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 306browser.<tool>.cmd:: 307 Specify the command to invoke the specified browser. The 308 specified command is evaluated in shell with the URLs passed 309 as arguments. (See linkgit:git-web{litdd}browse[1].) 310 311browser.<tool>.path:: 312 Override the path for the given tool that may be used to 313 browse HTML help (see `-w` option in linkgit:git-help[1]) or a 314 working repository in gitweb (see linkgit:git-instaweb[1]). 315 316checkout.defaultRemote:: 317 When you run 'git checkout <something>' and only have one 318 remote, it may implicitly fall back on checking out and 319 tracking e.g. 'origin/<something>'. This stops working as soon 320 as you have more than one remote with a '<something>' 321 reference. This setting allows for setting the name of a 322 preferred remote that should always win when it comes to 323 disambiguation. The typical use-case is to set this to 324 `origin`. 325+ 326Currently this is used by linkgit:git-checkout[1] when 'git checkout 327<something>' will checkout the '<something>' branch on another remote, 328and by linkgit:git-worktree[1] when 'git worktree add' refers to a 329remote branch. This setting might be used for other checkout-like 330commands or functionality in the future. 331 332checkout.optimizeNewBranch:: 333 Optimizes the performance of "git checkout -b <new_branch>" when 334 using sparse-checkout. When set to true, git will not update the 335 repo based on the current sparse-checkout settings. This means it 336 will not update the skip-worktree bit in the index nor add/remove 337 files in the working directory to reflect the current sparse checkout 338 settings nor will it show the local changes. 339 340clean.requireForce:: 341 A boolean to make git-clean do nothing unless given -f, 342 -i or -n. Defaults to true. 343 344color.advice:: 345 A boolean to enable/disable color in hints (e.g. when a push 346 failed, see `advice.*` for a list). May be set to `always`, 347 `false` (or `never`) or `auto` (or `true`), in which case colors 348 are used only when the error output goes to a terminal. If 349 unset, then the value of `color.ui` is used (`auto` by default). 350 351color.advice.hint:: 352 Use customized color for hints. 353 354color.blame.highlightRecent:: 355 This can be used to color the metadata of a blame line depending 356 on age of the line. 357+ 358This setting should be set to a comma-separated list of color and date settings, 359starting and ending with a color, the dates should be set from oldest to newest. 360The metadata will be colored given the colors if the the line was introduced 361before the given timestamp, overwriting older timestamped colors. 362+ 363Instead of an absolute timestamp relative timestamps work as well, e.g. 3642.weeks.ago is valid to address anything older than 2 weeks. 365+ 366It defaults to 'blue,12 month ago,white,1 month ago,red', which colors 367everything older than one year blue, recent changes between one month and 368one year old are kept white, and lines introduced within the last month are 369colored red. 370 371color.blame.repeatedLines:: 372 Use the customized color for the part of git-blame output that 373 is repeated meta information per line (such as commit id, 374 author name, date and timezone). Defaults to cyan. 375 376color.branch:: 377 A boolean to enable/disable color in the output of 378 linkgit:git-branch[1]. May be set to `always`, 379 `false` (or `never`) or `auto` (or `true`), in which case colors are used 380 only when the output is to a terminal. If unset, then the 381 value of `color.ui` is used (`auto` by default). 382 383color.branch.<slot>:: 384 Use customized color for branch coloration. `<slot>` is one of 385 `current` (the current branch), `local` (a local branch), 386 `remote` (a remote-tracking branch in refs/remotes/), 387 `upstream` (upstream tracking branch), `plain` (other 388 refs). 389 390color.diff:: 391 Whether to use ANSI escape sequences to add color to patches. 392 If this is set to `always`, linkgit:git-diff[1], 393 linkgit:git-log[1], and linkgit:git-show[1] will use color 394 for all patches. If it is set to `true` or `auto`, those 395 commands will only use color when output is to the terminal. 396 If unset, then the value of `color.ui` is used (`auto` by 397 default). 398+ 399This does not affect linkgit:git-format-patch[1] or the 400'git-diff-{asterisk}' plumbing commands. Can be overridden on the 401command line with the `--color[=<when>]` option. 402 403color.diff.<slot>:: 404 Use customized color for diff colorization. `<slot>` specifies 405 which part of the patch to use the specified color, and is one 406 of `context` (context text - `plain` is a historical synonym), 407 `meta` (metainformation), `frag` 408 (hunk header), 'func' (function in hunk header), `old` (removed lines), 409 `new` (added lines), `commit` (commit headers), `whitespace` 410 (highlighting whitespace errors), `oldMoved` (deleted lines), 411 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`, 412 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative` 413 `newMovedAlternativeDimmed` (See the '<mode>' 414 setting of '--color-moved' in linkgit:git-diff[1] for details), 415 `contextDimmed`, `oldDimmed`, `newDimmed`, `contextBold`, 416 `oldBold`, and `newBold` (see linkgit:git-range-diff[1] for details). 417 418color.decorate.<slot>:: 419 Use customized color for 'git log --decorate' output. `<slot>` is one 420 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 421 branches, remote-tracking branches, tags, stash and HEAD, respectively 422 and `grafted` for grafted commits. 423 424color.grep:: 425 When set to `always`, always highlight matches. When `false` (or 426 `never`), never. When set to `true` or `auto`, use color only 427 when the output is written to the terminal. If unset, then the 428 value of `color.ui` is used (`auto` by default). 429 430color.grep.<slot>:: 431 Use customized color for grep colorization. `<slot>` specifies which 432 part of the line to use the specified color, and is one of 433+ 434-- 435`context`;; 436 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 437`filename`;; 438 filename prefix (when not using `-h`) 439`function`;; 440 function name lines (when using `-p`) 441`lineNumber`;; 442 line number prefix (when using `-n`) 443`column`;; 444 column number prefix (when using `--column`) 445`match`;; 446 matching text (same as setting `matchContext` and `matchSelected`) 447`matchContext`;; 448 matching text in context lines 449`matchSelected`;; 450 matching text in selected lines 451`selected`;; 452 non-matching text in selected lines 453`separator`;; 454 separators between fields on a line (`:`, `-`, and `=`) 455 and between hunks (`--`) 456-- 457 458color.interactive:: 459 When set to `always`, always use colors for interactive prompts 460 and displays (such as those used by "git-add --interactive" and 461 "git-clean --interactive"). When false (or `never`), never. 462 When set to `true` or `auto`, use colors only when the output is 463 to the terminal. If unset, then the value of `color.ui` is 464 used (`auto` by default). 465 466color.interactive.<slot>:: 467 Use customized color for 'git add --interactive' and 'git clean 468 --interactive' output. `<slot>` may be `prompt`, `header`, `help` 469 or `error`, for four distinct types of normal output from 470 interactive commands. 471 472color.pager:: 473 A boolean to enable/disable colored output when the pager is in 474 use (default is true). 475 476color.push:: 477 A boolean to enable/disable color in push errors. May be set to 478 `always`, `false` (or `never`) or `auto` (or `true`), in which 479 case colors are used only when the error output goes to a terminal. 480 If unset, then the value of `color.ui` is used (`auto` by default). 481 482color.push.error:: 483 Use customized color for push errors. 484 485color.remote:: 486 If set, keywords at the start of the line are highlighted. The 487 keywords are "error", "warning", "hint" and "success", and are 488 matched case-insensitively. May be set to `always`, `false` (or 489 `never`) or `auto` (or `true`). If unset, then the value of 490 `color.ui` is used (`auto` by default). 491 492color.remote.<slot>:: 493 Use customized color for each remote keyword. `<slot>` may be 494 `hint`, `warning`, `success` or `error` which match the 495 corresponding keyword. 496 497color.showBranch:: 498 A boolean to enable/disable color in the output of 499 linkgit:git-show-branch[1]. May be set to `always`, 500 `false` (or `never`) or `auto` (or `true`), in which case colors are used 501 only when the output is to a terminal. If unset, then the 502 value of `color.ui` is used (`auto` by default). 503 504color.status:: 505 A boolean to enable/disable color in the output of 506 linkgit:git-status[1]. May be set to `always`, 507 `false` (or `never`) or `auto` (or `true`), in which case colors are used 508 only when the output is to a terminal. If unset, then the 509 value of `color.ui` is used (`auto` by default). 510 511color.status.<slot>:: 512 Use customized color for status colorization. `<slot>` is 513 one of `header` (the header text of the status message), 514 `added` or `updated` (files which are added but not committed), 515 `changed` (files which are changed but not added in the index), 516 `untracked` (files which are not tracked by Git), 517 `branch` (the current branch), 518 `nobranch` (the color the 'no branch' warning is shown in, defaulting 519 to red), 520 `localBranch` or `remoteBranch` (the local and remote branch names, 521 respectively, when branch and tracking information is displayed in the 522 status short-format), or 523 `unmerged` (files which have unmerged changes). 524 525color.transport:: 526 A boolean to enable/disable color when pushes are rejected. May be 527 set to `always`, `false` (or `never`) or `auto` (or `true`), in which 528 case colors are used only when the error output goes to a terminal. 529 If unset, then the value of `color.ui` is used (`auto` by default). 530 531color.transport.rejected:: 532 Use customized color when a push was rejected. 533 534color.ui:: 535 This variable determines the default value for variables such 536 as `color.diff` and `color.grep` that control the use of color 537 per command family. Its scope will expand as more commands learn 538 configuration to set a default for the `--color` option. Set it 539 to `false` or `never` if you prefer Git commands not to use 540 color unless enabled explicitly with some other configuration 541 or the `--color` option. Set it to `always` if you want all 542 output not intended for machine consumption to use color, to 543 `true` or `auto` (this is the default since Git 1.8.4) if you 544 want such output to use color when written to the terminal. 545 546column.ui:: 547 Specify whether supported commands should output in columns. 548 This variable consists of a list of tokens separated by spaces 549 or commas: 550+ 551These options control when the feature should be enabled 552(defaults to 'never'): 553+ 554-- 555`always`;; 556 always show in columns 557`never`;; 558 never show in columns 559`auto`;; 560 show in columns if the output is to the terminal 561-- 562+ 563These options control layout (defaults to 'column'). Setting any 564of these implies 'always' if none of 'always', 'never', or 'auto' are 565specified. 566+ 567-- 568`column`;; 569 fill columns before rows 570`row`;; 571 fill rows before columns 572`plain`;; 573 show in one column 574-- 575+ 576Finally, these options can be combined with a layout option (defaults 577to 'nodense'): 578+ 579-- 580`dense`;; 581 make unequal size columns to utilize more space 582`nodense`;; 583 make equal size columns 584-- 585 586column.branch:: 587 Specify whether to output branch listing in `git branch` in columns. 588 See `column.ui` for details. 589 590column.clean:: 591 Specify the layout when list items in `git clean -i`, which always 592 shows files and directories in columns. See `column.ui` for details. 593 594column.status:: 595 Specify whether to output untracked files in `git status` in columns. 596 See `column.ui` for details. 597 598column.tag:: 599 Specify whether to output tag listing in `git tag` in columns. 600 See `column.ui` for details. 601 602commit.cleanup:: 603 This setting overrides the default of the `--cleanup` option in 604 `git commit`. See linkgit:git-commit[1] for details. Changing the 605 default can be useful when you always want to keep lines that begin 606 with comment character `#` in your log message, in which case you 607 would do `git config commit.cleanup whitespace` (note that you will 608 have to remove the help lines that begin with `#` in the commit log 609 template yourself, if you do this). 610 611commit.gpgSign:: 612 613 A boolean to specify whether all commits should be GPG signed. 614 Use of this option when doing operations such as rebase can 615 result in a large number of commits being signed. It may be 616 convenient to use an agent to avoid typing your GPG passphrase 617 several times. 618 619commit.status:: 620 A boolean to enable/disable inclusion of status information in the 621 commit message template when using an editor to prepare the commit 622 message. Defaults to true. 623 624commit.template:: 625 Specify the pathname of a file to use as the template for 626 new commit messages. 627 628commit.verbose:: 629 A boolean or int to specify the level of verbose with `git commit`. 630 See linkgit:git-commit[1]. 631 632credential.helper:: 633 Specify an external helper to be called when a username or 634 password credential is needed; the helper may consult external 635 storage to avoid prompting the user for the credentials. Note 636 that multiple helpers may be defined. See linkgit:gitcredentials[7] 637 for details. 638 639credential.useHttpPath:: 640 When acquiring credentials, consider the "path" component of an http 641 or https URL to be important. Defaults to false. See 642 linkgit:gitcredentials[7] for more information. 643 644credential.username:: 645 If no username is set for a network authentication, use this username 646 by default. See credential.<context>.* below, and 647 linkgit:gitcredentials[7]. 648 649credential.<url>.*:: 650 Any of the credential.* options above can be applied selectively to 651 some credentials. For example "credential.https://example.com.username" 652 would set the default username only for https connections to 653 example.com. See linkgit:gitcredentials[7] for details on how URLs are 654 matched. 655 656credentialCache.ignoreSIGHUP:: 657 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting. 658 659completion.commands:: 660 This is only used by git-completion.bash to add or remove 661 commands from the list of completed commands. Normally only 662 porcelain commands and a few select others are completed. You 663 can add more commands, separated by space, in this 664 variable. Prefixing the command with '-' will remove it from 665 the existing list. 666 667include::diff-config.txt[] 668 669difftool.<tool>.path:: 670 Override the path for the given tool. This is useful in case 671 your tool is not in the PATH. 672 673difftool.<tool>.cmd:: 674 Specify the command to invoke the specified diff tool. 675 The specified command is evaluated in shell with the following 676 variables available: 'LOCAL' is set to the name of the temporary 677 file containing the contents of the diff pre-image and 'REMOTE' 678 is set to the name of the temporary file containing the contents 679 of the diff post-image. 680 681difftool.prompt:: 682 Prompt before each invocation of the diff tool. 683 684fastimport.unpackLimit:: 685 If the number of objects imported by linkgit:git-fast-import[1] 686 is below this limit, then the objects will be unpacked into 687 loose object files. However if the number of imported objects 688 equals or exceeds this limit then the pack will be stored as a 689 pack. Storing the pack from a fast-import can make the import 690 operation complete faster, especially on slow filesystems. If 691 not set, the value of `transfer.unpackLimit` is used instead. 692 693include::fetch-config.txt[] 694 695include::format-config.txt[] 696 697filter.<driver>.clean:: 698 The command which is used to convert the content of a worktree 699 file to a blob upon checkin. See linkgit:gitattributes[5] for 700 details. 701 702filter.<driver>.smudge:: 703 The command which is used to convert the content of a blob 704 object to a worktree file upon checkout. See 705 linkgit:gitattributes[5] for details. 706 707fsck.<msg-id>:: 708 During fsck git may find issues with legacy data which 709 wouldn't be generated by current versions of git, and which 710 wouldn't be sent over the wire if `transfer.fsckObjects` was 711 set. This feature is intended to support working with legacy 712 repositories containing such data. 713+ 714Setting `fsck.<msg-id>` will be picked up by linkgit:git-fsck[1], but 715to accept pushes of such data set `receive.fsck.<msg-id>` instead, or 716to clone or fetch it set `fetch.fsck.<msg-id>`. 717+ 718The rest of the documentation discusses `fsck.*` for brevity, but the 719same applies for the corresponding `receive.fsck.*` and 720`fetch.<msg-id>.*`. variables. 721+ 722Unlike variables like `color.ui` and `core.editor` the 723`receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` variables will not 724fall back on the `fsck.<msg-id>` configuration if they aren't set. To 725uniformly configure the same fsck settings in different circumstances 726all three of them they must all set to the same values. 727+ 728When `fsck.<msg-id>` is set, errors can be switched to warnings and 729vice versa by configuring the `fsck.<msg-id>` setting where the 730`<msg-id>` is the fsck message ID and the value is one of `error`, 731`warn` or `ignore`. For convenience, fsck prefixes the error/warning 732with the message ID, e.g. "missingEmail: invalid author/committer line 733- missing email" means that setting `fsck.missingEmail = ignore` will 734hide that issue. 735+ 736In general, it is better to enumerate existing objects with problems 737with `fsck.skipList`, instead of listing the kind of breakages these 738problematic objects share to be ignored, as doing the latter will 739allow new instances of the same breakages go unnoticed. 740+ 741Setting an unknown `fsck.<msg-id>` value will cause fsck to die, but 742doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` 743will only cause git to warn. 744 745fsck.skipList:: 746 The path to a list of object names (i.e. one unabbreviated SHA-1 per 747 line) that are known to be broken in a non-fatal way and should 748 be ignored. On versions of Git 2.20 and later comments ('#'), empty 749 lines, and any leading and trailing whitespace is ignored. Everything 750 but a SHA-1 per line will error out on older versions. 751+ 752This feature is useful when an established project should be accepted 753despite early commits containing errors that can be safely ignored 754such as invalid committer email addresses. Note: corrupt objects 755cannot be skipped with this setting. 756+ 757Like `fsck.<msg-id>` this variable has corresponding 758`receive.fsck.skipList` and `fetch.fsck.skipList` variants. 759+ 760Unlike variables like `color.ui` and `core.editor` the 761`receive.fsck.skipList` and `fetch.fsck.skipList` variables will not 762fall back on the `fsck.skipList` configuration if they aren't set. To 763uniformly configure the same fsck settings in different circumstances 764all three of them they must all set to the same values. 765+ 766Older versions of Git (before 2.20) documented that the object names 767list should be sorted. This was never a requirement, the object names 768could appear in any order, but when reading the list we tracked whether 769the list was sorted for the purposes of an internal binary search 770implementation, which could save itself some work with an already sorted 771list. Unless you had a humongous list there was no reason to go out of 772your way to pre-sort the list. After Git version 2.20 a hash implementation 773is used instead, so there's now no reason to pre-sort the list. 774 775gc.aggressiveDepth:: 776 The depth parameter used in the delta compression 777 algorithm used by 'git gc --aggressive'. This defaults 778 to 50. 779 780gc.aggressiveWindow:: 781 The window size parameter used in the delta compression 782 algorithm used by 'git gc --aggressive'. This defaults 783 to 250. 784 785gc.auto:: 786 When there are approximately more than this many loose 787 objects in the repository, `git gc --auto` will pack them. 788 Some Porcelain commands use this command to perform a 789 light-weight garbage collection from time to time. The 790 default value is 6700. Setting this to 0 disables it. 791 792gc.autoPackLimit:: 793 When there are more than this many packs that are not 794 marked with `*.keep` file in the repository, `git gc 795 --auto` consolidates them into one larger pack. The 796 default value is 50. Setting this to 0 disables it. 797 798gc.autoDetach:: 799 Make `git gc --auto` return immediately and run in background 800 if the system supports it. Default is true. 801 802gc.bigPackThreshold:: 803 If non-zero, all packs larger than this limit are kept when 804 `git gc` is run. This is very similar to `--keep-base-pack` 805 except that all packs that meet the threshold are kept, not 806 just the base pack. Defaults to zero. Common unit suffixes of 807 'k', 'm', or 'g' are supported. 808+ 809Note that if the number of kept packs is more than gc.autoPackLimit, 810this configuration variable is ignored, all packs except the base pack 811will be repacked. After this the number of packs should go below 812gc.autoPackLimit and gc.bigPackThreshold should be respected again. 813 814gc.writeCommitGraph:: 815 If true, then gc will rewrite the commit-graph file when 816 linkgit:git-gc[1] is run. When using linkgit:git-gc[1] 817 '--auto' the commit-graph will be updated if housekeeping is 818 required. Default is false. See linkgit:git-commit-graph[1] 819 for details. 820 821gc.logExpiry:: 822 If the file gc.log exists, then `git gc --auto` will print 823 its content and exit with status zero instead of running 824 unless that file is more than 'gc.logExpiry' old. Default is 825 "1.day". See `gc.pruneExpire` for more ways to specify its 826 value. 827 828gc.packRefs:: 829 Running `git pack-refs` in a repository renders it 830 unclonable by Git versions prior to 1.5.1.2 over dumb 831 transports such as HTTP. This variable determines whether 832 'git gc' runs `git pack-refs`. This can be set to `notbare` 833 to enable it within all non-bare repos or it can be set to a 834 boolean value. The default is `true`. 835 836gc.pruneExpire:: 837 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'. 838 Override the grace period with this config variable. The value 839 "now" may be used to disable this grace period and always prune 840 unreachable objects immediately, or "never" may be used to 841 suppress pruning. This feature helps prevent corruption when 842 'git gc' runs concurrently with another process writing to the 843 repository; see the "NOTES" section of linkgit:git-gc[1]. 844 845gc.worktreePruneExpire:: 846 When 'git gc' is run, it calls 847 'git worktree prune --expire 3.months.ago'. 848 This config variable can be used to set a different grace 849 period. The value "now" may be used to disable the grace 850 period and prune `$GIT_DIR/worktrees` immediately, or "never" 851 may be used to suppress pruning. 852 853gc.reflogExpire:: 854gc.<pattern>.reflogExpire:: 855 'git reflog expire' removes reflog entries older than 856 this time; defaults to 90 days. The value "now" expires all 857 entries immediately, and "never" suppresses expiration 858 altogether. With "<pattern>" (e.g. 859 "refs/stash") in the middle the setting applies only to 860 the refs that match the <pattern>. 861 862gc.reflogExpireUnreachable:: 863gc.<pattern>.reflogExpireUnreachable:: 864 'git reflog expire' removes reflog entries older than 865 this time and are not reachable from the current tip; 866 defaults to 30 days. The value "now" expires all entries 867 immediately, and "never" suppresses expiration altogether. 868 With "<pattern>" (e.g. "refs/stash") 869 in the middle, the setting applies only to the refs that 870 match the <pattern>. 871 872gc.rerereResolved:: 873 Records of conflicted merge you resolved earlier are 874 kept for this many days when 'git rerere gc' is run. 875 You can also use more human-readable "1.month.ago", etc. 876 The default is 60 days. See linkgit:git-rerere[1]. 877 878gc.rerereUnresolved:: 879 Records of conflicted merge you have not resolved are 880 kept for this many days when 'git rerere gc' is run. 881 You can also use more human-readable "1.month.ago", etc. 882 The default is 15 days. See linkgit:git-rerere[1]. 883 884include::gitcvs-config.txt[] 885 886gitweb.category:: 887gitweb.description:: 888gitweb.owner:: 889gitweb.url:: 890 See linkgit:gitweb[1] for description. 891 892gitweb.avatar:: 893gitweb.blame:: 894gitweb.grep:: 895gitweb.highlight:: 896gitweb.patches:: 897gitweb.pickaxe:: 898gitweb.remote_heads:: 899gitweb.showSizes:: 900gitweb.snapshot:: 901 See linkgit:gitweb.conf[5] for description. 902 903grep.lineNumber:: 904 If set to true, enable `-n` option by default. 905 906grep.column:: 907 If set to true, enable the `--column` option by default. 908 909grep.patternType:: 910 Set the default matching behavior. Using a value of 'basic', 'extended', 911 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`, 912 `--fixed-strings`, or `--perl-regexp` option accordingly, while the 913 value 'default' will return to the default matching behavior. 914 915grep.extendedRegexp:: 916 If set to true, enable `--extended-regexp` option by default. This 917 option is ignored when the `grep.patternType` option is set to a value 918 other than 'default'. 919 920grep.threads:: 921 Number of grep worker threads to use. 922 See `grep.threads` in linkgit:git-grep[1] for more information. 923 924grep.fallbackToNoIndex:: 925 If set to true, fall back to git grep --no-index if git grep 926 is executed outside of a git repository. Defaults to false. 927 928gpg.program:: 929 Use this custom program instead of "`gpg`" found on `$PATH` when 930 making or verifying a PGP signature. The program must support the 931 same command-line interface as GPG, namely, to verify a detached 932 signature, "`gpg --verify $file - <$signature`" is run, and the 933 program is expected to signal a good signature by exiting with 934 code 0, and to generate an ASCII-armored detached signature, the 935 standard input of "`gpg -bsau $key`" is fed with the contents to be 936 signed, and the program is expected to send the result to its 937 standard output. 938 939gpg.format:: 940 Specifies which key format to use when signing with `--gpg-sign`. 941 Default is "openpgp" and another possible value is "x509". 942 943gpg.<format>.program:: 944 Use this to customize the program used for the signing format you 945 chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still 946 be used as a legacy synonym for `gpg.openpgp.program`. The default 947 value for `gpg.x509.program` is "gpgsm". 948 949include::gui-config.txt[] 950 951guitool.<name>.cmd:: 952 Specifies the shell command line to execute when the corresponding item 953 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is 954 mandatory for every tool. The command is executed from the root of 955 the working directory, and in the environment it receives the name of 956 the tool as `GIT_GUITOOL`, the name of the currently selected file as 957 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if 958 the head is detached, 'CUR_BRANCH' is empty). 959 960guitool.<name>.needsFile:: 961 Run the tool only if a diff is selected in the GUI. It guarantees 962 that 'FILENAME' is not empty. 963 964guitool.<name>.noConsole:: 965 Run the command silently, without creating a window to display its 966 output. 967 968guitool.<name>.noRescan:: 969 Don't rescan the working directory for changes after the tool 970 finishes execution. 971 972guitool.<name>.confirm:: 973 Show a confirmation dialog before actually running the tool. 974 975guitool.<name>.argPrompt:: 976 Request a string argument from the user, and pass it to the tool 977 through the `ARGS` environment variable. Since requesting an 978 argument implies confirmation, the 'confirm' option has no effect 979 if this is enabled. If the option is set to 'true', 'yes', or '1', 980 the dialog uses a built-in generic prompt; otherwise the exact 981 value of the variable is used. 982 983guitool.<name>.revPrompt:: 984 Request a single valid revision from the user, and set the 985 `REVISION` environment variable. In other aspects this option 986 is similar to 'argPrompt', and can be used together with it. 987 988guitool.<name>.revUnmerged:: 989 Show only unmerged branches in the 'revPrompt' subdialog. 990 This is useful for tools similar to merge or rebase, but not 991 for things like checkout or reset. 992 993guitool.<name>.title:: 994 Specifies the title to use for the prompt dialog. The default 995 is the tool name. 996 997guitool.<name>.prompt:: 998 Specifies the general prompt string to display at the top of 999 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1000 The default value includes the actual command.10011002help.browser::1003 Specify the browser that will be used to display help in the1004 'web' format. See linkgit:git-help[1].10051006help.format::1007 Override the default help format used by linkgit:git-help[1].1008 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1009 the default. 'web' and 'html' are the same.10101011help.autoCorrect::1012 Automatically correct and execute mistyped commands after1013 waiting for the given number of deciseconds (0.1 sec). If more1014 than one command can be deduced from the entered text, nothing1015 will be executed. If the value of this option is negative,1016 the corrected command will be executed immediately. If the1017 value is 0 - the command will be just shown but not executed.1018 This is the default.10191020help.htmlPath::1021 Specify the path where the HTML documentation resides. File system paths1022 and URLs are supported. HTML pages will be prefixed with this path when1023 help is displayed in the 'web' format. This defaults to the documentation1024 path of your Git installation.10251026http.proxy::1027 Override the HTTP proxy, normally configured using the 'http_proxy',1028 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1029 addition to the syntax understood by curl, it is possible to specify a1030 proxy string with a user name but no password, in which case git will1031 attempt to acquire one in the same way it does for other credentials. See1032 linkgit:gitcredentials[7] for more information. The syntax thus is1033 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1034 on a per-remote basis; see remote.<name>.proxy10351036http.proxyAuthMethod::1037 Set the method with which to authenticate against the HTTP proxy. This1038 only takes effect if the configured proxy string contains a user name part1039 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1040 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1041 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1042 variable. Possible values are:1043+1044--1045* `anyauth` - Automatically pick a suitable authentication method. It is1046 assumed that the proxy answers an unauthenticated request with a 4071047 status code and one or more Proxy-authenticate headers with supported1048 authentication methods. This is the default.1049* `basic` - HTTP Basic authentication1050* `digest` - HTTP Digest authentication; this prevents the password from being1051 transmitted to the proxy in clear text1052* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1053 of `curl(1)`)1054* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1055--10561057http.emptyAuth::1058 Attempt authentication without seeking a username or password. This1059 can be used to attempt GSS-Negotiate authentication without specifying1060 a username in the URL, as libcurl normally requires a username for1061 authentication.10621063http.delegation::1064 Control GSSAPI credential delegation. The delegation is disabled1065 by default in libcurl since version 7.21.7. Set parameter to tell1066 the server what it is allowed to delegate when it comes to user1067 credentials. Used with GSS/kerberos. Possible values are:1068+1069--1070* `none` - Don't allow any delegation.1071* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the1072 Kerberos service ticket, which is a matter of realm policy.1073* `always` - Unconditionally allow the server to delegate.1074--107510761077http.extraHeader::1078 Pass an additional HTTP header when communicating with a server. If1079 more than one such entry exists, all of them are added as extra1080 headers. To allow overriding the settings inherited from the system1081 config, an empty value will reset the extra headers to the empty list.10821083http.cookieFile::1084 The pathname of a file containing previously stored cookie lines,1085 which should be used1086 in the Git http session, if they match the server. The file format1087 of the file to read cookies from should be plain HTTP headers or1088 the Netscape/Mozilla cookie file format (see `curl(1)`).1089 NOTE that the file specified with http.cookieFile is used only as1090 input unless http.saveCookies is set.10911092http.saveCookies::1093 If set, store cookies received during requests to the file specified by1094 http.cookieFile. Has no effect if http.cookieFile is unset.10951096http.sslVersion::1097 The SSL version to use when negotiating an SSL connection, if you1098 want to force the default. The available and default version1099 depend on whether libcurl was built against NSS or OpenSSL and the1100 particular configuration of the crypto library in use. Internally1101 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl1102 documentation for more details on the format of this option and1103 for the ssl version supported. Actually the possible values of1104 this option are:11051106 - sslv21107 - sslv31108 - tlsv11109 - tlsv1.01110 - tlsv1.11111 - tlsv1.21112 - tlsv1.311131114+1115Can be overridden by the `GIT_SSL_VERSION` environment variable.1116To force git to use libcurl's default ssl version and ignore any1117explicit http.sslversion option, set `GIT_SSL_VERSION` to the1118empty string.11191120http.sslCipherList::1121 A list of SSL ciphers to use when negotiating an SSL connection.1122 The available ciphers depend on whether libcurl was built against1123 NSS or OpenSSL and the particular configuration of the crypto1124 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'1125 option; see the libcurl documentation for more details on the format1126 of this list.1127+1128Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.1129To force git to use libcurl's default cipher list and ignore any1130explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the1131empty string.11321133http.sslVerify::1134 Whether to verify the SSL certificate when fetching or pushing1135 over HTTPS. Defaults to true. Can be overridden by the1136 `GIT_SSL_NO_VERIFY` environment variable.11371138http.sslCert::1139 File containing the SSL certificate when fetching or pushing1140 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment1141 variable.11421143http.sslKey::1144 File containing the SSL private key when fetching or pushing1145 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment1146 variable.11471148http.sslCertPasswordProtected::1149 Enable Git's password prompt for the SSL certificate. Otherwise1150 OpenSSL will prompt the user, possibly many times, if the1151 certificate or private key is encrypted. Can be overridden by the1152 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.11531154http.sslCAInfo::1155 File containing the certificates to verify the peer with when1156 fetching or pushing over HTTPS. Can be overridden by the1157 `GIT_SSL_CAINFO` environment variable.11581159http.sslCAPath::1160 Path containing files with the CA certificates to verify the peer1161 with when fetching or pushing over HTTPS. Can be overridden1162 by the `GIT_SSL_CAPATH` environment variable.11631164http.sslBackend::1165 Name of the SSL backend to use (e.g. "openssl" or "schannel").1166 This option is ignored if cURL lacks support for choosing the SSL1167 backend at runtime.11681169http.schannelCheckRevoke::1170 Used to enforce or disable certificate revocation checks in cURL1171 when http.sslBackend is set to "schannel". Defaults to `true` if1172 unset. Only necessary to disable this if Git consistently errors1173 and the message is about checking the revocation status of a1174 certificate. This option is ignored if cURL lacks support for1175 setting the relevant SSL option at runtime.11761177http.schannelUseSSLCAInfo::1178 As of cURL v7.60.0, the Secure Channel backend can use the1179 certificate bundle provided via `http.sslCAInfo`, but that would1180 override the Windows Certificate Store. Since this is not desirable1181 by default, Git will tell cURL not to use that bundle by default1182 when the `schannel` backend was configured via `http.sslBackend`,1183 unless `http.schannelUseSSLCAInfo` overrides this behavior.11841185http.pinnedpubkey::1186 Public key of the https service. It may either be the filename of1187 a PEM or DER encoded public key file or a string starting with1188 'sha256//' followed by the base64 encoded sha256 hash of the1189 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will1190 exit with an error if this option is set but not supported by1191 cURL.11921193http.sslTry::1194 Attempt to use AUTH SSL/TLS and encrypted data transfers1195 when connecting via regular FTP protocol. This might be needed1196 if the FTP server requires it for security reasons or you wish1197 to connect securely whenever remote FTP server supports it.1198 Default is false since it might trigger certificate verification1199 errors on misconfigured servers.12001201http.maxRequests::1202 How many HTTP requests to launch in parallel. Can be overridden1203 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.12041205http.minSessions::1206 The number of curl sessions (counted across slots) to be kept across1207 requests. They will not be ended with curl_easy_cleanup() until1208 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1209 value will be capped at 1. Defaults to 1.12101211http.postBuffer::1212 Maximum size in bytes of the buffer used by smart HTTP1213 transports when POSTing data to the remote system.1214 For requests larger than this buffer size, HTTP/1.1 and1215 Transfer-Encoding: chunked is used to avoid creating a1216 massive pack file locally. Default is 1 MiB, which is1217 sufficient for most requests.12181219http.lowSpeedLimit, http.lowSpeedTime::1220 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1221 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1222 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and1223 `GIT_HTTP_LOW_SPEED_TIME` environment variables.12241225http.noEPSV::1226 A boolean which disables using of EPSV ftp command by curl.1227 This can helpful with some "poor" ftp servers which don't1228 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`1229 environment variable. Default is false (curl will use EPSV).12301231http.userAgent::1232 The HTTP USER_AGENT string presented to an HTTP server. The default1233 value represents the version of the client Git such as git/1.7.1.1234 This option allows you to override this value to a more common value1235 such as Mozilla/4.0. This may be necessary, for instance, if1236 connecting through a firewall that restricts HTTP connections to a set1237 of common USER_AGENT strings (but not including those like git/1.7.1).1238 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.12391240http.followRedirects::1241 Whether git should follow HTTP redirects. If set to `true`, git1242 will transparently follow any redirect issued by a server it1243 encounters. If set to `false`, git will treat all redirects as1244 errors. If set to `initial`, git will follow redirects only for1245 the initial request to a remote, but not for subsequent1246 follow-up HTTP requests. Since git uses the redirected URL as1247 the base for the follow-up requests, this is generally1248 sufficient. The default is `initial`.12491250http.<url>.*::1251 Any of the http.* options above can be applied selectively to some URLs.1252 For a config key to match a URL, each element of the config key is1253 compared to that of the URL, in the following order:1254+1255--1256. Scheme (e.g., `https` in `https://example.com/`). This field1257 must match exactly between the config key and the URL.12581259. Host/domain name (e.g., `example.com` in `https://example.com/`).1260 This field must match between the config key and the URL. It is1261 possible to specify a `*` as part of the host name to match all subdomains1262 at this level. `https://*.example.com/` for example would match1263 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.12641265. Port number (e.g., `8080` in `http://example.com:8080/`).1266 This field must match exactly between the config key and the URL.1267 Omitted port numbers are automatically converted to the correct1268 default for the scheme before matching.12691270. Path (e.g., `repo.git` in `https://example.com/repo.git`). The1271 path field of the config key must match the path field of the URL1272 either exactly or as a prefix of slash-delimited path elements. This means1273 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only1274 match on a slash (`/`) boundary. Longer matches take precedence (so a config1275 key with path `foo/bar` is a better match to URL path `foo/bar` than a config1276 key with just path `foo/`).12771278. User name (e.g., `user` in `https://user@example.com/repo.git`). If1279 the config key has a user name it must match the user name in the1280 URL exactly. If the config key does not have a user name, that1281 config key will match a URL with any user name (including none),1282 but at a lower precedence than a config key with a user name.1283--1284+1285The list above is ordered by decreasing precedence; a URL that matches1286a config key's path is preferred to one that matches its user name. For example,1287if the URL is `https://user@example.com/foo/bar` a config key match of1288`https://example.com/foo` will be preferred over a config key match of1289`https://user@example.com`.1290+1291All URLs are normalized before attempting any matching (the password part,1292if embedded in the URL, is always ignored for matching purposes) so that1293equivalent URLs that are simply spelled differently will match properly.1294Environment variable settings always override any matches. The URLs that are1295matched against are those given directly to Git commands. This means any URLs1296visited as a result of a redirection do not participate in matching.12971298ssh.variant::1299 By default, Git determines the command line arguments to use1300 based on the basename of the configured SSH command (configured1301 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or1302 the config setting `core.sshCommand`). If the basename is1303 unrecognized, Git will attempt to detect support of OpenSSH1304 options by first invoking the configured SSH command with the1305 `-G` (print configuration) option and will subsequently use1306 OpenSSH options (if that is successful) or no options besides1307 the host and remote command (if it fails).1308+1309The config variable `ssh.variant` can be set to override this detection.1310Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,1311`tortoiseplink`, `simple` (no options except the host and remote command).1312The default auto-detection can be explicitly requested using the value1313`auto`. Any other value is treated as `ssh`. This setting can also be1314overridden via the environment variable `GIT_SSH_VARIANT`.1315+1316The current command-line parameters used for each variant are as1317follows:1318+1319--13201321* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command13221323* `simple` - [username@]host command13241325* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command13261327* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command13281329--1330+1331Except for the `simple` variant, command-line parameters are likely to1332change as git gains new features.13331334i18n.commitEncoding::1335 Character encoding the commit messages are stored in; Git itself1336 does not care per se, but this information is necessary e.g. when1337 importing commits from emails or in the gitk graphical history1338 browser (and possibly at other places in the future or in other1339 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.13401341i18n.logOutputEncoding::1342 Character encoding the commit messages are converted to when1343 running 'git log' and friends.13441345imap::1346 The configuration variables in the 'imap' section are described1347 in linkgit:git-imap-send[1].13481349index.threads::1350 Specifies the number of threads to spawn when loading the index.1351 This is meant to reduce index load time on multiprocessor machines.1352 Specifying 0 or 'true' will cause Git to auto-detect the number of1353 CPU's and set the number of threads accordingly. Specifying 1 or1354 'false' will disable multithreading. Defaults to 'true'.13551356index.version::1357 Specify the version with which new index files should be1358 initialized. This does not affect existing repositories.13591360init.templateDir::1361 Specify the directory from which templates will be copied.1362 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)13631364instaweb.browser::1365 Specify the program that will be used to browse your working1366 repository in gitweb. See linkgit:git-instaweb[1].13671368instaweb.httpd::1369 The HTTP daemon command-line to start gitweb on your working1370 repository. See linkgit:git-instaweb[1].13711372instaweb.local::1373 If true the web server started by linkgit:git-instaweb[1] will1374 be bound to the local IP (127.0.0.1).13751376instaweb.modulePath::1377 The default module path for linkgit:git-instaweb[1] to use1378 instead of /usr/lib/apache2/modules. Only used if httpd1379 is Apache.13801381instaweb.port::1382 The port number to bind the gitweb httpd to. See1383 linkgit:git-instaweb[1].13841385interactive.singleKey::1386 In interactive commands, allow the user to provide one-letter1387 input with a single key (i.e., without hitting enter).1388 Currently this is used by the `--patch` mode of1389 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],1390 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this1391 setting is silently ignored if portable keystroke input1392 is not available; requires the Perl module Term::ReadKey.13931394interactive.diffFilter::1395 When an interactive command (such as `git add --patch`) shows1396 a colorized diff, git will pipe the diff through the shell1397 command defined by this configuration variable. The command may1398 mark up the diff further for human consumption, provided that it1399 retains a one-to-one correspondence with the lines in the1400 original diff. Defaults to disabled (no filtering).14011402log.abbrevCommit::1403 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1404 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may1405 override this option with `--no-abbrev-commit`.14061407log.date::1408 Set the default date-time mode for the 'log' command.1409 Setting a value for log.date is similar to using 'git log''s1410 `--date` option. See linkgit:git-log[1] for details.14111412log.decorate::1413 Print out the ref names of any commits that are shown by the log1414 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1415 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1416 specified, the full ref name (including prefix) will be printed.1417 If 'auto' is specified, then if the output is going to a terminal,1418 the ref names are shown as if 'short' were given, otherwise no ref1419 names are shown. This is the same as the `--decorate` option1420 of the `git log`.14211422log.follow::1423 If `true`, `git log` will act as if the `--follow` option was used when1424 a single <path> is given. This has the same limitations as `--follow`,1425 i.e. it cannot be used to follow multiple files and does not work well1426 on non-linear history.14271428log.graphColors::1429 A list of colors, separated by commas, that can be used to draw1430 history lines in `git log --graph`.14311432log.showRoot::1433 If true, the initial commit will be shown as a big creation event.1434 This is equivalent to a diff against an empty tree.1435 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1436 normally hide the root commit will now show it. True by default.14371438log.showSignature::1439 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1440 linkgit:git-whatchanged[1] assume `--show-signature`.14411442log.mailmap::1443 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1444 linkgit:git-whatchanged[1] assume `--use-mailmap`.14451446mailinfo.scissors::1447 If true, makes linkgit:git-mailinfo[1] (and therefore1448 linkgit:git-am[1]) act by default as if the --scissors option1449 was provided on the command-line. When active, this features1450 removes everything from the message body before a scissors1451 line (i.e. consisting mainly of ">8", "8<" and "-").14521453mailmap.file::1454 The location of an augmenting mailmap file. The default1455 mailmap, located in the root of the repository, is loaded1456 first, then the mailmap file pointed to by this variable.1457 The location of the mailmap file may be in a repository1458 subdirectory, or somewhere outside of the repository itself.1459 See linkgit:git-shortlog[1] and linkgit:git-blame[1].14601461mailmap.blob::1462 Like `mailmap.file`, but consider the value as a reference to a1463 blob in the repository. If both `mailmap.file` and1464 `mailmap.blob` are given, both are parsed, with entries from1465 `mailmap.file` taking precedence. In a bare repository, this1466 defaults to `HEAD:.mailmap`. In a non-bare repository, it1467 defaults to empty.14681469man.viewer::1470 Specify the programs that may be used to display help in the1471 'man' format. See linkgit:git-help[1].14721473man.<tool>.cmd::1474 Specify the command to invoke the specified man viewer. The1475 specified command is evaluated in shell with the man page1476 passed as argument. (See linkgit:git-help[1].)14771478man.<tool>.path::1479 Override the path for the given tool that may be used to1480 display help in the 'man' format. See linkgit:git-help[1].14811482include::merge-config.txt[]14831484mergetool.<tool>.path::1485 Override the path for the given tool. This is useful in case1486 your tool is not in the PATH.14871488mergetool.<tool>.cmd::1489 Specify the command to invoke the specified merge tool. The1490 specified command is evaluated in shell with the following1491 variables available: 'BASE' is the name of a temporary file1492 containing the common base of the files to be merged, if available;1493 'LOCAL' is the name of a temporary file containing the contents of1494 the file on the current branch; 'REMOTE' is the name of a temporary1495 file containing the contents of the file from the branch being1496 merged; 'MERGED' contains the name of the file to which the merge1497 tool should write the results of a successful merge.14981499mergetool.<tool>.trustExitCode::1500 For a custom merge command, specify whether the exit code of1501 the merge command can be used to determine whether the merge was1502 successful. If this is not set to true then the merge target file1503 timestamp is checked and the merge assumed to have been successful1504 if the file has been updated, otherwise the user is prompted to1505 indicate the success of the merge.15061507mergetool.meld.hasOutput::1508 Older versions of `meld` do not support the `--output` option.1509 Git will attempt to detect whether `meld` supports `--output`1510 by inspecting the output of `meld --help`. Configuring1511 `mergetool.meld.hasOutput` will make Git skip these checks and1512 use the configured value instead. Setting `mergetool.meld.hasOutput`1513 to `true` tells Git to unconditionally use the `--output` option,1514 and `false` avoids using `--output`.15151516mergetool.keepBackup::1517 After performing a merge, the original file with conflict markers1518 can be saved as a file with a `.orig` extension. If this variable1519 is set to `false` then this file is not preserved. Defaults to1520 `true` (i.e. keep the backup files).15211522mergetool.keepTemporaries::1523 When invoking a custom merge tool, Git uses a set of temporary1524 files to pass to the tool. If the tool returns an error and this1525 variable is set to `true`, then these temporary files will be1526 preserved, otherwise they will be removed after the tool has1527 exited. Defaults to `false`.15281529mergetool.writeToTemp::1530 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of1531 conflicting files in the worktree by default. Git will attempt1532 to use a temporary directory for these files when set `true`.1533 Defaults to `false`.15341535mergetool.prompt::1536 Prompt before each invocation of the merge resolution program.15371538notes.mergeStrategy::1539 Which merge strategy to choose by default when resolving notes1540 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or1541 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"1542 section of linkgit:git-notes[1] for more information on each strategy.15431544notes.<name>.mergeStrategy::1545 Which merge strategy to choose when doing a notes merge into1546 refs/notes/<name>. This overrides the more general1547 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in1548 linkgit:git-notes[1] for more information on the available strategies.15491550notes.displayRef::1551 The (fully qualified) refname from which to show notes when1552 showing commit messages. The value of this variable can be set1553 to a glob, in which case notes from all matching refs will be1554 shown. You may also specify this configuration variable1555 several times. A warning will be issued for refs that do not1556 exist, but a glob that does not match any refs is silently1557 ignored.1558+1559This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`1560environment variable, which must be a colon separated list of refs or1561globs.1562+1563The effective value of "core.notesRef" (possibly overridden by1564GIT_NOTES_REF) is also implicitly added to the list of refs to be1565displayed.15661567notes.rewrite.<command>::1568 When rewriting commits with <command> (currently `amend` or1569 `rebase`) and this variable is set to `true`, Git1570 automatically copies your notes from the original to the1571 rewritten commit. Defaults to `true`, but see1572 "notes.rewriteRef" below.15731574notes.rewriteMode::1575 When copying notes during a rewrite (see the1576 "notes.rewrite.<command>" option), determines what to do if1577 the target commit already has a note. Must be one of1578 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.1579 Defaults to `concatenate`.1580+1581This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`1582environment variable.15831584notes.rewriteRef::1585 When copying notes during a rewrite, specifies the (fully1586 qualified) ref whose notes should be copied. The ref may be a1587 glob, in which case notes in all matching refs will be copied.1588 You may also specify this configuration several times.1589+1590Does not have a default value; you must configure this variable to1591enable note rewriting. Set it to `refs/notes/commits` to enable1592rewriting for the default commit notes.1593+1594This setting can be overridden with the `GIT_NOTES_REWRITE_REF`1595environment variable, which must be a colon separated list of refs or1596globs.15971598pack.window::1599 The size of the window used by linkgit:git-pack-objects[1] when no1600 window size is given on the command line. Defaults to 10.16011602pack.depth::1603 The maximum delta depth used by linkgit:git-pack-objects[1] when no1604 maximum depth is given on the command line. Defaults to 50.1605 Maximum value is 4095.16061607pack.windowMemory::1608 The maximum size of memory that is consumed by each thread1609 in linkgit:git-pack-objects[1] for pack window memory when1610 no limit is given on the command line. The value can be1611 suffixed with "k", "m", or "g". When left unconfigured (or1612 set explicitly to 0), there will be no limit.16131614pack.compression::1615 An integer -1..9, indicating the compression level for objects1616 in a pack file. -1 is the zlib default. 0 means no1617 compression, and 1..9 are various speed/size tradeoffs, 9 being1618 slowest. If not set, defaults to core.compression. If that is1619 not set, defaults to -1, the zlib default, which is "a default1620 compromise between speed and compression (currently equivalent1621 to level 6)."1622+1623Note that changing the compression level will not automatically recompress1624all existing objects. You can force recompression by passing the -F option1625to linkgit:git-repack[1].16261627pack.island::1628 An extended regular expression configuring a set of delta1629 islands. See "DELTA ISLANDS" in linkgit:git-pack-objects[1]1630 for details.16311632pack.islandCore::1633 Specify an island name which gets to have its objects be1634 packed first. This creates a kind of pseudo-pack at the front1635 of one pack, so that the objects from the specified island are1636 hopefully faster to copy into any pack that should be served1637 to a user requesting these objects. In practice this means1638 that the island specified should likely correspond to what is1639 the most commonly cloned in the repo. See also "DELTA ISLANDS"1640 in linkgit:git-pack-objects[1].16411642pack.deltaCacheSize::1643 The maximum memory in bytes used for caching deltas in1644 linkgit:git-pack-objects[1] before writing them out to a pack.1645 This cache is used to speed up the writing object phase by not1646 having to recompute the final delta result once the best match1647 for all objects is found. Repacking large repositories on machines1648 which are tight with memory might be badly impacted by this though,1649 especially if this cache pushes the system into swapping.1650 A value of 0 means no limit. The smallest size of 1 byte may be1651 used to virtually disable this cache. Defaults to 256 MiB.16521653pack.deltaCacheLimit::1654 The maximum size of a delta, that is cached in1655 linkgit:git-pack-objects[1]. This cache is used to speed up the1656 writing object phase by not having to recompute the final delta1657 result once the best match for all objects is found.1658 Defaults to 1000. Maximum value is 65535.16591660pack.threads::1661 Specifies the number of threads to spawn when searching for best1662 delta matches. This requires that linkgit:git-pack-objects[1]1663 be compiled with pthreads otherwise this option is ignored with a1664 warning. This is meant to reduce packing time on multiprocessor1665 machines. The required amount of memory for the delta search window1666 is however multiplied by the number of threads.1667 Specifying 0 will cause Git to auto-detect the number of CPU's1668 and set the number of threads accordingly.16691670pack.indexVersion::1671 Specify the default pack index version. Valid values are 1 for1672 legacy pack index used by Git versions prior to 1.5.2, and 2 for1673 the new pack index with capabilities for packs larger than 4 GB1674 as well as proper protection against the repacking of corrupted1675 packs. Version 2 is the default. Note that version 2 is enforced1676 and this config option ignored whenever the corresponding pack is1677 larger than 2 GB.1678+1679If you have an old Git that does not understand the version 2 `*.idx` file,1680cloning or fetching over a non native protocol (e.g. "http")1681that will copy both `*.pack` file and corresponding `*.idx` file from the1682other side may give you a repository that cannot be accessed with your1683older version of Git. If the `*.pack` file is smaller than 2 GB, however,1684you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1685the `*.idx` file.16861687pack.packSizeLimit::1688 The maximum size of a pack. This setting only affects1689 packing to a file when repacking, i.e. the git:// protocol1690 is unaffected. It can be overridden by the `--max-pack-size`1691 option of linkgit:git-repack[1]. Reaching this limit results1692 in the creation of multiple packfiles; which in turn prevents1693 bitmaps from being created.1694 The minimum size allowed is limited to 1 MiB.1695 The default is unlimited.1696 Common unit suffixes of 'k', 'm', or 'g' are1697 supported.16981699pack.useBitmaps::1700 When true, git will use pack bitmaps (if available) when packing1701 to stdout (e.g., during the server side of a fetch). Defaults to1702 true. You should not generally need to turn this off unless1703 you are debugging pack bitmaps.17041705pack.writeBitmaps (deprecated)::1706 This is a deprecated synonym for `repack.writeBitmaps`.17071708pack.writeBitmapHashCache::1709 When true, git will include a "hash cache" section in the bitmap1710 index (if one is written). This cache can be used to feed git's1711 delta heuristics, potentially leading to better deltas between1712 bitmapped and non-bitmapped objects (e.g., when serving a fetch1713 between an older, bitmapped pack and objects that have been1714 pushed since the last gc). The downside is that it consumes 41715 bytes per object of disk space, and that JGit's bitmap1716 implementation does not understand it, causing it to complain if1717 Git and JGit are used on the same repository. Defaults to false.17181719pager.<cmd>::1720 If the value is boolean, turns on or off pagination of the1721 output of a particular Git subcommand when writing to a tty.1722 Otherwise, turns on pagination for the subcommand using the1723 pager specified by the value of `pager.<cmd>`. If `--paginate`1724 or `--no-pager` is specified on the command line, it takes1725 precedence over this option. To disable pagination for all1726 commands, set `core.pager` or `GIT_PAGER` to `cat`.17271728pretty.<name>::1729 Alias for a --pretty= format string, as specified in1730 linkgit:git-log[1]. Any aliases defined here can be used just1731 as the built-in pretty formats could. For example,1732 running `git config pretty.changelog "format:* %H %s"`1733 would cause the invocation `git log --pretty=changelog`1734 to be equivalent to running `git log "--pretty=format:* %H %s"`.1735 Note that an alias with the same name as a built-in format1736 will be silently ignored.17371738protocol.allow::1739 If set, provide a user defined default policy for all protocols which1740 don't explicitly have a policy (`protocol.<name>.allow`). By default,1741 if unset, known-safe protocols (http, https, git, ssh, file) have a1742 default policy of `always`, known-dangerous protocols (ext) have a1743 default policy of `never`, and all other protocols have a default1744 policy of `user`. Supported policies:1745+1746--17471748* `always` - protocol is always able to be used.17491750* `never` - protocol is never able to be used.17511752* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is1753 either unset or has a value of 1. This policy should be used when you want a1754 protocol to be directly usable by the user but don't want it used by commands which1755 execute clone/fetch/push commands without user input, e.g. recursive1756 submodule initialization.17571758--17591760protocol.<name>.allow::1761 Set a policy to be used by protocol `<name>` with clone/fetch/push1762 commands. See `protocol.allow` above for the available policies.1763+1764The protocol names currently used by git are:1765+1766--1767 - `file`: any local file-based path (including `file://` URLs,1768 or local paths)17691770 - `git`: the anonymous git protocol over a direct TCP1771 connection (or proxy, if configured)17721773 - `ssh`: git over ssh (including `host:path` syntax,1774 `ssh://`, etc).17751776 - `http`: git over http, both "smart http" and "dumb http".1777 Note that this does _not_ include `https`; if you want to configure1778 both, you must do so individually.17791780 - any external helpers are named by their protocol (e.g., use1781 `hg` to allow the `git-remote-hg` helper)1782--17831784protocol.version::1785 Experimental. If set, clients will attempt to communicate with a1786 server using the specified protocol version. If unset, no1787 attempt will be made by the client to communicate using a1788 particular protocol version, this results in protocol version 01789 being used.1790 Supported versions:1791+1792--17931794* `0` - the original wire protocol.17951796* `1` - the original wire protocol with the addition of a version string1797 in the initial response from the server.17981799* `2` - link:technical/protocol-v2.html[wire protocol version 2].18001801--18021803include::pull-config.txt[]18041805include::push-config.txt[]18061807include::rebase-config.txt[]18081809include::receive-config.txt[]18101811remote.pushDefault::1812 The remote to push to by default. Overrides1813 `branch.<name>.remote` for all branches, and is overridden by1814 `branch.<name>.pushRemote` for specific branches.18151816remote.<name>.url::1817 The URL of a remote repository. See linkgit:git-fetch[1] or1818 linkgit:git-push[1].18191820remote.<name>.pushurl::1821 The push URL of a remote repository. See linkgit:git-push[1].18221823remote.<name>.proxy::1824 For remotes that require curl (http, https and ftp), the URL to1825 the proxy to use for that remote. Set to the empty string to1826 disable proxying for that remote.18271828remote.<name>.proxyAuthMethod::1829 For remotes that require curl (http, https and ftp), the method to use for1830 authenticating against the proxy in use (probably set in1831 `remote.<name>.proxy`). See `http.proxyAuthMethod`.18321833remote.<name>.fetch::1834 The default set of "refspec" for linkgit:git-fetch[1]. See1835 linkgit:git-fetch[1].18361837remote.<name>.push::1838 The default set of "refspec" for linkgit:git-push[1]. See1839 linkgit:git-push[1].18401841remote.<name>.mirror::1842 If true, pushing to this remote will automatically behave1843 as if the `--mirror` option was given on the command line.18441845remote.<name>.skipDefaultUpdate::1846 If true, this remote will be skipped by default when updating1847 using linkgit:git-fetch[1] or the `update` subcommand of1848 linkgit:git-remote[1].18491850remote.<name>.skipFetchAll::1851 If true, this remote will be skipped by default when updating1852 using linkgit:git-fetch[1] or the `update` subcommand of1853 linkgit:git-remote[1].18541855remote.<name>.receivepack::1856 The default program to execute on the remote side when pushing. See1857 option --receive-pack of linkgit:git-push[1].18581859remote.<name>.uploadpack::1860 The default program to execute on the remote side when fetching. See1861 option --upload-pack of linkgit:git-fetch-pack[1].18621863remote.<name>.tagOpt::1864 Setting this value to --no-tags disables automatic tag following when1865 fetching from remote <name>. Setting it to --tags will fetch every1866 tag from remote <name>, even if they are not reachable from remote1867 branch heads. Passing these flags directly to linkgit:git-fetch[1] can1868 override this setting. See options --tags and --no-tags of1869 linkgit:git-fetch[1].18701871remote.<name>.vcs::1872 Setting this to a value <vcs> will cause Git to interact with1873 the remote with the git-remote-<vcs> helper.18741875remote.<name>.prune::1876 When set to true, fetching from this remote by default will also1877 remove any remote-tracking references that no longer exist on the1878 remote (as if the `--prune` option was given on the command line).1879 Overrides `fetch.prune` settings, if any.18801881remote.<name>.pruneTags::1882 When set to true, fetching from this remote by default will also1883 remove any local tags that no longer exist on the remote if pruning1884 is activated in general via `remote.<name>.prune`, `fetch.prune` or1885 `--prune`. Overrides `fetch.pruneTags` settings, if any.1886+1887See also `remote.<name>.prune` and the PRUNING section of1888linkgit:git-fetch[1].18891890remotes.<group>::1891 The list of remotes which are fetched by "git remote update1892 <group>". See linkgit:git-remote[1].18931894repack.useDeltaBaseOffset::1895 By default, linkgit:git-repack[1] creates packs that use1896 delta-base offset. If you need to share your repository with1897 Git older than version 1.4.4, either directly or via a dumb1898 protocol such as http, then you need to set this option to1899 "false" and repack. Access from old Git versions over the1900 native protocol are unaffected by this option.19011902repack.packKeptObjects::1903 If set to true, makes `git repack` act as if1904 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for1905 details. Defaults to `false` normally, but `true` if a bitmap1906 index is being written (either via `--write-bitmap-index` or1907 `repack.writeBitmaps`).19081909repack.useDeltaIslands::1910 If set to true, makes `git repack` act as if `--delta-islands`1911 was passed. Defaults to `false`.19121913repack.writeBitmaps::1914 When true, git will write a bitmap index when packing all1915 objects to disk (e.g., when `git repack -a` is run). This1916 index can speed up the "counting objects" phase of subsequent1917 packs created for clones and fetches, at the cost of some disk1918 space and extra time spent on the initial repack. This has1919 no effect if multiple packfiles are created.1920 Defaults to false.19211922rerere.autoUpdate::1923 When set to true, `git-rerere` updates the index with the1924 resulting contents after it cleanly resolves conflicts using1925 previously recorded resolution. Defaults to false.19261927rerere.enabled::1928 Activate recording of resolved conflicts, so that identical1929 conflict hunks can be resolved automatically, should they be1930 encountered again. By default, linkgit:git-rerere[1] is1931 enabled if there is an `rr-cache` directory under the1932 `$GIT_DIR`, e.g. if "rerere" was previously used in the1933 repository.19341935reset.quiet::1936 When set to true, 'git reset' will default to the '--quiet' option.19371938include::sendemail-config.txt[]19391940sequence.editor::1941 Text editor used by `git rebase -i` for editing the rebase instruction file.1942 The value is meant to be interpreted by the shell when it is used.1943 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.1944 When not configured the default commit message editor is used instead.19451946showBranch.default::1947 The default set of branches for linkgit:git-show-branch[1].1948 See linkgit:git-show-branch[1].19491950splitIndex.maxPercentChange::1951 When the split index feature is used, this specifies the1952 percent of entries the split index can contain compared to the1953 total number of entries in both the split index and the shared1954 index before a new shared index is written.1955 The value should be between 0 and 100. If the value is 0 then1956 a new shared index is always written, if it is 100 a new1957 shared index is never written.1958 By default the value is 20, so a new shared index is written1959 if the number of entries in the split index would be greater1960 than 20 percent of the total number of entries.1961 See linkgit:git-update-index[1].19621963splitIndex.sharedIndexExpire::1964 When the split index feature is used, shared index files that1965 were not modified since the time this variable specifies will1966 be removed when a new shared index file is created. The value1967 "now" expires all entries immediately, and "never" suppresses1968 expiration altogether.1969 The default value is "2.weeks.ago".1970 Note that a shared index file is considered modified (for the1971 purpose of expiration) each time a new split-index file is1972 either created based on it or read from it.1973 See linkgit:git-update-index[1].19741975status.relativePaths::1976 By default, linkgit:git-status[1] shows paths relative to the1977 current directory. Setting this variable to `false` shows paths1978 relative to the repository root (this was the default for Git1979 prior to v1.5.4).19801981status.short::1982 Set to true to enable --short by default in linkgit:git-status[1].1983 The option --no-short takes precedence over this variable.19841985status.branch::1986 Set to true to enable --branch by default in linkgit:git-status[1].1987 The option --no-branch takes precedence over this variable.19881989status.displayCommentPrefix::1990 If set to true, linkgit:git-status[1] will insert a comment1991 prefix before each output line (starting with1992 `core.commentChar`, i.e. `#` by default). This was the1993 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.1994 Defaults to false.19951996status.renameLimit::1997 The number of files to consider when performing rename detection1998 in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to1999 the value of diff.renameLimit.20002001status.renames::2002 Whether and how Git detects renames in linkgit:git-status[1] and2003 linkgit:git-commit[1] . If set to "false", rename detection is2004 disabled. If set to "true", basic rename detection is enabled.2005 If set to "copies" or "copy", Git will detect copies, as well.2006 Defaults to the value of diff.renames.20072008status.showStash::2009 If set to true, linkgit:git-status[1] will display the number of2010 entries currently stashed away.2011 Defaults to false.20122013status.showUntrackedFiles::2014 By default, linkgit:git-status[1] and linkgit:git-commit[1] show2015 files which are not currently tracked by Git. Directories which2016 contain only untracked files, are shown with the directory name2017 only. Showing untracked files means that Git needs to lstat() all2018 the files in the whole repository, which might be slow on some2019 systems. So, this variable controls how the commands displays2020 the untracked files. Possible values are:2021+2022--2023* `no` - Show no untracked files.2024* `normal` - Show untracked files and directories.2025* `all` - Show also individual files in untracked directories.2026--2027+2028If this variable is not specified, it defaults to 'normal'.2029This variable can be overridden with the -u|--untracked-files option2030of linkgit:git-status[1] and linkgit:git-commit[1].20312032status.submoduleSummary::2033 Defaults to false.2034 If this is set to a non zero number or true (identical to -1 or an2035 unlimited number), the submodule summary will be enabled and a2036 summary of commits for modified submodules will be shown (see2037 --summary-limit option of linkgit:git-submodule[1]). Please note2038 that the summary output command will be suppressed for all2039 submodules when `diff.ignoreSubmodules` is set to 'all' or only2040 for those submodules where `submodule.<name>.ignore=all`. The only2041 exception to that rule is that status and commit will show staged2042 submodule changes. To2043 also view the summary for ignored submodules you can either use2044 the --ignore-submodules=dirty command-line option or the 'git2045 submodule summary' command, which shows a similar output but does2046 not honor these settings.20472048stash.showPatch::2049 If this is set to true, the `git stash show` command without an2050 option will show the stash entry in patch form. Defaults to false.2051 See description of 'show' command in linkgit:git-stash[1].20522053stash.showStat::2054 If this is set to true, the `git stash show` command without an2055 option will show diffstat of the stash entry. Defaults to true.2056 See description of 'show' command in linkgit:git-stash[1].20572058include::submodule-config.txt[]20592060tag.forceSignAnnotated::2061 A boolean to specify whether annotated tags created should be GPG signed.2062 If `--annotate` is specified on the command line, it takes2063 precedence over this option.20642065tag.sort::2066 This variable controls the sort ordering of tags when displayed by2067 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the2068 value of this variable will be used as the default.20692070tar.umask::2071 This variable can be used to restrict the permission bits of2072 tar archive entries. The default is 0002, which turns off the2073 world write bit. The special value "user" indicates that the2074 archiving user's umask will be used instead. See umask(2) and2075 linkgit:git-archive[1].20762077transfer.fsckObjects::2078 When `fetch.fsckObjects` or `receive.fsckObjects` are2079 not set, the value of this variable is used instead.2080 Defaults to false.2081+2082When set, the fetch or receive will abort in the case of a malformed2083object or a link to a nonexistent object. In addition, various other2084issues are checked for, including legacy issues (see `fsck.<msg-id>`),2085and potential security issues like the existence of a `.GIT` directory2086or a malicious `.gitmodules` file (see the release notes for v2.2.12087and v2.17.1 for details). Other sanity and security checks may be2088added in future releases.2089+2090On the receiving side, failing fsckObjects will make those objects2091unreachable, see "QUARANTINE ENVIRONMENT" in2092linkgit:git-receive-pack[1]. On the fetch side, malformed objects will2093instead be left unreferenced in the repository.2094+2095Due to the non-quarantine nature of the `fetch.fsckObjects`2096implementation it can not be relied upon to leave the object store2097clean like `receive.fsckObjects` can.2098+2099As objects are unpacked they're written to the object store, so there2100can be cases where malicious objects get introduced even though the2101"fetch" failed, only to have a subsequent "fetch" succeed because only2102new incoming objects are checked, not those that have already been2103written to the object store. That difference in behavior should not be2104relied upon. In the future, such objects may be quarantined for2105"fetch" as well.2106+2107For now, the paranoid need to find some way to emulate the quarantine2108environment if they'd like the same protection as "push". E.g. in the2109case of an internal mirror do the mirroring in two steps, one to fetch2110the untrusted objects, and then do a second "push" (which will use the2111quarantine) to another internal repo, and have internal clients2112consume this pushed-to repository, or embargo internal fetches and2113only allow them once a full "fsck" has run (and no new fetches have2114happened in the meantime).21152116transfer.hideRefs::2117 String(s) `receive-pack` and `upload-pack` use to decide which2118 refs to omit from their initial advertisements. Use more than2119 one definition to specify multiple prefix strings. A ref that is2120 under the hierarchies listed in the value of this variable is2121 excluded, and is hidden when responding to `git push` or `git2122 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for2123 program-specific versions of this config.2124+2125You may also include a `!` in front of the ref name to negate the entry,2126explicitly exposing it, even if an earlier entry marked it as hidden.2127If you have multiple hideRefs values, later entries override earlier ones2128(and entries in more-specific config files override less-specific ones).2129+2130If a namespace is in use, the namespace prefix is stripped from each2131reference before it is matched against `transfer.hiderefs` patterns.2132For example, if `refs/heads/master` is specified in `transfer.hideRefs` and2133the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`2134is omitted from the advertisements but `refs/heads/master` and2135`refs/namespaces/bar/refs/heads/master` are still advertised as so-called2136"have" lines. In order to match refs before stripping, add a `^` in front of2137the ref name. If you combine `!` and `^`, `!` must be specified first.2138+2139Even if you hide refs, a client may still be able to steal the target2140objects via the techniques described in the "SECURITY" section of the2141linkgit:gitnamespaces[7] man page; it's best to keep private data in a2142separate repository.21432144transfer.unpackLimit::2145 When `fetch.unpackLimit` or `receive.unpackLimit` are2146 not set, the value of this variable is used instead.2147 The default value is 100.21482149uploadarchive.allowUnreachable::2150 If true, allow clients to use `git archive --remote` to request2151 any tree, whether reachable from the ref tips or not. See the2152 discussion in the "SECURITY" section of2153 linkgit:git-upload-archive[1] for more details. Defaults to2154 `false`.21552156uploadpack.hideRefs::2157 This variable is the same as `transfer.hideRefs`, but applies2158 only to `upload-pack` (and so affects only fetches, not pushes).2159 An attempt to fetch a hidden ref by `git fetch` will fail. See2160 also `uploadpack.allowTipSHA1InWant`.21612162uploadpack.allowTipSHA1InWant::2163 When `uploadpack.hideRefs` is in effect, allow `upload-pack`2164 to accept a fetch request that asks for an object at the tip2165 of a hidden ref (by default, such a request is rejected).2166 See also `uploadpack.hideRefs`. Even if this is false, a client2167 may be able to steal objects via the techniques described in the2168 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's2169 best to keep private data in a separate repository.21702171uploadpack.allowReachableSHA1InWant::2172 Allow `upload-pack` to accept a fetch request that asks for an2173 object that is reachable from any ref tip. However, note that2174 calculating object reachability is computationally expensive.2175 Defaults to `false`. Even if this is false, a client may be able2176 to steal objects via the techniques described in the "SECURITY"2177 section of the linkgit:gitnamespaces[7] man page; it's best to2178 keep private data in a separate repository.21792180uploadpack.allowAnySHA1InWant::2181 Allow `upload-pack` to accept a fetch request that asks for any2182 object at all.2183 Defaults to `false`.21842185uploadpack.keepAlive::2186 When `upload-pack` has started `pack-objects`, there may be a2187 quiet period while `pack-objects` prepares the pack. Normally2188 it would output progress information, but if `--quiet` was used2189 for the fetch, `pack-objects` will output nothing at all until2190 the pack data begins. Some clients and networks may consider2191 the server to be hung and give up. Setting this option instructs2192 `upload-pack` to send an empty keepalive packet every2193 `uploadpack.keepAlive` seconds. Setting this option to 02194 disables keepalive packets entirely. The default is 5 seconds.21952196uploadpack.packObjectsHook::2197 If this option is set, when `upload-pack` would run2198 `git pack-objects` to create a packfile for a client, it will2199 run this shell command instead. The `pack-objects` command and2200 arguments it _would_ have run (including the `git pack-objects`2201 at the beginning) are appended to the shell command. The stdin2202 and stdout of the hook are treated as if `pack-objects` itself2203 was run. I.e., `upload-pack` will feed input intended for2204 `pack-objects` to the hook, and expects a completed packfile on2205 stdout.2206+2207Note that this configuration variable is ignored if it is seen in the2208repository-level config (this is a safety measure against fetching from2209untrusted repositories).22102211uploadpack.allowFilter::2212 If this option is set, `upload-pack` will support partial2213 clone and partial fetch object filtering.22142215uploadpack.allowRefInWant::2216 If this option is set, `upload-pack` will support the `ref-in-want`2217 feature of the protocol version 2 `fetch` command. This feature2218 is intended for the benefit of load-balanced servers which may2219 not have the same view of what OIDs their refs point to due to2220 replication delay.22212222url.<base>.insteadOf::2223 Any URL that starts with this value will be rewritten to2224 start, instead, with <base>. In cases where some site serves a2225 large number of repositories, and serves them with multiple2226 access methods, and some users need to use different access2227 methods, this feature allows people to specify any of the2228 equivalent URLs and have Git automatically rewrite the URL to2229 the best alternative for the particular user, even for a2230 never-before-seen repository on the site. When more than one2231 insteadOf strings match a given URL, the longest match is used.2232+2233Note that any protocol restrictions will be applied to the rewritten2234URL. If the rewrite changes the URL to use a custom protocol or remote2235helper, you may need to adjust the `protocol.*.allow` config to permit2236the request. In particular, protocols you expect to use for submodules2237must be set to `always` rather than the default of `user`. See the2238description of `protocol.allow` above.22392240url.<base>.pushInsteadOf::2241 Any URL that starts with this value will not be pushed to;2242 instead, it will be rewritten to start with <base>, and the2243 resulting URL will be pushed to. In cases where some site serves2244 a large number of repositories, and serves them with multiple2245 access methods, some of which do not allow push, this feature2246 allows people to specify a pull-only URL and have Git2247 automatically use an appropriate URL to push, even for a2248 never-before-seen repository on the site. When more than one2249 pushInsteadOf strings match a given URL, the longest match is2250 used. If a remote has an explicit pushurl, Git will ignore this2251 setting for that remote.22522253user.email::2254 Your email address to be recorded in any newly created commits.2255 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and2256 `EMAIL` environment variables. See linkgit:git-commit-tree[1].22572258user.name::2259 Your full name to be recorded in any newly created commits.2260 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`2261 environment variables. See linkgit:git-commit-tree[1].22622263user.useConfigOnly::2264 Instruct Git to avoid trying to guess defaults for `user.email`2265 and `user.name`, and instead retrieve the values only from the2266 configuration. For example, if you have multiple email addresses2267 and would like to use a different one for each repository, then2268 with this configuration option set to `true` in the global config2269 along with a name, Git will prompt you to set up an email before2270 making new commits in a newly cloned repository.2271 Defaults to `false`.22722273user.signingKey::2274 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the2275 key you want it to automatically when creating a signed tag or2276 commit, you can override the default selection with this variable.2277 This option is passed unchanged to gpg's --local-user parameter,2278 so you may specify a key using any method that gpg supports.22792280versionsort.prereleaseSuffix (deprecated)::2281 Deprecated alias for `versionsort.suffix`. Ignored if2282 `versionsort.suffix` is set.22832284versionsort.suffix::2285 Even when version sort is used in linkgit:git-tag[1], tagnames2286 with the same base version but different suffixes are still sorted2287 lexicographically, resulting e.g. in prerelease tags appearing2288 after the main release (e.g. "1.0-rc1" after "1.0"). This2289 variable can be specified to determine the sorting order of tags2290 with different suffixes.2291+2292By specifying a single suffix in this variable, any tagname containing2293that suffix will appear before the corresponding main release. E.g. if2294the variable is set to "-rc", then all "1.0-rcX" tags will appear before2295"1.0". If specified multiple times, once per suffix, then the order of2296suffixes in the configuration will determine the sorting order of tagnames2297with those suffixes. E.g. if "-pre" appears before "-rc" in the2298configuration, then all "1.0-preX" tags will be listed before any2299"1.0-rcX" tags. The placement of the main release tag relative to tags2300with various suffixes can be determined by specifying the empty suffix2301among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and2302"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags2303are listed first, followed by "v4.8", then "v4.8-ckX" and finally2304"v4.8-bfsX".2305+2306If more than one suffixes match the same tagname, then that tagname will2307be sorted according to the suffix which starts at the earliest position in2308the tagname. If more than one different matching suffixes start at2309that earliest position, then that tagname will be sorted according to the2310longest of those suffixes.2311The sorting order between different suffixes is undefined if they are2312in multiple config files.23132314web.browser::2315 Specify a web browser that may be used by some commands.2316 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]2317 may use it.23182319worktree.guessRemote::2320 With `add`, if no branch argument, and neither of `-b` nor2321 `-B` nor `--detach` are given, the command defaults to2322 creating a new branch from HEAD. If `worktree.guessRemote` is2323 set to true, `worktree add` tries to find a remote-tracking2324 branch whose name uniquely matches the new branch name. If2325 such a branch exists, it is checked out and set as "upstream"2326 for the new branch. If no such match can be found, it falls2327 back to creating a new branch from the current HEAD.