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 Internal variable which enables various workarounds to enable 394 Git to work better on filesystems that are not case sensitive, 395 like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing 396 finds "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+ 404Git relies on the proper configuration of this variable for your operating 405and file system. Modifying this value may result in unexpected behavior. 406 407core.precomposeUnicode:: 408 This option is only used by Mac OS implementation of Git. 409 When core.precomposeUnicode=true, Git reverts the unicode decomposition 410 of filenames done by Mac OS. This is useful when sharing a repository 411 between Mac OS and Linux or Windows. 412 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 413 When false, file names are handled fully transparent by Git, 414 which is backward compatible with older versions of Git. 415 416core.protectHFS:: 417 If set to true, do not allow checkout of paths that would 418 be considered equivalent to `.git` on an HFS+ filesystem. 419 Defaults to `true` on Mac OS, and `false` elsewhere. 420 421core.protectNTFS:: 422 If set to true, do not allow checkout of paths that would 423 cause problems with the NTFS filesystem, e.g. conflict with 424 8.3 "short" names. 425 Defaults to `true` on Windows, and `false` elsewhere. 426 427core.fsmonitor:: 428 If set, the value of this variable is used as a command which 429 will identify all files that may have changed since the 430 requested date/time. This information is used to speed up git by 431 avoiding unnecessary processing of files that have not changed. 432 See the "fsmonitor-watchman" section of linkgit:githooks[5]. 433 434core.trustctime:: 435 If false, the ctime differences between the index and the 436 working tree are ignored; useful when the inode change time 437 is regularly modified by something outside Git (file system 438 crawlers and some backup systems). 439 See linkgit:git-update-index[1]. True by default. 440 441core.splitIndex:: 442 If true, the split-index feature of the index will be used. 443 See linkgit:git-update-index[1]. False by default. 444 445core.untrackedCache:: 446 Determines what to do about the untracked cache feature of the 447 index. It will be kept, if this variable is unset or set to 448 `keep`. It will automatically be added if set to `true`. And 449 it will automatically be removed, if set to `false`. Before 450 setting it to `true`, you should check that mtime is working 451 properly on your system. 452 See linkgit:git-update-index[1]. `keep` by default. 453 454core.checkStat:: 455 Determines which stat fields to match between the index 456 and work tree. The user can set this to 'default' or 457 'minimal'. Default (or explicitly 'default'), is to check 458 all fields, including the sub-second part of mtime and ctime. 459 460core.quotePath:: 461 Commands that output paths (e.g. 'ls-files', 'diff'), will 462 quote "unusual" characters in the pathname by enclosing the 463 pathname in double-quotes and escaping those characters with 464 backslashes in the same way C escapes control characters (e.g. 465 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with 466 values larger than 0x80 (e.g. octal `\302\265` for "micro" in 467 UTF-8). If this variable is set to false, bytes higher than 468 0x80 are not considered "unusual" any more. Double-quotes, 469 backslash and control characters are always escaped regardless 470 of the setting of this variable. A simple space character is 471 not considered "unusual". Many commands can output pathnames 472 completely verbatim using the `-z` option. The default value 473 is true. 474 475core.eol:: 476 Sets the line ending type to use in the working directory for 477 files that have the `text` property set when core.autocrlf is false. 478 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's 479 native line ending. The default value is `native`. See 480 linkgit:gitattributes[5] for more information on end-of-line 481 conversion. 482 483core.safecrlf:: 484 If true, makes Git check if converting `CRLF` is reversible when 485 end-of-line conversion is active. Git will verify if a command 486 modifies a file in the work tree either directly or indirectly. 487 For example, committing a file followed by checking out the 488 same file should yield the original file in the work tree. If 489 this is not the case for the current setting of 490 `core.autocrlf`, Git will reject the file. The variable can 491 be set to "warn", in which case Git will only warn about an 492 irreversible conversion but continue the operation. 493+ 494CRLF conversion bears a slight chance of corrupting data. 495When it is enabled, Git will convert CRLF to LF during commit and LF to 496CRLF during checkout. A file that contains a mixture of LF and 497CRLF before the commit cannot be recreated by Git. For text 498files this is the right thing to do: it corrects line endings 499such that we have only LF line endings in the repository. 500But for binary files that are accidentally classified as text the 501conversion can corrupt data. 502+ 503If you recognize such corruption early you can easily fix it by 504setting the conversion type explicitly in .gitattributes. Right 505after committing you still have the original file in your work 506tree and this file is not yet corrupted. You can explicitly tell 507Git that this file is binary and Git will handle the file 508appropriately. 509+ 510Unfortunately, the desired effect of cleaning up text files with 511mixed line endings and the undesired effect of corrupting binary 512files cannot be distinguished. In both cases CRLFs are removed 513in an irreversible way. For text files this is the right thing 514to do because CRLFs are line endings, while for binary files 515converting CRLFs corrupts data. 516+ 517Note, this safety check does not mean that a checkout will generate a 518file identical to the original file for a different setting of 519`core.eol` and `core.autocrlf`, but only for the current one. For 520example, a text file with `LF` would be accepted with `core.eol=lf` 521and could later be checked out with `core.eol=crlf`, in which case the 522resulting file would contain `CRLF`, although the original file 523contained `LF`. However, in both work trees the line endings would be 524consistent, that is either all `LF` or all `CRLF`, but never mixed. A 525file with mixed line endings would be reported by the `core.safecrlf` 526mechanism. 527 528core.autocrlf:: 529 Setting this variable to "true" is the same as setting 530 the `text` attribute to "auto" on all files and core.eol to "crlf". 531 Set to true if you want to have `CRLF` line endings in your 532 working directory and the repository has LF line endings. 533 This variable can be set to 'input', 534 in which case no output conversion is performed. 535 536core.symlinks:: 537 If false, symbolic links are checked out as small plain files that 538 contain the link text. linkgit:git-update-index[1] and 539 linkgit:git-add[1] will not change the recorded type to regular 540 file. Useful on filesystems like FAT that do not support 541 symbolic links. 542+ 543The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 544will probe and set core.symlinks false if appropriate when the repository 545is created. 546 547core.gitProxy:: 548 A "proxy command" to execute (as 'command host port') instead 549 of establishing direct connection to the remote server when 550 using the Git protocol for fetching. If the variable value is 551 in the "COMMAND for DOMAIN" format, the command is applied only 552 on hostnames ending with the specified domain string. This variable 553 may be set multiple times and is matched in the given order; 554 the first match wins. 555+ 556Can be overridden by the `GIT_PROXY_COMMAND` environment variable 557(which always applies universally, without the special "for" 558handling). 559+ 560The special string `none` can be used as the proxy command to 561specify that no proxy be used for a given domain pattern. 562This is useful for excluding servers inside a firewall from 563proxy use, while defaulting to a common proxy for external domains. 564 565core.sshCommand:: 566 If this variable is set, `git fetch` and `git push` will 567 use the specified command instead of `ssh` when they need to 568 connect to a remote system. The command is in the same form as 569 the `GIT_SSH_COMMAND` environment variable and is overridden 570 when the environment variable is set. 571 572core.ignoreStat:: 573 If true, Git will avoid using lstat() calls to detect if files have 574 changed by setting the "assume-unchanged" bit for those tracked files 575 which it has updated identically in both the index and working tree. 576+ 577When files are modified outside of Git, the user will need to stage 578the modified files explicitly (e.g. see 'Examples' section in 579linkgit:git-update-index[1]). 580Git will not normally detect changes to those files. 581+ 582This is useful on systems where lstat() calls are very slow, such as 583CIFS/Microsoft Windows. 584+ 585False by default. 586 587core.preferSymlinkRefs:: 588 Instead of the default "symref" format for HEAD 589 and other symbolic reference files, use symbolic links. 590 This is sometimes needed to work with old scripts that 591 expect HEAD to be a symbolic link. 592 593core.bare:: 594 If true this repository is assumed to be 'bare' and has no 595 working directory associated with it. If this is the case a 596 number of commands that require a working directory will be 597 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 598+ 599This setting is automatically guessed by linkgit:git-clone[1] or 600linkgit:git-init[1] when the repository was created. By default a 601repository that ends in "/.git" is assumed to be not bare (bare = 602false), while all other repositories are assumed to be bare (bare 603= true). 604 605core.worktree:: 606 Set the path to the root of the working tree. 607 If `GIT_COMMON_DIR` environment variable is set, core.worktree 608 is ignored and not used for determining the root of working tree. 609 This can be overridden by the `GIT_WORK_TREE` environment 610 variable and the `--work-tree` command-line option. 611 The value can be an absolute path or relative to the path to 612 the .git directory, which is either specified by --git-dir 613 or GIT_DIR, or automatically discovered. 614 If --git-dir or GIT_DIR is specified but none of 615 --work-tree, GIT_WORK_TREE and core.worktree is specified, 616 the current working directory is regarded as the top level 617 of your working tree. 618+ 619Note that this variable is honored even when set in a configuration 620file in a ".git" subdirectory of a directory and its value differs 621from the latter directory (e.g. "/path/to/.git/config" has 622core.worktree set to "/different/path"), which is most likely a 623misconfiguration. Running Git commands in the "/path/to" directory will 624still use "/different/path" as the root of the work tree and can cause 625confusion unless you know what you are doing (e.g. you are creating a 626read-only snapshot of the same index to a location different from the 627repository's usual working tree). 628 629core.logAllRefUpdates:: 630 Enable the reflog. Updates to a ref <ref> is logged to the file 631 "`$GIT_DIR/logs/<ref>`", by appending the new and old 632 SHA-1, the date/time and the reason of the update, but 633 only when the file exists. If this configuration 634 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`" 635 file is automatically created for branch heads (i.e. under 636 `refs/heads/`), remote refs (i.e. under `refs/remotes/`), 637 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`. 638 If it is set to `always`, then a missing reflog is automatically 639 created for any ref under `refs/`. 640+ 641This information can be used to determine what commit 642was the tip of a branch "2 days ago". 643+ 644This value is true by default in a repository that has 645a working directory associated with it, and false by 646default in a bare repository. 647 648core.repositoryFormatVersion:: 649 Internal variable identifying the repository format and layout 650 version. 651 652core.sharedRepository:: 653 When 'group' (or 'true'), the repository is made shareable between 654 several users in a group (making sure all the files and objects are 655 group-writable). When 'all' (or 'world' or 'everybody'), the 656 repository will be readable by all users, additionally to being 657 group-shareable. When 'umask' (or 'false'), Git will use permissions 658 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 659 files in the repository will have this mode value. '0xxx' will override 660 user's umask value (whereas the other options will only override 661 requested parts of the user's umask value). Examples: '0660' will make 662 the repo read/write-able for the owner and group, but inaccessible to 663 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 664 repository that is group-readable but not group-writable. 665 See linkgit:git-init[1]. False by default. 666 667core.warnAmbiguousRefs:: 668 If true, Git will warn you if the ref name you passed it is ambiguous 669 and might match multiple refs in the repository. True by default. 670 671core.compression:: 672 An integer -1..9, indicating a default compression level. 673 -1 is the zlib default. 0 means no compression, 674 and 1..9 are various speed/size tradeoffs, 9 being slowest. 675 If set, this provides a default to other compression variables, 676 such as `core.looseCompression` and `pack.compression`. 677 678core.looseCompression:: 679 An integer -1..9, indicating the compression level for objects that 680 are not in a pack file. -1 is the zlib default. 0 means no 681 compression, and 1..9 are various speed/size tradeoffs, 9 being 682 slowest. If not set, defaults to core.compression. If that is 683 not set, defaults to 1 (best speed). 684 685core.packedGitWindowSize:: 686 Number of bytes of a pack file to map into memory in a 687 single mapping operation. Larger window sizes may allow 688 your system to process a smaller number of large pack files 689 more quickly. Smaller window sizes will negatively affect 690 performance due to increased calls to the operating system's 691 memory manager, but may improve performance when accessing 692 a large number of large pack files. 693+ 694Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 695MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 696be reasonable for all users/operating systems. You probably do 697not need to adjust this value. 698+ 699Common unit suffixes of 'k', 'm', or 'g' are supported. 700 701core.packedGitLimit:: 702 Maximum number of bytes to map simultaneously into memory 703 from pack files. If Git needs to access more than this many 704 bytes at once to complete an operation it will unmap existing 705 regions to reclaim virtual address space within the process. 706+ 707Default is 256 MiB on 32 bit platforms and 32 TiB (effectively 708unlimited) on 64 bit platforms. 709This should be reasonable for all users/operating systems, except on 710the largest projects. You probably do not need to adjust this value. 711+ 712Common unit suffixes of 'k', 'm', or 'g' are supported. 713 714core.deltaBaseCacheLimit:: 715 Maximum number of bytes to reserve for caching base objects 716 that may be referenced by multiple deltified objects. By storing the 717 entire decompressed base objects in a cache Git is able 718 to avoid unpacking and decompressing frequently used base 719 objects multiple times. 720+ 721Default is 96 MiB on all platforms. This should be reasonable 722for all users/operating systems, except on the largest projects. 723You probably do not need to adjust this value. 724+ 725Common unit suffixes of 'k', 'm', or 'g' are supported. 726 727core.bigFileThreshold:: 728 Files larger than this size are stored deflated, without 729 attempting delta compression. Storing large files without 730 delta compression avoids excessive memory usage, at the 731 slight expense of increased disk usage. Additionally files 732 larger than this size are always treated as binary. 733+ 734Default is 512 MiB on all platforms. This should be reasonable 735for most projects as source code and other text files can still 736be delta compressed, but larger binary media files won't be. 737+ 738Common unit suffixes of 'k', 'm', or 'g' are supported. 739 740core.excludesFile:: 741 Specifies the pathname to the file that contains patterns to 742 describe paths that are not meant to be tracked, in addition 743 to '.gitignore' (per-directory) and '.git/info/exclude'. 744 Defaults to `$XDG_CONFIG_HOME/git/ignore`. 745 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` 746 is used instead. See linkgit:gitignore[5]. 747 748core.askPass:: 749 Some commands (e.g. svn and http interfaces) that interactively 750 ask for a password can be told to use an external program given 751 via the value of this variable. Can be overridden by the `GIT_ASKPASS` 752 environment variable. If not set, fall back to the value of the 753 `SSH_ASKPASS` environment variable or, failing that, a simple password 754 prompt. The external program shall be given a suitable prompt as 755 command-line argument and write the password on its STDOUT. 756 757core.attributesFile:: 758 In addition to '.gitattributes' (per-directory) and 759 '.git/info/attributes', Git looks into this file for attributes 760 (see linkgit:gitattributes[5]). Path expansions are made the same 761 way as for `core.excludesFile`. Its default value is 762 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not 763 set or empty, `$HOME/.config/git/attributes` is used instead. 764 765core.hooksPath:: 766 By default Git will look for your hooks in the 767 '$GIT_DIR/hooks' directory. Set this to different path, 768 e.g. '/etc/git/hooks', and Git will try to find your hooks in 769 that directory, e.g. '/etc/git/hooks/pre-receive' instead of 770 in '$GIT_DIR/hooks/pre-receive'. 771+ 772The path can be either absolute or relative. A relative path is 773taken as relative to the directory where the hooks are run (see 774the "DESCRIPTION" section of linkgit:githooks[5]). 775+ 776This configuration variable is useful in cases where you'd like to 777centrally configure your Git hooks instead of configuring them on a 778per-repository basis, or as a more flexible and centralized 779alternative to having an `init.templateDir` where you've changed 780default hooks. 781 782core.editor:: 783 Commands such as `commit` and `tag` that let you edit 784 messages by launching an editor use the value of this 785 variable when it is set, and the environment variable 786 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 787 788core.commentChar:: 789 Commands such as `commit` and `tag` that let you edit 790 messages consider a line that begins with this character 791 commented, and removes them after the editor returns 792 (default '#'). 793+ 794If set to "auto", `git-commit` would select a character that is not 795the beginning character of any line in existing commit messages. 796 797core.filesRefLockTimeout:: 798 The length of time, in milliseconds, to retry when trying to 799 lock an individual reference. Value 0 means not to retry at 800 all; -1 means to try indefinitely. Default is 100 (i.e., 801 retry for 100ms). 802 803core.packedRefsTimeout:: 804 The length of time, in milliseconds, to retry when trying to 805 lock the `packed-refs` file. Value 0 means not to retry at 806 all; -1 means to try indefinitely. Default is 1000 (i.e., 807 retry for 1 second). 808 809sequence.editor:: 810 Text editor used by `git rebase -i` for editing the rebase instruction file. 811 The value is meant to be interpreted by the shell when it is used. 812 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 813 When not configured the default commit message editor is used instead. 814 815core.pager:: 816 Text viewer for use by Git commands (e.g., 'less'). The value 817 is meant to be interpreted by the shell. The order of preference 818 is the `$GIT_PAGER` environment variable, then `core.pager` 819 configuration, then `$PAGER`, and then the default chosen at 820 compile time (usually 'less'). 821+ 822When the `LESS` environment variable is unset, Git sets it to `FRX` 823(if `LESS` environment variable is set, Git does not change it at 824all). If you want to selectively override Git's default setting 825for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 826be passed to the shell by Git, which will translate the final 827command to `LESS=FRX less -S`. The environment does not set the 828`S` option but the command line does, instructing less to truncate 829long lines. Similarly, setting `core.pager` to `less -+F` will 830deactivate the `F` option specified by the environment from the 831command-line, deactivating the "quit if one screen" behavior of 832`less`. One can specifically activate some flags for particular 833commands: for example, setting `pager.blame` to `less -S` enables 834line truncation only for `git blame`. 835+ 836Likewise, when the `LV` environment variable is unset, Git sets it 837to `-c`. You can override this setting by exporting `LV` with 838another value or setting `core.pager` to `lv +c`. 839 840core.whitespace:: 841 A comma separated list of common whitespace problems to 842 notice. 'git diff' will use `color.diff.whitespace` to 843 highlight them, and 'git apply --whitespace=error' will 844 consider them as errors. You can prefix `-` to disable 845 any of them (e.g. `-trailing-space`): 846+ 847* `blank-at-eol` treats trailing whitespaces at the end of the line 848 as an error (enabled by default). 849* `space-before-tab` treats a space character that appears immediately 850 before a tab character in the initial indent part of the line as an 851 error (enabled by default). 852* `indent-with-non-tab` treats a line that is indented with space 853 characters instead of the equivalent tabs as an error (not enabled by 854 default). 855* `tab-in-indent` treats a tab character in the initial indent part of 856 the line as an error (not enabled by default). 857* `blank-at-eof` treats blank lines added at the end of file as an error 858 (enabled by default). 859* `trailing-space` is a short-hand to cover both `blank-at-eol` and 860 `blank-at-eof`. 861* `cr-at-eol` treats a carriage-return at the end of line as 862 part of the line terminator, i.e. with it, `trailing-space` 863 does not trigger if the character before such a carriage-return 864 is not a whitespace (not enabled by default). 865* `tabwidth=<n>` tells how many character positions a tab occupies; this 866 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 867 errors. The default tab width is 8. Allowed values are 1 to 63. 868 869core.fsyncObjectFiles:: 870 This boolean will enable 'fsync()' when writing object files. 871+ 872This is a total waste of time and effort on a filesystem that orders 873data writes properly, but can be useful for filesystems that do not use 874journalling (traditional UNIX filesystems) or that only journal metadata 875and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 876 877core.preloadIndex:: 878 Enable parallel index preload for operations like 'git diff' 879+ 880This can speed up operations like 'git diff' and 'git status' especially 881on filesystems like NFS that have weak caching semantics and thus 882relatively high IO latencies. When enabled, Git will do the 883index comparison to the filesystem data in parallel, allowing 884overlapping IO's. Defaults to true. 885 886core.createObject:: 887 You can set this to 'link', in which case a hardlink followed by 888 a delete of the source are used to make sure that object creation 889 will not overwrite existing objects. 890+ 891On some file system/operating system combinations, this is unreliable. 892Set this config setting to 'rename' there; However, This will remove the 893check that makes sure that existing object files will not get overwritten. 894 895core.notesRef:: 896 When showing commit messages, also show notes which are stored in 897 the given ref. The ref must be fully qualified. If the given 898 ref does not exist, it is not an error but means that no 899 notes should be printed. 900+ 901This setting defaults to "refs/notes/commits", and it can be overridden by 902the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. 903 904core.sparseCheckout:: 905 Enable "sparse checkout" feature. See section "Sparse checkout" in 906 linkgit:git-read-tree[1] for more information. 907 908core.abbrev:: 909 Set the length object names are abbreviated to. If 910 unspecified or set to "auto", an appropriate value is 911 computed based on the approximate number of packed objects 912 in your repository, which hopefully is enough for 913 abbreviated object names to stay unique for some time. 914 The minimum length is 4. 915 916add.ignoreErrors:: 917add.ignore-errors (deprecated):: 918 Tells 'git add' to continue adding files when some files cannot be 919 added due to indexing errors. Equivalent to the `--ignore-errors` 920 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 921 as it does not follow the usual naming convention for configuration 922 variables. 923 924alias.*:: 925 Command aliases for the linkgit:git[1] command wrapper - e.g. 926 after defining "alias.last = cat-file commit HEAD", the invocation 927 "git last" is equivalent to "git cat-file commit HEAD". To avoid 928 confusion and troubles with script usage, aliases that 929 hide existing Git commands are ignored. Arguments are split by 930 spaces, the usual shell quoting and escaping is supported. 931 A quote pair or a backslash can be used to quote them. 932+ 933If the alias expansion is prefixed with an exclamation point, 934it will be treated as a shell command. For example, defining 935"alias.new = !gitk --all --not ORIG_HEAD", the invocation 936"git new" is equivalent to running the shell command 937"gitk --all --not ORIG_HEAD". Note that shell commands will be 938executed from the top-level directory of a repository, which may 939not necessarily be the current directory. 940`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix' 941from the original current directory. See linkgit:git-rev-parse[1]. 942 943am.keepcr:: 944 If true, git-am will call git-mailsplit for patches in mbox format 945 with parameter `--keep-cr`. In this case git-mailsplit will 946 not remove `\r` from lines ending with `\r\n`. Can be overridden 947 by giving `--no-keep-cr` from the command line. 948 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 949 950am.threeWay:: 951 By default, `git am` will fail if the patch does not apply cleanly. When 952 set to true, this setting tells `git am` to fall back on 3-way merge if 953 the patch records the identity of blobs it is supposed to apply to and 954 we have those blobs available locally (equivalent to giving the `--3way` 955 option from the command line). Defaults to `false`. 956 See linkgit:git-am[1]. 957 958apply.ignoreWhitespace:: 959 When set to 'change', tells 'git apply' to ignore changes in 960 whitespace, in the same way as the `--ignore-space-change` 961 option. 962 When set to one of: no, none, never, false tells 'git apply' to 963 respect all whitespace differences. 964 See linkgit:git-apply[1]. 965 966apply.whitespace:: 967 Tells 'git apply' how to handle whitespaces, in the same way 968 as the `--whitespace` option. See linkgit:git-apply[1]. 969 970blame.showRoot:: 971 Do not treat root commits as boundaries in linkgit:git-blame[1]. 972 This option defaults to false. 973 974blame.blankBoundary:: 975 Show blank commit object name for boundary commits in 976 linkgit:git-blame[1]. This option defaults to false. 977 978blame.showEmail:: 979 Show the author email instead of author name in linkgit:git-blame[1]. 980 This option defaults to false. 981 982blame.date:: 983 Specifies the format used to output dates in linkgit:git-blame[1]. 984 If unset the iso format is used. For supported values, 985 see the discussion of the `--date` option at linkgit:git-log[1]. 986 987branch.autoSetupMerge:: 988 Tells 'git branch' and 'git checkout' to set up new branches 989 so that linkgit:git-pull[1] will appropriately merge from the 990 starting point branch. Note that even if this option is not set, 991 this behavior can be chosen per-branch using the `--track` 992 and `--no-track` options. The valid settings are: `false` -- no 993 automatic setup is done; `true` -- automatic setup is done when the 994 starting point is a remote-tracking branch; `always` -- 995 automatic setup is done when the starting point is either a 996 local branch or remote-tracking 997 branch. This option defaults to true. 998 999branch.autoSetupRebase::1000 When a new branch is created with 'git branch' or 'git checkout'1001 that tracks another branch, this variable tells Git to set1002 up pull to rebase instead of merge (see "branch.<name>.rebase").1003 When `never`, rebase is never automatically set to true.1004 When `local`, rebase is set to true for tracked branches of1005 other local branches.1006 When `remote`, rebase is set to true for tracked branches of1007 remote-tracking branches.1008 When `always`, rebase will be set to true for all tracking1009 branches.1010 See "branch.autoSetupMerge" for details on how to set up a1011 branch to track another branch.1012 This option defaults to never.10131014branch.<name>.remote::1015 When on branch <name>, it tells 'git fetch' and 'git push'1016 which remote to fetch from/push to. The remote to push to1017 may be overridden with `remote.pushDefault` (for all branches).1018 The remote to push to, for the current branch, may be further1019 overridden by `branch.<name>.pushRemote`. If no remote is1020 configured, or if you are not on any branch, it defaults to1021 `origin` for fetching and `remote.pushDefault` for pushing.1022 Additionally, `.` (a period) is the current local repository1023 (a dot-repository), see `branch.<name>.merge`'s final note below.10241025branch.<name>.pushRemote::1026 When on branch <name>, it overrides `branch.<name>.remote` for1027 pushing. It also overrides `remote.pushDefault` for pushing1028 from branch <name>. When you pull from one place (e.g. your1029 upstream) and push to another place (e.g. your own publishing1030 repository), you would want to set `remote.pushDefault` to1031 specify the remote to push to for all branches, and use this1032 option to override it for a specific branch.10331034branch.<name>.merge::1035 Defines, together with branch.<name>.remote, the upstream branch1036 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which1037 branch to merge and can also affect 'git push' (see push.default).1038 When in branch <name>, it tells 'git fetch' the default1039 refspec to be marked for merging in FETCH_HEAD. The value is1040 handled like the remote part of a refspec, and must match a1041 ref which is fetched from the remote given by1042 "branch.<name>.remote".1043 The merge information is used by 'git pull' (which at first calls1044 'git fetch') to lookup the default branch for merging. Without1045 this option, 'git pull' defaults to merge the first refspec fetched.1046 Specify multiple values to get an octopus merge.1047 If you wish to setup 'git pull' so that it merges into <name> from1048 another branch in the local repository, you can point1049 branch.<name>.merge to the desired branch, and use the relative path1050 setting `.` (a period) for branch.<name>.remote.10511052branch.<name>.mergeOptions::1053 Sets default options for merging into branch <name>. The syntax and1054 supported options are the same as those of linkgit:git-merge[1], but1055 option values containing whitespace characters are currently not1056 supported.10571058branch.<name>.rebase::1059 When true, rebase the branch <name> on top of the fetched branch,1060 instead of merging the default branch from the default remote when1061 "git pull" is run. See "pull.rebase" for doing this in a non1062 branch-specific manner.1063+1064When preserve, also pass `--preserve-merges` along to 'git rebase'1065so that locally committed merge commits will not be flattened1066by running 'git pull'.1067+1068When the value is `interactive`, the rebase is run in interactive mode.1069+1070*NOTE*: this is a possibly dangerous operation; do *not* use1071it unless you understand the implications (see linkgit:git-rebase[1]1072for details).10731074branch.<name>.description::1075 Branch description, can be edited with1076 `git branch --edit-description`. Branch description is1077 automatically added in the format-patch cover letter or1078 request-pull summary.10791080browser.<tool>.cmd::1081 Specify the command to invoke the specified browser. The1082 specified command is evaluated in shell with the URLs passed1083 as arguments. (See linkgit:git-web{litdd}browse[1].)10841085browser.<tool>.path::1086 Override the path for the given tool that may be used to1087 browse HTML help (see `-w` option in linkgit:git-help[1]) or a1088 working repository in gitweb (see linkgit:git-instaweb[1]).10891090clean.requireForce::1091 A boolean to make git-clean do nothing unless given -f,1092 -i or -n. Defaults to true.10931094color.branch::1095 A boolean to enable/disable color in the output of1096 linkgit:git-branch[1]. May be set to `always`,1097 `false` (or `never`) or `auto` (or `true`), in which case colors are used1098 only when the output is to a terminal. If unset, then the1099 value of `color.ui` is used (`auto` by default).11001101color.branch.<slot>::1102 Use customized color for branch coloration. `<slot>` is one of1103 `current` (the current branch), `local` (a local branch),1104 `remote` (a remote-tracking branch in refs/remotes/),1105 `upstream` (upstream tracking branch), `plain` (other1106 refs).11071108color.diff::1109 Whether to use ANSI escape sequences to add color to patches.1110 If this is set to `always`, linkgit:git-diff[1],1111 linkgit:git-log[1], and linkgit:git-show[1] will use color1112 for all patches. If it is set to `true` or `auto`, those1113 commands will only use color when output is to the terminal.1114 If unset, then the value of `color.ui` is used (`auto` by1115 default).1116+1117This does not affect linkgit:git-format-patch[1] or the1118'git-diff-{asterisk}' plumbing commands. Can be overridden on the1119command line with the `--color[=<when>]` option.11201121diff.colorMoved::1122 If set to either a valid `<mode>` or a true value, moved lines1123 in a diff are colored differently, for details of valid modes1124 see '--color-moved' in linkgit:git-diff[1]. If simply set to1125 true the default color mode will be used. When set to false,1126 moved lines are not colored.11271128color.diff.<slot>::1129 Use customized color for diff colorization. `<slot>` specifies1130 which part of the patch to use the specified color, and is one1131 of `context` (context text - `plain` is a historical synonym),1132 `meta` (metainformation), `frag`1133 (hunk header), 'func' (function in hunk header), `old` (removed lines),1134 `new` (added lines), `commit` (commit headers), `whitespace`1135 (highlighting whitespace errors), `oldMoved` (deleted lines),1136 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,1137 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`1138 and `newMovedAlternativeDimmed` (See the '<mode>'1139 setting of '--color-moved' in linkgit:git-diff[1] for details).11401141color.decorate.<slot>::1142 Use customized color for 'git log --decorate' output. `<slot>` is one1143 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local1144 branches, remote-tracking branches, tags, stash and HEAD, respectively.11451146color.grep::1147 When set to `always`, always highlight matches. When `false` (or1148 `never`), never. When set to `true` or `auto`, use color only1149 when the output is written to the terminal. If unset, then the1150 value of `color.ui` is used (`auto` by default).11511152color.grep.<slot>::1153 Use customized color for grep colorization. `<slot>` specifies which1154 part of the line to use the specified color, and is one of1155+1156--1157`context`;;1158 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1159`filename`;;1160 filename prefix (when not using `-h`)1161`function`;;1162 function name lines (when using `-p`)1163`linenumber`;;1164 line number prefix (when using `-n`)1165`match`;;1166 matching text (same as setting `matchContext` and `matchSelected`)1167`matchContext`;;1168 matching text in context lines1169`matchSelected`;;1170 matching text in selected lines1171`selected`;;1172 non-matching text in selected lines1173`separator`;;1174 separators between fields on a line (`:`, `-`, and `=`)1175 and between hunks (`--`)1176--11771178color.interactive::1179 When set to `always`, always use colors for interactive prompts1180 and displays (such as those used by "git-add --interactive" and1181 "git-clean --interactive"). When false (or `never`), never.1182 When set to `true` or `auto`, use colors only when the output is1183 to the terminal. If unset, then the value of `color.ui` is1184 used (`auto` by default).11851186color.interactive.<slot>::1187 Use customized color for 'git add --interactive' and 'git clean1188 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1189 or `error`, for four distinct types of normal output from1190 interactive commands.11911192color.pager::1193 A boolean to enable/disable colored output when the pager is in1194 use (default is true).11951196color.showBranch::1197 A boolean to enable/disable color in the output of1198 linkgit:git-show-branch[1]. May be set to `always`,1199 `false` (or `never`) or `auto` (or `true`), in which case colors are used1200 only when the output is to a terminal. If unset, then the1201 value of `color.ui` is used (`auto` by default).12021203color.status::1204 A boolean to enable/disable color in the output of1205 linkgit:git-status[1]. May be set to `always`,1206 `false` (or `never`) or `auto` (or `true`), in which case colors are used1207 only when the output is to a terminal. If unset, then the1208 value of `color.ui` is used (`auto` by default).12091210color.status.<slot>::1211 Use customized color for status colorization. `<slot>` is1212 one of `header` (the header text of the status message),1213 `added` or `updated` (files which are added but not committed),1214 `changed` (files which are changed but not added in the index),1215 `untracked` (files which are not tracked by Git),1216 `branch` (the current branch),1217 `nobranch` (the color the 'no branch' warning is shown in, defaulting1218 to red),1219 `localBranch` or `remoteBranch` (the local and remote branch names,1220 respectively, when branch and tracking information is displayed in the1221 status short-format), or1222 `unmerged` (files which have unmerged changes).12231224color.ui::1225 This variable determines the default value for variables such1226 as `color.diff` and `color.grep` that control the use of color1227 per command family. Its scope will expand as more commands learn1228 configuration to set a default for the `--color` option. Set it1229 to `false` or `never` if you prefer Git commands not to use1230 color unless enabled explicitly with some other configuration1231 or the `--color` option. Set it to `always` if you want all1232 output not intended for machine consumption to use color, to1233 `true` or `auto` (this is the default since Git 1.8.4) if you1234 want such output to use color when written to the terminal.12351236column.ui::1237 Specify whether supported commands should output in columns.1238 This variable consists of a list of tokens separated by spaces1239 or commas:1240+1241These options control when the feature should be enabled1242(defaults to 'never'):1243+1244--1245`always`;;1246 always show in columns1247`never`;;1248 never show in columns1249`auto`;;1250 show in columns if the output is to the terminal1251--1252+1253These options control layout (defaults to 'column'). Setting any1254of these implies 'always' if none of 'always', 'never', or 'auto' are1255specified.1256+1257--1258`column`;;1259 fill columns before rows1260`row`;;1261 fill rows before columns1262`plain`;;1263 show in one column1264--1265+1266Finally, these options can be combined with a layout option (defaults1267to 'nodense'):1268+1269--1270`dense`;;1271 make unequal size columns to utilize more space1272`nodense`;;1273 make equal size columns1274--12751276column.branch::1277 Specify whether to output branch listing in `git branch` in columns.1278 See `column.ui` for details.12791280column.clean::1281 Specify the layout when list items in `git clean -i`, which always1282 shows files and directories in columns. See `column.ui` for details.12831284column.status::1285 Specify whether to output untracked files in `git status` in columns.1286 See `column.ui` for details.12871288column.tag::1289 Specify whether to output tag listing in `git tag` in columns.1290 See `column.ui` for details.12911292commit.cleanup::1293 This setting overrides the default of the `--cleanup` option in1294 `git commit`. See linkgit:git-commit[1] for details. Changing the1295 default can be useful when you always want to keep lines that begin1296 with comment character `#` in your log message, in which case you1297 would do `git config commit.cleanup whitespace` (note that you will1298 have to remove the help lines that begin with `#` in the commit log1299 template yourself, if you do this).13001301commit.gpgSign::13021303 A boolean to specify whether all commits should be GPG signed.1304 Use of this option when doing operations such as rebase can1305 result in a large number of commits being signed. It may be1306 convenient to use an agent to avoid typing your GPG passphrase1307 several times.13081309commit.status::1310 A boolean to enable/disable inclusion of status information in the1311 commit message template when using an editor to prepare the commit1312 message. Defaults to true.13131314commit.template::1315 Specify the pathname of a file to use as the template for1316 new commit messages.13171318commit.verbose::1319 A boolean or int to specify the level of verbose with `git commit`.1320 See linkgit:git-commit[1].13211322credential.helper::1323 Specify an external helper to be called when a username or1324 password credential is needed; the helper may consult external1325 storage to avoid prompting the user for the credentials. Note1326 that multiple helpers may be defined. See linkgit:gitcredentials[7]1327 for details.13281329credential.useHttpPath::1330 When acquiring credentials, consider the "path" component of an http1331 or https URL to be important. Defaults to false. See1332 linkgit:gitcredentials[7] for more information.13331334credential.username::1335 If no username is set for a network authentication, use this username1336 by default. See credential.<context>.* below, and1337 linkgit:gitcredentials[7].13381339credential.<url>.*::1340 Any of the credential.* options above can be applied selectively to1341 some credentials. For example "credential.https://example.com.username"1342 would set the default username only for https connections to1343 example.com. See linkgit:gitcredentials[7] for details on how URLs are1344 matched.13451346credentialCache.ignoreSIGHUP::1347 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.13481349include::diff-config.txt[]13501351difftool.<tool>.path::1352 Override the path for the given tool. This is useful in case1353 your tool is not in the PATH.13541355difftool.<tool>.cmd::1356 Specify the command to invoke the specified diff tool.1357 The specified command is evaluated in shell with the following1358 variables available: 'LOCAL' is set to the name of the temporary1359 file containing the contents of the diff pre-image and 'REMOTE'1360 is set to the name of the temporary file containing the contents1361 of the diff post-image.13621363difftool.prompt::1364 Prompt before each invocation of the diff tool.13651366fastimport.unpackLimit::1367 If the number of objects imported by linkgit:git-fast-import[1]1368 is below this limit, then the objects will be unpacked into1369 loose object files. However if the number of imported objects1370 equals or exceeds this limit then the pack will be stored as a1371 pack. Storing the pack from a fast-import can make the import1372 operation complete faster, especially on slow filesystems. If1373 not set, the value of `transfer.unpackLimit` is used instead.13741375fetch.recurseSubmodules::1376 This option can be either set to a boolean value or to 'on-demand'.1377 Setting it to a boolean changes the behavior of fetch and pull to1378 unconditionally recurse into submodules when set to true or to not1379 recurse at all when set to false. When set to 'on-demand' (the default1380 value), fetch and pull will only recurse into a populated submodule1381 when its superproject retrieves a commit that updates the submodule's1382 reference.13831384fetch.fsckObjects::1385 If it is set to true, git-fetch-pack will check all fetched1386 objects. It will abort in the case of a malformed object or a1387 broken link. The result of an abort are only dangling objects.1388 Defaults to false. If not set, the value of `transfer.fsckObjects`1389 is used instead.13901391fetch.unpackLimit::1392 If the number of objects fetched over the Git native1393 transfer is below this1394 limit, then the objects will be unpacked into loose object1395 files. However if the number of received objects equals or1396 exceeds this limit then the received pack will be stored as1397 a pack, after adding any missing delta bases. Storing the1398 pack from a push can make the push operation complete faster,1399 especially on slow filesystems. If not set, the value of1400 `transfer.unpackLimit` is used instead.14011402fetch.prune::1403 If true, fetch will automatically behave as if the `--prune`1404 option was given on the command line. See also `remote.<name>.prune`.14051406fetch.output::1407 Control how ref update status is printed. Valid values are1408 `full` and `compact`. Default value is `full`. See section1409 OUTPUT in linkgit:git-fetch[1] for detail.14101411format.attach::1412 Enable multipart/mixed attachments as the default for1413 'format-patch'. The value can also be a double quoted string1414 which will enable attachments as the default and set the1415 value as the boundary. See the --attach option in1416 linkgit:git-format-patch[1].14171418format.from::1419 Provides the default value for the `--from` option to format-patch.1420 Accepts a boolean value, or a name and email address. If false,1421 format-patch defaults to `--no-from`, using commit authors directly in1422 the "From:" field of patch mails. If true, format-patch defaults to1423 `--from`, using your committer identity in the "From:" field of patch1424 mails and including a "From:" field in the body of the patch mail if1425 different. If set to a non-boolean value, format-patch uses that1426 value instead of your committer identity. Defaults to false.14271428format.numbered::1429 A boolean which can enable or disable sequence numbers in patch1430 subjects. It defaults to "auto" which enables it only if there1431 is more than one patch. It can be enabled or disabled for all1432 messages by setting it to "true" or "false". See --numbered1433 option in linkgit:git-format-patch[1].14341435format.headers::1436 Additional email headers to include in a patch to be submitted1437 by mail. See linkgit:git-format-patch[1].14381439format.to::1440format.cc::1441 Additional recipients to include in a patch to be submitted1442 by mail. See the --to and --cc options in1443 linkgit:git-format-patch[1].14441445format.subjectPrefix::1446 The default for format-patch is to output files with the '[PATCH]'1447 subject prefix. Use this variable to change that prefix.14481449format.signature::1450 The default for format-patch is to output a signature containing1451 the Git version number. Use this variable to change that default.1452 Set this variable to the empty string ("") to suppress1453 signature generation.14541455format.signatureFile::1456 Works just like format.signature except the contents of the1457 file specified by this variable will be used as the signature.14581459format.suffix::1460 The default for format-patch is to output files with the suffix1461 `.patch`. Use this variable to change that suffix (make sure to1462 include the dot if you want it).14631464format.pretty::1465 The default pretty format for log/show/whatchanged command,1466 See linkgit:git-log[1], linkgit:git-show[1],1467 linkgit:git-whatchanged[1].14681469format.thread::1470 The default threading style for 'git format-patch'. Can be1471 a boolean value, or `shallow` or `deep`. `shallow` threading1472 makes every mail a reply to the head of the series,1473 where the head is chosen from the cover letter, the1474 `--in-reply-to`, and the first patch mail, in this order.1475 `deep` threading makes every mail a reply to the previous one.1476 A true boolean value is the same as `shallow`, and a false1477 value disables threading.14781479format.signOff::1480 A boolean value which lets you enable the `-s/--signoff` option of1481 format-patch by default. *Note:* Adding the Signed-off-by: line to a1482 patch should be a conscious act and means that you certify you have1483 the rights to submit this work under the same open source license.1484 Please see the 'SubmittingPatches' document for further discussion.14851486format.coverLetter::1487 A boolean that controls whether to generate a cover-letter when1488 format-patch is invoked, but in addition can be set to "auto", to1489 generate a cover-letter only when there's more than one patch.14901491format.outputDirectory::1492 Set a custom directory to store the resulting files instead of the1493 current working directory.14941495format.useAutoBase::1496 A boolean value which lets you enable the `--base=auto` option of1497 format-patch by default.14981499filter.<driver>.clean::1500 The command which is used to convert the content of a worktree1501 file to a blob upon checkin. See linkgit:gitattributes[5] for1502 details.15031504filter.<driver>.smudge::1505 The command which is used to convert the content of a blob1506 object to a worktree file upon checkout. See1507 linkgit:gitattributes[5] for details.15081509fsck.<msg-id>::1510 Allows overriding the message type (error, warn or ignore) of a1511 specific message ID such as `missingEmail`.1512+1513For convenience, fsck prefixes the error/warning with the message ID,1514e.g. "missingEmail: invalid author/committer line - missing email" means1515that setting `fsck.missingEmail = ignore` will hide that issue.1516+1517This feature is intended to support working with legacy repositories1518which cannot be repaired without disruptive changes.15191520fsck.skipList::1521 The path to a sorted list of object names (i.e. one SHA-1 per1522 line) that are known to be broken in a non-fatal way and should1523 be ignored. This feature is useful when an established project1524 should be accepted despite early commits containing errors that1525 can be safely ignored such as invalid committer email addresses.1526 Note: corrupt objects cannot be skipped with this setting.15271528gc.aggressiveDepth::1529 The depth parameter used in the delta compression1530 algorithm used by 'git gc --aggressive'. This defaults1531 to 50.15321533gc.aggressiveWindow::1534 The window size parameter used in the delta compression1535 algorithm used by 'git gc --aggressive'. This defaults1536 to 250.15371538gc.auto::1539 When there are approximately more than this many loose1540 objects in the repository, `git gc --auto` will pack them.1541 Some Porcelain commands use this command to perform a1542 light-weight garbage collection from time to time. The1543 default value is 6700. Setting this to 0 disables it.15441545gc.autoPackLimit::1546 When there are more than this many packs that are not1547 marked with `*.keep` file in the repository, `git gc1548 --auto` consolidates them into one larger pack. The1549 default value is 50. Setting this to 0 disables it.15501551gc.autoDetach::1552 Make `git gc --auto` return immediately and run in background1553 if the system supports it. Default is true.15541555gc.logExpiry::1556 If the file gc.log exists, then `git gc --auto` won't run1557 unless that file is more than 'gc.logExpiry' old. Default is1558 "1.day". See `gc.pruneExpire` for more ways to specify its1559 value.15601561gc.packRefs::1562 Running `git pack-refs` in a repository renders it1563 unclonable by Git versions prior to 1.5.1.2 over dumb1564 transports such as HTTP. This variable determines whether1565 'git gc' runs `git pack-refs`. This can be set to `notbare`1566 to enable it within all non-bare repos or it can be set to a1567 boolean value. The default is `true`.15681569gc.pruneExpire::1570 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1571 Override the grace period with this config variable. The value1572 "now" may be used to disable this grace period and always prune1573 unreachable objects immediately, or "never" may be used to1574 suppress pruning. This feature helps prevent corruption when1575 'git gc' runs concurrently with another process writing to the1576 repository; see the "NOTES" section of linkgit:git-gc[1].15771578gc.worktreePruneExpire::1579 When 'git gc' is run, it calls1580 'git worktree prune --expire 3.months.ago'.1581 This config variable can be used to set a different grace1582 period. The value "now" may be used to disable the grace1583 period and prune `$GIT_DIR/worktrees` immediately, or "never"1584 may be used to suppress pruning.15851586gc.reflogExpire::1587gc.<pattern>.reflogExpire::1588 'git reflog expire' removes reflog entries older than1589 this time; defaults to 90 days. The value "now" expires all1590 entries immediately, and "never" suppresses expiration1591 altogether. With "<pattern>" (e.g.1592 "refs/stash") in the middle the setting applies only to1593 the refs that match the <pattern>.15941595gc.reflogExpireUnreachable::1596gc.<pattern>.reflogExpireUnreachable::1597 'git reflog expire' removes reflog entries older than1598 this time and are not reachable from the current tip;1599 defaults to 30 days. The value "now" expires all entries1600 immediately, and "never" suppresses expiration altogether.1601 With "<pattern>" (e.g. "refs/stash")1602 in the middle, the setting applies only to the refs that1603 match the <pattern>.16041605gc.rerereResolved::1606 Records of conflicted merge you resolved earlier are1607 kept for this many days when 'git rerere gc' is run.1608 You can also use more human-readable "1.month.ago", etc.1609 The default is 60 days. See linkgit:git-rerere[1].16101611gc.rerereUnresolved::1612 Records of conflicted merge you have not resolved are1613 kept for this many days when 'git rerere gc' is run.1614 You can also use more human-readable "1.month.ago", etc.1615 The default is 15 days. See linkgit:git-rerere[1].16161617gitcvs.commitMsgAnnotation::1618 Append this string to each commit message. Set to empty string1619 to disable this feature. Defaults to "via git-CVS emulator".16201621gitcvs.enabled::1622 Whether the CVS server interface is enabled for this repository.1623 See linkgit:git-cvsserver[1].16241625gitcvs.logFile::1626 Path to a log file where the CVS server interface well... logs1627 various stuff. See linkgit:git-cvsserver[1].16281629gitcvs.usecrlfattr::1630 If true, the server will look up the end-of-line conversion1631 attributes for files to determine the `-k` modes to use. If1632 the attributes force Git to treat a file as text,1633 the `-k` mode will be left blank so CVS clients will1634 treat it as text. If they suppress text conversion, the file1635 will be set with '-kb' mode, which suppresses any newline munging1636 the client might otherwise do. If the attributes do not allow1637 the file type to be determined, then `gitcvs.allBinary` is1638 used. See linkgit:gitattributes[5].16391640gitcvs.allBinary::1641 This is used if `gitcvs.usecrlfattr` does not resolve1642 the correct '-kb' mode to use. If true, all1643 unresolved files are sent to the client in1644 mode '-kb'. This causes the client to treat them1645 as binary files, which suppresses any newline munging it1646 otherwise might do. Alternatively, if it is set to "guess",1647 then the contents of the file are examined to decide if1648 it is binary, similar to `core.autocrlf`.16491650gitcvs.dbName::1651 Database used by git-cvsserver to cache revision information1652 derived from the Git repository. The exact meaning depends on the1653 used database driver, for SQLite (which is the default driver) this1654 is a filename. Supports variable substitution (see1655 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1656 Default: '%Ggitcvs.%m.sqlite'16571658gitcvs.dbDriver::1659 Used Perl DBI driver. You can specify any available driver1660 for this here, but it might not work. git-cvsserver is tested1661 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1662 reported *not* to work with 'DBD::mysql'. Experimental feature.1663 May not contain double colons (`:`). Default: 'SQLite'.1664 See linkgit:git-cvsserver[1].16651666gitcvs.dbUser, gitcvs.dbPass::1667 Database user and password. Only useful if setting `gitcvs.dbDriver`,1668 since SQLite has no concept of database users and/or passwords.1669 'gitcvs.dbUser' supports variable substitution (see1670 linkgit:git-cvsserver[1] for details).16711672gitcvs.dbTableNamePrefix::1673 Database table name prefix. Prepended to the names of any1674 database tables used, allowing a single database to be used1675 for several repositories. Supports variable substitution (see1676 linkgit:git-cvsserver[1] for details). Any non-alphabetic1677 characters will be replaced with underscores.16781679All gitcvs variables except for `gitcvs.usecrlfattr` and1680`gitcvs.allBinary` can also be specified as1681'gitcvs.<access_method>.<varname>' (where 'access_method'1682is one of "ext" and "pserver") to make them apply only for the given1683access method.16841685gitweb.category::1686gitweb.description::1687gitweb.owner::1688gitweb.url::1689 See linkgit:gitweb[1] for description.16901691gitweb.avatar::1692gitweb.blame::1693gitweb.grep::1694gitweb.highlight::1695gitweb.patches::1696gitweb.pickaxe::1697gitweb.remote_heads::1698gitweb.showSizes::1699gitweb.snapshot::1700 See linkgit:gitweb.conf[5] for description.17011702grep.lineNumber::1703 If set to true, enable `-n` option by default.17041705grep.patternType::1706 Set the default matching behavior. Using a value of 'basic', 'extended',1707 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1708 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1709 value 'default' will return to the default matching behavior.17101711grep.extendedRegexp::1712 If set to true, enable `--extended-regexp` option by default. This1713 option is ignored when the `grep.patternType` option is set to a value1714 other than 'default'.17151716grep.threads::1717 Number of grep worker threads to use.1718 See `grep.threads` in linkgit:git-grep[1] for more information.17191720grep.fallbackToNoIndex::1721 If set to true, fall back to git grep --no-index if git grep1722 is executed outside of a git repository. Defaults to false.17231724gpg.program::1725 Use this custom program instead of "`gpg`" found on `$PATH` when1726 making or verifying a PGP signature. The program must support the1727 same command-line interface as GPG, namely, to verify a detached1728 signature, "`gpg --verify $file - <$signature`" is run, and the1729 program is expected to signal a good signature by exiting with1730 code 0, and to generate an ASCII-armored detached signature, the1731 standard input of "`gpg -bsau $key`" is fed with the contents to be1732 signed, and the program is expected to send the result to its1733 standard output.17341735gui.commitMsgWidth::1736 Defines how wide the commit message window is in the1737 linkgit:git-gui[1]. "75" is the default.17381739gui.diffContext::1740 Specifies how many context lines should be used in calls to diff1741 made by the linkgit:git-gui[1]. The default is "5".17421743gui.displayUntracked::1744 Determines if linkgit:git-gui[1] shows untracked files1745 in the file list. The default is "true".17461747gui.encoding::1748 Specifies the default encoding to use for displaying of1749 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1750 It can be overridden by setting the 'encoding' attribute1751 for relevant files (see linkgit:gitattributes[5]).1752 If this option is not set, the tools default to the1753 locale encoding.17541755gui.matchTrackingBranch::1756 Determines if new branches created with linkgit:git-gui[1] should1757 default to tracking remote branches with matching names or1758 not. Default: "false".17591760gui.newBranchTemplate::1761 Is used as suggested name when creating new branches using the1762 linkgit:git-gui[1].17631764gui.pruneDuringFetch::1765 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1766 performing a fetch. The default value is "false".17671768gui.trustmtime::1769 Determines if linkgit:git-gui[1] should trust the file modification1770 timestamp or not. By default the timestamps are not trusted.17711772gui.spellingDictionary::1773 Specifies the dictionary used for spell checking commit messages in1774 the linkgit:git-gui[1]. When set to "none" spell checking is turned1775 off.17761777gui.fastCopyBlame::1778 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1779 location detection. It makes blame significantly faster on huge1780 repositories at the expense of less thorough copy detection.17811782gui.copyBlameThreshold::1783 Specifies the threshold to use in 'git gui blame' original location1784 detection, measured in alphanumeric characters. See the1785 linkgit:git-blame[1] manual for more information on copy detection.17861787gui.blamehistoryctx::1788 Specifies the radius of history context in days to show in1789 linkgit:gitk[1] for the selected commit, when the `Show History1790 Context` menu item is invoked from 'git gui blame'. If this1791 variable is set to zero, the whole history is shown.17921793guitool.<name>.cmd::1794 Specifies the shell command line to execute when the corresponding item1795 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1796 mandatory for every tool. The command is executed from the root of1797 the working directory, and in the environment it receives the name of1798 the tool as `GIT_GUITOOL`, the name of the currently selected file as1799 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1800 the head is detached, 'CUR_BRANCH' is empty).18011802guitool.<name>.needsFile::1803 Run the tool only if a diff is selected in the GUI. It guarantees1804 that 'FILENAME' is not empty.18051806guitool.<name>.noConsole::1807 Run the command silently, without creating a window to display its1808 output.18091810guitool.<name>.noRescan::1811 Don't rescan the working directory for changes after the tool1812 finishes execution.18131814guitool.<name>.confirm::1815 Show a confirmation dialog before actually running the tool.18161817guitool.<name>.argPrompt::1818 Request a string argument from the user, and pass it to the tool1819 through the `ARGS` environment variable. Since requesting an1820 argument implies confirmation, the 'confirm' option has no effect1821 if this is enabled. If the option is set to 'true', 'yes', or '1',1822 the dialog uses a built-in generic prompt; otherwise the exact1823 value of the variable is used.18241825guitool.<name>.revPrompt::1826 Request a single valid revision from the user, and set the1827 `REVISION` environment variable. In other aspects this option1828 is similar to 'argPrompt', and can be used together with it.18291830guitool.<name>.revUnmerged::1831 Show only unmerged branches in the 'revPrompt' subdialog.1832 This is useful for tools similar to merge or rebase, but not1833 for things like checkout or reset.18341835guitool.<name>.title::1836 Specifies the title to use for the prompt dialog. The default1837 is the tool name.18381839guitool.<name>.prompt::1840 Specifies the general prompt string to display at the top of1841 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1842 The default value includes the actual command.18431844help.browser::1845 Specify the browser that will be used to display help in the1846 'web' format. See linkgit:git-help[1].18471848help.format::1849 Override the default help format used by linkgit:git-help[1].1850 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1851 the default. 'web' and 'html' are the same.18521853help.autoCorrect::1854 Automatically correct and execute mistyped commands after1855 waiting for the given number of deciseconds (0.1 sec). If more1856 than one command can be deduced from the entered text, nothing1857 will be executed. If the value of this option is negative,1858 the corrected command will be executed immediately. If the1859 value is 0 - the command will be just shown but not executed.1860 This is the default.18611862help.htmlPath::1863 Specify the path where the HTML documentation resides. File system paths1864 and URLs are supported. HTML pages will be prefixed with this path when1865 help is displayed in the 'web' format. This defaults to the documentation1866 path of your Git installation.18671868http.proxy::1869 Override the HTTP proxy, normally configured using the 'http_proxy',1870 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1871 addition to the syntax understood by curl, it is possible to specify a1872 proxy string with a user name but no password, in which case git will1873 attempt to acquire one in the same way it does for other credentials. See1874 linkgit:gitcredentials[7] for more information. The syntax thus is1875 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1876 on a per-remote basis; see remote.<name>.proxy18771878http.proxyAuthMethod::1879 Set the method with which to authenticate against the HTTP proxy. This1880 only takes effect if the configured proxy string contains a user name part1881 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1882 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1883 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1884 variable. Possible values are:1885+1886--1887* `anyauth` - Automatically pick a suitable authentication method. It is1888 assumed that the proxy answers an unauthenticated request with a 4071889 status code and one or more Proxy-authenticate headers with supported1890 authentication methods. This is the default.1891* `basic` - HTTP Basic authentication1892* `digest` - HTTP Digest authentication; this prevents the password from being1893 transmitted to the proxy in clear text1894* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1895 of `curl(1)`)1896* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1897--18981899http.emptyAuth::1900 Attempt authentication without seeking a username or password. This1901 can be used to attempt GSS-Negotiate authentication without specifying1902 a username in the URL, as libcurl normally requires a username for1903 authentication.19041905http.delegation::1906 Control GSSAPI credential delegation. The delegation is disabled1907 by default in libcurl since version 7.21.7. Set parameter to tell1908 the server what it is allowed to delegate when it comes to user1909 credentials. Used with GSS/kerberos. Possible values are:1910+1911--1912* `none` - Don't allow any delegation.1913* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the1914 Kerberos service ticket, which is a matter of realm policy.1915* `always` - Unconditionally allow the server to delegate.1916--191719181919http.extraHeader::1920 Pass an additional HTTP header when communicating with a server. If1921 more than one such entry exists, all of them are added as extra1922 headers. To allow overriding the settings inherited from the system1923 config, an empty value will reset the extra headers to the empty list.19241925http.cookieFile::1926 The pathname of a file containing previously stored cookie lines,1927 which should be used1928 in the Git http session, if they match the server. The file format1929 of the file to read cookies from should be plain HTTP headers or1930 the Netscape/Mozilla cookie file format (see `curl(1)`).1931 NOTE that the file specified with http.cookieFile is used only as1932 input unless http.saveCookies is set.19331934http.saveCookies::1935 If set, store cookies received during requests to the file specified by1936 http.cookieFile. Has no effect if http.cookieFile is unset.19371938http.sslVersion::1939 The SSL version to use when negotiating an SSL connection, if you1940 want to force the default. The available and default version1941 depend on whether libcurl was built against NSS or OpenSSL and the1942 particular configuration of the crypto library in use. Internally1943 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl1944 documentation for more details on the format of this option and1945 for the ssl version supported. Actually the possible values of1946 this option are:19471948 - sslv21949 - sslv31950 - tlsv11951 - tlsv1.01952 - tlsv1.11953 - tlsv1.219541955+1956Can be overridden by the `GIT_SSL_VERSION` environment variable.1957To force git to use libcurl's default ssl version and ignore any1958explicit http.sslversion option, set `GIT_SSL_VERSION` to the1959empty string.19601961http.sslCipherList::1962 A list of SSL ciphers to use when negotiating an SSL connection.1963 The available ciphers depend on whether libcurl was built against1964 NSS or OpenSSL and the particular configuration of the crypto1965 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'1966 option; see the libcurl documentation for more details on the format1967 of this list.1968+1969Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.1970To force git to use libcurl's default cipher list and ignore any1971explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the1972empty string.19731974http.sslVerify::1975 Whether to verify the SSL certificate when fetching or pushing1976 over HTTPS. Defaults to true. Can be overridden by the1977 `GIT_SSL_NO_VERIFY` environment variable.19781979http.sslCert::1980 File containing the SSL certificate when fetching or pushing1981 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment1982 variable.19831984http.sslKey::1985 File containing the SSL private key when fetching or pushing1986 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment1987 variable.19881989http.sslCertPasswordProtected::1990 Enable Git's password prompt for the SSL certificate. Otherwise1991 OpenSSL will prompt the user, possibly many times, if the1992 certificate or private key is encrypted. Can be overridden by the1993 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.19941995http.sslCAInfo::1996 File containing the certificates to verify the peer with when1997 fetching or pushing over HTTPS. Can be overridden by the1998 `GIT_SSL_CAINFO` environment variable.19992000http.sslCAPath::2001 Path containing files with the CA certificates to verify the peer2002 with when fetching or pushing over HTTPS. Can be overridden2003 by the `GIT_SSL_CAPATH` environment variable.20042005http.pinnedpubkey::2006 Public key of the https service. It may either be the filename of2007 a PEM or DER encoded public key file or a string starting with2008 'sha256//' followed by the base64 encoded sha256 hash of the2009 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will2010 exit with an error if this option is set but not supported by2011 cURL.20122013http.sslTry::2014 Attempt to use AUTH SSL/TLS and encrypted data transfers2015 when connecting via regular FTP protocol. This might be needed2016 if the FTP server requires it for security reasons or you wish2017 to connect securely whenever remote FTP server supports it.2018 Default is false since it might trigger certificate verification2019 errors on misconfigured servers.20202021http.maxRequests::2022 How many HTTP requests to launch in parallel. Can be overridden2023 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.20242025http.minSessions::2026 The number of curl sessions (counted across slots) to be kept across2027 requests. They will not be ended with curl_easy_cleanup() until2028 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this2029 value will be capped at 1. Defaults to 1.20302031http.postBuffer::2032 Maximum size in bytes of the buffer used by smart HTTP2033 transports when POSTing data to the remote system.2034 For requests larger than this buffer size, HTTP/1.1 and2035 Transfer-Encoding: chunked is used to avoid creating a2036 massive pack file locally. Default is 1 MiB, which is2037 sufficient for most requests.20382039http.lowSpeedLimit, http.lowSpeedTime::2040 If the HTTP transfer speed is less than 'http.lowSpeedLimit'2041 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.2042 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and2043 `GIT_HTTP_LOW_SPEED_TIME` environment variables.20442045http.noEPSV::2046 A boolean which disables using of EPSV ftp command by curl.2047 This can helpful with some "poor" ftp servers which don't2048 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`2049 environment variable. Default is false (curl will use EPSV).20502051http.userAgent::2052 The HTTP USER_AGENT string presented to an HTTP server. The default2053 value represents the version of the client Git such as git/1.7.1.2054 This option allows you to override this value to a more common value2055 such as Mozilla/4.0. This may be necessary, for instance, if2056 connecting through a firewall that restricts HTTP connections to a set2057 of common USER_AGENT strings (but not including those like git/1.7.1).2058 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.20592060http.followRedirects::2061 Whether git should follow HTTP redirects. If set to `true`, git2062 will transparently follow any redirect issued by a server it2063 encounters. If set to `false`, git will treat all redirects as2064 errors. If set to `initial`, git will follow redirects only for2065 the initial request to a remote, but not for subsequent2066 follow-up HTTP requests. Since git uses the redirected URL as2067 the base for the follow-up requests, this is generally2068 sufficient. The default is `initial`.20692070http.<url>.*::2071 Any of the http.* options above can be applied selectively to some URLs.2072 For a config key to match a URL, each element of the config key is2073 compared to that of the URL, in the following order:2074+2075--2076. Scheme (e.g., `https` in `https://example.com/`). This field2077 must match exactly between the config key and the URL.20782079. Host/domain name (e.g., `example.com` in `https://example.com/`).2080 This field must match between the config key and the URL. It is2081 possible to specify a `*` as part of the host name to match all subdomains2082 at this level. `https://*.example.com/` for example would match2083 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.20842085. Port number (e.g., `8080` in `http://example.com:8080/`).2086 This field must match exactly between the config key and the URL.2087 Omitted port numbers are automatically converted to the correct2088 default for the scheme before matching.20892090. Path (e.g., `repo.git` in `https://example.com/repo.git`). The2091 path field of the config key must match the path field of the URL2092 either exactly or as a prefix of slash-delimited path elements. This means2093 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only2094 match on a slash (`/`) boundary. Longer matches take precedence (so a config2095 key with path `foo/bar` is a better match to URL path `foo/bar` than a config2096 key with just path `foo/`).20972098. User name (e.g., `user` in `https://user@example.com/repo.git`). If2099 the config key has a user name it must match the user name in the2100 URL exactly. If the config key does not have a user name, that2101 config key will match a URL with any user name (including none),2102 but at a lower precedence than a config key with a user name.2103--2104+2105The list above is ordered by decreasing precedence; a URL that matches2106a config key's path is preferred to one that matches its user name. For example,2107if the URL is `https://user@example.com/foo/bar` a config key match of2108`https://example.com/foo` will be preferred over a config key match of2109`https://user@example.com`.2110+2111All URLs are normalized before attempting any matching (the password part,2112if embedded in the URL, is always ignored for matching purposes) so that2113equivalent URLs that are simply spelled differently will match properly.2114Environment variable settings always override any matches. The URLs that are2115matched against are those given directly to Git commands. This means any URLs2116visited as a result of a redirection do not participate in matching.21172118ssh.variant::2119 By default, Git determines the command line arguments to use2120 based on the basename of the configured SSH command (configured2121 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or2122 the config setting `core.sshCommand`). If the basename is2123 unrecognized, Git will attempt to detect support of OpenSSH2124 options by first invoking the configured SSH command with the2125 `-G` (print configuration) option and will subsequently use2126 OpenSSH options (if that is successful) or no options besides2127 the host and remote command (if it fails).2128+2129The config variable `ssh.variant` can be set to override this detection.2130Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,2131`tortoiseplink`, `simple` (no options except the host and remote command).2132The default auto-detection can be explicitly requested using the value2133`auto`. Any other value is treated as `ssh`. This setting can also be2134overridden via the environment variable `GIT_SSH_VARIANT`.2135+2136The current command-line parameters used for each variant are as2137follows:2138+2139--21402141* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command21422143* `simple` - [username@]host command21442145* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command21462147* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command21482149--2150+2151Except for the `simple` variant, command-line parameters are likely to2152change as git gains new features.21532154i18n.commitEncoding::2155 Character encoding the commit messages are stored in; Git itself2156 does not care per se, but this information is necessary e.g. when2157 importing commits from emails or in the gitk graphical history2158 browser (and possibly at other places in the future or in other2159 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.21602161i18n.logOutputEncoding::2162 Character encoding the commit messages are converted to when2163 running 'git log' and friends.21642165imap::2166 The configuration variables in the 'imap' section are described2167 in linkgit:git-imap-send[1].21682169index.version::2170 Specify the version with which new index files should be2171 initialized. This does not affect existing repositories.21722173init.templateDir::2174 Specify the directory from which templates will be copied.2175 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)21762177instaweb.browser::2178 Specify the program that will be used to browse your working2179 repository in gitweb. See linkgit:git-instaweb[1].21802181instaweb.httpd::2182 The HTTP daemon command-line to start gitweb on your working2183 repository. See linkgit:git-instaweb[1].21842185instaweb.local::2186 If true the web server started by linkgit:git-instaweb[1] will2187 be bound to the local IP (127.0.0.1).21882189instaweb.modulePath::2190 The default module path for linkgit:git-instaweb[1] to use2191 instead of /usr/lib/apache2/modules. Only used if httpd2192 is Apache.21932194instaweb.port::2195 The port number to bind the gitweb httpd to. See2196 linkgit:git-instaweb[1].21972198interactive.singleKey::2199 In interactive commands, allow the user to provide one-letter2200 input with a single key (i.e., without hitting enter).2201 Currently this is used by the `--patch` mode of2202 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],2203 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this2204 setting is silently ignored if portable keystroke input2205 is not available; requires the Perl module Term::ReadKey.22062207interactive.diffFilter::2208 When an interactive command (such as `git add --patch`) shows2209 a colorized diff, git will pipe the diff through the shell2210 command defined by this configuration variable. The command may2211 mark up the diff further for human consumption, provided that it2212 retains a one-to-one correspondence with the lines in the2213 original diff. Defaults to disabled (no filtering).22142215log.abbrevCommit::2216 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2217 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may2218 override this option with `--no-abbrev-commit`.22192220log.date::2221 Set the default date-time mode for the 'log' command.2222 Setting a value for log.date is similar to using 'git log''s2223 `--date` option. See linkgit:git-log[1] for details.22242225log.decorate::2226 Print out the ref names of any commits that are shown by the log2227 command. If 'short' is specified, the ref name prefixes 'refs/heads/',2228 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is2229 specified, the full ref name (including prefix) will be printed.2230 If 'auto' is specified, then if the output is going to a terminal,2231 the ref names are shown as if 'short' were given, otherwise no ref2232 names are shown. This is the same as the `--decorate` option2233 of the `git log`.22342235log.follow::2236 If `true`, `git log` will act as if the `--follow` option was used when2237 a single <path> is given. This has the same limitations as `--follow`,2238 i.e. it cannot be used to follow multiple files and does not work well2239 on non-linear history.22402241log.graphColors::2242 A list of colors, separated by commas, that can be used to draw2243 history lines in `git log --graph`.22442245log.showRoot::2246 If true, the initial commit will be shown as a big creation event.2247 This is equivalent to a diff against an empty tree.2248 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2249 normally hide the root commit will now show it. True by default.22502251log.showSignature::2252 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2253 linkgit:git-whatchanged[1] assume `--show-signature`.22542255log.mailmap::2256 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2257 linkgit:git-whatchanged[1] assume `--use-mailmap`.22582259mailinfo.scissors::2260 If true, makes linkgit:git-mailinfo[1] (and therefore2261 linkgit:git-am[1]) act by default as if the --scissors option2262 was provided on the command-line. When active, this features2263 removes everything from the message body before a scissors2264 line (i.e. consisting mainly of ">8", "8<" and "-").22652266mailmap.file::2267 The location of an augmenting mailmap file. The default2268 mailmap, located in the root of the repository, is loaded2269 first, then the mailmap file pointed to by this variable.2270 The location of the mailmap file may be in a repository2271 subdirectory, or somewhere outside of the repository itself.2272 See linkgit:git-shortlog[1] and linkgit:git-blame[1].22732274mailmap.blob::2275 Like `mailmap.file`, but consider the value as a reference to a2276 blob in the repository. If both `mailmap.file` and2277 `mailmap.blob` are given, both are parsed, with entries from2278 `mailmap.file` taking precedence. In a bare repository, this2279 defaults to `HEAD:.mailmap`. In a non-bare repository, it2280 defaults to empty.22812282man.viewer::2283 Specify the programs that may be used to display help in the2284 'man' format. See linkgit:git-help[1].22852286man.<tool>.cmd::2287 Specify the command to invoke the specified man viewer. The2288 specified command is evaluated in shell with the man page2289 passed as argument. (See linkgit:git-help[1].)22902291man.<tool>.path::2292 Override the path for the given tool that may be used to2293 display help in the 'man' format. See linkgit:git-help[1].22942295include::merge-config.txt[]22962297mergetool.<tool>.path::2298 Override the path for the given tool. This is useful in case2299 your tool is not in the PATH.23002301mergetool.<tool>.cmd::2302 Specify the command to invoke the specified merge tool. The2303 specified command is evaluated in shell with the following2304 variables available: 'BASE' is the name of a temporary file2305 containing the common base of the files to be merged, if available;2306 'LOCAL' is the name of a temporary file containing the contents of2307 the file on the current branch; 'REMOTE' is the name of a temporary2308 file containing the contents of the file from the branch being2309 merged; 'MERGED' contains the name of the file to which the merge2310 tool should write the results of a successful merge.23112312mergetool.<tool>.trustExitCode::2313 For a custom merge command, specify whether the exit code of2314 the merge command can be used to determine whether the merge was2315 successful. If this is not set to true then the merge target file2316 timestamp is checked and the merge assumed to have been successful2317 if the file has been updated, otherwise the user is prompted to2318 indicate the success of the merge.23192320mergetool.meld.hasOutput::2321 Older versions of `meld` do not support the `--output` option.2322 Git will attempt to detect whether `meld` supports `--output`2323 by inspecting the output of `meld --help`. Configuring2324 `mergetool.meld.hasOutput` will make Git skip these checks and2325 use the configured value instead. Setting `mergetool.meld.hasOutput`2326 to `true` tells Git to unconditionally use the `--output` option,2327 and `false` avoids using `--output`.23282329mergetool.keepBackup::2330 After performing a merge, the original file with conflict markers2331 can be saved as a file with a `.orig` extension. If this variable2332 is set to `false` then this file is not preserved. Defaults to2333 `true` (i.e. keep the backup files).23342335mergetool.keepTemporaries::2336 When invoking a custom merge tool, Git uses a set of temporary2337 files to pass to the tool. If the tool returns an error and this2338 variable is set to `true`, then these temporary files will be2339 preserved, otherwise they will be removed after the tool has2340 exited. Defaults to `false`.23412342mergetool.writeToTemp::2343 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2344 conflicting files in the worktree by default. Git will attempt2345 to use a temporary directory for these files when set `true`.2346 Defaults to `false`.23472348mergetool.prompt::2349 Prompt before each invocation of the merge resolution program.23502351notes.mergeStrategy::2352 Which merge strategy to choose by default when resolving notes2353 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2354 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2355 section of linkgit:git-notes[1] for more information on each strategy.23562357notes.<name>.mergeStrategy::2358 Which merge strategy to choose when doing a notes merge into2359 refs/notes/<name>. This overrides the more general2360 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2361 linkgit:git-notes[1] for more information on the available strategies.23622363notes.displayRef::2364 The (fully qualified) refname from which to show notes when2365 showing commit messages. The value of this variable can be set2366 to a glob, in which case notes from all matching refs will be2367 shown. You may also specify this configuration variable2368 several times. A warning will be issued for refs that do not2369 exist, but a glob that does not match any refs is silently2370 ignored.2371+2372This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2373environment variable, which must be a colon separated list of refs or2374globs.2375+2376The effective value of "core.notesRef" (possibly overridden by2377GIT_NOTES_REF) is also implicitly added to the list of refs to be2378displayed.23792380notes.rewrite.<command>::2381 When rewriting commits with <command> (currently `amend` or2382 `rebase`) and this variable is set to `true`, Git2383 automatically copies your notes from the original to the2384 rewritten commit. Defaults to `true`, but see2385 "notes.rewriteRef" below.23862387notes.rewriteMode::2388 When copying notes during a rewrite (see the2389 "notes.rewrite.<command>" option), determines what to do if2390 the target commit already has a note. Must be one of2391 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2392 Defaults to `concatenate`.2393+2394This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2395environment variable.23962397notes.rewriteRef::2398 When copying notes during a rewrite, specifies the (fully2399 qualified) ref whose notes should be copied. The ref may be a2400 glob, in which case notes in all matching refs will be copied.2401 You may also specify this configuration several times.2402+2403Does not have a default value; you must configure this variable to2404enable note rewriting. Set it to `refs/notes/commits` to enable2405rewriting for the default commit notes.2406+2407This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2408environment variable, which must be a colon separated list of refs or2409globs.24102411pack.window::2412 The size of the window used by linkgit:git-pack-objects[1] when no2413 window size is given on the command line. Defaults to 10.24142415pack.depth::2416 The maximum delta depth used by linkgit:git-pack-objects[1] when no2417 maximum depth is given on the command line. Defaults to 50.24182419pack.windowMemory::2420 The maximum size of memory that is consumed by each thread2421 in linkgit:git-pack-objects[1] for pack window memory when2422 no limit is given on the command line. The value can be2423 suffixed with "k", "m", or "g". When left unconfigured (or2424 set explicitly to 0), there will be no limit.24252426pack.compression::2427 An integer -1..9, indicating the compression level for objects2428 in a pack file. -1 is the zlib default. 0 means no2429 compression, and 1..9 are various speed/size tradeoffs, 9 being2430 slowest. If not set, defaults to core.compression. If that is2431 not set, defaults to -1, the zlib default, which is "a default2432 compromise between speed and compression (currently equivalent2433 to level 6)."2434+2435Note that changing the compression level will not automatically recompress2436all existing objects. You can force recompression by passing the -F option2437to linkgit:git-repack[1].24382439pack.deltaCacheSize::2440 The maximum memory in bytes used for caching deltas in2441 linkgit:git-pack-objects[1] before writing them out to a pack.2442 This cache is used to speed up the writing object phase by not2443 having to recompute the final delta result once the best match2444 for all objects is found. Repacking large repositories on machines2445 which are tight with memory might be badly impacted by this though,2446 especially if this cache pushes the system into swapping.2447 A value of 0 means no limit. The smallest size of 1 byte may be2448 used to virtually disable this cache. Defaults to 256 MiB.24492450pack.deltaCacheLimit::2451 The maximum size of a delta, that is cached in2452 linkgit:git-pack-objects[1]. This cache is used to speed up the2453 writing object phase by not having to recompute the final delta2454 result once the best match for all objects is found. Defaults to 1000.24552456pack.threads::2457 Specifies the number of threads to spawn when searching for best2458 delta matches. This requires that linkgit:git-pack-objects[1]2459 be compiled with pthreads otherwise this option is ignored with a2460 warning. This is meant to reduce packing time on multiprocessor2461 machines. The required amount of memory for the delta search window2462 is however multiplied by the number of threads.2463 Specifying 0 will cause Git to auto-detect the number of CPU's2464 and set the number of threads accordingly.24652466pack.indexVersion::2467 Specify the default pack index version. Valid values are 1 for2468 legacy pack index used by Git versions prior to 1.5.2, and 2 for2469 the new pack index with capabilities for packs larger than 4 GB2470 as well as proper protection against the repacking of corrupted2471 packs. Version 2 is the default. Note that version 2 is enforced2472 and this config option ignored whenever the corresponding pack is2473 larger than 2 GB.2474+2475If you have an old Git that does not understand the version 2 `*.idx` file,2476cloning or fetching over a non native protocol (e.g. "http")2477that will copy both `*.pack` file and corresponding `*.idx` file from the2478other side may give you a repository that cannot be accessed with your2479older version of Git. If the `*.pack` file is smaller than 2 GB, however,2480you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2481the `*.idx` file.24822483pack.packSizeLimit::2484 The maximum size of a pack. This setting only affects2485 packing to a file when repacking, i.e. the git:// protocol2486 is unaffected. It can be overridden by the `--max-pack-size`2487 option of linkgit:git-repack[1]. Reaching this limit results2488 in the creation of multiple packfiles; which in turn prevents2489 bitmaps from being created.2490 The minimum size allowed is limited to 1 MiB.2491 The default is unlimited.2492 Common unit suffixes of 'k', 'm', or 'g' are2493 supported.24942495pack.useBitmaps::2496 When true, git will use pack bitmaps (if available) when packing2497 to stdout (e.g., during the server side of a fetch). Defaults to2498 true. You should not generally need to turn this off unless2499 you are debugging pack bitmaps.25002501pack.writeBitmaps (deprecated)::2502 This is a deprecated synonym for `repack.writeBitmaps`.25032504pack.writeBitmapHashCache::2505 When true, git will include a "hash cache" section in the bitmap2506 index (if one is written). This cache can be used to feed git's2507 delta heuristics, potentially leading to better deltas between2508 bitmapped and non-bitmapped objects (e.g., when serving a fetch2509 between an older, bitmapped pack and objects that have been2510 pushed since the last gc). The downside is that it consumes 42511 bytes per object of disk space, and that JGit's bitmap2512 implementation does not understand it, causing it to complain if2513 Git and JGit are used on the same repository. Defaults to false.25142515pager.<cmd>::2516 If the value is boolean, turns on or off pagination of the2517 output of a particular Git subcommand when writing to a tty.2518 Otherwise, turns on pagination for the subcommand using the2519 pager specified by the value of `pager.<cmd>`. If `--paginate`2520 or `--no-pager` is specified on the command line, it takes2521 precedence over this option. To disable pagination for all2522 commands, set `core.pager` or `GIT_PAGER` to `cat`.25232524pretty.<name>::2525 Alias for a --pretty= format string, as specified in2526 linkgit:git-log[1]. Any aliases defined here can be used just2527 as the built-in pretty formats could. For example,2528 running `git config pretty.changelog "format:* %H %s"`2529 would cause the invocation `git log --pretty=changelog`2530 to be equivalent to running `git log "--pretty=format:* %H %s"`.2531 Note that an alias with the same name as a built-in format2532 will be silently ignored.25332534protocol.allow::2535 If set, provide a user defined default policy for all protocols which2536 don't explicitly have a policy (`protocol.<name>.allow`). By default,2537 if unset, known-safe protocols (http, https, git, ssh, file) have a2538 default policy of `always`, known-dangerous protocols (ext) have a2539 default policy of `never`, and all other protocols have a default2540 policy of `user`. Supported policies:2541+2542--25432544* `always` - protocol is always able to be used.25452546* `never` - protocol is never able to be used.25472548* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is2549 either unset or has a value of 1. This policy should be used when you want a2550 protocol to be directly usable by the user but don't want it used by commands which2551 execute clone/fetch/push commands without user input, e.g. recursive2552 submodule initialization.25532554--25552556protocol.<name>.allow::2557 Set a policy to be used by protocol `<name>` with clone/fetch/push2558 commands. See `protocol.allow` above for the available policies.2559+2560The protocol names currently used by git are:2561+2562--2563 - `file`: any local file-based path (including `file://` URLs,2564 or local paths)25652566 - `git`: the anonymous git protocol over a direct TCP2567 connection (or proxy, if configured)25682569 - `ssh`: git over ssh (including `host:path` syntax,2570 `ssh://`, etc).25712572 - `http`: git over http, both "smart http" and "dumb http".2573 Note that this does _not_ include `https`; if you want to configure2574 both, you must do so individually.25752576 - any external helpers are named by their protocol (e.g., use2577 `hg` to allow the `git-remote-hg` helper)2578--25792580protocol.version::2581 Experimental. If set, clients will attempt to communicate with a2582 server using the specified protocol version. If unset, no2583 attempt will be made by the client to communicate using a2584 particular protocol version, this results in protocol version 02585 being used.2586 Supported versions:2587+2588--25892590* `0` - the original wire protocol.25912592* `1` - the original wire protocol with the addition of a version string2593 in the initial response from the server.25942595--25962597pull.ff::2598 By default, Git does not create an extra merge commit when merging2599 a commit that is a descendant of the current commit. Instead, the2600 tip of the current branch is fast-forwarded. When set to `false`,2601 this variable tells Git to create an extra merge commit in such2602 a case (equivalent to giving the `--no-ff` option from the command2603 line). When set to `only`, only such fast-forward merges are2604 allowed (equivalent to giving the `--ff-only` option from the2605 command line). This setting overrides `merge.ff` when pulling.26062607pull.rebase::2608 When true, rebase branches on top of the fetched branch, instead2609 of merging the default branch from the default remote when "git2610 pull" is run. See "branch.<name>.rebase" for setting this on a2611 per-branch basis.2612+2613When preserve, also pass `--preserve-merges` along to 'git rebase'2614so that locally committed merge commits will not be flattened2615by running 'git pull'.2616+2617When the value is `interactive`, the rebase is run in interactive mode.2618+2619*NOTE*: this is a possibly dangerous operation; do *not* use2620it unless you understand the implications (see linkgit:git-rebase[1]2621for details).26222623pull.octopus::2624 The default merge strategy to use when pulling multiple branches2625 at once.26262627pull.twohead::2628 The default merge strategy to use when pulling a single branch.26292630push.default::2631 Defines the action `git push` should take if no refspec is2632 explicitly given. Different values are well-suited for2633 specific workflows; for instance, in a purely central workflow2634 (i.e. the fetch source is equal to the push destination),2635 `upstream` is probably what you want. Possible values are:2636+2637--26382639* `nothing` - do not push anything (error out) unless a refspec is2640 explicitly given. This is primarily meant for people who want to2641 avoid mistakes by always being explicit.26422643* `current` - push the current branch to update a branch with the same2644 name on the receiving end. Works in both central and non-central2645 workflows.26462647* `upstream` - push the current branch back to the branch whose2648 changes are usually integrated into the current branch (which is2649 called `@{upstream}`). This mode only makes sense if you are2650 pushing to the same repository you would normally pull from2651 (i.e. central workflow).26522653* `tracking` - This is a deprecated synonym for `upstream`.26542655* `simple` - in centralized workflow, work like `upstream` with an2656 added safety to refuse to push if the upstream branch's name is2657 different from the local one.2658+2659When pushing to a remote that is different from the remote you normally2660pull from, work as `current`. This is the safest option and is suited2661for beginners.2662+2663This mode has become the default in Git 2.0.26642665* `matching` - push all branches having the same name on both ends.2666 This makes the repository you are pushing to remember the set of2667 branches that will be pushed out (e.g. if you always push 'maint'2668 and 'master' there and no other branches, the repository you push2669 to will have these two branches, and your local 'maint' and2670 'master' will be pushed there).2671+2672To use this mode effectively, you have to make sure _all_ the2673branches you would push out are ready to be pushed out before2674running 'git push', as the whole point of this mode is to allow you2675to push all of the branches in one go. If you usually finish work2676on only one branch and push out the result, while other branches are2677unfinished, this mode is not for you. Also this mode is not2678suitable for pushing into a shared central repository, as other2679people may add new branches there, or update the tip of existing2680branches outside your control.2681+2682This used to be the default, but not since Git 2.0 (`simple` is the2683new default).26842685--26862687push.followTags::2688 If set to true enable `--follow-tags` option by default. You2689 may override this configuration at time of push by specifying2690 `--no-follow-tags`.26912692push.gpgSign::2693 May be set to a boolean value, or the string 'if-asked'. A true2694 value causes all pushes to be GPG signed, as if `--signed` is2695 passed to linkgit:git-push[1]. The string 'if-asked' causes2696 pushes to be signed if the server supports it, as if2697 `--signed=if-asked` is passed to 'git push'. A false value may2698 override a value from a lower-priority config file. An explicit2699 command-line flag always overrides this config option.27002701push.pushOption::2702 When no `--push-option=<option>` argument is given from the2703 command line, `git push` behaves as if each <value> of2704 this variable is given as `--push-option=<value>`.2705+2706This is a multi-valued variable, and an empty value can be used in a2707higher priority configuration file (e.g. `.git/config` in a2708repository) to clear the values inherited from a lower priority2709configuration files (e.g. `$HOME/.gitconfig`).2710+2711--27122713Example:27142715/etc/gitconfig2716 push.pushoption = a2717 push.pushoption = b27182719~/.gitconfig2720 push.pushoption = c27212722repo/.git/config2723 push.pushoption =2724 push.pushoption = b27252726This will result in only b (a and c are cleared).27272728--27292730push.recurseSubmodules::2731 Make sure all submodule commits used by the revisions to be pushed2732 are available on a remote-tracking branch. If the value is 'check'2733 then Git will verify that all submodule commits that changed in the2734 revisions to be pushed are available on at least one remote of the2735 submodule. If any commits are missing, the push will be aborted and2736 exit with non-zero status. If the value is 'on-demand' then all2737 submodules that changed in the revisions to be pushed will be2738 pushed. If on-demand was not able to push all necessary revisions2739 it will also be aborted and exit with non-zero status. If the value2740 is 'no' then default behavior of ignoring submodules when pushing2741 is retained. You may override this configuration at time of push by2742 specifying '--recurse-submodules=check|on-demand|no'.27432744include::rebase-config.txt[]27452746receive.advertiseAtomic::2747 By default, git-receive-pack will advertise the atomic push2748 capability to its clients. If you don't want to advertise this2749 capability, set this variable to false.27502751receive.advertisePushOptions::2752 When set to true, git-receive-pack will advertise the push options2753 capability to its clients. False by default.27542755receive.autogc::2756 By default, git-receive-pack will run "git-gc --auto" after2757 receiving data from git-push and updating refs. You can stop2758 it by setting this variable to false.27592760receive.certNonceSeed::2761 By setting this variable to a string, `git receive-pack`2762 will accept a `git push --signed` and verifies it by using2763 a "nonce" protected by HMAC using this string as a secret2764 key.27652766receive.certNonceSlop::2767 When a `git push --signed` sent a push certificate with a2768 "nonce" that was issued by a receive-pack serving the same2769 repository within this many seconds, export the "nonce"2770 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2771 hooks (instead of what the receive-pack asked the sending2772 side to include). This may allow writing checks in2773 `pre-receive` and `post-receive` a bit easier. Instead of2774 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2775 that records by how many seconds the nonce is stale to2776 decide if they want to accept the certificate, they only2777 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.27782779receive.fsckObjects::2780 If it is set to true, git-receive-pack will check all received2781 objects. It will abort in the case of a malformed object or a2782 broken link. The result of an abort are only dangling objects.2783 Defaults to false. If not set, the value of `transfer.fsckObjects`2784 is used instead.27852786receive.fsck.<msg-id>::2787 When `receive.fsckObjects` is set to true, errors can be switched2788 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2789 setting where the `<msg-id>` is the fsck message ID and the value2790 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2791 the error/warning with the message ID, e.g. "missingEmail: invalid2792 author/committer line - missing email" means that setting2793 `receive.fsck.missingEmail = ignore` will hide that issue.2794+2795This feature is intended to support working with legacy repositories2796which would not pass pushing when `receive.fsckObjects = true`, allowing2797the host to accept repositories with certain known issues but still catch2798other issues.27992800receive.fsck.skipList::2801 The path to a sorted list of object names (i.e. one SHA-1 per2802 line) that are known to be broken in a non-fatal way and should2803 be ignored. This feature is useful when an established project2804 should be accepted despite early commits containing errors that2805 can be safely ignored such as invalid committer email addresses.2806 Note: corrupt objects cannot be skipped with this setting.28072808receive.keepAlive::2809 After receiving the pack from the client, `receive-pack` may2810 produce no output (if `--quiet` was specified) while processing2811 the pack, causing some networks to drop the TCP connection.2812 With this option set, if `receive-pack` does not transmit2813 any data in this phase for `receive.keepAlive` seconds, it will2814 send a short keepalive packet. The default is 5 seconds; set2815 to 0 to disable keepalives entirely.28162817receive.unpackLimit::2818 If the number of objects received in a push is below this2819 limit then the objects will be unpacked into loose object2820 files. However if the number of received objects equals or2821 exceeds this limit then the received pack will be stored as2822 a pack, after adding any missing delta bases. Storing the2823 pack from a push can make the push operation complete faster,2824 especially on slow filesystems. If not set, the value of2825 `transfer.unpackLimit` is used instead.28262827receive.maxInputSize::2828 If the size of the incoming pack stream is larger than this2829 limit, then git-receive-pack will error out, instead of2830 accepting the pack file. If not set or set to 0, then the size2831 is unlimited.28322833receive.denyDeletes::2834 If set to true, git-receive-pack will deny a ref update that deletes2835 the ref. Use this to prevent such a ref deletion via a push.28362837receive.denyDeleteCurrent::2838 If set to true, git-receive-pack will deny a ref update that2839 deletes the currently checked out branch of a non-bare repository.28402841receive.denyCurrentBranch::2842 If set to true or "refuse", git-receive-pack will deny a ref update2843 to the currently checked out branch of a non-bare repository.2844 Such a push is potentially dangerous because it brings the HEAD2845 out of sync with the index and working tree. If set to "warn",2846 print a warning of such a push to stderr, but allow the push to2847 proceed. If set to false or "ignore", allow such pushes with no2848 message. Defaults to "refuse".2849+2850Another option is "updateInstead" which will update the working2851tree if pushing into the current branch. This option is2852intended for synchronizing working directories when one side is not easily2853accessible via interactive ssh (e.g. a live web site, hence the requirement2854that the working directory be clean). This mode also comes in handy when2855developing inside a VM to test and fix code on different Operating Systems.2856+2857By default, "updateInstead" will refuse the push if the working tree or2858the index have any difference from the HEAD, but the `push-to-checkout`2859hook can be used to customize this. See linkgit:githooks[5].28602861receive.denyNonFastForwards::2862 If set to true, git-receive-pack will deny a ref update which is2863 not a fast-forward. Use this to prevent such an update via a push,2864 even if that push is forced. This configuration variable is2865 set when initializing a shared repository.28662867receive.hideRefs::2868 This variable is the same as `transfer.hideRefs`, but applies2869 only to `receive-pack` (and so affects pushes, but not fetches).2870 An attempt to update or delete a hidden ref by `git push` is2871 rejected.28722873receive.updateServerInfo::2874 If set to true, git-receive-pack will run git-update-server-info2875 after receiving data from git-push and updating refs.28762877receive.shallowUpdate::2878 If set to true, .git/shallow can be updated when new refs2879 require new shallow roots. Otherwise those refs are rejected.28802881remote.pushDefault::2882 The remote to push to by default. Overrides2883 `branch.<name>.remote` for all branches, and is overridden by2884 `branch.<name>.pushRemote` for specific branches.28852886remote.<name>.url::2887 The URL of a remote repository. See linkgit:git-fetch[1] or2888 linkgit:git-push[1].28892890remote.<name>.pushurl::2891 The push URL of a remote repository. See linkgit:git-push[1].28922893remote.<name>.proxy::2894 For remotes that require curl (http, https and ftp), the URL to2895 the proxy to use for that remote. Set to the empty string to2896 disable proxying for that remote.28972898remote.<name>.proxyAuthMethod::2899 For remotes that require curl (http, https and ftp), the method to use for2900 authenticating against the proxy in use (probably set in2901 `remote.<name>.proxy`). See `http.proxyAuthMethod`.29022903remote.<name>.fetch::2904 The default set of "refspec" for linkgit:git-fetch[1]. See2905 linkgit:git-fetch[1].29062907remote.<name>.push::2908 The default set of "refspec" for linkgit:git-push[1]. See2909 linkgit:git-push[1].29102911remote.<name>.mirror::2912 If true, pushing to this remote will automatically behave2913 as if the `--mirror` option was given on the command line.29142915remote.<name>.skipDefaultUpdate::2916 If true, this remote will be skipped by default when updating2917 using linkgit:git-fetch[1] or the `update` subcommand of2918 linkgit:git-remote[1].29192920remote.<name>.skipFetchAll::2921 If true, this remote will be skipped by default when updating2922 using linkgit:git-fetch[1] or the `update` subcommand of2923 linkgit:git-remote[1].29242925remote.<name>.receivepack::2926 The default program to execute on the remote side when pushing. See2927 option --receive-pack of linkgit:git-push[1].29282929remote.<name>.uploadpack::2930 The default program to execute on the remote side when fetching. See2931 option --upload-pack of linkgit:git-fetch-pack[1].29322933remote.<name>.tagOpt::2934 Setting this value to --no-tags disables automatic tag following when2935 fetching from remote <name>. Setting it to --tags will fetch every2936 tag from remote <name>, even if they are not reachable from remote2937 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2938 override this setting. See options --tags and --no-tags of2939 linkgit:git-fetch[1].29402941remote.<name>.vcs::2942 Setting this to a value <vcs> will cause Git to interact with2943 the remote with the git-remote-<vcs> helper.29442945remote.<name>.prune::2946 When set to true, fetching from this remote by default will also2947 remove any remote-tracking references that no longer exist on the2948 remote (as if the `--prune` option was given on the command line).2949 Overrides `fetch.prune` settings, if any.29502951remotes.<group>::2952 The list of remotes which are fetched by "git remote update2953 <group>". See linkgit:git-remote[1].29542955repack.useDeltaBaseOffset::2956 By default, linkgit:git-repack[1] creates packs that use2957 delta-base offset. If you need to share your repository with2958 Git older than version 1.4.4, either directly or via a dumb2959 protocol such as http, then you need to set this option to2960 "false" and repack. Access from old Git versions over the2961 native protocol are unaffected by this option.29622963repack.packKeptObjects::2964 If set to true, makes `git repack` act as if2965 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2966 details. Defaults to `false` normally, but `true` if a bitmap2967 index is being written (either via `--write-bitmap-index` or2968 `repack.writeBitmaps`).29692970repack.writeBitmaps::2971 When true, git will write a bitmap index when packing all2972 objects to disk (e.g., when `git repack -a` is run). This2973 index can speed up the "counting objects" phase of subsequent2974 packs created for clones and fetches, at the cost of some disk2975 space and extra time spent on the initial repack. This has2976 no effect if multiple packfiles are created.2977 Defaults to false.29782979rerere.autoUpdate::2980 When set to true, `git-rerere` updates the index with the2981 resulting contents after it cleanly resolves conflicts using2982 previously recorded resolution. Defaults to false.29832984rerere.enabled::2985 Activate recording of resolved conflicts, so that identical2986 conflict hunks can be resolved automatically, should they be2987 encountered again. By default, linkgit:git-rerere[1] is2988 enabled if there is an `rr-cache` directory under the2989 `$GIT_DIR`, e.g. if "rerere" was previously used in the2990 repository.29912992sendemail.identity::2993 A configuration identity. When given, causes values in the2994 'sendemail.<identity>' subsection to take precedence over2995 values in the 'sendemail' section. The default identity is2996 the value of `sendemail.identity`.29972998sendemail.smtpEncryption::2999 See linkgit:git-send-email[1] for description. Note that this3000 setting is not subject to the 'identity' mechanism.30013002sendemail.smtpssl (deprecated)::3003 Deprecated alias for 'sendemail.smtpEncryption = ssl'.30043005sendemail.smtpsslcertpath::3006 Path to ca-certificates (either a directory or a single file).3007 Set it to an empty string to disable certificate verification.30083009sendemail.<identity>.*::3010 Identity-specific versions of the 'sendemail.*' parameters3011 found below, taking precedence over those when this3012 identity is selected, through either the command-line or3013 `sendemail.identity`.30143015sendemail.aliasesFile::3016sendemail.aliasFileType::3017sendemail.annotate::3018sendemail.bcc::3019sendemail.cc::3020sendemail.ccCmd::3021sendemail.chainReplyTo::3022sendemail.confirm::3023sendemail.envelopeSender::3024sendemail.from::3025sendemail.multiEdit::3026sendemail.signedoffbycc::3027sendemail.smtpPass::3028sendemail.suppresscc::3029sendemail.suppressFrom::3030sendemail.to::3031sendemail.tocmd::3032sendemail.smtpDomain::3033sendemail.smtpServer::3034sendemail.smtpServerPort::3035sendemail.smtpServerOption::3036sendemail.smtpUser::3037sendemail.thread::3038sendemail.transferEncoding::3039sendemail.validate::3040sendemail.xmailer::3041 See linkgit:git-send-email[1] for description.30423043sendemail.signedoffcc (deprecated)::3044 Deprecated alias for `sendemail.signedoffbycc`.30453046sendemail.smtpBatchSize::3047 Number of messages to be sent per connection, after that a relogin3048 will happen. If the value is 0 or undefined, send all messages in3049 one connection.3050 See also the `--batch-size` option of linkgit:git-send-email[1].30513052sendemail.smtpReloginDelay::3053 Seconds wait before reconnecting to smtp server.3054 See also the `--relogin-delay` option of linkgit:git-send-email[1].30553056showbranch.default::3057 The default set of branches for linkgit:git-show-branch[1].3058 See linkgit:git-show-branch[1].30593060splitIndex.maxPercentChange::3061 When the split index feature is used, this specifies the3062 percent of entries the split index can contain compared to the3063 total number of entries in both the split index and the shared3064 index before a new shared index is written.3065 The value should be between 0 and 100. If the value is 0 then3066 a new shared index is always written, if it is 100 a new3067 shared index is never written.3068 By default the value is 20, so a new shared index is written3069 if the number of entries in the split index would be greater3070 than 20 percent of the total number of entries.3071 See linkgit:git-update-index[1].30723073splitIndex.sharedIndexExpire::3074 When the split index feature is used, shared index files that3075 were not modified since the time this variable specifies will3076 be removed when a new shared index file is created. The value3077 "now" expires all entries immediately, and "never" suppresses3078 expiration altogether.3079 The default value is "2.weeks.ago".3080 Note that a shared index file is considered modified (for the3081 purpose of expiration) each time a new split-index file is3082 either created based on it or read from it.3083 See linkgit:git-update-index[1].30843085status.relativePaths::3086 By default, linkgit:git-status[1] shows paths relative to the3087 current directory. Setting this variable to `false` shows paths3088 relative to the repository root (this was the default for Git3089 prior to v1.5.4).30903091status.short::3092 Set to true to enable --short by default in linkgit:git-status[1].3093 The option --no-short takes precedence over this variable.30943095status.branch::3096 Set to true to enable --branch by default in linkgit:git-status[1].3097 The option --no-branch takes precedence over this variable.30983099status.displayCommentPrefix::3100 If set to true, linkgit:git-status[1] will insert a comment3101 prefix before each output line (starting with3102 `core.commentChar`, i.e. `#` by default). This was the3103 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.3104 Defaults to false.31053106status.showStash::3107 If set to true, linkgit:git-status[1] will display the number of3108 entries currently stashed away.3109 Defaults to false.31103111status.showUntrackedFiles::3112 By default, linkgit:git-status[1] and linkgit:git-commit[1] show3113 files which are not currently tracked by Git. Directories which3114 contain only untracked files, are shown with the directory name3115 only. Showing untracked files means that Git needs to lstat() all3116 the files in the whole repository, which might be slow on some3117 systems. So, this variable controls how the commands displays3118 the untracked files. Possible values are:3119+3120--3121* `no` - Show no untracked files.3122* `normal` - Show untracked files and directories.3123* `all` - Show also individual files in untracked directories.3124--3125+3126If this variable is not specified, it defaults to 'normal'.3127This variable can be overridden with the -u|--untracked-files option3128of linkgit:git-status[1] and linkgit:git-commit[1].31293130status.submoduleSummary::3131 Defaults to false.3132 If this is set to a non zero number or true (identical to -1 or an3133 unlimited number), the submodule summary will be enabled and a3134 summary of commits for modified submodules will be shown (see3135 --summary-limit option of linkgit:git-submodule[1]). Please note3136 that the summary output command will be suppressed for all3137 submodules when `diff.ignoreSubmodules` is set to 'all' or only3138 for those submodules where `submodule.<name>.ignore=all`. The only3139 exception to that rule is that status and commit will show staged3140 submodule changes. To3141 also view the summary for ignored submodules you can either use3142 the --ignore-submodules=dirty command-line option or the 'git3143 submodule summary' command, which shows a similar output but does3144 not honor these settings.31453146stash.showPatch::3147 If this is set to true, the `git stash show` command without an3148 option will show the stash entry in patch form. Defaults to false.3149 See description of 'show' command in linkgit:git-stash[1].31503151stash.showStat::3152 If this is set to true, the `git stash show` command without an3153 option will show diffstat of the stash entry. Defaults to true.3154 See description of 'show' command in linkgit:git-stash[1].31553156submodule.<name>.url::3157 The URL for a submodule. This variable is copied from the .gitmodules3158 file to the git config via 'git submodule init'. The user can change3159 the configured URL before obtaining the submodule via 'git submodule3160 update'. If neither submodule.<name>.active or submodule.active are3161 set, the presence of this variable is used as a fallback to indicate3162 whether the submodule is of interest to git commands.3163 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.31643165submodule.<name>.update::3166 The method by which a submodule is updated by 'git submodule update',3167 which is the only affected command, others such as3168 'git checkout --recurse-submodules' are unaffected. It exists for3169 historical reasons, when 'git submodule' was the only command to3170 interact with submodules; settings like `submodule.active`3171 and `pull.rebase` are more specific. It is populated by3172 `git submodule init` from the linkgit:gitmodules[5] file.3173 See description of 'update' command in linkgit:git-submodule[1].31743175submodule.<name>.branch::3176 The remote branch name for a submodule, used by `git submodule3177 update --remote`. Set this option to override the value found in3178 the `.gitmodules` file. See linkgit:git-submodule[1] and3179 linkgit:gitmodules[5] for details.31803181submodule.<name>.fetchRecurseSubmodules::3182 This option can be used to control recursive fetching of this3183 submodule. It can be overridden by using the --[no-]recurse-submodules3184 command-line option to "git fetch" and "git pull".3185 This setting will override that from in the linkgit:gitmodules[5]3186 file.31873188submodule.<name>.ignore::3189 Defines under what circumstances "git status" and the diff family show3190 a submodule as modified. When set to "all", it will never be considered3191 modified (but it will nonetheless show up in the output of status and3192 commit when it has been staged), "dirty" will ignore all changes3193 to the submodules work tree and3194 takes only differences between the HEAD of the submodule and the commit3195 recorded in the superproject into account. "untracked" will additionally3196 let submodules with modified tracked files in their work tree show up.3197 Using "none" (the default when this option is not set) also shows3198 submodules that have untracked files in their work tree as changed.3199 This setting overrides any setting made in .gitmodules for this submodule,3200 both settings can be overridden on the command line by using the3201 "--ignore-submodules" option. The 'git submodule' commands are not3202 affected by this setting.32033204submodule.<name>.active::3205 Boolean value indicating if the submodule is of interest to git3206 commands. This config option takes precedence over the3207 submodule.active config option.32083209submodule.active::3210 A repeated field which contains a pathspec used to match against a3211 submodule's path to determine if the submodule is of interest to git3212 commands.32133214submodule.recurse::3215 Specifies if commands recurse into submodules by default. This3216 applies to all commands that have a `--recurse-submodules` option.3217 Defaults to false.32183219submodule.fetchJobs::3220 Specifies how many submodules are fetched/cloned at the same time.3221 A positive integer allows up to that number of submodules fetched3222 in parallel. A value of 0 will give some reasonable default.3223 If unset, it defaults to 1.32243225submodule.alternateLocation::3226 Specifies how the submodules obtain alternates when submodules are3227 cloned. Possible values are `no`, `superproject`.3228 By default `no` is assumed, which doesn't add references. When the3229 value is set to `superproject` the submodule to be cloned computes3230 its alternates location relative to the superprojects alternate.32313232submodule.alternateErrorStrategy::3233 Specifies how to treat errors with the alternates for a submodule3234 as computed via `submodule.alternateLocation`. Possible values are3235 `ignore`, `info`, `die`. Default is `die`.32363237tag.forceSignAnnotated::3238 A boolean to specify whether annotated tags created should be GPG signed.3239 If `--annotate` is specified on the command line, it takes3240 precedence over this option.32413242tag.sort::3243 This variable controls the sort ordering of tags when displayed by3244 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the3245 value of this variable will be used as the default.32463247tar.umask::3248 This variable can be used to restrict the permission bits of3249 tar archive entries. The default is 0002, which turns off the3250 world write bit. The special value "user" indicates that the3251 archiving user's umask will be used instead. See umask(2) and3252 linkgit:git-archive[1].32533254transfer.fsckObjects::3255 When `fetch.fsckObjects` or `receive.fsckObjects` are3256 not set, the value of this variable is used instead.3257 Defaults to false.32583259transfer.hideRefs::3260 String(s) `receive-pack` and `upload-pack` use to decide which3261 refs to omit from their initial advertisements. Use more than3262 one definition to specify multiple prefix strings. A ref that is3263 under the hierarchies listed in the value of this variable is3264 excluded, and is hidden when responding to `git push` or `git3265 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for3266 program-specific versions of this config.3267+3268You may also include a `!` in front of the ref name to negate the entry,3269explicitly exposing it, even if an earlier entry marked it as hidden.3270If you have multiple hideRefs values, later entries override earlier ones3271(and entries in more-specific config files override less-specific ones).3272+3273If a namespace is in use, the namespace prefix is stripped from each3274reference before it is matched against `transfer.hiderefs` patterns.3275For example, if `refs/heads/master` is specified in `transfer.hideRefs` and3276the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`3277is omitted from the advertisements but `refs/heads/master` and3278`refs/namespaces/bar/refs/heads/master` are still advertised as so-called3279"have" lines. In order to match refs before stripping, add a `^` in front of3280the ref name. If you combine `!` and `^`, `!` must be specified first.3281+3282Even if you hide refs, a client may still be able to steal the target3283objects via the techniques described in the "SECURITY" section of the3284linkgit:gitnamespaces[7] man page; it's best to keep private data in a3285separate repository.32863287transfer.unpackLimit::3288 When `fetch.unpackLimit` or `receive.unpackLimit` are3289 not set, the value of this variable is used instead.3290 The default value is 100.32913292uploadarchive.allowUnreachable::3293 If true, allow clients to use `git archive --remote` to request3294 any tree, whether reachable from the ref tips or not. See the3295 discussion in the "SECURITY" section of3296 linkgit:git-upload-archive[1] for more details. Defaults to3297 `false`.32983299uploadpack.hideRefs::3300 This variable is the same as `transfer.hideRefs`, but applies3301 only to `upload-pack` (and so affects only fetches, not pushes).3302 An attempt to fetch a hidden ref by `git fetch` will fail. See3303 also `uploadpack.allowTipSHA1InWant`.33043305uploadpack.allowTipSHA1InWant::3306 When `uploadpack.hideRefs` is in effect, allow `upload-pack`3307 to accept a fetch request that asks for an object at the tip3308 of a hidden ref (by default, such a request is rejected).3309 See also `uploadpack.hideRefs`. Even if this is false, a client3310 may be able to steal objects via the techniques described in the3311 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's3312 best to keep private data in a separate repository.33133314uploadpack.allowReachableSHA1InWant::3315 Allow `upload-pack` to accept a fetch request that asks for an3316 object that is reachable from any ref tip. However, note that3317 calculating object reachability is computationally expensive.3318 Defaults to `false`. Even if this is false, a client may be able3319 to steal objects via the techniques described in the "SECURITY"3320 section of the linkgit:gitnamespaces[7] man page; it's best to3321 keep private data in a separate repository.33223323uploadpack.allowAnySHA1InWant::3324 Allow `upload-pack` to accept a fetch request that asks for any3325 object at all.3326 Defaults to `false`.33273328uploadpack.keepAlive::3329 When `upload-pack` has started `pack-objects`, there may be a3330 quiet period while `pack-objects` prepares the pack. Normally3331 it would output progress information, but if `--quiet` was used3332 for the fetch, `pack-objects` will output nothing at all until3333 the pack data begins. Some clients and networks may consider3334 the server to be hung and give up. Setting this option instructs3335 `upload-pack` to send an empty keepalive packet every3336 `uploadpack.keepAlive` seconds. Setting this option to 03337 disables keepalive packets entirely. The default is 5 seconds.33383339uploadpack.packObjectsHook::3340 If this option is set, when `upload-pack` would run3341 `git pack-objects` to create a packfile for a client, it will3342 run this shell command instead. The `pack-objects` command and3343 arguments it _would_ have run (including the `git pack-objects`3344 at the beginning) are appended to the shell command. The stdin3345 and stdout of the hook are treated as if `pack-objects` itself3346 was run. I.e., `upload-pack` will feed input intended for3347 `pack-objects` to the hook, and expects a completed packfile on3348 stdout.3349+3350Note that this configuration variable is ignored if it is seen in the3351repository-level config (this is a safety measure against fetching from3352untrusted repositories).33533354url.<base>.insteadOf::3355 Any URL that starts with this value will be rewritten to3356 start, instead, with <base>. In cases where some site serves a3357 large number of repositories, and serves them with multiple3358 access methods, and some users need to use different access3359 methods, this feature allows people to specify any of the3360 equivalent URLs and have Git automatically rewrite the URL to3361 the best alternative for the particular user, even for a3362 never-before-seen repository on the site. When more than one3363 insteadOf strings match a given URL, the longest match is used.3364+3365Note that any protocol restrictions will be applied to the rewritten3366URL. If the rewrite changes the URL to use a custom protocol or remote3367helper, you may need to adjust the `protocol.*.allow` config to permit3368the request. In particular, protocols you expect to use for submodules3369must be set to `always` rather than the default of `user`. See the3370description of `protocol.allow` above.33713372url.<base>.pushInsteadOf::3373 Any URL that starts with this value will not be pushed to;3374 instead, it will be rewritten to start with <base>, and the3375 resulting URL will be pushed to. In cases where some site serves3376 a large number of repositories, and serves them with multiple3377 access methods, some of which do not allow push, this feature3378 allows people to specify a pull-only URL and have Git3379 automatically use an appropriate URL to push, even for a3380 never-before-seen repository on the site. When more than one3381 pushInsteadOf strings match a given URL, the longest match is3382 used. If a remote has an explicit pushurl, Git will ignore this3383 setting for that remote.33843385user.email::3386 Your email address to be recorded in any newly created commits.3387 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and3388 `EMAIL` environment variables. See linkgit:git-commit-tree[1].33893390user.name::3391 Your full name to be recorded in any newly created commits.3392 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`3393 environment variables. See linkgit:git-commit-tree[1].33943395user.useConfigOnly::3396 Instruct Git to avoid trying to guess defaults for `user.email`3397 and `user.name`, and instead retrieve the values only from the3398 configuration. For example, if you have multiple email addresses3399 and would like to use a different one for each repository, then3400 with this configuration option set to `true` in the global config3401 along with a name, Git will prompt you to set up an email before3402 making new commits in a newly cloned repository.3403 Defaults to `false`.34043405user.signingKey::3406 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the3407 key you want it to automatically when creating a signed tag or3408 commit, you can override the default selection with this variable.3409 This option is passed unchanged to gpg's --local-user parameter,3410 so you may specify a key using any method that gpg supports.34113412versionsort.prereleaseSuffix (deprecated)::3413 Deprecated alias for `versionsort.suffix`. Ignored if3414 `versionsort.suffix` is set.34153416versionsort.suffix::3417 Even when version sort is used in linkgit:git-tag[1], tagnames3418 with the same base version but different suffixes are still sorted3419 lexicographically, resulting e.g. in prerelease tags appearing3420 after the main release (e.g. "1.0-rc1" after "1.0"). This3421 variable can be specified to determine the sorting order of tags3422 with different suffixes.3423+3424By specifying a single suffix in this variable, any tagname containing3425that suffix will appear before the corresponding main release. E.g. if3426the variable is set to "-rc", then all "1.0-rcX" tags will appear before3427"1.0". If specified multiple times, once per suffix, then the order of3428suffixes in the configuration will determine the sorting order of tagnames3429with those suffixes. E.g. if "-pre" appears before "-rc" in the3430configuration, then all "1.0-preX" tags will be listed before any3431"1.0-rcX" tags. The placement of the main release tag relative to tags3432with various suffixes can be determined by specifying the empty suffix3433among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and3434"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags3435are listed first, followed by "v4.8", then "v4.8-ckX" and finally3436"v4.8-bfsX".3437+3438If more than one suffixes match the same tagname, then that tagname will3439be sorted according to the suffix which starts at the earliest position in3440the tagname. If more than one different matching suffixes start at3441that earliest position, then that tagname will be sorted according to the3442longest of those suffixes.3443The sorting order between different suffixes is undefined if they are3444in multiple config files.34453446web.browser::3447 Specify a web browser that may be used by some commands.3448 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3449 may use it.34503451worktree.guessRemote::3452 With `add`, if no branch argument, and neither of `-b` nor3453 `-B` nor `--detach` are given, the command defaults to3454 creating a new branch from HEAD. If `worktree.guessRemote` is3455 set to true, `worktree add` tries to find a remote-tracking3456 branch whose name uniquely matches the new branch name. If3457 such a branch exists, it is checked out and set as "upstream"3458 for the new branch. If no such match can be found, it falls3459 back to creating a new branch from the current HEAD.