1CONFIGURATION FILE 2------------------ 3 4The Git configuration file contains a number of variables that affect 5the Git commands' behavior. The `.git/config` file in each repository 6is used to store the configuration for that repository, and 7`$HOME/.gitconfig` is used to store a per-user configuration as 8fallback values for the `.git/config` file. The file `/etc/gitconfig` 9can be used to store a system-wide default configuration. 10 11The configuration variables are used by both the Git plumbing 12and the porcelains. The variables are divided into sections, wherein 13the fully qualified variable name of the variable itself is the last 14dot-separated segment and the section name is everything before the last 15dot. The variable names are case-insensitive, allow only alphanumeric 16characters and `-`, and must start with an alphabetic character. Some 17variables may appear multiple times; we say then that the variable is 18multivalued. 19 20Syntax 21~~~~~~ 22 23The syntax is fairly flexible and permissive; whitespaces are mostly 24ignored. The '#' and ';' characters begin comments to the end of line, 25blank lines are ignored. 26 27The file consists of sections and variables. A section begins with 28the name of the section in square brackets and continues until the next 29section begins. Section names are case-insensitive. Only alphanumeric 30characters, `-` and `.` are allowed in section names. Each variable 31must belong to some section, which means that there must be a section 32header before the first setting of a variable. 33 34Sections can be further divided into subsections. To begin a subsection 35put its name in double quotes, separated by space from the section name, 36in the section header, like in the example below: 37 38-------- 39 [section "subsection"] 40 41-------- 42 43Subsection names are case sensitive and can contain any characters except 44newline and the null byte. Doublequote `"` and backslash can be included 45by escaping them as `\"` and `\\`, respectively. Backslashes preceding 46other characters are dropped when reading; for example, `\t` is read as 47`t` and `\0` is read as `0` Section headers cannot span multiple lines. 48Variables may belong directly to a section or to a given subsection. You 49can have `[section]` if you have `[section "subsection"]`, but you don't 50need to. 51 52There is also a deprecated `[section.subsection]` syntax. With this 53syntax, the subsection name is converted to lower-case and is also 54compared case sensitively. These subsection names follow the same 55restrictions as section names. 56 57All the other lines (and the remainder of the line after the section 58header) are recognized as setting variables, in the form 59'name = value' (or just 'name', which is a short-hand to say that 60the variable is the boolean "true"). 61The variable names are case-insensitive, allow only alphanumeric characters 62and `-`, and must start with an alphabetic character. 63 64A line that defines a value can be continued to the next line by 65ending it with a `\`; the backquote and the end-of-line are 66stripped. Leading whitespaces after 'name =', the remainder of the 67line after the first comment character '#' or ';', and trailing 68whitespaces of the line are discarded unless they are enclosed in 69double quotes. Internal whitespaces within the value are retained 70verbatim. 71 72Inside double quotes, double quote `"` and backslash `\` characters 73must be escaped: use `\"` for `"` and `\\` for `\`. 74 75The following escape sequences (beside `\"` and `\\`) are recognized: 76`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) 77and `\b` for backspace (BS). Other char escape sequences (including octal 78escape sequences) are invalid. 79 80 81Includes 82~~~~~~~~ 83 84The `include` and `includeIf` sections allow you to include config 85directives from another source. These sections behave identically to 86each other with the exception that `includeIf` sections may be ignored 87if their condition does not evaluate to true; see "Conditional includes" 88below. 89 90You can include a config file from another by setting the special 91`include.path` (or `includeIf.*.path`) variable to the name of the file 92to be included. The variable takes a pathname as its value, and is 93subject to tilde expansion. These variables can be given multiple times. 94 95The contents of the included file are inserted immediately, as if they 96had been found at the location of the include directive. If the value of the 97variable is a relative path, the path is considered to 98be relative to the configuration file in which the include directive 99was found. See below for examples. 100 101Conditional includes 102~~~~~~~~~~~~~~~~~~~~ 103 104You can include a config file from another conditionally by setting a 105`includeIf.<condition>.path` variable to the name of the file to be 106included. 107 108The condition starts with a keyword followed by a colon and some data 109whose format and meaning depends on the keyword. Supported keywords 110are: 111 112`gitdir`:: 113 114 The data that follows the keyword `gitdir:` is used as a glob 115 pattern. If the location of the .git directory matches the 116 pattern, the include condition is met. 117+ 118The .git location may be auto-discovered, or come from `$GIT_DIR` 119environment variable. If the repository is auto discovered via a .git 120file (e.g. from submodules, or a linked worktree), the .git location 121would be the final location where the .git directory is, not where the 122.git file is. 123+ 124The pattern can contain standard globbing wildcards and two additional 125ones, `**/` and `/**`, that can match multiple path components. Please 126refer to linkgit:gitignore[5] for details. For convenience: 127 128 * If the pattern starts with `~/`, `~` will be substituted with the 129 content of the environment variable `HOME`. 130 131 * If the pattern starts with `./`, it is replaced with the directory 132 containing the current config file. 133 134 * If the pattern does not start with either `~/`, `./` or `/`, `**/` 135 will be automatically prepended. For example, the pattern `foo/bar` 136 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`. 137 138 * If the pattern ends with `/`, `**` will be automatically added. For 139 example, the pattern `foo/` becomes `foo/**`. In other words, it 140 matches "foo" and everything inside, recursively. 141 142`gitdir/i`:: 143 This is the same as `gitdir` except that matching is done 144 case-insensitively (e.g. on case-insensitive file sytems) 145 146A few more notes on matching via `gitdir` and `gitdir/i`: 147 148 * Symlinks in `$GIT_DIR` are not resolved before matching. 149 150 * Both the symlink & realpath versions of paths will be matched 151 outside of `$GIT_DIR`. E.g. if ~/git is a symlink to 152 /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git` 153 will match. 154+ 155This was not the case in the initial release of this feature in 156v2.13.0, which only matched the realpath version. Configuration that 157wants to be compatible with the initial release of this feature needs 158to either specify only the realpath version, or both versions. 159 160 * Note that "../" is not special and will match literally, which is 161 unlikely what you want. 162 163Example 164~~~~~~~ 165 166 # Core variables 167 [core] 168 ; Don't trust file modes 169 filemode = false 170 171 # Our diff algorithm 172 [diff] 173 external = /usr/local/bin/diff-wrapper 174 renames = true 175 176 [branch "devel"] 177 remote = origin 178 merge = refs/heads/devel 179 180 # Proxy settings 181 [core] 182 gitProxy="ssh" for "kernel.org" 183 gitProxy=default-proxy ; for the rest 184 185 [include] 186 path = /path/to/foo.inc ; include by absolute path 187 path = foo.inc ; find "foo.inc" relative to the current file 188 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory 189 190 ; include if $GIT_DIR is /path/to/foo/.git 191 [includeIf "gitdir:/path/to/foo/.git"] 192 path = /path/to/foo.inc 193 194 ; include for all repositories inside /path/to/group 195 [includeIf "gitdir:/path/to/group/"] 196 path = /path/to/foo.inc 197 198 ; include for all repositories inside $HOME/to/group 199 [includeIf "gitdir:~/to/group/"] 200 path = /path/to/foo.inc 201 202 ; relative paths are always relative to the including 203 ; file (if the condition is true); their location is not 204 ; affected by the condition 205 [includeIf "gitdir:/path/to/group/"] 206 path = foo.inc 207 208Values 209~~~~~~ 210 211Values of many variables are treated as a simple string, but there 212are variables that take values of specific types and there are rules 213as to how to spell them. 214 215boolean:: 216 217 When a variable is said to take a boolean value, many 218 synonyms are accepted for 'true' and 'false'; these are all 219 case-insensitive. 220 221 true;; Boolean true literals are `yes`, `on`, `true`, 222 and `1`. Also, a variable defined without `= <value>` 223 is taken as true. 224 225 false;; Boolean false literals are `no`, `off`, `false`, 226 `0` and the empty string. 227+ 228When converting value to the canonical form using `--bool` type 229specifier, 'git config' will ensure that the output is "true" or 230"false" (spelled in lowercase). 231 232integer:: 233 The value for many variables that specify various sizes can 234 be suffixed with `k`, `M`,... to mean "scale the number by 235 1024", "by 1024x1024", etc. 236 237color:: 238 The value for a variable that takes a color is a list of 239 colors (at most two, one for foreground and one for background) 240 and attributes (as many as you want), separated by spaces. 241+ 242The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`, 243`blue`, `magenta`, `cyan` and `white`. The first color given is the 244foreground; the second is the background. 245+ 246Colors may also be given as numbers between 0 and 255; these use ANSI 247256-color mode (but note that not all terminals may support this). If 248your terminal supports it, you may also specify 24-bit RGB values as 249hex, like `#ff0ab3`. 250+ 251The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`, 252`italic`, and `strike` (for crossed-out or "strikethrough" letters). 253The position of any attributes with respect to the colors 254(before, after, or in between), doesn't matter. Specific attributes may 255be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`, 256`no-ul`, etc). 257+ 258An empty color string produces no color effect at all. This can be used 259to avoid coloring specific elements without disabling color entirely. 260+ 261For git's pre-defined color slots, the attributes are meant to be reset 262at the beginning of each item in the colored output. So setting 263`color.decorate.branch` to `black` will paint that branch name in a 264plain `black`, even if the previous thing on the same output line (e.g. 265opening parenthesis before the list of branch names in `log --decorate` 266output) is set to be painted with `bold` or some other attribute. 267However, custom log formats may do more complicated and layered 268coloring, and the negated forms may be useful there. 269 270pathname:: 271 A variable that takes a pathname value can be given a 272 string that begins with "`~/`" or "`~user/`", and the usual 273 tilde expansion happens to such a string: `~/` 274 is expanded to the value of `$HOME`, and `~user/` to the 275 specified user's home directory. 276 277 278Variables 279~~~~~~~~~ 280 281Note that this list is non-comprehensive and not necessarily complete. 282For command-specific variables, you will find a more detailed description 283in the appropriate manual page. 284 285Other git-related tools may and do use their own variables. When 286inventing new variables for use in your own tool, make sure their 287names do not conflict with those that are used by Git itself and 288other popular tools, and describe them in your documentation. 289 290 291advice.*:: 292 These variables control various optional help messages designed to 293 aid new users. All 'advice.*' variables default to 'true', and you 294 can tell Git that you do not need help by setting these to 'false': 295+ 296-- 297 pushUpdateRejected:: 298 Set this variable to 'false' if you want to disable 299 'pushNonFFCurrent', 300 'pushNonFFMatching', 'pushAlreadyExists', 301 'pushFetchFirst', and 'pushNeedsForce' 302 simultaneously. 303 pushNonFFCurrent:: 304 Advice shown when linkgit:git-push[1] fails due to a 305 non-fast-forward update to the current branch. 306 pushNonFFMatching:: 307 Advice shown when you ran linkgit:git-push[1] and pushed 308 'matching refs' explicitly (i.e. you used ':', or 309 specified a refspec that isn't your current branch) and 310 it resulted in a non-fast-forward error. 311 pushAlreadyExists:: 312 Shown when linkgit:git-push[1] rejects an update that 313 does not qualify for fast-forwarding (e.g., a tag.) 314 pushFetchFirst:: 315 Shown when linkgit:git-push[1] rejects an update that 316 tries to overwrite a remote ref that points at an 317 object we do not have. 318 pushNeedsForce:: 319 Shown when linkgit:git-push[1] rejects an update that 320 tries to overwrite a remote ref that points at an 321 object that is not a commit-ish, or make the remote 322 ref point at an object that is not a commit-ish. 323 statusHints:: 324 Show directions on how to proceed from the current 325 state in the output of linkgit:git-status[1], in 326 the template shown when writing commit messages in 327 linkgit:git-commit[1], and in the help message shown 328 by linkgit:git-checkout[1] when switching branch. 329 statusUoption:: 330 Advise to consider using the `-u` option to linkgit:git-status[1] 331 when the command takes more than 2 seconds to enumerate untracked 332 files. 333 commitBeforeMerge:: 334 Advice shown when linkgit:git-merge[1] refuses to 335 merge to avoid overwriting local changes. 336 resolveConflict:: 337 Advice shown by various commands when conflicts 338 prevent the operation from being performed. 339 implicitIdentity:: 340 Advice on how to set your identity configuration when 341 your information is guessed from the system username and 342 domain name. 343 detachedHead:: 344 Advice shown when you used linkgit:git-checkout[1] to 345 move to the detach HEAD state, to instruct how to create 346 a local branch after the fact. 347 checkoutAmbiguousRemoteBranchName:: 348 Advice shown when the argument to 349 linkgit:git-checkout[1] ambiguously resolves to a 350 remote tracking branch on more than one remote in 351 situations where an unambiguous argument would have 352 otherwise caused a remote-tracking branch to be 353 checked out. See the `checkout.defaultRemote` 354 configuration variable for how to set a given remote 355 to used by default in some situations where this 356 advice would be printed. 357 amWorkDir:: 358 Advice that shows the location of the patch file when 359 linkgit:git-am[1] fails to apply it. 360 rmHints:: 361 In case of failure in the output of linkgit:git-rm[1], 362 show directions on how to proceed from the current state. 363 addEmbeddedRepo:: 364 Advice on what to do when you've accidentally added one 365 git repo inside of another. 366 ignoredHook:: 367 Advice shown if a hook is ignored because the hook is not 368 set as executable. 369 waitingForEditor:: 370 Print a message to the terminal whenever Git is waiting for 371 editor input from the user. 372-- 373 374core.fileMode:: 375 Tells Git if the executable bit of files in the working tree 376 is to be honored. 377+ 378Some filesystems lose the executable bit when a file that is 379marked as executable is checked out, or checks out a 380non-executable file with executable bit on. 381linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem 382to see if it handles the executable bit correctly 383and this variable is automatically set as necessary. 384+ 385A repository, however, may be on a filesystem that handles 386the filemode correctly, and this variable is set to 'true' 387when created, but later may be made accessible from another 388environment that loses the filemode (e.g. exporting ext4 via 389CIFS mount, visiting a Cygwin created repository with 390Git for Windows or Eclipse). 391In such a case it may be necessary to set this variable to 'false'. 392See linkgit:git-update-index[1]. 393+ 394The default is true (when core.filemode is not specified in the config file). 395 396core.hideDotFiles:: 397 (Windows-only) If true, mark newly-created directories and files whose 398 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/` 399 directory is hidden, but no other files starting with a dot. The 400 default mode is 'dotGitOnly'. 401 402core.ignoreCase:: 403 Internal variable which enables various workarounds to enable 404 Git to work better on filesystems that are not case sensitive, 405 like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing 406 finds "makefile" when Git expects "Makefile", Git will assume 407 it is really the same file, and continue to remember it as 408 "Makefile". 409+ 410The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 411will probe and set core.ignoreCase true if appropriate when the repository 412is created. 413+ 414Git relies on the proper configuration of this variable for your operating 415and file system. Modifying this value may result in unexpected behavior. 416 417core.precomposeUnicode:: 418 This option is only used by Mac OS implementation of Git. 419 When core.precomposeUnicode=true, Git reverts the unicode decomposition 420 of filenames done by Mac OS. This is useful when sharing a repository 421 between Mac OS and Linux or Windows. 422 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 423 When false, file names are handled fully transparent by Git, 424 which is backward compatible with older versions of Git. 425 426core.protectHFS:: 427 If set to true, do not allow checkout of paths that would 428 be considered equivalent to `.git` on an HFS+ filesystem. 429 Defaults to `true` on Mac OS, and `false` elsewhere. 430 431core.protectNTFS:: 432 If set to true, do not allow checkout of paths that would 433 cause problems with the NTFS filesystem, e.g. conflict with 434 8.3 "short" names. 435 Defaults to `true` on Windows, and `false` elsewhere. 436 437core.fsmonitor:: 438 If set, the value of this variable is used as a command which 439 will identify all files that may have changed since the 440 requested date/time. This information is used to speed up git by 441 avoiding unnecessary processing of files that have not changed. 442 See the "fsmonitor-watchman" section of linkgit:githooks[5]. 443 444core.trustctime:: 445 If false, the ctime differences between the index and the 446 working tree are ignored; useful when the inode change time 447 is regularly modified by something outside Git (file system 448 crawlers and some backup systems). 449 See linkgit:git-update-index[1]. True by default. 450 451core.splitIndex:: 452 If true, the split-index feature of the index will be used. 453 See linkgit:git-update-index[1]. False by default. 454 455core.untrackedCache:: 456 Determines what to do about the untracked cache feature of the 457 index. It will be kept, if this variable is unset or set to 458 `keep`. It will automatically be added if set to `true`. And 459 it will automatically be removed, if set to `false`. Before 460 setting it to `true`, you should check that mtime is working 461 properly on your system. 462 See linkgit:git-update-index[1]. `keep` by default. 463 464core.checkStat:: 465 When missing or is set to `default`, many fields in the stat 466 structure are checked to detect if a file has been modified 467 since Git looked at it. When this configuration variable is 468 set to `minimal`, sub-second part of mtime and ctime, the 469 uid and gid of the owner of the file, the inode number (and 470 the device number, if Git was compiled to use it), are 471 excluded from the check among these fields, leaving only the 472 whole-second part of mtime (and ctime, if `core.trustCtime` 473 is set) and the filesize to be checked. 474+ 475There are implementations of Git that do not leave usable values in 476some fields (e.g. JGit); by excluding these fields from the 477comparison, the `minimal` mode may help interoperability when the 478same repository is used by these other systems at the same time. 479 480core.quotePath:: 481 Commands that output paths (e.g. 'ls-files', 'diff'), will 482 quote "unusual" characters in the pathname by enclosing the 483 pathname in double-quotes and escaping those characters with 484 backslashes in the same way C escapes control characters (e.g. 485 `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with 486 values larger than 0x80 (e.g. octal `\302\265` for "micro" in 487 UTF-8). If this variable is set to false, bytes higher than 488 0x80 are not considered "unusual" any more. Double-quotes, 489 backslash and control characters are always escaped regardless 490 of the setting of this variable. A simple space character is 491 not considered "unusual". Many commands can output pathnames 492 completely verbatim using the `-z` option. The default value 493 is true. 494 495core.eol:: 496 Sets the line ending type to use in the working directory for 497 files that have the `text` property set when core.autocrlf is false. 498 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's 499 native line ending. The default value is `native`. See 500 linkgit:gitattributes[5] for more information on end-of-line 501 conversion. 502 503core.safecrlf:: 504 If true, makes Git check if converting `CRLF` is reversible when 505 end-of-line conversion is active. Git will verify if a command 506 modifies a file in the work tree either directly or indirectly. 507 For example, committing a file followed by checking out the 508 same file should yield the original file in the work tree. If 509 this is not the case for the current setting of 510 `core.autocrlf`, Git will reject the file. The variable can 511 be set to "warn", in which case Git will only warn about an 512 irreversible conversion but continue the operation. 513+ 514CRLF conversion bears a slight chance of corrupting data. 515When it is enabled, Git will convert CRLF to LF during commit and LF to 516CRLF during checkout. A file that contains a mixture of LF and 517CRLF before the commit cannot be recreated by Git. For text 518files this is the right thing to do: it corrects line endings 519such that we have only LF line endings in the repository. 520But for binary files that are accidentally classified as text the 521conversion can corrupt data. 522+ 523If you recognize such corruption early you can easily fix it by 524setting the conversion type explicitly in .gitattributes. Right 525after committing you still have the original file in your work 526tree and this file is not yet corrupted. You can explicitly tell 527Git that this file is binary and Git will handle the file 528appropriately. 529+ 530Unfortunately, the desired effect of cleaning up text files with 531mixed line endings and the undesired effect of corrupting binary 532files cannot be distinguished. In both cases CRLFs are removed 533in an irreversible way. For text files this is the right thing 534to do because CRLFs are line endings, while for binary files 535converting CRLFs corrupts data. 536+ 537Note, this safety check does not mean that a checkout will generate a 538file identical to the original file for a different setting of 539`core.eol` and `core.autocrlf`, but only for the current one. For 540example, a text file with `LF` would be accepted with `core.eol=lf` 541and could later be checked out with `core.eol=crlf`, in which case the 542resulting file would contain `CRLF`, although the original file 543contained `LF`. However, in both work trees the line endings would be 544consistent, that is either all `LF` or all `CRLF`, but never mixed. A 545file with mixed line endings would be reported by the `core.safecrlf` 546mechanism. 547 548core.autocrlf:: 549 Setting this variable to "true" is the same as setting 550 the `text` attribute to "auto" on all files and core.eol to "crlf". 551 Set to true if you want to have `CRLF` line endings in your 552 working directory and the repository has LF line endings. 553 This variable can be set to 'input', 554 in which case no output conversion is performed. 555 556core.checkRoundtripEncoding:: 557 A comma and/or whitespace separated list of encodings that Git 558 performs UTF-8 round trip checks on if they are used in an 559 `working-tree-encoding` attribute (see linkgit:gitattributes[5]). 560 The default value is `SHIFT-JIS`. 561 562core.symlinks:: 563 If false, symbolic links are checked out as small plain files that 564 contain the link text. linkgit:git-update-index[1] and 565 linkgit:git-add[1] will not change the recorded type to regular 566 file. Useful on filesystems like FAT that do not support 567 symbolic links. 568+ 569The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 570will probe and set core.symlinks false if appropriate when the repository 571is created. 572 573core.gitProxy:: 574 A "proxy command" to execute (as 'command host port') instead 575 of establishing direct connection to the remote server when 576 using the Git protocol for fetching. If the variable value is 577 in the "COMMAND for DOMAIN" format, the command is applied only 578 on hostnames ending with the specified domain string. This variable 579 may be set multiple times and is matched in the given order; 580 the first match wins. 581+ 582Can be overridden by the `GIT_PROXY_COMMAND` environment variable 583(which always applies universally, without the special "for" 584handling). 585+ 586The special string `none` can be used as the proxy command to 587specify that no proxy be used for a given domain pattern. 588This is useful for excluding servers inside a firewall from 589proxy use, while defaulting to a common proxy for external domains. 590 591core.sshCommand:: 592 If this variable is set, `git fetch` and `git push` will 593 use the specified command instead of `ssh` when they need to 594 connect to a remote system. The command is in the same form as 595 the `GIT_SSH_COMMAND` environment variable and is overridden 596 when the environment variable is set. 597 598core.ignoreStat:: 599 If true, Git will avoid using lstat() calls to detect if files have 600 changed by setting the "assume-unchanged" bit for those tracked files 601 which it has updated identically in both the index and working tree. 602+ 603When files are modified outside of Git, the user will need to stage 604the modified files explicitly (e.g. see 'Examples' section in 605linkgit:git-update-index[1]). 606Git will not normally detect changes to those files. 607+ 608This is useful on systems where lstat() calls are very slow, such as 609CIFS/Microsoft Windows. 610+ 611False by default. 612 613core.preferSymlinkRefs:: 614 Instead of the default "symref" format for HEAD 615 and other symbolic reference files, use symbolic links. 616 This is sometimes needed to work with old scripts that 617 expect HEAD to be a symbolic link. 618 619core.bare:: 620 If true this repository is assumed to be 'bare' and has no 621 working directory associated with it. If this is the case a 622 number of commands that require a working directory will be 623 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 624+ 625This setting is automatically guessed by linkgit:git-clone[1] or 626linkgit:git-init[1] when the repository was created. By default a 627repository that ends in "/.git" is assumed to be not bare (bare = 628false), while all other repositories are assumed to be bare (bare 629= true). 630 631core.worktree:: 632 Set the path to the root of the working tree. 633 If `GIT_COMMON_DIR` environment variable is set, core.worktree 634 is ignored and not used for determining the root of working tree. 635 This can be overridden by the `GIT_WORK_TREE` environment 636 variable and the `--work-tree` command-line option. 637 The value can be an absolute path or relative to the path to 638 the .git directory, which is either specified by --git-dir 639 or GIT_DIR, or automatically discovered. 640 If --git-dir or GIT_DIR is specified but none of 641 --work-tree, GIT_WORK_TREE and core.worktree is specified, 642 the current working directory is regarded as the top level 643 of your working tree. 644+ 645Note that this variable is honored even when set in a configuration 646file in a ".git" subdirectory of a directory and its value differs 647from the latter directory (e.g. "/path/to/.git/config" has 648core.worktree set to "/different/path"), which is most likely a 649misconfiguration. Running Git commands in the "/path/to" directory will 650still use "/different/path" as the root of the work tree and can cause 651confusion unless you know what you are doing (e.g. you are creating a 652read-only snapshot of the same index to a location different from the 653repository's usual working tree). 654 655core.logAllRefUpdates:: 656 Enable the reflog. Updates to a ref <ref> is logged to the file 657 "`$GIT_DIR/logs/<ref>`", by appending the new and old 658 SHA-1, the date/time and the reason of the update, but 659 only when the file exists. If this configuration 660 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`" 661 file is automatically created for branch heads (i.e. under 662 `refs/heads/`), remote refs (i.e. under `refs/remotes/`), 663 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`. 664 If it is set to `always`, then a missing reflog is automatically 665 created for any ref under `refs/`. 666+ 667This information can be used to determine what commit 668was the tip of a branch "2 days ago". 669+ 670This value is true by default in a repository that has 671a working directory associated with it, and false by 672default in a bare repository. 673 674core.repositoryFormatVersion:: 675 Internal variable identifying the repository format and layout 676 version. 677 678core.sharedRepository:: 679 When 'group' (or 'true'), the repository is made shareable between 680 several users in a group (making sure all the files and objects are 681 group-writable). When 'all' (or 'world' or 'everybody'), the 682 repository will be readable by all users, additionally to being 683 group-shareable. When 'umask' (or 'false'), Git will use permissions 684 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 685 files in the repository will have this mode value. '0xxx' will override 686 user's umask value (whereas the other options will only override 687 requested parts of the user's umask value). Examples: '0660' will make 688 the repo read/write-able for the owner and group, but inaccessible to 689 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 690 repository that is group-readable but not group-writable. 691 See linkgit:git-init[1]. False by default. 692 693core.warnAmbiguousRefs:: 694 If true, Git will warn you if the ref name you passed it is ambiguous 695 and might match multiple refs in the repository. True by default. 696 697core.compression:: 698 An integer -1..9, indicating a default compression level. 699 -1 is the zlib default. 0 means no compression, 700 and 1..9 are various speed/size tradeoffs, 9 being slowest. 701 If set, this provides a default to other compression variables, 702 such as `core.looseCompression` and `pack.compression`. 703 704core.looseCompression:: 705 An integer -1..9, indicating the compression level for objects that 706 are not in a pack file. -1 is the zlib default. 0 means no 707 compression, and 1..9 are various speed/size tradeoffs, 9 being 708 slowest. If not set, defaults to core.compression. If that is 709 not set, defaults to 1 (best speed). 710 711core.packedGitWindowSize:: 712 Number of bytes of a pack file to map into memory in a 713 single mapping operation. Larger window sizes may allow 714 your system to process a smaller number of large pack files 715 more quickly. Smaller window sizes will negatively affect 716 performance due to increased calls to the operating system's 717 memory manager, but may improve performance when accessing 718 a large number of large pack files. 719+ 720Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 721MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 722be reasonable for all users/operating systems. You probably do 723not need to adjust this value. 724+ 725Common unit suffixes of 'k', 'm', or 'g' are supported. 726 727core.packedGitLimit:: 728 Maximum number of bytes to map simultaneously into memory 729 from pack files. If Git needs to access more than this many 730 bytes at once to complete an operation it will unmap existing 731 regions to reclaim virtual address space within the process. 732+ 733Default is 256 MiB on 32 bit platforms and 32 TiB (effectively 734unlimited) on 64 bit platforms. 735This should be reasonable for all users/operating systems, except on 736the largest projects. You probably do not need to adjust this value. 737+ 738Common unit suffixes of 'k', 'm', or 'g' are supported. 739 740core.deltaBaseCacheLimit:: 741 Maximum number of bytes to reserve for caching base objects 742 that may be referenced by multiple deltified objects. By storing the 743 entire decompressed base objects in a cache Git is able 744 to avoid unpacking and decompressing frequently used base 745 objects multiple times. 746+ 747Default is 96 MiB on all platforms. This should be reasonable 748for all users/operating systems, except on the largest projects. 749You probably do not need to adjust this value. 750+ 751Common unit suffixes of 'k', 'm', or 'g' are supported. 752 753core.bigFileThreshold:: 754 Files larger than this size are stored deflated, without 755 attempting delta compression. Storing large files without 756 delta compression avoids excessive memory usage, at the 757 slight expense of increased disk usage. Additionally files 758 larger than this size are always treated as binary. 759+ 760Default is 512 MiB on all platforms. This should be reasonable 761for most projects as source code and other text files can still 762be delta compressed, but larger binary media files won't be. 763+ 764Common unit suffixes of 'k', 'm', or 'g' are supported. 765 766core.excludesFile:: 767 Specifies the pathname to the file that contains patterns to 768 describe paths that are not meant to be tracked, in addition 769 to '.gitignore' (per-directory) and '.git/info/exclude'. 770 Defaults to `$XDG_CONFIG_HOME/git/ignore`. 771 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` 772 is used instead. See linkgit:gitignore[5]. 773 774core.askPass:: 775 Some commands (e.g. svn and http interfaces) that interactively 776 ask for a password can be told to use an external program given 777 via the value of this variable. Can be overridden by the `GIT_ASKPASS` 778 environment variable. If not set, fall back to the value of the 779 `SSH_ASKPASS` environment variable or, failing that, a simple password 780 prompt. The external program shall be given a suitable prompt as 781 command-line argument and write the password on its STDOUT. 782 783core.attributesFile:: 784 In addition to '.gitattributes' (per-directory) and 785 '.git/info/attributes', Git looks into this file for attributes 786 (see linkgit:gitattributes[5]). Path expansions are made the same 787 way as for `core.excludesFile`. Its default value is 788 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not 789 set or empty, `$HOME/.config/git/attributes` is used instead. 790 791core.hooksPath:: 792 By default Git will look for your hooks in the 793 '$GIT_DIR/hooks' directory. Set this to different path, 794 e.g. '/etc/git/hooks', and Git will try to find your hooks in 795 that directory, e.g. '/etc/git/hooks/pre-receive' instead of 796 in '$GIT_DIR/hooks/pre-receive'. 797+ 798The path can be either absolute or relative. A relative path is 799taken as relative to the directory where the hooks are run (see 800the "DESCRIPTION" section of linkgit:githooks[5]). 801+ 802This configuration variable is useful in cases where you'd like to 803centrally configure your Git hooks instead of configuring them on a 804per-repository basis, or as a more flexible and centralized 805alternative to having an `init.templateDir` where you've changed 806default hooks. 807 808core.editor:: 809 Commands such as `commit` and `tag` that let you edit 810 messages by launching an editor use the value of this 811 variable when it is set, and the environment variable 812 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 813 814core.commentChar:: 815 Commands such as `commit` and `tag` that let you edit 816 messages consider a line that begins with this character 817 commented, and removes them after the editor returns 818 (default '#'). 819+ 820If set to "auto", `git-commit` would select a character that is not 821the beginning character of any line in existing commit messages. 822 823core.filesRefLockTimeout:: 824 The length of time, in milliseconds, to retry when trying to 825 lock an individual reference. Value 0 means not to retry at 826 all; -1 means to try indefinitely. Default is 100 (i.e., 827 retry for 100ms). 828 829core.packedRefsTimeout:: 830 The length of time, in milliseconds, to retry when trying to 831 lock the `packed-refs` file. Value 0 means not to retry at 832 all; -1 means to try indefinitely. Default is 1000 (i.e., 833 retry for 1 second). 834 835sequence.editor:: 836 Text editor used by `git rebase -i` for editing the rebase instruction file. 837 The value is meant to be interpreted by the shell when it is used. 838 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 839 When not configured the default commit message editor is used instead. 840 841core.pager:: 842 Text viewer for use by Git commands (e.g., 'less'). The value 843 is meant to be interpreted by the shell. The order of preference 844 is the `$GIT_PAGER` environment variable, then `core.pager` 845 configuration, then `$PAGER`, and then the default chosen at 846 compile time (usually 'less'). 847+ 848When the `LESS` environment variable is unset, Git sets it to `FRX` 849(if `LESS` environment variable is set, Git does not change it at 850all). If you want to selectively override Git's default setting 851for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 852be passed to the shell by Git, which will translate the final 853command to `LESS=FRX less -S`. The environment does not set the 854`S` option but the command line does, instructing less to truncate 855long lines. Similarly, setting `core.pager` to `less -+F` will 856deactivate the `F` option specified by the environment from the 857command-line, deactivating the "quit if one screen" behavior of 858`less`. One can specifically activate some flags for particular 859commands: for example, setting `pager.blame` to `less -S` enables 860line truncation only for `git blame`. 861+ 862Likewise, when the `LV` environment variable is unset, Git sets it 863to `-c`. You can override this setting by exporting `LV` with 864another value or setting `core.pager` to `lv +c`. 865 866core.whitespace:: 867 A comma separated list of common whitespace problems to 868 notice. 'git diff' will use `color.diff.whitespace` to 869 highlight them, and 'git apply --whitespace=error' will 870 consider them as errors. You can prefix `-` to disable 871 any of them (e.g. `-trailing-space`): 872+ 873* `blank-at-eol` treats trailing whitespaces at the end of the line 874 as an error (enabled by default). 875* `space-before-tab` treats a space character that appears immediately 876 before a tab character in the initial indent part of the line as an 877 error (enabled by default). 878* `indent-with-non-tab` treats a line that is indented with space 879 characters instead of the equivalent tabs as an error (not enabled by 880 default). 881* `tab-in-indent` treats a tab character in the initial indent part of 882 the line as an error (not enabled by default). 883* `blank-at-eof` treats blank lines added at the end of file as an error 884 (enabled by default). 885* `trailing-space` is a short-hand to cover both `blank-at-eol` and 886 `blank-at-eof`. 887* `cr-at-eol` treats a carriage-return at the end of line as 888 part of the line terminator, i.e. with it, `trailing-space` 889 does not trigger if the character before such a carriage-return 890 is not a whitespace (not enabled by default). 891* `tabwidth=<n>` tells how many character positions a tab occupies; this 892 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 893 errors. The default tab width is 8. Allowed values are 1 to 63. 894 895core.fsyncObjectFiles:: 896 This boolean will enable 'fsync()' when writing object files. 897+ 898This is a total waste of time and effort on a filesystem that orders 899data writes properly, but can be useful for filesystems that do not use 900journalling (traditional UNIX filesystems) or that only journal metadata 901and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 902 903core.preloadIndex:: 904 Enable parallel index preload for operations like 'git diff' 905+ 906This can speed up operations like 'git diff' and 'git status' especially 907on filesystems like NFS that have weak caching semantics and thus 908relatively high IO latencies. When enabled, Git will do the 909index comparison to the filesystem data in parallel, allowing 910overlapping IO's. Defaults to true. 911 912core.createObject:: 913 You can set this to 'link', in which case a hardlink followed by 914 a delete of the source are used to make sure that object creation 915 will not overwrite existing objects. 916+ 917On some file system/operating system combinations, this is unreliable. 918Set this config setting to 'rename' there; However, This will remove the 919check that makes sure that existing object files will not get overwritten. 920 921core.notesRef:: 922 When showing commit messages, also show notes which are stored in 923 the given ref. The ref must be fully qualified. If the given 924 ref does not exist, it is not an error but means that no 925 notes should be printed. 926+ 927This setting defaults to "refs/notes/commits", and it can be overridden by 928the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. 929 930core.commitGraph:: 931 If true, then git will read the commit-graph file (if it exists) 932 to parse the graph structure of commits. Defaults to false. See 933 linkgit:git-commit-graph[1] for more information. 934 935core.useReplaceRefs:: 936 If set to `false`, behave as if the `--no-replace-objects` 937 option was given on the command line. See linkgit:git[1] and 938 linkgit:git-replace[1] for more information. 939 940core.multiPackIndex:: 941 Use the multi-pack-index file to track multiple packfiles using a 942 single index. See link:technical/multi-pack-index.html[the 943 multi-pack-index design document]. 944 945core.sparseCheckout:: 946 Enable "sparse checkout" feature. See section "Sparse checkout" in 947 linkgit:git-read-tree[1] for more information. 948 949core.abbrev:: 950 Set the length object names are abbreviated to. If 951 unspecified or set to "auto", an appropriate value is 952 computed based on the approximate number of packed objects 953 in your repository, which hopefully is enough for 954 abbreviated object names to stay unique for some time. 955 The minimum length is 4. 956 957add.ignoreErrors:: 958add.ignore-errors (deprecated):: 959 Tells 'git add' to continue adding files when some files cannot be 960 added due to indexing errors. Equivalent to the `--ignore-errors` 961 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 962 as it does not follow the usual naming convention for configuration 963 variables. 964 965alias.*:: 966 Command aliases for the linkgit:git[1] command wrapper - e.g. 967 after defining "alias.last = cat-file commit HEAD", the invocation 968 "git last" is equivalent to "git cat-file commit HEAD". To avoid 969 confusion and troubles with script usage, aliases that 970 hide existing Git commands are ignored. Arguments are split by 971 spaces, the usual shell quoting and escaping is supported. 972 A quote pair or a backslash can be used to quote them. 973+ 974If the alias expansion is prefixed with an exclamation point, 975it will be treated as a shell command. For example, defining 976"alias.new = !gitk --all --not ORIG_HEAD", the invocation 977"git new" is equivalent to running the shell command 978"gitk --all --not ORIG_HEAD". Note that shell commands will be 979executed from the top-level directory of a repository, which may 980not necessarily be the current directory. 981`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix' 982from the original current directory. See linkgit:git-rev-parse[1]. 983 984am.keepcr:: 985 If true, git-am will call git-mailsplit for patches in mbox format 986 with parameter `--keep-cr`. In this case git-mailsplit will 987 not remove `\r` from lines ending with `\r\n`. Can be overridden 988 by giving `--no-keep-cr` from the command line. 989 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 990 991am.threeWay:: 992 By default, `git am` will fail if the patch does not apply cleanly. When 993 set to true, this setting tells `git am` to fall back on 3-way merge if 994 the patch records the identity of blobs it is supposed to apply to and 995 we have those blobs available locally (equivalent to giving the `--3way` 996 option from the command line). Defaults to `false`. 997 See linkgit:git-am[1]. 998 999apply.ignoreWhitespace::1000 When set to 'change', tells 'git apply' to ignore changes in1001 whitespace, in the same way as the `--ignore-space-change`1002 option.1003 When set to one of: no, none, never, false tells 'git apply' to1004 respect all whitespace differences.1005 See linkgit:git-apply[1].10061007apply.whitespace::1008 Tells 'git apply' how to handle whitespaces, in the same way1009 as the `--whitespace` option. See linkgit:git-apply[1].10101011blame.blankBoundary::1012 Show blank commit object name for boundary commits in1013 linkgit:git-blame[1]. This option defaults to false.10141015blame.coloring::1016 This determines the coloring scheme to be applied to blame1017 output. It can be 'repeatedLines', 'highlightRecent',1018 or 'none' which is the default.10191020blame.date::1021 Specifies the format used to output dates in linkgit:git-blame[1].1022 If unset the iso format is used. For supported values,1023 see the discussion of the `--date` option at linkgit:git-log[1].10241025blame.showEmail::1026 Show the author email instead of author name in linkgit:git-blame[1].1027 This option defaults to false.10281029blame.showRoot::1030 Do not treat root commits as boundaries in linkgit:git-blame[1].1031 This option defaults to false.10321033branch.autoSetupMerge::1034 Tells 'git branch' and 'git checkout' to set up new branches1035 so that linkgit:git-pull[1] will appropriately merge from the1036 starting point branch. Note that even if this option is not set,1037 this behavior can be chosen per-branch using the `--track`1038 and `--no-track` options. The valid settings are: `false` -- no1039 automatic setup is done; `true` -- automatic setup is done when the1040 starting point is a remote-tracking branch; `always` --1041 automatic setup is done when the starting point is either a1042 local branch or remote-tracking1043 branch. This option defaults to true.10441045branch.autoSetupRebase::1046 When a new branch is created with 'git branch' or 'git checkout'1047 that tracks another branch, this variable tells Git to set1048 up pull to rebase instead of merge (see "branch.<name>.rebase").1049 When `never`, rebase is never automatically set to true.1050 When `local`, rebase is set to true for tracked branches of1051 other local branches.1052 When `remote`, rebase is set to true for tracked branches of1053 remote-tracking branches.1054 When `always`, rebase will be set to true for all tracking1055 branches.1056 See "branch.autoSetupMerge" for details on how to set up a1057 branch to track another branch.1058 This option defaults to never.10591060branch.sort::1061 This variable controls the sort ordering of branches when displayed by1062 linkgit:git-branch[1]. Without the "--sort=<value>" option provided, the1063 value of this variable will be used as the default.1064 See linkgit:git-for-each-ref[1] field names for valid values.10651066branch.<name>.remote::1067 When on branch <name>, it tells 'git fetch' and 'git push'1068 which remote to fetch from/push to. The remote to push to1069 may be overridden with `remote.pushDefault` (for all branches).1070 The remote to push to, for the current branch, may be further1071 overridden by `branch.<name>.pushRemote`. If no remote is1072 configured, or if you are not on any branch, it defaults to1073 `origin` for fetching and `remote.pushDefault` for pushing.1074 Additionally, `.` (a period) is the current local repository1075 (a dot-repository), see `branch.<name>.merge`'s final note below.10761077branch.<name>.pushRemote::1078 When on branch <name>, it overrides `branch.<name>.remote` for1079 pushing. It also overrides `remote.pushDefault` for pushing1080 from branch <name>. When you pull from one place (e.g. your1081 upstream) and push to another place (e.g. your own publishing1082 repository), you would want to set `remote.pushDefault` to1083 specify the remote to push to for all branches, and use this1084 option to override it for a specific branch.10851086branch.<name>.merge::1087 Defines, together with branch.<name>.remote, the upstream branch1088 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which1089 branch to merge and can also affect 'git push' (see push.default).1090 When in branch <name>, it tells 'git fetch' the default1091 refspec to be marked for merging in FETCH_HEAD. The value is1092 handled like the remote part of a refspec, and must match a1093 ref which is fetched from the remote given by1094 "branch.<name>.remote".1095 The merge information is used by 'git pull' (which at first calls1096 'git fetch') to lookup the default branch for merging. Without1097 this option, 'git pull' defaults to merge the first refspec fetched.1098 Specify multiple values to get an octopus merge.1099 If you wish to setup 'git pull' so that it merges into <name> from1100 another branch in the local repository, you can point1101 branch.<name>.merge to the desired branch, and use the relative path1102 setting `.` (a period) for branch.<name>.remote.11031104branch.<name>.mergeOptions::1105 Sets default options for merging into branch <name>. The syntax and1106 supported options are the same as those of linkgit:git-merge[1], but1107 option values containing whitespace characters are currently not1108 supported.11091110branch.<name>.rebase::1111 When true, rebase the branch <name> on top of the fetched branch,1112 instead of merging the default branch from the default remote when1113 "git pull" is run. See "pull.rebase" for doing this in a non1114 branch-specific manner.1115+1116When `merges`, pass the `--rebase-merges` option to 'git rebase'1117so that the local merge commits are included in the rebase (see1118linkgit:git-rebase[1] for details).1119+1120When preserve, also pass `--preserve-merges` along to 'git rebase'1121so that locally committed merge commits will not be flattened1122by running 'git pull'.1123+1124When the value is `interactive`, the rebase is run in interactive mode.1125+1126*NOTE*: this is a possibly dangerous operation; do *not* use1127it unless you understand the implications (see linkgit:git-rebase[1]1128for details).11291130branch.<name>.description::1131 Branch description, can be edited with1132 `git branch --edit-description`. Branch description is1133 automatically added in the format-patch cover letter or1134 request-pull summary.11351136browser.<tool>.cmd::1137 Specify the command to invoke the specified browser. The1138 specified command is evaluated in shell with the URLs passed1139 as arguments. (See linkgit:git-web{litdd}browse[1].)11401141browser.<tool>.path::1142 Override the path for the given tool that may be used to1143 browse HTML help (see `-w` option in linkgit:git-help[1]) or a1144 working repository in gitweb (see linkgit:git-instaweb[1]).11451146checkout.defaultRemote::1147 When you run 'git checkout <something>' and only have one1148 remote, it may implicitly fall back on checking out and1149 tracking e.g. 'origin/<something>'. This stops working as soon1150 as you have more than one remote with a '<something>'1151 reference. This setting allows for setting the name of a1152 preferred remote that should always win when it comes to1153 disambiguation. The typical use-case is to set this to1154 `origin`.1155+1156Currently this is used by linkgit:git-checkout[1] when 'git checkout1157<something>' will checkout the '<something>' branch on another remote,1158and by linkgit:git-worktree[1] when 'git worktree add' refers to a1159remote branch. This setting might be used for other checkout-like1160commands or functionality in the future.11611162checkout.optimizeNewBranch::1163 Optimizes the performance of "git checkout -b <new_branch>" when1164 using sparse-checkout. When set to true, git will not update the1165 repo based on the current sparse-checkout settings. This means it1166 will not update the skip-worktree bit in the index nor add/remove1167 files in the working directory to reflect the current sparse checkout1168 settings nor will it show the local changes.11691170clean.requireForce::1171 A boolean to make git-clean do nothing unless given -f,1172 -i or -n. Defaults to true.11731174color.advice::1175 A boolean to enable/disable color in hints (e.g. when a push1176 failed, see `advice.*` for a list). May be set to `always`,1177 `false` (or `never`) or `auto` (or `true`), in which case colors1178 are used only when the error output goes to a terminal. If1179 unset, then the value of `color.ui` is used (`auto` by default).11801181color.advice.hint::1182 Use customized color for hints.11831184color.blame.highlightRecent::1185 This can be used to color the metadata of a blame line depending1186 on age of the line.1187+1188This setting should be set to a comma-separated list of color and date settings,1189starting and ending with a color, the dates should be set from oldest to newest.1190The metadata will be colored given the colors if the the line was introduced1191before the given timestamp, overwriting older timestamped colors.1192+1193Instead of an absolute timestamp relative timestamps work as well, e.g.11942.weeks.ago is valid to address anything older than 2 weeks.1195+1196It defaults to 'blue,12 month ago,white,1 month ago,red', which colors1197everything older than one year blue, recent changes between one month and1198one year old are kept white, and lines introduced within the last month are1199colored red.12001201color.blame.repeatedLines::1202 Use the customized color for the part of git-blame output that1203 is repeated meta information per line (such as commit id,1204 author name, date and timezone). Defaults to cyan.12051206color.branch::1207 A boolean to enable/disable color in the output of1208 linkgit:git-branch[1]. May be set to `always`,1209 `false` (or `never`) or `auto` (or `true`), in which case colors are used1210 only when the output is to a terminal. If unset, then the1211 value of `color.ui` is used (`auto` by default).12121213color.branch.<slot>::1214 Use customized color for branch coloration. `<slot>` is one of1215 `current` (the current branch), `local` (a local branch),1216 `remote` (a remote-tracking branch in refs/remotes/),1217 `upstream` (upstream tracking branch), `plain` (other1218 refs).12191220color.diff::1221 Whether to use ANSI escape sequences to add color to patches.1222 If this is set to `always`, linkgit:git-diff[1],1223 linkgit:git-log[1], and linkgit:git-show[1] will use color1224 for all patches. If it is set to `true` or `auto`, those1225 commands will only use color when output is to the terminal.1226 If unset, then the value of `color.ui` is used (`auto` by1227 default).1228+1229This does not affect linkgit:git-format-patch[1] or the1230'git-diff-{asterisk}' plumbing commands. Can be overridden on the1231command line with the `--color[=<when>]` option.12321233color.diff.<slot>::1234 Use customized color for diff colorization. `<slot>` specifies1235 which part of the patch to use the specified color, and is one1236 of `context` (context text - `plain` is a historical synonym),1237 `meta` (metainformation), `frag`1238 (hunk header), 'func' (function in hunk header), `old` (removed lines),1239 `new` (added lines), `commit` (commit headers), `whitespace`1240 (highlighting whitespace errors), `oldMoved` (deleted lines),1241 `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,1242 `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`1243 `newMovedAlternativeDimmed` (See the '<mode>'1244 setting of '--color-moved' in linkgit:git-diff[1] for details),1245 `contextDimmed`, `oldDimmed`, `newDimmed`, `contextBold`,1246 `oldBold`, and `newBold` (see linkgit:git-range-diff[1] for details).12471248color.decorate.<slot>::1249 Use customized color for 'git log --decorate' output. `<slot>` is one1250 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local1251 branches, remote-tracking branches, tags, stash and HEAD, respectively1252 and `grafted` for grafted commits.12531254color.grep::1255 When set to `always`, always highlight matches. When `false` (or1256 `never`), never. When set to `true` or `auto`, use color only1257 when the output is written to the terminal. If unset, then the1258 value of `color.ui` is used (`auto` by default).12591260color.grep.<slot>::1261 Use customized color for grep colorization. `<slot>` specifies which1262 part of the line to use the specified color, and is one of1263+1264--1265`context`;;1266 non-matching text in context lines (when using `-A`, `-B`, or `-C`)1267`filename`;;1268 filename prefix (when not using `-h`)1269`function`;;1270 function name lines (when using `-p`)1271`lineNumber`;;1272 line number prefix (when using `-n`)1273`column`;;1274 column number prefix (when using `--column`)1275`match`;;1276 matching text (same as setting `matchContext` and `matchSelected`)1277`matchContext`;;1278 matching text in context lines1279`matchSelected`;;1280 matching text in selected lines1281`selected`;;1282 non-matching text in selected lines1283`separator`;;1284 separators between fields on a line (`:`, `-`, and `=`)1285 and between hunks (`--`)1286--12871288color.interactive::1289 When set to `always`, always use colors for interactive prompts1290 and displays (such as those used by "git-add --interactive" and1291 "git-clean --interactive"). When false (or `never`), never.1292 When set to `true` or `auto`, use colors only when the output is1293 to the terminal. If unset, then the value of `color.ui` is1294 used (`auto` by default).12951296color.interactive.<slot>::1297 Use customized color for 'git add --interactive' and 'git clean1298 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1299 or `error`, for four distinct types of normal output from1300 interactive commands.13011302color.pager::1303 A boolean to enable/disable colored output when the pager is in1304 use (default is true).13051306color.push::1307 A boolean to enable/disable color in push errors. May be set to1308 `always`, `false` (or `never`) or `auto` (or `true`), in which1309 case colors are used only when the error output goes to a terminal.1310 If unset, then the value of `color.ui` is used (`auto` by default).13111312color.push.error::1313 Use customized color for push errors.13141315color.remote::1316 If set, keywords at the start of the line are highlighted. The1317 keywords are "error", "warning", "hint" and "success", and are1318 matched case-insensitively. May be set to `always`, `false` (or1319 `never`) or `auto` (or `true`). If unset, then the value of1320 `color.ui` is used (`auto` by default).13211322color.remote.<slot>::1323 Use customized color for each remote keyword. `<slot>` may be1324 `hint`, `warning`, `success` or `error` which match the1325 corresponding keyword.13261327color.showBranch::1328 A boolean to enable/disable color in the output of1329 linkgit:git-show-branch[1]. May be set to `always`,1330 `false` (or `never`) or `auto` (or `true`), in which case colors are used1331 only when the output is to a terminal. If unset, then the1332 value of `color.ui` is used (`auto` by default).13331334color.status::1335 A boolean to enable/disable color in the output of1336 linkgit:git-status[1]. May be set to `always`,1337 `false` (or `never`) or `auto` (or `true`), in which case colors are used1338 only when the output is to a terminal. If unset, then the1339 value of `color.ui` is used (`auto` by default).13401341color.status.<slot>::1342 Use customized color for status colorization. `<slot>` is1343 one of `header` (the header text of the status message),1344 `added` or `updated` (files which are added but not committed),1345 `changed` (files which are changed but not added in the index),1346 `untracked` (files which are not tracked by Git),1347 `branch` (the current branch),1348 `nobranch` (the color the 'no branch' warning is shown in, defaulting1349 to red),1350 `localBranch` or `remoteBranch` (the local and remote branch names,1351 respectively, when branch and tracking information is displayed in the1352 status short-format), or1353 `unmerged` (files which have unmerged changes).13541355color.transport::1356 A boolean to enable/disable color when pushes are rejected. May be1357 set to `always`, `false` (or `never`) or `auto` (or `true`), in which1358 case colors are used only when the error output goes to a terminal.1359 If unset, then the value of `color.ui` is used (`auto` by default).13601361color.transport.rejected::1362 Use customized color when a push was rejected.13631364color.ui::1365 This variable determines the default value for variables such1366 as `color.diff` and `color.grep` that control the use of color1367 per command family. Its scope will expand as more commands learn1368 configuration to set a default for the `--color` option. Set it1369 to `false` or `never` if you prefer Git commands not to use1370 color unless enabled explicitly with some other configuration1371 or the `--color` option. Set it to `always` if you want all1372 output not intended for machine consumption to use color, to1373 `true` or `auto` (this is the default since Git 1.8.4) if you1374 want such output to use color when written to the terminal.13751376column.ui::1377 Specify whether supported commands should output in columns.1378 This variable consists of a list of tokens separated by spaces1379 or commas:1380+1381These options control when the feature should be enabled1382(defaults to 'never'):1383+1384--1385`always`;;1386 always show in columns1387`never`;;1388 never show in columns1389`auto`;;1390 show in columns if the output is to the terminal1391--1392+1393These options control layout (defaults to 'column'). Setting any1394of these implies 'always' if none of 'always', 'never', or 'auto' are1395specified.1396+1397--1398`column`;;1399 fill columns before rows1400`row`;;1401 fill rows before columns1402`plain`;;1403 show in one column1404--1405+1406Finally, these options can be combined with a layout option (defaults1407to 'nodense'):1408+1409--1410`dense`;;1411 make unequal size columns to utilize more space1412`nodense`;;1413 make equal size columns1414--14151416column.branch::1417 Specify whether to output branch listing in `git branch` in columns.1418 See `column.ui` for details.14191420column.clean::1421 Specify the layout when list items in `git clean -i`, which always1422 shows files and directories in columns. See `column.ui` for details.14231424column.status::1425 Specify whether to output untracked files in `git status` in columns.1426 See `column.ui` for details.14271428column.tag::1429 Specify whether to output tag listing in `git tag` in columns.1430 See `column.ui` for details.14311432commit.cleanup::1433 This setting overrides the default of the `--cleanup` option in1434 `git commit`. See linkgit:git-commit[1] for details. Changing the1435 default can be useful when you always want to keep lines that begin1436 with comment character `#` in your log message, in which case you1437 would do `git config commit.cleanup whitespace` (note that you will1438 have to remove the help lines that begin with `#` in the commit log1439 template yourself, if you do this).14401441commit.gpgSign::14421443 A boolean to specify whether all commits should be GPG signed.1444 Use of this option when doing operations such as rebase can1445 result in a large number of commits being signed. It may be1446 convenient to use an agent to avoid typing your GPG passphrase1447 several times.14481449commit.status::1450 A boolean to enable/disable inclusion of status information in the1451 commit message template when using an editor to prepare the commit1452 message. Defaults to true.14531454commit.template::1455 Specify the pathname of a file to use as the template for1456 new commit messages.14571458commit.verbose::1459 A boolean or int to specify the level of verbose with `git commit`.1460 See linkgit:git-commit[1].14611462credential.helper::1463 Specify an external helper to be called when a username or1464 password credential is needed; the helper may consult external1465 storage to avoid prompting the user for the credentials. Note1466 that multiple helpers may be defined. See linkgit:gitcredentials[7]1467 for details.14681469credential.useHttpPath::1470 When acquiring credentials, consider the "path" component of an http1471 or https URL to be important. Defaults to false. See1472 linkgit:gitcredentials[7] for more information.14731474credential.username::1475 If no username is set for a network authentication, use this username1476 by default. See credential.<context>.* below, and1477 linkgit:gitcredentials[7].14781479credential.<url>.*::1480 Any of the credential.* options above can be applied selectively to1481 some credentials. For example "credential.https://example.com.username"1482 would set the default username only for https connections to1483 example.com. See linkgit:gitcredentials[7] for details on how URLs are1484 matched.14851486credentialCache.ignoreSIGHUP::1487 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.14881489completion.commands::1490 This is only used by git-completion.bash to add or remove1491 commands from the list of completed commands. Normally only1492 porcelain commands and a few select others are completed. You1493 can add more commands, separated by space, in this1494 variable. Prefixing the command with '-' will remove it from1495 the existing list.14961497include::diff-config.txt[]14981499difftool.<tool>.path::1500 Override the path for the given tool. This is useful in case1501 your tool is not in the PATH.15021503difftool.<tool>.cmd::1504 Specify the command to invoke the specified diff tool.1505 The specified command is evaluated in shell with the following1506 variables available: 'LOCAL' is set to the name of the temporary1507 file containing the contents of the diff pre-image and 'REMOTE'1508 is set to the name of the temporary file containing the contents1509 of the diff post-image.15101511difftool.prompt::1512 Prompt before each invocation of the diff tool.15131514fastimport.unpackLimit::1515 If the number of objects imported by linkgit:git-fast-import[1]1516 is below this limit, then the objects will be unpacked into1517 loose object files. However if the number of imported objects1518 equals or exceeds this limit then the pack will be stored as a1519 pack. Storing the pack from a fast-import can make the import1520 operation complete faster, especially on slow filesystems. If1521 not set, the value of `transfer.unpackLimit` is used instead.15221523fetch.recurseSubmodules::1524 This option can be either set to a boolean value or to 'on-demand'.1525 Setting it to a boolean changes the behavior of fetch and pull to1526 unconditionally recurse into submodules when set to true or to not1527 recurse at all when set to false. When set to 'on-demand' (the default1528 value), fetch and pull will only recurse into a populated submodule1529 when its superproject retrieves a commit that updates the submodule's1530 reference.15311532fetch.fsckObjects::1533 If it is set to true, git-fetch-pack will check all fetched1534 objects. See `transfer.fsckObjects` for what's1535 checked. Defaults to false. If not set, the value of1536 `transfer.fsckObjects` is used instead.15371538fetch.fsck.<msg-id>::1539 Acts like `fsck.<msg-id>`, but is used by1540 linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See1541 the `fsck.<msg-id>` documentation for details.15421543fetch.fsck.skipList::1544 Acts like `fsck.skipList`, but is used by1545 linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See1546 the `fsck.skipList` documentation for details.15471548fetch.unpackLimit::1549 If the number of objects fetched over the Git native1550 transfer is below this1551 limit, then the objects will be unpacked into loose object1552 files. However if the number of received objects equals or1553 exceeds this limit then the received pack will be stored as1554 a pack, after adding any missing delta bases. Storing the1555 pack from a push can make the push operation complete faster,1556 especially on slow filesystems. If not set, the value of1557 `transfer.unpackLimit` is used instead.15581559fetch.prune::1560 If true, fetch will automatically behave as if the `--prune`1561 option was given on the command line. See also `remote.<name>.prune`1562 and the PRUNING section of linkgit:git-fetch[1].15631564fetch.pruneTags::1565 If true, fetch will automatically behave as if the1566 `refs/tags/*:refs/tags/*` refspec was provided when pruning,1567 if not set already. This allows for setting both this option1568 and `fetch.prune` to maintain a 1=1 mapping to upstream1569 refs. See also `remote.<name>.pruneTags` and the PRUNING1570 section of linkgit:git-fetch[1].15711572fetch.output::1573 Control how ref update status is printed. Valid values are1574 `full` and `compact`. Default value is `full`. See section1575 OUTPUT in linkgit:git-fetch[1] for detail.15761577fetch.negotiationAlgorithm::1578 Control how information about the commits in the local repository is1579 sent when negotiating the contents of the packfile to be sent by the1580 server. Set to "skipping" to use an algorithm that skips commits in an1581 effort to converge faster, but may result in a larger-than-necessary1582 packfile; The default is "default" which instructs Git to use the default algorithm1583 that never skips commits (unless the server has acknowledged it or one1584 of its descendants).1585 Unknown values will cause 'git fetch' to error out.1586+1587See also the `--negotiation-tip` option for linkgit:git-fetch[1].15881589format.attach::1590 Enable multipart/mixed attachments as the default for1591 'format-patch'. The value can also be a double quoted string1592 which will enable attachments as the default and set the1593 value as the boundary. See the --attach option in1594 linkgit:git-format-patch[1].15951596format.from::1597 Provides the default value for the `--from` option to format-patch.1598 Accepts a boolean value, or a name and email address. If false,1599 format-patch defaults to `--no-from`, using commit authors directly in1600 the "From:" field of patch mails. If true, format-patch defaults to1601 `--from`, using your committer identity in the "From:" field of patch1602 mails and including a "From:" field in the body of the patch mail if1603 different. If set to a non-boolean value, format-patch uses that1604 value instead of your committer identity. Defaults to false.16051606format.numbered::1607 A boolean which can enable or disable sequence numbers in patch1608 subjects. It defaults to "auto" which enables it only if there1609 is more than one patch. It can be enabled or disabled for all1610 messages by setting it to "true" or "false". See --numbered1611 option in linkgit:git-format-patch[1].16121613format.headers::1614 Additional email headers to include in a patch to be submitted1615 by mail. See linkgit:git-format-patch[1].16161617format.to::1618format.cc::1619 Additional recipients to include in a patch to be submitted1620 by mail. See the --to and --cc options in1621 linkgit:git-format-patch[1].16221623format.subjectPrefix::1624 The default for format-patch is to output files with the '[PATCH]'1625 subject prefix. Use this variable to change that prefix.16261627format.signature::1628 The default for format-patch is to output a signature containing1629 the Git version number. Use this variable to change that default.1630 Set this variable to the empty string ("") to suppress1631 signature generation.16321633format.signatureFile::1634 Works just like format.signature except the contents of the1635 file specified by this variable will be used as the signature.16361637format.suffix::1638 The default for format-patch is to output files with the suffix1639 `.patch`. Use this variable to change that suffix (make sure to1640 include the dot if you want it).16411642format.pretty::1643 The default pretty format for log/show/whatchanged command,1644 See linkgit:git-log[1], linkgit:git-show[1],1645 linkgit:git-whatchanged[1].16461647format.thread::1648 The default threading style for 'git format-patch'. Can be1649 a boolean value, or `shallow` or `deep`. `shallow` threading1650 makes every mail a reply to the head of the series,1651 where the head is chosen from the cover letter, the1652 `--in-reply-to`, and the first patch mail, in this order.1653 `deep` threading makes every mail a reply to the previous one.1654 A true boolean value is the same as `shallow`, and a false1655 value disables threading.16561657format.signOff::1658 A boolean value which lets you enable the `-s/--signoff` option of1659 format-patch by default. *Note:* Adding the Signed-off-by: line to a1660 patch should be a conscious act and means that you certify you have1661 the rights to submit this work under the same open source license.1662 Please see the 'SubmittingPatches' document for further discussion.16631664format.coverLetter::1665 A boolean that controls whether to generate a cover-letter when1666 format-patch is invoked, but in addition can be set to "auto", to1667 generate a cover-letter only when there's more than one patch.16681669format.outputDirectory::1670 Set a custom directory to store the resulting files instead of the1671 current working directory.16721673format.useAutoBase::1674 A boolean value which lets you enable the `--base=auto` option of1675 format-patch by default.16761677filter.<driver>.clean::1678 The command which is used to convert the content of a worktree1679 file to a blob upon checkin. See linkgit:gitattributes[5] for1680 details.16811682filter.<driver>.smudge::1683 The command which is used to convert the content of a blob1684 object to a worktree file upon checkout. See1685 linkgit:gitattributes[5] for details.16861687fsck.<msg-id>::1688 During fsck git may find issues with legacy data which1689 wouldn't be generated by current versions of git, and which1690 wouldn't be sent over the wire if `transfer.fsckObjects` was1691 set. This feature is intended to support working with legacy1692 repositories containing such data.1693+1694Setting `fsck.<msg-id>` will be picked up by linkgit:git-fsck[1], but1695to accept pushes of such data set `receive.fsck.<msg-id>` instead, or1696to clone or fetch it set `fetch.fsck.<msg-id>`.1697+1698The rest of the documentation discusses `fsck.*` for brevity, but the1699same applies for the corresponding `receive.fsck.*` and1700`fetch.<msg-id>.*`. variables.1701+1702Unlike variables like `color.ui` and `core.editor` the1703`receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` variables will not1704fall back on the `fsck.<msg-id>` configuration if they aren't set. To1705uniformly configure the same fsck settings in different circumstances1706all three of them they must all set to the same values.1707+1708When `fsck.<msg-id>` is set, errors can be switched to warnings and1709vice versa by configuring the `fsck.<msg-id>` setting where the1710`<msg-id>` is the fsck message ID and the value is one of `error`,1711`warn` or `ignore`. For convenience, fsck prefixes the error/warning1712with the message ID, e.g. "missingEmail: invalid author/committer line1713- missing email" means that setting `fsck.missingEmail = ignore` will1714hide that issue.1715+1716In general, it is better to enumerate existing objects with problems1717with `fsck.skipList`, instead of listing the kind of breakages these1718problematic objects share to be ignored, as doing the latter will1719allow new instances of the same breakages go unnoticed.1720+1721Setting an unknown `fsck.<msg-id>` value will cause fsck to die, but1722doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>`1723will only cause git to warn.17241725fsck.skipList::1726 The path to a sorted list of object names (i.e. one SHA-1 per1727 line) that are known to be broken in a non-fatal way and should1728 be ignored. This feature is useful when an established project1729 should be accepted despite early commits containing errors that1730 can be safely ignored such as invalid committer email addresses.1731 Note: corrupt objects cannot be skipped with this setting.1732+1733Like `fsck.<msg-id>` this variable has corresponding1734`receive.fsck.skipList` and `fetch.fsck.skipList` variants.1735+1736Unlike variables like `color.ui` and `core.editor` the1737`receive.fsck.skipList` and `fetch.fsck.skipList` variables will not1738fall back on the `fsck.skipList` configuration if they aren't set. To1739uniformly configure the same fsck settings in different circumstances1740all three of them they must all set to the same values.17411742gc.aggressiveDepth::1743 The depth parameter used in the delta compression1744 algorithm used by 'git gc --aggressive'. This defaults1745 to 50.17461747gc.aggressiveWindow::1748 The window size parameter used in the delta compression1749 algorithm used by 'git gc --aggressive'. This defaults1750 to 250.17511752gc.auto::1753 When there are approximately more than this many loose1754 objects in the repository, `git gc --auto` will pack them.1755 Some Porcelain commands use this command to perform a1756 light-weight garbage collection from time to time. The1757 default value is 6700. Setting this to 0 disables it.17581759gc.autoPackLimit::1760 When there are more than this many packs that are not1761 marked with `*.keep` file in the repository, `git gc1762 --auto` consolidates them into one larger pack. The1763 default value is 50. Setting this to 0 disables it.17641765gc.autoDetach::1766 Make `git gc --auto` return immediately and run in background1767 if the system supports it. Default is true.17681769gc.bigPackThreshold::1770 If non-zero, all packs larger than this limit are kept when1771 `git gc` is run. This is very similar to `--keep-base-pack`1772 except that all packs that meet the threshold are kept, not1773 just the base pack. Defaults to zero. Common unit suffixes of1774 'k', 'm', or 'g' are supported.1775+1776Note that if the number of kept packs is more than gc.autoPackLimit,1777this configuration variable is ignored, all packs except the base pack1778will be repacked. After this the number of packs should go below1779gc.autoPackLimit and gc.bigPackThreshold should be respected again.17801781gc.writeCommitGraph::1782 If true, then gc will rewrite the commit-graph file when1783 linkgit:git-gc[1] is run. When using linkgit:git-gc[1]1784 '--auto' the commit-graph will be updated if housekeeping is1785 required. Default is false. See linkgit:git-commit-graph[1]1786 for details.17871788gc.logExpiry::1789 If the file gc.log exists, then `git gc --auto` won't run1790 unless that file is more than 'gc.logExpiry' old. Default is1791 "1.day". See `gc.pruneExpire` for more ways to specify its1792 value.17931794gc.packRefs::1795 Running `git pack-refs` in a repository renders it1796 unclonable by Git versions prior to 1.5.1.2 over dumb1797 transports such as HTTP. This variable determines whether1798 'git gc' runs `git pack-refs`. This can be set to `notbare`1799 to enable it within all non-bare repos or it can be set to a1800 boolean value. The default is `true`.18011802gc.pruneExpire::1803 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1804 Override the grace period with this config variable. The value1805 "now" may be used to disable this grace period and always prune1806 unreachable objects immediately, or "never" may be used to1807 suppress pruning. This feature helps prevent corruption when1808 'git gc' runs concurrently with another process writing to the1809 repository; see the "NOTES" section of linkgit:git-gc[1].18101811gc.worktreePruneExpire::1812 When 'git gc' is run, it calls1813 'git worktree prune --expire 3.months.ago'.1814 This config variable can be used to set a different grace1815 period. The value "now" may be used to disable the grace1816 period and prune `$GIT_DIR/worktrees` immediately, or "never"1817 may be used to suppress pruning.18181819gc.reflogExpire::1820gc.<pattern>.reflogExpire::1821 'git reflog expire' removes reflog entries older than1822 this time; defaults to 90 days. The value "now" expires all1823 entries immediately, and "never" suppresses expiration1824 altogether. With "<pattern>" (e.g.1825 "refs/stash") in the middle the setting applies only to1826 the refs that match the <pattern>.18271828gc.reflogExpireUnreachable::1829gc.<pattern>.reflogExpireUnreachable::1830 'git reflog expire' removes reflog entries older than1831 this time and are not reachable from the current tip;1832 defaults to 30 days. The value "now" expires all entries1833 immediately, and "never" suppresses expiration altogether.1834 With "<pattern>" (e.g. "refs/stash")1835 in the middle, the setting applies only to the refs that1836 match the <pattern>.18371838gc.rerereResolved::1839 Records of conflicted merge you resolved earlier are1840 kept for this many days when 'git rerere gc' is run.1841 You can also use more human-readable "1.month.ago", etc.1842 The default is 60 days. See linkgit:git-rerere[1].18431844gc.rerereUnresolved::1845 Records of conflicted merge you have not resolved are1846 kept for this many days when 'git rerere gc' is run.1847 You can also use more human-readable "1.month.ago", etc.1848 The default is 15 days. See linkgit:git-rerere[1].18491850gitcvs.commitMsgAnnotation::1851 Append this string to each commit message. Set to empty string1852 to disable this feature. Defaults to "via git-CVS emulator".18531854gitcvs.enabled::1855 Whether the CVS server interface is enabled for this repository.1856 See linkgit:git-cvsserver[1].18571858gitcvs.logFile::1859 Path to a log file where the CVS server interface well... logs1860 various stuff. See linkgit:git-cvsserver[1].18611862gitcvs.usecrlfattr::1863 If true, the server will look up the end-of-line conversion1864 attributes for files to determine the `-k` modes to use. If1865 the attributes force Git to treat a file as text,1866 the `-k` mode will be left blank so CVS clients will1867 treat it as text. If they suppress text conversion, the file1868 will be set with '-kb' mode, which suppresses any newline munging1869 the client might otherwise do. If the attributes do not allow1870 the file type to be determined, then `gitcvs.allBinary` is1871 used. See linkgit:gitattributes[5].18721873gitcvs.allBinary::1874 This is used if `gitcvs.usecrlfattr` does not resolve1875 the correct '-kb' mode to use. If true, all1876 unresolved files are sent to the client in1877 mode '-kb'. This causes the client to treat them1878 as binary files, which suppresses any newline munging it1879 otherwise might do. Alternatively, if it is set to "guess",1880 then the contents of the file are examined to decide if1881 it is binary, similar to `core.autocrlf`.18821883gitcvs.dbName::1884 Database used by git-cvsserver to cache revision information1885 derived from the Git repository. The exact meaning depends on the1886 used database driver, for SQLite (which is the default driver) this1887 is a filename. Supports variable substitution (see1888 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1889 Default: '%Ggitcvs.%m.sqlite'18901891gitcvs.dbDriver::1892 Used Perl DBI driver. You can specify any available driver1893 for this here, but it might not work. git-cvsserver is tested1894 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1895 reported *not* to work with 'DBD::mysql'. Experimental feature.1896 May not contain double colons (`:`). Default: 'SQLite'.1897 See linkgit:git-cvsserver[1].18981899gitcvs.dbUser, gitcvs.dbPass::1900 Database user and password. Only useful if setting `gitcvs.dbDriver`,1901 since SQLite has no concept of database users and/or passwords.1902 'gitcvs.dbUser' supports variable substitution (see1903 linkgit:git-cvsserver[1] for details).19041905gitcvs.dbTableNamePrefix::1906 Database table name prefix. Prepended to the names of any1907 database tables used, allowing a single database to be used1908 for several repositories. Supports variable substitution (see1909 linkgit:git-cvsserver[1] for details). Any non-alphabetic1910 characters will be replaced with underscores.19111912All gitcvs variables except for `gitcvs.usecrlfattr` and1913`gitcvs.allBinary` can also be specified as1914'gitcvs.<access_method>.<varname>' (where 'access_method'1915is one of "ext" and "pserver") to make them apply only for the given1916access method.19171918gitweb.category::1919gitweb.description::1920gitweb.owner::1921gitweb.url::1922 See linkgit:gitweb[1] for description.19231924gitweb.avatar::1925gitweb.blame::1926gitweb.grep::1927gitweb.highlight::1928gitweb.patches::1929gitweb.pickaxe::1930gitweb.remote_heads::1931gitweb.showSizes::1932gitweb.snapshot::1933 See linkgit:gitweb.conf[5] for description.19341935grep.lineNumber::1936 If set to true, enable `-n` option by default.19371938grep.column::1939 If set to true, enable the `--column` option by default.19401941grep.patternType::1942 Set the default matching behavior. Using a value of 'basic', 'extended',1943 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1944 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1945 value 'default' will return to the default matching behavior.19461947grep.extendedRegexp::1948 If set to true, enable `--extended-regexp` option by default. This1949 option is ignored when the `grep.patternType` option is set to a value1950 other than 'default'.19511952grep.threads::1953 Number of grep worker threads to use.1954 See `grep.threads` in linkgit:git-grep[1] for more information.19551956grep.fallbackToNoIndex::1957 If set to true, fall back to git grep --no-index if git grep1958 is executed outside of a git repository. Defaults to false.19591960gpg.program::1961 Use this custom program instead of "`gpg`" found on `$PATH` when1962 making or verifying a PGP signature. The program must support the1963 same command-line interface as GPG, namely, to verify a detached1964 signature, "`gpg --verify $file - <$signature`" is run, and the1965 program is expected to signal a good signature by exiting with1966 code 0, and to generate an ASCII-armored detached signature, the1967 standard input of "`gpg -bsau $key`" is fed with the contents to be1968 signed, and the program is expected to send the result to its1969 standard output.19701971gpg.format::1972 Specifies which key format to use when signing with `--gpg-sign`.1973 Default is "openpgp" and another possible value is "x509".19741975gpg.<format>.program::1976 Use this to customize the program used for the signing format you1977 chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still1978 be used as a legacy synonym for `gpg.openpgp.program`. The default1979 value for `gpg.x509.program` is "gpgsm".19801981gui.commitMsgWidth::1982 Defines how wide the commit message window is in the1983 linkgit:git-gui[1]. "75" is the default.19841985gui.diffContext::1986 Specifies how many context lines should be used in calls to diff1987 made by the linkgit:git-gui[1]. The default is "5".19881989gui.displayUntracked::1990 Determines if linkgit:git-gui[1] shows untracked files1991 in the file list. The default is "true".19921993gui.encoding::1994 Specifies the default encoding to use for displaying of1995 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1996 It can be overridden by setting the 'encoding' attribute1997 for relevant files (see linkgit:gitattributes[5]).1998 If this option is not set, the tools default to the1999 locale encoding.20002001gui.matchTrackingBranch::2002 Determines if new branches created with linkgit:git-gui[1] should2003 default to tracking remote branches with matching names or2004 not. Default: "false".20052006gui.newBranchTemplate::2007 Is used as suggested name when creating new branches using the2008 linkgit:git-gui[1].20092010gui.pruneDuringFetch::2011 "true" if linkgit:git-gui[1] should prune remote-tracking branches when2012 performing a fetch. The default value is "false".20132014gui.trustmtime::2015 Determines if linkgit:git-gui[1] should trust the file modification2016 timestamp or not. By default the timestamps are not trusted.20172018gui.spellingDictionary::2019 Specifies the dictionary used for spell checking commit messages in2020 the linkgit:git-gui[1]. When set to "none" spell checking is turned2021 off.20222023gui.fastCopyBlame::2024 If true, 'git gui blame' uses `-C` instead of `-C -C` for original2025 location detection. It makes blame significantly faster on huge2026 repositories at the expense of less thorough copy detection.20272028gui.copyBlameThreshold::2029 Specifies the threshold to use in 'git gui blame' original location2030 detection, measured in alphanumeric characters. See the2031 linkgit:git-blame[1] manual for more information on copy detection.20322033gui.blamehistoryctx::2034 Specifies the radius of history context in days to show in2035 linkgit:gitk[1] for the selected commit, when the `Show History2036 Context` menu item is invoked from 'git gui blame'. If this2037 variable is set to zero, the whole history is shown.20382039guitool.<name>.cmd::2040 Specifies the shell command line to execute when the corresponding item2041 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is2042 mandatory for every tool. The command is executed from the root of2043 the working directory, and in the environment it receives the name of2044 the tool as `GIT_GUITOOL`, the name of the currently selected file as2045 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if2046 the head is detached, 'CUR_BRANCH' is empty).20472048guitool.<name>.needsFile::2049 Run the tool only if a diff is selected in the GUI. It guarantees2050 that 'FILENAME' is not empty.20512052guitool.<name>.noConsole::2053 Run the command silently, without creating a window to display its2054 output.20552056guitool.<name>.noRescan::2057 Don't rescan the working directory for changes after the tool2058 finishes execution.20592060guitool.<name>.confirm::2061 Show a confirmation dialog before actually running the tool.20622063guitool.<name>.argPrompt::2064 Request a string argument from the user, and pass it to the tool2065 through the `ARGS` environment variable. Since requesting an2066 argument implies confirmation, the 'confirm' option has no effect2067 if this is enabled. If the option is set to 'true', 'yes', or '1',2068 the dialog uses a built-in generic prompt; otherwise the exact2069 value of the variable is used.20702071guitool.<name>.revPrompt::2072 Request a single valid revision from the user, and set the2073 `REVISION` environment variable. In other aspects this option2074 is similar to 'argPrompt', and can be used together with it.20752076guitool.<name>.revUnmerged::2077 Show only unmerged branches in the 'revPrompt' subdialog.2078 This is useful for tools similar to merge or rebase, but not2079 for things like checkout or reset.20802081guitool.<name>.title::2082 Specifies the title to use for the prompt dialog. The default2083 is the tool name.20842085guitool.<name>.prompt::2086 Specifies the general prompt string to display at the top of2087 the dialog, before subsections for 'argPrompt' and 'revPrompt'.2088 The default value includes the actual command.20892090help.browser::2091 Specify the browser that will be used to display help in the2092 'web' format. See linkgit:git-help[1].20932094help.format::2095 Override the default help format used by linkgit:git-help[1].2096 Values 'man', 'info', 'web' and 'html' are supported. 'man' is2097 the default. 'web' and 'html' are the same.20982099help.autoCorrect::2100 Automatically correct and execute mistyped commands after2101 waiting for the given number of deciseconds (0.1 sec). If more2102 than one command can be deduced from the entered text, nothing2103 will be executed. If the value of this option is negative,2104 the corrected command will be executed immediately. If the2105 value is 0 - the command will be just shown but not executed.2106 This is the default.21072108help.htmlPath::2109 Specify the path where the HTML documentation resides. File system paths2110 and URLs are supported. HTML pages will be prefixed with this path when2111 help is displayed in the 'web' format. This defaults to the documentation2112 path of your Git installation.21132114http.proxy::2115 Override the HTTP proxy, normally configured using the 'http_proxy',2116 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In2117 addition to the syntax understood by curl, it is possible to specify a2118 proxy string with a user name but no password, in which case git will2119 attempt to acquire one in the same way it does for other credentials. See2120 linkgit:gitcredentials[7] for more information. The syntax thus is2121 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden2122 on a per-remote basis; see remote.<name>.proxy21232124http.proxyAuthMethod::2125 Set the method with which to authenticate against the HTTP proxy. This2126 only takes effect if the configured proxy string contains a user name part2127 (i.e. is of the form 'user@host' or 'user@host:port'). This can be2128 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.2129 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment2130 variable. Possible values are:2131+2132--2133* `anyauth` - Automatically pick a suitable authentication method. It is2134 assumed that the proxy answers an unauthenticated request with a 4072135 status code and one or more Proxy-authenticate headers with supported2136 authentication methods. This is the default.2137* `basic` - HTTP Basic authentication2138* `digest` - HTTP Digest authentication; this prevents the password from being2139 transmitted to the proxy in clear text2140* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option2141 of `curl(1)`)2142* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)2143--21442145http.emptyAuth::2146 Attempt authentication without seeking a username or password. This2147 can be used to attempt GSS-Negotiate authentication without specifying2148 a username in the URL, as libcurl normally requires a username for2149 authentication.21502151http.delegation::2152 Control GSSAPI credential delegation. The delegation is disabled2153 by default in libcurl since version 7.21.7. Set parameter to tell2154 the server what it is allowed to delegate when it comes to user2155 credentials. Used with GSS/kerberos. Possible values are:2156+2157--2158* `none` - Don't allow any delegation.2159* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the2160 Kerberos service ticket, which is a matter of realm policy.2161* `always` - Unconditionally allow the server to delegate.2162--216321642165http.extraHeader::2166 Pass an additional HTTP header when communicating with a server. If2167 more than one such entry exists, all of them are added as extra2168 headers. To allow overriding the settings inherited from the system2169 config, an empty value will reset the extra headers to the empty list.21702171http.cookieFile::2172 The pathname of a file containing previously stored cookie lines,2173 which should be used2174 in the Git http session, if they match the server. The file format2175 of the file to read cookies from should be plain HTTP headers or2176 the Netscape/Mozilla cookie file format (see `curl(1)`).2177 NOTE that the file specified with http.cookieFile is used only as2178 input unless http.saveCookies is set.21792180http.saveCookies::2181 If set, store cookies received during requests to the file specified by2182 http.cookieFile. Has no effect if http.cookieFile is unset.21832184http.sslVersion::2185 The SSL version to use when negotiating an SSL connection, if you2186 want to force the default. The available and default version2187 depend on whether libcurl was built against NSS or OpenSSL and the2188 particular configuration of the crypto library in use. Internally2189 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl2190 documentation for more details on the format of this option and2191 for the ssl version supported. Actually the possible values of2192 this option are:21932194 - sslv22195 - sslv32196 - tlsv12197 - tlsv1.02198 - tlsv1.12199 - tlsv1.22200 - tlsv1.322012202+2203Can be overridden by the `GIT_SSL_VERSION` environment variable.2204To force git to use libcurl's default ssl version and ignore any2205explicit http.sslversion option, set `GIT_SSL_VERSION` to the2206empty string.22072208http.sslCipherList::2209 A list of SSL ciphers to use when negotiating an SSL connection.2210 The available ciphers depend on whether libcurl was built against2211 NSS or OpenSSL and the particular configuration of the crypto2212 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'2213 option; see the libcurl documentation for more details on the format2214 of this list.2215+2216Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.2217To force git to use libcurl's default cipher list and ignore any2218explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the2219empty string.22202221http.sslVerify::2222 Whether to verify the SSL certificate when fetching or pushing2223 over HTTPS. Defaults to true. Can be overridden by the2224 `GIT_SSL_NO_VERIFY` environment variable.22252226http.sslCert::2227 File containing the SSL certificate when fetching or pushing2228 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment2229 variable.22302231http.sslKey::2232 File containing the SSL private key when fetching or pushing2233 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment2234 variable.22352236http.sslCertPasswordProtected::2237 Enable Git's password prompt for the SSL certificate. Otherwise2238 OpenSSL will prompt the user, possibly many times, if the2239 certificate or private key is encrypted. Can be overridden by the2240 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.22412242http.sslCAInfo::2243 File containing the certificates to verify the peer with when2244 fetching or pushing over HTTPS. Can be overridden by the2245 `GIT_SSL_CAINFO` environment variable.22462247http.sslCAPath::2248 Path containing files with the CA certificates to verify the peer2249 with when fetching or pushing over HTTPS. Can be overridden2250 by the `GIT_SSL_CAPATH` environment variable.22512252http.pinnedpubkey::2253 Public key of the https service. It may either be the filename of2254 a PEM or DER encoded public key file or a string starting with2255 'sha256//' followed by the base64 encoded sha256 hash of the2256 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will2257 exit with an error if this option is set but not supported by2258 cURL.22592260http.sslTry::2261 Attempt to use AUTH SSL/TLS and encrypted data transfers2262 when connecting via regular FTP protocol. This might be needed2263 if the FTP server requires it for security reasons or you wish2264 to connect securely whenever remote FTP server supports it.2265 Default is false since it might trigger certificate verification2266 errors on misconfigured servers.22672268http.maxRequests::2269 How many HTTP requests to launch in parallel. Can be overridden2270 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.22712272http.minSessions::2273 The number of curl sessions (counted across slots) to be kept across2274 requests. They will not be ended with curl_easy_cleanup() until2275 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this2276 value will be capped at 1. Defaults to 1.22772278http.postBuffer::2279 Maximum size in bytes of the buffer used by smart HTTP2280 transports when POSTing data to the remote system.2281 For requests larger than this buffer size, HTTP/1.1 and2282 Transfer-Encoding: chunked is used to avoid creating a2283 massive pack file locally. Default is 1 MiB, which is2284 sufficient for most requests.22852286http.lowSpeedLimit, http.lowSpeedTime::2287 If the HTTP transfer speed is less than 'http.lowSpeedLimit'2288 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.2289 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and2290 `GIT_HTTP_LOW_SPEED_TIME` environment variables.22912292http.noEPSV::2293 A boolean which disables using of EPSV ftp command by curl.2294 This can helpful with some "poor" ftp servers which don't2295 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`2296 environment variable. Default is false (curl will use EPSV).22972298http.userAgent::2299 The HTTP USER_AGENT string presented to an HTTP server. The default2300 value represents the version of the client Git such as git/1.7.1.2301 This option allows you to override this value to a more common value2302 such as Mozilla/4.0. This may be necessary, for instance, if2303 connecting through a firewall that restricts HTTP connections to a set2304 of common USER_AGENT strings (but not including those like git/1.7.1).2305 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.23062307http.followRedirects::2308 Whether git should follow HTTP redirects. If set to `true`, git2309 will transparently follow any redirect issued by a server it2310 encounters. If set to `false`, git will treat all redirects as2311 errors. If set to `initial`, git will follow redirects only for2312 the initial request to a remote, but not for subsequent2313 follow-up HTTP requests. Since git uses the redirected URL as2314 the base for the follow-up requests, this is generally2315 sufficient. The default is `initial`.23162317http.<url>.*::2318 Any of the http.* options above can be applied selectively to some URLs.2319 For a config key to match a URL, each element of the config key is2320 compared to that of the URL, in the following order:2321+2322--2323. Scheme (e.g., `https` in `https://example.com/`). This field2324 must match exactly between the config key and the URL.23252326. Host/domain name (e.g., `example.com` in `https://example.com/`).2327 This field must match between the config key and the URL. It is2328 possible to specify a `*` as part of the host name to match all subdomains2329 at this level. `https://*.example.com/` for example would match2330 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.23312332. Port number (e.g., `8080` in `http://example.com:8080/`).2333 This field must match exactly between the config key and the URL.2334 Omitted port numbers are automatically converted to the correct2335 default for the scheme before matching.23362337. Path (e.g., `repo.git` in `https://example.com/repo.git`). The2338 path field of the config key must match the path field of the URL2339 either exactly or as a prefix of slash-delimited path elements. This means2340 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only2341 match on a slash (`/`) boundary. Longer matches take precedence (so a config2342 key with path `foo/bar` is a better match to URL path `foo/bar` than a config2343 key with just path `foo/`).23442345. User name (e.g., `user` in `https://user@example.com/repo.git`). If2346 the config key has a user name it must match the user name in the2347 URL exactly. If the config key does not have a user name, that2348 config key will match a URL with any user name (including none),2349 but at a lower precedence than a config key with a user name.2350--2351+2352The list above is ordered by decreasing precedence; a URL that matches2353a config key's path is preferred to one that matches its user name. For example,2354if the URL is `https://user@example.com/foo/bar` a config key match of2355`https://example.com/foo` will be preferred over a config key match of2356`https://user@example.com`.2357+2358All URLs are normalized before attempting any matching (the password part,2359if embedded in the URL, is always ignored for matching purposes) so that2360equivalent URLs that are simply spelled differently will match properly.2361Environment variable settings always override any matches. The URLs that are2362matched against are those given directly to Git commands. This means any URLs2363visited as a result of a redirection do not participate in matching.23642365ssh.variant::2366 By default, Git determines the command line arguments to use2367 based on the basename of the configured SSH command (configured2368 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or2369 the config setting `core.sshCommand`). If the basename is2370 unrecognized, Git will attempt to detect support of OpenSSH2371 options by first invoking the configured SSH command with the2372 `-G` (print configuration) option and will subsequently use2373 OpenSSH options (if that is successful) or no options besides2374 the host and remote command (if it fails).2375+2376The config variable `ssh.variant` can be set to override this detection.2377Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,2378`tortoiseplink`, `simple` (no options except the host and remote command).2379The default auto-detection can be explicitly requested using the value2380`auto`. Any other value is treated as `ssh`. This setting can also be2381overridden via the environment variable `GIT_SSH_VARIANT`.2382+2383The current command-line parameters used for each variant are as2384follows:2385+2386--23872388* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command23892390* `simple` - [username@]host command23912392* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command23932394* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command23952396--2397+2398Except for the `simple` variant, command-line parameters are likely to2399change as git gains new features.24002401i18n.commitEncoding::2402 Character encoding the commit messages are stored in; Git itself2403 does not care per se, but this information is necessary e.g. when2404 importing commits from emails or in the gitk graphical history2405 browser (and possibly at other places in the future or in other2406 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.24072408i18n.logOutputEncoding::2409 Character encoding the commit messages are converted to when2410 running 'git log' and friends.24112412imap::2413 The configuration variables in the 'imap' section are described2414 in linkgit:git-imap-send[1].24152416index.threads::2417 Specifies the number of threads to spawn when loading the index.2418 This is meant to reduce index load time on multiprocessor machines.2419 Specifying 0 or 'true' will cause Git to auto-detect the number of2420 CPU's and set the number of threads accordingly. Specifying 1 or2421 'false' will disable multithreading. Defaults to 'true'.24222423index.version::2424 Specify the version with which new index files should be2425 initialized. This does not affect existing repositories.24262427init.templateDir::2428 Specify the directory from which templates will be copied.2429 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)24302431instaweb.browser::2432 Specify the program that will be used to browse your working2433 repository in gitweb. See linkgit:git-instaweb[1].24342435instaweb.httpd::2436 The HTTP daemon command-line to start gitweb on your working2437 repository. See linkgit:git-instaweb[1].24382439instaweb.local::2440 If true the web server started by linkgit:git-instaweb[1] will2441 be bound to the local IP (127.0.0.1).24422443instaweb.modulePath::2444 The default module path for linkgit:git-instaweb[1] to use2445 instead of /usr/lib/apache2/modules. Only used if httpd2446 is Apache.24472448instaweb.port::2449 The port number to bind the gitweb httpd to. See2450 linkgit:git-instaweb[1].24512452interactive.singleKey::2453 In interactive commands, allow the user to provide one-letter2454 input with a single key (i.e., without hitting enter).2455 Currently this is used by the `--patch` mode of2456 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],2457 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this2458 setting is silently ignored if portable keystroke input2459 is not available; requires the Perl module Term::ReadKey.24602461interactive.diffFilter::2462 When an interactive command (such as `git add --patch`) shows2463 a colorized diff, git will pipe the diff through the shell2464 command defined by this configuration variable. The command may2465 mark up the diff further for human consumption, provided that it2466 retains a one-to-one correspondence with the lines in the2467 original diff. Defaults to disabled (no filtering).24682469log.abbrevCommit::2470 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2471 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may2472 override this option with `--no-abbrev-commit`.24732474log.date::2475 Set the default date-time mode for the 'log' command.2476 Setting a value for log.date is similar to using 'git log''s2477 `--date` option. See linkgit:git-log[1] for details.24782479log.decorate::2480 Print out the ref names of any commits that are shown by the log2481 command. If 'short' is specified, the ref name prefixes 'refs/heads/',2482 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is2483 specified, the full ref name (including prefix) will be printed.2484 If 'auto' is specified, then if the output is going to a terminal,2485 the ref names are shown as if 'short' were given, otherwise no ref2486 names are shown. This is the same as the `--decorate` option2487 of the `git log`.24882489log.follow::2490 If `true`, `git log` will act as if the `--follow` option was used when2491 a single <path> is given. This has the same limitations as `--follow`,2492 i.e. it cannot be used to follow multiple files and does not work well2493 on non-linear history.24942495log.graphColors::2496 A list of colors, separated by commas, that can be used to draw2497 history lines in `git log --graph`.24982499log.showRoot::2500 If true, the initial commit will be shown as a big creation event.2501 This is equivalent to a diff against an empty tree.2502 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which2503 normally hide the root commit will now show it. True by default.25042505log.showSignature::2506 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2507 linkgit:git-whatchanged[1] assume `--show-signature`.25082509log.mailmap::2510 If true, makes linkgit:git-log[1], linkgit:git-show[1], and2511 linkgit:git-whatchanged[1] assume `--use-mailmap`.25122513mailinfo.scissors::2514 If true, makes linkgit:git-mailinfo[1] (and therefore2515 linkgit:git-am[1]) act by default as if the --scissors option2516 was provided on the command-line. When active, this features2517 removes everything from the message body before a scissors2518 line (i.e. consisting mainly of ">8", "8<" and "-").25192520mailmap.file::2521 The location of an augmenting mailmap file. The default2522 mailmap, located in the root of the repository, is loaded2523 first, then the mailmap file pointed to by this variable.2524 The location of the mailmap file may be in a repository2525 subdirectory, or somewhere outside of the repository itself.2526 See linkgit:git-shortlog[1] and linkgit:git-blame[1].25272528mailmap.blob::2529 Like `mailmap.file`, but consider the value as a reference to a2530 blob in the repository. If both `mailmap.file` and2531 `mailmap.blob` are given, both are parsed, with entries from2532 `mailmap.file` taking precedence. In a bare repository, this2533 defaults to `HEAD:.mailmap`. In a non-bare repository, it2534 defaults to empty.25352536man.viewer::2537 Specify the programs that may be used to display help in the2538 'man' format. See linkgit:git-help[1].25392540man.<tool>.cmd::2541 Specify the command to invoke the specified man viewer. The2542 specified command is evaluated in shell with the man page2543 passed as argument. (See linkgit:git-help[1].)25442545man.<tool>.path::2546 Override the path for the given tool that may be used to2547 display help in the 'man' format. See linkgit:git-help[1].25482549include::merge-config.txt[]25502551mergetool.<tool>.path::2552 Override the path for the given tool. This is useful in case2553 your tool is not in the PATH.25542555mergetool.<tool>.cmd::2556 Specify the command to invoke the specified merge tool. The2557 specified command is evaluated in shell with the following2558 variables available: 'BASE' is the name of a temporary file2559 containing the common base of the files to be merged, if available;2560 'LOCAL' is the name of a temporary file containing the contents of2561 the file on the current branch; 'REMOTE' is the name of a temporary2562 file containing the contents of the file from the branch being2563 merged; 'MERGED' contains the name of the file to which the merge2564 tool should write the results of a successful merge.25652566mergetool.<tool>.trustExitCode::2567 For a custom merge command, specify whether the exit code of2568 the merge command can be used to determine whether the merge was2569 successful. If this is not set to true then the merge target file2570 timestamp is checked and the merge assumed to have been successful2571 if the file has been updated, otherwise the user is prompted to2572 indicate the success of the merge.25732574mergetool.meld.hasOutput::2575 Older versions of `meld` do not support the `--output` option.2576 Git will attempt to detect whether `meld` supports `--output`2577 by inspecting the output of `meld --help`. Configuring2578 `mergetool.meld.hasOutput` will make Git skip these checks and2579 use the configured value instead. Setting `mergetool.meld.hasOutput`2580 to `true` tells Git to unconditionally use the `--output` option,2581 and `false` avoids using `--output`.25822583mergetool.keepBackup::2584 After performing a merge, the original file with conflict markers2585 can be saved as a file with a `.orig` extension. If this variable2586 is set to `false` then this file is not preserved. Defaults to2587 `true` (i.e. keep the backup files).25882589mergetool.keepTemporaries::2590 When invoking a custom merge tool, Git uses a set of temporary2591 files to pass to the tool. If the tool returns an error and this2592 variable is set to `true`, then these temporary files will be2593 preserved, otherwise they will be removed after the tool has2594 exited. Defaults to `false`.25952596mergetool.writeToTemp::2597 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2598 conflicting files in the worktree by default. Git will attempt2599 to use a temporary directory for these files when set `true`.2600 Defaults to `false`.26012602mergetool.prompt::2603 Prompt before each invocation of the merge resolution program.26042605notes.mergeStrategy::2606 Which merge strategy to choose by default when resolving notes2607 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2608 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2609 section of linkgit:git-notes[1] for more information on each strategy.26102611notes.<name>.mergeStrategy::2612 Which merge strategy to choose when doing a notes merge into2613 refs/notes/<name>. This overrides the more general2614 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2615 linkgit:git-notes[1] for more information on the available strategies.26162617notes.displayRef::2618 The (fully qualified) refname from which to show notes when2619 showing commit messages. The value of this variable can be set2620 to a glob, in which case notes from all matching refs will be2621 shown. You may also specify this configuration variable2622 several times. A warning will be issued for refs that do not2623 exist, but a glob that does not match any refs is silently2624 ignored.2625+2626This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2627environment variable, which must be a colon separated list of refs or2628globs.2629+2630The effective value of "core.notesRef" (possibly overridden by2631GIT_NOTES_REF) is also implicitly added to the list of refs to be2632displayed.26332634notes.rewrite.<command>::2635 When rewriting commits with <command> (currently `amend` or2636 `rebase`) and this variable is set to `true`, Git2637 automatically copies your notes from the original to the2638 rewritten commit. Defaults to `true`, but see2639 "notes.rewriteRef" below.26402641notes.rewriteMode::2642 When copying notes during a rewrite (see the2643 "notes.rewrite.<command>" option), determines what to do if2644 the target commit already has a note. Must be one of2645 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2646 Defaults to `concatenate`.2647+2648This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2649environment variable.26502651notes.rewriteRef::2652 When copying notes during a rewrite, specifies the (fully2653 qualified) ref whose notes should be copied. The ref may be a2654 glob, in which case notes in all matching refs will be copied.2655 You may also specify this configuration several times.2656+2657Does not have a default value; you must configure this variable to2658enable note rewriting. Set it to `refs/notes/commits` to enable2659rewriting for the default commit notes.2660+2661This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2662environment variable, which must be a colon separated list of refs or2663globs.26642665pack.window::2666 The size of the window used by linkgit:git-pack-objects[1] when no2667 window size is given on the command line. Defaults to 10.26682669pack.depth::2670 The maximum delta depth used by linkgit:git-pack-objects[1] when no2671 maximum depth is given on the command line. Defaults to 50.2672 Maximum value is 4095.26732674pack.windowMemory::2675 The maximum size of memory that is consumed by each thread2676 in linkgit:git-pack-objects[1] for pack window memory when2677 no limit is given on the command line. The value can be2678 suffixed with "k", "m", or "g". When left unconfigured (or2679 set explicitly to 0), there will be no limit.26802681pack.compression::2682 An integer -1..9, indicating the compression level for objects2683 in a pack file. -1 is the zlib default. 0 means no2684 compression, and 1..9 are various speed/size tradeoffs, 9 being2685 slowest. If not set, defaults to core.compression. If that is2686 not set, defaults to -1, the zlib default, which is "a default2687 compromise between speed and compression (currently equivalent2688 to level 6)."2689+2690Note that changing the compression level will not automatically recompress2691all existing objects. You can force recompression by passing the -F option2692to linkgit:git-repack[1].26932694pack.island::2695 An extended regular expression configuring a set of delta2696 islands. See "DELTA ISLANDS" in linkgit:git-pack-objects[1]2697 for details.26982699pack.islandCore::2700 Specify an island name which gets to have its objects be2701 packed first. This creates a kind of pseudo-pack at the front2702 of one pack, so that the objects from the specified island are2703 hopefully faster to copy into any pack that should be served2704 to a user requesting these objects. In practice this means2705 that the island specified should likely correspond to what is2706 the most commonly cloned in the repo. See also "DELTA ISLANDS"2707 in linkgit:git-pack-objects[1].27082709pack.deltaCacheSize::2710 The maximum memory in bytes used for caching deltas in2711 linkgit:git-pack-objects[1] before writing them out to a pack.2712 This cache is used to speed up the writing object phase by not2713 having to recompute the final delta result once the best match2714 for all objects is found. Repacking large repositories on machines2715 which are tight with memory might be badly impacted by this though,2716 especially if this cache pushes the system into swapping.2717 A value of 0 means no limit. The smallest size of 1 byte may be2718 used to virtually disable this cache. Defaults to 256 MiB.27192720pack.deltaCacheLimit::2721 The maximum size of a delta, that is cached in2722 linkgit:git-pack-objects[1]. This cache is used to speed up the2723 writing object phase by not having to recompute the final delta2724 result once the best match for all objects is found.2725 Defaults to 1000. Maximum value is 65535.27262727pack.threads::2728 Specifies the number of threads to spawn when searching for best2729 delta matches. This requires that linkgit:git-pack-objects[1]2730 be compiled with pthreads otherwise this option is ignored with a2731 warning. This is meant to reduce packing time on multiprocessor2732 machines. The required amount of memory for the delta search window2733 is however multiplied by the number of threads.2734 Specifying 0 will cause Git to auto-detect the number of CPU's2735 and set the number of threads accordingly.27362737pack.indexVersion::2738 Specify the default pack index version. Valid values are 1 for2739 legacy pack index used by Git versions prior to 1.5.2, and 2 for2740 the new pack index with capabilities for packs larger than 4 GB2741 as well as proper protection against the repacking of corrupted2742 packs. Version 2 is the default. Note that version 2 is enforced2743 and this config option ignored whenever the corresponding pack is2744 larger than 2 GB.2745+2746If you have an old Git that does not understand the version 2 `*.idx` file,2747cloning or fetching over a non native protocol (e.g. "http")2748that will copy both `*.pack` file and corresponding `*.idx` file from the2749other side may give you a repository that cannot be accessed with your2750older version of Git. If the `*.pack` file is smaller than 2 GB, however,2751you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2752the `*.idx` file.27532754pack.packSizeLimit::2755 The maximum size of a pack. This setting only affects2756 packing to a file when repacking, i.e. the git:// protocol2757 is unaffected. It can be overridden by the `--max-pack-size`2758 option of linkgit:git-repack[1]. Reaching this limit results2759 in the creation of multiple packfiles; which in turn prevents2760 bitmaps from being created.2761 The minimum size allowed is limited to 1 MiB.2762 The default is unlimited.2763 Common unit suffixes of 'k', 'm', or 'g' are2764 supported.27652766pack.useBitmaps::2767 When true, git will use pack bitmaps (if available) when packing2768 to stdout (e.g., during the server side of a fetch). Defaults to2769 true. You should not generally need to turn this off unless2770 you are debugging pack bitmaps.27712772pack.writeBitmaps (deprecated)::2773 This is a deprecated synonym for `repack.writeBitmaps`.27742775pack.writeBitmapHashCache::2776 When true, git will include a "hash cache" section in the bitmap2777 index (if one is written). This cache can be used to feed git's2778 delta heuristics, potentially leading to better deltas between2779 bitmapped and non-bitmapped objects (e.g., when serving a fetch2780 between an older, bitmapped pack and objects that have been2781 pushed since the last gc). The downside is that it consumes 42782 bytes per object of disk space, and that JGit's bitmap2783 implementation does not understand it, causing it to complain if2784 Git and JGit are used on the same repository. Defaults to false.27852786pager.<cmd>::2787 If the value is boolean, turns on or off pagination of the2788 output of a particular Git subcommand when writing to a tty.2789 Otherwise, turns on pagination for the subcommand using the2790 pager specified by the value of `pager.<cmd>`. If `--paginate`2791 or `--no-pager` is specified on the command line, it takes2792 precedence over this option. To disable pagination for all2793 commands, set `core.pager` or `GIT_PAGER` to `cat`.27942795pretty.<name>::2796 Alias for a --pretty= format string, as specified in2797 linkgit:git-log[1]. Any aliases defined here can be used just2798 as the built-in pretty formats could. For example,2799 running `git config pretty.changelog "format:* %H %s"`2800 would cause the invocation `git log --pretty=changelog`2801 to be equivalent to running `git log "--pretty=format:* %H %s"`.2802 Note that an alias with the same name as a built-in format2803 will be silently ignored.28042805protocol.allow::2806 If set, provide a user defined default policy for all protocols which2807 don't explicitly have a policy (`protocol.<name>.allow`). By default,2808 if unset, known-safe protocols (http, https, git, ssh, file) have a2809 default policy of `always`, known-dangerous protocols (ext) have a2810 default policy of `never`, and all other protocols have a default2811 policy of `user`. Supported policies:2812+2813--28142815* `always` - protocol is always able to be used.28162817* `never` - protocol is never able to be used.28182819* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is2820 either unset or has a value of 1. This policy should be used when you want a2821 protocol to be directly usable by the user but don't want it used by commands which2822 execute clone/fetch/push commands without user input, e.g. recursive2823 submodule initialization.28242825--28262827protocol.<name>.allow::2828 Set a policy to be used by protocol `<name>` with clone/fetch/push2829 commands. See `protocol.allow` above for the available policies.2830+2831The protocol names currently used by git are:2832+2833--2834 - `file`: any local file-based path (including `file://` URLs,2835 or local paths)28362837 - `git`: the anonymous git protocol over a direct TCP2838 connection (or proxy, if configured)28392840 - `ssh`: git over ssh (including `host:path` syntax,2841 `ssh://`, etc).28422843 - `http`: git over http, both "smart http" and "dumb http".2844 Note that this does _not_ include `https`; if you want to configure2845 both, you must do so individually.28462847 - any external helpers are named by their protocol (e.g., use2848 `hg` to allow the `git-remote-hg` helper)2849--28502851protocol.version::2852 Experimental. If set, clients will attempt to communicate with a2853 server using the specified protocol version. If unset, no2854 attempt will be made by the client to communicate using a2855 particular protocol version, this results in protocol version 02856 being used.2857 Supported versions:2858+2859--28602861* `0` - the original wire protocol.28622863* `1` - the original wire protocol with the addition of a version string2864 in the initial response from the server.28652866* `2` - link:technical/protocol-v2.html[wire protocol version 2].28672868--28692870pull.ff::2871 By default, Git does not create an extra merge commit when merging2872 a commit that is a descendant of the current commit. Instead, the2873 tip of the current branch is fast-forwarded. When set to `false`,2874 this variable tells Git to create an extra merge commit in such2875 a case (equivalent to giving the `--no-ff` option from the command2876 line). When set to `only`, only such fast-forward merges are2877 allowed (equivalent to giving the `--ff-only` option from the2878 command line). This setting overrides `merge.ff` when pulling.28792880pull.rebase::2881 When true, rebase branches on top of the fetched branch, instead2882 of merging the default branch from the default remote when "git2883 pull" is run. See "branch.<name>.rebase" for setting this on a2884 per-branch basis.2885+2886When `merges`, pass the `--rebase-merges` option to 'git rebase'2887so that the local merge commits are included in the rebase (see2888linkgit:git-rebase[1] for details).2889+2890When preserve, also pass `--preserve-merges` along to 'git rebase'2891so that locally committed merge commits will not be flattened2892by running 'git pull'.2893+2894When the value is `interactive`, the rebase is run in interactive mode.2895+2896*NOTE*: this is a possibly dangerous operation; do *not* use2897it unless you understand the implications (see linkgit:git-rebase[1]2898for details).28992900pull.octopus::2901 The default merge strategy to use when pulling multiple branches2902 at once.29032904pull.twohead::2905 The default merge strategy to use when pulling a single branch.29062907push.default::2908 Defines the action `git push` should take if no refspec is2909 explicitly given. Different values are well-suited for2910 specific workflows; for instance, in a purely central workflow2911 (i.e. the fetch source is equal to the push destination),2912 `upstream` is probably what you want. Possible values are:2913+2914--29152916* `nothing` - do not push anything (error out) unless a refspec is2917 explicitly given. This is primarily meant for people who want to2918 avoid mistakes by always being explicit.29192920* `current` - push the current branch to update a branch with the same2921 name on the receiving end. Works in both central and non-central2922 workflows.29232924* `upstream` - push the current branch back to the branch whose2925 changes are usually integrated into the current branch (which is2926 called `@{upstream}`). This mode only makes sense if you are2927 pushing to the same repository you would normally pull from2928 (i.e. central workflow).29292930* `tracking` - This is a deprecated synonym for `upstream`.29312932* `simple` - in centralized workflow, work like `upstream` with an2933 added safety to refuse to push if the upstream branch's name is2934 different from the local one.2935+2936When pushing to a remote that is different from the remote you normally2937pull from, work as `current`. This is the safest option and is suited2938for beginners.2939+2940This mode has become the default in Git 2.0.29412942* `matching` - push all branches having the same name on both ends.2943 This makes the repository you are pushing to remember the set of2944 branches that will be pushed out (e.g. if you always push 'maint'2945 and 'master' there and no other branches, the repository you push2946 to will have these two branches, and your local 'maint' and2947 'master' will be pushed there).2948+2949To use this mode effectively, you have to make sure _all_ the2950branches you would push out are ready to be pushed out before2951running 'git push', as the whole point of this mode is to allow you2952to push all of the branches in one go. If you usually finish work2953on only one branch and push out the result, while other branches are2954unfinished, this mode is not for you. Also this mode is not2955suitable for pushing into a shared central repository, as other2956people may add new branches there, or update the tip of existing2957branches outside your control.2958+2959This used to be the default, but not since Git 2.0 (`simple` is the2960new default).29612962--29632964push.followTags::2965 If set to true enable `--follow-tags` option by default. You2966 may override this configuration at time of push by specifying2967 `--no-follow-tags`.29682969push.gpgSign::2970 May be set to a boolean value, or the string 'if-asked'. A true2971 value causes all pushes to be GPG signed, as if `--signed` is2972 passed to linkgit:git-push[1]. The string 'if-asked' causes2973 pushes to be signed if the server supports it, as if2974 `--signed=if-asked` is passed to 'git push'. A false value may2975 override a value from a lower-priority config file. An explicit2976 command-line flag always overrides this config option.29772978push.pushOption::2979 When no `--push-option=<option>` argument is given from the2980 command line, `git push` behaves as if each <value> of2981 this variable is given as `--push-option=<value>`.2982+2983This is a multi-valued variable, and an empty value can be used in a2984higher priority configuration file (e.g. `.git/config` in a2985repository) to clear the values inherited from a lower priority2986configuration files (e.g. `$HOME/.gitconfig`).2987+2988--29892990Example:29912992/etc/gitconfig2993 push.pushoption = a2994 push.pushoption = b29952996~/.gitconfig2997 push.pushoption = c29982999repo/.git/config3000 push.pushoption =3001 push.pushoption = b30023003This will result in only b (a and c are cleared).30043005--30063007push.recurseSubmodules::3008 Make sure all submodule commits used by the revisions to be pushed3009 are available on a remote-tracking branch. If the value is 'check'3010 then Git will verify that all submodule commits that changed in the3011 revisions to be pushed are available on at least one remote of the3012 submodule. If any commits are missing, the push will be aborted and3013 exit with non-zero status. If the value is 'on-demand' then all3014 submodules that changed in the revisions to be pushed will be3015 pushed. If on-demand was not able to push all necessary revisions3016 it will also be aborted and exit with non-zero status. If the value3017 is 'no' then default behavior of ignoring submodules when pushing3018 is retained. You may override this configuration at time of push by3019 specifying '--recurse-submodules=check|on-demand|no'.30203021include::rebase-config.txt[]30223023receive.advertiseAtomic::3024 By default, git-receive-pack will advertise the atomic push3025 capability to its clients. If you don't want to advertise this3026 capability, set this variable to false.30273028receive.advertisePushOptions::3029 When set to true, git-receive-pack will advertise the push options3030 capability to its clients. False by default.30313032receive.autogc::3033 By default, git-receive-pack will run "git-gc --auto" after3034 receiving data from git-push and updating refs. You can stop3035 it by setting this variable to false.30363037receive.certNonceSeed::3038 By setting this variable to a string, `git receive-pack`3039 will accept a `git push --signed` and verifies it by using3040 a "nonce" protected by HMAC using this string as a secret3041 key.30423043receive.certNonceSlop::3044 When a `git push --signed` sent a push certificate with a3045 "nonce" that was issued by a receive-pack serving the same3046 repository within this many seconds, export the "nonce"3047 found in the certificate to `GIT_PUSH_CERT_NONCE` to the3048 hooks (instead of what the receive-pack asked the sending3049 side to include). This may allow writing checks in3050 `pre-receive` and `post-receive` a bit easier. Instead of3051 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable3052 that records by how many seconds the nonce is stale to3053 decide if they want to accept the certificate, they only3054 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.30553056receive.fsckObjects::3057 If it is set to true, git-receive-pack will check all received3058 objects. See `transfer.fsckObjects` for what's checked.3059 Defaults to false. If not set, the value of3060 `transfer.fsckObjects` is used instead.30613062receive.fsck.<msg-id>::3063 Acts like `fsck.<msg-id>`, but is used by3064 linkgit:git-receive-pack[1] instead of3065 linkgit:git-fsck[1]. See the `fsck.<msg-id>` documentation for3066 details.30673068receive.fsck.skipList::3069 Acts like `fsck.skipList`, but is used by3070 linkgit:git-receive-pack[1] instead of3071 linkgit:git-fsck[1]. See the `fsck.skipList` documentation for3072 details.30733074receive.keepAlive::3075 After receiving the pack from the client, `receive-pack` may3076 produce no output (if `--quiet` was specified) while processing3077 the pack, causing some networks to drop the TCP connection.3078 With this option set, if `receive-pack` does not transmit3079 any data in this phase for `receive.keepAlive` seconds, it will3080 send a short keepalive packet. The default is 5 seconds; set3081 to 0 to disable keepalives entirely.30823083receive.unpackLimit::3084 If the number of objects received in a push is below this3085 limit then the objects will be unpacked into loose object3086 files. However if the number of received objects equals or3087 exceeds this limit then the received pack will be stored as3088 a pack, after adding any missing delta bases. Storing the3089 pack from a push can make the push operation complete faster,3090 especially on slow filesystems. If not set, the value of3091 `transfer.unpackLimit` is used instead.30923093receive.maxInputSize::3094 If the size of the incoming pack stream is larger than this3095 limit, then git-receive-pack will error out, instead of3096 accepting the pack file. If not set or set to 0, then the size3097 is unlimited.30983099receive.denyDeletes::3100 If set to true, git-receive-pack will deny a ref update that deletes3101 the ref. Use this to prevent such a ref deletion via a push.31023103receive.denyDeleteCurrent::3104 If set to true, git-receive-pack will deny a ref update that3105 deletes the currently checked out branch of a non-bare repository.31063107receive.denyCurrentBranch::3108 If set to true or "refuse", git-receive-pack will deny a ref update3109 to the currently checked out branch of a non-bare repository.3110 Such a push is potentially dangerous because it brings the HEAD3111 out of sync with the index and working tree. If set to "warn",3112 print a warning of such a push to stderr, but allow the push to3113 proceed. If set to false or "ignore", allow such pushes with no3114 message. Defaults to "refuse".3115+3116Another option is "updateInstead" which will update the working3117tree if pushing into the current branch. This option is3118intended for synchronizing working directories when one side is not easily3119accessible via interactive ssh (e.g. a live web site, hence the requirement3120that the working directory be clean). This mode also comes in handy when3121developing inside a VM to test and fix code on different Operating Systems.3122+3123By default, "updateInstead" will refuse the push if the working tree or3124the index have any difference from the HEAD, but the `push-to-checkout`3125hook can be used to customize this. See linkgit:githooks[5].31263127receive.denyNonFastForwards::3128 If set to true, git-receive-pack will deny a ref update which is3129 not a fast-forward. Use this to prevent such an update via a push,3130 even if that push is forced. This configuration variable is3131 set when initializing a shared repository.31323133receive.hideRefs::3134 This variable is the same as `transfer.hideRefs`, but applies3135 only to `receive-pack` (and so affects pushes, but not fetches).3136 An attempt to update or delete a hidden ref by `git push` is3137 rejected.31383139receive.updateServerInfo::3140 If set to true, git-receive-pack will run git-update-server-info3141 after receiving data from git-push and updating refs.31423143receive.shallowUpdate::3144 If set to true, .git/shallow can be updated when new refs3145 require new shallow roots. Otherwise those refs are rejected.31463147remote.pushDefault::3148 The remote to push to by default. Overrides3149 `branch.<name>.remote` for all branches, and is overridden by3150 `branch.<name>.pushRemote` for specific branches.31513152remote.<name>.url::3153 The URL of a remote repository. See linkgit:git-fetch[1] or3154 linkgit:git-push[1].31553156remote.<name>.pushurl::3157 The push URL of a remote repository. See linkgit:git-push[1].31583159remote.<name>.proxy::3160 For remotes that require curl (http, https and ftp), the URL to3161 the proxy to use for that remote. Set to the empty string to3162 disable proxying for that remote.31633164remote.<name>.proxyAuthMethod::3165 For remotes that require curl (http, https and ftp), the method to use for3166 authenticating against the proxy in use (probably set in3167 `remote.<name>.proxy`). See `http.proxyAuthMethod`.31683169remote.<name>.fetch::3170 The default set of "refspec" for linkgit:git-fetch[1]. See3171 linkgit:git-fetch[1].31723173remote.<name>.push::3174 The default set of "refspec" for linkgit:git-push[1]. See3175 linkgit:git-push[1].31763177remote.<name>.mirror::3178 If true, pushing to this remote will automatically behave3179 as if the `--mirror` option was given on the command line.31803181remote.<name>.skipDefaultUpdate::3182 If true, this remote will be skipped by default when updating3183 using linkgit:git-fetch[1] or the `update` subcommand of3184 linkgit:git-remote[1].31853186remote.<name>.skipFetchAll::3187 If true, this remote will be skipped by default when updating3188 using linkgit:git-fetch[1] or the `update` subcommand of3189 linkgit:git-remote[1].31903191remote.<name>.receivepack::3192 The default program to execute on the remote side when pushing. See3193 option --receive-pack of linkgit:git-push[1].31943195remote.<name>.uploadpack::3196 The default program to execute on the remote side when fetching. See3197 option --upload-pack of linkgit:git-fetch-pack[1].31983199remote.<name>.tagOpt::3200 Setting this value to --no-tags disables automatic tag following when3201 fetching from remote <name>. Setting it to --tags will fetch every3202 tag from remote <name>, even if they are not reachable from remote3203 branch heads. Passing these flags directly to linkgit:git-fetch[1] can3204 override this setting. See options --tags and --no-tags of3205 linkgit:git-fetch[1].32063207remote.<name>.vcs::3208 Setting this to a value <vcs> will cause Git to interact with3209 the remote with the git-remote-<vcs> helper.32103211remote.<name>.prune::3212 When set to true, fetching from this remote by default will also3213 remove any remote-tracking references that no longer exist on the3214 remote (as if the `--prune` option was given on the command line).3215 Overrides `fetch.prune` settings, if any.32163217remote.<name>.pruneTags::3218 When set to true, fetching from this remote by default will also3219 remove any local tags that no longer exist on the remote if pruning3220 is activated in general via `remote.<name>.prune`, `fetch.prune` or3221 `--prune`. Overrides `fetch.pruneTags` settings, if any.3222+3223See also `remote.<name>.prune` and the PRUNING section of3224linkgit:git-fetch[1].32253226remotes.<group>::3227 The list of remotes which are fetched by "git remote update3228 <group>". See linkgit:git-remote[1].32293230repack.useDeltaBaseOffset::3231 By default, linkgit:git-repack[1] creates packs that use3232 delta-base offset. If you need to share your repository with3233 Git older than version 1.4.4, either directly or via a dumb3234 protocol such as http, then you need to set this option to3235 "false" and repack. Access from old Git versions over the3236 native protocol are unaffected by this option.32373238repack.packKeptObjects::3239 If set to true, makes `git repack` act as if3240 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for3241 details. Defaults to `false` normally, but `true` if a bitmap3242 index is being written (either via `--write-bitmap-index` or3243 `repack.writeBitmaps`).32443245repack.useDeltaIslands::3246 If set to true, makes `git repack` act as if `--delta-islands`3247 was passed. Defaults to `false`.32483249repack.writeBitmaps::3250 When true, git will write a bitmap index when packing all3251 objects to disk (e.g., when `git repack -a` is run). This3252 index can speed up the "counting objects" phase of subsequent3253 packs created for clones and fetches, at the cost of some disk3254 space and extra time spent on the initial repack. This has3255 no effect if multiple packfiles are created.3256 Defaults to false.32573258rerere.autoUpdate::3259 When set to true, `git-rerere` updates the index with the3260 resulting contents after it cleanly resolves conflicts using3261 previously recorded resolution. Defaults to false.32623263rerere.enabled::3264 Activate recording of resolved conflicts, so that identical3265 conflict hunks can be resolved automatically, should they be3266 encountered again. By default, linkgit:git-rerere[1] is3267 enabled if there is an `rr-cache` directory under the3268 `$GIT_DIR`, e.g. if "rerere" was previously used in the3269 repository.32703271sendemail.identity::3272 A configuration identity. When given, causes values in the3273 'sendemail.<identity>' subsection to take precedence over3274 values in the 'sendemail' section. The default identity is3275 the value of `sendemail.identity`.32763277sendemail.smtpEncryption::3278 See linkgit:git-send-email[1] for description. Note that this3279 setting is not subject to the 'identity' mechanism.32803281sendemail.smtpssl (deprecated)::3282 Deprecated alias for 'sendemail.smtpEncryption = ssl'.32833284sendemail.smtpsslcertpath::3285 Path to ca-certificates (either a directory or a single file).3286 Set it to an empty string to disable certificate verification.32873288sendemail.<identity>.*::3289 Identity-specific versions of the 'sendemail.*' parameters3290 found below, taking precedence over those when this3291 identity is selected, through either the command-line or3292 `sendemail.identity`.32933294sendemail.aliasesFile::3295sendemail.aliasFileType::3296sendemail.annotate::3297sendemail.bcc::3298sendemail.cc::3299sendemail.ccCmd::3300sendemail.chainReplyTo::3301sendemail.confirm::3302sendemail.envelopeSender::3303sendemail.from::3304sendemail.multiEdit::3305sendemail.signedoffbycc::3306sendemail.smtpPass::3307sendemail.suppresscc::3308sendemail.suppressFrom::3309sendemail.to::3310sendemail.tocmd::3311sendemail.smtpDomain::3312sendemail.smtpServer::3313sendemail.smtpServerPort::3314sendemail.smtpServerOption::3315sendemail.smtpUser::3316sendemail.thread::3317sendemail.transferEncoding::3318sendemail.validate::3319sendemail.xmailer::3320 See linkgit:git-send-email[1] for description.33213322sendemail.signedoffcc (deprecated)::3323 Deprecated alias for `sendemail.signedoffbycc`.33243325sendemail.smtpBatchSize::3326 Number of messages to be sent per connection, after that a relogin3327 will happen. If the value is 0 or undefined, send all messages in3328 one connection.3329 See also the `--batch-size` option of linkgit:git-send-email[1].33303331sendemail.smtpReloginDelay::3332 Seconds wait before reconnecting to smtp server.3333 See also the `--relogin-delay` option of linkgit:git-send-email[1].33343335showbranch.default::3336 The default set of branches for linkgit:git-show-branch[1].3337 See linkgit:git-show-branch[1].33383339splitIndex.maxPercentChange::3340 When the split index feature is used, this specifies the3341 percent of entries the split index can contain compared to the3342 total number of entries in both the split index and the shared3343 index before a new shared index is written.3344 The value should be between 0 and 100. If the value is 0 then3345 a new shared index is always written, if it is 100 a new3346 shared index is never written.3347 By default the value is 20, so a new shared index is written3348 if the number of entries in the split index would be greater3349 than 20 percent of the total number of entries.3350 See linkgit:git-update-index[1].33513352splitIndex.sharedIndexExpire::3353 When the split index feature is used, shared index files that3354 were not modified since the time this variable specifies will3355 be removed when a new shared index file is created. The value3356 "now" expires all entries immediately, and "never" suppresses3357 expiration altogether.3358 The default value is "2.weeks.ago".3359 Note that a shared index file is considered modified (for the3360 purpose of expiration) each time a new split-index file is3361 either created based on it or read from it.3362 See linkgit:git-update-index[1].33633364status.relativePaths::3365 By default, linkgit:git-status[1] shows paths relative to the3366 current directory. Setting this variable to `false` shows paths3367 relative to the repository root (this was the default for Git3368 prior to v1.5.4).33693370status.short::3371 Set to true to enable --short by default in linkgit:git-status[1].3372 The option --no-short takes precedence over this variable.33733374status.branch::3375 Set to true to enable --branch by default in linkgit:git-status[1].3376 The option --no-branch takes precedence over this variable.33773378status.displayCommentPrefix::3379 If set to true, linkgit:git-status[1] will insert a comment3380 prefix before each output line (starting with3381 `core.commentChar`, i.e. `#` by default). This was the3382 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.3383 Defaults to false.33843385status.renameLimit::3386 The number of files to consider when performing rename detection3387 in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to3388 the value of diff.renameLimit.33893390status.renames::3391 Whether and how Git detects renames in linkgit:git-status[1] and3392 linkgit:git-commit[1] . If set to "false", rename detection is3393 disabled. If set to "true", basic rename detection is enabled.3394 If set to "copies" or "copy", Git will detect copies, as well.3395 Defaults to the value of diff.renames.33963397status.showStash::3398 If set to true, linkgit:git-status[1] will display the number of3399 entries currently stashed away.3400 Defaults to false.34013402status.showUntrackedFiles::3403 By default, linkgit:git-status[1] and linkgit:git-commit[1] show3404 files which are not currently tracked by Git. Directories which3405 contain only untracked files, are shown with the directory name3406 only. Showing untracked files means that Git needs to lstat() all3407 the files in the whole repository, which might be slow on some3408 systems. So, this variable controls how the commands displays3409 the untracked files. Possible values are:3410+3411--3412* `no` - Show no untracked files.3413* `normal` - Show untracked files and directories.3414* `all` - Show also individual files in untracked directories.3415--3416+3417If this variable is not specified, it defaults to 'normal'.3418This variable can be overridden with the -u|--untracked-files option3419of linkgit:git-status[1] and linkgit:git-commit[1].34203421status.submoduleSummary::3422 Defaults to false.3423 If this is set to a non zero number or true (identical to -1 or an3424 unlimited number), the submodule summary will be enabled and a3425 summary of commits for modified submodules will be shown (see3426 --summary-limit option of linkgit:git-submodule[1]). Please note3427 that the summary output command will be suppressed for all3428 submodules when `diff.ignoreSubmodules` is set to 'all' or only3429 for those submodules where `submodule.<name>.ignore=all`. The only3430 exception to that rule is that status and commit will show staged3431 submodule changes. To3432 also view the summary for ignored submodules you can either use3433 the --ignore-submodules=dirty command-line option or the 'git3434 submodule summary' command, which shows a similar output but does3435 not honor these settings.34363437stash.showPatch::3438 If this is set to true, the `git stash show` command without an3439 option will show the stash entry in patch form. Defaults to false.3440 See description of 'show' command in linkgit:git-stash[1].34413442stash.showStat::3443 If this is set to true, the `git stash show` command without an3444 option will show diffstat of the stash entry. Defaults to true.3445 See description of 'show' command in linkgit:git-stash[1].34463447submodule.<name>.url::3448 The URL for a submodule. This variable is copied from the .gitmodules3449 file to the git config via 'git submodule init'. The user can change3450 the configured URL before obtaining the submodule via 'git submodule3451 update'. If neither submodule.<name>.active or submodule.active are3452 set, the presence of this variable is used as a fallback to indicate3453 whether the submodule is of interest to git commands.3454 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.34553456submodule.<name>.update::3457 The method by which a submodule is updated by 'git submodule update',3458 which is the only affected command, others such as3459 'git checkout --recurse-submodules' are unaffected. It exists for3460 historical reasons, when 'git submodule' was the only command to3461 interact with submodules; settings like `submodule.active`3462 and `pull.rebase` are more specific. It is populated by3463 `git submodule init` from the linkgit:gitmodules[5] file.3464 See description of 'update' command in linkgit:git-submodule[1].34653466submodule.<name>.branch::3467 The remote branch name for a submodule, used by `git submodule3468 update --remote`. Set this option to override the value found in3469 the `.gitmodules` file. See linkgit:git-submodule[1] and3470 linkgit:gitmodules[5] for details.34713472submodule.<name>.fetchRecurseSubmodules::3473 This option can be used to control recursive fetching of this3474 submodule. It can be overridden by using the --[no-]recurse-submodules3475 command-line option to "git fetch" and "git pull".3476 This setting will override that from in the linkgit:gitmodules[5]3477 file.34783479submodule.<name>.ignore::3480 Defines under what circumstances "git status" and the diff family show3481 a submodule as modified. When set to "all", it will never be considered3482 modified (but it will nonetheless show up in the output of status and3483 commit when it has been staged), "dirty" will ignore all changes3484 to the submodules work tree and3485 takes only differences between the HEAD of the submodule and the commit3486 recorded in the superproject into account. "untracked" will additionally3487 let submodules with modified tracked files in their work tree show up.3488 Using "none" (the default when this option is not set) also shows3489 submodules that have untracked files in their work tree as changed.3490 This setting overrides any setting made in .gitmodules for this submodule,3491 both settings can be overridden on the command line by using the3492 "--ignore-submodules" option. The 'git submodule' commands are not3493 affected by this setting.34943495submodule.<name>.active::3496 Boolean value indicating if the submodule is of interest to git3497 commands. This config option takes precedence over the3498 submodule.active config option. See linkgit:gitsubmodules[7] for3499 details.35003501submodule.active::3502 A repeated field which contains a pathspec used to match against a3503 submodule's path to determine if the submodule is of interest to git3504 commands. See linkgit:gitsubmodules[7] for details.35053506submodule.recurse::3507 Specifies if commands recurse into submodules by default. This3508 applies to all commands that have a `--recurse-submodules` option,3509 except `clone`.3510 Defaults to false.35113512submodule.fetchJobs::3513 Specifies how many submodules are fetched/cloned at the same time.3514 A positive integer allows up to that number of submodules fetched3515 in parallel. A value of 0 will give some reasonable default.3516 If unset, it defaults to 1.35173518submodule.alternateLocation::3519 Specifies how the submodules obtain alternates when submodules are3520 cloned. Possible values are `no`, `superproject`.3521 By default `no` is assumed, which doesn't add references. When the3522 value is set to `superproject` the submodule to be cloned computes3523 its alternates location relative to the superprojects alternate.35243525submodule.alternateErrorStrategy::3526 Specifies how to treat errors with the alternates for a submodule3527 as computed via `submodule.alternateLocation`. Possible values are3528 `ignore`, `info`, `die`. Default is `die`.35293530tag.forceSignAnnotated::3531 A boolean to specify whether annotated tags created should be GPG signed.3532 If `--annotate` is specified on the command line, it takes3533 precedence over this option.35343535tag.sort::3536 This variable controls the sort ordering of tags when displayed by3537 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the3538 value of this variable will be used as the default.35393540tar.umask::3541 This variable can be used to restrict the permission bits of3542 tar archive entries. The default is 0002, which turns off the3543 world write bit. The special value "user" indicates that the3544 archiving user's umask will be used instead. See umask(2) and3545 linkgit:git-archive[1].35463547transfer.fsckObjects::3548 When `fetch.fsckObjects` or `receive.fsckObjects` are3549 not set, the value of this variable is used instead.3550 Defaults to false.3551+3552When set, the fetch or receive will abort in the case of a malformed3553object or a link to a nonexistent object. In addition, various other3554issues are checked for, including legacy issues (see `fsck.<msg-id>`),3555and potential security issues like the existence of a `.GIT` directory3556or a malicious `.gitmodules` file (see the release notes for v2.2.13557and v2.17.1 for details). Other sanity and security checks may be3558added in future releases.3559+3560On the receiving side, failing fsckObjects will make those objects3561unreachable, see "QUARANTINE ENVIRONMENT" in3562linkgit:git-receive-pack[1]. On the fetch side, malformed objects will3563instead be left unreferenced in the repository.3564+3565Due to the non-quarantine nature of the `fetch.fsckObjects`3566implementation it can not be relied upon to leave the object store3567clean like `receive.fsckObjects` can.3568+3569As objects are unpacked they're written to the object store, so there3570can be cases where malicious objects get introduced even though the3571"fetch" failed, only to have a subsequent "fetch" succeed because only3572new incoming objects are checked, not those that have already been3573written to the object store. That difference in behavior should not be3574relied upon. In the future, such objects may be quarantined for3575"fetch" as well.3576+3577For now, the paranoid need to find some way to emulate the quarantine3578environment if they'd like the same protection as "push". E.g. in the3579case of an internal mirror do the mirroring in two steps, one to fetch3580the untrusted objects, and then do a second "push" (which will use the3581quarantine) to another internal repo, and have internal clients3582consume this pushed-to repository, or embargo internal fetches and3583only allow them once a full "fsck" has run (and no new fetches have3584happened in the meantime).35853586transfer.hideRefs::3587 String(s) `receive-pack` and `upload-pack` use to decide which3588 refs to omit from their initial advertisements. Use more than3589 one definition to specify multiple prefix strings. A ref that is3590 under the hierarchies listed in the value of this variable is3591 excluded, and is hidden when responding to `git push` or `git3592 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for3593 program-specific versions of this config.3594+3595You may also include a `!` in front of the ref name to negate the entry,3596explicitly exposing it, even if an earlier entry marked it as hidden.3597If you have multiple hideRefs values, later entries override earlier ones3598(and entries in more-specific config files override less-specific ones).3599+3600If a namespace is in use, the namespace prefix is stripped from each3601reference before it is matched against `transfer.hiderefs` patterns.3602For example, if `refs/heads/master` is specified in `transfer.hideRefs` and3603the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`3604is omitted from the advertisements but `refs/heads/master` and3605`refs/namespaces/bar/refs/heads/master` are still advertised as so-called3606"have" lines. In order to match refs before stripping, add a `^` in front of3607the ref name. If you combine `!` and `^`, `!` must be specified first.3608+3609Even if you hide refs, a client may still be able to steal the target3610objects via the techniques described in the "SECURITY" section of the3611linkgit:gitnamespaces[7] man page; it's best to keep private data in a3612separate repository.36133614transfer.unpackLimit::3615 When `fetch.unpackLimit` or `receive.unpackLimit` are3616 not set, the value of this variable is used instead.3617 The default value is 100.36183619uploadarchive.allowUnreachable::3620 If true, allow clients to use `git archive --remote` to request3621 any tree, whether reachable from the ref tips or not. See the3622 discussion in the "SECURITY" section of3623 linkgit:git-upload-archive[1] for more details. Defaults to3624 `false`.36253626uploadpack.hideRefs::3627 This variable is the same as `transfer.hideRefs`, but applies3628 only to `upload-pack` (and so affects only fetches, not pushes).3629 An attempt to fetch a hidden ref by `git fetch` will fail. See3630 also `uploadpack.allowTipSHA1InWant`.36313632uploadpack.allowTipSHA1InWant::3633 When `uploadpack.hideRefs` is in effect, allow `upload-pack`3634 to accept a fetch request that asks for an object at the tip3635 of a hidden ref (by default, such a request is rejected).3636 See also `uploadpack.hideRefs`. Even if this is false, a client3637 may be able to steal objects via the techniques described in the3638 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's3639 best to keep private data in a separate repository.36403641uploadpack.allowReachableSHA1InWant::3642 Allow `upload-pack` to accept a fetch request that asks for an3643 object that is reachable from any ref tip. However, note that3644 calculating object reachability is computationally expensive.3645 Defaults to `false`. Even if this is false, a client may be able3646 to steal objects via the techniques described in the "SECURITY"3647 section of the linkgit:gitnamespaces[7] man page; it's best to3648 keep private data in a separate repository.36493650uploadpack.allowAnySHA1InWant::3651 Allow `upload-pack` to accept a fetch request that asks for any3652 object at all.3653 Defaults to `false`.36543655uploadpack.keepAlive::3656 When `upload-pack` has started `pack-objects`, there may be a3657 quiet period while `pack-objects` prepares the pack. Normally3658 it would output progress information, but if `--quiet` was used3659 for the fetch, `pack-objects` will output nothing at all until3660 the pack data begins. Some clients and networks may consider3661 the server to be hung and give up. Setting this option instructs3662 `upload-pack` to send an empty keepalive packet every3663 `uploadpack.keepAlive` seconds. Setting this option to 03664 disables keepalive packets entirely. The default is 5 seconds.36653666uploadpack.packObjectsHook::3667 If this option is set, when `upload-pack` would run3668 `git pack-objects` to create a packfile for a client, it will3669 run this shell command instead. The `pack-objects` command and3670 arguments it _would_ have run (including the `git pack-objects`3671 at the beginning) are appended to the shell command. The stdin3672 and stdout of the hook are treated as if `pack-objects` itself3673 was run. I.e., `upload-pack` will feed input intended for3674 `pack-objects` to the hook, and expects a completed packfile on3675 stdout.36763677uploadpack.allowFilter::3678 If this option is set, `upload-pack` will support partial3679 clone and partial fetch object filtering.3680+3681Note that this configuration variable is ignored if it is seen in the3682repository-level config (this is a safety measure against fetching from3683untrusted repositories).36843685uploadpack.allowRefInWant::3686 If this option is set, `upload-pack` will support the `ref-in-want`3687 feature of the protocol version 2 `fetch` command. This feature3688 is intended for the benefit of load-balanced servers which may3689 not have the same view of what OIDs their refs point to due to3690 replication delay.36913692url.<base>.insteadOf::3693 Any URL that starts with this value will be rewritten to3694 start, instead, with <base>. In cases where some site serves a3695 large number of repositories, and serves them with multiple3696 access methods, and some users need to use different access3697 methods, this feature allows people to specify any of the3698 equivalent URLs and have Git automatically rewrite the URL to3699 the best alternative for the particular user, even for a3700 never-before-seen repository on the site. When more than one3701 insteadOf strings match a given URL, the longest match is used.3702+3703Note that any protocol restrictions will be applied to the rewritten3704URL. If the rewrite changes the URL to use a custom protocol or remote3705helper, you may need to adjust the `protocol.*.allow` config to permit3706the request. In particular, protocols you expect to use for submodules3707must be set to `always` rather than the default of `user`. See the3708description of `protocol.allow` above.37093710url.<base>.pushInsteadOf::3711 Any URL that starts with this value will not be pushed to;3712 instead, it will be rewritten to start with <base>, and the3713 resulting URL will be pushed to. In cases where some site serves3714 a large number of repositories, and serves them with multiple3715 access methods, some of which do not allow push, this feature3716 allows people to specify a pull-only URL and have Git3717 automatically use an appropriate URL to push, even for a3718 never-before-seen repository on the site. When more than one3719 pushInsteadOf strings match a given URL, the longest match is3720 used. If a remote has an explicit pushurl, Git will ignore this3721 setting for that remote.37223723user.email::3724 Your email address to be recorded in any newly created commits.3725 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and3726 `EMAIL` environment variables. See linkgit:git-commit-tree[1].37273728user.name::3729 Your full name to be recorded in any newly created commits.3730 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`3731 environment variables. See linkgit:git-commit-tree[1].37323733user.useConfigOnly::3734 Instruct Git to avoid trying to guess defaults for `user.email`3735 and `user.name`, and instead retrieve the values only from the3736 configuration. For example, if you have multiple email addresses3737 and would like to use a different one for each repository, then3738 with this configuration option set to `true` in the global config3739 along with a name, Git will prompt you to set up an email before3740 making new commits in a newly cloned repository.3741 Defaults to `false`.37423743user.signingKey::3744 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the3745 key you want it to automatically when creating a signed tag or3746 commit, you can override the default selection with this variable.3747 This option is passed unchanged to gpg's --local-user parameter,3748 so you may specify a key using any method that gpg supports.37493750versionsort.prereleaseSuffix (deprecated)::3751 Deprecated alias for `versionsort.suffix`. Ignored if3752 `versionsort.suffix` is set.37533754versionsort.suffix::3755 Even when version sort is used in linkgit:git-tag[1], tagnames3756 with the same base version but different suffixes are still sorted3757 lexicographically, resulting e.g. in prerelease tags appearing3758 after the main release (e.g. "1.0-rc1" after "1.0"). This3759 variable can be specified to determine the sorting order of tags3760 with different suffixes.3761+3762By specifying a single suffix in this variable, any tagname containing3763that suffix will appear before the corresponding main release. E.g. if3764the variable is set to "-rc", then all "1.0-rcX" tags will appear before3765"1.0". If specified multiple times, once per suffix, then the order of3766suffixes in the configuration will determine the sorting order of tagnames3767with those suffixes. E.g. if "-pre" appears before "-rc" in the3768configuration, then all "1.0-preX" tags will be listed before any3769"1.0-rcX" tags. The placement of the main release tag relative to tags3770with various suffixes can be determined by specifying the empty suffix3771among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and3772"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags3773are listed first, followed by "v4.8", then "v4.8-ckX" and finally3774"v4.8-bfsX".3775+3776If more than one suffixes match the same tagname, then that tagname will3777be sorted according to the suffix which starts at the earliest position in3778the tagname. If more than one different matching suffixes start at3779that earliest position, then that tagname will be sorted according to the3780longest of those suffixes.3781The sorting order between different suffixes is undefined if they are3782in multiple config files.37833784web.browser::3785 Specify a web browser that may be used by some commands.3786 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]3787 may use it.37883789worktree.guessRemote::3790 With `add`, if no branch argument, and neither of `-b` nor3791 `-B` nor `--detach` are given, the command defaults to3792 creating a new branch from HEAD. If `worktree.guessRemote` is3793 set to true, `worktree add` tries to find a remote-tracking3794 branch whose name uniquely matches the new branch name. If3795 such a branch exists, it is checked out and set as "upstream"3796 for the new branch. If no such match can be found, it falls3797 back to creating a new branch from the current HEAD.