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. 18 19Syntax 20~~~~~~ 21 22The syntax is fairly flexible and permissive; whitespaces are mostly 23ignored. The '#' and ';' characters begin comments to the end of line, 24blank lines are ignored. 25 26The file consists of sections and variables. A section begins with 27the name of the section in square brackets and continues until the next 28section begins. Section names are not case sensitive. Only alphanumeric 29characters, `-` and `.` are allowed in section names. Each variable 30must belong to some section, which means that there must be a section 31header before the first setting of a variable. 32 33Sections can be further divided into subsections. To begin a subsection 34put its name in double quotes, separated by space from the section name, 35in the section header, like in the example below: 36 37-------- 38 [section "subsection"] 39 40-------- 41 42Subsection names are case sensitive and can contain any characters except 43newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`, 44respectively). Section headers cannot span multiple 45lines. Variables may belong directly to a section or to a given subsection. 46You can have `[section]` if you have `[section "subsection"]`, but you 47don't need to. 48 49There is also a deprecated `[section.subsection]` syntax. With this 50syntax, the subsection name is converted to lower-case and is also 51compared case sensitively. These subsection names follow the same 52restrictions as section names. 53 54All the other lines (and the remainder of the line after the section 55header) are recognized as setting variables, in the form 56'name = value'. If there is no equal sign on the line, the entire line 57is taken as 'name' and the variable is recognized as boolean "true". 58The variable names are case-insensitive, allow only alphanumeric characters 59and `-`, and must start with an alphabetic character. There can be more 60than one value for a given variable; we say then that the variable is 61multivalued. 62 63Leading and trailing whitespace in a variable value is discarded. 64Internal whitespace within a variable value is retained verbatim. 65 66The values following the equals sign in variable assign are all either 67a string, an integer, or a boolean. Boolean values may be given as yes/no, 681/0, true/false or on/off. Case is not significant in boolean values, when 69converting value to the canonical form using '--bool' type specifier; 70'git config' will ensure that the output is "true" or "false". 71 72String values may be entirely or partially enclosed in double quotes. 73You need to enclose variable values in double quotes if you want to 74preserve leading or trailing whitespace, or if the variable value contains 75comment characters (i.e. it contains '#' or ';'). 76Double quote `"` and backslash `\` characters in variable values must 77be escaped: use `\"` for `"` and `\\` for `\`. 78 79The following escape sequences (beside `\"` and `\\`) are recognized: 80`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) 81and `\b` for backspace (BS). Other char escape sequences (including octal 82escape sequences) are invalid. 83 84Variable values ending in a `\` are continued on the next line in the 85customary UNIX fashion. 86 87Some variables may require a special value format. 88 89Includes 90~~~~~~~~ 91 92You can include one config file from another by setting the special 93`include.path` variable to the name of the file to be included. The 94included file is expanded immediately, as if its contents had been 95found at the location of the include directive. If the value of the 96`include.path` variable is a relative path, the path is considered to be 97relative to the configuration file in which the include directive was 98found. The value of `include.path` is subject to tilde expansion: `~/` 99is expanded to the value of `$HOME`, and `~user/` to the specified 100user's home directory. See below for examples. 101 102Example 103~~~~~~~ 104 105 # Core variables 106 [core] 107 ; Don't trust file modes 108 filemode = false 109 110 # Our diff algorithm 111 [diff] 112 external = /usr/local/bin/diff-wrapper 113 renames = true 114 115 [branch "devel"] 116 remote = origin 117 merge = refs/heads/devel 118 119 # Proxy settings 120 [core] 121 gitProxy="ssh" for "kernel.org" 122 gitProxy=default-proxy ; for the rest 123 124 [include] 125 path = /path/to/foo.inc ; include by absolute path 126 path = foo ; expand "foo" relative to the current file 127 path = ~/foo ; expand "foo" in your $HOME directory 128 129Variables 130~~~~~~~~~ 131 132Note that this list is non-comprehensive and not necessarily complete. 133For command-specific variables, you will find a more detailed description 134in the appropriate manual page. 135 136Other git-related tools may and do use their own variables. When 137inventing new variables for use in your own tool, make sure their 138names do not conflict with those that are used by Git itself and 139other popular tools, and describe them in your documentation. 140 141 142advice.*:: 143 These variables control various optional help messages designed to 144 aid new users. All 'advice.*' variables default to 'true', and you 145 can tell Git that you do not need help by setting these to 'false': 146+ 147-- 148 pushUpdateRejected:: 149 Set this variable to 'false' if you want to disable 150 'pushNonFFCurrent', 151 'pushNonFFMatching', 'pushAlreadyExists', 152 'pushFetchFirst', and 'pushNeedsForce' 153 simultaneously. 154 pushNonFFCurrent:: 155 Advice shown when linkgit:git-push[1] fails due to a 156 non-fast-forward update to the current branch. 157 pushNonFFMatching:: 158 Advice shown when you ran linkgit:git-push[1] and pushed 159 'matching refs' explicitly (i.e. you used ':', or 160 specified a refspec that isn't your current branch) and 161 it resulted in a non-fast-forward error. 162 pushAlreadyExists:: 163 Shown when linkgit:git-push[1] rejects an update that 164 does not qualify for fast-forwarding (e.g., a tag.) 165 pushFetchFirst:: 166 Shown when linkgit:git-push[1] rejects an update that 167 tries to overwrite a remote ref that points at an 168 object we do not have. 169 pushNeedsForce:: 170 Shown when linkgit:git-push[1] rejects an update that 171 tries to overwrite a remote ref that points at an 172 object that is not a commit-ish, or make the remote 173 ref point at an object that is not a commit-ish. 174 statusHints:: 175 Show directions on how to proceed from the current 176 state in the output of linkgit:git-status[1], in 177 the template shown when writing commit messages in 178 linkgit:git-commit[1], and in the help message shown 179 by linkgit:git-checkout[1] when switching branch. 180 statusUoption:: 181 Advise to consider using the `-u` option to linkgit:git-status[1] 182 when the command takes more than 2 seconds to enumerate untracked 183 files. 184 commitBeforeMerge:: 185 Advice shown when linkgit:git-merge[1] refuses to 186 merge to avoid overwriting local changes. 187 resolveConflict:: 188 Advice shown by various commands when conflicts 189 prevent the operation from being performed. 190 implicitIdentity:: 191 Advice on how to set your identity configuration when 192 your information is guessed from the system username and 193 domain name. 194 detachedHead:: 195 Advice shown when you used linkgit:git-checkout[1] to 196 move to the detach HEAD state, to instruct how to create 197 a local branch after the fact. 198 amWorkDir:: 199 Advice that shows the location of the patch file when 200 linkgit:git-am[1] fails to apply it. 201 rmHints:: 202 In case of failure in the output of linkgit:git-rm[1], 203 show directions on how to proceed from the current state. 204-- 205 206core.fileMode:: 207 If false, the executable bit differences between the index and 208 the working tree are ignored; useful on broken filesystems like FAT. 209 See linkgit:git-update-index[1]. 210+ 211The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 212will probe and set core.fileMode false if appropriate when the 213repository is created. 214 215core.ignorecase:: 216 If true, this option enables various workarounds to enable 217 Git to work better on filesystems that are not case sensitive, 218 like FAT. For example, if a directory listing finds 219 "makefile" when Git expects "Makefile", Git will assume 220 it is really the same file, and continue to remember it as 221 "Makefile". 222+ 223The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 224will probe and set core.ignorecase true if appropriate when the repository 225is created. 226 227core.precomposeunicode:: 228 This option is only used by Mac OS implementation of Git. 229 When core.precomposeunicode=true, Git reverts the unicode decomposition 230 of filenames done by Mac OS. This is useful when sharing a repository 231 between Mac OS and Linux or Windows. 232 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 233 When false, file names are handled fully transparent by Git, 234 which is backward compatible with older versions of Git. 235 236core.trustctime:: 237 If false, the ctime differences between the index and the 238 working tree are ignored; useful when the inode change time 239 is regularly modified by something outside Git (file system 240 crawlers and some backup systems). 241 See linkgit:git-update-index[1]. True by default. 242 243core.checkstat:: 244 Determines which stat fields to match between the index 245 and work tree. The user can set this to 'default' or 246 'minimal'. Default (or explicitly 'default'), is to check 247 all fields, including the sub-second part of mtime and ctime. 248 249core.quotepath:: 250 The commands that output paths (e.g. 'ls-files', 251 'diff'), when not given the `-z` option, will quote 252 "unusual" characters in the pathname by enclosing the 253 pathname in a double-quote pair and with backslashes the 254 same way strings in C source code are quoted. If this 255 variable is set to false, the bytes higher than 0x80 are 256 not quoted but output as verbatim. Note that double 257 quote, backslash and control characters are always 258 quoted without `-z` regardless of the setting of this 259 variable. 260 261core.eol:: 262 Sets the line ending type to use in the working directory for 263 files that have the `text` property set. Alternatives are 264 'lf', 'crlf' and 'native', which uses the platform's native 265 line ending. The default value is `native`. See 266 linkgit:gitattributes[5] for more information on end-of-line 267 conversion. 268 269core.safecrlf:: 270 If true, makes Git check if converting `CRLF` is reversible when 271 end-of-line conversion is active. Git will verify if a command 272 modifies a file in the work tree either directly or indirectly. 273 For example, committing a file followed by checking out the 274 same file should yield the original file in the work tree. If 275 this is not the case for the current setting of 276 `core.autocrlf`, Git will reject the file. The variable can 277 be set to "warn", in which case Git will only warn about an 278 irreversible conversion but continue the operation. 279+ 280CRLF conversion bears a slight chance of corrupting data. 281When it is enabled, Git will convert CRLF to LF during commit and LF to 282CRLF during checkout. A file that contains a mixture of LF and 283CRLF before the commit cannot be recreated by Git. For text 284files this is the right thing to do: it corrects line endings 285such that we have only LF line endings in the repository. 286But for binary files that are accidentally classified as text the 287conversion can corrupt data. 288+ 289If you recognize such corruption early you can easily fix it by 290setting the conversion type explicitly in .gitattributes. Right 291after committing you still have the original file in your work 292tree and this file is not yet corrupted. You can explicitly tell 293Git that this file is binary and Git will handle the file 294appropriately. 295+ 296Unfortunately, the desired effect of cleaning up text files with 297mixed line endings and the undesired effect of corrupting binary 298files cannot be distinguished. In both cases CRLFs are removed 299in an irreversible way. For text files this is the right thing 300to do because CRLFs are line endings, while for binary files 301converting CRLFs corrupts data. 302+ 303Note, this safety check does not mean that a checkout will generate a 304file identical to the original file for a different setting of 305`core.eol` and `core.autocrlf`, but only for the current one. For 306example, a text file with `LF` would be accepted with `core.eol=lf` 307and could later be checked out with `core.eol=crlf`, in which case the 308resulting file would contain `CRLF`, although the original file 309contained `LF`. However, in both work trees the line endings would be 310consistent, that is either all `LF` or all `CRLF`, but never mixed. A 311file with mixed line endings would be reported by the `core.safecrlf` 312mechanism. 313 314core.autocrlf:: 315 Setting this variable to "true" is almost the same as setting 316 the `text` attribute to "auto" on all files except that text 317 files are not guaranteed to be normalized: files that contain 318 `CRLF` in the repository will not be touched. Use this 319 setting if you want to have `CRLF` line endings in your 320 working directory even though the repository does not have 321 normalized line endings. This variable can be set to 'input', 322 in which case no output conversion is performed. 323 324core.symlinks:: 325 If false, symbolic links are checked out as small plain files that 326 contain the link text. linkgit:git-update-index[1] and 327 linkgit:git-add[1] will not change the recorded type to regular 328 file. Useful on filesystems like FAT that do not support 329 symbolic links. 330+ 331The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 332will probe and set core.symlinks false if appropriate when the repository 333is created. 334 335core.gitProxy:: 336 A "proxy command" to execute (as 'command host port') instead 337 of establishing direct connection to the remote server when 338 using the Git protocol for fetching. If the variable value is 339 in the "COMMAND for DOMAIN" format, the command is applied only 340 on hostnames ending with the specified domain string. This variable 341 may be set multiple times and is matched in the given order; 342 the first match wins. 343+ 344Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 345(which always applies universally, without the special "for" 346handling). 347+ 348The special string `none` can be used as the proxy command to 349specify that no proxy be used for a given domain pattern. 350This is useful for excluding servers inside a firewall from 351proxy use, while defaulting to a common proxy for external domains. 352 353core.ignoreStat:: 354 If true, commands which modify both the working tree and the index 355 will mark the updated paths with the "assume unchanged" bit in the 356 index. These marked files are then assumed to stay unchanged in the 357 working tree, until you mark them otherwise manually - Git will not 358 detect the file changes by lstat() calls. This is useful on systems 359 where those are very slow, such as Microsoft Windows. 360 See linkgit:git-update-index[1]. 361 False by default. 362 363core.preferSymlinkRefs:: 364 Instead of the default "symref" format for HEAD 365 and other symbolic reference files, use symbolic links. 366 This is sometimes needed to work with old scripts that 367 expect HEAD to be a symbolic link. 368 369core.bare:: 370 If true this repository is assumed to be 'bare' and has no 371 working directory associated with it. If this is the case a 372 number of commands that require a working directory will be 373 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 374+ 375This setting is automatically guessed by linkgit:git-clone[1] or 376linkgit:git-init[1] when the repository was created. By default a 377repository that ends in "/.git" is assumed to be not bare (bare = 378false), while all other repositories are assumed to be bare (bare 379= true). 380 381core.worktree:: 382 Set the path to the root of the working tree. 383 This can be overridden by the GIT_WORK_TREE environment 384 variable and the '--work-tree' command-line option. 385 The value can be an absolute path or relative to the path to 386 the .git directory, which is either specified by --git-dir 387 or GIT_DIR, or automatically discovered. 388 If --git-dir or GIT_DIR is specified but none of 389 --work-tree, GIT_WORK_TREE and core.worktree is specified, 390 the current working directory is regarded as the top level 391 of your working tree. 392+ 393Note that this variable is honored even when set in a configuration 394file in a ".git" subdirectory of a directory and its value differs 395from the latter directory (e.g. "/path/to/.git/config" has 396core.worktree set to "/different/path"), which is most likely a 397misconfiguration. Running Git commands in the "/path/to" directory will 398still use "/different/path" as the root of the work tree and can cause 399confusion unless you know what you are doing (e.g. you are creating a 400read-only snapshot of the same index to a location different from the 401repository's usual working tree). 402 403core.logAllRefUpdates:: 404 Enable the reflog. Updates to a ref <ref> is logged to the file 405 "$GIT_DIR/logs/<ref>", by appending the new and old 406 SHA-1, the date/time and the reason of the update, but 407 only when the file exists. If this configuration 408 variable is set to true, missing "$GIT_DIR/logs/<ref>" 409 file is automatically created for branch heads (i.e. under 410 refs/heads/), remote refs (i.e. under refs/remotes/), 411 note refs (i.e. under refs/notes/), and the symbolic ref HEAD. 412+ 413This information can be used to determine what commit 414was the tip of a branch "2 days ago". 415+ 416This value is true by default in a repository that has 417a working directory associated with it, and false by 418default in a bare repository. 419 420core.repositoryFormatVersion:: 421 Internal variable identifying the repository format and layout 422 version. 423 424core.sharedRepository:: 425 When 'group' (or 'true'), the repository is made shareable between 426 several users in a group (making sure all the files and objects are 427 group-writable). When 'all' (or 'world' or 'everybody'), the 428 repository will be readable by all users, additionally to being 429 group-shareable. When 'umask' (or 'false'), Git will use permissions 430 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 431 files in the repository will have this mode value. '0xxx' will override 432 user's umask value (whereas the other options will only override 433 requested parts of the user's umask value). Examples: '0660' will make 434 the repo read/write-able for the owner and group, but inaccessible to 435 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 436 repository that is group-readable but not group-writable. 437 See linkgit:git-init[1]. False by default. 438 439core.warnAmbiguousRefs:: 440 If true, Git will warn you if the ref name you passed it is ambiguous 441 and might match multiple refs in the repository. True by default. 442 443core.compression:: 444 An integer -1..9, indicating a default compression level. 445 -1 is the zlib default. 0 means no compression, 446 and 1..9 are various speed/size tradeoffs, 9 being slowest. 447 If set, this provides a default to other compression variables, 448 such as 'core.loosecompression' and 'pack.compression'. 449 450core.loosecompression:: 451 An integer -1..9, indicating the compression level for objects that 452 are not in a pack file. -1 is the zlib default. 0 means no 453 compression, and 1..9 are various speed/size tradeoffs, 9 being 454 slowest. If not set, defaults to core.compression. If that is 455 not set, defaults to 1 (best speed). 456 457core.packedGitWindowSize:: 458 Number of bytes of a pack file to map into memory in a 459 single mapping operation. Larger window sizes may allow 460 your system to process a smaller number of large pack files 461 more quickly. Smaller window sizes will negatively affect 462 performance due to increased calls to the operating system's 463 memory manager, but may improve performance when accessing 464 a large number of large pack files. 465+ 466Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 467MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 468be reasonable for all users/operating systems. You probably do 469not need to adjust this value. 470+ 471Common unit suffixes of 'k', 'm', or 'g' are supported. 472 473core.packedGitLimit:: 474 Maximum number of bytes to map simultaneously into memory 475 from pack files. If Git needs to access more than this many 476 bytes at once to complete an operation it will unmap existing 477 regions to reclaim virtual address space within the process. 478+ 479Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 480This should be reasonable for all users/operating systems, except on 481the largest projects. You probably do not need to adjust this value. 482+ 483Common unit suffixes of 'k', 'm', or 'g' are supported. 484 485core.deltaBaseCacheLimit:: 486 Maximum number of bytes to reserve for caching base objects 487 that may be referenced by multiple deltified objects. By storing the 488 entire decompressed base objects in a cache Git is able 489 to avoid unpacking and decompressing frequently used base 490 objects multiple times. 491+ 492Default is 96 MiB on all platforms. This should be reasonable 493for all users/operating systems, except on the largest projects. 494You probably do not need to adjust this value. 495+ 496Common unit suffixes of 'k', 'm', or 'g' are supported. 497 498core.bigFileThreshold:: 499 Files larger than this size are stored deflated, without 500 attempting delta compression. Storing large files without 501 delta compression avoids excessive memory usage, at the 502 slight expense of increased disk usage. 503+ 504Default is 512 MiB on all platforms. This should be reasonable 505for most projects as source code and other text files can still 506be delta compressed, but larger binary media files won't be. 507+ 508Common unit suffixes of 'k', 'm', or 'g' are supported. 509 510core.excludesfile:: 511 In addition to '.gitignore' (per-directory) and 512 '.git/info/exclude', Git looks into this file for patterns 513 of files which are not meant to be tracked. "`~/`" is expanded 514 to the value of `$HOME` and "`~user/`" to the specified user's 515 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore. 516 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore 517 is used instead. See linkgit:gitignore[5]. 518 519core.askpass:: 520 Some commands (e.g. svn and http interfaces) that interactively 521 ask for a password can be told to use an external program given 522 via the value of this variable. Can be overridden by the 'GIT_ASKPASS' 523 environment variable. If not set, fall back to the value of the 524 'SSH_ASKPASS' environment variable or, failing that, a simple password 525 prompt. The external program shall be given a suitable prompt as 526 command-line argument and write the password on its STDOUT. 527 528core.attributesfile:: 529 In addition to '.gitattributes' (per-directory) and 530 '.git/info/attributes', Git looks into this file for attributes 531 (see linkgit:gitattributes[5]). Path expansions are made the same 532 way as for `core.excludesfile`. Its default value is 533 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not 534 set or empty, $HOME/.config/git/attributes is used instead. 535 536core.editor:: 537 Commands such as `commit` and `tag` that lets you edit 538 messages by launching an editor uses the value of this 539 variable when it is set, and the environment variable 540 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 541 542core.commentchar:: 543 Commands such as `commit` and `tag` that lets you edit 544 messages consider a line that begins with this character 545 commented, and removes them after the editor returns 546 (default '#'). 547+ 548If set to "auto", `git-commit` would select a character that is not 549the beginning character of any line in existing commit messages. 550 551sequence.editor:: 552 Text editor used by `git rebase -i` for editing the rebase instruction file. 553 The value is meant to be interpreted by the shell when it is used. 554 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 555 When not configured the default commit message editor is used instead. 556 557core.pager:: 558 Text viewer for use by Git commands (e.g., 'less'). The value 559 is meant to be interpreted by the shell. The order of preference 560 is the `$GIT_PAGER` environment variable, then `core.pager` 561 configuration, then `$PAGER`, and then the default chosen at 562 compile time (usually 'less'). 563+ 564When the `LESS` environment variable is unset, Git sets it to `FRX` 565(if `LESS` environment variable is set, Git does not change it at 566all). If you want to selectively override Git's default setting 567for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 568be passed to the shell by Git, which will translate the final 569command to `LESS=FRX less -S`. The environment does not set the 570`S` option but the command line does, instructing less to truncate 571long lines. Similarly, setting `core.pager` to `less -+F` will 572deactivate the `F` option specified by the environment from the 573command-line, deactivating the "quit if one screen" behavior of 574`less`. One can specifically activate some flags for particular 575commands: for example, setting `pager.blame` to `less -S` enables 576line truncation only for `git blame`. 577+ 578Likewise, when the `LV` environment variable is unset, Git sets it 579to `-c`. You can override this setting by exporting `LV` with 580another value or setting `core.pager` to `lv +c`. 581 582core.whitespace:: 583 A comma separated list of common whitespace problems to 584 notice. 'git diff' will use `color.diff.whitespace` to 585 highlight them, and 'git apply --whitespace=error' will 586 consider them as errors. You can prefix `-` to disable 587 any of them (e.g. `-trailing-space`): 588+ 589* `blank-at-eol` treats trailing whitespaces at the end of the line 590 as an error (enabled by default). 591* `space-before-tab` treats a space character that appears immediately 592 before a tab character in the initial indent part of the line as an 593 error (enabled by default). 594* `indent-with-non-tab` treats a line that is indented with space 595 characters instead of the equivalent tabs as an error (not enabled by 596 default). 597* `tab-in-indent` treats a tab character in the initial indent part of 598 the line as an error (not enabled by default). 599* `blank-at-eof` treats blank lines added at the end of file as an error 600 (enabled by default). 601* `trailing-space` is a short-hand to cover both `blank-at-eol` and 602 `blank-at-eof`. 603* `cr-at-eol` treats a carriage-return at the end of line as 604 part of the line terminator, i.e. with it, `trailing-space` 605 does not trigger if the character before such a carriage-return 606 is not a whitespace (not enabled by default). 607* `tabwidth=<n>` tells how many character positions a tab occupies; this 608 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 609 errors. The default tab width is 8. Allowed values are 1 to 63. 610 611core.fsyncobjectfiles:: 612 This boolean will enable 'fsync()' when writing object files. 613+ 614This is a total waste of time and effort on a filesystem that orders 615data writes properly, but can be useful for filesystems that do not use 616journalling (traditional UNIX filesystems) or that only journal metadata 617and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 618 619core.preloadindex:: 620 Enable parallel index preload for operations like 'git diff' 621+ 622This can speed up operations like 'git diff' and 'git status' especially 623on filesystems like NFS that have weak caching semantics and thus 624relatively high IO latencies. When enabled, Git will do the 625index comparison to the filesystem data in parallel, allowing 626overlapping IO's. Defaults to true. 627 628core.createObject:: 629 You can set this to 'link', in which case a hardlink followed by 630 a delete of the source are used to make sure that object creation 631 will not overwrite existing objects. 632+ 633On some file system/operating system combinations, this is unreliable. 634Set this config setting to 'rename' there; However, This will remove the 635check that makes sure that existing object files will not get overwritten. 636 637core.notesRef:: 638 When showing commit messages, also show notes which are stored in 639 the given ref. The ref must be fully qualified. If the given 640 ref does not exist, it is not an error but means that no 641 notes should be printed. 642+ 643This setting defaults to "refs/notes/commits", and it can be overridden by 644the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. 645 646core.sparseCheckout:: 647 Enable "sparse checkout" feature. See section "Sparse checkout" in 648 linkgit:git-read-tree[1] for more information. 649 650core.abbrev:: 651 Set the length object names are abbreviated to. If unspecified, 652 many commands abbreviate to 7 hexdigits, which may not be enough 653 for abbreviated object names to stay unique for sufficiently long 654 time. 655 656add.ignore-errors:: 657add.ignoreErrors:: 658 Tells 'git add' to continue adding files when some files cannot be 659 added due to indexing errors. Equivalent to the '--ignore-errors' 660 option of linkgit:git-add[1]. Older versions of Git accept only 661 `add.ignore-errors`, which does not follow the usual naming 662 convention for configuration variables. Newer versions of Git 663 honor `add.ignoreErrors` as well. 664 665alias.*:: 666 Command aliases for the linkgit:git[1] command wrapper - e.g. 667 after defining "alias.last = cat-file commit HEAD", the invocation 668 "git last" is equivalent to "git cat-file commit HEAD". To avoid 669 confusion and troubles with script usage, aliases that 670 hide existing Git commands are ignored. Arguments are split by 671 spaces, the usual shell quoting and escaping is supported. 672 A quote pair or a backslash can be used to quote them. 673+ 674If the alias expansion is prefixed with an exclamation point, 675it will be treated as a shell command. For example, defining 676"alias.new = !gitk --all --not ORIG_HEAD", the invocation 677"git new" is equivalent to running the shell command 678"gitk --all --not ORIG_HEAD". Note that shell commands will be 679executed from the top-level directory of a repository, which may 680not necessarily be the current directory. 681'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix' 682from the original current directory. See linkgit:git-rev-parse[1]. 683 684am.keepcr:: 685 If true, git-am will call git-mailsplit for patches in mbox format 686 with parameter '--keep-cr'. In this case git-mailsplit will 687 not remove `\r` from lines ending with `\r\n`. Can be overridden 688 by giving '--no-keep-cr' from the command line. 689 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 690 691apply.ignorewhitespace:: 692 When set to 'change', tells 'git apply' to ignore changes in 693 whitespace, in the same way as the '--ignore-space-change' 694 option. 695 When set to one of: no, none, never, false tells 'git apply' to 696 respect all whitespace differences. 697 See linkgit:git-apply[1]. 698 699apply.whitespace:: 700 Tells 'git apply' how to handle whitespaces, in the same way 701 as the '--whitespace' option. See linkgit:git-apply[1]. 702 703branch.autosetupmerge:: 704 Tells 'git branch' and 'git checkout' to set up new branches 705 so that linkgit:git-pull[1] will appropriately merge from the 706 starting point branch. Note that even if this option is not set, 707 this behavior can be chosen per-branch using the `--track` 708 and `--no-track` options. The valid settings are: `false` -- no 709 automatic setup is done; `true` -- automatic setup is done when the 710 starting point is a remote-tracking branch; `always` -- 711 automatic setup is done when the starting point is either a 712 local branch or remote-tracking 713 branch. This option defaults to true. 714 715branch.autosetuprebase:: 716 When a new branch is created with 'git branch' or 'git checkout' 717 that tracks another branch, this variable tells Git to set 718 up pull to rebase instead of merge (see "branch.<name>.rebase"). 719 When `never`, rebase is never automatically set to true. 720 When `local`, rebase is set to true for tracked branches of 721 other local branches. 722 When `remote`, rebase is set to true for tracked branches of 723 remote-tracking branches. 724 When `always`, rebase will be set to true for all tracking 725 branches. 726 See "branch.autosetupmerge" for details on how to set up a 727 branch to track another branch. 728 This option defaults to never. 729 730branch.<name>.remote:: 731 When on branch <name>, it tells 'git fetch' and 'git push' 732 which remote to fetch from/push to. The remote to push to 733 may be overridden with `remote.pushdefault` (for all branches). 734 The remote to push to, for the current branch, may be further 735 overridden by `branch.<name>.pushremote`. If no remote is 736 configured, or if you are not on any branch, it defaults to 737 `origin` for fetching and `remote.pushdefault` for pushing. 738 Additionally, `.` (a period) is the current local repository 739 (a dot-repository), see `branch.<name>.merge`'s final note below. 740 741branch.<name>.pushremote:: 742 When on branch <name>, it overrides `branch.<name>.remote` for 743 pushing. It also overrides `remote.pushdefault` for pushing 744 from branch <name>. When you pull from one place (e.g. your 745 upstream) and push to another place (e.g. your own publishing 746 repository), you would want to set `remote.pushdefault` to 747 specify the remote to push to for all branches, and use this 748 option to override it for a specific branch. 749 750branch.<name>.merge:: 751 Defines, together with branch.<name>.remote, the upstream branch 752 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which 753 branch to merge and can also affect 'git push' (see push.default). 754 When in branch <name>, it tells 'git fetch' the default 755 refspec to be marked for merging in FETCH_HEAD. The value is 756 handled like the remote part of a refspec, and must match a 757 ref which is fetched from the remote given by 758 "branch.<name>.remote". 759 The merge information is used by 'git pull' (which at first calls 760 'git fetch') to lookup the default branch for merging. Without 761 this option, 'git pull' defaults to merge the first refspec fetched. 762 Specify multiple values to get an octopus merge. 763 If you wish to setup 'git pull' so that it merges into <name> from 764 another branch in the local repository, you can point 765 branch.<name>.merge to the desired branch, and use the relative path 766 setting `.` (a period) for branch.<name>.remote. 767 768branch.<name>.mergeoptions:: 769 Sets default options for merging into branch <name>. The syntax and 770 supported options are the same as those of linkgit:git-merge[1], but 771 option values containing whitespace characters are currently not 772 supported. 773 774branch.<name>.rebase:: 775 When true, rebase the branch <name> on top of the fetched branch, 776 instead of merging the default branch from the default remote when 777 "git pull" is run. See "pull.rebase" for doing this in a non 778 branch-specific manner. 779+ 780 When preserve, also pass `--preserve-merges` along to 'git rebase' 781 so that locally committed merge commits will not be flattened 782 by running 'git pull'. 783+ 784*NOTE*: this is a possibly dangerous operation; do *not* use 785it unless you understand the implications (see linkgit:git-rebase[1] 786for details). 787 788branch.<name>.description:: 789 Branch description, can be edited with 790 `git branch --edit-description`. Branch description is 791 automatically added in the format-patch cover letter or 792 request-pull summary. 793 794browser.<tool>.cmd:: 795 Specify the command to invoke the specified browser. The 796 specified command is evaluated in shell with the URLs passed 797 as arguments. (See linkgit:git-web{litdd}browse[1].) 798 799browser.<tool>.path:: 800 Override the path for the given tool that may be used to 801 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 802 working repository in gitweb (see linkgit:git-instaweb[1]). 803 804clean.requireForce:: 805 A boolean to make git-clean do nothing unless given -f, 806 -i or -n. Defaults to true. 807 808color.branch:: 809 A boolean to enable/disable color in the output of 810 linkgit:git-branch[1]. May be set to `always`, 811 `false` (or `never`) or `auto` (or `true`), in which case colors are used 812 only when the output is to a terminal. Defaults to false. 813 814color.branch.<slot>:: 815 Use customized color for branch coloration. `<slot>` is one of 816 `current` (the current branch), `local` (a local branch), 817 `remote` (a remote-tracking branch in refs/remotes/), 818 `upstream` (upstream tracking branch), `plain` (other 819 refs). 820+ 821The value for these configuration variables is a list of colors (at most 822two) and attributes (at most one), separated by spaces. The colors 823accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, 824`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, 825`blink` and `reverse`. The first color given is the foreground; the 826second is the background. The position of the attribute, if any, 827doesn't matter. 828+ 829Colors (foreground and background) may also be given as numbers between 8300 and 255; these use ANSI 256-color mode (but note that not all 831terminals may support this). If your terminal supports it, you may also 832specify 24-bit RGB values as hex, like `#ff0ab3`. 833 834color.diff:: 835 Whether to use ANSI escape sequences to add color to patches. 836 If this is set to `always`, linkgit:git-diff[1], 837 linkgit:git-log[1], and linkgit:git-show[1] will use color 838 for all patches. If it is set to `true` or `auto`, those 839 commands will only use color when output is to the terminal. 840 Defaults to false. 841+ 842This does not affect linkgit:git-format-patch[1] or the 843'git-diff-{asterisk}' plumbing commands. Can be overridden on the 844command line with the `--color[=<when>]` option. 845 846color.diff.<slot>:: 847 Use customized color for diff colorization. `<slot>` specifies 848 which part of the patch to use the specified color, and is one 849 of `plain` (context text), `meta` (metainformation), `frag` 850 (hunk header), 'func' (function in hunk header), `old` (removed lines), 851 `new` (added lines), `commit` (commit headers), or `whitespace` 852 (highlighting whitespace errors). The values of these variables may be 853 specified as in color.branch.<slot>. 854 855color.decorate.<slot>:: 856 Use customized color for 'git log --decorate' output. `<slot>` is one 857 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 858 branches, remote-tracking branches, tags, stash and HEAD, respectively. 859 860color.grep:: 861 When set to `always`, always highlight matches. When `false` (or 862 `never`), never. When set to `true` or `auto`, use color only 863 when the output is written to the terminal. Defaults to `false`. 864 865color.grep.<slot>:: 866 Use customized color for grep colorization. `<slot>` specifies which 867 part of the line to use the specified color, and is one of 868+ 869-- 870`context`;; 871 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 872`filename`;; 873 filename prefix (when not using `-h`) 874`function`;; 875 function name lines (when using `-p`) 876`linenumber`;; 877 line number prefix (when using `-n`) 878`match`;; 879 matching text 880`selected`;; 881 non-matching text in selected lines 882`separator`;; 883 separators between fields on a line (`:`, `-`, and `=`) 884 and between hunks (`--`) 885-- 886+ 887The values of these variables may be specified as in color.branch.<slot>. 888 889color.interactive:: 890 When set to `always`, always use colors for interactive prompts 891 and displays (such as those used by "git-add --interactive" and 892 "git-clean --interactive"). When false (or `never`), never. 893 When set to `true` or `auto`, use colors only when the output is 894 to the terminal. Defaults to false. 895 896color.interactive.<slot>:: 897 Use customized color for 'git add --interactive' and 'git clean 898 --interactive' output. `<slot>` may be `prompt`, `header`, `help` 899 or `error`, for four distinct types of normal output from 900 interactive commands. The values of these variables may be 901 specified as in color.branch.<slot>. 902 903color.pager:: 904 A boolean to enable/disable colored output when the pager is in 905 use (default is true). 906 907color.showbranch:: 908 A boolean to enable/disable color in the output of 909 linkgit:git-show-branch[1]. May be set to `always`, 910 `false` (or `never`) or `auto` (or `true`), in which case colors are used 911 only when the output is to a terminal. Defaults to false. 912 913color.status:: 914 A boolean to enable/disable color in the output of 915 linkgit:git-status[1]. May be set to `always`, 916 `false` (or `never`) or `auto` (or `true`), in which case colors are used 917 only when the output is to a terminal. Defaults to false. 918 919color.status.<slot>:: 920 Use customized color for status colorization. `<slot>` is 921 one of `header` (the header text of the status message), 922 `added` or `updated` (files which are added but not committed), 923 `changed` (files which are changed but not added in the index), 924 `untracked` (files which are not tracked by Git), 925 `branch` (the current branch), or 926 `nobranch` (the color the 'no branch' warning is shown in, defaulting 927 to red). The values of these variables may be specified as in 928 color.branch.<slot>. 929 930color.ui:: 931 This variable determines the default value for variables such 932 as `color.diff` and `color.grep` that control the use of color 933 per command family. Its scope will expand as more commands learn 934 configuration to set a default for the `--color` option. Set it 935 to `false` or `never` if you prefer Git commands not to use 936 color unless enabled explicitly with some other configuration 937 or the `--color` option. Set it to `always` if you want all 938 output not intended for machine consumption to use color, to 939 `true` or `auto` (this is the default since Git 1.8.4) if you 940 want such output to use color when written to the terminal. 941 942column.ui:: 943 Specify whether supported commands should output in columns. 944 This variable consists of a list of tokens separated by spaces 945 or commas: 946+ 947These options control when the feature should be enabled 948(defaults to 'never'): 949+ 950-- 951`always`;; 952 always show in columns 953`never`;; 954 never show in columns 955`auto`;; 956 show in columns if the output is to the terminal 957-- 958+ 959These options control layout (defaults to 'column'). Setting any 960of these implies 'always' if none of 'always', 'never', or 'auto' are 961specified. 962+ 963-- 964`column`;; 965 fill columns before rows 966`row`;; 967 fill rows before columns 968`plain`;; 969 show in one column 970-- 971+ 972Finally, these options can be combined with a layout option (defaults 973to 'nodense'): 974+ 975-- 976`dense`;; 977 make unequal size columns to utilize more space 978`nodense`;; 979 make equal size columns 980-- 981 982column.branch:: 983 Specify whether to output branch listing in `git branch` in columns. 984 See `column.ui` for details. 985 986column.clean:: 987 Specify the layout when list items in `git clean -i`, which always 988 shows files and directories in columns. See `column.ui` for details. 989 990column.status:: 991 Specify whether to output untracked files in `git status` in columns. 992 See `column.ui` for details. 993 994column.tag:: 995 Specify whether to output tag listing in `git tag` in columns. 996 See `column.ui` for details. 997 998commit.cleanup:: 999 This setting overrides the default of the `--cleanup` option in1000 `git commit`. See linkgit:git-commit[1] for details. Changing the1001 default can be useful when you always want to keep lines that begin1002 with comment character `#` in your log message, in which case you1003 would do `git config commit.cleanup whitespace` (note that you will1004 have to remove the help lines that begin with `#` in the commit log1005 template yourself, if you do this).10061007commit.gpgsign::10081009 A boolean to specify whether all commits should be GPG signed.1010 Use of this option when doing operations such as rebase can1011 result in a large number of commits being signed. It may be1012 convenient to use an agent to avoid typing your GPG passphrase1013 several times.10141015commit.status::1016 A boolean to enable/disable inclusion of status information in the1017 commit message template when using an editor to prepare the commit1018 message. Defaults to true.10191020commit.template::1021 Specify a file to use as the template for new commit messages.1022 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the1023 specified user's home directory.10241025credential.helper::1026 Specify an external helper to be called when a username or1027 password credential is needed; the helper may consult external1028 storage to avoid prompting the user for the credentials. See1029 linkgit:gitcredentials[7] for details.10301031credential.useHttpPath::1032 When acquiring credentials, consider the "path" component of an http1033 or https URL to be important. Defaults to false. See1034 linkgit:gitcredentials[7] for more information.10351036credential.username::1037 If no username is set for a network authentication, use this username1038 by default. See credential.<context>.* below, and1039 linkgit:gitcredentials[7].10401041credential.<url>.*::1042 Any of the credential.* options above can be applied selectively to1043 some credentials. For example "credential.https://example.com.username"1044 would set the default username only for https connections to1045 example.com. See linkgit:gitcredentials[7] for details on how URLs are1046 matched.10471048include::diff-config.txt[]10491050difftool.<tool>.path::1051 Override the path for the given tool. This is useful in case1052 your tool is not in the PATH.10531054difftool.<tool>.cmd::1055 Specify the command to invoke the specified diff tool.1056 The specified command is evaluated in shell with the following1057 variables available: 'LOCAL' is set to the name of the temporary1058 file containing the contents of the diff pre-image and 'REMOTE'1059 is set to the name of the temporary file containing the contents1060 of the diff post-image.10611062difftool.prompt::1063 Prompt before each invocation of the diff tool.10641065fetch.recurseSubmodules::1066 This option can be either set to a boolean value or to 'on-demand'.1067 Setting it to a boolean changes the behavior of fetch and pull to1068 unconditionally recurse into submodules when set to true or to not1069 recurse at all when set to false. When set to 'on-demand' (the default1070 value), fetch and pull will only recurse into a populated submodule1071 when its superproject retrieves a commit that updates the submodule's1072 reference.10731074fetch.fsckObjects::1075 If it is set to true, git-fetch-pack will check all fetched1076 objects. It will abort in the case of a malformed object or a1077 broken link. The result of an abort are only dangling objects.1078 Defaults to false. If not set, the value of `transfer.fsckObjects`1079 is used instead.10801081fetch.unpackLimit::1082 If the number of objects fetched over the Git native1083 transfer is below this1084 limit, then the objects will be unpacked into loose object1085 files. However if the number of received objects equals or1086 exceeds this limit then the received pack will be stored as1087 a pack, after adding any missing delta bases. Storing the1088 pack from a push can make the push operation complete faster,1089 especially on slow filesystems. If not set, the value of1090 `transfer.unpackLimit` is used instead.10911092fetch.prune::1093 If true, fetch will automatically behave as if the `--prune`1094 option was given on the command line. See also `remote.<name>.prune`.10951096format.attach::1097 Enable multipart/mixed attachments as the default for1098 'format-patch'. The value can also be a double quoted string1099 which will enable attachments as the default and set the1100 value as the boundary. See the --attach option in1101 linkgit:git-format-patch[1].11021103format.numbered::1104 A boolean which can enable or disable sequence numbers in patch1105 subjects. It defaults to "auto" which enables it only if there1106 is more than one patch. It can be enabled or disabled for all1107 messages by setting it to "true" or "false". See --numbered1108 option in linkgit:git-format-patch[1].11091110format.headers::1111 Additional email headers to include in a patch to be submitted1112 by mail. See linkgit:git-format-patch[1].11131114format.to::1115format.cc::1116 Additional recipients to include in a patch to be submitted1117 by mail. See the --to and --cc options in1118 linkgit:git-format-patch[1].11191120format.subjectprefix::1121 The default for format-patch is to output files with the '[PATCH]'1122 subject prefix. Use this variable to change that prefix.11231124format.signature::1125 The default for format-patch is to output a signature containing1126 the Git version number. Use this variable to change that default.1127 Set this variable to the empty string ("") to suppress1128 signature generation.11291130format.signaturefile::1131 Works just like format.signature except the contents of the1132 file specified by this variable will be used as the signature.11331134format.suffix::1135 The default for format-patch is to output files with the suffix1136 `.patch`. Use this variable to change that suffix (make sure to1137 include the dot if you want it).11381139format.pretty::1140 The default pretty format for log/show/whatchanged command,1141 See linkgit:git-log[1], linkgit:git-show[1],1142 linkgit:git-whatchanged[1].11431144format.thread::1145 The default threading style for 'git format-patch'. Can be1146 a boolean value, or `shallow` or `deep`. `shallow` threading1147 makes every mail a reply to the head of the series,1148 where the head is chosen from the cover letter, the1149 `--in-reply-to`, and the first patch mail, in this order.1150 `deep` threading makes every mail a reply to the previous one.1151 A true boolean value is the same as `shallow`, and a false1152 value disables threading.11531154format.signoff::1155 A boolean value which lets you enable the `-s/--signoff` option of1156 format-patch by default. *Note:* Adding the Signed-off-by: line to a1157 patch should be a conscious act and means that you certify you have1158 the rights to submit this work under the same open source license.1159 Please see the 'SubmittingPatches' document for further discussion.11601161format.coverLetter::1162 A boolean that controls whether to generate a cover-letter when1163 format-patch is invoked, but in addition can be set to "auto", to1164 generate a cover-letter only when there's more than one patch.11651166filter.<driver>.clean::1167 The command which is used to convert the content of a worktree1168 file to a blob upon checkin. See linkgit:gitattributes[5] for1169 details.11701171filter.<driver>.smudge::1172 The command which is used to convert the content of a blob1173 object to a worktree file upon checkout. See1174 linkgit:gitattributes[5] for details.11751176gc.aggressiveDepth::1177 The depth parameter used in the delta compression1178 algorithm used by 'git gc --aggressive'. This defaults1179 to 250.11801181gc.aggressiveWindow::1182 The window size parameter used in the delta compression1183 algorithm used by 'git gc --aggressive'. This defaults1184 to 250.11851186gc.auto::1187 When there are approximately more than this many loose1188 objects in the repository, `git gc --auto` will pack them.1189 Some Porcelain commands use this command to perform a1190 light-weight garbage collection from time to time. The1191 default value is 6700. Setting this to 0 disables it.11921193gc.autopacklimit::1194 When there are more than this many packs that are not1195 marked with `*.keep` file in the repository, `git gc1196 --auto` consolidates them into one larger pack. The1197 default value is 50. Setting this to 0 disables it.11981199gc.autodetach::1200 Make `git gc --auto` return immediately andrun in background1201 if the system supports it. Default is true.12021203gc.packrefs::1204 Running `git pack-refs` in a repository renders it1205 unclonable by Git versions prior to 1.5.1.2 over dumb1206 transports such as HTTP. This variable determines whether1207 'git gc' runs `git pack-refs`. This can be set to `notbare`1208 to enable it within all non-bare repos or it can be set to a1209 boolean value. The default is `true`.12101211gc.pruneexpire::1212 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1213 Override the grace period with this config variable. The value1214 "now" may be used to disable this grace period and always prune1215 unreachable objects immediately.12161217gc.reflogexpire::1218gc.<pattern>.reflogexpire::1219 'git reflog expire' removes reflog entries older than1220 this time; defaults to 90 days. With "<pattern>" (e.g.1221 "refs/stash") in the middle the setting applies only to1222 the refs that match the <pattern>.12231224gc.reflogexpireunreachable::1225gc.<ref>.reflogexpireunreachable::1226 'git reflog expire' removes reflog entries older than1227 this time and are not reachable from the current tip;1228 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")1229 in the middle, the setting applies only to the refs that1230 match the <pattern>.12311232gc.rerereresolved::1233 Records of conflicted merge you resolved earlier are1234 kept for this many days when 'git rerere gc' is run.1235 The default is 60 days. See linkgit:git-rerere[1].12361237gc.rerereunresolved::1238 Records of conflicted merge you have not resolved are1239 kept for this many days when 'git rerere gc' is run.1240 The default is 15 days. See linkgit:git-rerere[1].12411242gitcvs.commitmsgannotation::1243 Append this string to each commit message. Set to empty string1244 to disable this feature. Defaults to "via git-CVS emulator".12451246gitcvs.enabled::1247 Whether the CVS server interface is enabled for this repository.1248 See linkgit:git-cvsserver[1].12491250gitcvs.logfile::1251 Path to a log file where the CVS server interface well... logs1252 various stuff. See linkgit:git-cvsserver[1].12531254gitcvs.usecrlfattr::1255 If true, the server will look up the end-of-line conversion1256 attributes for files to determine the '-k' modes to use. If1257 the attributes force Git to treat a file as text,1258 the '-k' mode will be left blank so CVS clients will1259 treat it as text. If they suppress text conversion, the file1260 will be set with '-kb' mode, which suppresses any newline munging1261 the client might otherwise do. If the attributes do not allow1262 the file type to be determined, then 'gitcvs.allbinary' is1263 used. See linkgit:gitattributes[5].12641265gitcvs.allbinary::1266 This is used if 'gitcvs.usecrlfattr' does not resolve1267 the correct '-kb' mode to use. If true, all1268 unresolved files are sent to the client in1269 mode '-kb'. This causes the client to treat them1270 as binary files, which suppresses any newline munging it1271 otherwise might do. Alternatively, if it is set to "guess",1272 then the contents of the file are examined to decide if1273 it is binary, similar to 'core.autocrlf'.12741275gitcvs.dbname::1276 Database used by git-cvsserver to cache revision information1277 derived from the Git repository. The exact meaning depends on the1278 used database driver, for SQLite (which is the default driver) this1279 is a filename. Supports variable substitution (see1280 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1281 Default: '%Ggitcvs.%m.sqlite'12821283gitcvs.dbdriver::1284 Used Perl DBI driver. You can specify any available driver1285 for this here, but it might not work. git-cvsserver is tested1286 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1287 reported *not* to work with 'DBD::mysql'. Experimental feature.1288 May not contain double colons (`:`). Default: 'SQLite'.1289 See linkgit:git-cvsserver[1].12901291gitcvs.dbuser, gitcvs.dbpass::1292 Database user and password. Only useful if setting 'gitcvs.dbdriver',1293 since SQLite has no concept of database users and/or passwords.1294 'gitcvs.dbuser' supports variable substitution (see1295 linkgit:git-cvsserver[1] for details).12961297gitcvs.dbTableNamePrefix::1298 Database table name prefix. Prepended to the names of any1299 database tables used, allowing a single database to be used1300 for several repositories. Supports variable substitution (see1301 linkgit:git-cvsserver[1] for details). Any non-alphabetic1302 characters will be replaced with underscores.13031304All gitcvs variables except for 'gitcvs.usecrlfattr' and1305'gitcvs.allbinary' can also be specified as1306'gitcvs.<access_method>.<varname>' (where 'access_method'1307is one of "ext" and "pserver") to make them apply only for the given1308access method.13091310gitweb.category::1311gitweb.description::1312gitweb.owner::1313gitweb.url::1314 See linkgit:gitweb[1] for description.13151316gitweb.avatar::1317gitweb.blame::1318gitweb.grep::1319gitweb.highlight::1320gitweb.patches::1321gitweb.pickaxe::1322gitweb.remote_heads::1323gitweb.showsizes::1324gitweb.snapshot::1325 See linkgit:gitweb.conf[5] for description.13261327grep.lineNumber::1328 If set to true, enable '-n' option by default.13291330grep.patternType::1331 Set the default matching behavior. Using a value of 'basic', 'extended',1332 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',1333 '--fixed-strings', or '--perl-regexp' option accordingly, while the1334 value 'default' will return to the default matching behavior.13351336grep.extendedRegexp::1337 If set to true, enable '--extended-regexp' option by default. This1338 option is ignored when the 'grep.patternType' option is set to a value1339 other than 'default'.13401341gpg.program::1342 Use this custom program instead of "gpg" found on $PATH when1343 making or verifying a PGP signature. The program must support the1344 same command-line interface as GPG, namely, to verify a detached1345 signature, "gpg --verify $file - <$signature" is run, and the1346 program is expected to signal a good signature by exiting with1347 code 0, and to generate an ascii-armored detached signature, the1348 standard input of "gpg -bsau $key" is fed with the contents to be1349 signed, and the program is expected to send the result to its1350 standard output.13511352gui.commitmsgwidth::1353 Defines how wide the commit message window is in the1354 linkgit:git-gui[1]. "75" is the default.13551356gui.diffcontext::1357 Specifies how many context lines should be used in calls to diff1358 made by the linkgit:git-gui[1]. The default is "5".13591360gui.displayuntracked::1361 Determines if linkgit::git-gui[1] shows untracked files1362 in the file list. The default is "true".13631364gui.encoding::1365 Specifies the default encoding to use for displaying of1366 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1367 It can be overridden by setting the 'encoding' attribute1368 for relevant files (see linkgit:gitattributes[5]).1369 If this option is not set, the tools default to the1370 locale encoding.13711372gui.matchtrackingbranch::1373 Determines if new branches created with linkgit:git-gui[1] should1374 default to tracking remote branches with matching names or1375 not. Default: "false".13761377gui.newbranchtemplate::1378 Is used as suggested name when creating new branches using the1379 linkgit:git-gui[1].13801381gui.pruneduringfetch::1382 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1383 performing a fetch. The default value is "false".13841385gui.trustmtime::1386 Determines if linkgit:git-gui[1] should trust the file modification1387 timestamp or not. By default the timestamps are not trusted.13881389gui.spellingdictionary::1390 Specifies the dictionary used for spell checking commit messages in1391 the linkgit:git-gui[1]. When set to "none" spell checking is turned1392 off.13931394gui.fastcopyblame::1395 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1396 location detection. It makes blame significantly faster on huge1397 repositories at the expense of less thorough copy detection.13981399gui.copyblamethreshold::1400 Specifies the threshold to use in 'git gui blame' original location1401 detection, measured in alphanumeric characters. See the1402 linkgit:git-blame[1] manual for more information on copy detection.14031404gui.blamehistoryctx::1405 Specifies the radius of history context in days to show in1406 linkgit:gitk[1] for the selected commit, when the `Show History1407 Context` menu item is invoked from 'git gui blame'. If this1408 variable is set to zero, the whole history is shown.14091410guitool.<name>.cmd::1411 Specifies the shell command line to execute when the corresponding item1412 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1413 mandatory for every tool. The command is executed from the root of1414 the working directory, and in the environment it receives the name of1415 the tool as 'GIT_GUITOOL', the name of the currently selected file as1416 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1417 the head is detached, 'CUR_BRANCH' is empty).14181419guitool.<name>.needsfile::1420 Run the tool only if a diff is selected in the GUI. It guarantees1421 that 'FILENAME' is not empty.14221423guitool.<name>.noconsole::1424 Run the command silently, without creating a window to display its1425 output.14261427guitool.<name>.norescan::1428 Don't rescan the working directory for changes after the tool1429 finishes execution.14301431guitool.<name>.confirm::1432 Show a confirmation dialog before actually running the tool.14331434guitool.<name>.argprompt::1435 Request a string argument from the user, and pass it to the tool1436 through the 'ARGS' environment variable. Since requesting an1437 argument implies confirmation, the 'confirm' option has no effect1438 if this is enabled. If the option is set to 'true', 'yes', or '1',1439 the dialog uses a built-in generic prompt; otherwise the exact1440 value of the variable is used.14411442guitool.<name>.revprompt::1443 Request a single valid revision from the user, and set the1444 'REVISION' environment variable. In other aspects this option1445 is similar to 'argprompt', and can be used together with it.14461447guitool.<name>.revunmerged::1448 Show only unmerged branches in the 'revprompt' subdialog.1449 This is useful for tools similar to merge or rebase, but not1450 for things like checkout or reset.14511452guitool.<name>.title::1453 Specifies the title to use for the prompt dialog. The default1454 is the tool name.14551456guitool.<name>.prompt::1457 Specifies the general prompt string to display at the top of1458 the dialog, before subsections for 'argprompt' and 'revprompt'.1459 The default value includes the actual command.14601461help.browser::1462 Specify the browser that will be used to display help in the1463 'web' format. See linkgit:git-help[1].14641465help.format::1466 Override the default help format used by linkgit:git-help[1].1467 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1468 the default. 'web' and 'html' are the same.14691470help.autocorrect::1471 Automatically correct and execute mistyped commands after1472 waiting for the given number of deciseconds (0.1 sec). If more1473 than one command can be deduced from the entered text, nothing1474 will be executed. If the value of this option is negative,1475 the corrected command will be executed immediately. If the1476 value is 0 - the command will be just shown but not executed.1477 This is the default.14781479help.htmlpath::1480 Specify the path where the HTML documentation resides. File system paths1481 and URLs are supported. HTML pages will be prefixed with this path when1482 help is displayed in the 'web' format. This defaults to the documentation1483 path of your Git installation.14841485http.proxy::1486 Override the HTTP proxy, normally configured using the 'http_proxy',1487 'https_proxy', and 'all_proxy' environment variables (see1488 `curl(1)`). This can be overridden on a per-remote basis; see1489 remote.<name>.proxy14901491http.cookiefile::1492 File containing previously stored cookie lines which should be used1493 in the Git http session, if they match the server. The file format1494 of the file to read cookies from should be plain HTTP headers or1495 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).1496 NOTE that the file specified with http.cookiefile is only used as1497 input unless http.saveCookies is set.14981499http.savecookies::1500 If set, store cookies received during requests to the file specified by1501 http.cookiefile. Has no effect if http.cookiefile is unset.15021503http.sslVerify::1504 Whether to verify the SSL certificate when fetching or pushing1505 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1506 variable.15071508http.sslCert::1509 File containing the SSL certificate when fetching or pushing1510 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1511 variable.15121513http.sslKey::1514 File containing the SSL private key when fetching or pushing1515 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1516 variable.15171518http.sslCertPasswordProtected::1519 Enable Git's password prompt for the SSL certificate. Otherwise1520 OpenSSL will prompt the user, possibly many times, if the1521 certificate or private key is encrypted. Can be overridden by the1522 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.15231524http.sslCAInfo::1525 File containing the certificates to verify the peer with when1526 fetching or pushing over HTTPS. Can be overridden by the1527 'GIT_SSL_CAINFO' environment variable.15281529http.sslCAPath::1530 Path containing files with the CA certificates to verify the peer1531 with when fetching or pushing over HTTPS. Can be overridden1532 by the 'GIT_SSL_CAPATH' environment variable.15331534http.sslTry::1535 Attempt to use AUTH SSL/TLS and encrypted data transfers1536 when connecting via regular FTP protocol. This might be needed1537 if the FTP server requires it for security reasons or you wish1538 to connect securely whenever remote FTP server supports it.1539 Default is false since it might trigger certificate verification1540 errors on misconfigured servers.15411542http.maxRequests::1543 How many HTTP requests to launch in parallel. Can be overridden1544 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.15451546http.minSessions::1547 The number of curl sessions (counted across slots) to be kept across1548 requests. They will not be ended with curl_easy_cleanup() until1549 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1550 value will be capped at 1. Defaults to 1.15511552http.postBuffer::1553 Maximum size in bytes of the buffer used by smart HTTP1554 transports when POSTing data to the remote system.1555 For requests larger than this buffer size, HTTP/1.1 and1556 Transfer-Encoding: chunked is used to avoid creating a1557 massive pack file locally. Default is 1 MiB, which is1558 sufficient for most requests.15591560http.lowSpeedLimit, http.lowSpeedTime::1561 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1562 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1563 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1564 'GIT_HTTP_LOW_SPEED_TIME' environment variables.15651566http.noEPSV::1567 A boolean which disables using of EPSV ftp command by curl.1568 This can helpful with some "poor" ftp servers which don't1569 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1570 environment variable. Default is false (curl will use EPSV).15711572http.useragent::1573 The HTTP USER_AGENT string presented to an HTTP server. The default1574 value represents the version of the client Git such as git/1.7.1.1575 This option allows you to override this value to a more common value1576 such as Mozilla/4.0. This may be necessary, for instance, if1577 connecting through a firewall that restricts HTTP connections to a set1578 of common USER_AGENT strings (but not including those like git/1.7.1).1579 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.15801581http.<url>.*::1582 Any of the http.* options above can be applied selectively to some urls.1583 For a config key to match a URL, each element of the config key is1584 compared to that of the URL, in the following order:1585+1586--1587. Scheme (e.g., `https` in `https://example.com/`). This field1588 must match exactly between the config key and the URL.15891590. Host/domain name (e.g., `example.com` in `https://example.com/`).1591 This field must match exactly between the config key and the URL.15921593. Port number (e.g., `8080` in `http://example.com:8080/`).1594 This field must match exactly between the config key and the URL.1595 Omitted port numbers are automatically converted to the correct1596 default for the scheme before matching.15971598. Path (e.g., `repo.git` in `https://example.com/repo.git`). The1599 path field of the config key must match the path field of the URL1600 either exactly or as a prefix of slash-delimited path elements. This means1601 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only1602 match on a slash (`/`) boundary. Longer matches take precedence (so a config1603 key with path `foo/bar` is a better match to URL path `foo/bar` than a config1604 key with just path `foo/`).16051606. User name (e.g., `user` in `https://user@example.com/repo.git`). If1607 the config key has a user name it must match the user name in the1608 URL exactly. If the config key does not have a user name, that1609 config key will match a URL with any user name (including none),1610 but at a lower precedence than a config key with a user name.1611--1612+1613The list above is ordered by decreasing precedence; a URL that matches1614a config key's path is preferred to one that matches its user name. For example,1615if the URL is `https://user@example.com/foo/bar` a config key match of1616`https://example.com/foo` will be preferred over a config key match of1617`https://user@example.com`.1618+1619All URLs are normalized before attempting any matching (the password part,1620if embedded in the URL, is always ignored for matching purposes) so that1621equivalent urls that are simply spelled differently will match properly.1622Environment variable settings always override any matches. The urls that are1623matched against are those given directly to Git commands. This means any URLs1624visited as a result of a redirection do not participate in matching.16251626i18n.commitEncoding::1627 Character encoding the commit messages are stored in; Git itself1628 does not care per se, but this information is necessary e.g. when1629 importing commits from emails or in the gitk graphical history1630 browser (and possibly at other places in the future or in other1631 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.16321633i18n.logOutputEncoding::1634 Character encoding the commit messages are converted to when1635 running 'git log' and friends.16361637imap::1638 The configuration variables in the 'imap' section are described1639 in linkgit:git-imap-send[1].16401641index.version::1642 Specify the version with which new index files should be1643 initialized. This does not affect existing repositories.16441645init.templatedir::1646 Specify the directory from which templates will be copied.1647 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)16481649instaweb.browser::1650 Specify the program that will be used to browse your working1651 repository in gitweb. See linkgit:git-instaweb[1].16521653instaweb.httpd::1654 The HTTP daemon command-line to start gitweb on your working1655 repository. See linkgit:git-instaweb[1].16561657instaweb.local::1658 If true the web server started by linkgit:git-instaweb[1] will1659 be bound to the local IP (127.0.0.1).16601661instaweb.modulepath::1662 The default module path for linkgit:git-instaweb[1] to use1663 instead of /usr/lib/apache2/modules. Only used if httpd1664 is Apache.16651666instaweb.port::1667 The port number to bind the gitweb httpd to. See1668 linkgit:git-instaweb[1].16691670interactive.singlekey::1671 In interactive commands, allow the user to provide one-letter1672 input with a single key (i.e., without hitting enter).1673 Currently this is used by the `--patch` mode of1674 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],1675 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this1676 setting is silently ignored if portable keystroke input1677 is not available; requires the Perl module Term::ReadKey.16781679log.abbrevCommit::1680 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1681 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may1682 override this option with `--no-abbrev-commit`.16831684log.date::1685 Set the default date-time mode for the 'log' command.1686 Setting a value for log.date is similar to using 'git log''s1687 `--date` option. Possible values are `relative`, `local`,1688 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]1689 for details.16901691log.decorate::1692 Print out the ref names of any commits that are shown by the log1693 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1694 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1695 specified, the full ref name (including prefix) will be printed.1696 This is the same as the log commands '--decorate' option.16971698log.showroot::1699 If true, the initial commit will be shown as a big creation event.1700 This is equivalent to a diff against an empty tree.1701 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1702 normally hide the root commit will now show it. True by default.17031704log.mailmap::1705 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1706 linkgit:git-whatchanged[1] assume `--use-mailmap`.17071708mailmap.file::1709 The location of an augmenting mailmap file. The default1710 mailmap, located in the root of the repository, is loaded1711 first, then the mailmap file pointed to by this variable.1712 The location of the mailmap file may be in a repository1713 subdirectory, or somewhere outside of the repository itself.1714 See linkgit:git-shortlog[1] and linkgit:git-blame[1].17151716mailmap.blob::1717 Like `mailmap.file`, but consider the value as a reference to a1718 blob in the repository. If both `mailmap.file` and1719 `mailmap.blob` are given, both are parsed, with entries from1720 `mailmap.file` taking precedence. In a bare repository, this1721 defaults to `HEAD:.mailmap`. In a non-bare repository, it1722 defaults to empty.17231724man.viewer::1725 Specify the programs that may be used to display help in the1726 'man' format. See linkgit:git-help[1].17271728man.<tool>.cmd::1729 Specify the command to invoke the specified man viewer. The1730 specified command is evaluated in shell with the man page1731 passed as argument. (See linkgit:git-help[1].)17321733man.<tool>.path::1734 Override the path for the given tool that may be used to1735 display help in the 'man' format. See linkgit:git-help[1].17361737include::merge-config.txt[]17381739mergetool.<tool>.path::1740 Override the path for the given tool. This is useful in case1741 your tool is not in the PATH.17421743mergetool.<tool>.cmd::1744 Specify the command to invoke the specified merge tool. The1745 specified command is evaluated in shell with the following1746 variables available: 'BASE' is the name of a temporary file1747 containing the common base of the files to be merged, if available;1748 'LOCAL' is the name of a temporary file containing the contents of1749 the file on the current branch; 'REMOTE' is the name of a temporary1750 file containing the contents of the file from the branch being1751 merged; 'MERGED' contains the name of the file to which the merge1752 tool should write the results of a successful merge.17531754mergetool.<tool>.trustExitCode::1755 For a custom merge command, specify whether the exit code of1756 the merge command can be used to determine whether the merge was1757 successful. If this is not set to true then the merge target file1758 timestamp is checked and the merge assumed to have been successful1759 if the file has been updated, otherwise the user is prompted to1760 indicate the success of the merge.17611762mergetool.meld.hasOutput::1763 Older versions of `meld` do not support the `--output` option.1764 Git will attempt to detect whether `meld` supports `--output`1765 by inspecting the output of `meld --help`. Configuring1766 `mergetool.meld.hasOutput` will make Git skip these checks and1767 use the configured value instead. Setting `mergetool.meld.hasOutput`1768 to `true` tells Git to unconditionally use the `--output` option,1769 and `false` avoids using `--output`.17701771mergetool.keepBackup::1772 After performing a merge, the original file with conflict markers1773 can be saved as a file with a `.orig` extension. If this variable1774 is set to `false` then this file is not preserved. Defaults to1775 `true` (i.e. keep the backup files).17761777mergetool.keepTemporaries::1778 When invoking a custom merge tool, Git uses a set of temporary1779 files to pass to the tool. If the tool returns an error and this1780 variable is set to `true`, then these temporary files will be1781 preserved, otherwise they will be removed after the tool has1782 exited. Defaults to `false`.17831784mergetool.prompt::1785 Prompt before each invocation of the merge resolution program.17861787notes.displayRef::1788 The (fully qualified) refname from which to show notes when1789 showing commit messages. The value of this variable can be set1790 to a glob, in which case notes from all matching refs will be1791 shown. You may also specify this configuration variable1792 several times. A warning will be issued for refs that do not1793 exist, but a glob that does not match any refs is silently1794 ignored.1795+1796This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`1797environment variable, which must be a colon separated list of refs or1798globs.1799+1800The effective value of "core.notesRef" (possibly overridden by1801GIT_NOTES_REF) is also implicitly added to the list of refs to be1802displayed.18031804notes.rewrite.<command>::1805 When rewriting commits with <command> (currently `amend` or1806 `rebase`) and this variable is set to `true`, Git1807 automatically copies your notes from the original to the1808 rewritten commit. Defaults to `true`, but see1809 "notes.rewriteRef" below.18101811notes.rewriteMode::1812 When copying notes during a rewrite (see the1813 "notes.rewrite.<command>" option), determines what to do if1814 the target commit already has a note. Must be one of1815 `overwrite`, `concatenate`, or `ignore`. Defaults to1816 `concatenate`.1817+1818This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`1819environment variable.18201821notes.rewriteRef::1822 When copying notes during a rewrite, specifies the (fully1823 qualified) ref whose notes should be copied. The ref may be a1824 glob, in which case notes in all matching refs will be copied.1825 You may also specify this configuration several times.1826+1827Does not have a default value; you must configure this variable to1828enable note rewriting. Set it to `refs/notes/commits` to enable1829rewriting for the default commit notes.1830+1831This setting can be overridden with the `GIT_NOTES_REWRITE_REF`1832environment variable, which must be a colon separated list of refs or1833globs.18341835pack.window::1836 The size of the window used by linkgit:git-pack-objects[1] when no1837 window size is given on the command line. Defaults to 10.18381839pack.depth::1840 The maximum delta depth used by linkgit:git-pack-objects[1] when no1841 maximum depth is given on the command line. Defaults to 50.18421843pack.windowMemory::1844 The window memory size limit used by linkgit:git-pack-objects[1]1845 when no limit is given on the command line. The value can be1846 suffixed with "k", "m", or "g". Defaults to 0, meaning no1847 limit.18481849pack.compression::1850 An integer -1..9, indicating the compression level for objects1851 in a pack file. -1 is the zlib default. 0 means no1852 compression, and 1..9 are various speed/size tradeoffs, 9 being1853 slowest. If not set, defaults to core.compression. If that is1854 not set, defaults to -1, the zlib default, which is "a default1855 compromise between speed and compression (currently equivalent1856 to level 6)."1857+1858Note that changing the compression level will not automatically recompress1859all existing objects. You can force recompression by passing the -F option1860to linkgit:git-repack[1].18611862pack.deltaCacheSize::1863 The maximum memory in bytes used for caching deltas in1864 linkgit:git-pack-objects[1] before writing them out to a pack.1865 This cache is used to speed up the writing object phase by not1866 having to recompute the final delta result once the best match1867 for all objects is found. Repacking large repositories on machines1868 which are tight with memory might be badly impacted by this though,1869 especially if this cache pushes the system into swapping.1870 A value of 0 means no limit. The smallest size of 1 byte may be1871 used to virtually disable this cache. Defaults to 256 MiB.18721873pack.deltaCacheLimit::1874 The maximum size of a delta, that is cached in1875 linkgit:git-pack-objects[1]. This cache is used to speed up the1876 writing object phase by not having to recompute the final delta1877 result once the best match for all objects is found. Defaults to 1000.18781879pack.threads::1880 Specifies the number of threads to spawn when searching for best1881 delta matches. This requires that linkgit:git-pack-objects[1]1882 be compiled with pthreads otherwise this option is ignored with a1883 warning. This is meant to reduce packing time on multiprocessor1884 machines. The required amount of memory for the delta search window1885 is however multiplied by the number of threads.1886 Specifying 0 will cause Git to auto-detect the number of CPU's1887 and set the number of threads accordingly.18881889pack.indexVersion::1890 Specify the default pack index version. Valid values are 1 for1891 legacy pack index used by Git versions prior to 1.5.2, and 2 for1892 the new pack index with capabilities for packs larger than 4 GB1893 as well as proper protection against the repacking of corrupted1894 packs. Version 2 is the default. Note that version 2 is enforced1895 and this config option ignored whenever the corresponding pack is1896 larger than 2 GB.1897+1898If you have an old Git that does not understand the version 2 `*.idx` file,1899cloning or fetching over a non native protocol (e.g. "http" and "rsync")1900that will copy both `*.pack` file and corresponding `*.idx` file from the1901other side may give you a repository that cannot be accessed with your1902older version of Git. If the `*.pack` file is smaller than 2 GB, however,1903you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1904the `*.idx` file.19051906pack.packSizeLimit::1907 The maximum size of a pack. This setting only affects1908 packing to a file when repacking, i.e. the git:// protocol1909 is unaffected. It can be overridden by the `--max-pack-size`1910 option of linkgit:git-repack[1]. The minimum size allowed is1911 limited to 1 MiB. The default is unlimited.1912 Common unit suffixes of 'k', 'm', or 'g' are1913 supported.19141915pack.useBitmaps::1916 When true, git will use pack bitmaps (if available) when packing1917 to stdout (e.g., during the server side of a fetch). Defaults to1918 true. You should not generally need to turn this off unless1919 you are debugging pack bitmaps.19201921pack.writebitmaps::1922 This is a deprecated synonym for `repack.writeBitmaps`.19231924pack.writeBitmapHashCache::1925 When true, git will include a "hash cache" section in the bitmap1926 index (if one is written). This cache can be used to feed git's1927 delta heuristics, potentially leading to better deltas between1928 bitmapped and non-bitmapped objects (e.g., when serving a fetch1929 between an older, bitmapped pack and objects that have been1930 pushed since the last gc). The downside is that it consumes 41931 bytes per object of disk space, and that JGit's bitmap1932 implementation does not understand it, causing it to complain if1933 Git and JGit are used on the same repository. Defaults to false.19341935pager.<cmd>::1936 If the value is boolean, turns on or off pagination of the1937 output of a particular Git subcommand when writing to a tty.1938 Otherwise, turns on pagination for the subcommand using the1939 pager specified by the value of `pager.<cmd>`. If `--paginate`1940 or `--no-pager` is specified on the command line, it takes1941 precedence over this option. To disable pagination for all1942 commands, set `core.pager` or `GIT_PAGER` to `cat`.19431944pretty.<name>::1945 Alias for a --pretty= format string, as specified in1946 linkgit:git-log[1]. Any aliases defined here can be used just1947 as the built-in pretty formats could. For example,1948 running `git config pretty.changelog "format:* %H %s"`1949 would cause the invocation `git log --pretty=changelog`1950 to be equivalent to running `git log "--pretty=format:* %H %s"`.1951 Note that an alias with the same name as a built-in format1952 will be silently ignored.19531954pull.ff::1955 By default, Git does not create an extra merge commit when merging1956 a commit that is a descendant of the current commit. Instead, the1957 tip of the current branch is fast-forwarded. When set to `false`,1958 this variable tells Git to create an extra merge commit in such1959 a case (equivalent to giving the `--no-ff` option from the command1960 line). When set to `only`, only such fast-forward merges are1961 allowed (equivalent to giving the `--ff-only` option from the1962 command line).19631964pull.rebase::1965 When true, rebase branches on top of the fetched branch, instead1966 of merging the default branch from the default remote when "git1967 pull" is run. See "branch.<name>.rebase" for setting this on a1968 per-branch basis.1969+1970 When preserve, also pass `--preserve-merges` along to 'git rebase'1971 so that locally committed merge commits will not be flattened1972 by running 'git pull'.1973+1974*NOTE*: this is a possibly dangerous operation; do *not* use1975it unless you understand the implications (see linkgit:git-rebase[1]1976for details).19771978pull.octopus::1979 The default merge strategy to use when pulling multiple branches1980 at once.19811982pull.twohead::1983 The default merge strategy to use when pulling a single branch.19841985push.default::1986 Defines the action `git push` should take if no refspec is1987 explicitly given. Different values are well-suited for1988 specific workflows; for instance, in a purely central workflow1989 (i.e. the fetch source is equal to the push destination),1990 `upstream` is probably what you want. Possible values are:1991+1992--19931994* `nothing` - do not push anything (error out) unless a refspec is1995 explicitly given. This is primarily meant for people who want to1996 avoid mistakes by always being explicit.19971998* `current` - push the current branch to update a branch with the same1999 name on the receiving end. Works in both central and non-central2000 workflows.20012002* `upstream` - push the current branch back to the branch whose2003 changes are usually integrated into the current branch (which is2004 called `@{upstream}`). This mode only makes sense if you are2005 pushing to the same repository you would normally pull from2006 (i.e. central workflow).20072008* `simple` - in centralized workflow, work like `upstream` with an2009 added safety to refuse to push if the upstream branch's name is2010 different from the local one.2011+2012When pushing to a remote that is different from the remote you normally2013pull from, work as `current`. This is the safest option and is suited2014for beginners.2015+2016This mode has become the default in Git 2.0.20172018* `matching` - push all branches having the same name on both ends.2019 This makes the repository you are pushing to remember the set of2020 branches that will be pushed out (e.g. if you always push 'maint'2021 and 'master' there and no other branches, the repository you push2022 to will have these two branches, and your local 'maint' and2023 'master' will be pushed there).2024+2025To use this mode effectively, you have to make sure _all_ the2026branches you would push out are ready to be pushed out before2027running 'git push', as the whole point of this mode is to allow you2028to push all of the branches in one go. If you usually finish work2029on only one branch and push out the result, while other branches are2030unfinished, this mode is not for you. Also this mode is not2031suitable for pushing into a shared central repository, as other2032people may add new branches there, or update the tip of existing2033branches outside your control.2034+2035This used to be the default, but not since Git 2.0 (`simple` is the2036new default).20372038--20392040rebase.stat::2041 Whether to show a diffstat of what changed upstream since the last2042 rebase. False by default.20432044rebase.autosquash::2045 If set to true enable '--autosquash' option by default.20462047rebase.autostash::2048 When set to true, automatically create a temporary stash2049 before the operation begins, and apply it after the operation2050 ends. This means that you can run rebase on a dirty worktree.2051 However, use with care: the final stash application after a2052 successful rebase might result in non-trivial conflicts.2053 Defaults to false.20542055receive.autogc::2056 By default, git-receive-pack will run "git-gc --auto" after2057 receiving data from git-push and updating refs. You can stop2058 it by setting this variable to false.20592060receive.fsckObjects::2061 If it is set to true, git-receive-pack will check all received2062 objects. It will abort in the case of a malformed object or a2063 broken link. The result of an abort are only dangling objects.2064 Defaults to false. If not set, the value of `transfer.fsckObjects`2065 is used instead.20662067receive.unpackLimit::2068 If the number of objects received in a push is below this2069 limit then the objects will be unpacked into loose object2070 files. However if the number of received objects equals or2071 exceeds this limit then the received pack will be stored as2072 a pack, after adding any missing delta bases. Storing the2073 pack from a push can make the push operation complete faster,2074 especially on slow filesystems. If not set, the value of2075 `transfer.unpackLimit` is used instead.20762077receive.denyDeletes::2078 If set to true, git-receive-pack will deny a ref update that deletes2079 the ref. Use this to prevent such a ref deletion via a push.20802081receive.denyDeleteCurrent::2082 If set to true, git-receive-pack will deny a ref update that2083 deletes the currently checked out branch of a non-bare repository.20842085receive.denyCurrentBranch::2086 If set to true or "refuse", git-receive-pack will deny a ref update2087 to the currently checked out branch of a non-bare repository.2088 Such a push is potentially dangerous because it brings the HEAD2089 out of sync with the index and working tree. If set to "warn",2090 print a warning of such a push to stderr, but allow the push to2091 proceed. If set to false or "ignore", allow such pushes with no2092 message. Defaults to "refuse".20932094receive.denyNonFastForwards::2095 If set to true, git-receive-pack will deny a ref update which is2096 not a fast-forward. Use this to prevent such an update via a push,2097 even if that push is forced. This configuration variable is2098 set when initializing a shared repository.20992100receive.hiderefs::2101 String(s) `receive-pack` uses to decide which refs to omit2102 from its initial advertisement. Use more than one2103 definitions to specify multiple prefix strings. A ref that2104 are under the hierarchies listed on the value of this2105 variable is excluded, and is hidden when responding to `git2106 push`, and an attempt to update or delete a hidden ref by2107 `git push` is rejected.21082109receive.updateserverinfo::2110 If set to true, git-receive-pack will run git-update-server-info2111 after receiving data from git-push and updating refs.21122113receive.shallowupdate::2114 If set to true, .git/shallow can be updated when new refs2115 require new shallow roots. Otherwise those refs are rejected.21162117remote.pushdefault::2118 The remote to push to by default. Overrides2119 `branch.<name>.remote` for all branches, and is overridden by2120 `branch.<name>.pushremote` for specific branches.21212122remote.<name>.url::2123 The URL of a remote repository. See linkgit:git-fetch[1] or2124 linkgit:git-push[1].21252126remote.<name>.pushurl::2127 The push URL of a remote repository. See linkgit:git-push[1].21282129remote.<name>.proxy::2130 For remotes that require curl (http, https and ftp), the URL to2131 the proxy to use for that remote. Set to the empty string to2132 disable proxying for that remote.21332134remote.<name>.fetch::2135 The default set of "refspec" for linkgit:git-fetch[1]. See2136 linkgit:git-fetch[1].21372138remote.<name>.push::2139 The default set of "refspec" for linkgit:git-push[1]. See2140 linkgit:git-push[1].21412142remote.<name>.mirror::2143 If true, pushing to this remote will automatically behave2144 as if the `--mirror` option was given on the command line.21452146remote.<name>.skipDefaultUpdate::2147 If true, this remote will be skipped by default when updating2148 using linkgit:git-fetch[1] or the `update` subcommand of2149 linkgit:git-remote[1].21502151remote.<name>.skipFetchAll::2152 If true, this remote will be skipped by default when updating2153 using linkgit:git-fetch[1] or the `update` subcommand of2154 linkgit:git-remote[1].21552156remote.<name>.receivepack::2157 The default program to execute on the remote side when pushing. See2158 option \--receive-pack of linkgit:git-push[1].21592160remote.<name>.uploadpack::2161 The default program to execute on the remote side when fetching. See2162 option \--upload-pack of linkgit:git-fetch-pack[1].21632164remote.<name>.tagopt::2165 Setting this value to \--no-tags disables automatic tag following when2166 fetching from remote <name>. Setting it to \--tags will fetch every2167 tag from remote <name>, even if they are not reachable from remote2168 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2169 override this setting. See options \--tags and \--no-tags of2170 linkgit:git-fetch[1].21712172remote.<name>.vcs::2173 Setting this to a value <vcs> will cause Git to interact with2174 the remote with the git-remote-<vcs> helper.21752176remote.<name>.prune::2177 When set to true, fetching from this remote by default will also2178 remove any remote-tracking references that no longer exist on the2179 remote (as if the `--prune` option was given on the command line).2180 Overrides `fetch.prune` settings, if any.21812182remotes.<group>::2183 The list of remotes which are fetched by "git remote update2184 <group>". See linkgit:git-remote[1].21852186repack.usedeltabaseoffset::2187 By default, linkgit:git-repack[1] creates packs that use2188 delta-base offset. If you need to share your repository with2189 Git older than version 1.4.4, either directly or via a dumb2190 protocol such as http, then you need to set this option to2191 "false" and repack. Access from old Git versions over the2192 native protocol are unaffected by this option.21932194repack.packKeptObjects::2195 If set to true, makes `git repack` act as if2196 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2197 details. Defaults to `false` normally, but `true` if a bitmap2198 index is being written (either via `--write-bitmap-index` or2199 `repack.writeBitmaps`).22002201repack.writeBitmaps::2202 When true, git will write a bitmap index when packing all2203 objects to disk (e.g., when `git repack -a` is run). This2204 index can speed up the "counting objects" phase of subsequent2205 packs created for clones and fetches, at the cost of some disk2206 space and extra time spent on the initial repack. Defaults to2207 false.22082209rerere.autoupdate::2210 When set to true, `git-rerere` updates the index with the2211 resulting contents after it cleanly resolves conflicts using2212 previously recorded resolution. Defaults to false.22132214rerere.enabled::2215 Activate recording of resolved conflicts, so that identical2216 conflict hunks can be resolved automatically, should they be2217 encountered again. By default, linkgit:git-rerere[1] is2218 enabled if there is an `rr-cache` directory under the2219 `$GIT_DIR`, e.g. if "rerere" was previously used in the2220 repository.22212222sendemail.identity::2223 A configuration identity. When given, causes values in the2224 'sendemail.<identity>' subsection to take precedence over2225 values in the 'sendemail' section. The default identity is2226 the value of 'sendemail.identity'.22272228sendemail.smtpencryption::2229 See linkgit:git-send-email[1] for description. Note that this2230 setting is not subject to the 'identity' mechanism.22312232sendemail.smtpssl::2233 Deprecated alias for 'sendemail.smtpencryption = ssl'.22342235sendemail.smtpsslcertpath::2236 Path to ca-certificates (either a directory or a single file).2237 Set it to an empty string to disable certificate verification.22382239sendemail.<identity>.*::2240 Identity-specific versions of the 'sendemail.*' parameters2241 found below, taking precedence over those when the this2242 identity is selected, through command-line or2243 'sendemail.identity'.22442245sendemail.aliasesfile::2246sendemail.aliasfiletype::2247sendemail.annotate::2248sendemail.bcc::2249sendemail.cc::2250sendemail.cccmd::2251sendemail.chainreplyto::2252sendemail.confirm::2253sendemail.envelopesender::2254sendemail.from::2255sendemail.multiedit::2256sendemail.signedoffbycc::2257sendemail.smtppass::2258sendemail.suppresscc::2259sendemail.suppressfrom::2260sendemail.to::2261sendemail.smtpdomain::2262sendemail.smtpserver::2263sendemail.smtpserverport::2264sendemail.smtpserveroption::2265sendemail.smtpuser::2266sendemail.thread::2267sendemail.validate::2268 See linkgit:git-send-email[1] for description.22692270sendemail.signedoffcc::2271 Deprecated alias for 'sendemail.signedoffbycc'.22722273showbranch.default::2274 The default set of branches for linkgit:git-show-branch[1].2275 See linkgit:git-show-branch[1].22762277status.relativePaths::2278 By default, linkgit:git-status[1] shows paths relative to the2279 current directory. Setting this variable to `false` shows paths2280 relative to the repository root (this was the default for Git2281 prior to v1.5.4).22822283status.short::2284 Set to true to enable --short by default in linkgit:git-status[1].2285 The option --no-short takes precedence over this variable.22862287status.branch::2288 Set to true to enable --branch by default in linkgit:git-status[1].2289 The option --no-branch takes precedence over this variable.22902291status.displayCommentPrefix::2292 If set to true, linkgit:git-status[1] will insert a comment2293 prefix before each output line (starting with2294 `core.commentChar`, i.e. `#` by default). This was the2295 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.2296 Defaults to false.22972298status.showUntrackedFiles::2299 By default, linkgit:git-status[1] and linkgit:git-commit[1] show2300 files which are not currently tracked by Git. Directories which2301 contain only untracked files, are shown with the directory name2302 only. Showing untracked files means that Git needs to lstat() all2303 the files in the whole repository, which might be slow on some2304 systems. So, this variable controls how the commands displays2305 the untracked files. Possible values are:2306+2307--2308* `no` - Show no untracked files.2309* `normal` - Show untracked files and directories.2310* `all` - Show also individual files in untracked directories.2311--2312+2313If this variable is not specified, it defaults to 'normal'.2314This variable can be overridden with the -u|--untracked-files option2315of linkgit:git-status[1] and linkgit:git-commit[1].23162317status.submodulesummary::2318 Defaults to false.2319 If this is set to a non zero number or true (identical to -1 or an2320 unlimited number), the submodule summary will be enabled and a2321 summary of commits for modified submodules will be shown (see2322 --summary-limit option of linkgit:git-submodule[1]). Please note2323 that the summary output command will be suppressed for all2324 submodules when `diff.ignoreSubmodules` is set to 'all' or only2325 for those submodules where `submodule.<name>.ignore=all`. The only2326 exception to that rule is that status and commit will show staged2327 submodule changes. To2328 also view the summary for ignored submodules you can either use2329 the --ignore-submodules=dirty command-line option or the 'git2330 submodule summary' command, which shows a similar output but does2331 not honor these settings.23322333submodule.<name>.path::2334submodule.<name>.url::2335submodule.<name>.update::2336 The path within this project, URL, and the updating strategy2337 for a submodule. These variables are initially populated2338 by 'git submodule init'; edit them to override the2339 URL and other values found in the `.gitmodules` file. See2340 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.23412342submodule.<name>.branch::2343 The remote branch name for a submodule, used by `git submodule2344 update --remote`. Set this option to override the value found in2345 the `.gitmodules` file. See linkgit:git-submodule[1] and2346 linkgit:gitmodules[5] for details.23472348submodule.<name>.fetchRecurseSubmodules::2349 This option can be used to control recursive fetching of this2350 submodule. It can be overridden by using the --[no-]recurse-submodules2351 command-line option to "git fetch" and "git pull".2352 This setting will override that from in the linkgit:gitmodules[5]2353 file.23542355submodule.<name>.ignore::2356 Defines under what circumstances "git status" and the diff family show2357 a submodule as modified. When set to "all", it will never be considered2358 modified (but it will nonetheless show up in the output of status and2359 commit when it has been staged), "dirty" will ignore all changes2360 to the submodules work tree and2361 takes only differences between the HEAD of the submodule and the commit2362 recorded in the superproject into account. "untracked" will additionally2363 let submodules with modified tracked files in their work tree show up.2364 Using "none" (the default when this option is not set) also shows2365 submodules that have untracked files in their work tree as changed.2366 This setting overrides any setting made in .gitmodules for this submodule,2367 both settings can be overridden on the command line by using the2368 "--ignore-submodules" option. The 'git submodule' commands are not2369 affected by this setting.23702371tag.sort::2372 This variable controls the sort ordering of tags when displayed by2373 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the2374 value of this variable will be used as the default.23752376tar.umask::2377 This variable can be used to restrict the permission bits of2378 tar archive entries. The default is 0002, which turns off the2379 world write bit. The special value "user" indicates that the2380 archiving user's umask will be used instead. See umask(2) and2381 linkgit:git-archive[1].23822383transfer.fsckObjects::2384 When `fetch.fsckObjects` or `receive.fsckObjects` are2385 not set, the value of this variable is used instead.2386 Defaults to false.23872388transfer.hiderefs::2389 This variable can be used to set both `receive.hiderefs`2390 and `uploadpack.hiderefs` at the same time to the same2391 values. See entries for these other variables.23922393transfer.unpackLimit::2394 When `fetch.unpackLimit` or `receive.unpackLimit` are2395 not set, the value of this variable is used instead.2396 The default value is 100.23972398uploadarchive.allowUnreachable::2399 If true, allow clients to use `git archive --remote` to request2400 any tree, whether reachable from the ref tips or not. See the2401 discussion in the `SECURITY` section of2402 linkgit:git-upload-archive[1] for more details. Defaults to2403 `false`.24042405uploadpack.hiderefs::2406 String(s) `upload-pack` uses to decide which refs to omit2407 from its initial advertisement. Use more than one2408 definitions to specify multiple prefix strings. A ref that2409 are under the hierarchies listed on the value of this2410 variable is excluded, and is hidden from `git ls-remote`,2411 `git fetch`, etc. An attempt to fetch a hidden ref by `git2412 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.24132414uploadpack.allowtipsha1inwant::2415 When `uploadpack.hiderefs` is in effect, allow `upload-pack`2416 to accept a fetch request that asks for an object at the tip2417 of a hidden ref (by default, such a request is rejected).2418 see also `uploadpack.hiderefs`.24192420uploadpack.keepalive::2421 When `upload-pack` has started `pack-objects`, there may be a2422 quiet period while `pack-objects` prepares the pack. Normally2423 it would output progress information, but if `--quiet` was used2424 for the fetch, `pack-objects` will output nothing at all until2425 the pack data begins. Some clients and networks may consider2426 the server to be hung and give up. Setting this option instructs2427 `upload-pack` to send an empty keepalive packet every2428 `uploadpack.keepalive` seconds. Setting this option to 02429 disables keepalive packets entirely. The default is 5 seconds.24302431url.<base>.insteadOf::2432 Any URL that starts with this value will be rewritten to2433 start, instead, with <base>. In cases where some site serves a2434 large number of repositories, and serves them with multiple2435 access methods, and some users need to use different access2436 methods, this feature allows people to specify any of the2437 equivalent URLs and have Git automatically rewrite the URL to2438 the best alternative for the particular user, even for a2439 never-before-seen repository on the site. When more than one2440 insteadOf strings match a given URL, the longest match is used.24412442url.<base>.pushInsteadOf::2443 Any URL that starts with this value will not be pushed to;2444 instead, it will be rewritten to start with <base>, and the2445 resulting URL will be pushed to. In cases where some site serves2446 a large number of repositories, and serves them with multiple2447 access methods, some of which do not allow push, this feature2448 allows people to specify a pull-only URL and have Git2449 automatically use an appropriate URL to push, even for a2450 never-before-seen repository on the site. When more than one2451 pushInsteadOf strings match a given URL, the longest match is2452 used. If a remote has an explicit pushurl, Git will ignore this2453 setting for that remote.24542455user.email::2456 Your email address to be recorded in any newly created commits.2457 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and2458 'EMAIL' environment variables. See linkgit:git-commit-tree[1].24592460user.name::2461 Your full name to be recorded in any newly created commits.2462 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'2463 environment variables. See linkgit:git-commit-tree[1].24642465user.signingkey::2466 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the2467 key you want it to automatically when creating a signed tag or2468 commit, you can override the default selection with this variable.2469 This option is passed unchanged to gpg's --local-user parameter,2470 so you may specify a key using any method that gpg supports.24712472web.browser::2473 Specify a web browser that may be used by some commands.2474 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]2475 may use it.