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 a value to its canonical form using the `--type=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 290include::config/advice.txt[] 291 292include::config/core.txt[] 293 294include::config/add.txt[] 295 296include::config/alias.txt[] 297 298include::config/am.txt[] 299 300include::config/apply.txt[] 301 302include::config/blame.txt[] 303 304include::config/branch.txt[] 305 306include::config/browser.txt[] 307 308include::config/checkout.txt[] 309 310include::config/clean.txt[] 311 312include::config/color.txt[] 313 314include::config/column.txt[] 315 316include::config/commit.txt[] 317 318include::config/credential.txt[] 319 320include::config/completion.txt[] 321 322include::config/diff.txt[] 323 324include::config/difftool.txt[] 325 326include::config/fastimport.txt[] 327 328include::config/fetch.txt[] 329 330include::config/format.txt[] 331 332include::config/filter.txt[] 333 334include::config/fsck.txt[] 335 336include::config/gc.txt[] 337 338include::config/gitcvs.txt[] 339 340include::config/gitweb.txt[] 341 342include::config/grep.txt[] 343 344include::config/gpg.txt[] 345 346include::config/gui.txt[] 347 348include::config/guitool.txt[] 349 350include::config/help.txt[] 351 352include::config/http.txt[] 353 354include::config/i18n.txt[] 355 356include::config/imap.txt[] 357 358include::config/index.txt[] 359 360include::config/init.txt[] 361 362include::config/instaweb.txt[] 363 364include::config/interactive.txt[] 365 366include::config/log.txt[] 367 368include::config/mailinfo.txt[] 369 370include::config/mailmap.txt[] 371 372include::config/man.txt[] 373 374include::config/merge.txt[] 375 376include::config/mergetool.txt[] 377 378include::config/notes.txt[] 379 380include::config/pack.txt[] 381 382pager.<cmd>:: 383 If the value is boolean, turns on or off pagination of the 384 output of a particular Git subcommand when writing to a tty. 385 Otherwise, turns on pagination for the subcommand using the 386 pager specified by the value of `pager.<cmd>`. If `--paginate` 387 or `--no-pager` is specified on the command line, it takes 388 precedence over this option. To disable pagination for all 389 commands, set `core.pager` or `GIT_PAGER` to `cat`. 390 391pretty.<name>:: 392 Alias for a --pretty= format string, as specified in 393 linkgit:git-log[1]. Any aliases defined here can be used just 394 as the built-in pretty formats could. For example, 395 running `git config pretty.changelog "format:* %H %s"` 396 would cause the invocation `git log --pretty=changelog` 397 to be equivalent to running `git log "--pretty=format:* %H %s"`. 398 Note that an alias with the same name as a built-in format 399 will be silently ignored. 400 401protocol.allow:: 402 If set, provide a user defined default policy for all protocols which 403 don't explicitly have a policy (`protocol.<name>.allow`). By default, 404 if unset, known-safe protocols (http, https, git, ssh, file) have a 405 default policy of `always`, known-dangerous protocols (ext) have a 406 default policy of `never`, and all other protocols have a default 407 policy of `user`. Supported policies: 408+ 409-- 410 411* `always` - protocol is always able to be used. 412 413* `never` - protocol is never able to be used. 414 415* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is 416 either unset or has a value of 1. This policy should be used when you want a 417 protocol to be directly usable by the user but don't want it used by commands which 418 execute clone/fetch/push commands without user input, e.g. recursive 419 submodule initialization. 420 421-- 422 423protocol.<name>.allow:: 424 Set a policy to be used by protocol `<name>` with clone/fetch/push 425 commands. See `protocol.allow` above for the available policies. 426+ 427The protocol names currently used by git are: 428+ 429-- 430 - `file`: any local file-based path (including `file://` URLs, 431 or local paths) 432 433 - `git`: the anonymous git protocol over a direct TCP 434 connection (or proxy, if configured) 435 436 - `ssh`: git over ssh (including `host:path` syntax, 437 `ssh://`, etc). 438 439 - `http`: git over http, both "smart http" and "dumb http". 440 Note that this does _not_ include `https`; if you want to configure 441 both, you must do so individually. 442 443 - any external helpers are named by their protocol (e.g., use 444 `hg` to allow the `git-remote-hg` helper) 445-- 446 447protocol.version:: 448 Experimental. If set, clients will attempt to communicate with a 449 server using the specified protocol version. If unset, no 450 attempt will be made by the client to communicate using a 451 particular protocol version, this results in protocol version 0 452 being used. 453 Supported versions: 454+ 455-- 456 457* `0` - the original wire protocol. 458 459* `1` - the original wire protocol with the addition of a version string 460 in the initial response from the server. 461 462* `2` - link:technical/protocol-v2.html[wire protocol version 2]. 463 464-- 465 466include::pull-config.txt[] 467 468include::push-config.txt[] 469 470include::rebase-config.txt[] 471 472include::receive-config.txt[] 473 474remote.pushDefault:: 475 The remote to push to by default. Overrides 476 `branch.<name>.remote` for all branches, and is overridden by 477 `branch.<name>.pushRemote` for specific branches. 478 479remote.<name>.url:: 480 The URL of a remote repository. See linkgit:git-fetch[1] or 481 linkgit:git-push[1]. 482 483remote.<name>.pushurl:: 484 The push URL of a remote repository. See linkgit:git-push[1]. 485 486remote.<name>.proxy:: 487 For remotes that require curl (http, https and ftp), the URL to 488 the proxy to use for that remote. Set to the empty string to 489 disable proxying for that remote. 490 491remote.<name>.proxyAuthMethod:: 492 For remotes that require curl (http, https and ftp), the method to use for 493 authenticating against the proxy in use (probably set in 494 `remote.<name>.proxy`). See `http.proxyAuthMethod`. 495 496remote.<name>.fetch:: 497 The default set of "refspec" for linkgit:git-fetch[1]. See 498 linkgit:git-fetch[1]. 499 500remote.<name>.push:: 501 The default set of "refspec" for linkgit:git-push[1]. See 502 linkgit:git-push[1]. 503 504remote.<name>.mirror:: 505 If true, pushing to this remote will automatically behave 506 as if the `--mirror` option was given on the command line. 507 508remote.<name>.skipDefaultUpdate:: 509 If true, this remote will be skipped by default when updating 510 using linkgit:git-fetch[1] or the `update` subcommand of 511 linkgit:git-remote[1]. 512 513remote.<name>.skipFetchAll:: 514 If true, this remote will be skipped by default when updating 515 using linkgit:git-fetch[1] or the `update` subcommand of 516 linkgit:git-remote[1]. 517 518remote.<name>.receivepack:: 519 The default program to execute on the remote side when pushing. See 520 option --receive-pack of linkgit:git-push[1]. 521 522remote.<name>.uploadpack:: 523 The default program to execute on the remote side when fetching. See 524 option --upload-pack of linkgit:git-fetch-pack[1]. 525 526remote.<name>.tagOpt:: 527 Setting this value to --no-tags disables automatic tag following when 528 fetching from remote <name>. Setting it to --tags will fetch every 529 tag from remote <name>, even if they are not reachable from remote 530 branch heads. Passing these flags directly to linkgit:git-fetch[1] can 531 override this setting. See options --tags and --no-tags of 532 linkgit:git-fetch[1]. 533 534remote.<name>.vcs:: 535 Setting this to a value <vcs> will cause Git to interact with 536 the remote with the git-remote-<vcs> helper. 537 538remote.<name>.prune:: 539 When set to true, fetching from this remote by default will also 540 remove any remote-tracking references that no longer exist on the 541 remote (as if the `--prune` option was given on the command line). 542 Overrides `fetch.prune` settings, if any. 543 544remote.<name>.pruneTags:: 545 When set to true, fetching from this remote by default will also 546 remove any local tags that no longer exist on the remote if pruning 547 is activated in general via `remote.<name>.prune`, `fetch.prune` or 548 `--prune`. Overrides `fetch.pruneTags` settings, if any. 549+ 550See also `remote.<name>.prune` and the PRUNING section of 551linkgit:git-fetch[1]. 552 553remotes.<group>:: 554 The list of remotes which are fetched by "git remote update 555 <group>". See linkgit:git-remote[1]. 556 557repack.useDeltaBaseOffset:: 558 By default, linkgit:git-repack[1] creates packs that use 559 delta-base offset. If you need to share your repository with 560 Git older than version 1.4.4, either directly or via a dumb 561 protocol such as http, then you need to set this option to 562 "false" and repack. Access from old Git versions over the 563 native protocol are unaffected by this option. 564 565repack.packKeptObjects:: 566 If set to true, makes `git repack` act as if 567 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for 568 details. Defaults to `false` normally, but `true` if a bitmap 569 index is being written (either via `--write-bitmap-index` or 570 `repack.writeBitmaps`). 571 572repack.useDeltaIslands:: 573 If set to true, makes `git repack` act as if `--delta-islands` 574 was passed. Defaults to `false`. 575 576repack.writeBitmaps:: 577 When true, git will write a bitmap index when packing all 578 objects to disk (e.g., when `git repack -a` is run). This 579 index can speed up the "counting objects" phase of subsequent 580 packs created for clones and fetches, at the cost of some disk 581 space and extra time spent on the initial repack. This has 582 no effect if multiple packfiles are created. 583 Defaults to false. 584 585rerere.autoUpdate:: 586 When set to true, `git-rerere` updates the index with the 587 resulting contents after it cleanly resolves conflicts using 588 previously recorded resolution. Defaults to false. 589 590rerere.enabled:: 591 Activate recording of resolved conflicts, so that identical 592 conflict hunks can be resolved automatically, should they be 593 encountered again. By default, linkgit:git-rerere[1] is 594 enabled if there is an `rr-cache` directory under the 595 `$GIT_DIR`, e.g. if "rerere" was previously used in the 596 repository. 597 598reset.quiet:: 599 When set to true, 'git reset' will default to the '--quiet' option. 600 601include::sendemail-config.txt[] 602 603sequence.editor:: 604 Text editor used by `git rebase -i` for editing the rebase instruction file. 605 The value is meant to be interpreted by the shell when it is used. 606 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 607 When not configured the default commit message editor is used instead. 608 609showBranch.default:: 610 The default set of branches for linkgit:git-show-branch[1]. 611 See linkgit:git-show-branch[1]. 612 613splitIndex.maxPercentChange:: 614 When the split index feature is used, this specifies the 615 percent of entries the split index can contain compared to the 616 total number of entries in both the split index and the shared 617 index before a new shared index is written. 618 The value should be between 0 and 100. If the value is 0 then 619 a new shared index is always written, if it is 100 a new 620 shared index is never written. 621 By default the value is 20, so a new shared index is written 622 if the number of entries in the split index would be greater 623 than 20 percent of the total number of entries. 624 See linkgit:git-update-index[1]. 625 626splitIndex.sharedIndexExpire:: 627 When the split index feature is used, shared index files that 628 were not modified since the time this variable specifies will 629 be removed when a new shared index file is created. The value 630 "now" expires all entries immediately, and "never" suppresses 631 expiration altogether. 632 The default value is "2.weeks.ago". 633 Note that a shared index file is considered modified (for the 634 purpose of expiration) each time a new split-index file is 635 either created based on it or read from it. 636 See linkgit:git-update-index[1]. 637 638include::config/ssh.txt[] 639 640status.relativePaths:: 641 By default, linkgit:git-status[1] shows paths relative to the 642 current directory. Setting this variable to `false` shows paths 643 relative to the repository root (this was the default for Git 644 prior to v1.5.4). 645 646status.short:: 647 Set to true to enable --short by default in linkgit:git-status[1]. 648 The option --no-short takes precedence over this variable. 649 650status.branch:: 651 Set to true to enable --branch by default in linkgit:git-status[1]. 652 The option --no-branch takes precedence over this variable. 653 654status.displayCommentPrefix:: 655 If set to true, linkgit:git-status[1] will insert a comment 656 prefix before each output line (starting with 657 `core.commentChar`, i.e. `#` by default). This was the 658 behavior of linkgit:git-status[1] in Git 1.8.4 and previous. 659 Defaults to false. 660 661status.renameLimit:: 662 The number of files to consider when performing rename detection 663 in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to 664 the value of diff.renameLimit. 665 666status.renames:: 667 Whether and how Git detects renames in linkgit:git-status[1] and 668 linkgit:git-commit[1] . If set to "false", rename detection is 669 disabled. If set to "true", basic rename detection is enabled. 670 If set to "copies" or "copy", Git will detect copies, as well. 671 Defaults to the value of diff.renames. 672 673status.showStash:: 674 If set to true, linkgit:git-status[1] will display the number of 675 entries currently stashed away. 676 Defaults to false. 677 678status.showUntrackedFiles:: 679 By default, linkgit:git-status[1] and linkgit:git-commit[1] show 680 files which are not currently tracked by Git. Directories which 681 contain only untracked files, are shown with the directory name 682 only. Showing untracked files means that Git needs to lstat() all 683 the files in the whole repository, which might be slow on some 684 systems. So, this variable controls how the commands displays 685 the untracked files. Possible values are: 686+ 687-- 688* `no` - Show no untracked files. 689* `normal` - Show untracked files and directories. 690* `all` - Show also individual files in untracked directories. 691-- 692+ 693If this variable is not specified, it defaults to 'normal'. 694This variable can be overridden with the -u|--untracked-files option 695of linkgit:git-status[1] and linkgit:git-commit[1]. 696 697status.submoduleSummary:: 698 Defaults to false. 699 If this is set to a non zero number or true (identical to -1 or an 700 unlimited number), the submodule summary will be enabled and a 701 summary of commits for modified submodules will be shown (see 702 --summary-limit option of linkgit:git-submodule[1]). Please note 703 that the summary output command will be suppressed for all 704 submodules when `diff.ignoreSubmodules` is set to 'all' or only 705 for those submodules where `submodule.<name>.ignore=all`. The only 706 exception to that rule is that status and commit will show staged 707 submodule changes. To 708 also view the summary for ignored submodules you can either use 709 the --ignore-submodules=dirty command-line option or the 'git 710 submodule summary' command, which shows a similar output but does 711 not honor these settings. 712 713stash.showPatch:: 714 If this is set to true, the `git stash show` command without an 715 option will show the stash entry in patch form. Defaults to false. 716 See description of 'show' command in linkgit:git-stash[1]. 717 718stash.showStat:: 719 If this is set to true, the `git stash show` command without an 720 option will show diffstat of the stash entry. Defaults to true. 721 See description of 'show' command in linkgit:git-stash[1]. 722 723include::submodule-config.txt[] 724 725tag.forceSignAnnotated:: 726 A boolean to specify whether annotated tags created should be GPG signed. 727 If `--annotate` is specified on the command line, it takes 728 precedence over this option. 729 730tag.sort:: 731 This variable controls the sort ordering of tags when displayed by 732 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the 733 value of this variable will be used as the default. 734 735tar.umask:: 736 This variable can be used to restrict the permission bits of 737 tar archive entries. The default is 0002, which turns off the 738 world write bit. The special value "user" indicates that the 739 archiving user's umask will be used instead. See umask(2) and 740 linkgit:git-archive[1]. 741 742transfer.fsckObjects:: 743 When `fetch.fsckObjects` or `receive.fsckObjects` are 744 not set, the value of this variable is used instead. 745 Defaults to false. 746+ 747When set, the fetch or receive will abort in the case of a malformed 748object or a link to a nonexistent object. In addition, various other 749issues are checked for, including legacy issues (see `fsck.<msg-id>`), 750and potential security issues like the existence of a `.GIT` directory 751or a malicious `.gitmodules` file (see the release notes for v2.2.1 752and v2.17.1 for details). Other sanity and security checks may be 753added in future releases. 754+ 755On the receiving side, failing fsckObjects will make those objects 756unreachable, see "QUARANTINE ENVIRONMENT" in 757linkgit:git-receive-pack[1]. On the fetch side, malformed objects will 758instead be left unreferenced in the repository. 759+ 760Due to the non-quarantine nature of the `fetch.fsckObjects` 761implementation it can not be relied upon to leave the object store 762clean like `receive.fsckObjects` can. 763+ 764As objects are unpacked they're written to the object store, so there 765can be cases where malicious objects get introduced even though the 766"fetch" failed, only to have a subsequent "fetch" succeed because only 767new incoming objects are checked, not those that have already been 768written to the object store. That difference in behavior should not be 769relied upon. In the future, such objects may be quarantined for 770"fetch" as well. 771+ 772For now, the paranoid need to find some way to emulate the quarantine 773environment if they'd like the same protection as "push". E.g. in the 774case of an internal mirror do the mirroring in two steps, one to fetch 775the untrusted objects, and then do a second "push" (which will use the 776quarantine) to another internal repo, and have internal clients 777consume this pushed-to repository, or embargo internal fetches and 778only allow them once a full "fsck" has run (and no new fetches have 779happened in the meantime). 780 781transfer.hideRefs:: 782 String(s) `receive-pack` and `upload-pack` use to decide which 783 refs to omit from their initial advertisements. Use more than 784 one definition to specify multiple prefix strings. A ref that is 785 under the hierarchies listed in the value of this variable is 786 excluded, and is hidden when responding to `git push` or `git 787 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for 788 program-specific versions of this config. 789+ 790You may also include a `!` in front of the ref name to negate the entry, 791explicitly exposing it, even if an earlier entry marked it as hidden. 792If you have multiple hideRefs values, later entries override earlier ones 793(and entries in more-specific config files override less-specific ones). 794+ 795If a namespace is in use, the namespace prefix is stripped from each 796reference before it is matched against `transfer.hiderefs` patterns. 797For example, if `refs/heads/master` is specified in `transfer.hideRefs` and 798the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master` 799is omitted from the advertisements but `refs/heads/master` and 800`refs/namespaces/bar/refs/heads/master` are still advertised as so-called 801"have" lines. In order to match refs before stripping, add a `^` in front of 802the ref name. If you combine `!` and `^`, `!` must be specified first. 803+ 804Even if you hide refs, a client may still be able to steal the target 805objects via the techniques described in the "SECURITY" section of the 806linkgit:gitnamespaces[7] man page; it's best to keep private data in a 807separate repository. 808 809transfer.unpackLimit:: 810 When `fetch.unpackLimit` or `receive.unpackLimit` are 811 not set, the value of this variable is used instead. 812 The default value is 100. 813 814uploadarchive.allowUnreachable:: 815 If true, allow clients to use `git archive --remote` to request 816 any tree, whether reachable from the ref tips or not. See the 817 discussion in the "SECURITY" section of 818 linkgit:git-upload-archive[1] for more details. Defaults to 819 `false`. 820 821uploadpack.hideRefs:: 822 This variable is the same as `transfer.hideRefs`, but applies 823 only to `upload-pack` (and so affects only fetches, not pushes). 824 An attempt to fetch a hidden ref by `git fetch` will fail. See 825 also `uploadpack.allowTipSHA1InWant`. 826 827uploadpack.allowTipSHA1InWant:: 828 When `uploadpack.hideRefs` is in effect, allow `upload-pack` 829 to accept a fetch request that asks for an object at the tip 830 of a hidden ref (by default, such a request is rejected). 831 See also `uploadpack.hideRefs`. Even if this is false, a client 832 may be able to steal objects via the techniques described in the 833 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's 834 best to keep private data in a separate repository. 835 836uploadpack.allowReachableSHA1InWant:: 837 Allow `upload-pack` to accept a fetch request that asks for an 838 object that is reachable from any ref tip. However, note that 839 calculating object reachability is computationally expensive. 840 Defaults to `false`. Even if this is false, a client may be able 841 to steal objects via the techniques described in the "SECURITY" 842 section of the linkgit:gitnamespaces[7] man page; it's best to 843 keep private data in a separate repository. 844 845uploadpack.allowAnySHA1InWant:: 846 Allow `upload-pack` to accept a fetch request that asks for any 847 object at all. 848 Defaults to `false`. 849 850uploadpack.keepAlive:: 851 When `upload-pack` has started `pack-objects`, there may be a 852 quiet period while `pack-objects` prepares the pack. Normally 853 it would output progress information, but if `--quiet` was used 854 for the fetch, `pack-objects` will output nothing at all until 855 the pack data begins. Some clients and networks may consider 856 the server to be hung and give up. Setting this option instructs 857 `upload-pack` to send an empty keepalive packet every 858 `uploadpack.keepAlive` seconds. Setting this option to 0 859 disables keepalive packets entirely. The default is 5 seconds. 860 861uploadpack.packObjectsHook:: 862 If this option is set, when `upload-pack` would run 863 `git pack-objects` to create a packfile for a client, it will 864 run this shell command instead. The `pack-objects` command and 865 arguments it _would_ have run (including the `git pack-objects` 866 at the beginning) are appended to the shell command. The stdin 867 and stdout of the hook are treated as if `pack-objects` itself 868 was run. I.e., `upload-pack` will feed input intended for 869 `pack-objects` to the hook, and expects a completed packfile on 870 stdout. 871+ 872Note that this configuration variable is ignored if it is seen in the 873repository-level config (this is a safety measure against fetching from 874untrusted repositories). 875 876uploadpack.allowFilter:: 877 If this option is set, `upload-pack` will support partial 878 clone and partial fetch object filtering. 879 880uploadpack.allowRefInWant:: 881 If this option is set, `upload-pack` will support the `ref-in-want` 882 feature of the protocol version 2 `fetch` command. This feature 883 is intended for the benefit of load-balanced servers which may 884 not have the same view of what OIDs their refs point to due to 885 replication delay. 886 887url.<base>.insteadOf:: 888 Any URL that starts with this value will be rewritten to 889 start, instead, with <base>. In cases where some site serves a 890 large number of repositories, and serves them with multiple 891 access methods, and some users need to use different access 892 methods, this feature allows people to specify any of the 893 equivalent URLs and have Git automatically rewrite the URL to 894 the best alternative for the particular user, even for a 895 never-before-seen repository on the site. When more than one 896 insteadOf strings match a given URL, the longest match is used. 897+ 898Note that any protocol restrictions will be applied to the rewritten 899URL. If the rewrite changes the URL to use a custom protocol or remote 900helper, you may need to adjust the `protocol.*.allow` config to permit 901the request. In particular, protocols you expect to use for submodules 902must be set to `always` rather than the default of `user`. See the 903description of `protocol.allow` above. 904 905url.<base>.pushInsteadOf:: 906 Any URL that starts with this value will not be pushed to; 907 instead, it will be rewritten to start with <base>, and the 908 resulting URL will be pushed to. In cases where some site serves 909 a large number of repositories, and serves them with multiple 910 access methods, some of which do not allow push, this feature 911 allows people to specify a pull-only URL and have Git 912 automatically use an appropriate URL to push, even for a 913 never-before-seen repository on the site. When more than one 914 pushInsteadOf strings match a given URL, the longest match is 915 used. If a remote has an explicit pushurl, Git will ignore this 916 setting for that remote. 917 918user.email:: 919 Your email address to be recorded in any newly created commits. 920 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and 921 `EMAIL` environment variables. See linkgit:git-commit-tree[1]. 922 923user.name:: 924 Your full name to be recorded in any newly created commits. 925 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME` 926 environment variables. See linkgit:git-commit-tree[1]. 927 928user.useConfigOnly:: 929 Instruct Git to avoid trying to guess defaults for `user.email` 930 and `user.name`, and instead retrieve the values only from the 931 configuration. For example, if you have multiple email addresses 932 and would like to use a different one for each repository, then 933 with this configuration option set to `true` in the global config 934 along with a name, Git will prompt you to set up an email before 935 making new commits in a newly cloned repository. 936 Defaults to `false`. 937 938user.signingKey:: 939 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the 940 key you want it to automatically when creating a signed tag or 941 commit, you can override the default selection with this variable. 942 This option is passed unchanged to gpg's --local-user parameter, 943 so you may specify a key using any method that gpg supports. 944 945versionsort.prereleaseSuffix (deprecated):: 946 Deprecated alias for `versionsort.suffix`. Ignored if 947 `versionsort.suffix` is set. 948 949versionsort.suffix:: 950 Even when version sort is used in linkgit:git-tag[1], tagnames 951 with the same base version but different suffixes are still sorted 952 lexicographically, resulting e.g. in prerelease tags appearing 953 after the main release (e.g. "1.0-rc1" after "1.0"). This 954 variable can be specified to determine the sorting order of tags 955 with different suffixes. 956+ 957By specifying a single suffix in this variable, any tagname containing 958that suffix will appear before the corresponding main release. E.g. if 959the variable is set to "-rc", then all "1.0-rcX" tags will appear before 960"1.0". If specified multiple times, once per suffix, then the order of 961suffixes in the configuration will determine the sorting order of tagnames 962with those suffixes. E.g. if "-pre" appears before "-rc" in the 963configuration, then all "1.0-preX" tags will be listed before any 964"1.0-rcX" tags. The placement of the main release tag relative to tags 965with various suffixes can be determined by specifying the empty suffix 966among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and 967"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags 968are listed first, followed by "v4.8", then "v4.8-ckX" and finally 969"v4.8-bfsX". 970+ 971If more than one suffixes match the same tagname, then that tagname will 972be sorted according to the suffix which starts at the earliest position in 973the tagname. If more than one different matching suffixes start at 974that earliest position, then that tagname will be sorted according to the 975longest of those suffixes. 976The sorting order between different suffixes is undefined if they are 977in multiple config files. 978 979web.browser:: 980 Specify a web browser that may be used by some commands. 981 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1] 982 may use it. 983 984worktree.guessRemote:: 985 With `add`, if no branch argument, and neither of `-b` nor 986 `-B` nor `--detach` are given, the command defaults to 987 creating a new branch from HEAD. If `worktree.guessRemote` is 988 set to true, `worktree add` tries to find a remote-tracking 989 branch whose name uniquely matches the new branch name. If 990 such a branch exists, it is checked out and set as "upstream" 991 for the new branch. If no such match can be found, it falls 992 back to creating a new branch from the current HEAD.