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 checkoutAmbiguousRemoteBranchName:: 348 Advice shown when the argument to 349 linkgit:git-checkout[1] ambiguously resolves to a 350 remote tracking branch on more than one remote in 351 situations where an unambiguous argument would have 352 otherwise caused a remote-tracking branch to be 353 checked out. See the `checkout.defaultRemote` 354 configuration variable for how to set a given remote 355 to used by default in some situations where this 356 advice would be printed. 357 amWorkDir:: 358 Advice that shows the location of the patch file when 359 linkgit:git-am[1] fails to apply it. 360 rmHints:: 361 In case of failure in the output of linkgit:git-rm[1], 362 show directions on how to proceed from the current state. 363 addEmbeddedRepo:: 364 Advice on what to do when you've accidentally added one 365 git repo inside of another. 366 ignoredHook:: 367 Advice shown if a hook is ignored because the hook is not 368 set as executable. 369 waitingForEditor:: 370 Print a message to the terminal whenever Git is waiting for 371 editor input from the user. 372-- 373 374core.fileMode:: 375 Tells Git if the executable bit of files in the working tree 376 is to be honored. 377+ 378Some filesystems lose the executable bit when a file that is 379marked as executable is checked out, or checks out a 380non-executable file with executable bit on. 381linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem 382to see if it handles the executable bit correctly 383and this variable is automatically set as necessary. 384+ 385A repository, however, may be on a filesystem that handles 386the filemode correctly, and this variable is set to 'true' 387when created, but later may be made accessible from another 388environment that loses the filemode (e.g. exporting ext4 via 389CIFS mount, visiting a Cygwin created repository with 390Git for Windows or Eclipse). 391In such a case it may be necessary to set this variable to 'false'. 392See linkgit:git-update-index[1]. 393+ 394The default is true (when core.filemode is not specified in the config file). 395 396core.hideDotFiles:: 397 (Windows-only) If true, mark newly-created directories and files whose 398 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/` 399 directory is hidden, but no other files starting with a dot. The 400 default mode is 'dotGitOnly'. 401 402core.ignoreCase:: 403 Internal variable which enables various workarounds to enable 404 Git to work better on filesystems that are not case sensitive, 405 like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing 406 finds "makefile" when Git expects "Makefile", Git will assume 407 it is really the same file, and continue to remember it as 408 "Makefile". 409+ 410The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 411will probe and set core.ignoreCase true if appropriate when the repository 412is created. 413+ 414Git relies on the proper configuration of this variable for your operating 415and file system. Modifying this value may result in unexpected behavior. 416 417core.precomposeUnicode:: 418 This option is only used by Mac OS implementation of Git. 419 When core.precomposeUnicode=true, Git reverts the unicode decomposition 420 of filenames done by Mac OS. This is useful when sharing a repository 421 between Mac OS and Linux or Windows. 422 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 423 When false, file names are handled fully transparent by Git, 424 which is backward compatible with older versions of Git. 425 426core.protectHFS:: 427 If set to true, do not allow checkout of paths that would 428 be considered equivalent to `.git` on an HFS+ filesystem. 429 Defaults to `true` on Mac OS, and `false` elsewhere. 430 431core.protectNTFS:: 432 If set to true, do not allow checkout of paths that would 433 cause problems with the NTFS filesystem, e.g. conflict with 434 8.3 "short" names. 435 Defaults to `true` on Windows, and `false` elsewhere. 436 437core.fsmonitor:: 438 If set, the value of this variable is used as a command which 439 will identify all files that may have changed since the 440 requested date/time. This information is used to speed up git by 441 avoiding unnecessary processing of files that have not changed. 442 See the "fsmonitor-watchman" section of linkgit:githooks[5]. 443 444core.trustctime:: 445 If false, the ctime differences between the index and the 446 working tree are ignored; useful when the inode change time 447 is regularly modified by something outside Git (file system 448 crawlers and some backup systems). 449 See linkgit:git-update-index[1]. True by default. 450 451core.splitIndex:: 452 If true, the split-index feature of the index will be used. 453 See linkgit:git-update-index[1]. False by default. 454 455core.untrackedCache:: 456 Determines what to do about the untracked cache feature of the 457 index. It will be kept, if this variable is unset or set to 458 `keep`. It will automatically be added if set to `true`. And 459 it will automatically be removed, if set to `false`. Before 460 setting it to `true`, you should check that mtime is working 461 properly on your system. 462 See linkgit:git-update-index[1]. `keep` by default. 463 464core.checkStat:: 465 When missing or is set to `default`, many fields in the stat 466 structure are checked to detect if a file has been modified 467 since Git looked at it. When this configuration variable is 468 set to `minimal`, sub-second part of mtime and ctime, the 469 uid and gid of the owner of the file, the inode number (and 470 the device number, if Git was compiled to use it), are 471 excluded from the check among these fields, leaving only the 472 whole-second part of mtime (and ctime, if `core.trustCtime` 473 is set) and the filesize to be checked. 474+ 475There are implementations of Git that do not leave usable values in 476some fields (e.g. JGit); by excluding these fields from the 477comparison, the `minimal` mode may help interoperability when the 478same repository is used by these other systems at the same time. 479 480core.quotePath:: 481 Commands that output paths (e.g. 'ls-files', 'diff'), will 482 quote "unusual" characters in the pathname by enclosing the 483 pathname in double-quotes and escaping those characters with 484 backslashes in the same way C escapes control characters (e.g. 485 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with 486 values larger than 0x80 (e.g. octal `\302\265` for "micro" in 487 UTF-8). If this variable is set to false, bytes higher than 488 0x80 are not considered "unusual" any more. Double-quotes, 489 backslash and control characters are always escaped regardless 490 of the setting of this variable. A simple space character is 491 not considered "unusual". Many commands can output pathnames 492 completely verbatim using the `-z` option. The default value 493 is true. 494 495core.eol:: 496 Sets the line ending type to use in the working directory for 497 files that have the `text` property set when core.autocrlf is false. 498 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's 499 native line ending. The default value is `native`. See 500 linkgit:gitattributes[5] for more information on end-of-line 501 conversion. 502 503core.safecrlf:: 504 If true, makes Git check if converting `CRLF` is reversible when 505 end-of-line conversion is active. Git will verify if a command 506 modifies a file in the work tree either directly or indirectly. 507 For example, committing a file followed by checking out the 508 same file should yield the original file in the work tree. If 509 this is not the case for the current setting of 510 `core.autocrlf`, Git will reject the file. The variable can 511 be set to "warn", in which case Git will only warn about an 512 irreversible conversion but continue the operation. 513+ 514CRLF conversion bears a slight chance of corrupting data. 515When it is enabled, Git will convert CRLF to LF during commit and LF to 516CRLF during checkout. A file that contains a mixture of LF and 517CRLF before the commit cannot be recreated by Git. For text 518files this is the right thing to do: it corrects line endings 519such that we have only LF line endings in the repository. 520But for binary files that are accidentally classified as text the 521conversion can corrupt data. 522+ 523If you recognize such corruption early you can easily fix it by 524setting the conversion type explicitly in .gitattributes. Right 525after committing you still have the original file in your work 526tree and this file is not yet corrupted. You can explicitly tell 527Git that this file is binary and Git will handle the file 528appropriately. 529+ 530Unfortunately, the desired effect of cleaning up text files with 531mixed line endings and the undesired effect of corrupting binary 532files cannot be distinguished. In both cases CRLFs are removed 533in an irreversible way. For text files this is the right thing 534to do because CRLFs are line endings, while for binary files 535converting CRLFs corrupts data. 536+ 537Note, this safety check does not mean that a checkout will generate a 538file identical to the original file for a different setting of 539`core.eol` and `core.autocrlf`, but only for the current one. For 540example, a text file with `LF` would be accepted with `core.eol=lf` 541and could later be checked out with `core.eol=crlf`, in which case the 542resulting file would contain `CRLF`, although the original file 543contained `LF`. However, in both work trees the line endings would be 544consistent, that is either all `LF` or all `CRLF`, but never mixed. A 545file with mixed line endings would be reported by the `core.safecrlf` 546mechanism. 547 548core.autocrlf:: 549 Setting this variable to "true" is the same as setting 550 the `text` attribute to "auto" on all files and core.eol to "crlf". 551 Set to true if you want to have `CRLF` line endings in your 552 working directory and the repository has LF line endings. 553 This variable can be set to 'input', 554 in which case no output conversion is performed. 555 556core.checkRoundtripEncoding:: 557 A comma and/or whitespace separated list of encodings that Git 558 performs UTF-8 round trip checks on if they are used in an 559 `working-tree-encoding` attribute (see linkgit:gitattributes[5]). 560 The default value is `SHIFT-JIS`. 561 562core.symlinks:: 563 If false, symbolic links are checked out as small plain files that 564 contain the link text. linkgit:git-update-index[1] and 565 linkgit:git-add[1] will not change the recorded type to regular 566 file. Useful on filesystems like FAT that do not support 567 symbolic links. 568+ 569The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 570will probe and set core.symlinks false if appropriate when the repository 571is created. 572 573core.gitProxy:: 574 A "proxy command" to execute (as 'command host port') instead 575 of establishing direct connection to the remote server when 576 using the Git protocol for fetching. If the variable value is 577 in the "COMMAND for DOMAIN" format, the command is applied only 578 on hostnames ending with the specified domain string. This variable 579 may be set multiple times and is matched in the given order; 580 the first match wins. 581+ 582Can be overridden by the `GIT_PROXY_COMMAND` environment variable 583(which always applies universally, without the special "for" 584handling). 585+ 586The special string `none` can be used as the proxy command to 587specify that no proxy be used for a given domain pattern. 588This is useful for excluding servers inside a firewall from 589proxy use, while defaulting to a common proxy for external domains. 590 591core.sshCommand:: 592 If this variable is set, `git fetch` and `git push` will 593 use the specified command instead of `ssh` when they need to 594 connect to a remote system. The command is in the same form as 595 the `GIT_SSH_COMMAND` environment variable and is overridden 596 when the environment variable is set. 597 598core.ignoreStat:: 599 If true, Git will avoid using lstat() calls to detect if files have 600 changed by setting the "assume-unchanged" bit for those tracked files 601 which it has updated identically in both the index and working tree. 602+ 603When files are modified outside of Git, the user will need to stage 604the modified files explicitly (e.g. see 'Examples' section in 605linkgit:git-update-index[1]). 606Git will not normally detect changes to those files. 607+ 608This is useful on systems where lstat() calls are very slow, such as 609CIFS/Microsoft Windows. 610+ 611False by default. 612 613core.preferSymlinkRefs:: 614 Instead of the default "symref" format for HEAD 615 and other symbolic reference files, use symbolic links. 616 This is sometimes needed to work with old scripts that 617 expect HEAD to be a symbolic link. 618 619core.bare:: 620 If true this repository is assumed to be 'bare' and has no 621 working directory associated with it. If this is the case a 622 number of commands that require a working directory will be 623 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 624+ 625This setting is automatically guessed by linkgit:git-clone[1] or 626linkgit:git-init[1] when the repository was created. By default a 627repository that ends in "/.git" is assumed to be not bare (bare = 628false), while all other repositories are assumed to be bare (bare 629= true). 630 631core.worktree:: 632 Set the path to the root of the working tree. 633 If `GIT_COMMON_DIR` environment variable is set, core.worktree 634 is ignored and not used for determining the root of working tree. 635 This can be overridden by the `GIT_WORK_TREE` environment 636 variable and the `--work-tree` command-line option. 637 The value can be an absolute path or relative to the path to 638 the .git directory, which is either specified by --git-dir 639 or GIT_DIR, or automatically discovered. 640 If --git-dir or GIT_DIR is specified but none of 641 --work-tree, GIT_WORK_TREE and core.worktree is specified, 642 the current working directory is regarded as the top level 643 of your working tree. 644+ 645Note that this variable is honored even when set in a configuration 646file in a ".git" subdirectory of a directory and its value differs 647from the latter directory (e.g. "/path/to/.git/config" has 648core.worktree set to "/different/path"), which is most likely a 649misconfiguration. Running Git commands in the "/path/to" directory will 650still use "/different/path" as the root of the work tree and can cause 651confusion unless you know what you are doing (e.g. you are creating a 652read-only snapshot of the same index to a location different from the 653repository's usual working tree). 654 655core.logAllRefUpdates:: 656 Enable the reflog. Updates to a ref <ref> is logged to the file 657 "`$GIT_DIR/logs/<ref>`", by appending the new and old 658 SHA-1, the date/time and the reason of the update, but 659 only when the file exists. If this configuration 660 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`" 661 file is automatically created for branch heads (i.e. under 662 `refs/heads/`), remote refs (i.e. under `refs/remotes/`), 663 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`. 664 If it is set to `always`, then a missing reflog is automatically 665 created for any ref under `refs/`. 666+ 667This information can be used to determine what commit 668was the tip of a branch "2 days ago". 669+ 670This value is true by default in a repository that has 671a working directory associated with it, and false by 672default in a bare repository. 673 674core.repositoryFormatVersion:: 675 Internal variable identifying the repository format and layout 676 version. 677 678core.sharedRepository:: 679 When 'group' (or 'true'), the repository is made shareable between 680 several users in a group (making sure all the files and objects are 681 group-writable). When 'all' (or 'world' or 'everybody'), the 682 repository will be readable by all users, additionally to being 683 group-shareable. When 'umask' (or 'false'), Git will use permissions 684 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 685 files in the repository will have this mode value. '0xxx' will override 686 user's umask value (whereas the other options will only override 687 requested parts of the user's umask value). Examples: '0660' will make 688 the repo read/write-able for the owner and group, but inaccessible to 689 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 690 repository that is group-readable but not group-writable. 691 See linkgit:git-init[1]. False by default. 692 693core.warnAmbiguousRefs:: 694 If true, Git will warn you if the ref name you passed it is ambiguous 695 and might match multiple refs in the repository. True by default. 696 697core.compression:: 698 An integer -1..9, indicating a default compression level. 699 -1 is the zlib default. 0 means no compression, 700 and 1..9 are various speed/size tradeoffs, 9 being slowest. 701 If set, this provides a default to other compression variables, 702 such as `core.looseCompression` and `pack.compression`. 703 704core.looseCompression:: 705 An integer -1..9, indicating the compression level for objects that 706 are not in a pack file. -1 is the zlib default. 0 means no 707 compression, and 1..9 are various speed/size tradeoffs, 9 being 708 slowest. If not set, defaults to core.compression. If that is 709 not set, defaults to 1 (best speed). 710 711core.packedGitWindowSize:: 712 Number of bytes of a pack file to map into memory in a 713 single mapping operation. Larger window sizes may allow 714 your system to process a smaller number of large pack files 715 more quickly. Smaller window sizes will negatively affect 716 performance due to increased calls to the operating system's 717 memory manager, but may improve performance when accessing 718 a large number of large pack files. 719+ 720Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 721MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 722be reasonable for all users/operating systems. You probably do 723not need to adjust this value. 724+ 725Common unit suffixes of 'k', 'm', or 'g' are supported. 726 727core.packedGitLimit:: 728 Maximum number of bytes to map simultaneously into memory 729 from pack files. If Git needs to access more than this many 730 bytes at once to complete an operation it will unmap existing 731 regions to reclaim virtual address space within the process. 732+ 733Default is 256 MiB on 32 bit platforms and 32 TiB (effectively 734unlimited) on 64 bit platforms. 735This should be reasonable for all users/operating systems, except on 736the largest projects. You probably do not need to adjust this value. 737+ 738Common unit suffixes of 'k', 'm', or 'g' are supported. 739 740core.deltaBaseCacheLimit:: 741 Maximum number of bytes to reserve for caching base objects 742 that may be referenced by multiple deltified objects. By storing the 743 entire decompressed base objects in a cache Git is able 744 to avoid unpacking and decompressing frequently used base 745 objects multiple times. 746+ 747Default is 96 MiB on all platforms. This should be reasonable 748for all users/operating systems, except on the largest projects. 749You probably do not need to adjust this value. 750+ 751Common unit suffixes of 'k', 'm', or 'g' are supported. 752 753core.bigFileThreshold:: 754 Files larger than this size are stored deflated, without 755 attempting delta compression. Storing large files without 756 delta compression avoids excessive memory usage, at the 757 slight expense of increased disk usage. Additionally files 758 larger than this size are always treated as binary. 759+ 760Default is 512 MiB on all platforms. This should be reasonable 761for most projects as source code and other text files can still 762be delta compressed, but larger binary media files won't be. 763+ 764Common unit suffixes of 'k', 'm', or 'g' are supported. 765 766core.excludesFile:: 767 Specifies the pathname to the file that contains patterns to 768 describe paths that are not meant to be tracked, in addition 769 to '.gitignore' (per-directory) and '.git/info/exclude'. 770 Defaults to `$XDG_CONFIG_HOME/git/ignore`. 771 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` 772 is used instead. See linkgit:gitignore[5]. 773 774core.askPass:: 775 Some commands (e.g. svn and http interfaces) that interactively 776 ask for a password can be told to use an external program given 777 via the value of this variable. Can be overridden by the `GIT_ASKPASS` 778 environment variable. If not set, fall back to the value of the 779 `SSH_ASKPASS` environment variable or, failing that, a simple password 780 prompt. The external program shall be given a suitable prompt as 781 command-line argument and write the password on its STDOUT. 782 783core.attributesFile:: 784 In addition to '.gitattributes' (per-directory) and 785 '.git/info/attributes', Git looks into this file for attributes 786 (see linkgit:gitattributes[5]). Path expansions are made the same 787 way as for `core.excludesFile`. Its default value is 788 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not 789 set or empty, `$HOME/.config/git/attributes` is used instead. 790 791core.hooksPath:: 792 By default Git will look for your hooks in the 793 '$GIT_DIR/hooks' directory. Set this to different path, 794 e.g. '/etc/git/hooks', and Git will try to find your hooks in 795 that directory, e.g. '/etc/git/hooks/pre-receive' instead of 796 in '$GIT_DIR/hooks/pre-receive'. 797+ 798The path can be either absolute or relative. A relative path is 799taken as relative to the directory where the hooks are run (see 800the "DESCRIPTION" section of linkgit:githooks[5]). 801+ 802This configuration variable is useful in cases where you'd like to 803centrally configure your Git hooks instead of configuring them on a 804per-repository basis, or as a more flexible and centralized 805alternative to having an `init.templateDir` where you've changed 806default hooks. 807 808core.editor:: 809 Commands such as `commit` and `tag` that let you edit 810 messages by launching an editor use the value of this 811 variable when it is set, and the environment variable 812 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 813 814core.commentChar:: 815 Commands such as `commit` and `tag` that let you edit 816 messages consider a line that begins with this character 817 commented, and removes them after the editor returns 818 (default '#'). 819+ 820If set to "auto", `git-commit` would select a character that is not 821the beginning character of any line in existing commit messages. 822 823core.filesRefLockTimeout:: 824 The length of time, in milliseconds, to retry when trying to 825 lock an individual reference. Value 0 means not to retry at 826 all; -1 means to try indefinitely. Default is 100 (i.e., 827 retry for 100ms). 828 829core.packedRefsTimeout:: 830 The length of time, in milliseconds, to retry when trying to 831 lock the `packed-refs` file. Value 0 means not to retry at 832 all; -1 means to try indefinitely. Default is 1000 (i.e., 833 retry for 1 second). 834 835sequence.editor:: 836 Text editor used by `git rebase -i` for editing the rebase instruction file. 837 The value is meant to be interpreted by the shell when it is used. 838 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 839 When not configured the default commit message editor is used instead. 840 841core.pager:: 842 Text viewer for use by Git commands (e.g., 'less'). The value 843 is meant to be interpreted by the shell. The order of preference 844 is the `$GIT_PAGER` environment variable, then `core.pager` 845 configuration, then `$PAGER`, and then the default chosen at 846 compile time (usually 'less'). 847+ 848When the `LESS` environment variable is unset, Git sets it to `FRX` 849(if `LESS` environment variable is set, Git does not change it at 850all). If you want to selectively override Git's default setting 851for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 852be passed to the shell by Git, which will translate the final 853command to `LESS=FRX less -S`. The environment does not set the 854`S` option but the command line does, instructing less to truncate 855long lines. Similarly, setting `core.pager` to `less -+F` will 856deactivate the `F` option specified by the environment from the 857command-line, deactivating the "quit if one screen" behavior of 858`less`. One can specifically activate some flags for particular 859commands: for example, setting `pager.blame` to `less -S` enables 860line truncation only for `git blame`. 861+ 862Likewise, when the `LV` environment variable is unset, Git sets it 863to `-c`. You can override this setting by exporting `LV` with 864another value or setting `core.pager` to `lv +c`. 865 866core.whitespace:: 867 A comma separated list of common whitespace problems to 868 notice. 'git diff' will use `color.diff.whitespace` to 869 highlight them, and 'git apply --whitespace=error' will 870 consider them as errors. You can prefix `-` to disable 871 any of them (e.g. `-trailing-space`): 872+ 873* `blank-at-eol` treats trailing whitespaces at the end of the line 874 as an error (enabled by default). 875* `space-before-tab` treats a space character that appears immediately 876 before a tab character in the initial indent part of the line as an 877 error (enabled by default). 878* `indent-with-non-tab` treats a line that is indented with space 879 characters instead of the equivalent tabs as an error (not enabled by 880 default). 881* `tab-in-indent` treats a tab character in the initial indent part of 882 the line as an error (not enabled by default). 883* `blank-at-eof` treats blank lines added at the end of file as an error 884 (enabled by default). 885* `trailing-space` is a short-hand to cover both `blank-at-eol` and 886 `blank-at-eof`. 887* `cr-at-eol` treats a carriage-return at the end of line as 888 part of the line terminator, i.e. with it, `trailing-space` 889 does not trigger if the character before such a carriage-return 890 is not a whitespace (not enabled by default). 891* `tabwidth=<n>` tells how many character positions a tab occupies; this 892 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 893 errors. The default tab width is 8. Allowed values are 1 to 63. 894 895core.fsyncObjectFiles:: 896 This boolean will enable 'fsync()' when writing object files. 897+ 898This is a total waste of time and effort on a filesystem that orders 899data writes properly, but can be useful for filesystems that do not use 900journalling (traditional UNIX filesystems) or that only journal metadata 901and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 902 903core.preloadIndex:: 904 Enable parallel index preload for operations like 'git diff' 905+ 906This can speed up operations like 'git diff' and 'git status' especially 907on filesystems like NFS that have weak caching semantics and thus 908relatively high IO latencies. When enabled, Git will do the 909index comparison to the filesystem data in parallel, allowing 910overlapping IO's. Defaults to true. 911 912core.createObject:: 913 You can set this to 'link', in which case a hardlink followed by 914 a delete of the source are used to make sure that object creation 915 will not overwrite existing objects. 916+ 917On some file system/operating system combinations, this is unreliable. 918Set this config setting to 'rename' there; However, This will remove the 919check that makes sure that existing object files will not get overwritten. 920 921core.notesRef:: 922 When showing commit messages, also show notes which are stored in 923 the given ref. The ref must be fully qualified. If the given 924 ref does not exist, it is not an error but means that no 925 notes should be printed. 926+ 927This setting defaults to "refs/notes/commits", and it can be overridden by 928the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. 929 930core.commitGraph:: 931 If true, then git will read the commit-graph file (if it exists) 932 to parse the graph structure of commits. Defaults to false. See 933 linkgit:git-commit-graph[1] for more information. 934 935core.useReplaceRefs:: 936 If set to `false`, behave as if the `--no-replace-objects` 937 option was given on the command line. See linkgit:git[1] and 938 linkgit:git-replace[1] for more information. 939 940core.sparseCheckout:: 941 Enable "sparse checkout" feature. See section "Sparse checkout" in 942 linkgit:git-read-tree[1] for more information. 943 944core.abbrev:: 945 Set the length object names are abbreviated to. If 946 unspecified or set to "auto", an appropriate value is 947 computed based on the approximate number of packed objects 948 in your repository, which hopefully is enough for 949 abbreviated object names to stay unique for some time. 950 The minimum length is 4. 951 952add.ignoreErrors:: 953add.ignore-errors (deprecated):: 954 Tells 'git add' to continue adding files when some files cannot be 955 added due to indexing errors. Equivalent to the `--ignore-errors` 956 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 957 as it does not follow the usual naming convention for configuration 958 variables. 959 960alias.*:: 961 Command aliases for the linkgit:git[1] command wrapper - e.g. 962 after defining "alias.last = cat-file commit HEAD", the invocation 963 "git last" is equivalent to "git cat-file commit HEAD". To avoid 964 confusion and troubles with script usage, aliases that 965 hide existing Git commands are ignored. Arguments are split by 966 spaces, the usual shell quoting and escaping is supported. 967 A quote pair or a backslash can be used to quote them. 968+ 969If the alias expansion is prefixed with an exclamation point, 970it will be treated as a shell command. For example, defining 971"alias.new = !gitk --all --not ORIG_HEAD", the invocation 972"git new" is equivalent to running the shell command 973"gitk --all --not ORIG_HEAD". Note that shell commands will be 974executed from the top-level directory of a repository, which may 975not necessarily be the current directory. 976`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix' 977from the original current directory. See linkgit:git-rev-parse[1]. 978 979am.keepcr:: 980 If true, git-am will call git-mailsplit for patches in mbox format 981 with parameter `--keep-cr`. In this case git-mailsplit will 982 not remove `\r` from lines ending with `\r\n`. Can be overridden 983 by giving `--no-keep-cr` from the command line. 984 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 985 986am.threeWay:: 987 By default, `git am` will fail if the patch does not apply cleanly. When 988 set to true, this setting tells `git am` to fall back on 3-way merge if 989 the patch records the identity of blobs it is supposed to apply to and 990 we have those blobs available locally (equivalent to giving the `--3way` 991 option from the command line). Defaults to `false`. 992 See linkgit:git-am[1]. 993 994apply.ignoreWhitespace:: 995 When set to 'change', tells 'git apply' to ignore changes in 996 whitespace, in the same way as the `--ignore-space-change` 997 option. 998 When set to one of: no, none, never, false tells 'git apply' to 999 respect all whitespace differences.1000 See linkgit:git-apply[1].10011002apply.whitespace::1003 Tells 'git apply' how to handle whitespaces, in the same way1004 as the `--whitespace` option. See linkgit:git-apply[1].10051006blame.blankBoundary::1007 Show blank commit object name for boundary commits in1008 linkgit:git-blame[1]. This option defaults to false.10091010blame.coloring::1011 This determines the coloring scheme to be applied to blame1012 output. It can be 'repeatedLines', 'highlightRecent',1013 or 'none' which is the default.10141015blame.date::1016 Specifies the format used to output dates in linkgit:git-blame[1].1017 If unset the iso format is used. For supported values,1018 see the discussion of the `--date` option at linkgit:git-log[1].10191020blame.showEmail::1021 Show the author email instead of author name in linkgit:git-blame[1].1022 This option defaults to false.10231024blame.showRoot::1025 Do not treat root commits as boundaries in linkgit:git-blame[1].1026 This option defaults to false.10271028branch.autoSetupMerge::1029 Tells 'git branch' and 'git checkout' to set up new branches1030 so that linkgit:git-pull[1] will appropriately merge from the1031 starting point branch. Note that even if this option is not set,1032 this behavior can be chosen per-branch using the `--track`1033 and `--no-track` options. The valid settings are: `false` -- no1034 automatic setup is done; `true` -- automatic setup is done when the1035 starting point is a remote-tracking branch; `always` --1036 automatic setup is done when the starting point is either a1037 local branch or remote-tracking1038 branch. This option defaults to true.10391040branch.autoSetupRebase::1041 When a new branch is created with 'git branch' or 'git checkout'1042 that tracks another branch, this variable tells Git to set1043 up pull to rebase instead of merge (see "branch.<name>.rebase").1044 When `never`, rebase is never automatically set to true.1045 When `local`, rebase is set to true for tracked branches of1046 other local branches.1047 When `remote`, rebase is set to true for tracked branches of1048 remote-tracking branches.1049 When `always`, rebase will be set to true for all tracking1050 branches.1051 See "branch.autoSetupMerge" for details on how to set up a1052 branch to track another branch.1053 This option defaults to never.10541055branch.sort::1056 This variable controls the sort ordering of branches when displayed by1057 linkgit:git-branch[1]. Without the "--sort=<value>" option provided, the1058 value of this variable will be used as the default.1059 See linkgit:git-for-each-ref[1] field names for valid values.10601061branch.<name>.remote::1062 When on branch <name>, it tells 'git fetch' and 'git push'1063 which remote to fetch from/push to. The remote to push to1064 may be overridden with `remote.pushDefault` (for all branches).1065 The remote to push to, for the current branch, may be further1066 overridden by `branch.<name>.pushRemote`. If no remote is1067 configured, or if you are not on any branch, it defaults to1068 `origin` for fetching and `remote.pushDefault` for pushing.1069 Additionally, `.` (a period) is the current local repository1070 (a dot-repository), see `branch.<name>.merge`'s final note below.10711072branch.<name>.pushRemote::1073 When on branch <name>, it overrides `branch.<name>.remote` for1074 pushing. It also overrides `remote.pushDefault` for pushing1075 from branch <name>. When you pull from one place (e.g. your1076 upstream) and push to another place (e.g. your own publishing1077 repository), you would want to set `remote.pushDefault` to1078 specify the remote to push to for all branches, and use this1079 option to override it for a specific branch.10801081branch.<name>.merge::1082 Defines, together with branch.<name>.remote, the upstream branch1083 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which1084 branch to merge and can also affect 'git push' (see push.default).1085 When in branch <name>, it tells 'git fetch' the default1086 refspec to be marked for merging in FETCH_HEAD. The value is1087 handled like the remote part of a refspec, and must match a1088 ref which is fetched from the remote given by1089 "branch.<name>.remote".1090 The merge information is used by 'git pull' (which at first calls1091 'git fetch') to lookup the default branch for merging. Without1092 this option, 'git pull' defaults to merge the first refspec fetched.1093 Specify multiple values to get an octopus merge.1094 If you wish to setup 'git pull' so that it merges into <name> from1095 another branch in the local repository, you can point1096 branch.<name>.merge to the desired branch, and use the relative path1097 setting `.` (a period) for branch.<name>.remote.10981099branch.<name>.mergeOptions::1100 Sets default options for merging into branch <name>. The syntax and1101 supported options are the same as those of linkgit:git-merge[1], but1102 option values containing whitespace characters are currently not1103 supported.11041105branch.<name>.rebase::1106 When true, rebase the branch <name> on top of the fetched branch,1107 instead of merging the default branch from the default remote when1108 "git pull" is run. See "pull.rebase" for doing this in a non1109 branch-specific manner.1110+1111When `merges`, pass the `--rebase-merges` option to 'git rebase'1112so that the local merge commits are included in the rebase (see1113linkgit:git-rebase[1] for details).1114+1115When preserve, also pass `--preserve-merges` along to 'git rebase'1116so that locally committed merge commits will not be flattened1117by running 'git pull'.1118+1119When the value is `interactive`, the rebase is run in interactive mode.1120+1121*NOTE*: this is a possibly dangerous operation; do *not* use1122it unless you understand the implications (see linkgit:git-rebase[1]1123for details).11241125branch.<name>.description::1126 Branch description, can be edited with1127 `git branch --edit-description`. Branch description is1128 automatically added in the format-patch cover letter or1129 request-pull summary.11301131browser.<tool>.cmd::1132 Specify the command to invoke the specified browser. The1133 specified command is evaluated in shell with the URLs passed1134 as arguments. (See linkgit:git-web{litdd}browse[1].)11351136browser.<tool>.path::1137 Override the path for the given tool that may be used to1138 browse HTML help (see `-w` option in linkgit:git-help[1]) or a1139 working repository in gitweb (see linkgit:git-instaweb[1]).11401141checkout.defaultRemote::1142 When you run 'git checkout <something>' and only have one1143 remote, it may implicitly fall back on checking out and1144 tracking e.g. 'origin/<something>'. This stops working as soon1145 as you have more than one remote with a '<something>'1146 reference. This setting allows for setting the name of a1147 preferred remote that should always win when it comes to1148 disambiguation. The typical use-case is to set this to1149 `origin`.1150+1151Currently this is used by linkgit:git-checkout[1] when 'git checkout1152<something>' will checkout the '<something>' branch on another remote,1153and by linkgit:git-worktree[1] when 'git worktree add' refers to a1154remote branch. This setting might be used for other checkout-like1155commands or functionality in the future.11561157clean.requireForce::1158 A boolean to make git-clean do nothing unless given -f,1159 -i or -n. Defaults to true.11601161color.advice::1162 A boolean to enable/disable color in hints (e.g. when a push1163 failed, see `advice.*` for a list). May be set to `always`,1164 `false` (or `never`) or `auto` (or `true`), in which case colors1165 are used only when the error output goes to a terminal. If1166 unset, then the value of `color.ui` is used (`auto` by default).11671168color.advice.hint::1169 Use customized color for hints.11701171color.blame.highlightRecent::1172 This can be used to color the metadata of a blame line depending1173 on age of the line.1174+1175This setting should be set to a comma-separated list of color and date settings,1176starting and ending with a color, the dates should be set from oldest to newest.1177The metadata will be colored given the colors if the the line was introduced1178before the given timestamp, overwriting older timestamped colors.1179+1180Instead of an absolute timestamp relative timestamps work as well, e.g.11812.weeks.ago is valid to address anything older than 2 weeks.1182+1183It defaults to 'blue,12 month ago,white,1 month ago,red', which colors1184everything older than one year blue, recent changes between one month and1185one year old are kept white, and lines introduced within the last month are1186colored red.11871188color.blame.repeatedLines::1189 Use the customized color for the part of git-blame output that1190 is repeated meta information per line (such as commit id,1191 author name, date and timezone). Defaults to cyan.11921193color.branch::1194 A boolean to enable/disable color in the output of1195 linkgit:git-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.branch.<slot>::1201 Use customized color for branch coloration. `<slot>` is one of1202 `current` (the current branch), `local` (a local branch),1203 `remote` (a remote-tracking branch in refs/remotes/),1204 `upstream` (upstream tracking branch), `plain` (other1205 refs).12061207color.diff::1208 Whether to use ANSI escape sequences to add color to patches.1209 If this is set to `always`, linkgit:git-diff[1],1210 linkgit:git-log[1], and linkgit:git-show[1] will use color1211 for all patches. If it is set to `true` or `auto`, those1212 commands will only use color when output is to the terminal.1213 If unset, then the value of `color.ui` is used (`auto` by1214 default).1215+1216This does not affect linkgit:git-format-patch[1] or the1217'git-diff-{asterisk}' plumbing commands. Can be overridden on the1218command line with the `--color[=<when>]` option.12191220color.diff.<slot>::1221 Use customized color for diff colorization. `<slot>` specifies1222 which part of the patch to use the specified color, and is one1223 of `context` (context text - `plain` is a historical synonym),1224 `meta` (metainformation), `frag`1225 (hunk header), 'func' (function in hunk header), `old` (removed lines),1226 `new` (added lines), `commit` (commit headers), `whitespace`1227 (highlighting whitespace errors), `oldMoved` (deleted lines),1228 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,1229 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`1230 `newMovedAlternativeDimmed` (See the '<mode>'1231 setting of '--color-moved' in linkgit:git-diff[1] for details),1232 `contextDimmed`, `oldDimmed`, `newDimmed`, `contextBold`,1233 `oldBold`, and `newBold` (see linkgit:git-range-diff[1] for details).12341235color.decorate.<slot>::1236 Use customized color for 'git log --decorate' output. `<slot>` is one1237 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local1238 branches, remote-tracking branches, tags, stash and HEAD, respectively1239 and `grafted` for grafted commits.12401241color.grep::1242 When set to `always`, always highlight matches. When `false` (or1243 `never`), never. When set to `true` or `auto`, use color only1244 when the output is written to the terminal. If unset, then the1245 value of `color.ui` is used (`auto` by default).12461247color.grep.<slot>::1248 Use customized color for grep colorization. `<slot>` specifies which1249 part of the line to use the specified color, and is one of1250+1251--1252`context`;;1253 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1254`filename`;;1255 filename prefix (when not using `-h`)1256`function`;;1257 function name lines (when using `-p`)1258`lineNumber`;;1259 line number prefix (when using `-n`)1260`column`;;1261 column number prefix (when using `--column`)1262`match`;;1263 matching text (same as setting `matchContext` and `matchSelected`)1264`matchContext`;;1265 matching text in context lines1266`matchSelected`;;1267 matching text in selected lines1268`selected`;;1269 non-matching text in selected lines1270`separator`;;1271 separators between fields on a line (`:`, `-`, and `=`)1272 and between hunks (`--`)1273--12741275color.interactive::1276 When set to `always`, always use colors for interactive prompts1277 and displays (such as those used by "git-add --interactive" and1278 "git-clean --interactive"). When false (or `never`), never.1279 When set to `true` or `auto`, use colors only when the output is1280 to the terminal. If unset, then the value of `color.ui` is1281 used (`auto` by default).12821283color.interactive.<slot>::1284 Use customized color for 'git add --interactive' and 'git clean1285 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1286 or `error`, for four distinct types of normal output from1287 interactive commands.12881289color.pager::1290 A boolean to enable/disable colored output when the pager is in1291 use (default is true).12921293color.push::1294 A boolean to enable/disable color in push errors. May be set to1295 `always`, `false` (or `never`) or `auto` (or `true`), in which1296 case colors are used only when the error output goes to a terminal.1297 If unset, then the value of `color.ui` is used (`auto` by default).12981299color.push.error::1300 Use customized color for push errors.13011302color.remote::1303 If set, keywords at the start of the line are highlighted. The1304 keywords are "error", "warning", "hint" and "success", and are1305 matched case-insensitively. May be set to `always`, `false` (or1306 `never`) or `auto` (or `true`). If unset, then the value of1307 `color.ui` is used (`auto` by default).13081309color.remote.<slot>::1310 Use customized color for each remote keyword. `<slot>` may be1311 `hint`, `warning`, `success` or `error` which match the1312 corresponding keyword.13131314color.showBranch::1315 A boolean to enable/disable color in the output of1316 linkgit:git-show-branch[1]. May be set to `always`,1317 `false` (or `never`) or `auto` (or `true`), in which case colors are used1318 only when the output is to a terminal. If unset, then the1319 value of `color.ui` is used (`auto` by default).13201321color.status::1322 A boolean to enable/disable color in the output of1323 linkgit:git-status[1]. May be set to `always`,1324 `false` (or `never`) or `auto` (or `true`), in which case colors are used1325 only when the output is to a terminal. If unset, then the1326 value of `color.ui` is used (`auto` by default).13271328color.status.<slot>::1329 Use customized color for status colorization. `<slot>` is1330 one of `header` (the header text of the status message),1331 `added` or `updated` (files which are added but not committed),1332 `changed` (files which are changed but not added in the index),1333 `untracked` (files which are not tracked by Git),1334 `branch` (the current branch),1335 `nobranch` (the color the 'no branch' warning is shown in, defaulting1336 to red),1337 `localBranch` or `remoteBranch` (the local and remote branch names,1338 respectively, when branch and tracking information is displayed in the1339 status short-format), or1340 `unmerged` (files which have unmerged changes).13411342color.transport::1343 A boolean to enable/disable color when pushes are rejected. May be1344 set to `always`, `false` (or `never`) or `auto` (or `true`), in which1345 case colors are used only when the error output goes to a terminal.1346 If unset, then the value of `color.ui` is used (`auto` by default).13471348color.transport.rejected::1349 Use customized color when a push was rejected.13501351color.ui::1352 This variable determines the default value for variables such1353 as `color.diff` and `color.grep` that control the use of color1354 per command family. Its scope will expand as more commands learn1355 configuration to set a default for the `--color` option. Set it1356 to `false` or `never` if you prefer Git commands not to use1357 color unless enabled explicitly with some other configuration1358 or the `--color` option. Set it to `always` if you want all1359 output not intended for machine consumption to use color, to1360 `true` or `auto` (this is the default since Git 1.8.4) if you1361 want such output to use color when written to the terminal.13621363column.ui::1364 Specify whether supported commands should output in columns.1365 This variable consists of a list of tokens separated by spaces1366 or commas:1367+1368These options control when the feature should be enabled1369(defaults to 'never'):1370+1371--1372`always`;;1373 always show in columns1374`never`;;1375 never show in columns1376`auto`;;1377 show in columns if the output is to the terminal1378--1379+1380These options control layout (defaults to 'column'). Setting any1381of these implies 'always' if none of 'always', 'never', or 'auto' are1382specified.1383+1384--1385`column`;;1386 fill columns before rows1387`row`;;1388 fill rows before columns1389`plain`;;1390 show in one column1391--1392+1393Finally, these options can be combined with a layout option (defaults1394to 'nodense'):1395+1396--1397`dense`;;1398 make unequal size columns to utilize more space1399`nodense`;;1400 make equal size columns1401--14021403column.branch::1404 Specify whether to output branch listing in `git branch` in columns.1405 See `column.ui` for details.14061407column.clean::1408 Specify the layout when list items in `git clean -i`, which always1409 shows files and directories in columns. See `column.ui` for details.14101411column.status::1412 Specify whether to output untracked files in `git status` in columns.1413 See `column.ui` for details.14141415column.tag::1416 Specify whether to output tag listing in `git tag` in columns.1417 See `column.ui` for details.14181419commit.cleanup::1420 This setting overrides the default of the `--cleanup` option in1421 `git commit`. See linkgit:git-commit[1] for details. Changing the1422 default can be useful when you always want to keep lines that begin1423 with comment character `#` in your log message, in which case you1424 would do `git config commit.cleanup whitespace` (note that you will1425 have to remove the help lines that begin with `#` in the commit log1426 template yourself, if you do this).14271428commit.gpgSign::14291430 A boolean to specify whether all commits should be GPG signed.1431 Use of this option when doing operations such as rebase can1432 result in a large number of commits being signed. It may be1433 convenient to use an agent to avoid typing your GPG passphrase1434 several times.14351436commit.status::1437 A boolean to enable/disable inclusion of status information in the1438 commit message template when using an editor to prepare the commit1439 message. Defaults to true.14401441commit.template::1442 Specify the pathname of a file to use as the template for1443 new commit messages.14441445commit.verbose::1446 A boolean or int to specify the level of verbose with `git commit`.1447 See linkgit:git-commit[1].14481449credential.helper::1450 Specify an external helper to be called when a username or1451 password credential is needed; the helper may consult external1452 storage to avoid prompting the user for the credentials. Note1453 that multiple helpers may be defined. See linkgit:gitcredentials[7]1454 for details.14551456credential.useHttpPath::1457 When acquiring credentials, consider the "path" component of an http1458 or https URL to be important. Defaults to false. See1459 linkgit:gitcredentials[7] for more information.14601461credential.username::1462 If no username is set for a network authentication, use this username1463 by default. See credential.<context>.* below, and1464 linkgit:gitcredentials[7].14651466credential.<url>.*::1467 Any of the credential.* options above can be applied selectively to1468 some credentials. For example "credential.https://example.com.username"1469 would set the default username only for https connections to1470 example.com. See linkgit:gitcredentials[7] for details on how URLs are1471 matched.14721473credentialCache.ignoreSIGHUP::1474 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.14751476completion.commands::1477 This is only used by git-completion.bash to add or remove1478 commands from the list of completed commands. Normally only1479 porcelain commands and a few select others are completed. You1480 can add more commands, separated by space, in this1481 variable. Prefixing the command with '-' will remove it from1482 the existing list.14831484include::diff-config.txt[]14851486difftool.<tool>.path::1487 Override the path for the given tool. This is useful in case1488 your tool is not in the PATH.14891490difftool.<tool>.cmd::1491 Specify the command to invoke the specified diff tool.1492 The specified command is evaluated in shell with the following1493 variables available: 'LOCAL' is set to the name of the temporary1494 file containing the contents of the diff pre-image and 'REMOTE'1495 is set to the name of the temporary file containing the contents1496 of the diff post-image.14971498difftool.prompt::1499 Prompt before each invocation of the diff tool.15001501fastimport.unpackLimit::1502 If the number of objects imported by linkgit:git-fast-import[1]1503 is below this limit, then the objects will be unpacked into1504 loose object files. However if the number of imported objects1505 equals or exceeds this limit then the pack will be stored as a1506 pack. Storing the pack from a fast-import can make the import1507 operation complete faster, especially on slow filesystems. If1508 not set, the value of `transfer.unpackLimit` is used instead.15091510include::fetch-config.txt[]15111512include::format-config.txt[]15131514filter.<driver>.clean::1515 The command which is used to convert the content of a worktree1516 file to a blob upon checkin. See linkgit:gitattributes[5] for1517 details.15181519filter.<driver>.smudge::1520 The command which is used to convert the content of a blob1521 object to a worktree file upon checkout. See1522 linkgit:gitattributes[5] for details.15231524fsck.<msg-id>::1525 During fsck git may find issues with legacy data which1526 wouldn't be generated by current versions of git, and which1527 wouldn't be sent over the wire if `transfer.fsckObjects` was1528 set. This feature is intended to support working with legacy1529 repositories containing such data.1530+1531Setting `fsck.<msg-id>` will be picked up by linkgit:git-fsck[1], but1532to accept pushes of such data set `receive.fsck.<msg-id>` instead, or1533to clone or fetch it set `fetch.fsck.<msg-id>`.1534+1535The rest of the documentation discusses `fsck.*` for brevity, but the1536same applies for the corresponding `receive.fsck.*` and1537`fetch.<msg-id>.*`. variables.1538+1539Unlike variables like `color.ui` and `core.editor` the1540`receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` variables will not1541fall back on the `fsck.<msg-id>` configuration if they aren't set. To1542uniformly configure the same fsck settings in different circumstances1543all three of them they must all set to the same values.1544+1545When `fsck.<msg-id>` is set, errors can be switched to warnings and1546vice versa by configuring the `fsck.<msg-id>` setting where the1547`<msg-id>` is the fsck message ID and the value is one of `error`,1548`warn` or `ignore`. For convenience, fsck prefixes the error/warning1549with the message ID, e.g. "missingEmail: invalid author/committer line1550- missing email" means that setting `fsck.missingEmail = ignore` will1551hide that issue.1552+1553In general, it is better to enumerate existing objects with problems1554with `fsck.skipList`, instead of listing the kind of breakages these1555problematic objects share to be ignored, as doing the latter will1556allow new instances of the same breakages go unnoticed.1557+1558Setting an unknown `fsck.<msg-id>` value will cause fsck to die, but1559doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>`1560will only cause git to warn.15611562fsck.skipList::1563 The path to a sorted list of object names (i.e. one SHA-1 per1564 line) that are known to be broken in a non-fatal way and should1565 be ignored. This feature is useful when an established project1566 should be accepted despite early commits containing errors that1567 can be safely ignored such as invalid committer email addresses.1568 Note: corrupt objects cannot be skipped with this setting.1569+1570Like `fsck.<msg-id>` this variable has corresponding1571`receive.fsck.skipList` and `fetch.fsck.skipList` variants.1572+1573Unlike variables like `color.ui` and `core.editor` the1574`receive.fsck.skipList` and `fetch.fsck.skipList` variables will not1575fall back on the `fsck.skipList` configuration if they aren't set. To1576uniformly configure the same fsck settings in different circumstances1577all three of them they must all set to the same values.15781579gc.aggressiveDepth::1580 The depth parameter used in the delta compression1581 algorithm used by 'git gc --aggressive'. This defaults1582 to 50.15831584gc.aggressiveWindow::1585 The window size parameter used in the delta compression1586 algorithm used by 'git gc --aggressive'. This defaults1587 to 250.15881589gc.auto::1590 When there are approximately more than this many loose1591 objects in the repository, `git gc --auto` will pack them.1592 Some Porcelain commands use this command to perform a1593 light-weight garbage collection from time to time. The1594 default value is 6700. Setting this to 0 disables it.15951596gc.autoPackLimit::1597 When there are more than this many packs that are not1598 marked with `*.keep` file in the repository, `git gc1599 --auto` consolidates them into one larger pack. The1600 default value is 50. Setting this to 0 disables it.16011602gc.autoDetach::1603 Make `git gc --auto` return immediately and run in background1604 if the system supports it. Default is true.16051606gc.bigPackThreshold::1607 If non-zero, all packs larger than this limit are kept when1608 `git gc` is run. This is very similar to `--keep-base-pack`1609 except that all packs that meet the threshold are kept, not1610 just the base pack. Defaults to zero. Common unit suffixes of1611 'k', 'm', or 'g' are supported.1612+1613Note that if the number of kept packs is more than gc.autoPackLimit,1614this configuration variable is ignored, all packs except the base pack1615will be repacked. After this the number of packs should go below1616gc.autoPackLimit and gc.bigPackThreshold should be respected again.16171618gc.writeCommitGraph::1619 If true, then gc will rewrite the commit-graph file when1620 linkgit:git-gc[1] is run. When using linkgit:git-gc[1]1621 '--auto' the commit-graph will be updated if housekeeping is1622 required. Default is false. See linkgit:git-commit-graph[1]1623 for details.16241625gc.logExpiry::1626 If the file gc.log exists, then `git gc --auto` won't run1627 unless that file is more than 'gc.logExpiry' old. Default is1628 "1.day". See `gc.pruneExpire` for more ways to specify its1629 value.16301631gc.packRefs::1632 Running `git pack-refs` in a repository renders it1633 unclonable by Git versions prior to 1.5.1.2 over dumb1634 transports such as HTTP. This variable determines whether1635 'git gc' runs `git pack-refs`. This can be set to `notbare`1636 to enable it within all non-bare repos or it can be set to a1637 boolean value. The default is `true`.16381639gc.pruneExpire::1640 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1641 Override the grace period with this config variable. The value1642 "now" may be used to disable this grace period and always prune1643 unreachable objects immediately, or "never" may be used to1644 suppress pruning. This feature helps prevent corruption when1645 'git gc' runs concurrently with another process writing to the1646 repository; see the "NOTES" section of linkgit:git-gc[1].16471648gc.worktreePruneExpire::1649 When 'git gc' is run, it calls1650 'git worktree prune --expire 3.months.ago'.1651 This config variable can be used to set a different grace1652 period. The value "now" may be used to disable the grace1653 period and prune `$GIT_DIR/worktrees` immediately, or "never"1654 may be used to suppress pruning.16551656gc.reflogExpire::1657gc.<pattern>.reflogExpire::1658 'git reflog expire' removes reflog entries older than1659 this time; defaults to 90 days. The value "now" expires all1660 entries immediately, and "never" suppresses expiration1661 altogether. With "<pattern>" (e.g.1662 "refs/stash") in the middle the setting applies only to1663 the refs that match the <pattern>.16641665gc.reflogExpireUnreachable::1666gc.<pattern>.reflogExpireUnreachable::1667 'git reflog expire' removes reflog entries older than1668 this time and are not reachable from the current tip;1669 defaults to 30 days. The value "now" expires all entries1670 immediately, and "never" suppresses expiration altogether.1671 With "<pattern>" (e.g. "refs/stash")1672 in the middle, the setting applies only to the refs that1673 match the <pattern>.16741675gc.rerereResolved::1676 Records of conflicted merge you resolved earlier are1677 kept for this many days when 'git rerere gc' is run.1678 You can also use more human-readable "1.month.ago", etc.1679 The default is 60 days. See linkgit:git-rerere[1].16801681gc.rerereUnresolved::1682 Records of conflicted merge you have not resolved are1683 kept for this many days when 'git rerere gc' is run.1684 You can also use more human-readable "1.month.ago", etc.1685 The default is 15 days. See linkgit:git-rerere[1].16861687include::gitcvs-config.txt[]16881689gitweb.category::1690gitweb.description::1691gitweb.owner::1692gitweb.url::1693 See linkgit:gitweb[1] for description.16941695gitweb.avatar::1696gitweb.blame::1697gitweb.grep::1698gitweb.highlight::1699gitweb.patches::1700gitweb.pickaxe::1701gitweb.remote_heads::1702gitweb.showSizes::1703gitweb.snapshot::1704 See linkgit:gitweb.conf[5] for description.17051706grep.lineNumber::1707 If set to true, enable `-n` option by default.17081709grep.column::1710 If set to true, enable the `--column` option by default.17111712grep.patternType::1713 Set the default matching behavior. Using a value of 'basic', 'extended',1714 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1715 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1716 value 'default' will return to the default matching behavior.17171718grep.extendedRegexp::1719 If set to true, enable `--extended-regexp` option by default. This1720 option is ignored when the `grep.patternType` option is set to a value1721 other than 'default'.17221723grep.threads::1724 Number of grep worker threads to use.1725 See `grep.threads` in linkgit:git-grep[1] for more information.17261727grep.fallbackToNoIndex::1728 If set to true, fall back to git grep --no-index if git grep1729 is executed outside of a git repository. Defaults to false.17301731gpg.program::1732 Use this custom program instead of "`gpg`" found on `$PATH` when1733 making or verifying a PGP signature. The program must support the1734 same command-line interface as GPG, namely, to verify a detached1735 signature, "`gpg --verify $file - <$signature`" is run, and the1736 program is expected to signal a good signature by exiting with1737 code 0, and to generate an ASCII-armored detached signature, the1738 standard input of "`gpg -bsau $key`" is fed with the contents to be1739 signed, and the program is expected to send the result to its1740 standard output.17411742gpg.format::1743 Specifies which key format to use when signing with `--gpg-sign`.1744 Default is "openpgp" and another possible value is "x509".17451746gpg.<format>.program::1747 Use this to customize the program used for the signing format you1748 chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still1749 be used as a legacy synonym for `gpg.openpgp.program`. The default1750 value for `gpg.x509.program` is "gpgsm".17511752include::gui-config.txt[]17531754guitool.<name>.cmd::1755 Specifies the shell command line to execute when the corresponding item1756 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1757 mandatory for every tool. The command is executed from the root of1758 the working directory, and in the environment it receives the name of1759 the tool as `GIT_GUITOOL`, the name of the currently selected file as1760 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1761 the head is detached, 'CUR_BRANCH' is empty).17621763guitool.<name>.needsFile::1764 Run the tool only if a diff is selected in the GUI. It guarantees1765 that 'FILENAME' is not empty.17661767guitool.<name>.noConsole::1768 Run the command silently, without creating a window to display its1769 output.17701771guitool.<name>.noRescan::1772 Don't rescan the working directory for changes after the tool1773 finishes execution.17741775guitool.<name>.confirm::1776 Show a confirmation dialog before actually running the tool.17771778guitool.<name>.argPrompt::1779 Request a string argument from the user, and pass it to the tool1780 through the `ARGS` environment variable. Since requesting an1781 argument implies confirmation, the 'confirm' option has no effect1782 if this is enabled. If the option is set to 'true', 'yes', or '1',1783 the dialog uses a built-in generic prompt; otherwise the exact1784 value of the variable is used.17851786guitool.<name>.revPrompt::1787 Request a single valid revision from the user, and set the1788 `REVISION` environment variable. In other aspects this option1789 is similar to 'argPrompt', and can be used together with it.17901791guitool.<name>.revUnmerged::1792 Show only unmerged branches in the 'revPrompt' subdialog.1793 This is useful for tools similar to merge or rebase, but not1794 for things like checkout or reset.17951796guitool.<name>.title::1797 Specifies the title to use for the prompt dialog. The default1798 is the tool name.17991800guitool.<name>.prompt::1801 Specifies the general prompt string to display at the top of1802 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1803 The default value includes the actual command.18041805help.browser::1806 Specify the browser that will be used to display help in the1807 'web' format. See linkgit:git-help[1].18081809help.format::1810 Override the default help format used by linkgit:git-help[1].1811 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1812 the default. 'web' and 'html' are the same.18131814help.autoCorrect::1815 Automatically correct and execute mistyped commands after1816 waiting for the given number of deciseconds (0.1 sec). If more1817 than one command can be deduced from the entered text, nothing1818 will be executed. If the value of this option is negative,1819 the corrected command will be executed immediately. If the1820 value is 0 - the command will be just shown but not executed.1821 This is the default.18221823help.htmlPath::1824 Specify the path where the HTML documentation resides. File system paths1825 and URLs are supported. HTML pages will be prefixed with this path when1826 help is displayed in the 'web' format. This defaults to the documentation1827 path of your Git installation.18281829http.proxy::1830 Override the HTTP proxy, normally configured using the 'http_proxy',1831 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1832 addition to the syntax understood by curl, it is possible to specify a1833 proxy string with a user name but no password, in which case git will1834 attempt to acquire one in the same way it does for other credentials. See1835 linkgit:gitcredentials[7] for more information. The syntax thus is1836 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1837 on a per-remote basis; see remote.<name>.proxy18381839http.proxyAuthMethod::1840 Set the method with which to authenticate against the HTTP proxy. This1841 only takes effect if the configured proxy string contains a user name part1842 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1843 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1844 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1845 variable. Possible values are:1846+1847--1848* `anyauth` - Automatically pick a suitable authentication method. It is1849 assumed that the proxy answers an unauthenticated request with a 4071850 status code and one or more Proxy-authenticate headers with supported1851 authentication methods. This is the default.1852* `basic` - HTTP Basic authentication1853* `digest` - HTTP Digest authentication; this prevents the password from being1854 transmitted to the proxy in clear text1855* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1856 of `curl(1)`)1857* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1858--18591860http.emptyAuth::1861 Attempt authentication without seeking a username or password. This1862 can be used to attempt GSS-Negotiate authentication without specifying1863 a username in the URL, as libcurl normally requires a username for1864 authentication.18651866http.delegation::1867 Control GSSAPI credential delegation. The delegation is disabled1868 by default in libcurl since version 7.21.7. Set parameter to tell1869 the server what it is allowed to delegate when it comes to user1870 credentials. Used with GSS/kerberos. Possible values are:1871+1872--1873* `none` - Don't allow any delegation.1874* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the1875 Kerberos service ticket, which is a matter of realm policy.1876* `always` - Unconditionally allow the server to delegate.1877--187818791880http.extraHeader::1881 Pass an additional HTTP header when communicating with a server. If1882 more than one such entry exists, all of them are added as extra1883 headers. To allow overriding the settings inherited from the system1884 config, an empty value will reset the extra headers to the empty list.18851886http.cookieFile::1887 The pathname of a file containing previously stored cookie lines,1888 which should be used1889 in the Git http session, if they match the server. The file format1890 of the file to read cookies from should be plain HTTP headers or1891 the Netscape/Mozilla cookie file format (see `curl(1)`).1892 NOTE that the file specified with http.cookieFile is used only as1893 input unless http.saveCookies is set.18941895http.saveCookies::1896 If set, store cookies received during requests to the file specified by1897 http.cookieFile. Has no effect if http.cookieFile is unset.18981899http.sslVersion::1900 The SSL version to use when negotiating an SSL connection, if you1901 want to force the default. The available and default version1902 depend on whether libcurl was built against NSS or OpenSSL and the1903 particular configuration of the crypto library in use. Internally1904 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl1905 documentation for more details on the format of this option and1906 for the ssl version supported. Actually the possible values of1907 this option are:19081909 - sslv21910 - sslv31911 - tlsv11912 - tlsv1.01913 - tlsv1.11914 - tlsv1.21915 - tlsv1.319161917+1918Can be overridden by the `GIT_SSL_VERSION` environment variable.1919To force git to use libcurl's default ssl version and ignore any1920explicit http.sslversion option, set `GIT_SSL_VERSION` to the1921empty string.19221923http.sslCipherList::1924 A list of SSL ciphers to use when negotiating an SSL connection.1925 The available ciphers depend on whether libcurl was built against1926 NSS or OpenSSL and the particular configuration of the crypto1927 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'1928 option; see the libcurl documentation for more details on the format1929 of this list.1930+1931Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.1932To force git to use libcurl's default cipher list and ignore any1933explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the1934empty string.19351936http.sslVerify::1937 Whether to verify the SSL certificate when fetching or pushing1938 over HTTPS. Defaults to true. Can be overridden by the1939 `GIT_SSL_NO_VERIFY` environment variable.19401941http.sslCert::1942 File containing the SSL certificate when fetching or pushing1943 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment1944 variable.19451946http.sslKey::1947 File containing the SSL private key when fetching or pushing1948 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment1949 variable.19501951http.sslCertPasswordProtected::1952 Enable Git's password prompt for the SSL certificate. Otherwise1953 OpenSSL will prompt the user, possibly many times, if the1954 certificate or private key is encrypted. Can be overridden by the1955 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.19561957http.sslCAInfo::1958 File containing the certificates to verify the peer with when1959 fetching or pushing over HTTPS. Can be overridden by the1960 `GIT_SSL_CAINFO` environment variable.19611962http.sslCAPath::1963 Path containing files with the CA certificates to verify the peer1964 with when fetching or pushing over HTTPS. Can be overridden1965 by the `GIT_SSL_CAPATH` environment variable.19661967http.pinnedpubkey::1968 Public key of the https service. It may either be the filename of1969 a PEM or DER encoded public key file or a string starting with1970 'sha256//' followed by the base64 encoded sha256 hash of the1971 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will1972 exit with an error if this option is set but not supported by1973 cURL.19741975http.sslTry::1976 Attempt to use AUTH SSL/TLS and encrypted data transfers1977 when connecting via regular FTP protocol. This might be needed1978 if the FTP server requires it for security reasons or you wish1979 to connect securely whenever remote FTP server supports it.1980 Default is false since it might trigger certificate verification1981 errors on misconfigured servers.19821983http.maxRequests::1984 How many HTTP requests to launch in parallel. Can be overridden1985 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.19861987http.minSessions::1988 The number of curl sessions (counted across slots) to be kept across1989 requests. They will not be ended with curl_easy_cleanup() until1990 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1991 value will be capped at 1. Defaults to 1.19921993http.postBuffer::1994 Maximum size in bytes of the buffer used by smart HTTP1995 transports when POSTing data to the remote system.1996 For requests larger than this buffer size, HTTP/1.1 and1997 Transfer-Encoding: chunked is used to avoid creating a1998 massive pack file locally. Default is 1 MiB, which is1999 sufficient for most requests.20002001http.lowSpeedLimit, http.lowSpeedTime::2002 If the HTTP transfer speed is less than 'http.lowSpeedLimit'2003 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.2004 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and2005 `GIT_HTTP_LOW_SPEED_TIME` environment variables.20062007http.noEPSV::2008 A boolean which disables using of EPSV ftp command by curl.2009 This can helpful with some "poor" ftp servers which don't2010 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`2011 environment variable. Default is false (curl will use EPSV).20122013http.userAgent::2014 The HTTP USER_AGENT string presented to an HTTP server. The default2015 value represents the version of the client Git such as git/1.7.1.2016 This option allows you to override this value to a more common value2017 such as Mozilla/4.0. This may be necessary, for instance, if2018 connecting through a firewall that restricts HTTP connections to a set2019 of common USER_AGENT strings (but not including those like git/1.7.1).2020 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.20212022http.followRedirects::2023 Whether git should follow HTTP redirects. If set to `true`, git2024 will transparently follow any redirect issued by a server it2025 encounters. If set to `false`, git will treat all redirects as2026 errors. If set to `initial`, git will follow redirects only for2027 the initial request to a remote, but not for subsequent2028 follow-up HTTP requests. Since git uses the redirected URL as2029 the base for the follow-up requests, this is generally2030 sufficient. The default is `initial`.20312032http.<url>.*::2033 Any of the http.* options above can be applied selectively to some URLs.2034 For a config key to match a URL, each element of the config key is2035 compared to that of the URL, in the following order:2036+2037--2038. Scheme (e.g., `https` in `https://example.com/`). This field2039 must match exactly between the config key and the URL.20402041. Host/domain name (e.g., `example.com` in `https://example.com/`).2042 This field must match between the config key and the URL. It is2043 possible to specify a `*` as part of the host name to match all subdomains2044 at this level. `https://*.example.com/` for example would match2045 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.20462047. Port number (e.g., `8080` in `http://example.com:8080/`).2048 This field must match exactly between the config key and the URL.2049 Omitted port numbers are automatically converted to the correct2050 default for the scheme before matching.20512052. Path (e.g., `repo.git` in `https://example.com/repo.git`). The2053 path field of the config key must match the path field of the URL2054 either exactly or as a prefix of slash-delimited path elements. This means2055 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only2056 match on a slash (`/`) boundary. Longer matches take precedence (so a config2057 key with path `foo/bar` is a better match to URL path `foo/bar` than a config2058 key with just path `foo/`).20592060. User name (e.g., `user` in `https://user@example.com/repo.git`). If2061 the config key has a user name it must match the user name in the2062 URL exactly. If the config key does not have a user name, that2063 config key will match a URL with any user name (including none),2064 but at a lower precedence than a config key with a user name.2065--2066+2067The list above is ordered by decreasing precedence; a URL that matches2068a config key's path is preferred to one that matches its user name. For example,2069if the URL is `https://user@example.com/foo/bar` a config key match of2070`https://example.com/foo` will be preferred over a config key match of2071`https://user@example.com`.2072+2073All URLs are normalized before attempting any matching (the password part,2074if embedded in the URL, is always ignored for matching purposes) so that2075equivalent URLs that are simply spelled differently will match properly.2076Environment variable settings always override any matches. The URLs that are2077matched against are those given directly to Git commands. This means any URLs2078visited as a result of a redirection do not participate in matching.20792080ssh.variant::2081 By default, Git determines the command line arguments to use2082 based on the basename of the configured SSH command (configured2083 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or2084 the config setting `core.sshCommand`). If the basename is2085 unrecognized, Git will attempt to detect support of OpenSSH2086 options by first invoking the configured SSH command with the2087 `-G` (print configuration) option and will subsequently use2088 OpenSSH options (if that is successful) or no options besides2089 the host and remote command (if it fails).2090+2091The config variable `ssh.variant` can be set to override this detection.2092Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,2093`tortoiseplink`, `simple` (no options except the host and remote command).2094The default auto-detection can be explicitly requested using the value2095`auto`. Any other value is treated as `ssh`. This setting can also be2096overridden via the environment variable `GIT_SSH_VARIANT`.2097+2098The current command-line parameters used for each variant are as2099follows:2100+2101--21022103* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command21042105* `simple` - [username@]host command21062107* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command21082109* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command21102111--2112+2113Except for the `simple` variant, command-line parameters are likely to2114change as git gains new features.21152116i18n.commitEncoding::2117 Character encoding the commit messages are stored in; Git itself2118 does not care per se, but this information is necessary e.g. when2119 importing commits from emails or in the gitk graphical history2120 browser (and possibly at other places in the future or in other2121 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.21222123i18n.logOutputEncoding::2124 Character encoding the commit messages are converted to when2125 running 'git log' and friends.21262127imap::2128 The configuration variables in the 'imap' section are described2129 in linkgit:git-imap-send[1].21302131index.version::2132 Specify the version with which new index files should be2133 initialized. This does not affect existing repositories.21342135init.templateDir::2136 Specify the directory from which templates will be copied.2137 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)21382139instaweb.browser::2140 Specify the program that will be used to browse your working2141 repository in gitweb. See linkgit:git-instaweb[1].21422143instaweb.httpd::2144 The HTTP daemon command-line to start gitweb on your working2145 repository. See linkgit:git-instaweb[1].21462147instaweb.local::2148 If true the web server started by linkgit:git-instaweb[1] will2149 be bound to the local IP (127.0.0.1).21502151instaweb.modulePath::2152 The default module path for linkgit:git-instaweb[1] to use2153 instead of /usr/lib/apache2/modules. Only used if httpd2154 is Apache.21552156instaweb.port::2157 The port number to bind the gitweb httpd to. See2158 linkgit:git-instaweb[1].21592160interactive.singleKey::2161 In interactive commands, allow the user to provide one-letter2162 input with a single key (i.e., without hitting enter).2163 Currently this is used by the `--patch` mode of2164 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],2165 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this2166 setting is silently ignored if portable keystroke input2167 is not available; requires the Perl module Term::ReadKey.21682169interactive.diffFilter::2170 When an interactive command (such as `git add --patch`) shows2171 a colorized diff, git will pipe the diff through the shell2172 command defined by this configuration variable. The command may2173 mark up the diff further for human consumption, provided that it2174 retains a one-to-one correspondence with the lines in the2175 original diff. Defaults to disabled (no filtering).21762177log.abbrevCommit::2178 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2179 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may2180 override this option with `--no-abbrev-commit`.21812182log.date::2183 Set the default date-time mode for the 'log' command.2184 Setting a value for log.date is similar to using 'git log''s2185 `--date` option. See linkgit:git-log[1] for details.21862187log.decorate::2188 Print out the ref names of any commits that are shown by the log2189 command. If 'short' is specified, the ref name prefixes 'refs/heads/',2190 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is2191 specified, the full ref name (including prefix) will be printed.2192 If 'auto' is specified, then if the output is going to a terminal,2193 the ref names are shown as if 'short' were given, otherwise no ref2194 names are shown. This is the same as the `--decorate` option2195 of the `git log`.21962197log.follow::2198 If `true`, `git log` will act as if the `--follow` option was used when2199 a single <path> is given. This has the same limitations as `--follow`,2200 i.e. it cannot be used to follow multiple files and does not work well2201 on non-linear history.22022203log.graphColors::2204 A list of colors, separated by commas, that can be used to draw2205 history lines in `git log --graph`.22062207log.showRoot::2208 If true, the initial commit will be shown as a big creation event.2209 This is equivalent to a diff against an empty tree.2210 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2211 normally hide the root commit will now show it. True by default.22122213log.showSignature::2214 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2215 linkgit:git-whatchanged[1] assume `--show-signature`.22162217log.mailmap::2218 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2219 linkgit:git-whatchanged[1] assume `--use-mailmap`.22202221mailinfo.scissors::2222 If true, makes linkgit:git-mailinfo[1] (and therefore2223 linkgit:git-am[1]) act by default as if the --scissors option2224 was provided on the command-line. When active, this features2225 removes everything from the message body before a scissors2226 line (i.e. consisting mainly of ">8", "8<" and "-").22272228mailmap.file::2229 The location of an augmenting mailmap file. The default2230 mailmap, located in the root of the repository, is loaded2231 first, then the mailmap file pointed to by this variable.2232 The location of the mailmap file may be in a repository2233 subdirectory, or somewhere outside of the repository itself.2234 See linkgit:git-shortlog[1] and linkgit:git-blame[1].22352236mailmap.blob::2237 Like `mailmap.file`, but consider the value as a reference to a2238 blob in the repository. If both `mailmap.file` and2239 `mailmap.blob` are given, both are parsed, with entries from2240 `mailmap.file` taking precedence. In a bare repository, this2241 defaults to `HEAD:.mailmap`. In a non-bare repository, it2242 defaults to empty.22432244man.viewer::2245 Specify the programs that may be used to display help in the2246 'man' format. See linkgit:git-help[1].22472248man.<tool>.cmd::2249 Specify the command to invoke the specified man viewer. The2250 specified command is evaluated in shell with the man page2251 passed as argument. (See linkgit:git-help[1].)22522253man.<tool>.path::2254 Override the path for the given tool that may be used to2255 display help in the 'man' format. See linkgit:git-help[1].22562257include::merge-config.txt[]22582259mergetool.<tool>.path::2260 Override the path for the given tool. This is useful in case2261 your tool is not in the PATH.22622263mergetool.<tool>.cmd::2264 Specify the command to invoke the specified merge tool. The2265 specified command is evaluated in shell with the following2266 variables available: 'BASE' is the name of a temporary file2267 containing the common base of the files to be merged, if available;2268 'LOCAL' is the name of a temporary file containing the contents of2269 the file on the current branch; 'REMOTE' is the name of a temporary2270 file containing the contents of the file from the branch being2271 merged; 'MERGED' contains the name of the file to which the merge2272 tool should write the results of a successful merge.22732274mergetool.<tool>.trustExitCode::2275 For a custom merge command, specify whether the exit code of2276 the merge command can be used to determine whether the merge was2277 successful. If this is not set to true then the merge target file2278 timestamp is checked and the merge assumed to have been successful2279 if the file has been updated, otherwise the user is prompted to2280 indicate the success of the merge.22812282mergetool.meld.hasOutput::2283 Older versions of `meld` do not support the `--output` option.2284 Git will attempt to detect whether `meld` supports `--output`2285 by inspecting the output of `meld --help`. Configuring2286 `mergetool.meld.hasOutput` will make Git skip these checks and2287 use the configured value instead. Setting `mergetool.meld.hasOutput`2288 to `true` tells Git to unconditionally use the `--output` option,2289 and `false` avoids using `--output`.22902291mergetool.keepBackup::2292 After performing a merge, the original file with conflict markers2293 can be saved as a file with a `.orig` extension. If this variable2294 is set to `false` then this file is not preserved. Defaults to2295 `true` (i.e. keep the backup files).22962297mergetool.keepTemporaries::2298 When invoking a custom merge tool, Git uses a set of temporary2299 files to pass to the tool. If the tool returns an error and this2300 variable is set to `true`, then these temporary files will be2301 preserved, otherwise they will be removed after the tool has2302 exited. Defaults to `false`.23032304mergetool.writeToTemp::2305 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2306 conflicting files in the worktree by default. Git will attempt2307 to use a temporary directory for these files when set `true`.2308 Defaults to `false`.23092310mergetool.prompt::2311 Prompt before each invocation of the merge resolution program.23122313notes.mergeStrategy::2314 Which merge strategy to choose by default when resolving notes2315 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2316 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2317 section of linkgit:git-notes[1] for more information on each strategy.23182319notes.<name>.mergeStrategy::2320 Which merge strategy to choose when doing a notes merge into2321 refs/notes/<name>. This overrides the more general2322 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2323 linkgit:git-notes[1] for more information on the available strategies.23242325notes.displayRef::2326 The (fully qualified) refname from which to show notes when2327 showing commit messages. The value of this variable can be set2328 to a glob, in which case notes from all matching refs will be2329 shown. You may also specify this configuration variable2330 several times. A warning will be issued for refs that do not2331 exist, but a glob that does not match any refs is silently2332 ignored.2333+2334This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2335environment variable, which must be a colon separated list of refs or2336globs.2337+2338The effective value of "core.notesRef" (possibly overridden by2339GIT_NOTES_REF) is also implicitly added to the list of refs to be2340displayed.23412342notes.rewrite.<command>::2343 When rewriting commits with <command> (currently `amend` or2344 `rebase`) and this variable is set to `true`, Git2345 automatically copies your notes from the original to the2346 rewritten commit. Defaults to `true`, but see2347 "notes.rewriteRef" below.23482349notes.rewriteMode::2350 When copying notes during a rewrite (see the2351 "notes.rewrite.<command>" option), determines what to do if2352 the target commit already has a note. Must be one of2353 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2354 Defaults to `concatenate`.2355+2356This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2357environment variable.23582359notes.rewriteRef::2360 When copying notes during a rewrite, specifies the (fully2361 qualified) ref whose notes should be copied. The ref may be a2362 glob, in which case notes in all matching refs will be copied.2363 You may also specify this configuration several times.2364+2365Does not have a default value; you must configure this variable to2366enable note rewriting. Set it to `refs/notes/commits` to enable2367rewriting for the default commit notes.2368+2369This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2370environment variable, which must be a colon separated list of refs or2371globs.23722373pack.window::2374 The size of the window used by linkgit:git-pack-objects[1] when no2375 window size is given on the command line. Defaults to 10.23762377pack.depth::2378 The maximum delta depth used by linkgit:git-pack-objects[1] when no2379 maximum depth is given on the command line. Defaults to 50.2380 Maximum value is 4095.23812382pack.windowMemory::2383 The maximum size of memory that is consumed by each thread2384 in linkgit:git-pack-objects[1] for pack window memory when2385 no limit is given on the command line. The value can be2386 suffixed with "k", "m", or "g". When left unconfigured (or2387 set explicitly to 0), there will be no limit.23882389pack.compression::2390 An integer -1..9, indicating the compression level for objects2391 in a pack file. -1 is the zlib default. 0 means no2392 compression, and 1..9 are various speed/size tradeoffs, 9 being2393 slowest. If not set, defaults to core.compression. If that is2394 not set, defaults to -1, the zlib default, which is "a default2395 compromise between speed and compression (currently equivalent2396 to level 6)."2397+2398Note that changing the compression level will not automatically recompress2399all existing objects. You can force recompression by passing the -F option2400to linkgit:git-repack[1].24012402pack.deltaCacheSize::2403 The maximum memory in bytes used for caching deltas in2404 linkgit:git-pack-objects[1] before writing them out to a pack.2405 This cache is used to speed up the writing object phase by not2406 having to recompute the final delta result once the best match2407 for all objects is found. Repacking large repositories on machines2408 which are tight with memory might be badly impacted by this though,2409 especially if this cache pushes the system into swapping.2410 A value of 0 means no limit. The smallest size of 1 byte may be2411 used to virtually disable this cache. Defaults to 256 MiB.24122413pack.deltaCacheLimit::2414 The maximum size of a delta, that is cached in2415 linkgit:git-pack-objects[1]. This cache is used to speed up the2416 writing object phase by not having to recompute the final delta2417 result once the best match for all objects is found.2418 Defaults to 1000. Maximum value is 65535.24192420pack.threads::2421 Specifies the number of threads to spawn when searching for best2422 delta matches. This requires that linkgit:git-pack-objects[1]2423 be compiled with pthreads otherwise this option is ignored with a2424 warning. This is meant to reduce packing time on multiprocessor2425 machines. The required amount of memory for the delta search window2426 is however multiplied by the number of threads.2427 Specifying 0 will cause Git to auto-detect the number of CPU's2428 and set the number of threads accordingly.24292430pack.indexVersion::2431 Specify the default pack index version. Valid values are 1 for2432 legacy pack index used by Git versions prior to 1.5.2, and 2 for2433 the new pack index with capabilities for packs larger than 4 GB2434 as well as proper protection against the repacking of corrupted2435 packs. Version 2 is the default. Note that version 2 is enforced2436 and this config option ignored whenever the corresponding pack is2437 larger than 2 GB.2438+2439If you have an old Git that does not understand the version 2 `*.idx` file,2440cloning or fetching over a non native protocol (e.g. "http")2441that will copy both `*.pack` file and corresponding `*.idx` file from the2442other side may give you a repository that cannot be accessed with your2443older version of Git. If the `*.pack` file is smaller than 2 GB, however,2444you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2445the `*.idx` file.24462447pack.packSizeLimit::2448 The maximum size of a pack. This setting only affects2449 packing to a file when repacking, i.e. the git:// protocol2450 is unaffected. It can be overridden by the `--max-pack-size`2451 option of linkgit:git-repack[1]. Reaching this limit results2452 in the creation of multiple packfiles; which in turn prevents2453 bitmaps from being created.2454 The minimum size allowed is limited to 1 MiB.2455 The default is unlimited.2456 Common unit suffixes of 'k', 'm', or 'g' are2457 supported.24582459pack.useBitmaps::2460 When true, git will use pack bitmaps (if available) when packing2461 to stdout (e.g., during the server side of a fetch). Defaults to2462 true. You should not generally need to turn this off unless2463 you are debugging pack bitmaps.24642465pack.writeBitmaps (deprecated)::2466 This is a deprecated synonym for `repack.writeBitmaps`.24672468pack.writeBitmapHashCache::2469 When true, git will include a "hash cache" section in the bitmap2470 index (if one is written). This cache can be used to feed git's2471 delta heuristics, potentially leading to better deltas between2472 bitmapped and non-bitmapped objects (e.g., when serving a fetch2473 between an older, bitmapped pack and objects that have been2474 pushed since the last gc). The downside is that it consumes 42475 bytes per object of disk space, and that JGit's bitmap2476 implementation does not understand it, causing it to complain if2477 Git and JGit are used on the same repository. Defaults to false.24782479pager.<cmd>::2480 If the value is boolean, turns on or off pagination of the2481 output of a particular Git subcommand when writing to a tty.2482 Otherwise, turns on pagination for the subcommand using the2483 pager specified by the value of `pager.<cmd>`. If `--paginate`2484 or `--no-pager` is specified on the command line, it takes2485 precedence over this option. To disable pagination for all2486 commands, set `core.pager` or `GIT_PAGER` to `cat`.24872488pretty.<name>::2489 Alias for a --pretty= format string, as specified in2490 linkgit:git-log[1]. Any aliases defined here can be used just2491 as the built-in pretty formats could. For example,2492 running `git config pretty.changelog "format:* %H %s"`2493 would cause the invocation `git log --pretty=changelog`2494 to be equivalent to running `git log "--pretty=format:* %H %s"`.2495 Note that an alias with the same name as a built-in format2496 will be silently ignored.24972498protocol.allow::2499 If set, provide a user defined default policy for all protocols which2500 don't explicitly have a policy (`protocol.<name>.allow`). By default,2501 if unset, known-safe protocols (http, https, git, ssh, file) have a2502 default policy of `always`, known-dangerous protocols (ext) have a2503 default policy of `never`, and all other protocols have a default2504 policy of `user`. Supported policies:2505+2506--25072508* `always` - protocol is always able to be used.25092510* `never` - protocol is never able to be used.25112512* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is2513 either unset or has a value of 1. This policy should be used when you want a2514 protocol to be directly usable by the user but don't want it used by commands which2515 execute clone/fetch/push commands without user input, e.g. recursive2516 submodule initialization.25172518--25192520protocol.<name>.allow::2521 Set a policy to be used by protocol `<name>` with clone/fetch/push2522 commands. See `protocol.allow` above for the available policies.2523+2524The protocol names currently used by git are:2525+2526--2527 - `file`: any local file-based path (including `file://` URLs,2528 or local paths)25292530 - `git`: the anonymous git protocol over a direct TCP2531 connection (or proxy, if configured)25322533 - `ssh`: git over ssh (including `host:path` syntax,2534 `ssh://`, etc).25352536 - `http`: git over http, both "smart http" and "dumb http".2537 Note that this does _not_ include `https`; if you want to configure2538 both, you must do so individually.25392540 - any external helpers are named by their protocol (e.g., use2541 `hg` to allow the `git-remote-hg` helper)2542--25432544protocol.version::2545 Experimental. If set, clients will attempt to communicate with a2546 server using the specified protocol version. If unset, no2547 attempt will be made by the client to communicate using a2548 particular protocol version, this results in protocol version 02549 being used.2550 Supported versions:2551+2552--25532554* `0` - the original wire protocol.25552556* `1` - the original wire protocol with the addition of a version string2557 in the initial response from the server.25582559--25602561pull.ff::2562 By default, Git does not create an extra merge commit when merging2563 a commit that is a descendant of the current commit. Instead, the2564 tip of the current branch is fast-forwarded. When set to `false`,2565 this variable tells Git to create an extra merge commit in such2566 a case (equivalent to giving the `--no-ff` option from the command2567 line). When set to `only`, only such fast-forward merges are2568 allowed (equivalent to giving the `--ff-only` option from the2569 command line). This setting overrides `merge.ff` when pulling.25702571pull.rebase::2572 When true, rebase branches on top of the fetched branch, instead2573 of merging the default branch from the default remote when "git2574 pull" is run. See "branch.<name>.rebase" for setting this on a2575 per-branch basis.2576+2577When `merges`, pass the `--rebase-merges` option to 'git rebase'2578so that the local merge commits are included in the rebase (see2579linkgit:git-rebase[1] for details).2580+2581When preserve, also pass `--preserve-merges` along to 'git rebase'2582so that locally committed merge commits will not be flattened2583by running 'git pull'.2584+2585When the value is `interactive`, the rebase is run in interactive mode.2586+2587*NOTE*: this is a possibly dangerous operation; do *not* use2588it unless you understand the implications (see linkgit:git-rebase[1]2589for details).25902591pull.octopus::2592 The default merge strategy to use when pulling multiple branches2593 at once.25942595pull.twohead::2596 The default merge strategy to use when pulling a single branch.25972598push.default::2599 Defines the action `git push` should take if no refspec is2600 explicitly given. Different values are well-suited for2601 specific workflows; for instance, in a purely central workflow2602 (i.e. the fetch source is equal to the push destination),2603 `upstream` is probably what you want. Possible values are:2604+2605--26062607* `nothing` - do not push anything (error out) unless a refspec is2608 explicitly given. This is primarily meant for people who want to2609 avoid mistakes by always being explicit.26102611* `current` - push the current branch to update a branch with the same2612 name on the receiving end. Works in both central and non-central2613 workflows.26142615* `upstream` - push the current branch back to the branch whose2616 changes are usually integrated into the current branch (which is2617 called `@{upstream}`). This mode only makes sense if you are2618 pushing to the same repository you would normally pull from2619 (i.e. central workflow).26202621* `tracking` - This is a deprecated synonym for `upstream`.26222623* `simple` - in centralized workflow, work like `upstream` with an2624 added safety to refuse to push if the upstream branch's name is2625 different from the local one.2626+2627When pushing to a remote that is different from the remote you normally2628pull from, work as `current`. This is the safest option and is suited2629for beginners.2630+2631This mode has become the default in Git 2.0.26322633* `matching` - push all branches having the same name on both ends.2634 This makes the repository you are pushing to remember the set of2635 branches that will be pushed out (e.g. if you always push 'maint'2636 and 'master' there and no other branches, the repository you push2637 to will have these two branches, and your local 'maint' and2638 'master' will be pushed there).2639+2640To use this mode effectively, you have to make sure _all_ the2641branches you would push out are ready to be pushed out before2642running 'git push', as the whole point of this mode is to allow you2643to push all of the branches in one go. If you usually finish work2644on only one branch and push out the result, while other branches are2645unfinished, this mode is not for you. Also this mode is not2646suitable for pushing into a shared central repository, as other2647people may add new branches there, or update the tip of existing2648branches outside your control.2649+2650This used to be the default, but not since Git 2.0 (`simple` is the2651new default).26522653--26542655push.followTags::2656 If set to true enable `--follow-tags` option by default. You2657 may override this configuration at time of push by specifying2658 `--no-follow-tags`.26592660push.gpgSign::2661 May be set to a boolean value, or the string 'if-asked'. A true2662 value causes all pushes to be GPG signed, as if `--signed` is2663 passed to linkgit:git-push[1]. The string 'if-asked' causes2664 pushes to be signed if the server supports it, as if2665 `--signed=if-asked` is passed to 'git push'. A false value may2666 override a value from a lower-priority config file. An explicit2667 command-line flag always overrides this config option.26682669push.pushOption::2670 When no `--push-option=<option>` argument is given from the2671 command line, `git push` behaves as if each <value> of2672 this variable is given as `--push-option=<value>`.2673+2674This is a multi-valued variable, and an empty value can be used in a2675higher priority configuration file (e.g. `.git/config` in a2676repository) to clear the values inherited from a lower priority2677configuration files (e.g. `$HOME/.gitconfig`).2678+2679--26802681Example:26822683/etc/gitconfig2684 push.pushoption = a2685 push.pushoption = b26862687~/.gitconfig2688 push.pushoption = c26892690repo/.git/config2691 push.pushoption =2692 push.pushoption = b26932694This will result in only b (a and c are cleared).26952696--26972698push.recurseSubmodules::2699 Make sure all submodule commits used by the revisions to be pushed2700 are available on a remote-tracking branch. If the value is 'check'2701 then Git will verify that all submodule commits that changed in the2702 revisions to be pushed are available on at least one remote of the2703 submodule. If any commits are missing, the push will be aborted and2704 exit with non-zero status. If the value is 'on-demand' then all2705 submodules that changed in the revisions to be pushed will be2706 pushed. If on-demand was not able to push all necessary revisions2707 it will also be aborted and exit with non-zero status. If the value2708 is 'no' then default behavior of ignoring submodules when pushing2709 is retained. You may override this configuration at time of push by2710 specifying '--recurse-submodules=check|on-demand|no'.27112712include::rebase-config.txt[]27132714receive.advertiseAtomic::2715 By default, git-receive-pack will advertise the atomic push2716 capability to its clients. If you don't want to advertise this2717 capability, set this variable to false.27182719receive.advertisePushOptions::2720 When set to true, git-receive-pack will advertise the push options2721 capability to its clients. False by default.27222723receive.autogc::2724 By default, git-receive-pack will run "git-gc --auto" after2725 receiving data from git-push and updating refs. You can stop2726 it by setting this variable to false.27272728receive.certNonceSeed::2729 By setting this variable to a string, `git receive-pack`2730 will accept a `git push --signed` and verifies it by using2731 a "nonce" protected by HMAC using this string as a secret2732 key.27332734receive.certNonceSlop::2735 When a `git push --signed` sent a push certificate with a2736 "nonce" that was issued by a receive-pack serving the same2737 repository within this many seconds, export the "nonce"2738 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2739 hooks (instead of what the receive-pack asked the sending2740 side to include). This may allow writing checks in2741 `pre-receive` and `post-receive` a bit easier. Instead of2742 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2743 that records by how many seconds the nonce is stale to2744 decide if they want to accept the certificate, they only2745 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.27462747receive.fsckObjects::2748 If it is set to true, git-receive-pack will check all received2749 objects. See `transfer.fsckObjects` for what's checked.2750 Defaults to false. If not set, the value of2751 `transfer.fsckObjects` is used instead.27522753receive.fsck.<msg-id>::2754 Acts like `fsck.<msg-id>`, but is used by2755 linkgit:git-receive-pack[1] instead of2756 linkgit:git-fsck[1]. See the `fsck.<msg-id>` documentation for2757 details.27582759receive.fsck.skipList::2760 Acts like `fsck.skipList`, but is used by2761 linkgit:git-receive-pack[1] instead of2762 linkgit:git-fsck[1]. See the `fsck.skipList` documentation for2763 details.27642765receive.keepAlive::2766 After receiving the pack from the client, `receive-pack` may2767 produce no output (if `--quiet` was specified) while processing2768 the pack, causing some networks to drop the TCP connection.2769 With this option set, if `receive-pack` does not transmit2770 any data in this phase for `receive.keepAlive` seconds, it will2771 send a short keepalive packet. The default is 5 seconds; set2772 to 0 to disable keepalives entirely.27732774receive.unpackLimit::2775 If the number of objects received in a push is below this2776 limit then the objects will be unpacked into loose object2777 files. However if the number of received objects equals or2778 exceeds this limit then the received pack will be stored as2779 a pack, after adding any missing delta bases. Storing the2780 pack from a push can make the push operation complete faster,2781 especially on slow filesystems. If not set, the value of2782 `transfer.unpackLimit` is used instead.27832784receive.maxInputSize::2785 If the size of the incoming pack stream is larger than this2786 limit, then git-receive-pack will error out, instead of2787 accepting the pack file. If not set or set to 0, then the size2788 is unlimited.27892790receive.denyDeletes::2791 If set to true, git-receive-pack will deny a ref update that deletes2792 the ref. Use this to prevent such a ref deletion via a push.27932794receive.denyDeleteCurrent::2795 If set to true, git-receive-pack will deny a ref update that2796 deletes the currently checked out branch of a non-bare repository.27972798receive.denyCurrentBranch::2799 If set to true or "refuse", git-receive-pack will deny a ref update2800 to the currently checked out branch of a non-bare repository.2801 Such a push is potentially dangerous because it brings the HEAD2802 out of sync with the index and working tree. If set to "warn",2803 print a warning of such a push to stderr, but allow the push to2804 proceed. If set to false or "ignore", allow such pushes with no2805 message. Defaults to "refuse".2806+2807Another option is "updateInstead" which will update the working2808tree if pushing into the current branch. This option is2809intended for synchronizing working directories when one side is not easily2810accessible via interactive ssh (e.g. a live web site, hence the requirement2811that the working directory be clean). This mode also comes in handy when2812developing inside a VM to test and fix code on different Operating Systems.2813+2814By default, "updateInstead" will refuse the push if the working tree or2815the index have any difference from the HEAD, but the `push-to-checkout`2816hook can be used to customize this. See linkgit:githooks[5].28172818receive.denyNonFastForwards::2819 If set to true, git-receive-pack will deny a ref update which is2820 not a fast-forward. Use this to prevent such an update via a push,2821 even if that push is forced. This configuration variable is2822 set when initializing a shared repository.28232824receive.hideRefs::2825 This variable is the same as `transfer.hideRefs`, but applies2826 only to `receive-pack` (and so affects pushes, but not fetches).2827 An attempt to update or delete a hidden ref by `git push` is2828 rejected.28292830receive.updateServerInfo::2831 If set to true, git-receive-pack will run git-update-server-info2832 after receiving data from git-push and updating refs.28332834receive.shallowUpdate::2835 If set to true, .git/shallow can be updated when new refs2836 require new shallow roots. Otherwise those refs are rejected.28372838remote.pushDefault::2839 The remote to push to by default. Overrides2840 `branch.<name>.remote` for all branches, and is overridden by2841 `branch.<name>.pushRemote` for specific branches.28422843remote.<name>.url::2844 The URL of a remote repository. See linkgit:git-fetch[1] or2845 linkgit:git-push[1].28462847remote.<name>.pushurl::2848 The push URL of a remote repository. See linkgit:git-push[1].28492850remote.<name>.proxy::2851 For remotes that require curl (http, https and ftp), the URL to2852 the proxy to use for that remote. Set to the empty string to2853 disable proxying for that remote.28542855remote.<name>.proxyAuthMethod::2856 For remotes that require curl (http, https and ftp), the method to use for2857 authenticating against the proxy in use (probably set in2858 `remote.<name>.proxy`). See `http.proxyAuthMethod`.28592860remote.<name>.fetch::2861 The default set of "refspec" for linkgit:git-fetch[1]. See2862 linkgit:git-fetch[1].28632864remote.<name>.push::2865 The default set of "refspec" for linkgit:git-push[1]. See2866 linkgit:git-push[1].28672868remote.<name>.mirror::2869 If true, pushing to this remote will automatically behave2870 as if the `--mirror` option was given on the command line.28712872remote.<name>.skipDefaultUpdate::2873 If true, this remote will be skipped by default when updating2874 using linkgit:git-fetch[1] or the `update` subcommand of2875 linkgit:git-remote[1].28762877remote.<name>.skipFetchAll::2878 If true, this remote will be skipped by default when updating2879 using linkgit:git-fetch[1] or the `update` subcommand of2880 linkgit:git-remote[1].28812882remote.<name>.receivepack::2883 The default program to execute on the remote side when pushing. See2884 option --receive-pack of linkgit:git-push[1].28852886remote.<name>.uploadpack::2887 The default program to execute on the remote side when fetching. See2888 option --upload-pack of linkgit:git-fetch-pack[1].28892890remote.<name>.tagOpt::2891 Setting this value to --no-tags disables automatic tag following when2892 fetching from remote <name>. Setting it to --tags will fetch every2893 tag from remote <name>, even if they are not reachable from remote2894 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2895 override this setting. See options --tags and --no-tags of2896 linkgit:git-fetch[1].28972898remote.<name>.vcs::2899 Setting this to a value <vcs> will cause Git to interact with2900 the remote with the git-remote-<vcs> helper.29012902remote.<name>.prune::2903 When set to true, fetching from this remote by default will also2904 remove any remote-tracking references that no longer exist on the2905 remote (as if the `--prune` option was given on the command line).2906 Overrides `fetch.prune` settings, if any.29072908remote.<name>.pruneTags::2909 When set to true, fetching from this remote by default will also2910 remove any local tags that no longer exist on the remote if pruning2911 is activated in general via `remote.<name>.prune`, `fetch.prune` or2912 `--prune`. Overrides `fetch.pruneTags` settings, if any.2913+2914See also `remote.<name>.prune` and the PRUNING section of2915linkgit:git-fetch[1].29162917remotes.<group>::2918 The list of remotes which are fetched by "git remote update2919 <group>". See linkgit:git-remote[1].29202921repack.useDeltaBaseOffset::2922 By default, linkgit:git-repack[1] creates packs that use2923 delta-base offset. If you need to share your repository with2924 Git older than version 1.4.4, either directly or via a dumb2925 protocol such as http, then you need to set this option to2926 "false" and repack. Access from old Git versions over the2927 native protocol are unaffected by this option.29282929repack.packKeptObjects::2930 If set to true, makes `git repack` act as if2931 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2932 details. Defaults to `false` normally, but `true` if a bitmap2933 index is being written (either via `--write-bitmap-index` or2934 `repack.writeBitmaps`).29352936repack.writeBitmaps::2937 When true, git will write a bitmap index when packing all2938 objects to disk (e.g., when `git repack -a` is run). This2939 index can speed up the "counting objects" phase of subsequent2940 packs created for clones and fetches, at the cost of some disk2941 space and extra time spent on the initial repack. This has2942 no effect if multiple packfiles are created.2943 Defaults to false.29442945rerere.autoUpdate::2946 When set to true, `git-rerere` updates the index with the2947 resulting contents after it cleanly resolves conflicts using2948 previously recorded resolution. Defaults to false.29492950rerere.enabled::2951 Activate recording of resolved conflicts, so that identical2952 conflict hunks can be resolved automatically, should they be2953 encountered again. By default, linkgit:git-rerere[1] is2954 enabled if there is an `rr-cache` directory under the2955 `$GIT_DIR`, e.g. if "rerere" was previously used in the2956 repository.29572958sendemail.identity::2959 A configuration identity. When given, causes values in the2960 'sendemail.<identity>' subsection to take precedence over2961 values in the 'sendemail' section. The default identity is2962 the value of `sendemail.identity`.29632964sendemail.smtpEncryption::2965 See linkgit:git-send-email[1] for description. Note that this2966 setting is not subject to the 'identity' mechanism.29672968sendemail.smtpssl (deprecated)::2969 Deprecated alias for 'sendemail.smtpEncryption = ssl'.29702971sendemail.smtpsslcertpath::2972 Path to ca-certificates (either a directory or a single file).2973 Set it to an empty string to disable certificate verification.29742975sendemail.<identity>.*::2976 Identity-specific versions of the 'sendemail.*' parameters2977 found below, taking precedence over those when this2978 identity is selected, through either the command-line or2979 `sendemail.identity`.29802981sendemail.aliasesFile::2982sendemail.aliasFileType::2983sendemail.annotate::2984sendemail.bcc::2985sendemail.cc::2986sendemail.ccCmd::2987sendemail.chainReplyTo::2988sendemail.confirm::2989sendemail.envelopeSender::2990sendemail.from::2991sendemail.multiEdit::2992sendemail.signedoffbycc::2993sendemail.smtpPass::2994sendemail.suppresscc::2995sendemail.suppressFrom::2996sendemail.to::2997sendemail.tocmd::2998sendemail.smtpDomain::2999sendemail.smtpServer::3000sendemail.smtpServerPort::3001sendemail.smtpServerOption::3002sendemail.smtpUser::3003sendemail.thread::3004sendemail.transferEncoding::3005sendemail.validate::3006sendemail.xmailer::3007 See linkgit:git-send-email[1] for description.30083009sendemail.signedoffcc (deprecated)::3010 Deprecated alias for `sendemail.signedoffbycc`.30113012sendemail.smtpBatchSize::3013 Number of messages to be sent per connection, after that a relogin3014 will happen. If the value is 0 or undefined, send all messages in3015 one connection.3016 See also the `--batch-size` option of linkgit:git-send-email[1].30173018sendemail.smtpReloginDelay::3019 Seconds wait before reconnecting to smtp server.3020 See also the `--relogin-delay` option of linkgit:git-send-email[1].30213022showBranch.default::3023 The default set of branches for linkgit:git-show-branch[1].3024 See linkgit:git-show-branch[1].30253026splitIndex.maxPercentChange::3027 When the split index feature is used, this specifies the3028 percent of entries the split index can contain compared to the3029 total number of entries in both the split index and the shared3030 index before a new shared index is written.3031 The value should be between 0 and 100. If the value is 0 then3032 a new shared index is always written, if it is 100 a new3033 shared index is never written.3034 By default the value is 20, so a new shared index is written3035 if the number of entries in the split index would be greater3036 than 20 percent of the total number of entries.3037 See linkgit:git-update-index[1].30383039splitIndex.sharedIndexExpire::3040 When the split index feature is used, shared index files that3041 were not modified since the time this variable specifies will3042 be removed when a new shared index file is created. The value3043 "now" expires all entries immediately, and "never" suppresses3044 expiration altogether.3045 The default value is "2.weeks.ago".3046 Note that a shared index file is considered modified (for the3047 purpose of expiration) each time a new split-index file is3048 either created based on it or read from it.3049 See linkgit:git-update-index[1].30503051status.relativePaths::3052 By default, linkgit:git-status[1] shows paths relative to the3053 current directory. Setting this variable to `false` shows paths3054 relative to the repository root (this was the default for Git3055 prior to v1.5.4).30563057status.short::3058 Set to true to enable --short by default in linkgit:git-status[1].3059 The option --no-short takes precedence over this variable.30603061status.branch::3062 Set to true to enable --branch by default in linkgit:git-status[1].3063 The option --no-branch takes precedence over this variable.30643065status.displayCommentPrefix::3066 If set to true, linkgit:git-status[1] will insert a comment3067 prefix before each output line (starting with3068 `core.commentChar`, i.e. `#` by default). This was the3069 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.3070 Defaults to false.30713072status.renameLimit::3073 The number of files to consider when performing rename detection3074 in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to3075 the value of diff.renameLimit.30763077status.renames::3078 Whether and how Git detects renames in linkgit:git-status[1] and3079 linkgit:git-commit[1] . If set to "false", rename detection is3080 disabled. If set to "true", basic rename detection is enabled.3081 If set to "copies" or "copy", Git will detect copies, as well.3082 Defaults to the value of diff.renames.30833084status.showStash::3085 If set to true, linkgit:git-status[1] will display the number of3086 entries currently stashed away.3087 Defaults to false.30883089status.showUntrackedFiles::3090 By default, linkgit:git-status[1] and linkgit:git-commit[1] show3091 files which are not currently tracked by Git. Directories which3092 contain only untracked files, are shown with the directory name3093 only. Showing untracked files means that Git needs to lstat() all3094 the files in the whole repository, which might be slow on some3095 systems. So, this variable controls how the commands displays3096 the untracked files. Possible values are:3097+3098--3099* `no` - Show no untracked files.3100* `normal` - Show untracked files and directories.3101* `all` - Show also individual files in untracked directories.3102--3103+3104If this variable is not specified, it defaults to 'normal'.3105This variable can be overridden with the -u|--untracked-files option3106of linkgit:git-status[1] and linkgit:git-commit[1].31073108status.submoduleSummary::3109 Defaults to false.3110 If this is set to a non zero number or true (identical to -1 or an3111 unlimited number), the submodule summary will be enabled and a3112 summary of commits for modified submodules will be shown (see3113 --summary-limit option of linkgit:git-submodule[1]). Please note3114 that the summary output command will be suppressed for all3115 submodules when `diff.ignoreSubmodules` is set to 'all' or only3116 for those submodules where `submodule.<name>.ignore=all`. The only3117 exception to that rule is that status and commit will show staged3118 submodule changes. To3119 also view the summary for ignored submodules you can either use3120 the --ignore-submodules=dirty command-line option or the 'git3121 submodule summary' command, which shows a similar output but does3122 not honor these settings.31233124stash.showPatch::3125 If this is set to true, the `git stash show` command without an3126 option will show the stash entry in patch form. Defaults to false.3127 See description of 'show' command in linkgit:git-stash[1].31283129stash.showStat::3130 If this is set to true, the `git stash show` command without an3131 option will show diffstat of the stash entry. Defaults to true.3132 See description of 'show' command in linkgit:git-stash[1].31333134submodule.<name>.url::3135 The URL for a submodule. This variable is copied from the .gitmodules3136 file to the git config via 'git submodule init'. The user can change3137 the configured URL before obtaining the submodule via 'git submodule3138 update'. If neither submodule.<name>.active or submodule.active are3139 set, the presence of this variable is used as a fallback to indicate3140 whether the submodule is of interest to git commands.3141 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.31423143submodule.<name>.update::3144 The method by which a submodule is updated by 'git submodule update',3145 which is the only affected command, others such as3146 'git checkout --recurse-submodules' are unaffected. It exists for3147 historical reasons, when 'git submodule' was the only command to3148 interact with submodules; settings like `submodule.active`3149 and `pull.rebase` are more specific. It is populated by3150 `git submodule init` from the linkgit:gitmodules[5] file.3151 See description of 'update' command in linkgit:git-submodule[1].31523153submodule.<name>.branch::3154 The remote branch name for a submodule, used by `git submodule3155 update --remote`. Set this option to override the value found in3156 the `.gitmodules` file. See linkgit:git-submodule[1] and3157 linkgit:gitmodules[5] for details.31583159submodule.<name>.fetchRecurseSubmodules::3160 This option can be used to control recursive fetching of this3161 submodule. It can be overridden by using the --[no-]recurse-submodules3162 command-line option to "git fetch" and "git pull".3163 This setting will override that from in the linkgit:gitmodules[5]3164 file.31653166submodule.<name>.ignore::3167 Defines under what circumstances "git status" and the diff family show3168 a submodule as modified. When set to "all", it will never be considered3169 modified (but it will nonetheless show up in the output of status and3170 commit when it has been staged), "dirty" will ignore all changes3171 to the submodules work tree and3172 takes only differences between the HEAD of the submodule and the commit3173 recorded in the superproject into account. "untracked" will additionally3174 let submodules with modified tracked files in their work tree show up.3175 Using "none" (the default when this option is not set) also shows3176 submodules that have untracked files in their work tree as changed.3177 This setting overrides any setting made in .gitmodules for this submodule,3178 both settings can be overridden on the command line by using the3179 "--ignore-submodules" option. The 'git submodule' commands are not3180 affected by this setting.31813182submodule.<name>.active::3183 Boolean value indicating if the submodule is of interest to git3184 commands. This config option takes precedence over the3185 submodule.active config option. See linkgit:gitsubmodules[7] for3186 details.31873188submodule.active::3189 A repeated field which contains a pathspec used to match against a3190 submodule's path to determine if the submodule is of interest to git3191 commands. See linkgit:gitsubmodules[7] for details.31923193submodule.recurse::3194 Specifies if commands recurse into submodules by default. This3195 applies to all commands that have a `--recurse-submodules` option,3196 except `clone`.3197 Defaults to false.31983199submodule.fetchJobs::3200 Specifies how many submodules are fetched/cloned at the same time.3201 A positive integer allows up to that number of submodules fetched3202 in parallel. A value of 0 will give some reasonable default.3203 If unset, it defaults to 1.32043205submodule.alternateLocation::3206 Specifies how the submodules obtain alternates when submodules are3207 cloned. Possible values are `no`, `superproject`.3208 By default `no` is assumed, which doesn't add references. When the3209 value is set to `superproject` the submodule to be cloned computes3210 its alternates location relative to the superprojects alternate.32113212submodule.alternateErrorStrategy::3213 Specifies how to treat errors with the alternates for a submodule3214 as computed via `submodule.alternateLocation`. Possible values are3215 `ignore`, `info`, `die`. Default is `die`.32163217tag.forceSignAnnotated::3218 A boolean to specify whether annotated tags created should be GPG signed.3219 If `--annotate` is specified on the command line, it takes3220 precedence over this option.32213222tag.sort::3223 This variable controls the sort ordering of tags when displayed by3224 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the3225 value of this variable will be used as the default.32263227tar.umask::3228 This variable can be used to restrict the permission bits of3229 tar archive entries. The default is 0002, which turns off the3230 world write bit. The special value "user" indicates that the3231 archiving user's umask will be used instead. See umask(2) and3232 linkgit:git-archive[1].32333234transfer.fsckObjects::3235 When `fetch.fsckObjects` or `receive.fsckObjects` are3236 not set, the value of this variable is used instead.3237 Defaults to false.3238+3239When set, the fetch or receive will abort in the case of a malformed3240object or a link to a nonexistent object. In addition, various other3241issues are checked for, including legacy issues (see `fsck.<msg-id>`),3242and potential security issues like the existence of a `.GIT` directory3243or a malicious `.gitmodules` file (see the release notes for v2.2.13244and v2.17.1 for details). Other sanity and security checks may be3245added in future releases.3246+3247On the receiving side, failing fsckObjects will make those objects3248unreachable, see "QUARANTINE ENVIRONMENT" in3249linkgit:git-receive-pack[1]. On the fetch side, malformed objects will3250instead be left unreferenced in the repository.3251+3252Due to the non-quarantine nature of the `fetch.fsckObjects`3253implementation it can not be relied upon to leave the object store3254clean like `receive.fsckObjects` can.3255+3256As objects are unpacked they're written to the object store, so there3257can be cases where malicious objects get introduced even though the3258"fetch" failed, only to have a subsequent "fetch" succeed because only3259new incoming objects are checked, not those that have already been3260written to the object store. That difference in behavior should not be3261relied upon. In the future, such objects may be quarantined for3262"fetch" as well.3263+3264For now, the paranoid need to find some way to emulate the quarantine3265environment if they'd like the same protection as "push". E.g. in the3266case of an internal mirror do the mirroring in two steps, one to fetch3267the untrusted objects, and then do a second "push" (which will use the3268quarantine) to another internal repo, and have internal clients3269consume this pushed-to repository, or embargo internal fetches and3270only allow them once a full "fsck" has run (and no new fetches have3271happened in the meantime).32723273transfer.hideRefs::3274 String(s) `receive-pack` and `upload-pack` use to decide which3275 refs to omit from their initial advertisements. Use more than3276 one definition to specify multiple prefix strings. A ref that is3277 under the hierarchies listed in the value of this variable is3278 excluded, and is hidden when responding to `git push` or `git3279 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for3280 program-specific versions of this config.3281+3282You may also include a `!` in front of the ref name to negate the entry,3283explicitly exposing it, even if an earlier entry marked it as hidden.3284If you have multiple hideRefs values, later entries override earlier ones3285(and entries in more-specific config files override less-specific ones).3286+3287If a namespace is in use, the namespace prefix is stripped from each3288reference before it is matched against `transfer.hiderefs` patterns.3289For example, if `refs/heads/master` is specified in `transfer.hideRefs` and3290the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`3291is omitted from the advertisements but `refs/heads/master` and3292`refs/namespaces/bar/refs/heads/master` are still advertised as so-called3293"have" lines. In order to match refs before stripping, add a `^` in front of3294the ref name. If you combine `!` and `^`, `!` must be specified first.3295+3296Even if you hide refs, a client may still be able to steal the target3297objects via the techniques described in the "SECURITY" section of the3298linkgit:gitnamespaces[7] man page; it's best to keep private data in a3299separate repository.33003301transfer.unpackLimit::3302 When `fetch.unpackLimit` or `receive.unpackLimit` are3303 not set, the value of this variable is used instead.3304 The default value is 100.33053306uploadarchive.allowUnreachable::3307 If true, allow clients to use `git archive --remote` to request3308 any tree, whether reachable from the ref tips or not. See the3309 discussion in the "SECURITY" section of3310 linkgit:git-upload-archive[1] for more details. Defaults to3311 `false`.33123313uploadpack.hideRefs::3314 This variable is the same as `transfer.hideRefs`, but applies3315 only to `upload-pack` (and so affects only fetches, not pushes).3316 An attempt to fetch a hidden ref by `git fetch` will fail. See3317 also `uploadpack.allowTipSHA1InWant`.33183319uploadpack.allowTipSHA1InWant::3320 When `uploadpack.hideRefs` is in effect, allow `upload-pack`3321 to accept a fetch request that asks for an object at the tip3322 of a hidden ref (by default, such a request is rejected).3323 See also `uploadpack.hideRefs`. Even if this is false, a client3324 may be able to steal objects via the techniques described in the3325 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's3326 best to keep private data in a separate repository.33273328uploadpack.allowReachableSHA1InWant::3329 Allow `upload-pack` to accept a fetch request that asks for an3330 object that is reachable from any ref tip. However, note that3331 calculating object reachability is computationally expensive.3332 Defaults to `false`. Even if this is false, a client may be able3333 to steal objects via the techniques described in the "SECURITY"3334 section of the linkgit:gitnamespaces[7] man page; it's best to3335 keep private data in a separate repository.33363337uploadpack.allowAnySHA1InWant::3338 Allow `upload-pack` to accept a fetch request that asks for any3339 object at all.3340 Defaults to `false`.33413342uploadpack.keepAlive::3343 When `upload-pack` has started `pack-objects`, there may be a3344 quiet period while `pack-objects` prepares the pack. Normally3345 it would output progress information, but if `--quiet` was used3346 for the fetch, `pack-objects` will output nothing at all until3347 the pack data begins. Some clients and networks may consider3348 the server to be hung and give up. Setting this option instructs3349 `upload-pack` to send an empty keepalive packet every3350 `uploadpack.keepAlive` seconds. Setting this option to 03351 disables keepalive packets entirely. The default is 5 seconds.33523353uploadpack.packObjectsHook::3354 If this option is set, when `upload-pack` would run3355 `git pack-objects` to create a packfile for a client, it will3356 run this shell command instead. The `pack-objects` command and3357 arguments it _would_ have run (including the `git pack-objects`3358 at the beginning) are appended to the shell command. The stdin3359 and stdout of the hook are treated as if `pack-objects` itself3360 was run. I.e., `upload-pack` will feed input intended for3361 `pack-objects` to the hook, and expects a completed packfile on3362 stdout.33633364uploadpack.allowFilter::3365 If this option is set, `upload-pack` will support partial3366 clone and partial fetch object filtering.3367+3368Note that this configuration variable is ignored if it is seen in the3369repository-level config (this is a safety measure against fetching from3370untrusted repositories).33713372uploadpack.allowRefInWant::3373 If this option is set, `upload-pack` will support the `ref-in-want`3374 feature of the protocol version 2 `fetch` command. This feature3375 is intended for the benefit of load-balanced servers which may3376 not have the same view of what OIDs their refs point to due to3377 replication delay.33783379url.<base>.insteadOf::3380 Any URL that starts with this value will be rewritten to3381 start, instead, with <base>. In cases where some site serves a3382 large number of repositories, and serves them with multiple3383 access methods, and some users need to use different access3384 methods, this feature allows people to specify any of the3385 equivalent URLs and have Git automatically rewrite the URL to3386 the best alternative for the particular user, even for a3387 never-before-seen repository on the site. When more than one3388 insteadOf strings match a given URL, the longest match is used.3389+3390Note that any protocol restrictions will be applied to the rewritten3391URL. If the rewrite changes the URL to use a custom protocol or remote3392helper, you may need to adjust the `protocol.*.allow` config to permit3393the request. In particular, protocols you expect to use for submodules3394must be set to `always` rather than the default of `user`. See the3395description of `protocol.allow` above.33963397url.<base>.pushInsteadOf::3398 Any URL that starts with this value will not be pushed to;3399 instead, it will be rewritten to start with <base>, and the3400 resulting URL will be pushed to. In cases where some site serves3401 a large number of repositories, and serves them with multiple3402 access methods, some of which do not allow push, this feature3403 allows people to specify a pull-only URL and have Git3404 automatically use an appropriate URL to push, even for a3405 never-before-seen repository on the site. When more than one3406 pushInsteadOf strings match a given URL, the longest match is3407 used. If a remote has an explicit pushurl, Git will ignore this3408 setting for that remote.34093410user.email::3411 Your email address to be recorded in any newly created commits.3412 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and3413 `EMAIL` environment variables. See linkgit:git-commit-tree[1].34143415user.name::3416 Your full name to be recorded in any newly created commits.3417 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`3418 environment variables. See linkgit:git-commit-tree[1].34193420user.useConfigOnly::3421 Instruct Git to avoid trying to guess defaults for `user.email`3422 and `user.name`, and instead retrieve the values only from the3423 configuration. For example, if you have multiple email addresses3424 and would like to use a different one for each repository, then3425 with this configuration option set to `true` in the global config3426 along with a name, Git will prompt you to set up an email before3427 making new commits in a newly cloned repository.3428 Defaults to `false`.34293430user.signingKey::3431 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the3432 key you want it to automatically when creating a signed tag or3433 commit, you can override the default selection with this variable.3434 This option is passed unchanged to gpg's --local-user parameter,3435 so you may specify a key using any method that gpg supports.34363437versionsort.prereleaseSuffix (deprecated)::3438 Deprecated alias for `versionsort.suffix`. Ignored if3439 `versionsort.suffix` is set.34403441versionsort.suffix::3442 Even when version sort is used in linkgit:git-tag[1], tagnames3443 with the same base version but different suffixes are still sorted3444 lexicographically, resulting e.g. in prerelease tags appearing3445 after the main release (e.g. "1.0-rc1" after "1.0"). This3446 variable can be specified to determine the sorting order of tags3447 with different suffixes.3448+3449By specifying a single suffix in this variable, any tagname containing3450that suffix will appear before the corresponding main release. E.g. if3451the variable is set to "-rc", then all "1.0-rcX" tags will appear before3452"1.0". If specified multiple times, once per suffix, then the order of3453suffixes in the configuration will determine the sorting order of tagnames3454with those suffixes. E.g. if "-pre" appears before "-rc" in the3455configuration, then all "1.0-preX" tags will be listed before any3456"1.0-rcX" tags. The placement of the main release tag relative to tags3457with various suffixes can be determined by specifying the empty suffix3458among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and3459"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags3460are listed first, followed by "v4.8", then "v4.8-ckX" and finally3461"v4.8-bfsX".3462+3463If more than one suffixes match the same tagname, then that tagname will3464be sorted according to the suffix which starts at the earliest position in3465the tagname. If more than one different matching suffixes start at3466that earliest position, then that tagname will be sorted according to the3467longest of those suffixes.3468The sorting order between different suffixes is undefined if they are3469in multiple config files.34703471web.browser::3472 Specify a web browser that may be used by some commands.3473 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3474 may use it.34753476worktree.guessRemote::3477 With `add`, if no branch argument, and neither of `-b` nor3478 `-B` nor `--detach` are given, the command defaults to3479 creating a new branch from HEAD. If `worktree.guessRemote` is3480 set to true, `worktree add` tries to find a remote-tracking3481 branch whose name uniquely matches the new branch name. If3482 such a branch exists, it is checked out and set as "upstream"3483 for the new branch. If no such match can be found, it falls3484 back to creating a new branch from the current HEAD.