1CONFIGURATION FILE 2------------------ 3 4The Git configuration file contains a number of variables that affect 5the Git commands' behavior. The `.git/config` file in each repository 6is used to store the configuration for that repository, and 7`$HOME/.gitconfig` is used to store a per-user configuration as 8fallback values for the `.git/config` file. The file `/etc/gitconfig` 9can be used to store a system-wide default configuration. 10 11The configuration variables are used by both the Git plumbing 12and the porcelains. The variables are divided into sections, wherein 13the fully qualified variable name of the variable itself is the last 14dot-separated segment and the section name is everything before the last 15dot. The variable names are case-insensitive, allow only alphanumeric 16characters and `-`, and must start with an alphabetic character. Some 17variables may appear multiple times; we say then that the variable is 18multivalued. 19 20Syntax 21~~~~~~ 22 23The syntax is fairly flexible and permissive; whitespaces are mostly 24ignored. The '#' and ';' characters begin comments to the end of line, 25blank lines are ignored. 26 27The file consists of sections and variables. A section begins with 28the name of the section in square brackets and continues until the next 29section begins. Section names are case-insensitive. Only alphanumeric 30characters, `-` and `.` are allowed in section names. Each variable 31must belong to some section, which means that there must be a section 32header before the first setting of a variable. 33 34Sections can be further divided into subsections. To begin a subsection 35put its name in double quotes, separated by space from the section name, 36in the section header, like in the example below: 37 38-------- 39 [section "subsection"] 40 41-------- 42 43Subsection names are case sensitive and can contain any characters except 44newline and the null byte. Doublequote `"` and backslash can be included 45by escaping them as `\"` and `\\`, respectively. Backslashes preceding 46other characters are dropped when reading; for example, `\t` is read as 47`t` and `\0` is read as `0` Section headers cannot span multiple lines. 48Variables may belong directly to a section or to a given subsection. You 49can have `[section]` if you have `[section "subsection"]`, but you don't 50need to. 51 52There is also a deprecated `[section.subsection]` syntax. With this 53syntax, the subsection name is converted to lower-case and is also 54compared case sensitively. These subsection names follow the same 55restrictions as section names. 56 57All the other lines (and the remainder of the line after the section 58header) are recognized as setting variables, in the form 59'name = value' (or just 'name', which is a short-hand to say that 60the variable is the boolean "true"). 61The variable names are case-insensitive, allow only alphanumeric characters 62and `-`, and must start with an alphabetic character. 63 64A line that defines a value can be continued to the next line by 65ending it with a `\`; the backquote and the end-of-line are 66stripped. Leading whitespaces after 'name =', the remainder of the 67line after the first comment character '#' or ';', and trailing 68whitespaces of the line are discarded unless they are enclosed in 69double quotes. Internal whitespaces within the value are retained 70verbatim. 71 72Inside double quotes, double quote `"` and backslash `\` characters 73must be escaped: use `\"` for `"` and `\\` for `\`. 74 75The following escape sequences (beside `\"` and `\\`) are recognized: 76`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) 77and `\b` for backspace (BS). Other char escape sequences (including octal 78escape sequences) are invalid. 79 80 81Includes 82~~~~~~~~ 83 84The `include` and `includeIf` sections allow you to include config 85directives from another source. These sections behave identically to 86each other with the exception that `includeIf` sections may be ignored 87if their condition does not evaluate to true; see "Conditional includes" 88below. 89 90You can include a config file from another by setting the special 91`include.path` (or `includeIf.*.path`) variable to the name of the file 92to be included. The variable takes a pathname as its value, and is 93subject to tilde expansion. These variables can be given multiple times. 94 95The contents of the included file are inserted immediately, as if they 96had been found at the location of the include directive. If the value of the 97variable is a relative path, the path is considered to 98be relative to the configuration file in which the include directive 99was found. See below for examples. 100 101Conditional includes 102~~~~~~~~~~~~~~~~~~~~ 103 104You can include a config file from another conditionally by setting a 105`includeIf.<condition>.path` variable to the name of the file to be 106included. 107 108The condition starts with a keyword followed by a colon and some data 109whose format and meaning depends on the keyword. Supported keywords 110are: 111 112`gitdir`:: 113 114 The data that follows the keyword `gitdir:` is used as a glob 115 pattern. If the location of the .git directory matches the 116 pattern, the include condition is met. 117+ 118The .git location may be auto-discovered, or come from `$GIT_DIR` 119environment variable. If the repository is auto discovered via a .git 120file (e.g. from submodules, or a linked worktree), the .git location 121would be the final location where the .git directory is, not where the 122.git file is. 123+ 124The pattern can contain standard globbing wildcards and two additional 125ones, `**/` and `/**`, that can match multiple path components. Please 126refer to linkgit:gitignore[5] for details. For convenience: 127 128 * If the pattern starts with `~/`, `~` will be substituted with the 129 content of the environment variable `HOME`. 130 131 * If the pattern starts with `./`, it is replaced with the directory 132 containing the current config file. 133 134 * If the pattern does not start with either `~/`, `./` or `/`, `**/` 135 will be automatically prepended. For example, the pattern `foo/bar` 136 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`. 137 138 * If the pattern ends with `/`, `**` will be automatically added. For 139 example, the pattern `foo/` becomes `foo/**`. In other words, it 140 matches "foo" and everything inside, recursively. 141 142`gitdir/i`:: 143 This is the same as `gitdir` except that matching is done 144 case-insensitively (e.g. on case-insensitive file sytems) 145 146A few more notes on matching via `gitdir` and `gitdir/i`: 147 148 * Symlinks in `$GIT_DIR` are not resolved before matching. 149 150 * Both the symlink & realpath versions of paths will be matched 151 outside of `$GIT_DIR`. E.g. if ~/git is a symlink to 152 /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git` 153 will match. 154+ 155This was not the case in the initial release of this feature in 156v2.13.0, which only matched the realpath version. Configuration that 157wants to be compatible with the initial release of this feature needs 158to either specify only the realpath version, or both versions. 159 160 * Note that "../" is not special and will match literally, which is 161 unlikely what you want. 162 163Example 164~~~~~~~ 165 166 # Core variables 167 [core] 168 ; Don't trust file modes 169 filemode = false 170 171 # Our diff algorithm 172 [diff] 173 external = /usr/local/bin/diff-wrapper 174 renames = true 175 176 [branch "devel"] 177 remote = origin 178 merge = refs/heads/devel 179 180 # Proxy settings 181 [core] 182 gitProxy="ssh" for "kernel.org" 183 gitProxy=default-proxy ; for the rest 184 185 [include] 186 path = /path/to/foo.inc ; include by absolute path 187 path = foo.inc ; find "foo.inc" relative to the current file 188 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory 189 190 ; include if $GIT_DIR is /path/to/foo/.git 191 [includeIf "gitdir:/path/to/foo/.git"] 192 path = /path/to/foo.inc 193 194 ; include for all repositories inside /path/to/group 195 [includeIf "gitdir:/path/to/group/"] 196 path = /path/to/foo.inc 197 198 ; include for all repositories inside $HOME/to/group 199 [includeIf "gitdir:~/to/group/"] 200 path = /path/to/foo.inc 201 202 ; relative paths are always relative to the including 203 ; file (if the condition is true); their location is not 204 ; affected by the condition 205 [includeIf "gitdir:/path/to/group/"] 206 path = foo.inc 207 208Values 209~~~~~~ 210 211Values of many variables are treated as a simple string, but there 212are variables that take values of specific types and there are rules 213as to how to spell them. 214 215boolean:: 216 217 When a variable is said to take a boolean value, many 218 synonyms are accepted for 'true' and 'false'; these are all 219 case-insensitive. 220 221 true;; Boolean true literals are `yes`, `on`, `true`, 222 and `1`. Also, a variable defined without `= <value>` 223 is taken as true. 224 225 false;; Boolean false literals are `no`, `off`, `false`, 226 `0` and the empty string. 227+ 228When converting a value to its canonical form using the `--type=bool` type 229specifier, 'git config' will ensure that the output is "true" or 230"false" (spelled in lowercase). 231 232integer:: 233 The value for many variables that specify various sizes can 234 be suffixed with `k`, `M`,... to mean "scale the number by 235 1024", "by 1024x1024", etc. 236 237color:: 238 The value for a variable that takes a color is a list of 239 colors (at most two, one for foreground and one for background) 240 and attributes (as many as you want), separated by spaces. 241+ 242The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`, 243`blue`, `magenta`, `cyan` and `white`. The first color given is the 244foreground; the second is the background. 245+ 246Colors may also be given as numbers between 0 and 255; these use ANSI 247256-color mode (but note that not all terminals may support this). If 248your terminal supports it, you may also specify 24-bit RGB values as 249hex, like `#ff0ab3`. 250+ 251The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`, 252`italic`, and `strike` (for crossed-out or "strikethrough" letters). 253The position of any attributes with respect to the colors 254(before, after, or in between), doesn't matter. Specific attributes may 255be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`, 256`no-ul`, etc). 257+ 258An empty color string produces no color effect at all. This can be used 259to avoid coloring specific elements without disabling color entirely. 260+ 261For git's pre-defined color slots, the attributes are meant to be reset 262at the beginning of each item in the colored output. So setting 263`color.decorate.branch` to `black` will paint that branch name in a 264plain `black`, even if the previous thing on the same output line (e.g. 265opening parenthesis before the list of branch names in `log --decorate` 266output) is set to be painted with `bold` or some other attribute. 267However, custom log formats may do more complicated and layered 268coloring, and the negated forms may be useful there. 269 270pathname:: 271 A variable that takes a pathname value can be given a 272 string that begins with "`~/`" or "`~user/`", and the usual 273 tilde expansion happens to such a string: `~/` 274 is expanded to the value of `$HOME`, and `~user/` to the 275 specified user's home directory. 276 277 278Variables 279~~~~~~~~~ 280 281Note that this list is non-comprehensive and not necessarily complete. 282For command-specific variables, you will find a more detailed description 283in the appropriate manual page. 284 285Other git-related tools may and do use their own variables. When 286inventing new variables for use in your own tool, make sure their 287names do not conflict with those that are used by Git itself and 288other popular tools, and describe them in your documentation. 289 290include::config/advice.txt[] 291 292include::config/core.txt[] 293 294include::config/add.txt[] 295 296include::config/alias.txt[] 297 298include::config/am.txt[] 299 300include::config/apply.txt[] 301 302include::config/blame.txt[] 303 304include::config/branch.txt[] 305 306include::config/browser.txt[] 307 308include::config/checkout.txt[] 309 310include::config/clean.txt[] 311 312include::config/color.txt[] 313 314include::config/column.txt[] 315 316include::config/commit.txt[] 317 318include::config/credential.txt[] 319 320include::config/completion.txt[] 321 322include::config/diff.txt[] 323 324include::config/difftool.txt[] 325 326include::config/fastimport.txt[] 327 328include::config/fetch.txt[] 329 330include::config/format.txt[] 331 332include::config/filter.txt[] 333 334include::config/fsck.txt[] 335 336include::config/gc.txt[] 337 338include::config/gitcvs.txt[] 339 340include::config/gitweb.txt[] 341 342include::config/grep.txt[] 343 344include::config/gpg.txt[] 345 346include::config/gui.txt[] 347 348include::config/guitool.txt[] 349 350include::config/help.txt[] 351 352http.proxy:: 353 Override the HTTP proxy, normally configured using the 'http_proxy', 354 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In 355 addition to the syntax understood by curl, it is possible to specify a 356 proxy string with a user name but no password, in which case git will 357 attempt to acquire one in the same way it does for other credentials. See 358 linkgit:gitcredentials[7] for more information. The syntax thus is 359 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden 360 on a per-remote basis; see remote.<name>.proxy 361 362http.proxyAuthMethod:: 363 Set the method with which to authenticate against the HTTP proxy. This 364 only takes effect if the configured proxy string contains a user name part 365 (i.e. is of the form 'user@host' or 'user@host:port'). This can be 366 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`. 367 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment 368 variable. Possible values are: 369+ 370-- 371* `anyauth` - Automatically pick a suitable authentication method. It is 372 assumed that the proxy answers an unauthenticated request with a 407 373 status code and one or more Proxy-authenticate headers with supported 374 authentication methods. This is the default. 375* `basic` - HTTP Basic authentication 376* `digest` - HTTP Digest authentication; this prevents the password from being 377 transmitted to the proxy in clear text 378* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option 379 of `curl(1)`) 380* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`) 381-- 382 383http.emptyAuth:: 384 Attempt authentication without seeking a username or password. This 385 can be used to attempt GSS-Negotiate authentication without specifying 386 a username in the URL, as libcurl normally requires a username for 387 authentication. 388 389http.delegation:: 390 Control GSSAPI credential delegation. The delegation is disabled 391 by default in libcurl since version 7.21.7. Set parameter to tell 392 the server what it is allowed to delegate when it comes to user 393 credentials. Used with GSS/kerberos. Possible values are: 394+ 395-- 396* `none` - Don't allow any delegation. 397* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the 398 Kerberos service ticket, which is a matter of realm policy. 399* `always` - Unconditionally allow the server to delegate. 400-- 401 402 403http.extraHeader:: 404 Pass an additional HTTP header when communicating with a server. If 405 more than one such entry exists, all of them are added as extra 406 headers. To allow overriding the settings inherited from the system 407 config, an empty value will reset the extra headers to the empty list. 408 409http.cookieFile:: 410 The pathname of a file containing previously stored cookie lines, 411 which should be used 412 in the Git http session, if they match the server. The file format 413 of the file to read cookies from should be plain HTTP headers or 414 the Netscape/Mozilla cookie file format (see `curl(1)`). 415 NOTE that the file specified with http.cookieFile is used only as 416 input unless http.saveCookies is set. 417 418http.saveCookies:: 419 If set, store cookies received during requests to the file specified by 420 http.cookieFile. Has no effect if http.cookieFile is unset. 421 422http.sslVersion:: 423 The SSL version to use when negotiating an SSL connection, if you 424 want to force the default. The available and default version 425 depend on whether libcurl was built against NSS or OpenSSL and the 426 particular configuration of the crypto library in use. Internally 427 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl 428 documentation for more details on the format of this option and 429 for the ssl version supported. Actually the possible values of 430 this option are: 431 432 - sslv2 433 - sslv3 434 - tlsv1 435 - tlsv1.0 436 - tlsv1.1 437 - tlsv1.2 438 - tlsv1.3 439 440+ 441Can be overridden by the `GIT_SSL_VERSION` environment variable. 442To force git to use libcurl's default ssl version and ignore any 443explicit http.sslversion option, set `GIT_SSL_VERSION` to the 444empty string. 445 446http.sslCipherList:: 447 A list of SSL ciphers to use when negotiating an SSL connection. 448 The available ciphers depend on whether libcurl was built against 449 NSS or OpenSSL and the particular configuration of the crypto 450 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST' 451 option; see the libcurl documentation for more details on the format 452 of this list. 453+ 454Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable. 455To force git to use libcurl's default cipher list and ignore any 456explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the 457empty string. 458 459http.sslVerify:: 460 Whether to verify the SSL certificate when fetching or pushing 461 over HTTPS. Defaults to true. Can be overridden by the 462 `GIT_SSL_NO_VERIFY` environment variable. 463 464http.sslCert:: 465 File containing the SSL certificate when fetching or pushing 466 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment 467 variable. 468 469http.sslKey:: 470 File containing the SSL private key when fetching or pushing 471 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment 472 variable. 473 474http.sslCertPasswordProtected:: 475 Enable Git's password prompt for the SSL certificate. Otherwise 476 OpenSSL will prompt the user, possibly many times, if the 477 certificate or private key is encrypted. Can be overridden by the 478 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable. 479 480http.sslCAInfo:: 481 File containing the certificates to verify the peer with when 482 fetching or pushing over HTTPS. Can be overridden by the 483 `GIT_SSL_CAINFO` environment variable. 484 485http.sslCAPath:: 486 Path containing files with the CA certificates to verify the peer 487 with when fetching or pushing over HTTPS. Can be overridden 488 by the `GIT_SSL_CAPATH` environment variable. 489 490http.sslBackend:: 491 Name of the SSL backend to use (e.g. "openssl" or "schannel"). 492 This option is ignored if cURL lacks support for choosing the SSL 493 backend at runtime. 494 495http.schannelCheckRevoke:: 496 Used to enforce or disable certificate revocation checks in cURL 497 when http.sslBackend is set to "schannel". Defaults to `true` if 498 unset. Only necessary to disable this if Git consistently errors 499 and the message is about checking the revocation status of a 500 certificate. This option is ignored if cURL lacks support for 501 setting the relevant SSL option at runtime. 502 503http.schannelUseSSLCAInfo:: 504 As of cURL v7.60.0, the Secure Channel backend can use the 505 certificate bundle provided via `http.sslCAInfo`, but that would 506 override the Windows Certificate Store. Since this is not desirable 507 by default, Git will tell cURL not to use that bundle by default 508 when the `schannel` backend was configured via `http.sslBackend`, 509 unless `http.schannelUseSSLCAInfo` overrides this behavior. 510 511http.pinnedpubkey:: 512 Public key of the https service. It may either be the filename of 513 a PEM or DER encoded public key file or a string starting with 514 'sha256//' followed by the base64 encoded sha256 hash of the 515 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will 516 exit with an error if this option is set but not supported by 517 cURL. 518 519http.sslTry:: 520 Attempt to use AUTH SSL/TLS and encrypted data transfers 521 when connecting via regular FTP protocol. This might be needed 522 if the FTP server requires it for security reasons or you wish 523 to connect securely whenever remote FTP server supports it. 524 Default is false since it might trigger certificate verification 525 errors on misconfigured servers. 526 527http.maxRequests:: 528 How many HTTP requests to launch in parallel. Can be overridden 529 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5. 530 531http.minSessions:: 532 The number of curl sessions (counted across slots) to be kept across 533 requests. They will not be ended with curl_easy_cleanup() until 534 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this 535 value will be capped at 1. Defaults to 1. 536 537http.postBuffer:: 538 Maximum size in bytes of the buffer used by smart HTTP 539 transports when POSTing data to the remote system. 540 For requests larger than this buffer size, HTTP/1.1 and 541 Transfer-Encoding: chunked is used to avoid creating a 542 massive pack file locally. Default is 1 MiB, which is 543 sufficient for most requests. 544 545http.lowSpeedLimit, http.lowSpeedTime:: 546 If the HTTP transfer speed is less than 'http.lowSpeedLimit' 547 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted. 548 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and 549 `GIT_HTTP_LOW_SPEED_TIME` environment variables. 550 551http.noEPSV:: 552 A boolean which disables using of EPSV ftp command by curl. 553 This can helpful with some "poor" ftp servers which don't 554 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV` 555 environment variable. Default is false (curl will use EPSV). 556 557http.userAgent:: 558 The HTTP USER_AGENT string presented to an HTTP server. The default 559 value represents the version of the client Git such as git/1.7.1. 560 This option allows you to override this value to a more common value 561 such as Mozilla/4.0. This may be necessary, for instance, if 562 connecting through a firewall that restricts HTTP connections to a set 563 of common USER_AGENT strings (but not including those like git/1.7.1). 564 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable. 565 566http.followRedirects:: 567 Whether git should follow HTTP redirects. If set to `true`, git 568 will transparently follow any redirect issued by a server it 569 encounters. If set to `false`, git will treat all redirects as 570 errors. If set to `initial`, git will follow redirects only for 571 the initial request to a remote, but not for subsequent 572 follow-up HTTP requests. Since git uses the redirected URL as 573 the base for the follow-up requests, this is generally 574 sufficient. The default is `initial`. 575 576http.<url>.*:: 577 Any of the http.* options above can be applied selectively to some URLs. 578 For a config key to match a URL, each element of the config key is 579 compared to that of the URL, in the following order: 580+ 581-- 582. Scheme (e.g., `https` in `https://example.com/`). This field 583 must match exactly between the config key and the URL. 584 585. Host/domain name (e.g., `example.com` in `https://example.com/`). 586 This field must match between the config key and the URL. It is 587 possible to specify a `*` as part of the host name to match all subdomains 588 at this level. `https://*.example.com/` for example would match 589 `https://foo.example.com/`, but not `https://foo.bar.example.com/`. 590 591. Port number (e.g., `8080` in `http://example.com:8080/`). 592 This field must match exactly between the config key and the URL. 593 Omitted port numbers are automatically converted to the correct 594 default for the scheme before matching. 595 596. Path (e.g., `repo.git` in `https://example.com/repo.git`). The 597 path field of the config key must match the path field of the URL 598 either exactly or as a prefix of slash-delimited path elements. This means 599 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only 600 match on a slash (`/`) boundary. Longer matches take precedence (so a config 601 key with path `foo/bar` is a better match to URL path `foo/bar` than a config 602 key with just path `foo/`). 603 604. User name (e.g., `user` in `https://user@example.com/repo.git`). If 605 the config key has a user name it must match the user name in the 606 URL exactly. If the config key does not have a user name, that 607 config key will match a URL with any user name (including none), 608 but at a lower precedence than a config key with a user name. 609-- 610+ 611The list above is ordered by decreasing precedence; a URL that matches 612a config key's path is preferred to one that matches its user name. For example, 613if the URL is `https://user@example.com/foo/bar` a config key match of 614`https://example.com/foo` will be preferred over a config key match of 615`https://user@example.com`. 616+ 617All URLs are normalized before attempting any matching (the password part, 618if embedded in the URL, is always ignored for matching purposes) so that 619equivalent URLs that are simply spelled differently will match properly. 620Environment variable settings always override any matches. The URLs that are 621matched against are those given directly to Git commands. This means any URLs 622visited as a result of a redirection do not participate in matching. 623 624i18n.commitEncoding:: 625 Character encoding the commit messages are stored in; Git itself 626 does not care per se, but this information is necessary e.g. when 627 importing commits from emails or in the gitk graphical history 628 browser (and possibly at other places in the future or in other 629 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'. 630 631i18n.logOutputEncoding:: 632 Character encoding the commit messages are converted to when 633 running 'git log' and friends. 634 635imap:: 636 The configuration variables in the 'imap' section are described 637 in linkgit:git-imap-send[1]. 638 639index.threads:: 640 Specifies the number of threads to spawn when loading the index. 641 This is meant to reduce index load time on multiprocessor machines. 642 Specifying 0 or 'true' will cause Git to auto-detect the number of 643 CPU's and set the number of threads accordingly. Specifying 1 or 644 'false' will disable multithreading. Defaults to 'true'. 645 646index.version:: 647 Specify the version with which new index files should be 648 initialized. This does not affect existing repositories. 649 650init.templateDir:: 651 Specify the directory from which templates will be copied. 652 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].) 653 654instaweb.browser:: 655 Specify the program that will be used to browse your working 656 repository in gitweb. See linkgit:git-instaweb[1]. 657 658instaweb.httpd:: 659 The HTTP daemon command-line to start gitweb on your working 660 repository. See linkgit:git-instaweb[1]. 661 662instaweb.local:: 663 If true the web server started by linkgit:git-instaweb[1] will 664 be bound to the local IP (127.0.0.1). 665 666instaweb.modulePath:: 667 The default module path for linkgit:git-instaweb[1] to use 668 instead of /usr/lib/apache2/modules. Only used if httpd 669 is Apache. 670 671instaweb.port:: 672 The port number to bind the gitweb httpd to. See 673 linkgit:git-instaweb[1]. 674 675interactive.singleKey:: 676 In interactive commands, allow the user to provide one-letter 677 input with a single key (i.e., without hitting enter). 678 Currently this is used by the `--patch` mode of 679 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1], 680 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this 681 setting is silently ignored if portable keystroke input 682 is not available; requires the Perl module Term::ReadKey. 683 684interactive.diffFilter:: 685 When an interactive command (such as `git add --patch`) shows 686 a colorized diff, git will pipe the diff through the shell 687 command defined by this configuration variable. The command may 688 mark up the diff further for human consumption, provided that it 689 retains a one-to-one correspondence with the lines in the 690 original diff. Defaults to disabled (no filtering). 691 692log.abbrevCommit:: 693 If true, makes linkgit:git-log[1], linkgit:git-show[1], and 694 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may 695 override this option with `--no-abbrev-commit`. 696 697log.date:: 698 Set the default date-time mode for the 'log' command. 699 Setting a value for log.date is similar to using 'git log''s 700 `--date` option. See linkgit:git-log[1] for details. 701 702log.decorate:: 703 Print out the ref names of any commits that are shown by the log 704 command. If 'short' is specified, the ref name prefixes 'refs/heads/', 705 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is 706 specified, the full ref name (including prefix) will be printed. 707 If 'auto' is specified, then if the output is going to a terminal, 708 the ref names are shown as if 'short' were given, otherwise no ref 709 names are shown. This is the same as the `--decorate` option 710 of the `git log`. 711 712log.follow:: 713 If `true`, `git log` will act as if the `--follow` option was used when 714 a single <path> is given. This has the same limitations as `--follow`, 715 i.e. it cannot be used to follow multiple files and does not work well 716 on non-linear history. 717 718log.graphColors:: 719 A list of colors, separated by commas, that can be used to draw 720 history lines in `git log --graph`. 721 722log.showRoot:: 723 If true, the initial commit will be shown as a big creation event. 724 This is equivalent to a diff against an empty tree. 725 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which 726 normally hide the root commit will now show it. True by default. 727 728log.showSignature:: 729 If true, makes linkgit:git-log[1], linkgit:git-show[1], and 730 linkgit:git-whatchanged[1] assume `--show-signature`. 731 732log.mailmap:: 733 If true, makes linkgit:git-log[1], linkgit:git-show[1], and 734 linkgit:git-whatchanged[1] assume `--use-mailmap`. 735 736mailinfo.scissors:: 737 If true, makes linkgit:git-mailinfo[1] (and therefore 738 linkgit:git-am[1]) act by default as if the --scissors option 739 was provided on the command-line. When active, this features 740 removes everything from the message body before a scissors 741 line (i.e. consisting mainly of ">8", "8<" and "-"). 742 743mailmap.file:: 744 The location of an augmenting mailmap file. The default 745 mailmap, located in the root of the repository, is loaded 746 first, then the mailmap file pointed to by this variable. 747 The location of the mailmap file may be in a repository 748 subdirectory, or somewhere outside of the repository itself. 749 See linkgit:git-shortlog[1] and linkgit:git-blame[1]. 750 751mailmap.blob:: 752 Like `mailmap.file`, but consider the value as a reference to a 753 blob in the repository. If both `mailmap.file` and 754 `mailmap.blob` are given, both are parsed, with entries from 755 `mailmap.file` taking precedence. In a bare repository, this 756 defaults to `HEAD:.mailmap`. In a non-bare repository, it 757 defaults to empty. 758 759man.viewer:: 760 Specify the programs that may be used to display help in the 761 'man' format. See linkgit:git-help[1]. 762 763man.<tool>.cmd:: 764 Specify the command to invoke the specified man viewer. The 765 specified command is evaluated in shell with the man page 766 passed as argument. (See linkgit:git-help[1].) 767 768man.<tool>.path:: 769 Override the path for the given tool that may be used to 770 display help in the 'man' format. See linkgit:git-help[1]. 771 772include::merge-config.txt[] 773 774mergetool.<tool>.path:: 775 Override the path for the given tool. This is useful in case 776 your tool is not in the PATH. 777 778mergetool.<tool>.cmd:: 779 Specify the command to invoke the specified merge tool. The 780 specified command is evaluated in shell with the following 781 variables available: 'BASE' is the name of a temporary file 782 containing the common base of the files to be merged, if available; 783 'LOCAL' is the name of a temporary file containing the contents of 784 the file on the current branch; 'REMOTE' is the name of a temporary 785 file containing the contents of the file from the branch being 786 merged; 'MERGED' contains the name of the file to which the merge 787 tool should write the results of a successful merge. 788 789mergetool.<tool>.trustExitCode:: 790 For a custom merge command, specify whether the exit code of 791 the merge command can be used to determine whether the merge was 792 successful. If this is not set to true then the merge target file 793 timestamp is checked and the merge assumed to have been successful 794 if the file has been updated, otherwise the user is prompted to 795 indicate the success of the merge. 796 797mergetool.meld.hasOutput:: 798 Older versions of `meld` do not support the `--output` option. 799 Git will attempt to detect whether `meld` supports `--output` 800 by inspecting the output of `meld --help`. Configuring 801 `mergetool.meld.hasOutput` will make Git skip these checks and 802 use the configured value instead. Setting `mergetool.meld.hasOutput` 803 to `true` tells Git to unconditionally use the `--output` option, 804 and `false` avoids using `--output`. 805 806mergetool.keepBackup:: 807 After performing a merge, the original file with conflict markers 808 can be saved as a file with a `.orig` extension. If this variable 809 is set to `false` then this file is not preserved. Defaults to 810 `true` (i.e. keep the backup files). 811 812mergetool.keepTemporaries:: 813 When invoking a custom merge tool, Git uses a set of temporary 814 files to pass to the tool. If the tool returns an error and this 815 variable is set to `true`, then these temporary files will be 816 preserved, otherwise they will be removed after the tool has 817 exited. Defaults to `false`. 818 819mergetool.writeToTemp:: 820 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of 821 conflicting files in the worktree by default. Git will attempt 822 to use a temporary directory for these files when set `true`. 823 Defaults to `false`. 824 825mergetool.prompt:: 826 Prompt before each invocation of the merge resolution program. 827 828notes.mergeStrategy:: 829 Which merge strategy to choose by default when resolving notes 830 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or 831 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES" 832 section of linkgit:git-notes[1] for more information on each strategy. 833 834notes.<name>.mergeStrategy:: 835 Which merge strategy to choose when doing a notes merge into 836 refs/notes/<name>. This overrides the more general 837 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in 838 linkgit:git-notes[1] for more information on the available strategies. 839 840notes.displayRef:: 841 The (fully qualified) refname from which to show notes when 842 showing commit messages. The value of this variable can be set 843 to a glob, in which case notes from all matching refs will be 844 shown. You may also specify this configuration variable 845 several times. A warning will be issued for refs that do not 846 exist, but a glob that does not match any refs is silently 847 ignored. 848+ 849This setting can be overridden with the `GIT_NOTES_DISPLAY_REF` 850environment variable, which must be a colon separated list of refs or 851globs. 852+ 853The effective value of "core.notesRef" (possibly overridden by 854GIT_NOTES_REF) is also implicitly added to the list of refs to be 855displayed. 856 857notes.rewrite.<command>:: 858 When rewriting commits with <command> (currently `amend` or 859 `rebase`) and this variable is set to `true`, Git 860 automatically copies your notes from the original to the 861 rewritten commit. Defaults to `true`, but see 862 "notes.rewriteRef" below. 863 864notes.rewriteMode:: 865 When copying notes during a rewrite (see the 866 "notes.rewrite.<command>" option), determines what to do if 867 the target commit already has a note. Must be one of 868 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`. 869 Defaults to `concatenate`. 870+ 871This setting can be overridden with the `GIT_NOTES_REWRITE_MODE` 872environment variable. 873 874notes.rewriteRef:: 875 When copying notes during a rewrite, specifies the (fully 876 qualified) ref whose notes should be copied. The ref may be a 877 glob, in which case notes in all matching refs will be copied. 878 You may also specify this configuration several times. 879+ 880Does not have a default value; you must configure this variable to 881enable note rewriting. Set it to `refs/notes/commits` to enable 882rewriting for the default commit notes. 883+ 884This setting can be overridden with the `GIT_NOTES_REWRITE_REF` 885environment variable, which must be a colon separated list of refs or 886globs. 887 888pack.window:: 889 The size of the window used by linkgit:git-pack-objects[1] when no 890 window size is given on the command line. Defaults to 10. 891 892pack.depth:: 893 The maximum delta depth used by linkgit:git-pack-objects[1] when no 894 maximum depth is given on the command line. Defaults to 50. 895 Maximum value is 4095. 896 897pack.windowMemory:: 898 The maximum size of memory that is consumed by each thread 899 in linkgit:git-pack-objects[1] for pack window memory when 900 no limit is given on the command line. The value can be 901 suffixed with "k", "m", or "g". When left unconfigured (or 902 set explicitly to 0), there will be no limit. 903 904pack.compression:: 905 An integer -1..9, indicating the compression level for objects 906 in a pack file. -1 is the zlib default. 0 means no 907 compression, and 1..9 are various speed/size tradeoffs, 9 being 908 slowest. If not set, defaults to core.compression. If that is 909 not set, defaults to -1, the zlib default, which is "a default 910 compromise between speed and compression (currently equivalent 911 to level 6)." 912+ 913Note that changing the compression level will not automatically recompress 914all existing objects. You can force recompression by passing the -F option 915to linkgit:git-repack[1]. 916 917pack.island:: 918 An extended regular expression configuring a set of delta 919 islands. See "DELTA ISLANDS" in linkgit:git-pack-objects[1] 920 for details. 921 922pack.islandCore:: 923 Specify an island name which gets to have its objects be 924 packed first. This creates a kind of pseudo-pack at the front 925 of one pack, so that the objects from the specified island are 926 hopefully faster to copy into any pack that should be served 927 to a user requesting these objects. In practice this means 928 that the island specified should likely correspond to what is 929 the most commonly cloned in the repo. See also "DELTA ISLANDS" 930 in linkgit:git-pack-objects[1]. 931 932pack.deltaCacheSize:: 933 The maximum memory in bytes used for caching deltas in 934 linkgit:git-pack-objects[1] before writing them out to a pack. 935 This cache is used to speed up the writing object phase by not 936 having to recompute the final delta result once the best match 937 for all objects is found. Repacking large repositories on machines 938 which are tight with memory might be badly impacted by this though, 939 especially if this cache pushes the system into swapping. 940 A value of 0 means no limit. The smallest size of 1 byte may be 941 used to virtually disable this cache. Defaults to 256 MiB. 942 943pack.deltaCacheLimit:: 944 The maximum size of a delta, that is cached in 945 linkgit:git-pack-objects[1]. This cache is used to speed up the 946 writing object phase by not having to recompute the final delta 947 result once the best match for all objects is found. 948 Defaults to 1000. Maximum value is 65535. 949 950pack.threads:: 951 Specifies the number of threads to spawn when searching for best 952 delta matches. This requires that linkgit:git-pack-objects[1] 953 be compiled with pthreads otherwise this option is ignored with a 954 warning. This is meant to reduce packing time on multiprocessor 955 machines. The required amount of memory for the delta search window 956 is however multiplied by the number of threads. 957 Specifying 0 will cause Git to auto-detect the number of CPU's 958 and set the number of threads accordingly. 959 960pack.indexVersion:: 961 Specify the default pack index version. Valid values are 1 for 962 legacy pack index used by Git versions prior to 1.5.2, and 2 for 963 the new pack index with capabilities for packs larger than 4 GB 964 as well as proper protection against the repacking of corrupted 965 packs. Version 2 is the default. Note that version 2 is enforced 966 and this config option ignored whenever the corresponding pack is 967 larger than 2 GB. 968+ 969If you have an old Git that does not understand the version 2 `*.idx` file, 970cloning or fetching over a non native protocol (e.g. "http") 971that will copy both `*.pack` file and corresponding `*.idx` file from the 972other side may give you a repository that cannot be accessed with your 973older version of Git. If the `*.pack` file is smaller than 2 GB, however, 974you can use linkgit:git-index-pack[1] on the *.pack file to regenerate 975the `*.idx` file. 976 977pack.packSizeLimit:: 978 The maximum size of a pack. This setting only affects 979 packing to a file when repacking, i.e. the git:// protocol 980 is unaffected. It can be overridden by the `--max-pack-size` 981 option of linkgit:git-repack[1]. Reaching this limit results 982 in the creation of multiple packfiles; which in turn prevents 983 bitmaps from being created. 984 The minimum size allowed is limited to 1 MiB. 985 The default is unlimited. 986 Common unit suffixes of 'k', 'm', or 'g' are 987 supported. 988 989pack.useBitmaps:: 990 When true, git will use pack bitmaps (if available) when packing 991 to stdout (e.g., during the server side of a fetch). Defaults to 992 true. You should not generally need to turn this off unless 993 you are debugging pack bitmaps. 994 995pack.writeBitmaps (deprecated):: 996 This is a deprecated synonym for `repack.writeBitmaps`. 997 998pack.writeBitmapHashCache:: 999 When true, git will include a "hash cache" section in the bitmap1000 index (if one is written). This cache can be used to feed git's1001 delta heuristics, potentially leading to better deltas between1002 bitmapped and non-bitmapped objects (e.g., when serving a fetch1003 between an older, bitmapped pack and objects that have been1004 pushed since the last gc). The downside is that it consumes 41005 bytes per object of disk space, and that JGit's bitmap1006 implementation does not understand it, causing it to complain if1007 Git and JGit are used on the same repository. Defaults to false.10081009pager.<cmd>::1010 If the value is boolean, turns on or off pagination of the1011 output of a particular Git subcommand when writing to a tty.1012 Otherwise, turns on pagination for the subcommand using the1013 pager specified by the value of `pager.<cmd>`. If `--paginate`1014 or `--no-pager` is specified on the command line, it takes1015 precedence over this option. To disable pagination for all1016 commands, set `core.pager` or `GIT_PAGER` to `cat`.10171018pretty.<name>::1019 Alias for a --pretty= format string, as specified in1020 linkgit:git-log[1]. Any aliases defined here can be used just1021 as the built-in pretty formats could. For example,1022 running `git config pretty.changelog "format:* %H %s"`1023 would cause the invocation `git log --pretty=changelog`1024 to be equivalent to running `git log "--pretty=format:* %H %s"`.1025 Note that an alias with the same name as a built-in format1026 will be silently ignored.10271028protocol.allow::1029 If set, provide a user defined default policy for all protocols which1030 don't explicitly have a policy (`protocol.<name>.allow`). By default,1031 if unset, known-safe protocols (http, https, git, ssh, file) have a1032 default policy of `always`, known-dangerous protocols (ext) have a1033 default policy of `never`, and all other protocols have a default1034 policy of `user`. Supported policies:1035+1036--10371038* `always` - protocol is always able to be used.10391040* `never` - protocol is never able to be used.10411042* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is1043 either unset or has a value of 1. This policy should be used when you want a1044 protocol to be directly usable by the user but don't want it used by commands which1045 execute clone/fetch/push commands without user input, e.g. recursive1046 submodule initialization.10471048--10491050protocol.<name>.allow::1051 Set a policy to be used by protocol `<name>` with clone/fetch/push1052 commands. See `protocol.allow` above for the available policies.1053+1054The protocol names currently used by git are:1055+1056--1057 - `file`: any local file-based path (including `file://` URLs,1058 or local paths)10591060 - `git`: the anonymous git protocol over a direct TCP1061 connection (or proxy, if configured)10621063 - `ssh`: git over ssh (including `host:path` syntax,1064 `ssh://`, etc).10651066 - `http`: git over http, both "smart http" and "dumb http".1067 Note that this does _not_ include `https`; if you want to configure1068 both, you must do so individually.10691070 - any external helpers are named by their protocol (e.g., use1071 `hg` to allow the `git-remote-hg` helper)1072--10731074protocol.version::1075 Experimental. If set, clients will attempt to communicate with a1076 server using the specified protocol version. If unset, no1077 attempt will be made by the client to communicate using a1078 particular protocol version, this results in protocol version 01079 being used.1080 Supported versions:1081+1082--10831084* `0` - the original wire protocol.10851086* `1` - the original wire protocol with the addition of a version string1087 in the initial response from the server.10881089* `2` - link:technical/protocol-v2.html[wire protocol version 2].10901091--10921093include::pull-config.txt[]10941095include::push-config.txt[]10961097include::rebase-config.txt[]10981099include::receive-config.txt[]11001101remote.pushDefault::1102 The remote to push to by default. Overrides1103 `branch.<name>.remote` for all branches, and is overridden by1104 `branch.<name>.pushRemote` for specific branches.11051106remote.<name>.url::1107 The URL of a remote repository. See linkgit:git-fetch[1] or1108 linkgit:git-push[1].11091110remote.<name>.pushurl::1111 The push URL of a remote repository. See linkgit:git-push[1].11121113remote.<name>.proxy::1114 For remotes that require curl (http, https and ftp), the URL to1115 the proxy to use for that remote. Set to the empty string to1116 disable proxying for that remote.11171118remote.<name>.proxyAuthMethod::1119 For remotes that require curl (http, https and ftp), the method to use for1120 authenticating against the proxy in use (probably set in1121 `remote.<name>.proxy`). See `http.proxyAuthMethod`.11221123remote.<name>.fetch::1124 The default set of "refspec" for linkgit:git-fetch[1]. See1125 linkgit:git-fetch[1].11261127remote.<name>.push::1128 The default set of "refspec" for linkgit:git-push[1]. See1129 linkgit:git-push[1].11301131remote.<name>.mirror::1132 If true, pushing to this remote will automatically behave1133 as if the `--mirror` option was given on the command line.11341135remote.<name>.skipDefaultUpdate::1136 If true, this remote will be skipped by default when updating1137 using linkgit:git-fetch[1] or the `update` subcommand of1138 linkgit:git-remote[1].11391140remote.<name>.skipFetchAll::1141 If true, this remote will be skipped by default when updating1142 using linkgit:git-fetch[1] or the `update` subcommand of1143 linkgit:git-remote[1].11441145remote.<name>.receivepack::1146 The default program to execute on the remote side when pushing. See1147 option --receive-pack of linkgit:git-push[1].11481149remote.<name>.uploadpack::1150 The default program to execute on the remote side when fetching. See1151 option --upload-pack of linkgit:git-fetch-pack[1].11521153remote.<name>.tagOpt::1154 Setting this value to --no-tags disables automatic tag following when1155 fetching from remote <name>. Setting it to --tags will fetch every1156 tag from remote <name>, even if they are not reachable from remote1157 branch heads. Passing these flags directly to linkgit:git-fetch[1] can1158 override this setting. See options --tags and --no-tags of1159 linkgit:git-fetch[1].11601161remote.<name>.vcs::1162 Setting this to a value <vcs> will cause Git to interact with1163 the remote with the git-remote-<vcs> helper.11641165remote.<name>.prune::1166 When set to true, fetching from this remote by default will also1167 remove any remote-tracking references that no longer exist on the1168 remote (as if the `--prune` option was given on the command line).1169 Overrides `fetch.prune` settings, if any.11701171remote.<name>.pruneTags::1172 When set to true, fetching from this remote by default will also1173 remove any local tags that no longer exist on the remote if pruning1174 is activated in general via `remote.<name>.prune`, `fetch.prune` or1175 `--prune`. Overrides `fetch.pruneTags` settings, if any.1176+1177See also `remote.<name>.prune` and the PRUNING section of1178linkgit:git-fetch[1].11791180remotes.<group>::1181 The list of remotes which are fetched by "git remote update1182 <group>". See linkgit:git-remote[1].11831184repack.useDeltaBaseOffset::1185 By default, linkgit:git-repack[1] creates packs that use1186 delta-base offset. If you need to share your repository with1187 Git older than version 1.4.4, either directly or via a dumb1188 protocol such as http, then you need to set this option to1189 "false" and repack. Access from old Git versions over the1190 native protocol are unaffected by this option.11911192repack.packKeptObjects::1193 If set to true, makes `git repack` act as if1194 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for1195 details. Defaults to `false` normally, but `true` if a bitmap1196 index is being written (either via `--write-bitmap-index` or1197 `repack.writeBitmaps`).11981199repack.useDeltaIslands::1200 If set to true, makes `git repack` act as if `--delta-islands`1201 was passed. Defaults to `false`.12021203repack.writeBitmaps::1204 When true, git will write a bitmap index when packing all1205 objects to disk (e.g., when `git repack -a` is run). This1206 index can speed up the "counting objects" phase of subsequent1207 packs created for clones and fetches, at the cost of some disk1208 space and extra time spent on the initial repack. This has1209 no effect if multiple packfiles are created.1210 Defaults to false.12111212rerere.autoUpdate::1213 When set to true, `git-rerere` updates the index with the1214 resulting contents after it cleanly resolves conflicts using1215 previously recorded resolution. Defaults to false.12161217rerere.enabled::1218 Activate recording of resolved conflicts, so that identical1219 conflict hunks can be resolved automatically, should they be1220 encountered again. By default, linkgit:git-rerere[1] is1221 enabled if there is an `rr-cache` directory under the1222 `$GIT_DIR`, e.g. if "rerere" was previously used in the1223 repository.12241225reset.quiet::1226 When set to true, 'git reset' will default to the '--quiet' option.12271228include::sendemail-config.txt[]12291230sequence.editor::1231 Text editor used by `git rebase -i` for editing the rebase instruction file.1232 The value is meant to be interpreted by the shell when it is used.1233 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.1234 When not configured the default commit message editor is used instead.12351236showBranch.default::1237 The default set of branches for linkgit:git-show-branch[1].1238 See linkgit:git-show-branch[1].12391240splitIndex.maxPercentChange::1241 When the split index feature is used, this specifies the1242 percent of entries the split index can contain compared to the1243 total number of entries in both the split index and the shared1244 index before a new shared index is written.1245 The value should be between 0 and 100. If the value is 0 then1246 a new shared index is always written, if it is 100 a new1247 shared index is never written.1248 By default the value is 20, so a new shared index is written1249 if the number of entries in the split index would be greater1250 than 20 percent of the total number of entries.1251 See linkgit:git-update-index[1].12521253splitIndex.sharedIndexExpire::1254 When the split index feature is used, shared index files that1255 were not modified since the time this variable specifies will1256 be removed when a new shared index file is created. The value1257 "now" expires all entries immediately, and "never" suppresses1258 expiration altogether.1259 The default value is "2.weeks.ago".1260 Note that a shared index file is considered modified (for the1261 purpose of expiration) each time a new split-index file is1262 either created based on it or read from it.1263 See linkgit:git-update-index[1].12641265include::config/ssh.txt[]12661267status.relativePaths::1268 By default, linkgit:git-status[1] shows paths relative to the1269 current directory. Setting this variable to `false` shows paths1270 relative to the repository root (this was the default for Git1271 prior to v1.5.4).12721273status.short::1274 Set to true to enable --short by default in linkgit:git-status[1].1275 The option --no-short takes precedence over this variable.12761277status.branch::1278 Set to true to enable --branch by default in linkgit:git-status[1].1279 The option --no-branch takes precedence over this variable.12801281status.displayCommentPrefix::1282 If set to true, linkgit:git-status[1] will insert a comment1283 prefix before each output line (starting with1284 `core.commentChar`, i.e. `#` by default). This was the1285 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.1286 Defaults to false.12871288status.renameLimit::1289 The number of files to consider when performing rename detection1290 in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to1291 the value of diff.renameLimit.12921293status.renames::1294 Whether and how Git detects renames in linkgit:git-status[1] and1295 linkgit:git-commit[1] . If set to "false", rename detection is1296 disabled. If set to "true", basic rename detection is enabled.1297 If set to "copies" or "copy", Git will detect copies, as well.1298 Defaults to the value of diff.renames.12991300status.showStash::1301 If set to true, linkgit:git-status[1] will display the number of1302 entries currently stashed away.1303 Defaults to false.13041305status.showUntrackedFiles::1306 By default, linkgit:git-status[1] and linkgit:git-commit[1] show1307 files which are not currently tracked by Git. Directories which1308 contain only untracked files, are shown with the directory name1309 only. Showing untracked files means that Git needs to lstat() all1310 the files in the whole repository, which might be slow on some1311 systems. So, this variable controls how the commands displays1312 the untracked files. Possible values are:1313+1314--1315* `no` - Show no untracked files.1316* `normal` - Show untracked files and directories.1317* `all` - Show also individual files in untracked directories.1318--1319+1320If this variable is not specified, it defaults to 'normal'.1321This variable can be overridden with the -u|--untracked-files option1322of linkgit:git-status[1] and linkgit:git-commit[1].13231324status.submoduleSummary::1325 Defaults to false.1326 If this is set to a non zero number or true (identical to -1 or an1327 unlimited number), the submodule summary will be enabled and a1328 summary of commits for modified submodules will be shown (see1329 --summary-limit option of linkgit:git-submodule[1]). Please note1330 that the summary output command will be suppressed for all1331 submodules when `diff.ignoreSubmodules` is set to 'all' or only1332 for those submodules where `submodule.<name>.ignore=all`. The only1333 exception to that rule is that status and commit will show staged1334 submodule changes. To1335 also view the summary for ignored submodules you can either use1336 the --ignore-submodules=dirty command-line option or the 'git1337 submodule summary' command, which shows a similar output but does1338 not honor these settings.13391340stash.showPatch::1341 If this is set to true, the `git stash show` command without an1342 option will show the stash entry in patch form. Defaults to false.1343 See description of 'show' command in linkgit:git-stash[1].13441345stash.showStat::1346 If this is set to true, the `git stash show` command without an1347 option will show diffstat of the stash entry. Defaults to true.1348 See description of 'show' command in linkgit:git-stash[1].13491350include::submodule-config.txt[]13511352tag.forceSignAnnotated::1353 A boolean to specify whether annotated tags created should be GPG signed.1354 If `--annotate` is specified on the command line, it takes1355 precedence over this option.13561357tag.sort::1358 This variable controls the sort ordering of tags when displayed by1359 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the1360 value of this variable will be used as the default.13611362tar.umask::1363 This variable can be used to restrict the permission bits of1364 tar archive entries. The default is 0002, which turns off the1365 world write bit. The special value "user" indicates that the1366 archiving user's umask will be used instead. See umask(2) and1367 linkgit:git-archive[1].13681369transfer.fsckObjects::1370 When `fetch.fsckObjects` or `receive.fsckObjects` are1371 not set, the value of this variable is used instead.1372 Defaults to false.1373+1374When set, the fetch or receive will abort in the case of a malformed1375object or a link to a nonexistent object. In addition, various other1376issues are checked for, including legacy issues (see `fsck.<msg-id>`),1377and potential security issues like the existence of a `.GIT` directory1378or a malicious `.gitmodules` file (see the release notes for v2.2.11379and v2.17.1 for details). Other sanity and security checks may be1380added in future releases.1381+1382On the receiving side, failing fsckObjects will make those objects1383unreachable, see "QUARANTINE ENVIRONMENT" in1384linkgit:git-receive-pack[1]. On the fetch side, malformed objects will1385instead be left unreferenced in the repository.1386+1387Due to the non-quarantine nature of the `fetch.fsckObjects`1388implementation it can not be relied upon to leave the object store1389clean like `receive.fsckObjects` can.1390+1391As objects are unpacked they're written to the object store, so there1392can be cases where malicious objects get introduced even though the1393"fetch" failed, only to have a subsequent "fetch" succeed because only1394new incoming objects are checked, not those that have already been1395written to the object store. That difference in behavior should not be1396relied upon. In the future, such objects may be quarantined for1397"fetch" as well.1398+1399For now, the paranoid need to find some way to emulate the quarantine1400environment if they'd like the same protection as "push". E.g. in the1401case of an internal mirror do the mirroring in two steps, one to fetch1402the untrusted objects, and then do a second "push" (which will use the1403quarantine) to another internal repo, and have internal clients1404consume this pushed-to repository, or embargo internal fetches and1405only allow them once a full "fsck" has run (and no new fetches have1406happened in the meantime).14071408transfer.hideRefs::1409 String(s) `receive-pack` and `upload-pack` use to decide which1410 refs to omit from their initial advertisements. Use more than1411 one definition to specify multiple prefix strings. A ref that is1412 under the hierarchies listed in the value of this variable is1413 excluded, and is hidden when responding to `git push` or `git1414 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for1415 program-specific versions of this config.1416+1417You may also include a `!` in front of the ref name to negate the entry,1418explicitly exposing it, even if an earlier entry marked it as hidden.1419If you have multiple hideRefs values, later entries override earlier ones1420(and entries in more-specific config files override less-specific ones).1421+1422If a namespace is in use, the namespace prefix is stripped from each1423reference before it is matched against `transfer.hiderefs` patterns.1424For example, if `refs/heads/master` is specified in `transfer.hideRefs` and1425the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`1426is omitted from the advertisements but `refs/heads/master` and1427`refs/namespaces/bar/refs/heads/master` are still advertised as so-called1428"have" lines. In order to match refs before stripping, add a `^` in front of1429the ref name. If you combine `!` and `^`, `!` must be specified first.1430+1431Even if you hide refs, a client may still be able to steal the target1432objects via the techniques described in the "SECURITY" section of the1433linkgit:gitnamespaces[7] man page; it's best to keep private data in a1434separate repository.14351436transfer.unpackLimit::1437 When `fetch.unpackLimit` or `receive.unpackLimit` are1438 not set, the value of this variable is used instead.1439 The default value is 100.14401441uploadarchive.allowUnreachable::1442 If true, allow clients to use `git archive --remote` to request1443 any tree, whether reachable from the ref tips or not. See the1444 discussion in the "SECURITY" section of1445 linkgit:git-upload-archive[1] for more details. Defaults to1446 `false`.14471448uploadpack.hideRefs::1449 This variable is the same as `transfer.hideRefs`, but applies1450 only to `upload-pack` (and so affects only fetches, not pushes).1451 An attempt to fetch a hidden ref by `git fetch` will fail. See1452 also `uploadpack.allowTipSHA1InWant`.14531454uploadpack.allowTipSHA1InWant::1455 When `uploadpack.hideRefs` is in effect, allow `upload-pack`1456 to accept a fetch request that asks for an object at the tip1457 of a hidden ref (by default, such a request is rejected).1458 See also `uploadpack.hideRefs`. Even if this is false, a client1459 may be able to steal objects via the techniques described in the1460 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's1461 best to keep private data in a separate repository.14621463uploadpack.allowReachableSHA1InWant::1464 Allow `upload-pack` to accept a fetch request that asks for an1465 object that is reachable from any ref tip. However, note that1466 calculating object reachability is computationally expensive.1467 Defaults to `false`. Even if this is false, a client may be able1468 to steal objects via the techniques described in the "SECURITY"1469 section of the linkgit:gitnamespaces[7] man page; it's best to1470 keep private data in a separate repository.14711472uploadpack.allowAnySHA1InWant::1473 Allow `upload-pack` to accept a fetch request that asks for any1474 object at all.1475 Defaults to `false`.14761477uploadpack.keepAlive::1478 When `upload-pack` has started `pack-objects`, there may be a1479 quiet period while `pack-objects` prepares the pack. Normally1480 it would output progress information, but if `--quiet` was used1481 for the fetch, `pack-objects` will output nothing at all until1482 the pack data begins. Some clients and networks may consider1483 the server to be hung and give up. Setting this option instructs1484 `upload-pack` to send an empty keepalive packet every1485 `uploadpack.keepAlive` seconds. Setting this option to 01486 disables keepalive packets entirely. The default is 5 seconds.14871488uploadpack.packObjectsHook::1489 If this option is set, when `upload-pack` would run1490 `git pack-objects` to create a packfile for a client, it will1491 run this shell command instead. The `pack-objects` command and1492 arguments it _would_ have run (including the `git pack-objects`1493 at the beginning) are appended to the shell command. The stdin1494 and stdout of the hook are treated as if `pack-objects` itself1495 was run. I.e., `upload-pack` will feed input intended for1496 `pack-objects` to the hook, and expects a completed packfile on1497 stdout.1498+1499Note that this configuration variable is ignored if it is seen in the1500repository-level config (this is a safety measure against fetching from1501untrusted repositories).15021503uploadpack.allowFilter::1504 If this option is set, `upload-pack` will support partial1505 clone and partial fetch object filtering.15061507uploadpack.allowRefInWant::1508 If this option is set, `upload-pack` will support the `ref-in-want`1509 feature of the protocol version 2 `fetch` command. This feature1510 is intended for the benefit of load-balanced servers which may1511 not have the same view of what OIDs their refs point to due to1512 replication delay.15131514url.<base>.insteadOf::1515 Any URL that starts with this value will be rewritten to1516 start, instead, with <base>. In cases where some site serves a1517 large number of repositories, and serves them with multiple1518 access methods, and some users need to use different access1519 methods, this feature allows people to specify any of the1520 equivalent URLs and have Git automatically rewrite the URL to1521 the best alternative for the particular user, even for a1522 never-before-seen repository on the site. When more than one1523 insteadOf strings match a given URL, the longest match is used.1524+1525Note that any protocol restrictions will be applied to the rewritten1526URL. If the rewrite changes the URL to use a custom protocol or remote1527helper, you may need to adjust the `protocol.*.allow` config to permit1528the request. In particular, protocols you expect to use for submodules1529must be set to `always` rather than the default of `user`. See the1530description of `protocol.allow` above.15311532url.<base>.pushInsteadOf::1533 Any URL that starts with this value will not be pushed to;1534 instead, it will be rewritten to start with <base>, and the1535 resulting URL will be pushed to. In cases where some site serves1536 a large number of repositories, and serves them with multiple1537 access methods, some of which do not allow push, this feature1538 allows people to specify a pull-only URL and have Git1539 automatically use an appropriate URL to push, even for a1540 never-before-seen repository on the site. When more than one1541 pushInsteadOf strings match a given URL, the longest match is1542 used. If a remote has an explicit pushurl, Git will ignore this1543 setting for that remote.15441545user.email::1546 Your email address to be recorded in any newly created commits.1547 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and1548 `EMAIL` environment variables. See linkgit:git-commit-tree[1].15491550user.name::1551 Your full name to be recorded in any newly created commits.1552 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`1553 environment variables. See linkgit:git-commit-tree[1].15541555user.useConfigOnly::1556 Instruct Git to avoid trying to guess defaults for `user.email`1557 and `user.name`, and instead retrieve the values only from the1558 configuration. For example, if you have multiple email addresses1559 and would like to use a different one for each repository, then1560 with this configuration option set to `true` in the global config1561 along with a name, Git will prompt you to set up an email before1562 making new commits in a newly cloned repository.1563 Defaults to `false`.15641565user.signingKey::1566 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the1567 key you want it to automatically when creating a signed tag or1568 commit, you can override the default selection with this variable.1569 This option is passed unchanged to gpg's --local-user parameter,1570 so you may specify a key using any method that gpg supports.15711572versionsort.prereleaseSuffix (deprecated)::1573 Deprecated alias for `versionsort.suffix`. Ignored if1574 `versionsort.suffix` is set.15751576versionsort.suffix::1577 Even when version sort is used in linkgit:git-tag[1], tagnames1578 with the same base version but different suffixes are still sorted1579 lexicographically, resulting e.g. in prerelease tags appearing1580 after the main release (e.g. "1.0-rc1" after "1.0"). This1581 variable can be specified to determine the sorting order of tags1582 with different suffixes.1583+1584By specifying a single suffix in this variable, any tagname containing1585that suffix will appear before the corresponding main release. E.g. if1586the variable is set to "-rc", then all "1.0-rcX" tags will appear before1587"1.0". If specified multiple times, once per suffix, then the order of1588suffixes in the configuration will determine the sorting order of tagnames1589with those suffixes. E.g. if "-pre" appears before "-rc" in the1590configuration, then all "1.0-preX" tags will be listed before any1591"1.0-rcX" tags. The placement of the main release tag relative to tags1592with various suffixes can be determined by specifying the empty suffix1593among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and1594"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags1595are listed first, followed by "v4.8", then "v4.8-ckX" and finally1596"v4.8-bfsX".1597+1598If more than one suffixes match the same tagname, then that tagname will1599be sorted according to the suffix which starts at the earliest position in1600the tagname. If more than one different matching suffixes start at1601that earliest position, then that tagname will be sorted according to the1602longest of those suffixes.1603The sorting order between different suffixes is undefined if they are1604in multiple config files.16051606web.browser::1607 Specify a web browser that may be used by some commands.1608 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]1609 may use it.16101611worktree.guessRemote::1612 With `add`, if no branch argument, and neither of `-b` nor1613 `-B` nor `--detach` are given, the command defaults to1614 creating a new branch from HEAD. If `worktree.guessRemote` is1615 set to true, `worktree add` tries to find a remote-tracking1616 branch whose name uniquely matches the new branch name. If1617 such a branch exists, it is checked out and set as "upstream"1618 for the new branch. If no such match can be found, it falls1619 back to creating a new branch from the current HEAD.