1CONFIGURATION FILE 2------------------ 3 4The Git configuration file contains a number of variables that affect 5the Git commands' behavior. The `.git/config` file in each repository 6is used to store the configuration for that repository, and 7`$HOME/.gitconfig` is used to store a per-user configuration as 8fallback values for the `.git/config` file. The file `/etc/gitconfig` 9can be used to store a system-wide default configuration. 10 11The configuration variables are used by both the Git plumbing 12and the porcelains. The variables are divided into sections, wherein 13the fully qualified variable name of the variable itself is the last 14dot-separated segment and the section name is everything before the last 15dot. The variable names are case-insensitive, allow only alphanumeric 16characters and `-`, and must start with an alphabetic character. Some 17variables may appear multiple times; we say then that the variable is 18multivalued. 19 20Syntax 21~~~~~~ 22 23The syntax is fairly flexible and permissive; whitespaces are mostly 24ignored. The '#' and ';' characters begin comments to the end of line, 25blank lines are ignored. 26 27The file consists of sections and variables. A section begins with 28the name of the section in square brackets and continues until the next 29section begins. Section names are case-insensitive. Only alphanumeric 30characters, `-` and `.` are allowed in section names. Each variable 31must belong to some section, which means that there must be a section 32header before the first setting of a variable. 33 34Sections can be further divided into subsections. To begin a subsection 35put its name in double quotes, separated by space from the section name, 36in the section header, like in the example below: 37 38-------- 39 [section "subsection"] 40 41-------- 42 43Subsection names are case sensitive and can contain any characters except 44newline and the null byte. Doublequote `"` and backslash can be included 45by escaping them as `\"` and `\\`, respectively. Backslashes preceding 46other characters are dropped when reading; for example, `\t` is read as 47`t` and `\0` is read as `0` Section headers cannot span multiple lines. 48Variables may belong directly to a section or to a given subsection. You 49can have `[section]` if you have `[section "subsection"]`, but you don't 50need to. 51 52There is also a deprecated `[section.subsection]` syntax. With this 53syntax, the subsection name is converted to lower-case and is also 54compared case sensitively. These subsection names follow the same 55restrictions as section names. 56 57All the other lines (and the remainder of the line after the section 58header) are recognized as setting variables, in the form 59'name = value' (or just 'name', which is a short-hand to say that 60the variable is the boolean "true"). 61The variable names are case-insensitive, allow only alphanumeric characters 62and `-`, and must start with an alphabetic character. 63 64A line that defines a value can be continued to the next line by 65ending it with a `\`; the backquote and the end-of-line are 66stripped. Leading whitespaces after 'name =', the remainder of the 67line after the first comment character '#' or ';', and trailing 68whitespaces of the line are discarded unless they are enclosed in 69double quotes. Internal whitespaces within the value are retained 70verbatim. 71 72Inside double quotes, double quote `"` and backslash `\` characters 73must be escaped: use `\"` for `"` and `\\` for `\`. 74 75The following escape sequences (beside `\"` and `\\`) are recognized: 76`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) 77and `\b` for backspace (BS). Other char escape sequences (including octal 78escape sequences) are invalid. 79 80 81Includes 82~~~~~~~~ 83 84The `include` and `includeIf` sections allow you to include config 85directives from another source. These sections behave identically to 86each other with the exception that `includeIf` sections may be ignored 87if their condition does not evaluate to true; see "Conditional includes" 88below. 89 90You can include a config file from another by setting the special 91`include.path` (or `includeIf.*.path`) variable to the name of the file 92to be included. The variable takes a pathname as its value, and is 93subject to tilde expansion. These variables can be given multiple times. 94 95The contents of the included file are inserted immediately, as if they 96had been found at the location of the include directive. If the value of the 97variable is a relative path, the path is considered to 98be relative to the configuration file in which the include directive 99was found. See below for examples. 100 101Conditional includes 102~~~~~~~~~~~~~~~~~~~~ 103 104You can include a config file from another conditionally by setting a 105`includeIf.<condition>.path` variable to the name of the file to be 106included. 107 108The condition starts with a keyword followed by a colon and some data 109whose format and meaning depends on the keyword. Supported keywords 110are: 111 112`gitdir`:: 113 114 The data that follows the keyword `gitdir:` is used as a glob 115 pattern. If the location of the .git directory matches the 116 pattern, the include condition is met. 117+ 118The .git location may be auto-discovered, or come from `$GIT_DIR` 119environment variable. If the repository is auto discovered via a .git 120file (e.g. from submodules, or a linked worktree), the .git location 121would be the final location where the .git directory is, not where the 122.git file is. 123+ 124The pattern can contain standard globbing wildcards and two additional 125ones, `**/` and `/**`, that can match multiple path components. Please 126refer to linkgit:gitignore[5] for details. For convenience: 127 128 * If the pattern starts with `~/`, `~` will be substituted with the 129 content of the environment variable `HOME`. 130 131 * If the pattern starts with `./`, it is replaced with the directory 132 containing the current config file. 133 134 * If the pattern does not start with either `~/`, `./` or `/`, `**/` 135 will be automatically prepended. For example, the pattern `foo/bar` 136 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`. 137 138 * If the pattern ends with `/`, `**` will be automatically added. For 139 example, the pattern `foo/` becomes `foo/**`. In other words, it 140 matches "foo" and everything inside, recursively. 141 142`gitdir/i`:: 143 This is the same as `gitdir` except that matching is done 144 case-insensitively (e.g. on case-insensitive file sytems) 145 146A few more notes on matching via `gitdir` and `gitdir/i`: 147 148 * Symlinks in `$GIT_DIR` are not resolved before matching. 149 150 * Both the symlink & realpath versions of paths will be matched 151 outside of `$GIT_DIR`. E.g. if ~/git is a symlink to 152 /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git` 153 will match. 154+ 155This was not the case in the initial release of this feature in 156v2.13.0, which only matched the realpath version. Configuration that 157wants to be compatible with the initial release of this feature needs 158to either specify only the realpath version, or both versions. 159 160 * Note that "../" is not special and will match literally, which is 161 unlikely what you want. 162 163Example 164~~~~~~~ 165 166 # Core variables 167 [core] 168 ; Don't trust file modes 169 filemode = false 170 171 # Our diff algorithm 172 [diff] 173 external = /usr/local/bin/diff-wrapper 174 renames = true 175 176 [branch "devel"] 177 remote = origin 178 merge = refs/heads/devel 179 180 # Proxy settings 181 [core] 182 gitProxy="ssh" for "kernel.org" 183 gitProxy=default-proxy ; for the rest 184 185 [include] 186 path = /path/to/foo.inc ; include by absolute path 187 path = foo.inc ; find "foo.inc" relative to the current file 188 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory 189 190 ; include if $GIT_DIR is /path/to/foo/.git 191 [includeIf "gitdir:/path/to/foo/.git"] 192 path = /path/to/foo.inc 193 194 ; include for all repositories inside /path/to/group 195 [includeIf "gitdir:/path/to/group/"] 196 path = /path/to/foo.inc 197 198 ; include for all repositories inside $HOME/to/group 199 [includeIf "gitdir:~/to/group/"] 200 path = /path/to/foo.inc 201 202 ; relative paths are always relative to the including 203 ; file (if the condition is true); their location is not 204 ; affected by the condition 205 [includeIf "gitdir:/path/to/group/"] 206 path = foo.inc 207 208Values 209~~~~~~ 210 211Values of many variables are treated as a simple string, but there 212are variables that take values of specific types and there are rules 213as to how to spell them. 214 215boolean:: 216 217 When a variable is said to take a boolean value, many 218 synonyms are accepted for 'true' and 'false'; these are all 219 case-insensitive. 220 221 true;; Boolean true literals are `yes`, `on`, `true`, 222 and `1`. Also, a variable defined without `= <value>` 223 is taken as true. 224 225 false;; Boolean false literals are `no`, `off`, `false`, 226 `0` and the empty string. 227+ 228When converting value to the canonical form using `--bool` type 229specifier, 'git config' will ensure that the output is "true" or 230"false" (spelled in lowercase). 231 232integer:: 233 The value for many variables that specify various sizes can 234 be suffixed with `k`, `M`,... to mean "scale the number by 235 1024", "by 1024x1024", etc. 236 237color:: 238 The value for a variable that takes a color is a list of 239 colors (at most two, one for foreground and one for background) 240 and attributes (as many as you want), separated by spaces. 241+ 242The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`, 243`blue`, `magenta`, `cyan` and `white`. The first color given is the 244foreground; the second is the background. 245+ 246Colors may also be given as numbers between 0 and 255; these use ANSI 247256-color mode (but note that not all terminals may support this). If 248your terminal supports it, you may also specify 24-bit RGB values as 249hex, like `#ff0ab3`. 250+ 251The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`, 252`italic`, and `strike` (for crossed-out or "strikethrough" letters). 253The position of any attributes with respect to the colors 254(before, after, or in between), doesn't matter. Specific attributes may 255be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`, 256`no-ul`, etc). 257+ 258An empty color string produces no color effect at all. This can be used 259to avoid coloring specific elements without disabling color entirely. 260+ 261For git's pre-defined color slots, the attributes are meant to be reset 262at the beginning of each item in the colored output. So setting 263`color.decorate.branch` to `black` will paint that branch name in a 264plain `black`, even if the previous thing on the same output line (e.g. 265opening parenthesis before the list of branch names in `log --decorate` 266output) is set to be painted with `bold` or some other attribute. 267However, custom log formats may do more complicated and layered 268coloring, and the negated forms may be useful there. 269 270pathname:: 271 A variable that takes a pathname value can be given a 272 string that begins with "`~/`" or "`~user/`", and the usual 273 tilde expansion happens to such a string: `~/` 274 is expanded to the value of `$HOME`, and `~user/` to the 275 specified user's home directory. 276 277 278Variables 279~~~~~~~~~ 280 281Note that this list is non-comprehensive and not necessarily complete. 282For command-specific variables, you will find a more detailed description 283in the appropriate manual page. 284 285Other git-related tools may and do use their own variables. When 286inventing new variables for use in your own tool, make sure their 287names do not conflict with those that are used by Git itself and 288other popular tools, and describe them in your documentation. 289 290 291advice.*:: 292 These variables control various optional help messages designed to 293 aid new users. All 'advice.*' variables default to 'true', and you 294 can tell Git that you do not need help by setting these to 'false': 295+ 296-- 297 pushUpdateRejected:: 298 Set this variable to 'false' if you want to disable 299 'pushNonFFCurrent', 300 'pushNonFFMatching', 'pushAlreadyExists', 301 'pushFetchFirst', and 'pushNeedsForce' 302 simultaneously. 303 pushNonFFCurrent:: 304 Advice shown when linkgit:git-push[1] fails due to a 305 non-fast-forward update to the current branch. 306 pushNonFFMatching:: 307 Advice shown when you ran linkgit:git-push[1] and pushed 308 'matching refs' explicitly (i.e. you used ':', or 309 specified a refspec that isn't your current branch) and 310 it resulted in a non-fast-forward error. 311 pushAlreadyExists:: 312 Shown when linkgit:git-push[1] rejects an update that 313 does not qualify for fast-forwarding (e.g., a tag.) 314 pushFetchFirst:: 315 Shown when linkgit:git-push[1] rejects an update that 316 tries to overwrite a remote ref that points at an 317 object we do not have. 318 pushNeedsForce:: 319 Shown when linkgit:git-push[1] rejects an update that 320 tries to overwrite a remote ref that points at an 321 object that is not a commit-ish, or make the remote 322 ref point at an object that is not a commit-ish. 323 statusHints:: 324 Show directions on how to proceed from the current 325 state in the output of linkgit:git-status[1], in 326 the template shown when writing commit messages in 327 linkgit:git-commit[1], and in the help message shown 328 by linkgit:git-checkout[1] when switching branch. 329 statusUoption:: 330 Advise to consider using the `-u` option to linkgit:git-status[1] 331 when the command takes more than 2 seconds to enumerate untracked 332 files. 333 commitBeforeMerge:: 334 Advice shown when linkgit:git-merge[1] refuses to 335 merge to avoid overwriting local changes. 336 resolveConflict:: 337 Advice shown by various commands when conflicts 338 prevent the operation from being performed. 339 implicitIdentity:: 340 Advice on how to set your identity configuration when 341 your information is guessed from the system username and 342 domain name. 343 detachedHead:: 344 Advice shown when you used linkgit:git-checkout[1] to 345 move to the detach HEAD state, to instruct how to create 346 a local branch after the fact. 347 amWorkDir:: 348 Advice that shows the location of the patch file when 349 linkgit:git-am[1] fails to apply it. 350 rmHints:: 351 In case of failure in the output of linkgit:git-rm[1], 352 show directions on how to proceed from the current state. 353 addEmbeddedRepo:: 354 Advice on what to do when you've accidentally added one 355 git repo inside of another. 356 ignoredHook:: 357 Advice shown if an hook is ignored because the hook is not 358 set as executable. 359 waitingForEditor:: 360 Print a message to the terminal whenever Git is waiting for 361 editor input from the user. 362-- 363 364core.fileMode:: 365 Tells Git if the executable bit of files in the working tree 366 is to be honored. 367+ 368Some filesystems lose the executable bit when a file that is 369marked as executable is checked out, or checks out a 370non-executable file with executable bit on. 371linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem 372to see if it handles the executable bit correctly 373and this variable is automatically set as necessary. 374+ 375A repository, however, may be on a filesystem that handles 376the filemode correctly, and this variable is set to 'true' 377when created, but later may be made accessible from another 378environment that loses the filemode (e.g. exporting ext4 via 379CIFS mount, visiting a Cygwin created repository with 380Git for Windows or Eclipse). 381In such a case it may be necessary to set this variable to 'false'. 382See linkgit:git-update-index[1]. 383+ 384The default is true (when core.filemode is not specified in the config file). 385 386core.hideDotFiles:: 387 (Windows-only) If true, mark newly-created directories and files whose 388 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/` 389 directory is hidden, but no other files starting with a dot. The 390 default mode is 'dotGitOnly'. 391 392core.ignoreCase:: 393 If true, this option enables various workarounds to enable 394 Git to work better on filesystems that are not case sensitive, 395 like FAT. For example, if a directory listing finds 396 "makefile" when Git expects "Makefile", Git will assume 397 it is really the same file, and continue to remember it as 398 "Makefile". 399+ 400The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 401will probe and set core.ignoreCase true if appropriate when the repository 402is created. 403 404core.precomposeUnicode:: 405 This option is only used by Mac OS implementation of Git. 406 When core.precomposeUnicode=true, Git reverts the unicode decomposition 407 of filenames done by Mac OS. This is useful when sharing a repository 408 between Mac OS and Linux or Windows. 409 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 410 When false, file names are handled fully transparent by Git, 411 which is backward compatible with older versions of Git. 412 413core.protectHFS:: 414 If set to true, do not allow checkout of paths that would 415 be considered equivalent to `.git` on an HFS+ filesystem. 416 Defaults to `true` on Mac OS, and `false` elsewhere. 417 418core.protectNTFS:: 419 If set to true, do not allow checkout of paths that would 420 cause problems with the NTFS filesystem, e.g. conflict with 421 8.3 "short" names. 422 Defaults to `true` on Windows, and `false` elsewhere. 423 424core.fsmonitor:: 425 If set, the value of this variable is used as a command which 426 will identify all files that may have changed since the 427 requested date/time. This information is used to speed up git by 428 avoiding unnecessary processing of files that have not changed. 429 See the "fsmonitor-watchman" section of linkgit:githooks[5]. 430 431core.trustctime:: 432 If false, the ctime differences between the index and the 433 working tree are ignored; useful when the inode change time 434 is regularly modified by something outside Git (file system 435 crawlers and some backup systems). 436 See linkgit:git-update-index[1]. True by default. 437 438core.splitIndex:: 439 If true, the split-index feature of the index will be used. 440 See linkgit:git-update-index[1]. False by default. 441 442core.untrackedCache:: 443 Determines what to do about the untracked cache feature of the 444 index. It will be kept, if this variable is unset or set to 445 `keep`. It will automatically be added if set to `true`. And 446 it will automatically be removed, if set to `false`. Before 447 setting it to `true`, you should check that mtime is working 448 properly on your system. 449 See linkgit:git-update-index[1]. `keep` by default. 450 451core.checkStat:: 452 Determines which stat fields to match between the index 453 and work tree. The user can set this to 'default' or 454 'minimal'. Default (or explicitly 'default'), is to check 455 all fields, including the sub-second part of mtime and ctime. 456 457core.quotePath:: 458 Commands that output paths (e.g. 'ls-files', 'diff'), will 459 quote "unusual" characters in the pathname by enclosing the 460 pathname in double-quotes and escaping those characters with 461 backslashes in the same way C escapes control characters (e.g. 462 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with 463 values larger than 0x80 (e.g. octal `\302\265` for "micro" in 464 UTF-8). If this variable is set to false, bytes higher than 465 0x80 are not considered "unusual" any more. Double-quotes, 466 backslash and control characters are always escaped regardless 467 of the setting of this variable. A simple space character is 468 not considered "unusual". Many commands can output pathnames 469 completely verbatim using the `-z` option. The default value 470 is true. 471 472core.eol:: 473 Sets the line ending type to use in the working directory for 474 files that have the `text` property set when core.autocrlf is false. 475 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's 476 native line ending. The default value is `native`. See 477 linkgit:gitattributes[5] for more information on end-of-line 478 conversion. 479 480core.safecrlf:: 481 If true, makes Git check if converting `CRLF` is reversible when 482 end-of-line conversion is active. Git will verify if a command 483 modifies a file in the work tree either directly or indirectly. 484 For example, committing a file followed by checking out the 485 same file should yield the original file in the work tree. If 486 this is not the case for the current setting of 487 `core.autocrlf`, Git will reject the file. The variable can 488 be set to "warn", in which case Git will only warn about an 489 irreversible conversion but continue the operation. 490+ 491CRLF conversion bears a slight chance of corrupting data. 492When it is enabled, Git will convert CRLF to LF during commit and LF to 493CRLF during checkout. A file that contains a mixture of LF and 494CRLF before the commit cannot be recreated by Git. For text 495files this is the right thing to do: it corrects line endings 496such that we have only LF line endings in the repository. 497But for binary files that are accidentally classified as text the 498conversion can corrupt data. 499+ 500If you recognize such corruption early you can easily fix it by 501setting the conversion type explicitly in .gitattributes. Right 502after committing you still have the original file in your work 503tree and this file is not yet corrupted. You can explicitly tell 504Git that this file is binary and Git will handle the file 505appropriately. 506+ 507Unfortunately, the desired effect of cleaning up text files with 508mixed line endings and the undesired effect of corrupting binary 509files cannot be distinguished. In both cases CRLFs are removed 510in an irreversible way. For text files this is the right thing 511to do because CRLFs are line endings, while for binary files 512converting CRLFs corrupts data. 513+ 514Note, this safety check does not mean that a checkout will generate a 515file identical to the original file for a different setting of 516`core.eol` and `core.autocrlf`, but only for the current one. For 517example, a text file with `LF` would be accepted with `core.eol=lf` 518and could later be checked out with `core.eol=crlf`, in which case the 519resulting file would contain `CRLF`, although the original file 520contained `LF`. However, in both work trees the line endings would be 521consistent, that is either all `LF` or all `CRLF`, but never mixed. A 522file with mixed line endings would be reported by the `core.safecrlf` 523mechanism. 524 525core.autocrlf:: 526 Setting this variable to "true" is the same as setting 527 the `text` attribute to "auto" on all files and core.eol to "crlf". 528 Set to true if you want to have `CRLF` line endings in your 529 working directory and the repository has LF line endings. 530 This variable can be set to 'input', 531 in which case no output conversion is performed. 532 533core.symlinks:: 534 If false, symbolic links are checked out as small plain files that 535 contain the link text. linkgit:git-update-index[1] and 536 linkgit:git-add[1] will not change the recorded type to regular 537 file. Useful on filesystems like FAT that do not support 538 symbolic links. 539+ 540The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 541will probe and set core.symlinks false if appropriate when the repository 542is created. 543 544core.gitProxy:: 545 A "proxy command" to execute (as 'command host port') instead 546 of establishing direct connection to the remote server when 547 using the Git protocol for fetching. If the variable value is 548 in the "COMMAND for DOMAIN" format, the command is applied only 549 on hostnames ending with the specified domain string. This variable 550 may be set multiple times and is matched in the given order; 551 the first match wins. 552+ 553Can be overridden by the `GIT_PROXY_COMMAND` environment variable 554(which always applies universally, without the special "for" 555handling). 556+ 557The special string `none` can be used as the proxy command to 558specify that no proxy be used for a given domain pattern. 559This is useful for excluding servers inside a firewall from 560proxy use, while defaulting to a common proxy for external domains. 561 562core.sshCommand:: 563 If this variable is set, `git fetch` and `git push` will 564 use the specified command instead of `ssh` when they need to 565 connect to a remote system. The command is in the same form as 566 the `GIT_SSH_COMMAND` environment variable and is overridden 567 when the environment variable is set. 568 569core.ignoreStat:: 570 If true, Git will avoid using lstat() calls to detect if files have 571 changed by setting the "assume-unchanged" bit for those tracked files 572 which it has updated identically in both the index and working tree. 573+ 574When files are modified outside of Git, the user will need to stage 575the modified files explicitly (e.g. see 'Examples' section in 576linkgit:git-update-index[1]). 577Git will not normally detect changes to those files. 578+ 579This is useful on systems where lstat() calls are very slow, such as 580CIFS/Microsoft Windows. 581+ 582False by default. 583 584core.preferSymlinkRefs:: 585 Instead of the default "symref" format for HEAD 586 and other symbolic reference files, use symbolic links. 587 This is sometimes needed to work with old scripts that 588 expect HEAD to be a symbolic link. 589 590core.bare:: 591 If true this repository is assumed to be 'bare' and has no 592 working directory associated with it. If this is the case a 593 number of commands that require a working directory will be 594 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 595+ 596This setting is automatically guessed by linkgit:git-clone[1] or 597linkgit:git-init[1] when the repository was created. By default a 598repository that ends in "/.git" is assumed to be not bare (bare = 599false), while all other repositories are assumed to be bare (bare 600= true). 601 602core.worktree:: 603 Set the path to the root of the working tree. 604 If `GIT_COMMON_DIR` environment variable is set, core.worktree 605 is ignored and not used for determining the root of working tree. 606 This can be overridden by the `GIT_WORK_TREE` environment 607 variable and the `--work-tree` command-line option. 608 The value can be an absolute path or relative to the path to 609 the .git directory, which is either specified by --git-dir 610 or GIT_DIR, or automatically discovered. 611 If --git-dir or GIT_DIR is specified but none of 612 --work-tree, GIT_WORK_TREE and core.worktree is specified, 613 the current working directory is regarded as the top level 614 of your working tree. 615+ 616Note that this variable is honored even when set in a configuration 617file in a ".git" subdirectory of a directory and its value differs 618from the latter directory (e.g. "/path/to/.git/config" has 619core.worktree set to "/different/path"), which is most likely a 620misconfiguration. Running Git commands in the "/path/to" directory will 621still use "/different/path" as the root of the work tree and can cause 622confusion unless you know what you are doing (e.g. you are creating a 623read-only snapshot of the same index to a location different from the 624repository's usual working tree). 625 626core.logAllRefUpdates:: 627 Enable the reflog. Updates to a ref <ref> is logged to the file 628 "`$GIT_DIR/logs/<ref>`", by appending the new and old 629 SHA-1, the date/time and the reason of the update, but 630 only when the file exists. If this configuration 631 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`" 632 file is automatically created for branch heads (i.e. under 633 `refs/heads/`), remote refs (i.e. under `refs/remotes/`), 634 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`. 635 If it is set to `always`, then a missing reflog is automatically 636 created for any ref under `refs/`. 637+ 638This information can be used to determine what commit 639was the tip of a branch "2 days ago". 640+ 641This value is true by default in a repository that has 642a working directory associated with it, and false by 643default in a bare repository. 644 645core.repositoryFormatVersion:: 646 Internal variable identifying the repository format and layout 647 version. 648 649core.sharedRepository:: 650 When 'group' (or 'true'), the repository is made shareable between 651 several users in a group (making sure all the files and objects are 652 group-writable). When 'all' (or 'world' or 'everybody'), the 653 repository will be readable by all users, additionally to being 654 group-shareable. When 'umask' (or 'false'), Git will use permissions 655 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 656 files in the repository will have this mode value. '0xxx' will override 657 user's umask value (whereas the other options will only override 658 requested parts of the user's umask value). Examples: '0660' will make 659 the repo read/write-able for the owner and group, but inaccessible to 660 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 661 repository that is group-readable but not group-writable. 662 See linkgit:git-init[1]. False by default. 663 664core.warnAmbiguousRefs:: 665 If true, Git will warn you if the ref name you passed it is ambiguous 666 and might match multiple refs in the repository. True by default. 667 668core.compression:: 669 An integer -1..9, indicating a default compression level. 670 -1 is the zlib default. 0 means no compression, 671 and 1..9 are various speed/size tradeoffs, 9 being slowest. 672 If set, this provides a default to other compression variables, 673 such as `core.looseCompression` and `pack.compression`. 674 675core.looseCompression:: 676 An integer -1..9, indicating the compression level for objects that 677 are not in a pack file. -1 is the zlib default. 0 means no 678 compression, and 1..9 are various speed/size tradeoffs, 9 being 679 slowest. If not set, defaults to core.compression. If that is 680 not set, defaults to 1 (best speed). 681 682core.packedGitWindowSize:: 683 Number of bytes of a pack file to map into memory in a 684 single mapping operation. Larger window sizes may allow 685 your system to process a smaller number of large pack files 686 more quickly. Smaller window sizes will negatively affect 687 performance due to increased calls to the operating system's 688 memory manager, but may improve performance when accessing 689 a large number of large pack files. 690+ 691Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 692MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 693be reasonable for all users/operating systems. You probably do 694not need to adjust this value. 695+ 696Common unit suffixes of 'k', 'm', or 'g' are supported. 697 698core.packedGitLimit:: 699 Maximum number of bytes to map simultaneously into memory 700 from pack files. If Git needs to access more than this many 701 bytes at once to complete an operation it will unmap existing 702 regions to reclaim virtual address space within the process. 703+ 704Default is 256 MiB on 32 bit platforms and 32 TiB (effectively 705unlimited) on 64 bit platforms. 706This should be reasonable for all users/operating systems, except on 707the largest projects. You probably do not need to adjust this value. 708+ 709Common unit suffixes of 'k', 'm', or 'g' are supported. 710 711core.deltaBaseCacheLimit:: 712 Maximum number of bytes to reserve for caching base objects 713 that may be referenced by multiple deltified objects. By storing the 714 entire decompressed base objects in a cache Git is able 715 to avoid unpacking and decompressing frequently used base 716 objects multiple times. 717+ 718Default is 96 MiB on all platforms. This should be reasonable 719for all users/operating systems, except on the largest projects. 720You probably do not need to adjust this value. 721+ 722Common unit suffixes of 'k', 'm', or 'g' are supported. 723 724core.bigFileThreshold:: 725 Files larger than this size are stored deflated, without 726 attempting delta compression. Storing large files without 727 delta compression avoids excessive memory usage, at the 728 slight expense of increased disk usage. Additionally files 729 larger than this size are always treated as binary. 730+ 731Default is 512 MiB on all platforms. This should be reasonable 732for most projects as source code and other text files can still 733be delta compressed, but larger binary media files won't be. 734+ 735Common unit suffixes of 'k', 'm', or 'g' are supported. 736 737core.excludesFile:: 738 Specifies the pathname to the file that contains patterns to 739 describe paths that are not meant to be tracked, in addition 740 to '.gitignore' (per-directory) and '.git/info/exclude'. 741 Defaults to `$XDG_CONFIG_HOME/git/ignore`. 742 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` 743 is used instead. See linkgit:gitignore[5]. 744 745core.askPass:: 746 Some commands (e.g. svn and http interfaces) that interactively 747 ask for a password can be told to use an external program given 748 via the value of this variable. Can be overridden by the `GIT_ASKPASS` 749 environment variable. If not set, fall back to the value of the 750 `SSH_ASKPASS` environment variable or, failing that, a simple password 751 prompt. The external program shall be given a suitable prompt as 752 command-line argument and write the password on its STDOUT. 753 754core.attributesFile:: 755 In addition to '.gitattributes' (per-directory) and 756 '.git/info/attributes', Git looks into this file for attributes 757 (see linkgit:gitattributes[5]). Path expansions are made the same 758 way as for `core.excludesFile`. Its default value is 759 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not 760 set or empty, `$HOME/.config/git/attributes` is used instead. 761 762core.hooksPath:: 763 By default Git will look for your hooks in the 764 '$GIT_DIR/hooks' directory. Set this to different path, 765 e.g. '/etc/git/hooks', and Git will try to find your hooks in 766 that directory, e.g. '/etc/git/hooks/pre-receive' instead of 767 in '$GIT_DIR/hooks/pre-receive'. 768+ 769The path can be either absolute or relative. A relative path is 770taken as relative to the directory where the hooks are run (see 771the "DESCRIPTION" section of linkgit:githooks[5]). 772+ 773This configuration variable is useful in cases where you'd like to 774centrally configure your Git hooks instead of configuring them on a 775per-repository basis, or as a more flexible and centralized 776alternative to having an `init.templateDir` where you've changed 777default hooks. 778 779core.editor:: 780 Commands such as `commit` and `tag` that let you edit 781 messages by launching an editor use the value of this 782 variable when it is set, and the environment variable 783 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 784 785core.commentChar:: 786 Commands such as `commit` and `tag` that let you edit 787 messages consider a line that begins with this character 788 commented, and removes them after the editor returns 789 (default '#'). 790+ 791If set to "auto", `git-commit` would select a character that is not 792the beginning character of any line in existing commit messages. 793 794core.filesRefLockTimeout:: 795 The length of time, in milliseconds, to retry when trying to 796 lock an individual reference. Value 0 means not to retry at 797 all; -1 means to try indefinitely. Default is 100 (i.e., 798 retry for 100ms). 799 800core.packedRefsTimeout:: 801 The length of time, in milliseconds, to retry when trying to 802 lock the `packed-refs` file. Value 0 means not to retry at 803 all; -1 means to try indefinitely. Default is 1000 (i.e., 804 retry for 1 second). 805 806sequence.editor:: 807 Text editor used by `git rebase -i` for editing the rebase instruction file. 808 The value is meant to be interpreted by the shell when it is used. 809 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 810 When not configured the default commit message editor is used instead. 811 812core.pager:: 813 Text viewer for use by Git commands (e.g., 'less'). The value 814 is meant to be interpreted by the shell. The order of preference 815 is the `$GIT_PAGER` environment variable, then `core.pager` 816 configuration, then `$PAGER`, and then the default chosen at 817 compile time (usually 'less'). 818+ 819When the `LESS` environment variable is unset, Git sets it to `FRX` 820(if `LESS` environment variable is set, Git does not change it at 821all). If you want to selectively override Git's default setting 822for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 823be passed to the shell by Git, which will translate the final 824command to `LESS=FRX less -S`. The environment does not set the 825`S` option but the command line does, instructing less to truncate 826long lines. Similarly, setting `core.pager` to `less -+F` will 827deactivate the `F` option specified by the environment from the 828command-line, deactivating the "quit if one screen" behavior of 829`less`. One can specifically activate some flags for particular 830commands: for example, setting `pager.blame` to `less -S` enables 831line truncation only for `git blame`. 832+ 833Likewise, when the `LV` environment variable is unset, Git sets it 834to `-c`. You can override this setting by exporting `LV` with 835another value or setting `core.pager` to `lv +c`. 836 837core.whitespace:: 838 A comma separated list of common whitespace problems to 839 notice. 'git diff' will use `color.diff.whitespace` to 840 highlight them, and 'git apply --whitespace=error' will 841 consider them as errors. You can prefix `-` to disable 842 any of them (e.g. `-trailing-space`): 843+ 844* `blank-at-eol` treats trailing whitespaces at the end of the line 845 as an error (enabled by default). 846* `space-before-tab` treats a space character that appears immediately 847 before a tab character in the initial indent part of the line as an 848 error (enabled by default). 849* `indent-with-non-tab` treats a line that is indented with space 850 characters instead of the equivalent tabs as an error (not enabled by 851 default). 852* `tab-in-indent` treats a tab character in the initial indent part of 853 the line as an error (not enabled by default). 854* `blank-at-eof` treats blank lines added at the end of file as an error 855 (enabled by default). 856* `trailing-space` is a short-hand to cover both `blank-at-eol` and 857 `blank-at-eof`. 858* `cr-at-eol` treats a carriage-return at the end of line as 859 part of the line terminator, i.e. with it, `trailing-space` 860 does not trigger if the character before such a carriage-return 861 is not a whitespace (not enabled by default). 862* `tabwidth=<n>` tells how many character positions a tab occupies; this 863 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 864 errors. The default tab width is 8. Allowed values are 1 to 63. 865 866core.fsyncObjectFiles:: 867 This boolean will enable 'fsync()' when writing object files. 868+ 869This is a total waste of time and effort on a filesystem that orders 870data writes properly, but can be useful for filesystems that do not use 871journalling (traditional UNIX filesystems) or that only journal metadata 872and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 873 874core.preloadIndex:: 875 Enable parallel index preload for operations like 'git diff' 876+ 877This can speed up operations like 'git diff' and 'git status' especially 878on filesystems like NFS that have weak caching semantics and thus 879relatively high IO latencies. When enabled, Git will do the 880index comparison to the filesystem data in parallel, allowing 881overlapping IO's. Defaults to true. 882 883core.createObject:: 884 You can set this to 'link', in which case a hardlink followed by 885 a delete of the source are used to make sure that object creation 886 will not overwrite existing objects. 887+ 888On some file system/operating system combinations, this is unreliable. 889Set this config setting to 'rename' there; However, This will remove the 890check that makes sure that existing object files will not get overwritten. 891 892core.notesRef:: 893 When showing commit messages, also show notes which are stored in 894 the given ref. The ref must be fully qualified. If the given 895 ref does not exist, it is not an error but means that no 896 notes should be printed. 897+ 898This setting defaults to "refs/notes/commits", and it can be overridden by 899the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. 900 901core.sparseCheckout:: 902 Enable "sparse checkout" feature. See section "Sparse checkout" in 903 linkgit:git-read-tree[1] for more information. 904 905core.abbrev:: 906 Set the length object names are abbreviated to. If 907 unspecified or set to "auto", an appropriate value is 908 computed based on the approximate number of packed objects 909 in your repository, which hopefully is enough for 910 abbreviated object names to stay unique for some time. 911 The minimum length is 4. 912 913add.ignoreErrors:: 914add.ignore-errors (deprecated):: 915 Tells 'git add' to continue adding files when some files cannot be 916 added due to indexing errors. Equivalent to the `--ignore-errors` 917 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 918 as it does not follow the usual naming convention for configuration 919 variables. 920 921alias.*:: 922 Command aliases for the linkgit:git[1] command wrapper - e.g. 923 after defining "alias.last = cat-file commit HEAD", the invocation 924 "git last" is equivalent to "git cat-file commit HEAD". To avoid 925 confusion and troubles with script usage, aliases that 926 hide existing Git commands are ignored. Arguments are split by 927 spaces, the usual shell quoting and escaping is supported. 928 A quote pair or a backslash can be used to quote them. 929+ 930If the alias expansion is prefixed with an exclamation point, 931it will be treated as a shell command. For example, defining 932"alias.new = !gitk --all --not ORIG_HEAD", the invocation 933"git new" is equivalent to running the shell command 934"gitk --all --not ORIG_HEAD". Note that shell commands will be 935executed from the top-level directory of a repository, which may 936not necessarily be the current directory. 937`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix' 938from the original current directory. See linkgit:git-rev-parse[1]. 939 940am.keepcr:: 941 If true, git-am will call git-mailsplit for patches in mbox format 942 with parameter `--keep-cr`. In this case git-mailsplit will 943 not remove `\r` from lines ending with `\r\n`. Can be overridden 944 by giving `--no-keep-cr` from the command line. 945 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 946 947am.threeWay:: 948 By default, `git am` will fail if the patch does not apply cleanly. When 949 set to true, this setting tells `git am` to fall back on 3-way merge if 950 the patch records the identity of blobs it is supposed to apply to and 951 we have those blobs available locally (equivalent to giving the `--3way` 952 option from the command line). Defaults to `false`. 953 See linkgit:git-am[1]. 954 955apply.ignoreWhitespace:: 956 When set to 'change', tells 'git apply' to ignore changes in 957 whitespace, in the same way as the `--ignore-space-change` 958 option. 959 When set to one of: no, none, never, false tells 'git apply' to 960 respect all whitespace differences. 961 See linkgit:git-apply[1]. 962 963apply.whitespace:: 964 Tells 'git apply' how to handle whitespaces, in the same way 965 as the `--whitespace` option. See linkgit:git-apply[1]. 966 967blame.showRoot:: 968 Do not treat root commits as boundaries in linkgit:git-blame[1]. 969 This option defaults to false. 970 971blame.blankBoundary:: 972 Show blank commit object name for boundary commits in 973 linkgit:git-blame[1]. This option defaults to false. 974 975blame.showEmail:: 976 Show the author email instead of author name in linkgit:git-blame[1]. 977 This option defaults to false. 978 979blame.date:: 980 Specifies the format used to output dates in linkgit:git-blame[1]. 981 If unset the iso format is used. For supported values, 982 see the discussion of the `--date` option at linkgit:git-log[1]. 983 984branch.autoSetupMerge:: 985 Tells 'git branch' and 'git checkout' to set up new branches 986 so that linkgit:git-pull[1] will appropriately merge from the 987 starting point branch. Note that even if this option is not set, 988 this behavior can be chosen per-branch using the `--track` 989 and `--no-track` options. The valid settings are: `false` -- no 990 automatic setup is done; `true` -- automatic setup is done when the 991 starting point is a remote-tracking branch; `always` -- 992 automatic setup is done when the starting point is either a 993 local branch or remote-tracking 994 branch. This option defaults to true. 995 996branch.autoSetupRebase:: 997 When a new branch is created with 'git branch' or 'git checkout' 998 that tracks another branch, this variable tells Git to set 999 up pull to rebase instead of merge (see "branch.<name>.rebase").1000 When `never`, rebase is never automatically set to true.1001 When `local`, rebase is set to true for tracked branches of1002 other local branches.1003 When `remote`, rebase is set to true for tracked branches of1004 remote-tracking branches.1005 When `always`, rebase will be set to true for all tracking1006 branches.1007 See "branch.autoSetupMerge" for details on how to set up a1008 branch to track another branch.1009 This option defaults to never.10101011branch.<name>.remote::1012 When on branch <name>, it tells 'git fetch' and 'git push'1013 which remote to fetch from/push to. The remote to push to1014 may be overridden with `remote.pushDefault` (for all branches).1015 The remote to push to, for the current branch, may be further1016 overridden by `branch.<name>.pushRemote`. If no remote is1017 configured, or if you are not on any branch, it defaults to1018 `origin` for fetching and `remote.pushDefault` for pushing.1019 Additionally, `.` (a period) is the current local repository1020 (a dot-repository), see `branch.<name>.merge`'s final note below.10211022branch.<name>.pushRemote::1023 When on branch <name>, it overrides `branch.<name>.remote` for1024 pushing. It also overrides `remote.pushDefault` for pushing1025 from branch <name>. When you pull from one place (e.g. your1026 upstream) and push to another place (e.g. your own publishing1027 repository), you would want to set `remote.pushDefault` to1028 specify the remote to push to for all branches, and use this1029 option to override it for a specific branch.10301031branch.<name>.merge::1032 Defines, together with branch.<name>.remote, the upstream branch1033 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which1034 branch to merge and can also affect 'git push' (see push.default).1035 When in branch <name>, it tells 'git fetch' the default1036 refspec to be marked for merging in FETCH_HEAD. The value is1037 handled like the remote part of a refspec, and must match a1038 ref which is fetched from the remote given by1039 "branch.<name>.remote".1040 The merge information is used by 'git pull' (which at first calls1041 'git fetch') to lookup the default branch for merging. Without1042 this option, 'git pull' defaults to merge the first refspec fetched.1043 Specify multiple values to get an octopus merge.1044 If you wish to setup 'git pull' so that it merges into <name> from1045 another branch in the local repository, you can point1046 branch.<name>.merge to the desired branch, and use the relative path1047 setting `.` (a period) for branch.<name>.remote.10481049branch.<name>.mergeOptions::1050 Sets default options for merging into branch <name>. The syntax and1051 supported options are the same as those of linkgit:git-merge[1], but1052 option values containing whitespace characters are currently not1053 supported.10541055branch.<name>.rebase::1056 When true, rebase the branch <name> on top of the fetched branch,1057 instead of merging the default branch from the default remote when1058 "git pull" is run. See "pull.rebase" for doing this in a non1059 branch-specific manner.1060+1061When preserve, also pass `--preserve-merges` along to 'git rebase'1062so that locally committed merge commits will not be flattened1063by running 'git pull'.1064+1065When the value is `interactive`, the rebase is run in interactive mode.1066+1067*NOTE*: this is a possibly dangerous operation; do *not* use1068it unless you understand the implications (see linkgit:git-rebase[1]1069for details).10701071branch.<name>.description::1072 Branch description, can be edited with1073 `git branch --edit-description`. Branch description is1074 automatically added in the format-patch cover letter or1075 request-pull summary.10761077browser.<tool>.cmd::1078 Specify the command to invoke the specified browser. The1079 specified command is evaluated in shell with the URLs passed1080 as arguments. (See linkgit:git-web{litdd}browse[1].)10811082browser.<tool>.path::1083 Override the path for the given tool that may be used to1084 browse HTML help (see `-w` option in linkgit:git-help[1]) or a1085 working repository in gitweb (see linkgit:git-instaweb[1]).10861087clean.requireForce::1088 A boolean to make git-clean do nothing unless given -f,1089 -i or -n. Defaults to true.10901091color.branch::1092 A boolean to enable/disable color in the output of1093 linkgit:git-branch[1]. May be set to `always`,1094 `false` (or `never`) or `auto` (or `true`), in which case colors are used1095 only when the output is to a terminal. If unset, then the1096 value of `color.ui` is used (`auto` by default).10971098color.branch.<slot>::1099 Use customized color for branch coloration. `<slot>` is one of1100 `current` (the current branch), `local` (a local branch),1101 `remote` (a remote-tracking branch in refs/remotes/),1102 `upstream` (upstream tracking branch), `plain` (other1103 refs).11041105color.diff::1106 Whether to use ANSI escape sequences to add color to patches.1107 If this is set to `always`, linkgit:git-diff[1],1108 linkgit:git-log[1], and linkgit:git-show[1] will use color1109 for all patches. If it is set to `true` or `auto`, those1110 commands will only use color when output is to the terminal.1111 If unset, then the value of `color.ui` is used (`auto` by1112 default).1113+1114This does not affect linkgit:git-format-patch[1] or the1115'git-diff-{asterisk}' plumbing commands. Can be overridden on the1116command line with the `--color[=<when>]` option.11171118diff.colorMoved::1119 If set to either a valid `<mode>` or a true value, moved lines1120 in a diff are colored differently, for details of valid modes1121 see '--color-moved' in linkgit:git-diff[1]. If simply set to1122 true the default color mode will be used. When set to false,1123 moved lines are not colored.11241125diff.colorMovedWS::1126 When moved lines are colored using e.g. the `diff.colorMoved` setting,1127 this option controls the `<mode>` how spaces are treated1128 for details of valid modes see '--color-moved-ws' in linkgit:git-diff[1].11291130color.diff.<slot>::1131 Use customized color for diff colorization. `<slot>` specifies1132 which part of the patch to use the specified color, and is one1133 of `context` (context text - `plain` is a historical synonym),1134 `meta` (metainformation), `frag`1135 (hunk header), 'func' (function in hunk header), `old` (removed lines),1136 `new` (added lines), `commit` (commit headers), `whitespace`1137 (highlighting whitespace errors), `oldMoved` (deleted lines),1138 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,1139 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`1140 and `newMovedAlternativeDimmed` (See the '<mode>'1141 setting of '--color-moved' in linkgit:git-diff[1] for details).11421143color.decorate.<slot>::1144 Use customized color for 'git log --decorate' output. `<slot>` is one1145 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local1146 branches, remote-tracking branches, tags, stash and HEAD, respectively.11471148color.grep::1149 When set to `always`, always highlight matches. When `false` (or1150 `never`), never. When set to `true` or `auto`, use color only1151 when the output is written to the terminal. If unset, then the1152 value of `color.ui` is used (`auto` by default).11531154color.grep.<slot>::1155 Use customized color for grep colorization. `<slot>` specifies which1156 part of the line to use the specified color, and is one of1157+1158--1159`context`;;1160 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1161`filename`;;1162 filename prefix (when not using `-h`)1163`function`;;1164 function name lines (when using `-p`)1165`linenumber`;;1166 line number prefix (when using `-n`)1167`match`;;1168 matching text (same as setting `matchContext` and `matchSelected`)1169`matchContext`;;1170 matching text in context lines1171`matchSelected`;;1172 matching text in selected lines1173`selected`;;1174 non-matching text in selected lines1175`separator`;;1176 separators between fields on a line (`:`, `-`, and `=`)1177 and between hunks (`--`)1178--11791180color.interactive::1181 When set to `always`, always use colors for interactive prompts1182 and displays (such as those used by "git-add --interactive" and1183 "git-clean --interactive"). When false (or `never`), never.1184 When set to `true` or `auto`, use colors only when the output is1185 to the terminal. If unset, then the value of `color.ui` is1186 used (`auto` by default).11871188color.interactive.<slot>::1189 Use customized color for 'git add --interactive' and 'git clean1190 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1191 or `error`, for four distinct types of normal output from1192 interactive commands.11931194color.pager::1195 A boolean to enable/disable colored output when the pager is in1196 use (default is true).11971198color.showBranch::1199 A boolean to enable/disable color in the output of1200 linkgit:git-show-branch[1]. May be set to `always`,1201 `false` (or `never`) or `auto` (or `true`), in which case colors are used1202 only when the output is to a terminal. If unset, then the1203 value of `color.ui` is used (`auto` by default).12041205color.status::1206 A boolean to enable/disable color in the output of1207 linkgit:git-status[1]. May be set to `always`,1208 `false` (or `never`) or `auto` (or `true`), in which case colors are used1209 only when the output is to a terminal. If unset, then the1210 value of `color.ui` is used (`auto` by default).12111212color.status.<slot>::1213 Use customized color for status colorization. `<slot>` is1214 one of `header` (the header text of the status message),1215 `added` or `updated` (files which are added but not committed),1216 `changed` (files which are changed but not added in the index),1217 `untracked` (files which are not tracked by Git),1218 `branch` (the current branch),1219 `nobranch` (the color the 'no branch' warning is shown in, defaulting1220 to red),1221 `localBranch` or `remoteBranch` (the local and remote branch names,1222 respectively, when branch and tracking information is displayed in the1223 status short-format), or1224 `unmerged` (files which have unmerged changes).12251226color.ui::1227 This variable determines the default value for variables such1228 as `color.diff` and `color.grep` that control the use of color1229 per command family. Its scope will expand as more commands learn1230 configuration to set a default for the `--color` option. Set it1231 to `false` or `never` if you prefer Git commands not to use1232 color unless enabled explicitly with some other configuration1233 or the `--color` option. Set it to `always` if you want all1234 output not intended for machine consumption to use color, to1235 `true` or `auto` (this is the default since Git 1.8.4) if you1236 want such output to use color when written to the terminal.12371238column.ui::1239 Specify whether supported commands should output in columns.1240 This variable consists of a list of tokens separated by spaces1241 or commas:1242+1243These options control when the feature should be enabled1244(defaults to 'never'):1245+1246--1247`always`;;1248 always show in columns1249`never`;;1250 never show in columns1251`auto`;;1252 show in columns if the output is to the terminal1253--1254+1255These options control layout (defaults to 'column'). Setting any1256of these implies 'always' if none of 'always', 'never', or 'auto' are1257specified.1258+1259--1260`column`;;1261 fill columns before rows1262`row`;;1263 fill rows before columns1264`plain`;;1265 show in one column1266--1267+1268Finally, these options can be combined with a layout option (defaults1269to 'nodense'):1270+1271--1272`dense`;;1273 make unequal size columns to utilize more space1274`nodense`;;1275 make equal size columns1276--12771278column.branch::1279 Specify whether to output branch listing in `git branch` in columns.1280 See `column.ui` for details.12811282column.clean::1283 Specify the layout when list items in `git clean -i`, which always1284 shows files and directories in columns. See `column.ui` for details.12851286column.status::1287 Specify whether to output untracked files in `git status` in columns.1288 See `column.ui` for details.12891290column.tag::1291 Specify whether to output tag listing in `git tag` in columns.1292 See `column.ui` for details.12931294commit.cleanup::1295 This setting overrides the default of the `--cleanup` option in1296 `git commit`. See linkgit:git-commit[1] for details. Changing the1297 default can be useful when you always want to keep lines that begin1298 with comment character `#` in your log message, in which case you1299 would do `git config commit.cleanup whitespace` (note that you will1300 have to remove the help lines that begin with `#` in the commit log1301 template yourself, if you do this).13021303commit.gpgSign::13041305 A boolean to specify whether all commits should be GPG signed.1306 Use of this option when doing operations such as rebase can1307 result in a large number of commits being signed. It may be1308 convenient to use an agent to avoid typing your GPG passphrase1309 several times.13101311commit.status::1312 A boolean to enable/disable inclusion of status information in the1313 commit message template when using an editor to prepare the commit1314 message. Defaults to true.13151316commit.template::1317 Specify the pathname of a file to use as the template for1318 new commit messages.13191320commit.verbose::1321 A boolean or int to specify the level of verbose with `git commit`.1322 See linkgit:git-commit[1].13231324credential.helper::1325 Specify an external helper to be called when a username or1326 password credential is needed; the helper may consult external1327 storage to avoid prompting the user for the credentials. Note1328 that multiple helpers may be defined. See linkgit:gitcredentials[7]1329 for details.13301331credential.useHttpPath::1332 When acquiring credentials, consider the "path" component of an http1333 or https URL to be important. Defaults to false. See1334 linkgit:gitcredentials[7] for more information.13351336credential.username::1337 If no username is set for a network authentication, use this username1338 by default. See credential.<context>.* below, and1339 linkgit:gitcredentials[7].13401341credential.<url>.*::1342 Any of the credential.* options above can be applied selectively to1343 some credentials. For example "credential.https://example.com.username"1344 would set the default username only for https connections to1345 example.com. See linkgit:gitcredentials[7] for details on how URLs are1346 matched.13471348credentialCache.ignoreSIGHUP::1349 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.13501351include::diff-config.txt[]13521353difftool.<tool>.path::1354 Override the path for the given tool. This is useful in case1355 your tool is not in the PATH.13561357difftool.<tool>.cmd::1358 Specify the command to invoke the specified diff tool.1359 The specified command is evaluated in shell with the following1360 variables available: 'LOCAL' is set to the name of the temporary1361 file containing the contents of the diff pre-image and 'REMOTE'1362 is set to the name of the temporary file containing the contents1363 of the diff post-image.13641365difftool.prompt::1366 Prompt before each invocation of the diff tool.13671368fastimport.unpackLimit::1369 If the number of objects imported by linkgit:git-fast-import[1]1370 is below this limit, then the objects will be unpacked into1371 loose object files. However if the number of imported objects1372 equals or exceeds this limit then the pack will be stored as a1373 pack. Storing the pack from a fast-import can make the import1374 operation complete faster, especially on slow filesystems. If1375 not set, the value of `transfer.unpackLimit` is used instead.13761377fetch.recurseSubmodules::1378 This option can be either set to a boolean value or to 'on-demand'.1379 Setting it to a boolean changes the behavior of fetch and pull to1380 unconditionally recurse into submodules when set to true or to not1381 recurse at all when set to false. When set to 'on-demand' (the default1382 value), fetch and pull will only recurse into a populated submodule1383 when its superproject retrieves a commit that updates the submodule's1384 reference.13851386fetch.fsckObjects::1387 If it is set to true, git-fetch-pack will check all fetched1388 objects. It will abort in the case of a malformed object or a1389 broken link. The result of an abort are only dangling objects.1390 Defaults to false. If not set, the value of `transfer.fsckObjects`1391 is used instead.13921393fetch.unpackLimit::1394 If the number of objects fetched over the Git native1395 transfer is below this1396 limit, then the objects will be unpacked into loose object1397 files. However if the number of received objects equals or1398 exceeds this limit then the received pack will be stored as1399 a pack, after adding any missing delta bases. Storing the1400 pack from a push can make the push operation complete faster,1401 especially on slow filesystems. If not set, the value of1402 `transfer.unpackLimit` is used instead.14031404fetch.prune::1405 If true, fetch will automatically behave as if the `--prune`1406 option was given on the command line. See also `remote.<name>.prune`1407 and the PRUNING section of linkgit:git-fetch[1].14081409fetch.pruneTags::1410 If true, fetch will automatically behave as if the1411 `refs/tags/*:refs/tags/*` refspec was provided when pruning,1412 if not set already. This allows for setting both this option1413 and `fetch.prune` to maintain a 1=1 mapping to upstream1414 refs. See also `remote.<name>.pruneTags` and the PRUNING1415 section of linkgit:git-fetch[1].14161417fetch.output::1418 Control how ref update status is printed. Valid values are1419 `full` and `compact`. Default value is `full`. See section1420 OUTPUT in linkgit:git-fetch[1] for detail.14211422format.attach::1423 Enable multipart/mixed attachments as the default for1424 'format-patch'. The value can also be a double quoted string1425 which will enable attachments as the default and set the1426 value as the boundary. See the --attach option in1427 linkgit:git-format-patch[1].14281429format.from::1430 Provides the default value for the `--from` option to format-patch.1431 Accepts a boolean value, or a name and email address. If false,1432 format-patch defaults to `--no-from`, using commit authors directly in1433 the "From:" field of patch mails. If true, format-patch defaults to1434 `--from`, using your committer identity in the "From:" field of patch1435 mails and including a "From:" field in the body of the patch mail if1436 different. If set to a non-boolean value, format-patch uses that1437 value instead of your committer identity. Defaults to false.14381439format.numbered::1440 A boolean which can enable or disable sequence numbers in patch1441 subjects. It defaults to "auto" which enables it only if there1442 is more than one patch. It can be enabled or disabled for all1443 messages by setting it to "true" or "false". See --numbered1444 option in linkgit:git-format-patch[1].14451446format.headers::1447 Additional email headers to include in a patch to be submitted1448 by mail. See linkgit:git-format-patch[1].14491450format.to::1451format.cc::1452 Additional recipients to include in a patch to be submitted1453 by mail. See the --to and --cc options in1454 linkgit:git-format-patch[1].14551456format.subjectPrefix::1457 The default for format-patch is to output files with the '[PATCH]'1458 subject prefix. Use this variable to change that prefix.14591460format.signature::1461 The default for format-patch is to output a signature containing1462 the Git version number. Use this variable to change that default.1463 Set this variable to the empty string ("") to suppress1464 signature generation.14651466format.signatureFile::1467 Works just like format.signature except the contents of the1468 file specified by this variable will be used as the signature.14691470format.suffix::1471 The default for format-patch is to output files with the suffix1472 `.patch`. Use this variable to change that suffix (make sure to1473 include the dot if you want it).14741475format.pretty::1476 The default pretty format for log/show/whatchanged command,1477 See linkgit:git-log[1], linkgit:git-show[1],1478 linkgit:git-whatchanged[1].14791480format.thread::1481 The default threading style for 'git format-patch'. Can be1482 a boolean value, or `shallow` or `deep`. `shallow` threading1483 makes every mail a reply to the head of the series,1484 where the head is chosen from the cover letter, the1485 `--in-reply-to`, and the first patch mail, in this order.1486 `deep` threading makes every mail a reply to the previous one.1487 A true boolean value is the same as `shallow`, and a false1488 value disables threading.14891490format.signOff::1491 A boolean value which lets you enable the `-s/--signoff` option of1492 format-patch by default. *Note:* Adding the Signed-off-by: line to a1493 patch should be a conscious act and means that you certify you have1494 the rights to submit this work under the same open source license.1495 Please see the 'SubmittingPatches' document for further discussion.14961497format.coverLetter::1498 A boolean that controls whether to generate a cover-letter when1499 format-patch is invoked, but in addition can be set to "auto", to1500 generate a cover-letter only when there's more than one patch.15011502format.outputDirectory::1503 Set a custom directory to store the resulting files instead of the1504 current working directory.15051506format.useAutoBase::1507 A boolean value which lets you enable the `--base=auto` option of1508 format-patch by default.15091510filter.<driver>.clean::1511 The command which is used to convert the content of a worktree1512 file to a blob upon checkin. See linkgit:gitattributes[5] for1513 details.15141515filter.<driver>.smudge::1516 The command which is used to convert the content of a blob1517 object to a worktree file upon checkout. See1518 linkgit:gitattributes[5] for details.15191520fsck.<msg-id>::1521 Allows overriding the message type (error, warn or ignore) of a1522 specific message ID such as `missingEmail`.1523+1524For convenience, fsck prefixes the error/warning with the message ID,1525e.g. "missingEmail: invalid author/committer line - missing email" means1526that setting `fsck.missingEmail = ignore` will hide that issue.1527+1528This feature is intended to support working with legacy repositories1529which cannot be repaired without disruptive changes.15301531fsck.skipList::1532 The path to a sorted list of object names (i.e. one SHA-1 per1533 line) that are known to be broken in a non-fatal way and should1534 be ignored. This feature is useful when an established project1535 should be accepted despite early commits containing errors that1536 can be safely ignored such as invalid committer email addresses.1537 Note: corrupt objects cannot be skipped with this setting.15381539gc.aggressiveDepth::1540 The depth parameter used in the delta compression1541 algorithm used by 'git gc --aggressive'. This defaults1542 to 50.15431544gc.aggressiveWindow::1545 The window size parameter used in the delta compression1546 algorithm used by 'git gc --aggressive'. This defaults1547 to 250.15481549gc.auto::1550 When there are approximately more than this many loose1551 objects in the repository, `git gc --auto` will pack them.1552 Some Porcelain commands use this command to perform a1553 light-weight garbage collection from time to time. The1554 default value is 6700. Setting this to 0 disables it.15551556gc.autoPackLimit::1557 When there are more than this many packs that are not1558 marked with `*.keep` file in the repository, `git gc1559 --auto` consolidates them into one larger pack. The1560 default value is 50. Setting this to 0 disables it.15611562gc.autoDetach::1563 Make `git gc --auto` return immediately and run in background1564 if the system supports it. Default is true.15651566gc.logExpiry::1567 If the file gc.log exists, then `git gc --auto` won't run1568 unless that file is more than 'gc.logExpiry' old. Default is1569 "1.day". See `gc.pruneExpire` for more ways to specify its1570 value.15711572gc.packRefs::1573 Running `git pack-refs` in a repository renders it1574 unclonable by Git versions prior to 1.5.1.2 over dumb1575 transports such as HTTP. This variable determines whether1576 'git gc' runs `git pack-refs`. This can be set to `notbare`1577 to enable it within all non-bare repos or it can be set to a1578 boolean value. The default is `true`.15791580gc.pruneExpire::1581 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1582 Override the grace period with this config variable. The value1583 "now" may be used to disable this grace period and always prune1584 unreachable objects immediately, or "never" may be used to1585 suppress pruning. This feature helps prevent corruption when1586 'git gc' runs concurrently with another process writing to the1587 repository; see the "NOTES" section of linkgit:git-gc[1].15881589gc.worktreePruneExpire::1590 When 'git gc' is run, it calls1591 'git worktree prune --expire 3.months.ago'.1592 This config variable can be used to set a different grace1593 period. The value "now" may be used to disable the grace1594 period and prune `$GIT_DIR/worktrees` immediately, or "never"1595 may be used to suppress pruning.15961597gc.reflogExpire::1598gc.<pattern>.reflogExpire::1599 'git reflog expire' removes reflog entries older than1600 this time; defaults to 90 days. The value "now" expires all1601 entries immediately, and "never" suppresses expiration1602 altogether. With "<pattern>" (e.g.1603 "refs/stash") in the middle the setting applies only to1604 the refs that match the <pattern>.16051606gc.reflogExpireUnreachable::1607gc.<pattern>.reflogExpireUnreachable::1608 'git reflog expire' removes reflog entries older than1609 this time and are not reachable from the current tip;1610 defaults to 30 days. The value "now" expires all entries1611 immediately, and "never" suppresses expiration altogether.1612 With "<pattern>" (e.g. "refs/stash")1613 in the middle, the setting applies only to the refs that1614 match the <pattern>.16151616gc.rerereResolved::1617 Records of conflicted merge you resolved earlier are1618 kept for this many days when 'git rerere gc' is run.1619 You can also use more human-readable "1.month.ago", etc.1620 The default is 60 days. See linkgit:git-rerere[1].16211622gc.rerereUnresolved::1623 Records of conflicted merge you have not resolved are1624 kept for this many days when 'git rerere gc' is run.1625 You can also use more human-readable "1.month.ago", etc.1626 The default is 15 days. See linkgit:git-rerere[1].16271628gitcvs.commitMsgAnnotation::1629 Append this string to each commit message. Set to empty string1630 to disable this feature. Defaults to "via git-CVS emulator".16311632gitcvs.enabled::1633 Whether the CVS server interface is enabled for this repository.1634 See linkgit:git-cvsserver[1].16351636gitcvs.logFile::1637 Path to a log file where the CVS server interface well... logs1638 various stuff. See linkgit:git-cvsserver[1].16391640gitcvs.usecrlfattr::1641 If true, the server will look up the end-of-line conversion1642 attributes for files to determine the `-k` modes to use. If1643 the attributes force Git to treat a file as text,1644 the `-k` mode will be left blank so CVS clients will1645 treat it as text. If they suppress text conversion, the file1646 will be set with '-kb' mode, which suppresses any newline munging1647 the client might otherwise do. If the attributes do not allow1648 the file type to be determined, then `gitcvs.allBinary` is1649 used. See linkgit:gitattributes[5].16501651gitcvs.allBinary::1652 This is used if `gitcvs.usecrlfattr` does not resolve1653 the correct '-kb' mode to use. If true, all1654 unresolved files are sent to the client in1655 mode '-kb'. This causes the client to treat them1656 as binary files, which suppresses any newline munging it1657 otherwise might do. Alternatively, if it is set to "guess",1658 then the contents of the file are examined to decide if1659 it is binary, similar to `core.autocrlf`.16601661gitcvs.dbName::1662 Database used by git-cvsserver to cache revision information1663 derived from the Git repository. The exact meaning depends on the1664 used database driver, for SQLite (which is the default driver) this1665 is a filename. Supports variable substitution (see1666 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1667 Default: '%Ggitcvs.%m.sqlite'16681669gitcvs.dbDriver::1670 Used Perl DBI driver. You can specify any available driver1671 for this here, but it might not work. git-cvsserver is tested1672 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1673 reported *not* to work with 'DBD::mysql'. Experimental feature.1674 May not contain double colons (`:`). Default: 'SQLite'.1675 See linkgit:git-cvsserver[1].16761677gitcvs.dbUser, gitcvs.dbPass::1678 Database user and password. Only useful if setting `gitcvs.dbDriver`,1679 since SQLite has no concept of database users and/or passwords.1680 'gitcvs.dbUser' supports variable substitution (see1681 linkgit:git-cvsserver[1] for details).16821683gitcvs.dbTableNamePrefix::1684 Database table name prefix. Prepended to the names of any1685 database tables used, allowing a single database to be used1686 for several repositories. Supports variable substitution (see1687 linkgit:git-cvsserver[1] for details). Any non-alphabetic1688 characters will be replaced with underscores.16891690All gitcvs variables except for `gitcvs.usecrlfattr` and1691`gitcvs.allBinary` can also be specified as1692'gitcvs.<access_method>.<varname>' (where 'access_method'1693is one of "ext" and "pserver") to make them apply only for the given1694access method.16951696gitweb.category::1697gitweb.description::1698gitweb.owner::1699gitweb.url::1700 See linkgit:gitweb[1] for description.17011702gitweb.avatar::1703gitweb.blame::1704gitweb.grep::1705gitweb.highlight::1706gitweb.patches::1707gitweb.pickaxe::1708gitweb.remote_heads::1709gitweb.showSizes::1710gitweb.snapshot::1711 See linkgit:gitweb.conf[5] for description.17121713grep.lineNumber::1714 If set to true, enable `-n` option by default.17151716grep.patternType::1717 Set the default matching behavior. Using a value of 'basic', 'extended',1718 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1719 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1720 value 'default' will return to the default matching behavior.17211722grep.extendedRegexp::1723 If set to true, enable `--extended-regexp` option by default. This1724 option is ignored when the `grep.patternType` option is set to a value1725 other than 'default'.17261727grep.threads::1728 Number of grep worker threads to use.1729 See `grep.threads` in linkgit:git-grep[1] for more information.17301731grep.fallbackToNoIndex::1732 If set to true, fall back to git grep --no-index if git grep1733 is executed outside of a git repository. Defaults to false.17341735gpg.program::1736 Use this custom program instead of "`gpg`" found on `$PATH` when1737 making or verifying a PGP signature. The program must support the1738 same command-line interface as GPG, namely, to verify a detached1739 signature, "`gpg --verify $file - <$signature`" is run, and the1740 program is expected to signal a good signature by exiting with1741 code 0, and to generate an ASCII-armored detached signature, the1742 standard input of "`gpg -bsau $key`" is fed with the contents to be1743 signed, and the program is expected to send the result to its1744 standard output.17451746gui.commitMsgWidth::1747 Defines how wide the commit message window is in the1748 linkgit:git-gui[1]. "75" is the default.17491750gui.diffContext::1751 Specifies how many context lines should be used in calls to diff1752 made by the linkgit:git-gui[1]. The default is "5".17531754gui.displayUntracked::1755 Determines if linkgit:git-gui[1] shows untracked files1756 in the file list. The default is "true".17571758gui.encoding::1759 Specifies the default encoding to use for displaying of1760 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1761 It can be overridden by setting the 'encoding' attribute1762 for relevant files (see linkgit:gitattributes[5]).1763 If this option is not set, the tools default to the1764 locale encoding.17651766gui.matchTrackingBranch::1767 Determines if new branches created with linkgit:git-gui[1] should1768 default to tracking remote branches with matching names or1769 not. Default: "false".17701771gui.newBranchTemplate::1772 Is used as suggested name when creating new branches using the1773 linkgit:git-gui[1].17741775gui.pruneDuringFetch::1776 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1777 performing a fetch. The default value is "false".17781779gui.trustmtime::1780 Determines if linkgit:git-gui[1] should trust the file modification1781 timestamp or not. By default the timestamps are not trusted.17821783gui.spellingDictionary::1784 Specifies the dictionary used for spell checking commit messages in1785 the linkgit:git-gui[1]. When set to "none" spell checking is turned1786 off.17871788gui.fastCopyBlame::1789 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1790 location detection. It makes blame significantly faster on huge1791 repositories at the expense of less thorough copy detection.17921793gui.copyBlameThreshold::1794 Specifies the threshold to use in 'git gui blame' original location1795 detection, measured in alphanumeric characters. See the1796 linkgit:git-blame[1] manual for more information on copy detection.17971798gui.blamehistoryctx::1799 Specifies the radius of history context in days to show in1800 linkgit:gitk[1] for the selected commit, when the `Show History1801 Context` menu item is invoked from 'git gui blame'. If this1802 variable is set to zero, the whole history is shown.18031804guitool.<name>.cmd::1805 Specifies the shell command line to execute when the corresponding item1806 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1807 mandatory for every tool. The command is executed from the root of1808 the working directory, and in the environment it receives the name of1809 the tool as `GIT_GUITOOL`, the name of the currently selected file as1810 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1811 the head is detached, 'CUR_BRANCH' is empty).18121813guitool.<name>.needsFile::1814 Run the tool only if a diff is selected in the GUI. It guarantees1815 that 'FILENAME' is not empty.18161817guitool.<name>.noConsole::1818 Run the command silently, without creating a window to display its1819 output.18201821guitool.<name>.noRescan::1822 Don't rescan the working directory for changes after the tool1823 finishes execution.18241825guitool.<name>.confirm::1826 Show a confirmation dialog before actually running the tool.18271828guitool.<name>.argPrompt::1829 Request a string argument from the user, and pass it to the tool1830 through the `ARGS` environment variable. Since requesting an1831 argument implies confirmation, the 'confirm' option has no effect1832 if this is enabled. If the option is set to 'true', 'yes', or '1',1833 the dialog uses a built-in generic prompt; otherwise the exact1834 value of the variable is used.18351836guitool.<name>.revPrompt::1837 Request a single valid revision from the user, and set the1838 `REVISION` environment variable. In other aspects this option1839 is similar to 'argPrompt', and can be used together with it.18401841guitool.<name>.revUnmerged::1842 Show only unmerged branches in the 'revPrompt' subdialog.1843 This is useful for tools similar to merge or rebase, but not1844 for things like checkout or reset.18451846guitool.<name>.title::1847 Specifies the title to use for the prompt dialog. The default1848 is the tool name.18491850guitool.<name>.prompt::1851 Specifies the general prompt string to display at the top of1852 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1853 The default value includes the actual command.18541855help.browser::1856 Specify the browser that will be used to display help in the1857 'web' format. See linkgit:git-help[1].18581859help.format::1860 Override the default help format used by linkgit:git-help[1].1861 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1862 the default. 'web' and 'html' are the same.18631864help.autoCorrect::1865 Automatically correct and execute mistyped commands after1866 waiting for the given number of deciseconds (0.1 sec). If more1867 than one command can be deduced from the entered text, nothing1868 will be executed. If the value of this option is negative,1869 the corrected command will be executed immediately. If the1870 value is 0 - the command will be just shown but not executed.1871 This is the default.18721873help.htmlPath::1874 Specify the path where the HTML documentation resides. File system paths1875 and URLs are supported. HTML pages will be prefixed with this path when1876 help is displayed in the 'web' format. This defaults to the documentation1877 path of your Git installation.18781879http.proxy::1880 Override the HTTP proxy, normally configured using the 'http_proxy',1881 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1882 addition to the syntax understood by curl, it is possible to specify a1883 proxy string with a user name but no password, in which case git will1884 attempt to acquire one in the same way it does for other credentials. See1885 linkgit:gitcredentials[7] for more information. The syntax thus is1886 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1887 on a per-remote basis; see remote.<name>.proxy18881889http.proxyAuthMethod::1890 Set the method with which to authenticate against the HTTP proxy. This1891 only takes effect if the configured proxy string contains a user name part1892 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1893 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1894 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1895 variable. Possible values are:1896+1897--1898* `anyauth` - Automatically pick a suitable authentication method. It is1899 assumed that the proxy answers an unauthenticated request with a 4071900 status code and one or more Proxy-authenticate headers with supported1901 authentication methods. This is the default.1902* `basic` - HTTP Basic authentication1903* `digest` - HTTP Digest authentication; this prevents the password from being1904 transmitted to the proxy in clear text1905* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1906 of `curl(1)`)1907* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1908--19091910http.emptyAuth::1911 Attempt authentication without seeking a username or password. This1912 can be used to attempt GSS-Negotiate authentication without specifying1913 a username in the URL, as libcurl normally requires a username for1914 authentication.19151916http.delegation::1917 Control GSSAPI credential delegation. The delegation is disabled1918 by default in libcurl since version 7.21.7. Set parameter to tell1919 the server what it is allowed to delegate when it comes to user1920 credentials. Used with GSS/kerberos. Possible values are:1921+1922--1923* `none` - Don't allow any delegation.1924* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the1925 Kerberos service ticket, which is a matter of realm policy.1926* `always` - Unconditionally allow the server to delegate.1927--192819291930http.extraHeader::1931 Pass an additional HTTP header when communicating with a server. If1932 more than one such entry exists, all of them are added as extra1933 headers. To allow overriding the settings inherited from the system1934 config, an empty value will reset the extra headers to the empty list.19351936http.cookieFile::1937 The pathname of a file containing previously stored cookie lines,1938 which should be used1939 in the Git http session, if they match the server. The file format1940 of the file to read cookies from should be plain HTTP headers or1941 the Netscape/Mozilla cookie file format (see `curl(1)`).1942 NOTE that the file specified with http.cookieFile is used only as1943 input unless http.saveCookies is set.19441945http.saveCookies::1946 If set, store cookies received during requests to the file specified by1947 http.cookieFile. Has no effect if http.cookieFile is unset.19481949http.sslVersion::1950 The SSL version to use when negotiating an SSL connection, if you1951 want to force the default. The available and default version1952 depend on whether libcurl was built against NSS or OpenSSL and the1953 particular configuration of the crypto library in use. Internally1954 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl1955 documentation for more details on the format of this option and1956 for the ssl version supported. Actually the possible values of1957 this option are:19581959 - sslv21960 - sslv31961 - tlsv11962 - tlsv1.01963 - tlsv1.11964 - tlsv1.21965 - tlsv1.319661967+1968Can be overridden by the `GIT_SSL_VERSION` environment variable.1969To force git to use libcurl's default ssl version and ignore any1970explicit http.sslversion option, set `GIT_SSL_VERSION` to the1971empty string.19721973http.sslCipherList::1974 A list of SSL ciphers to use when negotiating an SSL connection.1975 The available ciphers depend on whether libcurl was built against1976 NSS or OpenSSL and the particular configuration of the crypto1977 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'1978 option; see the libcurl documentation for more details on the format1979 of this list.1980+1981Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.1982To force git to use libcurl's default cipher list and ignore any1983explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the1984empty string.19851986http.sslVerify::1987 Whether to verify the SSL certificate when fetching or pushing1988 over HTTPS. Defaults to true. Can be overridden by the1989 `GIT_SSL_NO_VERIFY` environment variable.19901991http.sslCert::1992 File containing the SSL certificate when fetching or pushing1993 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment1994 variable.19951996http.sslKey::1997 File containing the SSL private key when fetching or pushing1998 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment1999 variable.20002001http.sslCertPasswordProtected::2002 Enable Git's password prompt for the SSL certificate. Otherwise2003 OpenSSL will prompt the user, possibly many times, if the2004 certificate or private key is encrypted. Can be overridden by the2005 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.20062007http.sslCAInfo::2008 File containing the certificates to verify the peer with when2009 fetching or pushing over HTTPS. Can be overridden by the2010 `GIT_SSL_CAINFO` environment variable.20112012http.sslCAPath::2013 Path containing files with the CA certificates to verify the peer2014 with when fetching or pushing over HTTPS. Can be overridden2015 by the `GIT_SSL_CAPATH` environment variable.20162017http.pinnedpubkey::2018 Public key of the https service. It may either be the filename of2019 a PEM or DER encoded public key file or a string starting with2020 'sha256//' followed by the base64 encoded sha256 hash of the2021 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will2022 exit with an error if this option is set but not supported by2023 cURL.20242025http.sslTry::2026 Attempt to use AUTH SSL/TLS and encrypted data transfers2027 when connecting via regular FTP protocol. This might be needed2028 if the FTP server requires it for security reasons or you wish2029 to connect securely whenever remote FTP server supports it.2030 Default is false since it might trigger certificate verification2031 errors on misconfigured servers.20322033http.maxRequests::2034 How many HTTP requests to launch in parallel. Can be overridden2035 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.20362037http.minSessions::2038 The number of curl sessions (counted across slots) to be kept across2039 requests. They will not be ended with curl_easy_cleanup() until2040 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this2041 value will be capped at 1. Defaults to 1.20422043http.postBuffer::2044 Maximum size in bytes of the buffer used by smart HTTP2045 transports when POSTing data to the remote system.2046 For requests larger than this buffer size, HTTP/1.1 and2047 Transfer-Encoding: chunked is used to avoid creating a2048 massive pack file locally. Default is 1 MiB, which is2049 sufficient for most requests.20502051http.lowSpeedLimit, http.lowSpeedTime::2052 If the HTTP transfer speed is less than 'http.lowSpeedLimit'2053 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.2054 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and2055 `GIT_HTTP_LOW_SPEED_TIME` environment variables.20562057http.noEPSV::2058 A boolean which disables using of EPSV ftp command by curl.2059 This can helpful with some "poor" ftp servers which don't2060 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`2061 environment variable. Default is false (curl will use EPSV).20622063http.userAgent::2064 The HTTP USER_AGENT string presented to an HTTP server. The default2065 value represents the version of the client Git such as git/1.7.1.2066 This option allows you to override this value to a more common value2067 such as Mozilla/4.0. This may be necessary, for instance, if2068 connecting through a firewall that restricts HTTP connections to a set2069 of common USER_AGENT strings (but not including those like git/1.7.1).2070 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.20712072http.followRedirects::2073 Whether git should follow HTTP redirects. If set to `true`, git2074 will transparently follow any redirect issued by a server it2075 encounters. If set to `false`, git will treat all redirects as2076 errors. If set to `initial`, git will follow redirects only for2077 the initial request to a remote, but not for subsequent2078 follow-up HTTP requests. Since git uses the redirected URL as2079 the base for the follow-up requests, this is generally2080 sufficient. The default is `initial`.20812082http.<url>.*::2083 Any of the http.* options above can be applied selectively to some URLs.2084 For a config key to match a URL, each element of the config key is2085 compared to that of the URL, in the following order:2086+2087--2088. Scheme (e.g., `https` in `https://example.com/`). This field2089 must match exactly between the config key and the URL.20902091. Host/domain name (e.g., `example.com` in `https://example.com/`).2092 This field must match between the config key and the URL. It is2093 possible to specify a `*` as part of the host name to match all subdomains2094 at this level. `https://*.example.com/` for example would match2095 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.20962097. Port number (e.g., `8080` in `http://example.com:8080/`).2098 This field must match exactly between the config key and the URL.2099 Omitted port numbers are automatically converted to the correct2100 default for the scheme before matching.21012102. Path (e.g., `repo.git` in `https://example.com/repo.git`). The2103 path field of the config key must match the path field of the URL2104 either exactly or as a prefix of slash-delimited path elements. This means2105 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only2106 match on a slash (`/`) boundary. Longer matches take precedence (so a config2107 key with path `foo/bar` is a better match to URL path `foo/bar` than a config2108 key with just path `foo/`).21092110. User name (e.g., `user` in `https://user@example.com/repo.git`). If2111 the config key has a user name it must match the user name in the2112 URL exactly. If the config key does not have a user name, that2113 config key will match a URL with any user name (including none),2114 but at a lower precedence than a config key with a user name.2115--2116+2117The list above is ordered by decreasing precedence; a URL that matches2118a config key's path is preferred to one that matches its user name. For example,2119if the URL is `https://user@example.com/foo/bar` a config key match of2120`https://example.com/foo` will be preferred over a config key match of2121`https://user@example.com`.2122+2123All URLs are normalized before attempting any matching (the password part,2124if embedded in the URL, is always ignored for matching purposes) so that2125equivalent URLs that are simply spelled differently will match properly.2126Environment variable settings always override any matches. The URLs that are2127matched against are those given directly to Git commands. This means any URLs2128visited as a result of a redirection do not participate in matching.21292130ssh.variant::2131 By default, Git determines the command line arguments to use2132 based on the basename of the configured SSH command (configured2133 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or2134 the config setting `core.sshCommand`). If the basename is2135 unrecognized, Git will attempt to detect support of OpenSSH2136 options by first invoking the configured SSH command with the2137 `-G` (print configuration) option and will subsequently use2138 OpenSSH options (if that is successful) or no options besides2139 the host and remote command (if it fails).2140+2141The config variable `ssh.variant` can be set to override this detection.2142Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,2143`tortoiseplink`, `simple` (no options except the host and remote command).2144The default auto-detection can be explicitly requested using the value2145`auto`. Any other value is treated as `ssh`. This setting can also be2146overridden via the environment variable `GIT_SSH_VARIANT`.2147+2148The current command-line parameters used for each variant are as2149follows:2150+2151--21522153* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command21542155* `simple` - [username@]host command21562157* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command21582159* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command21602161--2162+2163Except for the `simple` variant, command-line parameters are likely to2164change as git gains new features.21652166i18n.commitEncoding::2167 Character encoding the commit messages are stored in; Git itself2168 does not care per se, but this information is necessary e.g. when2169 importing commits from emails or in the gitk graphical history2170 browser (and possibly at other places in the future or in other2171 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.21722173i18n.logOutputEncoding::2174 Character encoding the commit messages are converted to when2175 running 'git log' and friends.21762177imap::2178 The configuration variables in the 'imap' section are described2179 in linkgit:git-imap-send[1].21802181index.version::2182 Specify the version with which new index files should be2183 initialized. This does not affect existing repositories.21842185init.templateDir::2186 Specify the directory from which templates will be copied.2187 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)21882189instaweb.browser::2190 Specify the program that will be used to browse your working2191 repository in gitweb. See linkgit:git-instaweb[1].21922193instaweb.httpd::2194 The HTTP daemon command-line to start gitweb on your working2195 repository. See linkgit:git-instaweb[1].21962197instaweb.local::2198 If true the web server started by linkgit:git-instaweb[1] will2199 be bound to the local IP (127.0.0.1).22002201instaweb.modulePath::2202 The default module path for linkgit:git-instaweb[1] to use2203 instead of /usr/lib/apache2/modules. Only used if httpd2204 is Apache.22052206instaweb.port::2207 The port number to bind the gitweb httpd to. See2208 linkgit:git-instaweb[1].22092210interactive.singleKey::2211 In interactive commands, allow the user to provide one-letter2212 input with a single key (i.e., without hitting enter).2213 Currently this is used by the `--patch` mode of2214 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],2215 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this2216 setting is silently ignored if portable keystroke input2217 is not available; requires the Perl module Term::ReadKey.22182219interactive.diffFilter::2220 When an interactive command (such as `git add --patch`) shows2221 a colorized diff, git will pipe the diff through the shell2222 command defined by this configuration variable. The command may2223 mark up the diff further for human consumption, provided that it2224 retains a one-to-one correspondence with the lines in the2225 original diff. Defaults to disabled (no filtering).22262227log.abbrevCommit::2228 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2229 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may2230 override this option with `--no-abbrev-commit`.22312232log.date::2233 Set the default date-time mode for the 'log' command.2234 Setting a value for log.date is similar to using 'git log''s2235 `--date` option. See linkgit:git-log[1] for details.22362237log.decorate::2238 Print out the ref names of any commits that are shown by the log2239 command. If 'short' is specified, the ref name prefixes 'refs/heads/',2240 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is2241 specified, the full ref name (including prefix) will be printed.2242 If 'auto' is specified, then if the output is going to a terminal,2243 the ref names are shown as if 'short' were given, otherwise no ref2244 names are shown. This is the same as the `--decorate` option2245 of the `git log`.22462247log.follow::2248 If `true`, `git log` will act as if the `--follow` option was used when2249 a single <path> is given. This has the same limitations as `--follow`,2250 i.e. it cannot be used to follow multiple files and does not work well2251 on non-linear history.22522253log.graphColors::2254 A list of colors, separated by commas, that can be used to draw2255 history lines in `git log --graph`.22562257log.showRoot::2258 If true, the initial commit will be shown as a big creation event.2259 This is equivalent to a diff against an empty tree.2260 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2261 normally hide the root commit will now show it. True by default.22622263log.showSignature::2264 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2265 linkgit:git-whatchanged[1] assume `--show-signature`.22662267log.mailmap::2268 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2269 linkgit:git-whatchanged[1] assume `--use-mailmap`.22702271mailinfo.scissors::2272 If true, makes linkgit:git-mailinfo[1] (and therefore2273 linkgit:git-am[1]) act by default as if the --scissors option2274 was provided on the command-line. When active, this features2275 removes everything from the message body before a scissors2276 line (i.e. consisting mainly of ">8", "8<" and "-").22772278mailmap.file::2279 The location of an augmenting mailmap file. The default2280 mailmap, located in the root of the repository, is loaded2281 first, then the mailmap file pointed to by this variable.2282 The location of the mailmap file may be in a repository2283 subdirectory, or somewhere outside of the repository itself.2284 See linkgit:git-shortlog[1] and linkgit:git-blame[1].22852286mailmap.blob::2287 Like `mailmap.file`, but consider the value as a reference to a2288 blob in the repository. If both `mailmap.file` and2289 `mailmap.blob` are given, both are parsed, with entries from2290 `mailmap.file` taking precedence. In a bare repository, this2291 defaults to `HEAD:.mailmap`. In a non-bare repository, it2292 defaults to empty.22932294man.viewer::2295 Specify the programs that may be used to display help in the2296 'man' format. See linkgit:git-help[1].22972298man.<tool>.cmd::2299 Specify the command to invoke the specified man viewer. The2300 specified command is evaluated in shell with the man page2301 passed as argument. (See linkgit:git-help[1].)23022303man.<tool>.path::2304 Override the path for the given tool that may be used to2305 display help in the 'man' format. See linkgit:git-help[1].23062307include::merge-config.txt[]23082309mergetool.<tool>.path::2310 Override the path for the given tool. This is useful in case2311 your tool is not in the PATH.23122313mergetool.<tool>.cmd::2314 Specify the command to invoke the specified merge tool. The2315 specified command is evaluated in shell with the following2316 variables available: 'BASE' is the name of a temporary file2317 containing the common base of the files to be merged, if available;2318 'LOCAL' is the name of a temporary file containing the contents of2319 the file on the current branch; 'REMOTE' is the name of a temporary2320 file containing the contents of the file from the branch being2321 merged; 'MERGED' contains the name of the file to which the merge2322 tool should write the results of a successful merge.23232324mergetool.<tool>.trustExitCode::2325 For a custom merge command, specify whether the exit code of2326 the merge command can be used to determine whether the merge was2327 successful. If this is not set to true then the merge target file2328 timestamp is checked and the merge assumed to have been successful2329 if the file has been updated, otherwise the user is prompted to2330 indicate the success of the merge.23312332mergetool.meld.hasOutput::2333 Older versions of `meld` do not support the `--output` option.2334 Git will attempt to detect whether `meld` supports `--output`2335 by inspecting the output of `meld --help`. Configuring2336 `mergetool.meld.hasOutput` will make Git skip these checks and2337 use the configured value instead. Setting `mergetool.meld.hasOutput`2338 to `true` tells Git to unconditionally use the `--output` option,2339 and `false` avoids using `--output`.23402341mergetool.keepBackup::2342 After performing a merge, the original file with conflict markers2343 can be saved as a file with a `.orig` extension. If this variable2344 is set to `false` then this file is not preserved. Defaults to2345 `true` (i.e. keep the backup files).23462347mergetool.keepTemporaries::2348 When invoking a custom merge tool, Git uses a set of temporary2349 files to pass to the tool. If the tool returns an error and this2350 variable is set to `true`, then these temporary files will be2351 preserved, otherwise they will be removed after the tool has2352 exited. Defaults to `false`.23532354mergetool.writeToTemp::2355 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2356 conflicting files in the worktree by default. Git will attempt2357 to use a temporary directory for these files when set `true`.2358 Defaults to `false`.23592360mergetool.prompt::2361 Prompt before each invocation of the merge resolution program.23622363notes.mergeStrategy::2364 Which merge strategy to choose by default when resolving notes2365 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2366 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2367 section of linkgit:git-notes[1] for more information on each strategy.23682369notes.<name>.mergeStrategy::2370 Which merge strategy to choose when doing a notes merge into2371 refs/notes/<name>. This overrides the more general2372 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2373 linkgit:git-notes[1] for more information on the available strategies.23742375notes.displayRef::2376 The (fully qualified) refname from which to show notes when2377 showing commit messages. The value of this variable can be set2378 to a glob, in which case notes from all matching refs will be2379 shown. You may also specify this configuration variable2380 several times. A warning will be issued for refs that do not2381 exist, but a glob that does not match any refs is silently2382 ignored.2383+2384This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2385environment variable, which must be a colon separated list of refs or2386globs.2387+2388The effective value of "core.notesRef" (possibly overridden by2389GIT_NOTES_REF) is also implicitly added to the list of refs to be2390displayed.23912392notes.rewrite.<command>::2393 When rewriting commits with <command> (currently `amend` or2394 `rebase`) and this variable is set to `true`, Git2395 automatically copies your notes from the original to the2396 rewritten commit. Defaults to `true`, but see2397 "notes.rewriteRef" below.23982399notes.rewriteMode::2400 When copying notes during a rewrite (see the2401 "notes.rewrite.<command>" option), determines what to do if2402 the target commit already has a note. Must be one of2403 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2404 Defaults to `concatenate`.2405+2406This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2407environment variable.24082409notes.rewriteRef::2410 When copying notes during a rewrite, specifies the (fully2411 qualified) ref whose notes should be copied. The ref may be a2412 glob, in which case notes in all matching refs will be copied.2413 You may also specify this configuration several times.2414+2415Does not have a default value; you must configure this variable to2416enable note rewriting. Set it to `refs/notes/commits` to enable2417rewriting for the default commit notes.2418+2419This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2420environment variable, which must be a colon separated list of refs or2421globs.24222423pack.window::2424 The size of the window used by linkgit:git-pack-objects[1] when no2425 window size is given on the command line. Defaults to 10.24262427pack.depth::2428 The maximum delta depth used by linkgit:git-pack-objects[1] when no2429 maximum depth is given on the command line. Defaults to 50.24302431pack.windowMemory::2432 The maximum size of memory that is consumed by each thread2433 in linkgit:git-pack-objects[1] for pack window memory when2434 no limit is given on the command line. The value can be2435 suffixed with "k", "m", or "g". When left unconfigured (or2436 set explicitly to 0), there will be no limit.24372438pack.compression::2439 An integer -1..9, indicating the compression level for objects2440 in a pack file. -1 is the zlib default. 0 means no2441 compression, and 1..9 are various speed/size tradeoffs, 9 being2442 slowest. If not set, defaults to core.compression. If that is2443 not set, defaults to -1, the zlib default, which is "a default2444 compromise between speed and compression (currently equivalent2445 to level 6)."2446+2447Note that changing the compression level will not automatically recompress2448all existing objects. You can force recompression by passing the -F option2449to linkgit:git-repack[1].24502451pack.deltaCacheSize::2452 The maximum memory in bytes used for caching deltas in2453 linkgit:git-pack-objects[1] before writing them out to a pack.2454 This cache is used to speed up the writing object phase by not2455 having to recompute the final delta result once the best match2456 for all objects is found. Repacking large repositories on machines2457 which are tight with memory might be badly impacted by this though,2458 especially if this cache pushes the system into swapping.2459 A value of 0 means no limit. The smallest size of 1 byte may be2460 used to virtually disable this cache. Defaults to 256 MiB.24612462pack.deltaCacheLimit::2463 The maximum size of a delta, that is cached in2464 linkgit:git-pack-objects[1]. This cache is used to speed up the2465 writing object phase by not having to recompute the final delta2466 result once the best match for all objects is found. Defaults to 1000.24672468pack.threads::2469 Specifies the number of threads to spawn when searching for best2470 delta matches. This requires that linkgit:git-pack-objects[1]2471 be compiled with pthreads otherwise this option is ignored with a2472 warning. This is meant to reduce packing time on multiprocessor2473 machines. The required amount of memory for the delta search window2474 is however multiplied by the number of threads.2475 Specifying 0 will cause Git to auto-detect the number of CPU's2476 and set the number of threads accordingly.24772478pack.indexVersion::2479 Specify the default pack index version. Valid values are 1 for2480 legacy pack index used by Git versions prior to 1.5.2, and 2 for2481 the new pack index with capabilities for packs larger than 4 GB2482 as well as proper protection against the repacking of corrupted2483 packs. Version 2 is the default. Note that version 2 is enforced2484 and this config option ignored whenever the corresponding pack is2485 larger than 2 GB.2486+2487If you have an old Git that does not understand the version 2 `*.idx` file,2488cloning or fetching over a non native protocol (e.g. "http")2489that will copy both `*.pack` file and corresponding `*.idx` file from the2490other side may give you a repository that cannot be accessed with your2491older version of Git. If the `*.pack` file is smaller than 2 GB, however,2492you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2493the `*.idx` file.24942495pack.packSizeLimit::2496 The maximum size of a pack. This setting only affects2497 packing to a file when repacking, i.e. the git:// protocol2498 is unaffected. It can be overridden by the `--max-pack-size`2499 option of linkgit:git-repack[1]. Reaching this limit results2500 in the creation of multiple packfiles; which in turn prevents2501 bitmaps from being created.2502 The minimum size allowed is limited to 1 MiB.2503 The default is unlimited.2504 Common unit suffixes of 'k', 'm', or 'g' are2505 supported.25062507pack.useBitmaps::2508 When true, git will use pack bitmaps (if available) when packing2509 to stdout (e.g., during the server side of a fetch). Defaults to2510 true. You should not generally need to turn this off unless2511 you are debugging pack bitmaps.25122513pack.writeBitmaps (deprecated)::2514 This is a deprecated synonym for `repack.writeBitmaps`.25152516pack.writeBitmapHashCache::2517 When true, git will include a "hash cache" section in the bitmap2518 index (if one is written). This cache can be used to feed git's2519 delta heuristics, potentially leading to better deltas between2520 bitmapped and non-bitmapped objects (e.g., when serving a fetch2521 between an older, bitmapped pack and objects that have been2522 pushed since the last gc). The downside is that it consumes 42523 bytes per object of disk space, and that JGit's bitmap2524 implementation does not understand it, causing it to complain if2525 Git and JGit are used on the same repository. Defaults to false.25262527pager.<cmd>::2528 If the value is boolean, turns on or off pagination of the2529 output of a particular Git subcommand when writing to a tty.2530 Otherwise, turns on pagination for the subcommand using the2531 pager specified by the value of `pager.<cmd>`. If `--paginate`2532 or `--no-pager` is specified on the command line, it takes2533 precedence over this option. To disable pagination for all2534 commands, set `core.pager` or `GIT_PAGER` to `cat`.25352536pretty.<name>::2537 Alias for a --pretty= format string, as specified in2538 linkgit:git-log[1]. Any aliases defined here can be used just2539 as the built-in pretty formats could. For example,2540 running `git config pretty.changelog "format:* %H %s"`2541 would cause the invocation `git log --pretty=changelog`2542 to be equivalent to running `git log "--pretty=format:* %H %s"`.2543 Note that an alias with the same name as a built-in format2544 will be silently ignored.25452546protocol.allow::2547 If set, provide a user defined default policy for all protocols which2548 don't explicitly have a policy (`protocol.<name>.allow`). By default,2549 if unset, known-safe protocols (http, https, git, ssh, file) have a2550 default policy of `always`, known-dangerous protocols (ext) have a2551 default policy of `never`, and all other protocols have a default2552 policy of `user`. Supported policies:2553+2554--25552556* `always` - protocol is always able to be used.25572558* `never` - protocol is never able to be used.25592560* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is2561 either unset or has a value of 1. This policy should be used when you want a2562 protocol to be directly usable by the user but don't want it used by commands which2563 execute clone/fetch/push commands without user input, e.g. recursive2564 submodule initialization.25652566--25672568protocol.<name>.allow::2569 Set a policy to be used by protocol `<name>` with clone/fetch/push2570 commands. See `protocol.allow` above for the available policies.2571+2572The protocol names currently used by git are:2573+2574--2575 - `file`: any local file-based path (including `file://` URLs,2576 or local paths)25772578 - `git`: the anonymous git protocol over a direct TCP2579 connection (or proxy, if configured)25802581 - `ssh`: git over ssh (including `host:path` syntax,2582 `ssh://`, etc).25832584 - `http`: git over http, both "smart http" and "dumb http".2585 Note that this does _not_ include `https`; if you want to configure2586 both, you must do so individually.25872588 - any external helpers are named by their protocol (e.g., use2589 `hg` to allow the `git-remote-hg` helper)2590--25912592protocol.version::2593 Experimental. If set, clients will attempt to communicate with a2594 server using the specified protocol version. If unset, no2595 attempt will be made by the client to communicate using a2596 particular protocol version, this results in protocol version 02597 being used.2598 Supported versions:2599+2600--26012602* `0` - the original wire protocol.26032604* `1` - the original wire protocol with the addition of a version string2605 in the initial response from the server.26062607--26082609pull.ff::2610 By default, Git does not create an extra merge commit when merging2611 a commit that is a descendant of the current commit. Instead, the2612 tip of the current branch is fast-forwarded. When set to `false`,2613 this variable tells Git to create an extra merge commit in such2614 a case (equivalent to giving the `--no-ff` option from the command2615 line). When set to `only`, only such fast-forward merges are2616 allowed (equivalent to giving the `--ff-only` option from the2617 command line). This setting overrides `merge.ff` when pulling.26182619pull.rebase::2620 When true, rebase branches on top of the fetched branch, instead2621 of merging the default branch from the default remote when "git2622 pull" is run. See "branch.<name>.rebase" for setting this on a2623 per-branch basis.2624+2625When preserve, also pass `--preserve-merges` along to 'git rebase'2626so that locally committed merge commits will not be flattened2627by running 'git pull'.2628+2629When the value is `interactive`, the rebase is run in interactive mode.2630+2631*NOTE*: this is a possibly dangerous operation; do *not* use2632it unless you understand the implications (see linkgit:git-rebase[1]2633for details).26342635pull.octopus::2636 The default merge strategy to use when pulling multiple branches2637 at once.26382639pull.twohead::2640 The default merge strategy to use when pulling a single branch.26412642push.default::2643 Defines the action `git push` should take if no refspec is2644 explicitly given. Different values are well-suited for2645 specific workflows; for instance, in a purely central workflow2646 (i.e. the fetch source is equal to the push destination),2647 `upstream` is probably what you want. Possible values are:2648+2649--26502651* `nothing` - do not push anything (error out) unless a refspec is2652 explicitly given. This is primarily meant for people who want to2653 avoid mistakes by always being explicit.26542655* `current` - push the current branch to update a branch with the same2656 name on the receiving end. Works in both central and non-central2657 workflows.26582659* `upstream` - push the current branch back to the branch whose2660 changes are usually integrated into the current branch (which is2661 called `@{upstream}`). This mode only makes sense if you are2662 pushing to the same repository you would normally pull from2663 (i.e. central workflow).26642665* `tracking` - This is a deprecated synonym for `upstream`.26662667* `simple` - in centralized workflow, work like `upstream` with an2668 added safety to refuse to push if the upstream branch's name is2669 different from the local one.2670+2671When pushing to a remote that is different from the remote you normally2672pull from, work as `current`. This is the safest option and is suited2673for beginners.2674+2675This mode has become the default in Git 2.0.26762677* `matching` - push all branches having the same name on both ends.2678 This makes the repository you are pushing to remember the set of2679 branches that will be pushed out (e.g. if you always push 'maint'2680 and 'master' there and no other branches, the repository you push2681 to will have these two branches, and your local 'maint' and2682 'master' will be pushed there).2683+2684To use this mode effectively, you have to make sure _all_ the2685branches you would push out are ready to be pushed out before2686running 'git push', as the whole point of this mode is to allow you2687to push all of the branches in one go. If you usually finish work2688on only one branch and push out the result, while other branches are2689unfinished, this mode is not for you. Also this mode is not2690suitable for pushing into a shared central repository, as other2691people may add new branches there, or update the tip of existing2692branches outside your control.2693+2694This used to be the default, but not since Git 2.0 (`simple` is the2695new default).26962697--26982699push.followTags::2700 If set to true enable `--follow-tags` option by default. You2701 may override this configuration at time of push by specifying2702 `--no-follow-tags`.27032704push.gpgSign::2705 May be set to a boolean value, or the string 'if-asked'. A true2706 value causes all pushes to be GPG signed, as if `--signed` is2707 passed to linkgit:git-push[1]. The string 'if-asked' causes2708 pushes to be signed if the server supports it, as if2709 `--signed=if-asked` is passed to 'git push'. A false value may2710 override a value from a lower-priority config file. An explicit2711 command-line flag always overrides this config option.27122713push.pushOption::2714 When no `--push-option=<option>` argument is given from the2715 command line, `git push` behaves as if each <value> of2716 this variable is given as `--push-option=<value>`.2717+2718This is a multi-valued variable, and an empty value can be used in a2719higher priority configuration file (e.g. `.git/config` in a2720repository) to clear the values inherited from a lower priority2721configuration files (e.g. `$HOME/.gitconfig`).2722+2723--27242725Example:27262727/etc/gitconfig2728 push.pushoption = a2729 push.pushoption = b27302731~/.gitconfig2732 push.pushoption = c27332734repo/.git/config2735 push.pushoption =2736 push.pushoption = b27372738This will result in only b (a and c are cleared).27392740--27412742push.recurseSubmodules::2743 Make sure all submodule commits used by the revisions to be pushed2744 are available on a remote-tracking branch. If the value is 'check'2745 then Git will verify that all submodule commits that changed in the2746 revisions to be pushed are available on at least one remote of the2747 submodule. If any commits are missing, the push will be aborted and2748 exit with non-zero status. If the value is 'on-demand' then all2749 submodules that changed in the revisions to be pushed will be2750 pushed. If on-demand was not able to push all necessary revisions2751 it will also be aborted and exit with non-zero status. If the value2752 is 'no' then default behavior of ignoring submodules when pushing2753 is retained. You may override this configuration at time of push by2754 specifying '--recurse-submodules=check|on-demand|no'.27552756include::rebase-config.txt[]27572758receive.advertiseAtomic::2759 By default, git-receive-pack will advertise the atomic push2760 capability to its clients. If you don't want to advertise this2761 capability, set this variable to false.27622763receive.advertisePushOptions::2764 When set to true, git-receive-pack will advertise the push options2765 capability to its clients. False by default.27662767receive.autogc::2768 By default, git-receive-pack will run "git-gc --auto" after2769 receiving data from git-push and updating refs. You can stop2770 it by setting this variable to false.27712772receive.certNonceSeed::2773 By setting this variable to a string, `git receive-pack`2774 will accept a `git push --signed` and verifies it by using2775 a "nonce" protected by HMAC using this string as a secret2776 key.27772778receive.certNonceSlop::2779 When a `git push --signed` sent a push certificate with a2780 "nonce" that was issued by a receive-pack serving the same2781 repository within this many seconds, export the "nonce"2782 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2783 hooks (instead of what the receive-pack asked the sending2784 side to include). This may allow writing checks in2785 `pre-receive` and `post-receive` a bit easier. Instead of2786 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2787 that records by how many seconds the nonce is stale to2788 decide if they want to accept the certificate, they only2789 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.27902791receive.fsckObjects::2792 If it is set to true, git-receive-pack will check all received2793 objects. It will abort in the case of a malformed object or a2794 broken link. The result of an abort are only dangling objects.2795 Defaults to false. If not set, the value of `transfer.fsckObjects`2796 is used instead.27972798receive.fsck.<msg-id>::2799 When `receive.fsckObjects` is set to true, errors can be switched2800 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2801 setting where the `<msg-id>` is the fsck message ID and the value2802 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2803 the error/warning with the message ID, e.g. "missingEmail: invalid2804 author/committer line - missing email" means that setting2805 `receive.fsck.missingEmail = ignore` will hide that issue.2806+2807This feature is intended to support working with legacy repositories2808which would not pass pushing when `receive.fsckObjects = true`, allowing2809the host to accept repositories with certain known issues but still catch2810other issues.28112812receive.fsck.skipList::2813 The path to a sorted list of object names (i.e. one SHA-1 per2814 line) that are known to be broken in a non-fatal way and should2815 be ignored. This feature is useful when an established project2816 should be accepted despite early commits containing errors that2817 can be safely ignored such as invalid committer email addresses.2818 Note: corrupt objects cannot be skipped with this setting.28192820receive.keepAlive::2821 After receiving the pack from the client, `receive-pack` may2822 produce no output (if `--quiet` was specified) while processing2823 the pack, causing some networks to drop the TCP connection.2824 With this option set, if `receive-pack` does not transmit2825 any data in this phase for `receive.keepAlive` seconds, it will2826 send a short keepalive packet. The default is 5 seconds; set2827 to 0 to disable keepalives entirely.28282829receive.unpackLimit::2830 If the number of objects received in a push is below this2831 limit then the objects will be unpacked into loose object2832 files. However if the number of received objects equals or2833 exceeds this limit then the received pack will be stored as2834 a pack, after adding any missing delta bases. Storing the2835 pack from a push can make the push operation complete faster,2836 especially on slow filesystems. If not set, the value of2837 `transfer.unpackLimit` is used instead.28382839receive.maxInputSize::2840 If the size of the incoming pack stream is larger than this2841 limit, then git-receive-pack will error out, instead of2842 accepting the pack file. If not set or set to 0, then the size2843 is unlimited.28442845receive.denyDeletes::2846 If set to true, git-receive-pack will deny a ref update that deletes2847 the ref. Use this to prevent such a ref deletion via a push.28482849receive.denyDeleteCurrent::2850 If set to true, git-receive-pack will deny a ref update that2851 deletes the currently checked out branch of a non-bare repository.28522853receive.denyCurrentBranch::2854 If set to true or "refuse", git-receive-pack will deny a ref update2855 to the currently checked out branch of a non-bare repository.2856 Such a push is potentially dangerous because it brings the HEAD2857 out of sync with the index and working tree. If set to "warn",2858 print a warning of such a push to stderr, but allow the push to2859 proceed. If set to false or "ignore", allow such pushes with no2860 message. Defaults to "refuse".2861+2862Another option is "updateInstead" which will update the working2863tree if pushing into the current branch. This option is2864intended for synchronizing working directories when one side is not easily2865accessible via interactive ssh (e.g. a live web site, hence the requirement2866that the working directory be clean). This mode also comes in handy when2867developing inside a VM to test and fix code on different Operating Systems.2868+2869By default, "updateInstead" will refuse the push if the working tree or2870the index have any difference from the HEAD, but the `push-to-checkout`2871hook can be used to customize this. See linkgit:githooks[5].28722873receive.denyNonFastForwards::2874 If set to true, git-receive-pack will deny a ref update which is2875 not a fast-forward. Use this to prevent such an update via a push,2876 even if that push is forced. This configuration variable is2877 set when initializing a shared repository.28782879receive.hideRefs::2880 This variable is the same as `transfer.hideRefs`, but applies2881 only to `receive-pack` (and so affects pushes, but not fetches).2882 An attempt to update or delete a hidden ref by `git push` is2883 rejected.28842885receive.updateServerInfo::2886 If set to true, git-receive-pack will run git-update-server-info2887 after receiving data from git-push and updating refs.28882889receive.shallowUpdate::2890 If set to true, .git/shallow can be updated when new refs2891 require new shallow roots. Otherwise those refs are rejected.28922893remote.pushDefault::2894 The remote to push to by default. Overrides2895 `branch.<name>.remote` for all branches, and is overridden by2896 `branch.<name>.pushRemote` for specific branches.28972898remote.<name>.url::2899 The URL of a remote repository. See linkgit:git-fetch[1] or2900 linkgit:git-push[1].29012902remote.<name>.pushurl::2903 The push URL of a remote repository. See linkgit:git-push[1].29042905remote.<name>.proxy::2906 For remotes that require curl (http, https and ftp), the URL to2907 the proxy to use for that remote. Set to the empty string to2908 disable proxying for that remote.29092910remote.<name>.proxyAuthMethod::2911 For remotes that require curl (http, https and ftp), the method to use for2912 authenticating against the proxy in use (probably set in2913 `remote.<name>.proxy`). See `http.proxyAuthMethod`.29142915remote.<name>.fetch::2916 The default set of "refspec" for linkgit:git-fetch[1]. See2917 linkgit:git-fetch[1].29182919remote.<name>.push::2920 The default set of "refspec" for linkgit:git-push[1]. See2921 linkgit:git-push[1].29222923remote.<name>.mirror::2924 If true, pushing to this remote will automatically behave2925 as if the `--mirror` option was given on the command line.29262927remote.<name>.skipDefaultUpdate::2928 If true, this remote will be skipped by default when updating2929 using linkgit:git-fetch[1] or the `update` subcommand of2930 linkgit:git-remote[1].29312932remote.<name>.skipFetchAll::2933 If true, this remote will be skipped by default when updating2934 using linkgit:git-fetch[1] or the `update` subcommand of2935 linkgit:git-remote[1].29362937remote.<name>.receivepack::2938 The default program to execute on the remote side when pushing. See2939 option --receive-pack of linkgit:git-push[1].29402941remote.<name>.uploadpack::2942 The default program to execute on the remote side when fetching. See2943 option --upload-pack of linkgit:git-fetch-pack[1].29442945remote.<name>.tagOpt::2946 Setting this value to --no-tags disables automatic tag following when2947 fetching from remote <name>. Setting it to --tags will fetch every2948 tag from remote <name>, even if they are not reachable from remote2949 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2950 override this setting. See options --tags and --no-tags of2951 linkgit:git-fetch[1].29522953remote.<name>.vcs::2954 Setting this to a value <vcs> will cause Git to interact with2955 the remote with the git-remote-<vcs> helper.29562957remote.<name>.prune::2958 When set to true, fetching from this remote by default will also2959 remove any remote-tracking references that no longer exist on the2960 remote (as if the `--prune` option was given on the command line).2961 Overrides `fetch.prune` settings, if any.29622963remote.<name>.pruneTags::2964 When set to true, fetching from this remote by default will also2965 remove any local tags that no longer exist on the remote if pruning2966 is activated in general via `remote.<name>.prune`, `fetch.prune` or2967 `--prune`. Overrides `fetch.pruneTags` settings, if any.2968+2969See also `remote.<name>.prune` and the PRUNING section of2970linkgit:git-fetch[1].29712972remotes.<group>::2973 The list of remotes which are fetched by "git remote update2974 <group>". See linkgit:git-remote[1].29752976repack.useDeltaBaseOffset::2977 By default, linkgit:git-repack[1] creates packs that use2978 delta-base offset. If you need to share your repository with2979 Git older than version 1.4.4, either directly or via a dumb2980 protocol such as http, then you need to set this option to2981 "false" and repack. Access from old Git versions over the2982 native protocol are unaffected by this option.29832984repack.packKeptObjects::2985 If set to true, makes `git repack` act as if2986 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2987 details. Defaults to `false` normally, but `true` if a bitmap2988 index is being written (either via `--write-bitmap-index` or2989 `repack.writeBitmaps`).29902991repack.writeBitmaps::2992 When true, git will write a bitmap index when packing all2993 objects to disk (e.g., when `git repack -a` is run). This2994 index can speed up the "counting objects" phase of subsequent2995 packs created for clones and fetches, at the cost of some disk2996 space and extra time spent on the initial repack. This has2997 no effect if multiple packfiles are created.2998 Defaults to false.29993000rerere.autoUpdate::3001 When set to true, `git-rerere` updates the index with the3002 resulting contents after it cleanly resolves conflicts using3003 previously recorded resolution. Defaults to false.30043005rerere.enabled::3006 Activate recording of resolved conflicts, so that identical3007 conflict hunks can be resolved automatically, should they be3008 encountered again. By default, linkgit:git-rerere[1] is3009 enabled if there is an `rr-cache` directory under the3010 `$GIT_DIR`, e.g. if "rerere" was previously used in the3011 repository.30123013sendemail.identity::3014 A configuration identity. When given, causes values in the3015 'sendemail.<identity>' subsection to take precedence over3016 values in the 'sendemail' section. The default identity is3017 the value of `sendemail.identity`.30183019sendemail.smtpEncryption::3020 See linkgit:git-send-email[1] for description. Note that this3021 setting is not subject to the 'identity' mechanism.30223023sendemail.smtpssl (deprecated)::3024 Deprecated alias for 'sendemail.smtpEncryption = ssl'.30253026sendemail.smtpsslcertpath::3027 Path to ca-certificates (either a directory or a single file).3028 Set it to an empty string to disable certificate verification.30293030sendemail.<identity>.*::3031 Identity-specific versions of the 'sendemail.*' parameters3032 found below, taking precedence over those when this3033 identity is selected, through either the command-line or3034 `sendemail.identity`.30353036sendemail.aliasesFile::3037sendemail.aliasFileType::3038sendemail.annotate::3039sendemail.bcc::3040sendemail.cc::3041sendemail.ccCmd::3042sendemail.chainReplyTo::3043sendemail.confirm::3044sendemail.envelopeSender::3045sendemail.from::3046sendemail.multiEdit::3047sendemail.signedoffbycc::3048sendemail.smtpPass::3049sendemail.suppresscc::3050sendemail.suppressFrom::3051sendemail.to::3052sendemail.tocmd::3053sendemail.smtpDomain::3054sendemail.smtpServer::3055sendemail.smtpServerPort::3056sendemail.smtpServerOption::3057sendemail.smtpUser::3058sendemail.thread::3059sendemail.transferEncoding::3060sendemail.validate::3061sendemail.xmailer::3062 See linkgit:git-send-email[1] for description.30633064sendemail.signedoffcc (deprecated)::3065 Deprecated alias for `sendemail.signedoffbycc`.30663067sendemail.smtpBatchSize::3068 Number of messages to be sent per connection, after that a relogin3069 will happen. If the value is 0 or undefined, send all messages in3070 one connection.3071 See also the `--batch-size` option of linkgit:git-send-email[1].30723073sendemail.smtpReloginDelay::3074 Seconds wait before reconnecting to smtp server.3075 See also the `--relogin-delay` option of linkgit:git-send-email[1].30763077showbranch.default::3078 The default set of branches for linkgit:git-show-branch[1].3079 See linkgit:git-show-branch[1].30803081splitIndex.maxPercentChange::3082 When the split index feature is used, this specifies the3083 percent of entries the split index can contain compared to the3084 total number of entries in both the split index and the shared3085 index before a new shared index is written.3086 The value should be between 0 and 100. If the value is 0 then3087 a new shared index is always written, if it is 100 a new3088 shared index is never written.3089 By default the value is 20, so a new shared index is written3090 if the number of entries in the split index would be greater3091 than 20 percent of the total number of entries.3092 See linkgit:git-update-index[1].30933094splitIndex.sharedIndexExpire::3095 When the split index feature is used, shared index files that3096 were not modified since the time this variable specifies will3097 be removed when a new shared index file is created. The value3098 "now" expires all entries immediately, and "never" suppresses3099 expiration altogether.3100 The default value is "2.weeks.ago".3101 Note that a shared index file is considered modified (for the3102 purpose of expiration) each time a new split-index file is3103 either created based on it or read from it.3104 See linkgit:git-update-index[1].31053106status.relativePaths::3107 By default, linkgit:git-status[1] shows paths relative to the3108 current directory. Setting this variable to `false` shows paths3109 relative to the repository root (this was the default for Git3110 prior to v1.5.4).31113112status.short::3113 Set to true to enable --short by default in linkgit:git-status[1].3114 The option --no-short takes precedence over this variable.31153116status.branch::3117 Set to true to enable --branch by default in linkgit:git-status[1].3118 The option --no-branch takes precedence over this variable.31193120status.displayCommentPrefix::3121 If set to true, linkgit:git-status[1] will insert a comment3122 prefix before each output line (starting with3123 `core.commentChar`, i.e. `#` by default). This was the3124 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.3125 Defaults to false.31263127status.showStash::3128 If set to true, linkgit:git-status[1] will display the number of3129 entries currently stashed away.3130 Defaults to false.31313132status.showUntrackedFiles::3133 By default, linkgit:git-status[1] and linkgit:git-commit[1] show3134 files which are not currently tracked by Git. Directories which3135 contain only untracked files, are shown with the directory name3136 only. Showing untracked files means that Git needs to lstat() all3137 the files in the whole repository, which might be slow on some3138 systems. So, this variable controls how the commands displays3139 the untracked files. Possible values are:3140+3141--3142* `no` - Show no untracked files.3143* `normal` - Show untracked files and directories.3144* `all` - Show also individual files in untracked directories.3145--3146+3147If this variable is not specified, it defaults to 'normal'.3148This variable can be overridden with the -u|--untracked-files option3149of linkgit:git-status[1] and linkgit:git-commit[1].31503151status.submoduleSummary::3152 Defaults to false.3153 If this is set to a non zero number or true (identical to -1 or an3154 unlimited number), the submodule summary will be enabled and a3155 summary of commits for modified submodules will be shown (see3156 --summary-limit option of linkgit:git-submodule[1]). Please note3157 that the summary output command will be suppressed for all3158 submodules when `diff.ignoreSubmodules` is set to 'all' or only3159 for those submodules where `submodule.<name>.ignore=all`. The only3160 exception to that rule is that status and commit will show staged3161 submodule changes. To3162 also view the summary for ignored submodules you can either use3163 the --ignore-submodules=dirty command-line option or the 'git3164 submodule summary' command, which shows a similar output but does3165 not honor these settings.31663167stash.showPatch::3168 If this is set to true, the `git stash show` command without an3169 option will show the stash entry in patch form. Defaults to false.3170 See description of 'show' command in linkgit:git-stash[1].31713172stash.showStat::3173 If this is set to true, the `git stash show` command without an3174 option will show diffstat of the stash entry. Defaults to true.3175 See description of 'show' command in linkgit:git-stash[1].31763177submodule.<name>.url::3178 The URL for a submodule. This variable is copied from the .gitmodules3179 file to the git config via 'git submodule init'. The user can change3180 the configured URL before obtaining the submodule via 'git submodule3181 update'. If neither submodule.<name>.active or submodule.active are3182 set, the presence of this variable is used as a fallback to indicate3183 whether the submodule is of interest to git commands.3184 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.31853186submodule.<name>.update::3187 The method by which a submodule is updated by 'git submodule update',3188 which is the only affected command, others such as3189 'git checkout --recurse-submodules' are unaffected. It exists for3190 historical reasons, when 'git submodule' was the only command to3191 interact with submodules; settings like `submodule.active`3192 and `pull.rebase` are more specific. It is populated by3193 `git submodule init` from the linkgit:gitmodules[5] file.3194 See description of 'update' command in linkgit:git-submodule[1].31953196submodule.<name>.branch::3197 The remote branch name for a submodule, used by `git submodule3198 update --remote`. Set this option to override the value found in3199 the `.gitmodules` file. See linkgit:git-submodule[1] and3200 linkgit:gitmodules[5] for details.32013202submodule.<name>.fetchRecurseSubmodules::3203 This option can be used to control recursive fetching of this3204 submodule. It can be overridden by using the --[no-]recurse-submodules3205 command-line option to "git fetch" and "git pull".3206 This setting will override that from in the linkgit:gitmodules[5]3207 file.32083209submodule.<name>.ignore::3210 Defines under what circumstances "git status" and the diff family show3211 a submodule as modified. When set to "all", it will never be considered3212 modified (but it will nonetheless show up in the output of status and3213 commit when it has been staged), "dirty" will ignore all changes3214 to the submodules work tree and3215 takes only differences between the HEAD of the submodule and the commit3216 recorded in the superproject into account. "untracked" will additionally3217 let submodules with modified tracked files in their work tree show up.3218 Using "none" (the default when this option is not set) also shows3219 submodules that have untracked files in their work tree as changed.3220 This setting overrides any setting made in .gitmodules for this submodule,3221 both settings can be overridden on the command line by using the3222 "--ignore-submodules" option. The 'git submodule' commands are not3223 affected by this setting.32243225submodule.<name>.active::3226 Boolean value indicating if the submodule is of interest to git3227 commands. This config option takes precedence over the3228 submodule.active config option.32293230submodule.active::3231 A repeated field which contains a pathspec used to match against a3232 submodule's path to determine if the submodule is of interest to git3233 commands.32343235submodule.recurse::3236 Specifies if commands recurse into submodules by default. This3237 applies to all commands that have a `--recurse-submodules` option,3238 except `clone`.3239 Defaults to false.32403241submodule.fetchJobs::3242 Specifies how many submodules are fetched/cloned at the same time.3243 A positive integer allows up to that number of submodules fetched3244 in parallel. A value of 0 will give some reasonable default.3245 If unset, it defaults to 1.32463247submodule.alternateLocation::3248 Specifies how the submodules obtain alternates when submodules are3249 cloned. Possible values are `no`, `superproject`.3250 By default `no` is assumed, which doesn't add references. When the3251 value is set to `superproject` the submodule to be cloned computes3252 its alternates location relative to the superprojects alternate.32533254submodule.alternateErrorStrategy::3255 Specifies how to treat errors with the alternates for a submodule3256 as computed via `submodule.alternateLocation`. Possible values are3257 `ignore`, `info`, `die`. Default is `die`.32583259tag.forceSignAnnotated::3260 A boolean to specify whether annotated tags created should be GPG signed.3261 If `--annotate` is specified on the command line, it takes3262 precedence over this option.32633264tag.sort::3265 This variable controls the sort ordering of tags when displayed by3266 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the3267 value of this variable will be used as the default.32683269tar.umask::3270 This variable can be used to restrict the permission bits of3271 tar archive entries. The default is 0002, which turns off the3272 world write bit. The special value "user" indicates that the3273 archiving user's umask will be used instead. See umask(2) and3274 linkgit:git-archive[1].32753276transfer.fsckObjects::3277 When `fetch.fsckObjects` or `receive.fsckObjects` are3278 not set, the value of this variable is used instead.3279 Defaults to false.32803281transfer.hideRefs::3282 String(s) `receive-pack` and `upload-pack` use to decide which3283 refs to omit from their initial advertisements. Use more than3284 one definition to specify multiple prefix strings. A ref that is3285 under the hierarchies listed in the value of this variable is3286 excluded, and is hidden when responding to `git push` or `git3287 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for3288 program-specific versions of this config.3289+3290You may also include a `!` in front of the ref name to negate the entry,3291explicitly exposing it, even if an earlier entry marked it as hidden.3292If you have multiple hideRefs values, later entries override earlier ones3293(and entries in more-specific config files override less-specific ones).3294+3295If a namespace is in use, the namespace prefix is stripped from each3296reference before it is matched against `transfer.hiderefs` patterns.3297For example, if `refs/heads/master` is specified in `transfer.hideRefs` and3298the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`3299is omitted from the advertisements but `refs/heads/master` and3300`refs/namespaces/bar/refs/heads/master` are still advertised as so-called3301"have" lines. In order to match refs before stripping, add a `^` in front of3302the ref name. If you combine `!` and `^`, `!` must be specified first.3303+3304Even if you hide refs, a client may still be able to steal the target3305objects via the techniques described in the "SECURITY" section of the3306linkgit:gitnamespaces[7] man page; it's best to keep private data in a3307separate repository.33083309transfer.unpackLimit::3310 When `fetch.unpackLimit` or `receive.unpackLimit` are3311 not set, the value of this variable is used instead.3312 The default value is 100.33133314uploadarchive.allowUnreachable::3315 If true, allow clients to use `git archive --remote` to request3316 any tree, whether reachable from the ref tips or not. See the3317 discussion in the "SECURITY" section of3318 linkgit:git-upload-archive[1] for more details. Defaults to3319 `false`.33203321uploadpack.hideRefs::3322 This variable is the same as `transfer.hideRefs`, but applies3323 only to `upload-pack` (and so affects only fetches, not pushes).3324 An attempt to fetch a hidden ref by `git fetch` will fail. See3325 also `uploadpack.allowTipSHA1InWant`.33263327uploadpack.allowTipSHA1InWant::3328 When `uploadpack.hideRefs` is in effect, allow `upload-pack`3329 to accept a fetch request that asks for an object at the tip3330 of a hidden ref (by default, such a request is rejected).3331 See also `uploadpack.hideRefs`. Even if this is false, a client3332 may be able to steal objects via the techniques described in the3333 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's3334 best to keep private data in a separate repository.33353336uploadpack.allowReachableSHA1InWant::3337 Allow `upload-pack` to accept a fetch request that asks for an3338 object that is reachable from any ref tip. However, note that3339 calculating object reachability is computationally expensive.3340 Defaults to `false`. Even if this is false, a client may be able3341 to steal objects via the techniques described in the "SECURITY"3342 section of the linkgit:gitnamespaces[7] man page; it's best to3343 keep private data in a separate repository.33443345uploadpack.allowAnySHA1InWant::3346 Allow `upload-pack` to accept a fetch request that asks for any3347 object at all.3348 Defaults to `false`.33493350uploadpack.keepAlive::3351 When `upload-pack` has started `pack-objects`, there may be a3352 quiet period while `pack-objects` prepares the pack. Normally3353 it would output progress information, but if `--quiet` was used3354 for the fetch, `pack-objects` will output nothing at all until3355 the pack data begins. Some clients and networks may consider3356 the server to be hung and give up. Setting this option instructs3357 `upload-pack` to send an empty keepalive packet every3358 `uploadpack.keepAlive` seconds. Setting this option to 03359 disables keepalive packets entirely. The default is 5 seconds.33603361uploadpack.packObjectsHook::3362 If this option is set, when `upload-pack` would run3363 `git pack-objects` to create a packfile for a client, it will3364 run this shell command instead. The `pack-objects` command and3365 arguments it _would_ have run (including the `git pack-objects`3366 at the beginning) are appended to the shell command. The stdin3367 and stdout of the hook are treated as if `pack-objects` itself3368 was run. I.e., `upload-pack` will feed input intended for3369 `pack-objects` to the hook, and expects a completed packfile on3370 stdout.33713372uploadpack.allowFilter::3373 If this option is set, `upload-pack` will support partial3374 clone and partial fetch object filtering.3375+3376Note that this configuration variable is ignored if it is seen in the3377repository-level config (this is a safety measure against fetching from3378untrusted repositories).33793380url.<base>.insteadOf::3381 Any URL that starts with this value will be rewritten to3382 start, instead, with <base>. In cases where some site serves a3383 large number of repositories, and serves them with multiple3384 access methods, and some users need to use different access3385 methods, this feature allows people to specify any of the3386 equivalent URLs and have Git automatically rewrite the URL to3387 the best alternative for the particular user, even for a3388 never-before-seen repository on the site. When more than one3389 insteadOf strings match a given URL, the longest match is used.3390+3391Note that any protocol restrictions will be applied to the rewritten3392URL. If the rewrite changes the URL to use a custom protocol or remote3393helper, you may need to adjust the `protocol.*.allow` config to permit3394the request. In particular, protocols you expect to use for submodules3395must be set to `always` rather than the default of `user`. See the3396description of `protocol.allow` above.33973398url.<base>.pushInsteadOf::3399 Any URL that starts with this value will not be pushed to;3400 instead, it will be rewritten to start with <base>, and the3401 resulting URL will be pushed to. In cases where some site serves3402 a large number of repositories, and serves them with multiple3403 access methods, some of which do not allow push, this feature3404 allows people to specify a pull-only URL and have Git3405 automatically use an appropriate URL to push, even for a3406 never-before-seen repository on the site. When more than one3407 pushInsteadOf strings match a given URL, the longest match is3408 used. If a remote has an explicit pushurl, Git will ignore this3409 setting for that remote.34103411user.email::3412 Your email address to be recorded in any newly created commits.3413 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and3414 `EMAIL` environment variables. See linkgit:git-commit-tree[1].34153416user.name::3417 Your full name to be recorded in any newly created commits.3418 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`3419 environment variables. See linkgit:git-commit-tree[1].34203421user.useConfigOnly::3422 Instruct Git to avoid trying to guess defaults for `user.email`3423 and `user.name`, and instead retrieve the values only from the3424 configuration. For example, if you have multiple email addresses3425 and would like to use a different one for each repository, then3426 with this configuration option set to `true` in the global config3427 along with a name, Git will prompt you to set up an email before3428 making new commits in a newly cloned repository.3429 Defaults to `false`.34303431user.signingKey::3432 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the3433 key you want it to automatically when creating a signed tag or3434 commit, you can override the default selection with this variable.3435 This option is passed unchanged to gpg's --local-user parameter,3436 so you may specify a key using any method that gpg supports.34373438versionsort.prereleaseSuffix (deprecated)::3439 Deprecated alias for `versionsort.suffix`. Ignored if3440 `versionsort.suffix` is set.34413442versionsort.suffix::3443 Even when version sort is used in linkgit:git-tag[1], tagnames3444 with the same base version but different suffixes are still sorted3445 lexicographically, resulting e.g. in prerelease tags appearing3446 after the main release (e.g. "1.0-rc1" after "1.0"). This3447 variable can be specified to determine the sorting order of tags3448 with different suffixes.3449+3450By specifying a single suffix in this variable, any tagname containing3451that suffix will appear before the corresponding main release. E.g. if3452the variable is set to "-rc", then all "1.0-rcX" tags will appear before3453"1.0". If specified multiple times, once per suffix, then the order of3454suffixes in the configuration will determine the sorting order of tagnames3455with those suffixes. E.g. if "-pre" appears before "-rc" in the3456configuration, then all "1.0-preX" tags will be listed before any3457"1.0-rcX" tags. The placement of the main release tag relative to tags3458with various suffixes can be determined by specifying the empty suffix3459among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and3460"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags3461are listed first, followed by "v4.8", then "v4.8-ckX" and finally3462"v4.8-bfsX".3463+3464If more than one suffixes match the same tagname, then that tagname will3465be sorted according to the suffix which starts at the earliest position in3466the tagname. If more than one different matching suffixes start at3467that earliest position, then that tagname will be sorted according to the3468longest of those suffixes.3469The sorting order between different suffixes is undefined if they are3470in multiple config files.34713472web.browser::3473 Specify a web browser that may be used by some commands.3474 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3475 may use it.34763477worktree.guessRemote::3478 With `add`, if no branch argument, and neither of `-b` nor3479 `-B` nor `--detach` are given, the command defaults to3480 creating a new branch from HEAD. If `worktree.guessRemote` is3481 set to true, `worktree add` tries to find a remote-tracking3482 branch whose name uniquely matches the new branch name. If3483 such a branch exists, it is checked out and set as "upstream"3484 for the new branch. If no such match can be found, it falls3485 back to creating a new branch from the current HEAD.