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). No other char escape sequence, nor octal 82char sequences are valid. 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. You will find a description of non-core 135porcelain configuration variables in the respective porcelain documentation. 136 137advice.*:: 138 These variables control various optional help messages designed to 139 aid new users. All 'advice.*' variables default to 'true', and you 140 can tell Git that you do not need help by setting these to 'false': 141+ 142-- 143 pushUpdateRejected:: 144 Set this variable to 'false' if you want to disable 145 'pushNonFFCurrent', 'pushNonFFDefault', 146 'pushNonFFMatching', 'pushAlreadyExists', 147 'pushFetchFirst', and 'pushNeedsForce' 148 simultaneously. 149 pushNonFFCurrent:: 150 Advice shown when linkgit:git-push[1] fails due to a 151 non-fast-forward update to the current branch. 152 pushNonFFDefault:: 153 Advice to set 'push.default' to 'upstream' or 'current' 154 when you ran linkgit:git-push[1] and pushed 'matching 155 refs' by default (i.e. you did not provide an explicit 156 refspec, and no 'push.default' configuration was set) 157 and it resulted in a non-fast-forward error. 158 pushNonFFMatching:: 159 Advice shown when you ran linkgit:git-push[1] and pushed 160 'matching refs' explicitly (i.e. you used ':', or 161 specified a refspec that isn't your current branch) and 162 it resulted in a non-fast-forward error. 163 pushAlreadyExists:: 164 Shown when linkgit:git-push[1] rejects an update that 165 does not qualify for fast-forwarding (e.g., a tag.) 166 pushFetchFirst:: 167 Shown when linkgit:git-push[1] rejects an update that 168 tries to overwrite a remote ref that points at an 169 object we do not have. 170 pushNeedsForce:: 171 Shown when linkgit:git-push[1] rejects an update that 172 tries to overwrite a remote ref that points at an 173 object that is not a committish, or make the remote 174 ref point at an object that is not a committish. 175 statusHints:: 176 Show directions on how to proceed from the current 177 state in the output of linkgit:git-status[1], in 178 the template shown when writing commit messages in 179 linkgit:git-commit[1], and in the help message shown 180 by linkgit:git-checkout[1] when switching branch. 181 statusUoption:: 182 Advise to consider using the `-u` option to linkgit:git-status[1] 183 when the command takes more than 2 seconds to enumerate untracked 184 files. 185 commitBeforeMerge:: 186 Advice shown when linkgit:git-merge[1] refuses to 187 merge to avoid overwriting local changes. 188 resolveConflict:: 189 Advice shown by various commands when conflicts 190 prevent the operation from being performed. 191 implicitIdentity:: 192 Advice on how to set your identity configuration when 193 your information is guessed from the system username and 194 domain name. 195 detachedHead:: 196 Advice shown when you used linkgit:git-checkout[1] to 197 move to the detach HEAD state, to instruct how to create 198 a local branch after the fact. 199 amWorkDir:: 200 Advice that shows the location of the patch file when 201 linkgit:git-am[1] fails to apply it. 202 rmHints:: 203 In case of failure in the output of linkgit:git-rm[1], 204 show directions on how to proceed from the current state. 205-- 206 207core.fileMode:: 208 If false, the executable bit differences between the index and 209 the working tree are ignored; useful on broken filesystems like FAT. 210 See linkgit:git-update-index[1]. 211+ 212The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 213will probe and set core.fileMode false if appropriate when the 214repository is created. 215 216core.ignoreCygwinFSTricks:: 217 This option is only used by Cygwin implementation of Git. If false, 218 the Cygwin stat() and lstat() functions are used. This may be useful 219 if your repository consists of a few separate directories joined in 220 one hierarchy using Cygwin mount. If true, Git uses native Win32 API 221 whenever it is possible and falls back to Cygwin functions only to 222 handle symbol links. The native mode is more than twice faster than 223 normal Cygwin l/stat() functions. True by default, unless core.filemode 224 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's 225 POSIX emulation is required to support core.filemode. 226 227core.ignorecase:: 228 If true, this option enables various workarounds to enable 229 Git to work better on filesystems that are not case sensitive, 230 like FAT. For example, if a directory listing finds 231 "makefile" when Git expects "Makefile", Git will assume 232 it is really the same file, and continue to remember it as 233 "Makefile". 234+ 235The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 236will probe and set core.ignorecase true if appropriate when the repository 237is created. 238 239core.precomposeunicode:: 240 This option is only used by Mac OS implementation of Git. 241 When core.precomposeunicode=true, Git reverts the unicode decomposition 242 of filenames done by Mac OS. This is useful when sharing a repository 243 between Mac OS and Linux or Windows. 244 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 245 When false, file names are handled fully transparent by Git, 246 which is backward compatible with older versions of Git. 247 248core.trustctime:: 249 If false, the ctime differences between the index and the 250 working tree are ignored; useful when the inode change time 251 is regularly modified by something outside Git (file system 252 crawlers and some backup systems). 253 See linkgit:git-update-index[1]. True by default. 254 255core.checkstat:: 256 Determines which stat fields to match between the index 257 and work tree. The user can set this to 'default' or 258 'minimal'. Default (or explicitly 'default'), is to check 259 all fields, including the sub-second part of mtime and ctime. 260 261core.quotepath:: 262 The commands that output paths (e.g. 'ls-files', 263 'diff'), when not given the `-z` option, will quote 264 "unusual" characters in the pathname by enclosing the 265 pathname in a double-quote pair and with backslashes the 266 same way strings in C source code are quoted. If this 267 variable is set to false, the bytes higher than 0x80 are 268 not quoted but output as verbatim. Note that double 269 quote, backslash and control characters are always 270 quoted without `-z` regardless of the setting of this 271 variable. 272 273core.eol:: 274 Sets the line ending type to use in the working directory for 275 files that have the `text` property set. Alternatives are 276 'lf', 'crlf' and 'native', which uses the platform's native 277 line ending. The default value is `native`. See 278 linkgit:gitattributes[5] for more information on end-of-line 279 conversion. 280 281core.safecrlf:: 282 If true, makes Git check if converting `CRLF` is reversible when 283 end-of-line conversion is active. Git will verify if a command 284 modifies a file in the work tree either directly or indirectly. 285 For example, committing a file followed by checking out the 286 same file should yield the original file in the work tree. If 287 this is not the case for the current setting of 288 `core.autocrlf`, Git will reject the file. The variable can 289 be set to "warn", in which case Git will only warn about an 290 irreversible conversion but continue the operation. 291+ 292CRLF conversion bears a slight chance of corrupting data. 293When it is enabled, Git will convert CRLF to LF during commit and LF to 294CRLF during checkout. A file that contains a mixture of LF and 295CRLF before the commit cannot be recreated by Git. For text 296files this is the right thing to do: it corrects line endings 297such that we have only LF line endings in the repository. 298But for binary files that are accidentally classified as text the 299conversion can corrupt data. 300+ 301If you recognize such corruption early you can easily fix it by 302setting the conversion type explicitly in .gitattributes. Right 303after committing you still have the original file in your work 304tree and this file is not yet corrupted. You can explicitly tell 305Git that this file is binary and Git will handle the file 306appropriately. 307+ 308Unfortunately, the desired effect of cleaning up text files with 309mixed line endings and the undesired effect of corrupting binary 310files cannot be distinguished. In both cases CRLFs are removed 311in an irreversible way. For text files this is the right thing 312to do because CRLFs are line endings, while for binary files 313converting CRLFs corrupts data. 314+ 315Note, this safety check does not mean that a checkout will generate a 316file identical to the original file for a different setting of 317`core.eol` and `core.autocrlf`, but only for the current one. For 318example, a text file with `LF` would be accepted with `core.eol=lf` 319and could later be checked out with `core.eol=crlf`, in which case the 320resulting file would contain `CRLF`, although the original file 321contained `LF`. However, in both work trees the line endings would be 322consistent, that is either all `LF` or all `CRLF`, but never mixed. A 323file with mixed line endings would be reported by the `core.safecrlf` 324mechanism. 325 326core.autocrlf:: 327 Setting this variable to "true" is almost the same as setting 328 the `text` attribute to "auto" on all files except that text 329 files are not guaranteed to be normalized: files that contain 330 `CRLF` in the repository will not be touched. Use this 331 setting if you want to have `CRLF` line endings in your 332 working directory even though the repository does not have 333 normalized line endings. This variable can be set to 'input', 334 in which case no output conversion is performed. 335 336core.symlinks:: 337 If false, symbolic links are checked out as small plain files that 338 contain the link text. linkgit:git-update-index[1] and 339 linkgit:git-add[1] will not change the recorded type to regular 340 file. Useful on filesystems like FAT that do not support 341 symbolic links. 342+ 343The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 344will probe and set core.symlinks false if appropriate when the repository 345is created. 346 347core.gitProxy:: 348 A "proxy command" to execute (as 'command host port') instead 349 of establishing direct connection to the remote server when 350 using the Git protocol for fetching. If the variable value is 351 in the "COMMAND for DOMAIN" format, the command is applied only 352 on hostnames ending with the specified domain string. This variable 353 may be set multiple times and is matched in the given order; 354 the first match wins. 355+ 356Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 357(which always applies universally, without the special "for" 358handling). 359+ 360The special string `none` can be used as the proxy command to 361specify that no proxy be used for a given domain pattern. 362This is useful for excluding servers inside a firewall from 363proxy use, while defaulting to a common proxy for external domains. 364 365core.ignoreStat:: 366 If true, commands which modify both the working tree and the index 367 will mark the updated paths with the "assume unchanged" bit in the 368 index. These marked files are then assumed to stay unchanged in the 369 working tree, until you mark them otherwise manually - Git will not 370 detect the file changes by lstat() calls. This is useful on systems 371 where those are very slow, such as Microsoft Windows. 372 See linkgit:git-update-index[1]. 373 False by default. 374 375core.preferSymlinkRefs:: 376 Instead of the default "symref" format for HEAD 377 and other symbolic reference files, use symbolic links. 378 This is sometimes needed to work with old scripts that 379 expect HEAD to be a symbolic link. 380 381core.bare:: 382 If true this repository is assumed to be 'bare' and has no 383 working directory associated with it. If this is the case a 384 number of commands that require a working directory will be 385 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 386+ 387This setting is automatically guessed by linkgit:git-clone[1] or 388linkgit:git-init[1] when the repository was created. By default a 389repository that ends in "/.git" is assumed to be not bare (bare = 390false), while all other repositories are assumed to be bare (bare 391= true). 392 393core.worktree:: 394 Set the path to the root of the working tree. 395 This can be overridden by the GIT_WORK_TREE environment 396 variable and the '--work-tree' command line option. 397 The value can be an absolute path or relative to the path to 398 the .git directory, which is either specified by --git-dir 399 or GIT_DIR, or automatically discovered. 400 If --git-dir or GIT_DIR is specified but none of 401 --work-tree, GIT_WORK_TREE and core.worktree is specified, 402 the current working directory is regarded as the top level 403 of your working tree. 404+ 405Note that this variable is honored even when set in a configuration 406file in a ".git" subdirectory of a directory and its value differs 407from the latter directory (e.g. "/path/to/.git/config" has 408core.worktree set to "/different/path"), which is most likely a 409misconfiguration. Running Git commands in the "/path/to" directory will 410still use "/different/path" as the root of the work tree and can cause 411confusion unless you know what you are doing (e.g. you are creating a 412read-only snapshot of the same index to a location different from the 413repository's usual working tree). 414 415core.logAllRefUpdates:: 416 Enable the reflog. Updates to a ref <ref> is logged to the file 417 "$GIT_DIR/logs/<ref>", by appending the new and old 418 SHA-1, the date/time and the reason of the update, but 419 only when the file exists. If this configuration 420 variable is set to true, missing "$GIT_DIR/logs/<ref>" 421 file is automatically created for branch heads (i.e. under 422 refs/heads/), remote refs (i.e. under refs/remotes/), 423 note refs (i.e. under refs/notes/), and the symbolic ref HEAD. 424+ 425This information can be used to determine what commit 426was the tip of a branch "2 days ago". 427+ 428This value is true by default in a repository that has 429a working directory associated with it, and false by 430default in a bare repository. 431 432core.repositoryFormatVersion:: 433 Internal variable identifying the repository format and layout 434 version. 435 436core.sharedRepository:: 437 When 'group' (or 'true'), the repository is made shareable between 438 several users in a group (making sure all the files and objects are 439 group-writable). When 'all' (or 'world' or 'everybody'), the 440 repository will be readable by all users, additionally to being 441 group-shareable. When 'umask' (or 'false'), Git will use permissions 442 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 443 files in the repository will have this mode value. '0xxx' will override 444 user's umask value (whereas the other options will only override 445 requested parts of the user's umask value). Examples: '0660' will make 446 the repo read/write-able for the owner and group, but inaccessible to 447 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 448 repository that is group-readable but not group-writable. 449 See linkgit:git-init[1]. False by default. 450 451core.warnAmbiguousRefs:: 452 If true, Git will warn you if the ref name you passed it is ambiguous 453 and might match multiple refs in the repository. True by default. 454 455core.compression:: 456 An integer -1..9, indicating a default compression level. 457 -1 is the zlib default. 0 means no compression, 458 and 1..9 are various speed/size tradeoffs, 9 being slowest. 459 If set, this provides a default to other compression variables, 460 such as 'core.loosecompression' and 'pack.compression'. 461 462core.loosecompression:: 463 An integer -1..9, indicating the compression level for objects that 464 are not in a pack file. -1 is the zlib default. 0 means no 465 compression, and 1..9 are various speed/size tradeoffs, 9 being 466 slowest. If not set, defaults to core.compression. If that is 467 not set, defaults to 1 (best speed). 468 469core.packedGitWindowSize:: 470 Number of bytes of a pack file to map into memory in a 471 single mapping operation. Larger window sizes may allow 472 your system to process a smaller number of large pack files 473 more quickly. Smaller window sizes will negatively affect 474 performance due to increased calls to the operating system's 475 memory manager, but may improve performance when accessing 476 a large number of large pack files. 477+ 478Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 479MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 480be reasonable for all users/operating systems. You probably do 481not need to adjust this value. 482+ 483Common unit suffixes of 'k', 'm', or 'g' are supported. 484 485core.packedGitLimit:: 486 Maximum number of bytes to map simultaneously into memory 487 from pack files. If Git needs to access more than this many 488 bytes at once to complete an operation it will unmap existing 489 regions to reclaim virtual address space within the process. 490+ 491Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 492This should be reasonable for all users/operating systems, except on 493the largest projects. You probably do not need to adjust this value. 494+ 495Common unit suffixes of 'k', 'm', or 'g' are supported. 496 497core.deltaBaseCacheLimit:: 498 Maximum number of bytes to reserve for caching base objects 499 that may be referenced by multiple deltified objects. By storing the 500 entire decompressed base objects in a cache Git is able 501 to avoid unpacking and decompressing frequently used base 502 objects multiple times. 503+ 504Default is 16 MiB on all platforms. This should be reasonable 505for all users/operating systems, except on the largest projects. 506You probably do not need to adjust this value. 507+ 508Common unit suffixes of 'k', 'm', or 'g' are supported. 509 510core.bigFileThreshold:: 511 Files larger than this size are stored deflated, without 512 attempting delta compression. Storing large files without 513 delta compression avoids excessive memory usage, at the 514 slight expense of increased disk usage. 515+ 516Default is 512 MiB on all platforms. This should be reasonable 517for most projects as source code and other text files can still 518be delta compressed, but larger binary media files won't be. 519+ 520Common unit suffixes of 'k', 'm', or 'g' are supported. 521 522core.excludesfile:: 523 In addition to '.gitignore' (per-directory) and 524 '.git/info/exclude', Git looks into this file for patterns 525 of files which are not meant to be tracked. "`~/`" is expanded 526 to the value of `$HOME` and "`~user/`" to the specified user's 527 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore. 528 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore 529 is used instead. See linkgit:gitignore[5]. 530 531core.askpass:: 532 Some commands (e.g. svn and http interfaces) that interactively 533 ask for a password can be told to use an external program given 534 via the value of this variable. Can be overridden by the 'GIT_ASKPASS' 535 environment variable. If not set, fall back to the value of the 536 'SSH_ASKPASS' environment variable or, failing that, a simple password 537 prompt. The external program shall be given a suitable prompt as 538 command line argument and write the password on its STDOUT. 539 540core.attributesfile:: 541 In addition to '.gitattributes' (per-directory) and 542 '.git/info/attributes', Git looks into this file for attributes 543 (see linkgit:gitattributes[5]). Path expansions are made the same 544 way as for `core.excludesfile`. Its default value is 545 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not 546 set or empty, $HOME/.config/git/attributes is used instead. 547 548core.editor:: 549 Commands such as `commit` and `tag` that lets you edit 550 messages by launching an editor uses the value of this 551 variable when it is set, and the environment variable 552 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 553 554core.commentchar:: 555 Commands such as `commit` and `tag` that lets you edit 556 messages consider a line that begins with this character 557 commented, and removes them after the editor returns 558 (default '#'). 559 560sequence.editor:: 561 Text editor used by `git rebase -i` for editing the rebase instruction file. 562 The value is meant to be interpreted by the shell when it is used. 563 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 564 When not configured the default commit message editor is used instead. 565 566core.pager:: 567 The command that Git will use to paginate output. Can 568 be overridden with the `GIT_PAGER` environment 569 variable. Note that Git sets the `LESS` environment 570 variable to `FRSX` if it is unset when it runs the 571 pager. One can change these settings by setting the 572 `LESS` variable to some other value. Alternately, 573 these settings can be overridden on a project or 574 global basis by setting the `core.pager` option. 575 Setting `core.pager` has no effect on the `LESS` 576 environment variable behaviour above, so if you want 577 to override Git's default settings this way, you need 578 to be explicit. For example, to disable the S option 579 in a backward compatible manner, set `core.pager` 580 to `less -+S`. This will be passed to the shell by 581 Git, which will translate the final command to 582 `LESS=FRSX less -+S`. 583 584core.whitespace:: 585 A comma separated list of common whitespace problems to 586 notice. 'git diff' will use `color.diff.whitespace` to 587 highlight them, and 'git apply --whitespace=error' will 588 consider them as errors. You can prefix `-` to disable 589 any of them (e.g. `-trailing-space`): 590+ 591* `blank-at-eol` treats trailing whitespaces at the end of the line 592 as an error (enabled by default). 593* `space-before-tab` treats a space character that appears immediately 594 before a tab character in the initial indent part of the line as an 595 error (enabled by default). 596* `indent-with-non-tab` treats a line that is indented with space 597 characters instead of the equivalent tabs as an error (not enabled by 598 default). 599* `tab-in-indent` treats a tab character in the initial indent part of 600 the line as an error (not enabled by default). 601* `blank-at-eof` treats blank lines added at the end of file as an error 602 (enabled by default). 603* `trailing-space` is a short-hand to cover both `blank-at-eol` and 604 `blank-at-eof`. 605* `cr-at-eol` treats a carriage-return at the end of line as 606 part of the line terminator, i.e. with it, `trailing-space` 607 does not trigger if the character before such a carriage-return 608 is not a whitespace (not enabled by default). 609* `tabwidth=<n>` tells how many character positions a tab occupies; this 610 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 611 errors. The default tab width is 8. Allowed values are 1 to 63. 612 613core.fsyncobjectfiles:: 614 This boolean will enable 'fsync()' when writing object files. 615+ 616This is a total waste of time and effort on a filesystem that orders 617data writes properly, but can be useful for filesystems that do not use 618journalling (traditional UNIX filesystems) or that only journal metadata 619and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 620 621core.preloadindex:: 622 Enable parallel index preload for operations like 'git diff' 623+ 624This can speed up operations like 'git diff' and 'git status' especially 625on filesystems like NFS that have weak caching semantics and thus 626relatively high IO latencies. With this set to 'true', Git will do the 627index comparison to the filesystem data in parallel, allowing 628overlapping IO's. 629 630core.createObject:: 631 You can set this to 'link', in which case a hardlink followed by 632 a delete of the source are used to make sure that object creation 633 will not overwrite existing objects. 634+ 635On some file system/operating system combinations, this is unreliable. 636Set this config setting to 'rename' there; However, This will remove the 637check that makes sure that existing object files will not get overwritten. 638 639core.notesRef:: 640 When showing commit messages, also show notes which are stored in 641 the given ref. The ref must be fully qualified. If the given 642 ref does not exist, it is not an error but means that no 643 notes should be printed. 644+ 645This setting defaults to "refs/notes/commits", and it can be overridden by 646the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. 647 648core.sparseCheckout:: 649 Enable "sparse checkout" feature. See section "Sparse checkout" in 650 linkgit:git-read-tree[1] for more information. 651 652core.abbrev:: 653 Set the length object names are abbreviated to. If unspecified, 654 many commands abbreviate to 7 hexdigits, which may not be enough 655 for abbreviated object names to stay unique for sufficiently long 656 time. 657 658add.ignore-errors:: 659add.ignoreErrors:: 660 Tells 'git add' to continue adding files when some files cannot be 661 added due to indexing errors. Equivalent to the '--ignore-errors' 662 option of linkgit:git-add[1]. Older versions of Git accept only 663 `add.ignore-errors`, which does not follow the usual naming 664 convention for configuration variables. Newer versions of Git 665 honor `add.ignoreErrors` as well. 666 667alias.*:: 668 Command aliases for the linkgit:git[1] command wrapper - e.g. 669 after defining "alias.last = cat-file commit HEAD", the invocation 670 "git last" is equivalent to "git cat-file commit HEAD". To avoid 671 confusion and troubles with script usage, aliases that 672 hide existing Git commands are ignored. Arguments are split by 673 spaces, the usual shell quoting and escaping is supported. 674 quote pair and a backslash can be used to quote them. 675+ 676If the alias expansion is prefixed with an exclamation point, 677it will be treated as a shell command. For example, defining 678"alias.new = !gitk --all --not ORIG_HEAD", the invocation 679"git new" is equivalent to running the shell command 680"gitk --all --not ORIG_HEAD". Note that shell commands will be 681executed from the top-level directory of a repository, which may 682not necessarily be the current directory. 683'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix' 684from the original current directory. See linkgit:git-rev-parse[1]. 685 686am.keepcr:: 687 If true, git-am will call git-mailsplit for patches in mbox format 688 with parameter '--keep-cr'. In this case git-mailsplit will 689 not remove `\r` from lines ending with `\r\n`. Can be overridden 690 by giving '--no-keep-cr' from the command line. 691 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 692 693apply.ignorewhitespace:: 694 When set to 'change', tells 'git apply' to ignore changes in 695 whitespace, in the same way as the '--ignore-space-change' 696 option. 697 When set to one of: no, none, never, false tells 'git apply' to 698 respect all whitespace differences. 699 See linkgit:git-apply[1]. 700 701apply.whitespace:: 702 Tells 'git apply' how to handle whitespaces, in the same way 703 as the '--whitespace' option. See linkgit:git-apply[1]. 704 705branch.autosetupmerge:: 706 Tells 'git branch' and 'git checkout' to set up new branches 707 so that linkgit:git-pull[1] will appropriately merge from the 708 starting point branch. Note that even if this option is not set, 709 this behavior can be chosen per-branch using the `--track` 710 and `--no-track` options. The valid settings are: `false` -- no 711 automatic setup is done; `true` -- automatic setup is done when the 712 starting point is a remote-tracking branch; `always` -- 713 automatic setup is done when the starting point is either a 714 local branch or remote-tracking 715 branch. This option defaults to true. 716 717branch.autosetuprebase:: 718 When a new branch is created with 'git branch' or 'git checkout' 719 that tracks another branch, this variable tells Git to set 720 up pull to rebase instead of merge (see "branch.<name>.rebase"). 721 When `never`, rebase is never automatically set to true. 722 When `local`, rebase is set to true for tracked branches of 723 other local branches. 724 When `remote`, rebase is set to true for tracked branches of 725 remote-tracking branches. 726 When `always`, rebase will be set to true for all tracking 727 branches. 728 See "branch.autosetupmerge" for details on how to set up a 729 branch to track another branch. 730 This option defaults to never. 731 732branch.<name>.remote:: 733 When on branch <name>, it tells 'git fetch' and 'git push' 734 which remote to fetch from/push to. The remote to push to 735 may be overridden with `remote.pushdefault` (for all branches). 736 The remote to push to, for the current branch, may be further 737 overridden by `branch.<name>.pushremote`. If no remote is 738 configured, or if you are not on any branch, it defaults to 739 `origin` for fetching and `remote.pushdefault` for pushing. 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 special setting 766 `.` (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*NOTE*: this is a possibly dangerous operation; do *not* use 781it unless you understand the implications (see linkgit:git-rebase[1] 782for details). 783 784branch.<name>.description:: 785 Branch description, can be edited with 786 `git branch --edit-description`. Branch description is 787 automatically added in the format-patch cover letter or 788 request-pull summary. 789 790browser.<tool>.cmd:: 791 Specify the command to invoke the specified browser. The 792 specified command is evaluated in shell with the URLs passed 793 as arguments. (See linkgit:git-web{litdd}browse[1].) 794 795browser.<tool>.path:: 796 Override the path for the given tool that may be used to 797 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 798 working repository in gitweb (see linkgit:git-instaweb[1]). 799 800clean.requireForce:: 801 A boolean to make git-clean do nothing unless given -f 802 or -n. Defaults to true. 803 804color.branch:: 805 A boolean to enable/disable color in the output of 806 linkgit:git-branch[1]. May be set to `always`, 807 `false` (or `never`) or `auto` (or `true`), in which case colors are used 808 only when the output is to a terminal. Defaults to false. 809 810color.branch.<slot>:: 811 Use customized color for branch coloration. `<slot>` is one of 812 `current` (the current branch), `local` (a local branch), 813 `remote` (a remote-tracking branch in refs/remotes/), 814 `upstream` (upstream tracking branch), `plain` (other 815 refs). 816+ 817The value for these configuration variables is a list of colors (at most 818two) and attributes (at most one), separated by spaces. The colors 819accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, 820`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, 821`blink` and `reverse`. The first color given is the foreground; the 822second is the background. The position of the attribute, if any, 823doesn't matter. 824 825color.diff:: 826 Whether to use ANSI escape sequences to add color to patches. 827 If this is set to `always`, linkgit:git-diff[1], 828 linkgit:git-log[1], and linkgit:git-show[1] will use color 829 for all patches. If it is set to `true` or `auto`, those 830 commands will only use color when output is to the terminal. 831 Defaults to false. 832+ 833This does not affect linkgit:git-format-patch[1] nor the 834'git-diff-{asterisk}' plumbing commands. Can be overridden on the 835command line with the `--color[=<when>]` option. 836 837color.diff.<slot>:: 838 Use customized color for diff colorization. `<slot>` specifies 839 which part of the patch to use the specified color, and is one 840 of `plain` (context text), `meta` (metainformation), `frag` 841 (hunk header), 'func' (function in hunk header), `old` (removed lines), 842 `new` (added lines), `commit` (commit headers), or `whitespace` 843 (highlighting whitespace errors). The values of these variables may be 844 specified as in color.branch.<slot>. 845 846color.decorate.<slot>:: 847 Use customized color for 'git log --decorate' output. `<slot>` is one 848 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 849 branches, remote-tracking branches, tags, stash and HEAD, respectively. 850 851color.grep:: 852 When set to `always`, always highlight matches. When `false` (or 853 `never`), never. When set to `true` or `auto`, use color only 854 when the output is written to the terminal. Defaults to `false`. 855 856color.grep.<slot>:: 857 Use customized color for grep colorization. `<slot>` specifies which 858 part of the line to use the specified color, and is one of 859+ 860-- 861`context`;; 862 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 863`filename`;; 864 filename prefix (when not using `-h`) 865`function`;; 866 function name lines (when using `-p`) 867`linenumber`;; 868 line number prefix (when using `-n`) 869`match`;; 870 matching text 871`selected`;; 872 non-matching text in selected lines 873`separator`;; 874 separators between fields on a line (`:`, `-`, and `=`) 875 and between hunks (`--`) 876-- 877+ 878The values of these variables may be specified as in color.branch.<slot>. 879 880color.interactive:: 881 When set to `always`, always use colors for interactive prompts 882 and displays (such as those used by "git-add --interactive" and 883 "git-clean --interactive"). When false (or `never`), never. 884 When set to `true` or `auto`, use colors only when the output is 885 to the terminal. Defaults to false. 886 887color.interactive.<slot>:: 888 Use customized color for 'git add --interactive' and 'git clean 889 --interactive' output. `<slot>` may be `prompt`, `header`, `help` 890 or `error`, for four distinct types of normal output from 891 interactive commands. The values of these variables may be 892 specified as in color.branch.<slot>. 893 894color.pager:: 895 A boolean to enable/disable colored output when the pager is in 896 use (default is true). 897 898color.showbranch:: 899 A boolean to enable/disable color in the output of 900 linkgit:git-show-branch[1]. May be set to `always`, 901 `false` (or `never`) or `auto` (or `true`), in which case colors are used 902 only when the output is to a terminal. Defaults to false. 903 904color.status:: 905 A boolean to enable/disable color in the output of 906 linkgit:git-status[1]. May be set to `always`, 907 `false` (or `never`) or `auto` (or `true`), in which case colors are used 908 only when the output is to a terminal. Defaults to false. 909 910color.status.<slot>:: 911 Use customized color for status colorization. `<slot>` is 912 one of `header` (the header text of the status message), 913 `added` or `updated` (files which are added but not committed), 914 `changed` (files which are changed but not added in the index), 915 `untracked` (files which are not tracked by Git), 916 `branch` (the current branch), or 917 `nobranch` (the color the 'no branch' warning is shown in, defaulting 918 to red). The values of these variables may be specified as in 919 color.branch.<slot>. 920 921color.ui:: 922 This variable determines the default value for variables such 923 as `color.diff` and `color.grep` that control the use of color 924 per command family. Its scope will expand as more commands learn 925 configuration to set a default for the `--color` option. Set it 926 to `false` or `never` if you prefer Git commands not to use 927 color unless enabled explicitly with some other configuration 928 or the `--color` option. Set it to `always` if you want all 929 output not intended for machine consumption to use color, to 930 `true` or `auto` (this is the default since Git 1.8.4) if you 931 want such output to use color when written to the terminal. 932 933column.ui:: 934 Specify whether supported commands should output in columns. 935 This variable consists of a list of tokens separated by spaces 936 or commas: 937+ 938These options control when the feature should be enabled 939(defaults to 'never'): 940+ 941-- 942`always`;; 943 always show in columns 944`never`;; 945 never show in columns 946`auto`;; 947 show in columns if the output is to the terminal 948-- 949+ 950These options control layout (defaults to 'column'). Setting any 951of these implies 'always' if none of 'always', 'never', or 'auto' are 952specified. 953+ 954-- 955`column`;; 956 fill columns before rows 957`row`;; 958 fill rows before columns 959`plain`;; 960 show in one column 961-- 962+ 963Finally, these options can be combined with a layout option (defaults 964to 'nodense'): 965+ 966-- 967`dense`;; 968 make unequal size columns to utilize more space 969`nodense`;; 970 make equal size columns 971-- 972 973column.branch:: 974 Specify whether to output branch listing in `git branch` in columns. 975 See `column.ui` for details. 976 977column.clean:: 978 Specify the layout when list items in `git clean -i`, which always 979 shows files and directories in columns. See `column.ui` for details. 980 981column.status:: 982 Specify whether to output untracked files in `git status` in columns. 983 See `column.ui` for details. 984 985column.tag:: 986 Specify whether to output tag listing in `git tag` in columns. 987 See `column.ui` for details. 988 989commit.cleanup:: 990 This setting overrides the default of the `--cleanup` option in 991 `git commit`. See linkgit:git-commit[1] for details. Changing the 992 default can be useful when you always want to keep lines that begin 993 with comment character `#` in your log message, in which case you 994 would do `git config commit.cleanup whitespace` (note that you will 995 have to remove the help lines that begin with `#` in the commit log 996 template yourself, if you do this). 997 998commit.status:: 999 A boolean to enable/disable inclusion of status information in the1000 commit message template when using an editor to prepare the commit1001 message. Defaults to true.10021003commit.template::1004 Specify a file to use as the template for new commit messages.1005 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the1006 specified user's home directory.10071008credential.helper::1009 Specify an external helper to be called when a username or1010 password credential is needed; the helper may consult external1011 storage to avoid prompting the user for the credentials. See1012 linkgit:gitcredentials[7] for details.10131014credential.useHttpPath::1015 When acquiring credentials, consider the "path" component of an http1016 or https URL to be important. Defaults to false. See1017 linkgit:gitcredentials[7] for more information.10181019credential.username::1020 If no username is set for a network authentication, use this username1021 by default. See credential.<context>.* below, and1022 linkgit:gitcredentials[7].10231024credential.<url>.*::1025 Any of the credential.* options above can be applied selectively to1026 some credentials. For example "credential.https://example.com.username"1027 would set the default username only for https connections to1028 example.com. See linkgit:gitcredentials[7] for details on how URLs are1029 matched.10301031include::diff-config.txt[]10321033difftool.<tool>.path::1034 Override the path for the given tool. This is useful in case1035 your tool is not in the PATH.10361037difftool.<tool>.cmd::1038 Specify the command to invoke the specified diff tool.1039 The specified command is evaluated in shell with the following1040 variables available: 'LOCAL' is set to the name of the temporary1041 file containing the contents of the diff pre-image and 'REMOTE'1042 is set to the name of the temporary file containing the contents1043 of the diff post-image.10441045difftool.prompt::1046 Prompt before each invocation of the diff tool.10471048fetch.recurseSubmodules::1049 This option can be either set to a boolean value or to 'on-demand'.1050 Setting it to a boolean changes the behavior of fetch and pull to1051 unconditionally recurse into submodules when set to true or to not1052 recurse at all when set to false. When set to 'on-demand' (the default1053 value), fetch and pull will only recurse into a populated submodule1054 when its superproject retrieves a commit that updates the submodule's1055 reference.10561057fetch.fsckObjects::1058 If it is set to true, git-fetch-pack will check all fetched1059 objects. It will abort in the case of a malformed object or a1060 broken link. The result of an abort are only dangling objects.1061 Defaults to false. If not set, the value of `transfer.fsckObjects`1062 is used instead.10631064fetch.unpackLimit::1065 If the number of objects fetched over the Git native1066 transfer is below this1067 limit, then the objects will be unpacked into loose object1068 files. However if the number of received objects equals or1069 exceeds this limit then the received pack will be stored as1070 a pack, after adding any missing delta bases. Storing the1071 pack from a push can make the push operation complete faster,1072 especially on slow filesystems. If not set, the value of1073 `transfer.unpackLimit` is used instead.10741075format.attach::1076 Enable multipart/mixed attachments as the default for1077 'format-patch'. The value can also be a double quoted string1078 which will enable attachments as the default and set the1079 value as the boundary. See the --attach option in1080 linkgit:git-format-patch[1].10811082format.numbered::1083 A boolean which can enable or disable sequence numbers in patch1084 subjects. It defaults to "auto" which enables it only if there1085 is more than one patch. It can be enabled or disabled for all1086 messages by setting it to "true" or "false". See --numbered1087 option in linkgit:git-format-patch[1].10881089format.headers::1090 Additional email headers to include in a patch to be submitted1091 by mail. See linkgit:git-format-patch[1].10921093format.to::1094format.cc::1095 Additional recipients to include in a patch to be submitted1096 by mail. See the --to and --cc options in1097 linkgit:git-format-patch[1].10981099format.subjectprefix::1100 The default for format-patch is to output files with the '[PATCH]'1101 subject prefix. Use this variable to change that prefix.11021103format.signature::1104 The default for format-patch is to output a signature containing1105 the Git version number. Use this variable to change that default.1106 Set this variable to the empty string ("") to suppress1107 signature generation.11081109format.suffix::1110 The default for format-patch is to output files with the suffix1111 `.patch`. Use this variable to change that suffix (make sure to1112 include the dot if you want it).11131114format.pretty::1115 The default pretty format for log/show/whatchanged command,1116 See linkgit:git-log[1], linkgit:git-show[1],1117 linkgit:git-whatchanged[1].11181119format.thread::1120 The default threading style for 'git format-patch'. Can be1121 a boolean value, or `shallow` or `deep`. `shallow` threading1122 makes every mail a reply to the head of the series,1123 where the head is chosen from the cover letter, the1124 `--in-reply-to`, and the first patch mail, in this order.1125 `deep` threading makes every mail a reply to the previous one.1126 A true boolean value is the same as `shallow`, and a false1127 value disables threading.11281129format.signoff::1130 A boolean value which lets you enable the `-s/--signoff` option of1131 format-patch by default. *Note:* Adding the Signed-off-by: line to a1132 patch should be a conscious act and means that you certify you have1133 the rights to submit this work under the same open source license.1134 Please see the 'SubmittingPatches' document for further discussion.11351136format.coverLetter::1137 A boolean that controls whether to generate a cover-letter when1138 format-patch is invoked, but in addition can be set to "auto", to1139 generate a cover-letter only when there's more than one patch.11401141filter.<driver>.clean::1142 The command which is used to convert the content of a worktree1143 file to a blob upon checkin. See linkgit:gitattributes[5] for1144 details.11451146filter.<driver>.smudge::1147 The command which is used to convert the content of a blob1148 object to a worktree file upon checkout. See1149 linkgit:gitattributes[5] for details.11501151gc.aggressiveWindow::1152 The window size parameter used in the delta compression1153 algorithm used by 'git gc --aggressive'. This defaults1154 to 250.11551156gc.auto::1157 When there are approximately more than this many loose1158 objects in the repository, `git gc --auto` will pack them.1159 Some Porcelain commands use this command to perform a1160 light-weight garbage collection from time to time. The1161 default value is 6700. Setting this to 0 disables it.11621163gc.autopacklimit::1164 When there are more than this many packs that are not1165 marked with `*.keep` file in the repository, `git gc1166 --auto` consolidates them into one larger pack. The1167 default value is 50. Setting this to 0 disables it.11681169gc.packrefs::1170 Running `git pack-refs` in a repository renders it1171 unclonable by Git versions prior to 1.5.1.2 over dumb1172 transports such as HTTP. This variable determines whether1173 'git gc' runs `git pack-refs`. This can be set to `notbare`1174 to enable it within all non-bare repos or it can be set to a1175 boolean value. The default is `true`.11761177gc.pruneexpire::1178 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1179 Override the grace period with this config variable. The value1180 "now" may be used to disable this grace period and always prune1181 unreachable objects immediately.11821183gc.reflogexpire::1184gc.<pattern>.reflogexpire::1185 'git reflog expire' removes reflog entries older than1186 this time; defaults to 90 days. With "<pattern>" (e.g.1187 "refs/stash") in the middle the setting applies only to1188 the refs that match the <pattern>.11891190gc.reflogexpireunreachable::1191gc.<ref>.reflogexpireunreachable::1192 'git reflog expire' removes reflog entries older than1193 this time and are not reachable from the current tip;1194 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")1195 in the middle, the setting applies only to the refs that1196 match the <pattern>.11971198gc.rerereresolved::1199 Records of conflicted merge you resolved earlier are1200 kept for this many days when 'git rerere gc' is run.1201 The default is 60 days. See linkgit:git-rerere[1].12021203gc.rerereunresolved::1204 Records of conflicted merge you have not resolved are1205 kept for this many days when 'git rerere gc' is run.1206 The default is 15 days. See linkgit:git-rerere[1].12071208gitcvs.commitmsgannotation::1209 Append this string to each commit message. Set to empty string1210 to disable this feature. Defaults to "via git-CVS emulator".12111212gitcvs.enabled::1213 Whether the CVS server interface is enabled for this repository.1214 See linkgit:git-cvsserver[1].12151216gitcvs.logfile::1217 Path to a log file where the CVS server interface well... logs1218 various stuff. See linkgit:git-cvsserver[1].12191220gitcvs.usecrlfattr::1221 If true, the server will look up the end-of-line conversion1222 attributes for files to determine the '-k' modes to use. If1223 the attributes force Git to treat a file as text,1224 the '-k' mode will be left blank so CVS clients will1225 treat it as text. If they suppress text conversion, the file1226 will be set with '-kb' mode, which suppresses any newline munging1227 the client might otherwise do. If the attributes do not allow1228 the file type to be determined, then 'gitcvs.allbinary' is1229 used. See linkgit:gitattributes[5].12301231gitcvs.allbinary::1232 This is used if 'gitcvs.usecrlfattr' does not resolve1233 the correct '-kb' mode to use. If true, all1234 unresolved files are sent to the client in1235 mode '-kb'. This causes the client to treat them1236 as binary files, which suppresses any newline munging it1237 otherwise might do. Alternatively, if it is set to "guess",1238 then the contents of the file are examined to decide if1239 it is binary, similar to 'core.autocrlf'.12401241gitcvs.dbname::1242 Database used by git-cvsserver to cache revision information1243 derived from the Git repository. The exact meaning depends on the1244 used database driver, for SQLite (which is the default driver) this1245 is a filename. Supports variable substitution (see1246 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1247 Default: '%Ggitcvs.%m.sqlite'12481249gitcvs.dbdriver::1250 Used Perl DBI driver. You can specify any available driver1251 for this here, but it might not work. git-cvsserver is tested1252 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1253 reported *not* to work with 'DBD::mysql'. Experimental feature.1254 May not contain double colons (`:`). Default: 'SQLite'.1255 See linkgit:git-cvsserver[1].12561257gitcvs.dbuser, gitcvs.dbpass::1258 Database user and password. Only useful if setting 'gitcvs.dbdriver',1259 since SQLite has no concept of database users and/or passwords.1260 'gitcvs.dbuser' supports variable substitution (see1261 linkgit:git-cvsserver[1] for details).12621263gitcvs.dbTableNamePrefix::1264 Database table name prefix. Prepended to the names of any1265 database tables used, allowing a single database to be used1266 for several repositories. Supports variable substitution (see1267 linkgit:git-cvsserver[1] for details). Any non-alphabetic1268 characters will be replaced with underscores.12691270All gitcvs variables except for 'gitcvs.usecrlfattr' and1271'gitcvs.allbinary' can also be specified as1272'gitcvs.<access_method>.<varname>' (where 'access_method'1273is one of "ext" and "pserver") to make them apply only for the given1274access method.12751276gitweb.category::1277gitweb.description::1278gitweb.owner::1279gitweb.url::1280 See linkgit:gitweb[1] for description.12811282gitweb.avatar::1283gitweb.blame::1284gitweb.grep::1285gitweb.highlight::1286gitweb.patches::1287gitweb.pickaxe::1288gitweb.remote_heads::1289gitweb.showsizes::1290gitweb.snapshot::1291 See linkgit:gitweb.conf[5] for description.12921293grep.lineNumber::1294 If set to true, enable '-n' option by default.12951296grep.patternType::1297 Set the default matching behavior. Using a value of 'basic', 'extended',1298 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',1299 '--fixed-strings', or '--perl-regexp' option accordingly, while the1300 value 'default' will return to the default matching behavior.13011302grep.extendedRegexp::1303 If set to true, enable '--extended-regexp' option by default. This1304 option is ignored when the 'grep.patternType' option is set to a value1305 other than 'default'.13061307gpg.program::1308 Use this custom program instead of "gpg" found on $PATH when1309 making or verifying a PGP signature. The program must support the1310 same command line interface as GPG, namely, to verify a detached1311 signature, "gpg --verify $file - <$signature" is run, and the1312 program is expected to signal a good signature by exiting with1313 code 0, and to generate an ascii-armored detached signature, the1314 standard input of "gpg -bsau $key" is fed with the contents to be1315 signed, and the program is expected to send the result to its1316 standard output.13171318gui.commitmsgwidth::1319 Defines how wide the commit message window is in the1320 linkgit:git-gui[1]. "75" is the default.13211322gui.diffcontext::1323 Specifies how many context lines should be used in calls to diff1324 made by the linkgit:git-gui[1]. The default is "5".13251326gui.encoding::1327 Specifies the default encoding to use for displaying of1328 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1329 It can be overridden by setting the 'encoding' attribute1330 for relevant files (see linkgit:gitattributes[5]).1331 If this option is not set, the tools default to the1332 locale encoding.13331334gui.matchtrackingbranch::1335 Determines if new branches created with linkgit:git-gui[1] should1336 default to tracking remote branches with matching names or1337 not. Default: "false".13381339gui.newbranchtemplate::1340 Is used as suggested name when creating new branches using the1341 linkgit:git-gui[1].13421343gui.pruneduringfetch::1344 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1345 performing a fetch. The default value is "false".13461347gui.trustmtime::1348 Determines if linkgit:git-gui[1] should trust the file modification1349 timestamp or not. By default the timestamps are not trusted.13501351gui.spellingdictionary::1352 Specifies the dictionary used for spell checking commit messages in1353 the linkgit:git-gui[1]. When set to "none" spell checking is turned1354 off.13551356gui.fastcopyblame::1357 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1358 location detection. It makes blame significantly faster on huge1359 repositories at the expense of less thorough copy detection.13601361gui.copyblamethreshold::1362 Specifies the threshold to use in 'git gui blame' original location1363 detection, measured in alphanumeric characters. See the1364 linkgit:git-blame[1] manual for more information on copy detection.13651366gui.blamehistoryctx::1367 Specifies the radius of history context in days to show in1368 linkgit:gitk[1] for the selected commit, when the `Show History1369 Context` menu item is invoked from 'git gui blame'. If this1370 variable is set to zero, the whole history is shown.13711372guitool.<name>.cmd::1373 Specifies the shell command line to execute when the corresponding item1374 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1375 mandatory for every tool. The command is executed from the root of1376 the working directory, and in the environment it receives the name of1377 the tool as 'GIT_GUITOOL', the name of the currently selected file as1378 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1379 the head is detached, 'CUR_BRANCH' is empty).13801381guitool.<name>.needsfile::1382 Run the tool only if a diff is selected in the GUI. It guarantees1383 that 'FILENAME' is not empty.13841385guitool.<name>.noconsole::1386 Run the command silently, without creating a window to display its1387 output.13881389guitool.<name>.norescan::1390 Don't rescan the working directory for changes after the tool1391 finishes execution.13921393guitool.<name>.confirm::1394 Show a confirmation dialog before actually running the tool.13951396guitool.<name>.argprompt::1397 Request a string argument from the user, and pass it to the tool1398 through the 'ARGS' environment variable. Since requesting an1399 argument implies confirmation, the 'confirm' option has no effect1400 if this is enabled. If the option is set to 'true', 'yes', or '1',1401 the dialog uses a built-in generic prompt; otherwise the exact1402 value of the variable is used.14031404guitool.<name>.revprompt::1405 Request a single valid revision from the user, and set the1406 'REVISION' environment variable. In other aspects this option1407 is similar to 'argprompt', and can be used together with it.14081409guitool.<name>.revunmerged::1410 Show only unmerged branches in the 'revprompt' subdialog.1411 This is useful for tools similar to merge or rebase, but not1412 for things like checkout or reset.14131414guitool.<name>.title::1415 Specifies the title to use for the prompt dialog. The default1416 is the tool name.14171418guitool.<name>.prompt::1419 Specifies the general prompt string to display at the top of1420 the dialog, before subsections for 'argprompt' and 'revprompt'.1421 The default value includes the actual command.14221423help.browser::1424 Specify the browser that will be used to display help in the1425 'web' format. See linkgit:git-help[1].14261427help.format::1428 Override the default help format used by linkgit:git-help[1].1429 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1430 the default. 'web' and 'html' are the same.14311432help.autocorrect::1433 Automatically correct and execute mistyped commands after1434 waiting for the given number of deciseconds (0.1 sec). If more1435 than one command can be deduced from the entered text, nothing1436 will be executed. If the value of this option is negative,1437 the corrected command will be executed immediately. If the1438 value is 0 - the command will be just shown but not executed.1439 This is the default.14401441help.htmlpath::1442 Specify the path where the HTML documentation resides. File system paths1443 and URLs are supported. HTML pages will be prefixed with this path when1444 help is displayed in the 'web' format. This defaults to the documentation1445 path of your Git installation.14461447http.proxy::1448 Override the HTTP proxy, normally configured using the 'http_proxy',1449 'https_proxy', and 'all_proxy' environment variables (see1450 `curl(1)`). This can be overridden on a per-remote basis; see1451 remote.<name>.proxy14521453http.cookiefile::1454 File containing previously stored cookie lines which should be used1455 in the Git http session, if they match the server. The file format1456 of the file to read cookies from should be plain HTTP headers or1457 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).1458 NOTE that the file specified with http.cookiefile is only used as1459 input unless http.saveCookies is set.14601461http.savecookies::1462 If set, store cookies received during requests to the file specified by1463 http.cookiefile. Has no effect if http.cookiefile is unset.14641465http.sslVerify::1466 Whether to verify the SSL certificate when fetching or pushing1467 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1468 variable.14691470http.sslCert::1471 File containing the SSL certificate when fetching or pushing1472 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1473 variable.14741475http.sslKey::1476 File containing the SSL private key when fetching or pushing1477 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1478 variable.14791480http.sslCertPasswordProtected::1481 Enable Git's password prompt for the SSL certificate. Otherwise1482 OpenSSL will prompt the user, possibly many times, if the1483 certificate or private key is encrypted. Can be overridden by the1484 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.14851486http.sslCAInfo::1487 File containing the certificates to verify the peer with when1488 fetching or pushing over HTTPS. Can be overridden by the1489 'GIT_SSL_CAINFO' environment variable.14901491http.sslCAPath::1492 Path containing files with the CA certificates to verify the peer1493 with when fetching or pushing over HTTPS. Can be overridden1494 by the 'GIT_SSL_CAPATH' environment variable.14951496http.sslTry::1497 Attempt to use AUTH SSL/TLS and encrypted data transfers1498 when connecting via regular FTP protocol. This might be needed1499 if the FTP server requires it for security reasons or you wish1500 to connect securely whenever remote FTP server supports it.1501 Default is false since it might trigger certificate verification1502 errors on misconfigured servers.15031504http.maxRequests::1505 How many HTTP requests to launch in parallel. Can be overridden1506 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.15071508http.minSessions::1509 The number of curl sessions (counted across slots) to be kept across1510 requests. They will not be ended with curl_easy_cleanup() until1511 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1512 value will be capped at 1. Defaults to 1.15131514http.postBuffer::1515 Maximum size in bytes of the buffer used by smart HTTP1516 transports when POSTing data to the remote system.1517 For requests larger than this buffer size, HTTP/1.1 and1518 Transfer-Encoding: chunked is used to avoid creating a1519 massive pack file locally. Default is 1 MiB, which is1520 sufficient for most requests.15211522http.lowSpeedLimit, http.lowSpeedTime::1523 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1524 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1525 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1526 'GIT_HTTP_LOW_SPEED_TIME' environment variables.15271528http.noEPSV::1529 A boolean which disables using of EPSV ftp command by curl.1530 This can helpful with some "poor" ftp servers which don't1531 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1532 environment variable. Default is false (curl will use EPSV).15331534http.useragent::1535 The HTTP USER_AGENT string presented to an HTTP server. The default1536 value represents the version of the client Git such as git/1.7.1.1537 This option allows you to override this value to a more common value1538 such as Mozilla/4.0. This may be necessary, for instance, if1539 connecting through a firewall that restricts HTTP connections to a set1540 of common USER_AGENT strings (but not including those like git/1.7.1).1541 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.15421543i18n.commitEncoding::1544 Character encoding the commit messages are stored in; Git itself1545 does not care per se, but this information is necessary e.g. when1546 importing commits from emails or in the gitk graphical history1547 browser (and possibly at other places in the future or in other1548 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.15491550i18n.logOutputEncoding::1551 Character encoding the commit messages are converted to when1552 running 'git log' and friends.15531554imap::1555 The configuration variables in the 'imap' section are described1556 in linkgit:git-imap-send[1].15571558init.templatedir::1559 Specify the directory from which templates will be copied.1560 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)15611562instaweb.browser::1563 Specify the program that will be used to browse your working1564 repository in gitweb. See linkgit:git-instaweb[1].15651566instaweb.httpd::1567 The HTTP daemon command-line to start gitweb on your working1568 repository. See linkgit:git-instaweb[1].15691570instaweb.local::1571 If true the web server started by linkgit:git-instaweb[1] will1572 be bound to the local IP (127.0.0.1).15731574instaweb.modulepath::1575 The default module path for linkgit:git-instaweb[1] to use1576 instead of /usr/lib/apache2/modules. Only used if httpd1577 is Apache.15781579instaweb.port::1580 The port number to bind the gitweb httpd to. See1581 linkgit:git-instaweb[1].15821583interactive.singlekey::1584 In interactive commands, allow the user to provide one-letter1585 input with a single key (i.e., without hitting enter).1586 Currently this is used by the `--patch` mode of1587 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],1588 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this1589 setting is silently ignored if portable keystroke input1590 is not available.15911592log.abbrevCommit::1593 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1594 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may1595 override this option with `--no-abbrev-commit`.15961597log.date::1598 Set the default date-time mode for the 'log' command.1599 Setting a value for log.date is similar to using 'git log''s1600 `--date` option. Possible values are `relative`, `local`,1601 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]1602 for details.16031604log.decorate::1605 Print out the ref names of any commits that are shown by the log1606 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1607 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1608 specified, the full ref name (including prefix) will be printed.1609 This is the same as the log commands '--decorate' option.16101611log.showroot::1612 If true, the initial commit will be shown as a big creation event.1613 This is equivalent to a diff against an empty tree.1614 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1615 normally hide the root commit will now show it. True by default.16161617log.mailmap::1618 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1619 linkgit:git-whatchanged[1] assume `--use-mailmap`.16201621mailmap.file::1622 The location of an augmenting mailmap file. The default1623 mailmap, located in the root of the repository, is loaded1624 first, then the mailmap file pointed to by this variable.1625 The location of the mailmap file may be in a repository1626 subdirectory, or somewhere outside of the repository itself.1627 See linkgit:git-shortlog[1] and linkgit:git-blame[1].16281629mailmap.blob::1630 Like `mailmap.file`, but consider the value as a reference to a1631 blob in the repository. If both `mailmap.file` and1632 `mailmap.blob` are given, both are parsed, with entries from1633 `mailmap.file` taking precedence. In a bare repository, this1634 defaults to `HEAD:.mailmap`. In a non-bare repository, it1635 defaults to empty.16361637man.viewer::1638 Specify the programs that may be used to display help in the1639 'man' format. See linkgit:git-help[1].16401641man.<tool>.cmd::1642 Specify the command to invoke the specified man viewer. The1643 specified command is evaluated in shell with the man page1644 passed as argument. (See linkgit:git-help[1].)16451646man.<tool>.path::1647 Override the path for the given tool that may be used to1648 display help in the 'man' format. See linkgit:git-help[1].16491650include::merge-config.txt[]16511652mergetool.<tool>.path::1653 Override the path for the given tool. This is useful in case1654 your tool is not in the PATH.16551656mergetool.<tool>.cmd::1657 Specify the command to invoke the specified merge tool. The1658 specified command is evaluated in shell with the following1659 variables available: 'BASE' is the name of a temporary file1660 containing the common base of the files to be merged, if available;1661 'LOCAL' is the name of a temporary file containing the contents of1662 the file on the current branch; 'REMOTE' is the name of a temporary1663 file containing the contents of the file from the branch being1664 merged; 'MERGED' contains the name of the file to which the merge1665 tool should write the results of a successful merge.16661667mergetool.<tool>.trustExitCode::1668 For a custom merge command, specify whether the exit code of1669 the merge command can be used to determine whether the merge was1670 successful. If this is not set to true then the merge target file1671 timestamp is checked and the merge assumed to have been successful1672 if the file has been updated, otherwise the user is prompted to1673 indicate the success of the merge.16741675mergetool.keepBackup::1676 After performing a merge, the original file with conflict markers1677 can be saved as a file with a `.orig` extension. If this variable1678 is set to `false` then this file is not preserved. Defaults to1679 `true` (i.e. keep the backup files).16801681mergetool.keepTemporaries::1682 When invoking a custom merge tool, Git uses a set of temporary1683 files to pass to the tool. If the tool returns an error and this1684 variable is set to `true`, then these temporary files will be1685 preserved, otherwise they will be removed after the tool has1686 exited. Defaults to `false`.16871688mergetool.prompt::1689 Prompt before each invocation of the merge resolution program.16901691notes.displayRef::1692 The (fully qualified) refname from which to show notes when1693 showing commit messages. The value of this variable can be set1694 to a glob, in which case notes from all matching refs will be1695 shown. You may also specify this configuration variable1696 several times. A warning will be issued for refs that do not1697 exist, but a glob that does not match any refs is silently1698 ignored.1699+1700This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`1701environment variable, which must be a colon separated list of refs or1702globs.1703+1704The effective value of "core.notesRef" (possibly overridden by1705GIT_NOTES_REF) is also implicitly added to the list of refs to be1706displayed.17071708notes.rewrite.<command>::1709 When rewriting commits with <command> (currently `amend` or1710 `rebase`) and this variable is set to `true`, Git1711 automatically copies your notes from the original to the1712 rewritten commit. Defaults to `true`, but see1713 "notes.rewriteRef" below.17141715notes.rewriteMode::1716 When copying notes during a rewrite (see the1717 "notes.rewrite.<command>" option), determines what to do if1718 the target commit already has a note. Must be one of1719 `overwrite`, `concatenate`, or `ignore`. Defaults to1720 `concatenate`.1721+1722This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`1723environment variable.17241725notes.rewriteRef::1726 When copying notes during a rewrite, specifies the (fully1727 qualified) ref whose notes should be copied. The ref may be a1728 glob, in which case notes in all matching refs will be copied.1729 You may also specify this configuration several times.1730+1731Does not have a default value; you must configure this variable to1732enable note rewriting. Set it to `refs/notes/commits` to enable1733rewriting for the default commit notes.1734+1735This setting can be overridden with the `GIT_NOTES_REWRITE_REF`1736environment variable, which must be a colon separated list of refs or1737globs.17381739pack.window::1740 The size of the window used by linkgit:git-pack-objects[1] when no1741 window size is given on the command line. Defaults to 10.17421743pack.depth::1744 The maximum delta depth used by linkgit:git-pack-objects[1] when no1745 maximum depth is given on the command line. Defaults to 50.17461747pack.windowMemory::1748 The window memory size limit used by linkgit:git-pack-objects[1]1749 when no limit is given on the command line. The value can be1750 suffixed with "k", "m", or "g". Defaults to 0, meaning no1751 limit.17521753pack.compression::1754 An integer -1..9, indicating the compression level for objects1755 in a pack file. -1 is the zlib default. 0 means no1756 compression, and 1..9 are various speed/size tradeoffs, 9 being1757 slowest. If not set, defaults to core.compression. If that is1758 not set, defaults to -1, the zlib default, which is "a default1759 compromise between speed and compression (currently equivalent1760 to level 6)."1761+1762Note that changing the compression level will not automatically recompress1763all existing objects. You can force recompression by passing the -F option1764to linkgit:git-repack[1].17651766pack.deltaCacheSize::1767 The maximum memory in bytes used for caching deltas in1768 linkgit:git-pack-objects[1] before writing them out to a pack.1769 This cache is used to speed up the writing object phase by not1770 having to recompute the final delta result once the best match1771 for all objects is found. Repacking large repositories on machines1772 which are tight with memory might be badly impacted by this though,1773 especially if this cache pushes the system into swapping.1774 A value of 0 means no limit. The smallest size of 1 byte may be1775 used to virtually disable this cache. Defaults to 256 MiB.17761777pack.deltaCacheLimit::1778 The maximum size of a delta, that is cached in1779 linkgit:git-pack-objects[1]. This cache is used to speed up the1780 writing object phase by not having to recompute the final delta1781 result once the best match for all objects is found. Defaults to 1000.17821783pack.threads::1784 Specifies the number of threads to spawn when searching for best1785 delta matches. This requires that linkgit:git-pack-objects[1]1786 be compiled with pthreads otherwise this option is ignored with a1787 warning. This is meant to reduce packing time on multiprocessor1788 machines. The required amount of memory for the delta search window1789 is however multiplied by the number of threads.1790 Specifying 0 will cause Git to auto-detect the number of CPU's1791 and set the number of threads accordingly.17921793pack.indexVersion::1794 Specify the default pack index version. Valid values are 1 for1795 legacy pack index used by Git versions prior to 1.5.2, and 2 for1796 the new pack index with capabilities for packs larger than 4 GB1797 as well as proper protection against the repacking of corrupted1798 packs. Version 2 is the default. Note that version 2 is enforced1799 and this config option ignored whenever the corresponding pack is1800 larger than 2 GB.1801+1802If you have an old Git that does not understand the version 2 `*.idx` file,1803cloning or fetching over a non native protocol (e.g. "http" and "rsync")1804that will copy both `*.pack` file and corresponding `*.idx` file from the1805other side may give you a repository that cannot be accessed with your1806older version of Git. If the `*.pack` file is smaller than 2 GB, however,1807you can use linkgit:git-index-pack[1] on the *.pack file to regenerate1808the `*.idx` file.18091810pack.packSizeLimit::1811 The maximum size of a pack. This setting only affects1812 packing to a file when repacking, i.e. the git:// protocol1813 is unaffected. It can be overridden by the `--max-pack-size`1814 option of linkgit:git-repack[1]. The minimum size allowed is1815 limited to 1 MiB. The default is unlimited.1816 Common unit suffixes of 'k', 'm', or 'g' are1817 supported.18181819pager.<cmd>::1820 If the value is boolean, turns on or off pagination of the1821 output of a particular Git subcommand when writing to a tty.1822 Otherwise, turns on pagination for the subcommand using the1823 pager specified by the value of `pager.<cmd>`. If `--paginate`1824 or `--no-pager` is specified on the command line, it takes1825 precedence over this option. To disable pagination for all1826 commands, set `core.pager` or `GIT_PAGER` to `cat`.18271828pretty.<name>::1829 Alias for a --pretty= format string, as specified in1830 linkgit:git-log[1]. Any aliases defined here can be used just1831 as the built-in pretty formats could. For example,1832 running `git config pretty.changelog "format:* %H %s"`1833 would cause the invocation `git log --pretty=changelog`1834 to be equivalent to running `git log "--pretty=format:* %H %s"`.1835 Note that an alias with the same name as a built-in format1836 will be silently ignored.18371838pull.rebase::1839 When true, rebase branches on top of the fetched branch, instead1840 of merging the default branch from the default remote when "git1841 pull" is run. See "branch.<name>.rebase" for setting this on a1842 per-branch basis.1843+1844*NOTE*: this is a possibly dangerous operation; do *not* use1845it unless you understand the implications (see linkgit:git-rebase[1]1846for details).18471848pull.octopus::1849 The default merge strategy to use when pulling multiple branches1850 at once.18511852pull.twohead::1853 The default merge strategy to use when pulling a single branch.18541855push.default::1856 Defines the action `git push` should take if no refspec is1857 explicitly given. Different values are well-suited for1858 specific workflows; for instance, in a purely central workflow1859 (i.e. the fetch source is equal to the push destination),1860 `upstream` is probably what you want. Possible values are:1861+1862--18631864* `nothing` - do not push anything (error out) unless a refspec is1865 explicitly given. This is primarily meant for people who want to1866 avoid mistakes by always being explicit.18671868* `current` - push the current branch to update a branch with the same1869 name on the receiving end. Works in both central and non-central1870 workflows.18711872* `upstream` - push the current branch back to the branch whose1873 changes are usually integrated into the current branch (which is1874 called `@{upstream}`). This mode only makes sense if you are1875 pushing to the same repository you would normally pull from1876 (i.e. central workflow).18771878* `simple` - in centralized workflow, work like `upstream` with an1879 added safety to refuse to push if the upstream branch's name is1880 different from the local one.1881+1882When pushing to a remote that is different from the remote you normally1883pull from, work as `current`. This is the safest option and is suited1884for beginners.1885+1886This mode will become the default in Git 2.0.18871888* `matching` - push all branches having the same name on both ends.1889 This makes the repository you are pushing to remember the set of1890 branches that will be pushed out (e.g. if you always push 'maint'1891 and 'master' there and no other branches, the repository you push1892 to will have these two branches, and your local 'maint' and1893 'master' will be pushed there).1894+1895To use this mode effectively, you have to make sure _all_ the1896branches you would push out are ready to be pushed out before1897running 'git push', as the whole point of this mode is to allow you1898to push all of the branches in one go. If you usually finish work1899on only one branch and push out the result, while other branches are1900unfinished, this mode is not for you. Also this mode is not1901suitable for pushing into a shared central repository, as other1902people may add new branches there, or update the tip of existing1903branches outside your control.1904+1905This is currently the default, but Git 2.0 will change the default1906to `simple`.19071908--19091910rebase.stat::1911 Whether to show a diffstat of what changed upstream since the last1912 rebase. False by default.19131914rebase.autosquash::1915 If set to true enable '--autosquash' option by default.19161917rebase.autostash::1918 When set to true, automatically create a temporary stash1919 before the operation begins, and apply it after the operation1920 ends. This means that you can run rebase on a dirty worktree.1921 However, use with care: the final stash application after a1922 successful rebase might result in non-trivial conflicts.1923 Defaults to false.19241925receive.autogc::1926 By default, git-receive-pack will run "git-gc --auto" after1927 receiving data from git-push and updating refs. You can stop1928 it by setting this variable to false.19291930receive.fsckObjects::1931 If it is set to true, git-receive-pack will check all received1932 objects. It will abort in the case of a malformed object or a1933 broken link. The result of an abort are only dangling objects.1934 Defaults to false. If not set, the value of `transfer.fsckObjects`1935 is used instead.19361937receive.unpackLimit::1938 If the number of objects received in a push is below this1939 limit then the objects will be unpacked into loose object1940 files. However if the number of received objects equals or1941 exceeds this limit then the received pack will be stored as1942 a pack, after adding any missing delta bases. Storing the1943 pack from a push can make the push operation complete faster,1944 especially on slow filesystems. If not set, the value of1945 `transfer.unpackLimit` is used instead.19461947receive.denyDeletes::1948 If set to true, git-receive-pack will deny a ref update that deletes1949 the ref. Use this to prevent such a ref deletion via a push.19501951receive.denyDeleteCurrent::1952 If set to true, git-receive-pack will deny a ref update that1953 deletes the currently checked out branch of a non-bare repository.19541955receive.denyCurrentBranch::1956 If set to true or "refuse", git-receive-pack will deny a ref update1957 to the currently checked out branch of a non-bare repository.1958 Such a push is potentially dangerous because it brings the HEAD1959 out of sync with the index and working tree. If set to "warn",1960 print a warning of such a push to stderr, but allow the push to1961 proceed. If set to false or "ignore", allow such pushes with no1962 message. Defaults to "refuse".19631964receive.denyNonFastForwards::1965 If set to true, git-receive-pack will deny a ref update which is1966 not a fast-forward. Use this to prevent such an update via a push,1967 even if that push is forced. This configuration variable is1968 set when initializing a shared repository.19691970receive.hiderefs::1971 String(s) `receive-pack` uses to decide which refs to omit1972 from its initial advertisement. Use more than one1973 definitions to specify multiple prefix strings. A ref that1974 are under the hierarchies listed on the value of this1975 variable is excluded, and is hidden when responding to `git1976 push`, and an attempt to update or delete a hidden ref by1977 `git push` is rejected.19781979receive.updateserverinfo::1980 If set to true, git-receive-pack will run git-update-server-info1981 after receiving data from git-push and updating refs.19821983remote.pushdefault::1984 The remote to push to by default. Overrides1985 `branch.<name>.remote` for all branches, and is overridden by1986 `branch.<name>.pushremote` for specific branches.19871988remote.<name>.url::1989 The URL of a remote repository. See linkgit:git-fetch[1] or1990 linkgit:git-push[1].19911992remote.<name>.pushurl::1993 The push URL of a remote repository. See linkgit:git-push[1].19941995remote.<name>.proxy::1996 For remotes that require curl (http, https and ftp), the URL to1997 the proxy to use for that remote. Set to the empty string to1998 disable proxying for that remote.19992000remote.<name>.fetch::2001 The default set of "refspec" for linkgit:git-fetch[1]. See2002 linkgit:git-fetch[1].20032004remote.<name>.push::2005 The default set of "refspec" for linkgit:git-push[1]. See2006 linkgit:git-push[1].20072008remote.<name>.mirror::2009 If true, pushing to this remote will automatically behave2010 as if the `--mirror` option was given on the command line.20112012remote.<name>.skipDefaultUpdate::2013 If true, this remote will be skipped by default when updating2014 using linkgit:git-fetch[1] or the `update` subcommand of2015 linkgit:git-remote[1].20162017remote.<name>.skipFetchAll::2018 If true, this remote will be skipped by default when updating2019 using linkgit:git-fetch[1] or the `update` subcommand of2020 linkgit:git-remote[1].20212022remote.<name>.receivepack::2023 The default program to execute on the remote side when pushing. See2024 option \--receive-pack of linkgit:git-push[1].20252026remote.<name>.uploadpack::2027 The default program to execute on the remote side when fetching. See2028 option \--upload-pack of linkgit:git-fetch-pack[1].20292030remote.<name>.tagopt::2031 Setting this value to \--no-tags disables automatic tag following when2032 fetching from remote <name>. Setting it to \--tags will fetch every2033 tag from remote <name>, even if they are not reachable from remote2034 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2035 override this setting. See options \--tags and \--no-tags of2036 linkgit:git-fetch[1].20372038remote.<name>.vcs::2039 Setting this to a value <vcs> will cause Git to interact with2040 the remote with the git-remote-<vcs> helper.20412042remotes.<group>::2043 The list of remotes which are fetched by "git remote update2044 <group>". See linkgit:git-remote[1].20452046repack.usedeltabaseoffset::2047 By default, linkgit:git-repack[1] creates packs that use2048 delta-base offset. If you need to share your repository with2049 Git older than version 1.4.4, either directly or via a dumb2050 protocol such as http, then you need to set this option to2051 "false" and repack. Access from old Git versions over the2052 native protocol are unaffected by this option.20532054rerere.autoupdate::2055 When set to true, `git-rerere` updates the index with the2056 resulting contents after it cleanly resolves conflicts using2057 previously recorded resolution. Defaults to false.20582059rerere.enabled::2060 Activate recording of resolved conflicts, so that identical2061 conflict hunks can be resolved automatically, should they be2062 encountered again. By default, linkgit:git-rerere[1] is2063 enabled if there is an `rr-cache` directory under the2064 `$GIT_DIR`, e.g. if "rerere" was previously used in the2065 repository.20662067sendemail.identity::2068 A configuration identity. When given, causes values in the2069 'sendemail.<identity>' subsection to take precedence over2070 values in the 'sendemail' section. The default identity is2071 the value of 'sendemail.identity'.20722073sendemail.smtpencryption::2074 See linkgit:git-send-email[1] for description. Note that this2075 setting is not subject to the 'identity' mechanism.20762077sendemail.smtpssl::2078 Deprecated alias for 'sendemail.smtpencryption = ssl'.20792080sendemail.smtpsslcertpath::2081 Path to ca-certificates (either a directory or a single file).2082 Set it to an empty string to disable certificate verification.20832084sendemail.<identity>.*::2085 Identity-specific versions of the 'sendemail.*' parameters2086 found below, taking precedence over those when the this2087 identity is selected, through command-line or2088 'sendemail.identity'.20892090sendemail.aliasesfile::2091sendemail.aliasfiletype::2092sendemail.annotate::2093sendemail.bcc::2094sendemail.cc::2095sendemail.cccmd::2096sendemail.chainreplyto::2097sendemail.confirm::2098sendemail.envelopesender::2099sendemail.from::2100sendemail.multiedit::2101sendemail.signedoffbycc::2102sendemail.smtppass::2103sendemail.suppresscc::2104sendemail.suppressfrom::2105sendemail.to::2106sendemail.smtpdomain::2107sendemail.smtpserver::2108sendemail.smtpserverport::2109sendemail.smtpserveroption::2110sendemail.smtpuser::2111sendemail.thread::2112sendemail.validate::2113 See linkgit:git-send-email[1] for description.21142115sendemail.signedoffcc::2116 Deprecated alias for 'sendemail.signedoffbycc'.21172118showbranch.default::2119 The default set of branches for linkgit:git-show-branch[1].2120 See linkgit:git-show-branch[1].21212122status.relativePaths::2123 By default, linkgit:git-status[1] shows paths relative to the2124 current directory. Setting this variable to `false` shows paths2125 relative to the repository root (this was the default for Git2126 prior to v1.5.4).21272128status.short::2129 Set to true to enable --short by default in linkgit:git-status[1].2130 The option --no-short takes precedence over this variable.21312132status.branch::2133 Set to true to enable --branch by default in linkgit:git-status[1].2134 The option --no-branch takes precedence over this variable.21352136status.showUntrackedFiles::2137 By default, linkgit:git-status[1] and linkgit:git-commit[1] show2138 files which are not currently tracked by Git. Directories which2139 contain only untracked files, are shown with the directory name2140 only. Showing untracked files means that Git needs to lstat() all2141 all the files in the whole repository, which might be slow on some2142 systems. So, this variable controls how the commands displays2143 the untracked files. Possible values are:2144+2145--2146* `no` - Show no untracked files.2147* `normal` - Show untracked files and directories.2148* `all` - Show also individual files in untracked directories.2149--2150+2151If this variable is not specified, it defaults to 'normal'.2152This variable can be overridden with the -u|--untracked-files option2153of linkgit:git-status[1] and linkgit:git-commit[1].21542155status.submodulesummary::2156 Defaults to false.2157 If this is set to a non zero number or true (identical to -1 or an2158 unlimited number), the submodule summary will be enabled and a2159 summary of commits for modified submodules will be shown (see2160 --summary-limit option of linkgit:git-submodule[1]).21612162submodule.<name>.path::2163submodule.<name>.url::2164submodule.<name>.update::2165 The path within this project, URL, and the updating strategy2166 for a submodule. These variables are initially populated2167 by 'git submodule init'; edit them to override the2168 URL and other values found in the `.gitmodules` file. See2169 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.21702171submodule.<name>.branch::2172 The remote branch name for a submodule, used by `git submodule2173 update --remote`. Set this option to override the value found in2174 the `.gitmodules` file. See linkgit:git-submodule[1] and2175 linkgit:gitmodules[5] for details.21762177submodule.<name>.fetchRecurseSubmodules::2178 This option can be used to control recursive fetching of this2179 submodule. It can be overridden by using the --[no-]recurse-submodules2180 command line option to "git fetch" and "git pull".2181 This setting will override that from in the linkgit:gitmodules[5]2182 file.21832184submodule.<name>.ignore::2185 Defines under what circumstances "git status" and the diff family show2186 a submodule as modified. When set to "all", it will never be considered2187 modified, "dirty" will ignore all changes to the submodules work tree and2188 takes only differences between the HEAD of the submodule and the commit2189 recorded in the superproject into account. "untracked" will additionally2190 let submodules with modified tracked files in their work tree show up.2191 Using "none" (the default when this option is not set) also shows2192 submodules that have untracked files in their work tree as changed.2193 This setting overrides any setting made in .gitmodules for this submodule,2194 both settings can be overridden on the command line by using the2195 "--ignore-submodules" option.21962197tar.umask::2198 This variable can be used to restrict the permission bits of2199 tar archive entries. The default is 0002, which turns off the2200 world write bit. The special value "user" indicates that the2201 archiving user's umask will be used instead. See umask(2) and2202 linkgit:git-archive[1].22032204transfer.fsckObjects::2205 When `fetch.fsckObjects` or `receive.fsckObjects` are2206 not set, the value of this variable is used instead.2207 Defaults to false.22082209transfer.hiderefs::2210 This variable can be used to set both `receive.hiderefs`2211 and `uploadpack.hiderefs` at the same time to the same2212 values. See entries for these other variables.22132214transfer.unpackLimit::2215 When `fetch.unpackLimit` or `receive.unpackLimit` are2216 not set, the value of this variable is used instead.2217 The default value is 100.22182219uploadpack.hiderefs::2220 String(s) `upload-pack` uses to decide which refs to omit2221 from its initial advertisement. Use more than one2222 definitions to specify multiple prefix strings. A ref that2223 are under the hierarchies listed on the value of this2224 variable is excluded, and is hidden from `git ls-remote`,2225 `git fetch`, etc. An attempt to fetch a hidden ref by `git2226 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.22272228uploadpack.allowtipsha1inwant::2229 When `uploadpack.hiderefs` is in effect, allow `upload-pack`2230 to accept a fetch request that asks for an object at the tip2231 of a hidden ref (by default, such a request is rejected).2232 see also `uploadpack.hiderefs`.22332234url.<base>.insteadOf::2235 Any URL that starts with this value will be rewritten to2236 start, instead, with <base>. In cases where some site serves a2237 large number of repositories, and serves them with multiple2238 access methods, and some users need to use different access2239 methods, this feature allows people to specify any of the2240 equivalent URLs and have Git automatically rewrite the URL to2241 the best alternative for the particular user, even for a2242 never-before-seen repository on the site. When more than one2243 insteadOf strings match a given URL, the longest match is used.22442245url.<base>.pushInsteadOf::2246 Any URL that starts with this value will not be pushed to;2247 instead, it will be rewritten to start with <base>, and the2248 resulting URL will be pushed to. In cases where some site serves2249 a large number of repositories, and serves them with multiple2250 access methods, some of which do not allow push, this feature2251 allows people to specify a pull-only URL and have Git2252 automatically use an appropriate URL to push, even for a2253 never-before-seen repository on the site. When more than one2254 pushInsteadOf strings match a given URL, the longest match is2255 used. If a remote has an explicit pushurl, Git will ignore this2256 setting for that remote.22572258user.email::2259 Your email address to be recorded in any newly created commits.2260 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and2261 'EMAIL' environment variables. See linkgit:git-commit-tree[1].22622263user.name::2264 Your full name to be recorded in any newly created commits.2265 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'2266 environment variables. See linkgit:git-commit-tree[1].22672268user.signingkey::2269 If linkgit:git-tag[1] is not selecting the key you want it to2270 automatically when creating a signed tag, you can override the2271 default selection with this variable. This option is passed2272 unchanged to gpg's --local-user parameter, so you may specify a key2273 using any method that gpg supports.22742275web.browser::2276 Specify a web browser that may be used by some commands.2277 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]2278 may use it.