1CONFIGURATION FILE 2------------------ 3 4The Git configuration file contains a number of variables that affect 5the Git commands' behavior. The `.git/config` file in each repository 6is used to store the configuration for that repository, and 7`$HOME/.gitconfig` is used to store a per-user configuration as 8fallback values for the `.git/config` file. The file `/etc/gitconfig` 9can be used to store a system-wide default configuration. 10 11The configuration variables are used by both the Git plumbing 12and the porcelains. The variables are divided into sections, wherein 13the fully qualified variable name of the variable itself is the last 14dot-separated segment and the section name is everything before the last 15dot. The variable names are case-insensitive, allow only alphanumeric 16characters and `-`, and must start with an alphabetic character. Some 17variables may appear multiple times; we say then that the variable is 18multivalued. 19 20Syntax 21~~~~~~ 22 23The syntax is fairly flexible and permissive; whitespaces are mostly 24ignored. The '#' and ';' characters begin comments to the end of line, 25blank lines are ignored. 26 27The file consists of sections and variables. A section begins with 28the name of the section in square brackets and continues until the next 29section begins. Section names are case-insensitive. Only alphanumeric 30characters, `-` and `.` are allowed in section names. Each variable 31must belong to some section, which means that there must be a section 32header before the first setting of a variable. 33 34Sections can be further divided into subsections. To begin a subsection 35put its name in double quotes, separated by space from the section name, 36in the section header, like in the example below: 37 38-------- 39 [section "subsection"] 40 41-------- 42 43Subsection names are case sensitive and can contain any characters except 44newline (doublequote `"` and backslash can be included by escaping them 45as `\"` and `\\`, respectively). Section headers cannot span multiple 46lines. Variables may belong directly to a section or to a given subsection. 47You can have `[section]` if you have `[section "subsection"]`, but you 48don't need to. 49 50There is also a deprecated `[section.subsection]` syntax. With this 51syntax, the subsection name is converted to lower-case and is also 52compared case sensitively. These subsection names follow the same 53restrictions as section names. 54 55All the other lines (and the remainder of the line after the section 56header) are recognized as setting variables, in the form 57'name = value' (or just 'name', which is a short-hand to say that 58the variable is the boolean "true"). 59The variable names are case-insensitive, allow only alphanumeric characters 60and `-`, and must start with an alphabetic character. 61 62A line that defines a value can be continued to the next line by 63ending it with a `\`; the backquote and the end-of-line are 64stripped. Leading whitespaces after 'name =', the remainder of the 65line after the first comment character '#' or ';', and trailing 66whitespaces of the line are discarded unless they are enclosed in 67double quotes. Internal whitespaces within the value are retained 68verbatim. 69 70Inside double quotes, double quote `"` and backslash `\` characters 71must be escaped: use `\"` for `"` and `\\` for `\`. 72 73The following escape sequences (beside `\"` and `\\`) are recognized: 74`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) 75and `\b` for backspace (BS). Other char escape sequences (including octal 76escape sequences) are invalid. 77 78 79Includes 80~~~~~~~~ 81 82You can include one config file from another by setting the special 83`include.path` variable to the name of the file to be included. The 84included file is expanded immediately, as if its contents had been 85found at the location of the include directive. If the value of the 86`include.path` variable is a relative path, the path is considered to be 87relative to the configuration file in which the include directive was 88found. The value of `include.path` is subject to tilde expansion: `~/` 89is expanded to the value of `$HOME`, and `~user/` to the specified 90user's home directory. See below for examples. 91 92Example 93~~~~~~~ 94 95 # Core variables 96 [core] 97 ; Don't trust file modes 98 filemode = false 99 100 # Our diff algorithm 101 [diff] 102 external = /usr/local/bin/diff-wrapper 103 renames = true 104 105 [branch "devel"] 106 remote = origin 107 merge = refs/heads/devel 108 109 # Proxy settings 110 [core] 111 gitProxy="ssh" for "kernel.org" 112 gitProxy=default-proxy ; for the rest 113 114 [include] 115 path = /path/to/foo.inc ; include by absolute path 116 path = foo ; expand "foo" relative to the current file 117 path = ~/foo ; expand "foo" in your $HOME directory 118 119 120Values 121~~~~~~ 122 123Values of many variables are treated as a simple string, but there 124are variables that take values of specific types and there are rules 125as to how to spell them. 126 127boolean:: 128 129 When a variable is said to take a boolean value, many 130 synonyms are accepted for 'true' and 'false'; these are all 131 case-insensitive. 132 133 true;; Boolean true can be spelled as `yes`, `on`, `true`, 134 or `1`. Also, a variable defined without `= <value>` 135 is taken as true. 136 137 false;; Boolean false can be spelled as `no`, `off`, 138 `false`, or `0`. 139+ 140When converting value to the canonical form using '--bool' type 141specifier; 'git config' will ensure that the output is "true" or 142"false" (spelled in lowercase). 143 144integer:: 145 The value for many variables that specify various sizes can 146 be suffixed with `k`, `M`,... to mean "scale the number by 147 1024", "by 1024x1024", etc. 148 149color:: 150 The value for a variables that takes a color is a list of 151 colors (at most two) and attributes (at most one), separated 152 by spaces. The colors accepted are `normal`, `black`, 153 `red`, `green`, `yellow`, `blue`, `magenta`, `cyan` and 154 `white`; the attributes are `bold`, `dim`, `ul`, `blink` and 155 `reverse`. The first color given is the foreground; the 156 second is the background. The position of the attribute, if 157 any, doesn't matter. Attributes may be turned off specifically 158 by prefixing them with `no` (e.g., `noreverse`, `noul`, etc). 159+ 160Colors (foreground and background) may also be given as numbers between 1610 and 255; these use ANSI 256-color mode (but note that not all 162terminals may support this). If your terminal supports it, you may also 163specify 24-bit RGB values as hex, like `#ff0ab3`. 164+ 165The attributes are meant to be reset at the beginning of each item 166in the colored output, so setting color.decorate.branch to `black` 167will paint that branch name in a plain `black`, even if the previous 168thing on the same output line (e.g. opening parenthesis before the 169list of branch names in `log --decorate` output) is set to be 170painted with `bold` or some other attribute. 171 172 173Variables 174~~~~~~~~~ 175 176Note that this list is non-comprehensive and not necessarily complete. 177For command-specific variables, you will find a more detailed description 178in the appropriate manual page. 179 180Other git-related tools may and do use their own variables. When 181inventing new variables for use in your own tool, make sure their 182names do not conflict with those that are used by Git itself and 183other popular tools, and describe them in your documentation. 184 185 186advice.*:: 187 These variables control various optional help messages designed to 188 aid new users. All 'advice.*' variables default to 'true', and you 189 can tell Git that you do not need help by setting these to 'false': 190+ 191-- 192 pushUpdateRejected:: 193 Set this variable to 'false' if you want to disable 194 'pushNonFFCurrent', 195 'pushNonFFMatching', 'pushAlreadyExists', 196 'pushFetchFirst', and 'pushNeedsForce' 197 simultaneously. 198 pushNonFFCurrent:: 199 Advice shown when linkgit:git-push[1] fails due to a 200 non-fast-forward update to the current branch. 201 pushNonFFMatching:: 202 Advice shown when you ran linkgit:git-push[1] and pushed 203 'matching refs' explicitly (i.e. you used ':', or 204 specified a refspec that isn't your current branch) and 205 it resulted in a non-fast-forward error. 206 pushAlreadyExists:: 207 Shown when linkgit:git-push[1] rejects an update that 208 does not qualify for fast-forwarding (e.g., a tag.) 209 pushFetchFirst:: 210 Shown when linkgit:git-push[1] rejects an update that 211 tries to overwrite a remote ref that points at an 212 object we do not have. 213 pushNeedsForce:: 214 Shown when linkgit:git-push[1] rejects an update that 215 tries to overwrite a remote ref that points at an 216 object that is not a commit-ish, or make the remote 217 ref point at an object that is not a commit-ish. 218 statusHints:: 219 Show directions on how to proceed from the current 220 state in the output of linkgit:git-status[1], in 221 the template shown when writing commit messages in 222 linkgit:git-commit[1], and in the help message shown 223 by linkgit:git-checkout[1] when switching branch. 224 statusUoption:: 225 Advise to consider using the `-u` option to linkgit:git-status[1] 226 when the command takes more than 2 seconds to enumerate untracked 227 files. 228 commitBeforeMerge:: 229 Advice shown when linkgit:git-merge[1] refuses to 230 merge to avoid overwriting local changes. 231 resolveConflict:: 232 Advice shown by various commands when conflicts 233 prevent the operation from being performed. 234 implicitIdentity:: 235 Advice on how to set your identity configuration when 236 your information is guessed from the system username and 237 domain name. 238 detachedHead:: 239 Advice shown when you used linkgit:git-checkout[1] to 240 move to the detach HEAD state, to instruct how to create 241 a local branch after the fact. 242 amWorkDir:: 243 Advice that shows the location of the patch file when 244 linkgit:git-am[1] fails to apply it. 245 rmHints:: 246 In case of failure in the output of linkgit:git-rm[1], 247 show directions on how to proceed from the current state. 248-- 249 250core.fileMode:: 251 Tells Git if the executable bit of files in the working tree 252 is to be honored. 253+ 254Some filesystems lose the executable bit when a file that is 255marked as executable is checked out, or checks out an 256non-executable file with executable bit on. 257linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem 258to see if it handles the executable bit correctly 259and this variable is automatically set as necessary. 260+ 261A repository, however, may be on a filesystem that handles 262the filemode correctly, and this variable is set to 'true' 263when created, but later may be made accessible from another 264environment that loses the filemode (e.g. exporting ext4 via 265CIFS mount, visiting a Cygwin created repository with 266Git for Windows or Eclipse). 267In such a case it may be necessary to set this variable to 'false'. 268See linkgit:git-update-index[1]. 269+ 270The default is true (when core.filemode is not specified in the config file). 271 272core.ignoreCase:: 273 If true, this option enables various workarounds to enable 274 Git to work better on filesystems that are not case sensitive, 275 like FAT. For example, if a directory listing finds 276 "makefile" when Git expects "Makefile", Git will assume 277 it is really the same file, and continue to remember it as 278 "Makefile". 279+ 280The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 281will probe and set core.ignoreCase true if appropriate when the repository 282is created. 283 284core.precomposeUnicode:: 285 This option is only used by Mac OS implementation of Git. 286 When core.precomposeUnicode=true, Git reverts the unicode decomposition 287 of filenames done by Mac OS. This is useful when sharing a repository 288 between Mac OS and Linux or Windows. 289 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 290 When false, file names are handled fully transparent by Git, 291 which is backward compatible with older versions of Git. 292 293core.protectHFS:: 294 If set to true, do not allow checkout of paths that would 295 be considered equivalent to `.git` on an HFS+ filesystem. 296 Defaults to `true` on Mac OS, and `false` elsewhere. 297 298core.protectNTFS:: 299 If set to true, do not allow checkout of paths that would 300 cause problems with the NTFS filesystem, e.g. conflict with 301 8.3 "short" names. 302 Defaults to `true` on Windows, and `false` elsewhere. 303 304core.trustctime:: 305 If false, the ctime differences between the index and the 306 working tree are ignored; useful when the inode change time 307 is regularly modified by something outside Git (file system 308 crawlers and some backup systems). 309 See linkgit:git-update-index[1]. True by default. 310 311core.checkStat:: 312 Determines which stat fields to match between the index 313 and work tree. The user can set this to 'default' or 314 'minimal'. Default (or explicitly 'default'), is to check 315 all fields, including the sub-second part of mtime and ctime. 316 317core.quotePath:: 318 The commands that output paths (e.g. 'ls-files', 319 'diff'), when not given the `-z` option, will quote 320 "unusual" characters in the pathname by enclosing the 321 pathname in a double-quote pair and with backslashes the 322 same way strings in C source code are quoted. If this 323 variable is set to false, the bytes higher than 0x80 are 324 not quoted but output as verbatim. Note that double 325 quote, backslash and control characters are always 326 quoted without `-z` regardless of the setting of this 327 variable. 328 329core.eol:: 330 Sets the line ending type to use in the working directory for 331 files that have the `text` property set. Alternatives are 332 'lf', 'crlf' and 'native', which uses the platform's native 333 line ending. The default value is `native`. See 334 linkgit:gitattributes[5] for more information on end-of-line 335 conversion. 336 337core.safecrlf:: 338 If true, makes Git check if converting `CRLF` is reversible when 339 end-of-line conversion is active. Git will verify if a command 340 modifies a file in the work tree either directly or indirectly. 341 For example, committing a file followed by checking out the 342 same file should yield the original file in the work tree. If 343 this is not the case for the current setting of 344 `core.autocrlf`, Git will reject the file. The variable can 345 be set to "warn", in which case Git will only warn about an 346 irreversible conversion but continue the operation. 347+ 348CRLF conversion bears a slight chance of corrupting data. 349When it is enabled, Git will convert CRLF to LF during commit and LF to 350CRLF during checkout. A file that contains a mixture of LF and 351CRLF before the commit cannot be recreated by Git. For text 352files this is the right thing to do: it corrects line endings 353such that we have only LF line endings in the repository. 354But for binary files that are accidentally classified as text the 355conversion can corrupt data. 356+ 357If you recognize such corruption early you can easily fix it by 358setting the conversion type explicitly in .gitattributes. Right 359after committing you still have the original file in your work 360tree and this file is not yet corrupted. You can explicitly tell 361Git that this file is binary and Git will handle the file 362appropriately. 363+ 364Unfortunately, the desired effect of cleaning up text files with 365mixed line endings and the undesired effect of corrupting binary 366files cannot be distinguished. In both cases CRLFs are removed 367in an irreversible way. For text files this is the right thing 368to do because CRLFs are line endings, while for binary files 369converting CRLFs corrupts data. 370+ 371Note, this safety check does not mean that a checkout will generate a 372file identical to the original file for a different setting of 373`core.eol` and `core.autocrlf`, but only for the current one. For 374example, a text file with `LF` would be accepted with `core.eol=lf` 375and could later be checked out with `core.eol=crlf`, in which case the 376resulting file would contain `CRLF`, although the original file 377contained `LF`. However, in both work trees the line endings would be 378consistent, that is either all `LF` or all `CRLF`, but never mixed. A 379file with mixed line endings would be reported by the `core.safecrlf` 380mechanism. 381 382core.autocrlf:: 383 Setting this variable to "true" is almost the same as setting 384 the `text` attribute to "auto" on all files except that text 385 files are not guaranteed to be normalized: files that contain 386 `CRLF` in the repository will not be touched. Use this 387 setting if you want to have `CRLF` line endings in your 388 working directory even though the repository does not have 389 normalized line endings. This variable can be set to 'input', 390 in which case no output conversion is performed. 391 392core.symlinks:: 393 If false, symbolic links are checked out as small plain files that 394 contain the link text. linkgit:git-update-index[1] and 395 linkgit:git-add[1] will not change the recorded type to regular 396 file. Useful on filesystems like FAT that do not support 397 symbolic links. 398+ 399The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 400will probe and set core.symlinks false if appropriate when the repository 401is created. 402 403core.gitProxy:: 404 A "proxy command" to execute (as 'command host port') instead 405 of establishing direct connection to the remote server when 406 using the Git protocol for fetching. If the variable value is 407 in the "COMMAND for DOMAIN" format, the command is applied only 408 on hostnames ending with the specified domain string. This variable 409 may be set multiple times and is matched in the given order; 410 the first match wins. 411+ 412Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 413(which always applies universally, without the special "for" 414handling). 415+ 416The special string `none` can be used as the proxy command to 417specify that no proxy be used for a given domain pattern. 418This is useful for excluding servers inside a firewall from 419proxy use, while defaulting to a common proxy for external domains. 420 421core.ignoreStat:: 422 If true, Git will avoid using lstat() calls to detect if files have 423 changed by setting the "assume-unchanged" bit for those tracked files 424 which it has updated identically in both the index and working tree. 425+ 426When files are modified outside of Git, the user will need to stage 427the modified files explicitly (e.g. see 'Examples' section in 428linkgit:git-update-index[1]). 429Git will not normally detect changes to those files. 430+ 431This is useful on systems where lstat() calls are very slow, such as 432CIFS/Microsoft Windows. 433+ 434False by default. 435 436core.preferSymlinkRefs:: 437 Instead of the default "symref" format for HEAD 438 and other symbolic reference files, use symbolic links. 439 This is sometimes needed to work with old scripts that 440 expect HEAD to be a symbolic link. 441 442core.bare:: 443 If true this repository is assumed to be 'bare' and has no 444 working directory associated with it. If this is the case a 445 number of commands that require a working directory will be 446 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 447+ 448This setting is automatically guessed by linkgit:git-clone[1] or 449linkgit:git-init[1] when the repository was created. By default a 450repository that ends in "/.git" is assumed to be not bare (bare = 451false), while all other repositories are assumed to be bare (bare 452= true). 453 454core.worktree:: 455 Set the path to the root of the working tree. 456 If GIT_COMMON_DIR environment variable is set, core.worktree 457 is ignored and not used for determining the root of working tree. 458 This can be overridden by the GIT_WORK_TREE environment 459 variable and the '--work-tree' command-line option. 460 The value can be an absolute path or relative to the path to 461 the .git directory, which is either specified by --git-dir 462 or GIT_DIR, or automatically discovered. 463 If --git-dir or GIT_DIR is specified but none of 464 --work-tree, GIT_WORK_TREE and core.worktree is specified, 465 the current working directory is regarded as the top level 466 of your working tree. 467+ 468Note that this variable is honored even when set in a configuration 469file in a ".git" subdirectory of a directory and its value differs 470from the latter directory (e.g. "/path/to/.git/config" has 471core.worktree set to "/different/path"), which is most likely a 472misconfiguration. Running Git commands in the "/path/to" directory will 473still use "/different/path" as the root of the work tree and can cause 474confusion unless you know what you are doing (e.g. you are creating a 475read-only snapshot of the same index to a location different from the 476repository's usual working tree). 477 478core.logAllRefUpdates:: 479 Enable the reflog. Updates to a ref <ref> is logged to the file 480 "$GIT_DIR/logs/<ref>", by appending the new and old 481 SHA-1, the date/time and the reason of the update, but 482 only when the file exists. If this configuration 483 variable is set to true, missing "$GIT_DIR/logs/<ref>" 484 file is automatically created for branch heads (i.e. under 485 refs/heads/), remote refs (i.e. under refs/remotes/), 486 note refs (i.e. under refs/notes/), and the symbolic ref HEAD. 487+ 488This information can be used to determine what commit 489was the tip of a branch "2 days ago". 490+ 491This value is true by default in a repository that has 492a working directory associated with it, and false by 493default in a bare repository. 494 495core.repositoryFormatVersion:: 496 Internal variable identifying the repository format and layout 497 version. 498 499core.sharedRepository:: 500 When 'group' (or 'true'), the repository is made shareable between 501 several users in a group (making sure all the files and objects are 502 group-writable). When 'all' (or 'world' or 'everybody'), the 503 repository will be readable by all users, additionally to being 504 group-shareable. When 'umask' (or 'false'), Git will use permissions 505 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 506 files in the repository will have this mode value. '0xxx' will override 507 user's umask value (whereas the other options will only override 508 requested parts of the user's umask value). Examples: '0660' will make 509 the repo read/write-able for the owner and group, but inaccessible to 510 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 511 repository that is group-readable but not group-writable. 512 See linkgit:git-init[1]. False by default. 513 514core.warnAmbiguousRefs:: 515 If true, Git will warn you if the ref name you passed it is ambiguous 516 and might match multiple refs in the repository. True by default. 517 518core.compression:: 519 An integer -1..9, indicating a default compression level. 520 -1 is the zlib default. 0 means no compression, 521 and 1..9 are various speed/size tradeoffs, 9 being slowest. 522 If set, this provides a default to other compression variables, 523 such as 'core.looseCompression' and 'pack.compression'. 524 525core.looseCompression:: 526 An integer -1..9, indicating the compression level for objects that 527 are not in a pack file. -1 is the zlib default. 0 means no 528 compression, and 1..9 are various speed/size tradeoffs, 9 being 529 slowest. If not set, defaults to core.compression. If that is 530 not set, defaults to 1 (best speed). 531 532core.packedGitWindowSize:: 533 Number of bytes of a pack file to map into memory in a 534 single mapping operation. Larger window sizes may allow 535 your system to process a smaller number of large pack files 536 more quickly. Smaller window sizes will negatively affect 537 performance due to increased calls to the operating system's 538 memory manager, but may improve performance when accessing 539 a large number of large pack files. 540+ 541Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 542MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 543be reasonable for all users/operating systems. You probably do 544not need to adjust this value. 545+ 546Common unit suffixes of 'k', 'm', or 'g' are supported. 547 548core.packedGitLimit:: 549 Maximum number of bytes to map simultaneously into memory 550 from pack files. If Git needs to access more than this many 551 bytes at once to complete an operation it will unmap existing 552 regions to reclaim virtual address space within the process. 553+ 554Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 555This should be reasonable for all users/operating systems, except on 556the largest projects. You probably do not need to adjust this value. 557+ 558Common unit suffixes of 'k', 'm', or 'g' are supported. 559 560core.deltaBaseCacheLimit:: 561 Maximum number of bytes to reserve for caching base objects 562 that may be referenced by multiple deltified objects. By storing the 563 entire decompressed base objects in a cache Git is able 564 to avoid unpacking and decompressing frequently used base 565 objects multiple times. 566+ 567Default is 96 MiB on all platforms. This should be reasonable 568for all users/operating systems, except on the largest projects. 569You probably do not need to adjust this value. 570+ 571Common unit suffixes of 'k', 'm', or 'g' are supported. 572 573core.bigFileThreshold:: 574 Files larger than this size are stored deflated, without 575 attempting delta compression. Storing large files without 576 delta compression avoids excessive memory usage, at the 577 slight expense of increased disk usage. Additionally files 578 larger than this size are always treated as binary. 579+ 580Default is 512 MiB on all platforms. This should be reasonable 581for most projects as source code and other text files can still 582be delta compressed, but larger binary media files won't be. 583+ 584Common unit suffixes of 'k', 'm', or 'g' are supported. 585 586core.excludesFile:: 587 In addition to '.gitignore' (per-directory) and 588 '.git/info/exclude', Git looks into this file for patterns 589 of files which are not meant to be tracked. "`~/`" is expanded 590 to the value of `$HOME` and "`~user/`" to the specified user's 591 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore. 592 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore 593 is used instead. See linkgit:gitignore[5]. 594 595core.askPass:: 596 Some commands (e.g. svn and http interfaces) that interactively 597 ask for a password can be told to use an external program given 598 via the value of this variable. Can be overridden by the 'GIT_ASKPASS' 599 environment variable. If not set, fall back to the value of the 600 'SSH_ASKPASS' environment variable or, failing that, a simple password 601 prompt. The external program shall be given a suitable prompt as 602 command-line argument and write the password on its STDOUT. 603 604core.attributesFile:: 605 In addition to '.gitattributes' (per-directory) and 606 '.git/info/attributes', Git looks into this file for attributes 607 (see linkgit:gitattributes[5]). Path expansions are made the same 608 way as for `core.excludesFile`. Its default value is 609 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not 610 set or empty, $HOME/.config/git/attributes is used instead. 611 612core.editor:: 613 Commands such as `commit` and `tag` that lets you edit 614 messages by launching an editor uses the value of this 615 variable when it is set, and the environment variable 616 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 617 618core.commentChar:: 619 Commands such as `commit` and `tag` that lets you edit 620 messages consider a line that begins with this character 621 commented, and removes them after the editor returns 622 (default '#'). 623+ 624If set to "auto", `git-commit` would select a character that is not 625the beginning character of any line in existing commit messages. 626 627core.packedRefsTimeout:: 628 The length of time, in milliseconds, to retry when trying to 629 lock the `packed-refs` file. Value 0 means not to retry at 630 all; -1 means to try indefinitely. Default is 1000 (i.e., 631 retry for 1 second). 632 633sequence.editor:: 634 Text editor used by `git rebase -i` for editing the rebase instruction file. 635 The value is meant to be interpreted by the shell when it is used. 636 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 637 When not configured the default commit message editor is used instead. 638 639core.pager:: 640 Text viewer for use by Git commands (e.g., 'less'). The value 641 is meant to be interpreted by the shell. The order of preference 642 is the `$GIT_PAGER` environment variable, then `core.pager` 643 configuration, then `$PAGER`, and then the default chosen at 644 compile time (usually 'less'). 645+ 646When the `LESS` environment variable is unset, Git sets it to `FRX` 647(if `LESS` environment variable is set, Git does not change it at 648all). If you want to selectively override Git's default setting 649for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 650be passed to the shell by Git, which will translate the final 651command to `LESS=FRX less -S`. The environment does not set the 652`S` option but the command line does, instructing less to truncate 653long lines. Similarly, setting `core.pager` to `less -+F` will 654deactivate the `F` option specified by the environment from the 655command-line, deactivating the "quit if one screen" behavior of 656`less`. One can specifically activate some flags for particular 657commands: for example, setting `pager.blame` to `less -S` enables 658line truncation only for `git blame`. 659+ 660Likewise, when the `LV` environment variable is unset, Git sets it 661to `-c`. You can override this setting by exporting `LV` with 662another value or setting `core.pager` to `lv +c`. 663 664core.whitespace:: 665 A comma separated list of common whitespace problems to 666 notice. 'git diff' will use `color.diff.whitespace` to 667 highlight them, and 'git apply --whitespace=error' will 668 consider them as errors. You can prefix `-` to disable 669 any of them (e.g. `-trailing-space`): 670+ 671* `blank-at-eol` treats trailing whitespaces at the end of the line 672 as an error (enabled by default). 673* `space-before-tab` treats a space character that appears immediately 674 before a tab character in the initial indent part of the line as an 675 error (enabled by default). 676* `indent-with-non-tab` treats a line that is indented with space 677 characters instead of the equivalent tabs as an error (not enabled by 678 default). 679* `tab-in-indent` treats a tab character in the initial indent part of 680 the line as an error (not enabled by default). 681* `blank-at-eof` treats blank lines added at the end of file as an error 682 (enabled by default). 683* `trailing-space` is a short-hand to cover both `blank-at-eol` and 684 `blank-at-eof`. 685* `cr-at-eol` treats a carriage-return at the end of line as 686 part of the line terminator, i.e. with it, `trailing-space` 687 does not trigger if the character before such a carriage-return 688 is not a whitespace (not enabled by default). 689* `tabwidth=<n>` tells how many character positions a tab occupies; this 690 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 691 errors. The default tab width is 8. Allowed values are 1 to 63. 692 693core.fsyncObjectFiles:: 694 This boolean will enable 'fsync()' when writing object files. 695+ 696This is a total waste of time and effort on a filesystem that orders 697data writes properly, but can be useful for filesystems that do not use 698journalling (traditional UNIX filesystems) or that only journal metadata 699and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 700 701core.preloadIndex:: 702 Enable parallel index preload for operations like 'git diff' 703+ 704This can speed up operations like 'git diff' and 'git status' especially 705on filesystems like NFS that have weak caching semantics and thus 706relatively high IO latencies. When enabled, Git will do the 707index comparison to the filesystem data in parallel, allowing 708overlapping IO's. Defaults to true. 709 710core.createObject:: 711 You can set this to 'link', in which case a hardlink followed by 712 a delete of the source are used to make sure that object creation 713 will not overwrite existing objects. 714+ 715On some file system/operating system combinations, this is unreliable. 716Set this config setting to 'rename' there; However, This will remove the 717check that makes sure that existing object files will not get overwritten. 718 719core.notesRef:: 720 When showing commit messages, also show notes which are stored in 721 the given ref. The ref must be fully qualified. If the given 722 ref does not exist, it is not an error but means that no 723 notes should be printed. 724+ 725This setting defaults to "refs/notes/commits", and it can be overridden by 726the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. 727 728core.sparseCheckout:: 729 Enable "sparse checkout" feature. See section "Sparse checkout" in 730 linkgit:git-read-tree[1] for more information. 731 732core.abbrev:: 733 Set the length object names are abbreviated to. If unspecified, 734 many commands abbreviate to 7 hexdigits, which may not be enough 735 for abbreviated object names to stay unique for sufficiently long 736 time. 737 738add.ignoreErrors:: 739add.ignore-errors (deprecated):: 740 Tells 'git add' to continue adding files when some files cannot be 741 added due to indexing errors. Equivalent to the '--ignore-errors' 742 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 743 as it does not follow the usual naming convention for configuration 744 variables. 745 746alias.*:: 747 Command aliases for the linkgit:git[1] command wrapper - e.g. 748 after defining "alias.last = cat-file commit HEAD", the invocation 749 "git last" is equivalent to "git cat-file commit HEAD". To avoid 750 confusion and troubles with script usage, aliases that 751 hide existing Git commands are ignored. Arguments are split by 752 spaces, the usual shell quoting and escaping is supported. 753 A quote pair or a backslash can be used to quote them. 754+ 755If the alias expansion is prefixed with an exclamation point, 756it will be treated as a shell command. For example, defining 757"alias.new = !gitk --all --not ORIG_HEAD", the invocation 758"git new" is equivalent to running the shell command 759"gitk --all --not ORIG_HEAD". Note that shell commands will be 760executed from the top-level directory of a repository, which may 761not necessarily be the current directory. 762'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix' 763from the original current directory. See linkgit:git-rev-parse[1]. 764 765am.keepcr:: 766 If true, git-am will call git-mailsplit for patches in mbox format 767 with parameter '--keep-cr'. In this case git-mailsplit will 768 not remove `\r` from lines ending with `\r\n`. Can be overridden 769 by giving '--no-keep-cr' from the command line. 770 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 771 772apply.ignoreWhitespace:: 773 When set to 'change', tells 'git apply' to ignore changes in 774 whitespace, in the same way as the '--ignore-space-change' 775 option. 776 When set to one of: no, none, never, false tells 'git apply' to 777 respect all whitespace differences. 778 See linkgit:git-apply[1]. 779 780apply.whitespace:: 781 Tells 'git apply' how to handle whitespaces, in the same way 782 as the '--whitespace' option. See linkgit:git-apply[1]. 783 784branch.autoSetupMerge:: 785 Tells 'git branch' and 'git checkout' to set up new branches 786 so that linkgit:git-pull[1] will appropriately merge from the 787 starting point branch. Note that even if this option is not set, 788 this behavior can be chosen per-branch using the `--track` 789 and `--no-track` options. The valid settings are: `false` -- no 790 automatic setup is done; `true` -- automatic setup is done when the 791 starting point is a remote-tracking branch; `always` -- 792 automatic setup is done when the starting point is either a 793 local branch or remote-tracking 794 branch. This option defaults to true. 795 796branch.autoSetupRebase:: 797 When a new branch is created with 'git branch' or 'git checkout' 798 that tracks another branch, this variable tells Git to set 799 up pull to rebase instead of merge (see "branch.<name>.rebase"). 800 When `never`, rebase is never automatically set to true. 801 When `local`, rebase is set to true for tracked branches of 802 other local branches. 803 When `remote`, rebase is set to true for tracked branches of 804 remote-tracking branches. 805 When `always`, rebase will be set to true for all tracking 806 branches. 807 See "branch.autoSetupMerge" for details on how to set up a 808 branch to track another branch. 809 This option defaults to never. 810 811branch.<name>.remote:: 812 When on branch <name>, it tells 'git fetch' and 'git push' 813 which remote to fetch from/push to. The remote to push to 814 may be overridden with `remote.pushDefault` (for all branches). 815 The remote to push to, for the current branch, may be further 816 overridden by `branch.<name>.pushRemote`. If no remote is 817 configured, or if you are not on any branch, it defaults to 818 `origin` for fetching and `remote.pushDefault` for pushing. 819 Additionally, `.` (a period) is the current local repository 820 (a dot-repository), see `branch.<name>.merge`'s final note below. 821 822branch.<name>.pushRemote:: 823 When on branch <name>, it overrides `branch.<name>.remote` for 824 pushing. It also overrides `remote.pushDefault` for pushing 825 from branch <name>. When you pull from one place (e.g. your 826 upstream) and push to another place (e.g. your own publishing 827 repository), you would want to set `remote.pushDefault` to 828 specify the remote to push to for all branches, and use this 829 option to override it for a specific branch. 830 831branch.<name>.merge:: 832 Defines, together with branch.<name>.remote, the upstream branch 833 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which 834 branch to merge and can also affect 'git push' (see push.default). 835 When in branch <name>, it tells 'git fetch' the default 836 refspec to be marked for merging in FETCH_HEAD. The value is 837 handled like the remote part of a refspec, and must match a 838 ref which is fetched from the remote given by 839 "branch.<name>.remote". 840 The merge information is used by 'git pull' (which at first calls 841 'git fetch') to lookup the default branch for merging. Without 842 this option, 'git pull' defaults to merge the first refspec fetched. 843 Specify multiple values to get an octopus merge. 844 If you wish to setup 'git pull' so that it merges into <name> from 845 another branch in the local repository, you can point 846 branch.<name>.merge to the desired branch, and use the relative path 847 setting `.` (a period) for branch.<name>.remote. 848 849branch.<name>.mergeOptions:: 850 Sets default options for merging into branch <name>. The syntax and 851 supported options are the same as those of linkgit:git-merge[1], but 852 option values containing whitespace characters are currently not 853 supported. 854 855branch.<name>.rebase:: 856 When true, rebase the branch <name> on top of the fetched branch, 857 instead of merging the default branch from the default remote when 858 "git pull" is run. See "pull.rebase" for doing this in a non 859 branch-specific manner. 860+ 861 When preserve, also pass `--preserve-merges` along to 'git rebase' 862 so that locally committed merge commits will not be flattened 863 by running 'git pull'. 864+ 865*NOTE*: this is a possibly dangerous operation; do *not* use 866it unless you understand the implications (see linkgit:git-rebase[1] 867for details). 868 869branch.<name>.description:: 870 Branch description, can be edited with 871 `git branch --edit-description`. Branch description is 872 automatically added in the format-patch cover letter or 873 request-pull summary. 874 875browser.<tool>.cmd:: 876 Specify the command to invoke the specified browser. The 877 specified command is evaluated in shell with the URLs passed 878 as arguments. (See linkgit:git-web{litdd}browse[1].) 879 880browser.<tool>.path:: 881 Override the path for the given tool that may be used to 882 browse HTML help (see '-w' option in linkgit:git-help[1]) or a 883 working repository in gitweb (see linkgit:git-instaweb[1]). 884 885clean.requireForce:: 886 A boolean to make git-clean do nothing unless given -f, 887 -i or -n. Defaults to true. 888 889color.branch:: 890 A boolean to enable/disable color in the output of 891 linkgit:git-branch[1]. May be set to `always`, 892 `false` (or `never`) or `auto` (or `true`), in which case colors are used 893 only when the output is to a terminal. Defaults to false. 894 895color.branch.<slot>:: 896 Use customized color for branch coloration. `<slot>` is one of 897 `current` (the current branch), `local` (a local branch), 898 `remote` (a remote-tracking branch in refs/remotes/), 899 `upstream` (upstream tracking branch), `plain` (other 900 refs). 901 902color.diff:: 903 Whether to use ANSI escape sequences to add color to patches. 904 If this is set to `always`, linkgit:git-diff[1], 905 linkgit:git-log[1], and linkgit:git-show[1] will use color 906 for all patches. If it is set to `true` or `auto`, those 907 commands will only use color when output is to the terminal. 908 Defaults to false. 909+ 910This does not affect linkgit:git-format-patch[1] or the 911'git-diff-{asterisk}' plumbing commands. Can be overridden on the 912command line with the `--color[=<when>]` option. 913 914color.diff.<slot>:: 915 Use customized color for diff colorization. `<slot>` specifies 916 which part of the patch to use the specified color, and is one 917 of `context` (context text - `plain` is a historical synonym), 918 `meta` (metainformation), `frag` 919 (hunk header), 'func' (function in hunk header), `old` (removed lines), 920 `new` (added lines), `commit` (commit headers), or `whitespace` 921 (highlighting whitespace errors). 922 923color.decorate.<slot>:: 924 Use customized color for 'git log --decorate' output. `<slot>` is one 925 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 926 branches, remote-tracking branches, tags, stash and HEAD, respectively. 927 928color.grep:: 929 When set to `always`, always highlight matches. When `false` (or 930 `never`), never. When set to `true` or `auto`, use color only 931 when the output is written to the terminal. Defaults to `false`. 932 933color.grep.<slot>:: 934 Use customized color for grep colorization. `<slot>` specifies which 935 part of the line to use the specified color, and is one of 936+ 937-- 938`context`;; 939 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 940`filename`;; 941 filename prefix (when not using `-h`) 942`function`;; 943 function name lines (when using `-p`) 944`linenumber`;; 945 line number prefix (when using `-n`) 946`match`;; 947 matching text (same as setting `matchContext` and `matchSelected`) 948`matchContext`;; 949 matching text in context lines 950`matchSelected`;; 951 matching text in selected lines 952`selected`;; 953 non-matching text in selected lines 954`separator`;; 955 separators between fields on a line (`:`, `-`, and `=`) 956 and between hunks (`--`) 957-- 958 959color.interactive:: 960 When set to `always`, always use colors for interactive prompts 961 and displays (such as those used by "git-add --interactive" and 962 "git-clean --interactive"). When false (or `never`), never. 963 When set to `true` or `auto`, use colors only when the output is 964 to the terminal. Defaults to false. 965 966color.interactive.<slot>:: 967 Use customized color for 'git add --interactive' and 'git clean 968 --interactive' output. `<slot>` may be `prompt`, `header`, `help` 969 or `error`, for four distinct types of normal output from 970 interactive commands. 971 972color.pager:: 973 A boolean to enable/disable colored output when the pager is in 974 use (default is true). 975 976color.showBranch:: 977 A boolean to enable/disable color in the output of 978 linkgit:git-show-branch[1]. May be set to `always`, 979 `false` (or `never`) or `auto` (or `true`), in which case colors are used 980 only when the output is to a terminal. Defaults to false. 981 982color.status:: 983 A boolean to enable/disable color in the output of 984 linkgit:git-status[1]. May be set to `always`, 985 `false` (or `never`) or `auto` (or `true`), in which case colors are used 986 only when the output is to a terminal. Defaults to false. 987 988color.status.<slot>:: 989 Use customized color for status colorization. `<slot>` is 990 one of `header` (the header text of the status message), 991 `added` or `updated` (files which are added but not committed), 992 `changed` (files which are changed but not added in the index), 993 `untracked` (files which are not tracked by Git), 994 `branch` (the current branch), 995 `nobranch` (the color the 'no branch' warning is shown in, defaulting 996 to red), or 997 `unmerged` (files which have unmerged changes). 998 999color.ui::1000 This variable determines the default value for variables such1001 as `color.diff` and `color.grep` that control the use of color1002 per command family. Its scope will expand as more commands learn1003 configuration to set a default for the `--color` option. Set it1004 to `false` or `never` if you prefer Git commands not to use1005 color unless enabled explicitly with some other configuration1006 or the `--color` option. Set it to `always` if you want all1007 output not intended for machine consumption to use color, to1008 `true` or `auto` (this is the default since Git 1.8.4) if you1009 want such output to use color when written to the terminal.10101011column.ui::1012 Specify whether supported commands should output in columns.1013 This variable consists of a list of tokens separated by spaces1014 or commas:1015+1016These options control when the feature should be enabled1017(defaults to 'never'):1018+1019--1020`always`;;1021 always show in columns1022`never`;;1023 never show in columns1024`auto`;;1025 show in columns if the output is to the terminal1026--1027+1028These options control layout (defaults to 'column'). Setting any1029of these implies 'always' if none of 'always', 'never', or 'auto' are1030specified.1031+1032--1033`column`;;1034 fill columns before rows1035`row`;;1036 fill rows before columns1037`plain`;;1038 show in one column1039--1040+1041Finally, these options can be combined with a layout option (defaults1042to 'nodense'):1043+1044--1045`dense`;;1046 make unequal size columns to utilize more space1047`nodense`;;1048 make equal size columns1049--10501051column.branch::1052 Specify whether to output branch listing in `git branch` in columns.1053 See `column.ui` for details.10541055column.clean::1056 Specify the layout when list items in `git clean -i`, which always1057 shows files and directories in columns. See `column.ui` for details.10581059column.status::1060 Specify whether to output untracked files in `git status` in columns.1061 See `column.ui` for details.10621063column.tag::1064 Specify whether to output tag listing in `git tag` in columns.1065 See `column.ui` for details.10661067commit.cleanup::1068 This setting overrides the default of the `--cleanup` option in1069 `git commit`. See linkgit:git-commit[1] for details. Changing the1070 default can be useful when you always want to keep lines that begin1071 with comment character `#` in your log message, in which case you1072 would do `git config commit.cleanup whitespace` (note that you will1073 have to remove the help lines that begin with `#` in the commit log1074 template yourself, if you do this).10751076commit.gpgSign::10771078 A boolean to specify whether all commits should be GPG signed.1079 Use of this option when doing operations such as rebase can1080 result in a large number of commits being signed. It may be1081 convenient to use an agent to avoid typing your GPG passphrase1082 several times.10831084commit.status::1085 A boolean to enable/disable inclusion of status information in the1086 commit message template when using an editor to prepare the commit1087 message. Defaults to true.10881089commit.template::1090 Specify a file to use as the template for new commit messages.1091 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the1092 specified user's home directory.10931094credential.helper::1095 Specify an external helper to be called when a username or1096 password credential is needed; the helper may consult external1097 storage to avoid prompting the user for the credentials. See1098 linkgit:gitcredentials[7] for details.10991100credential.useHttpPath::1101 When acquiring credentials, consider the "path" component of an http1102 or https URL to be important. Defaults to false. See1103 linkgit:gitcredentials[7] for more information.11041105credential.username::1106 If no username is set for a network authentication, use this username1107 by default. See credential.<context>.* below, and1108 linkgit:gitcredentials[7].11091110credential.<url>.*::1111 Any of the credential.* options above can be applied selectively to1112 some credentials. For example "credential.https://example.com.username"1113 would set the default username only for https connections to1114 example.com. See linkgit:gitcredentials[7] for details on how URLs are1115 matched.11161117include::diff-config.txt[]11181119difftool.<tool>.path::1120 Override the path for the given tool. This is useful in case1121 your tool is not in the PATH.11221123difftool.<tool>.cmd::1124 Specify the command to invoke the specified diff tool.1125 The specified command is evaluated in shell with the following1126 variables available: 'LOCAL' is set to the name of the temporary1127 file containing the contents of the diff pre-image and 'REMOTE'1128 is set to the name of the temporary file containing the contents1129 of the diff post-image.11301131difftool.prompt::1132 Prompt before each invocation of the diff tool.11331134fetch.recurseSubmodules::1135 This option can be either set to a boolean value or to 'on-demand'.1136 Setting it to a boolean changes the behavior of fetch and pull to1137 unconditionally recurse into submodules when set to true or to not1138 recurse at all when set to false. When set to 'on-demand' (the default1139 value), fetch and pull will only recurse into a populated submodule1140 when its superproject retrieves a commit that updates the submodule's1141 reference.11421143fetch.fsckObjects::1144 If it is set to true, git-fetch-pack will check all fetched1145 objects. It will abort in the case of a malformed object or a1146 broken link. The result of an abort are only dangling objects.1147 Defaults to false. If not set, the value of `transfer.fsckObjects`1148 is used instead.11491150fetch.unpackLimit::1151 If the number of objects fetched over the Git native1152 transfer is below this1153 limit, then the objects will be unpacked into loose object1154 files. However if the number of received objects equals or1155 exceeds this limit then the received pack will be stored as1156 a pack, after adding any missing delta bases. Storing the1157 pack from a push can make the push operation complete faster,1158 especially on slow filesystems. If not set, the value of1159 `transfer.unpackLimit` is used instead.11601161fetch.prune::1162 If true, fetch will automatically behave as if the `--prune`1163 option was given on the command line. See also `remote.<name>.prune`.11641165format.attach::1166 Enable multipart/mixed attachments as the default for1167 'format-patch'. The value can also be a double quoted string1168 which will enable attachments as the default and set the1169 value as the boundary. See the --attach option in1170 linkgit:git-format-patch[1].11711172format.numbered::1173 A boolean which can enable or disable sequence numbers in patch1174 subjects. It defaults to "auto" which enables it only if there1175 is more than one patch. It can be enabled or disabled for all1176 messages by setting it to "true" or "false". See --numbered1177 option in linkgit:git-format-patch[1].11781179format.headers::1180 Additional email headers to include in a patch to be submitted1181 by mail. See linkgit:git-format-patch[1].11821183format.to::1184format.cc::1185 Additional recipients to include in a patch to be submitted1186 by mail. See the --to and --cc options in1187 linkgit:git-format-patch[1].11881189format.subjectPrefix::1190 The default for format-patch is to output files with the '[PATCH]'1191 subject prefix. Use this variable to change that prefix.11921193format.signature::1194 The default for format-patch is to output a signature containing1195 the Git version number. Use this variable to change that default.1196 Set this variable to the empty string ("") to suppress1197 signature generation.11981199format.signatureFile::1200 Works just like format.signature except the contents of the1201 file specified by this variable will be used as the signature.12021203format.suffix::1204 The default for format-patch is to output files with the suffix1205 `.patch`. Use this variable to change that suffix (make sure to1206 include the dot if you want it).12071208format.pretty::1209 The default pretty format for log/show/whatchanged command,1210 See linkgit:git-log[1], linkgit:git-show[1],1211 linkgit:git-whatchanged[1].12121213format.thread::1214 The default threading style for 'git format-patch'. Can be1215 a boolean value, or `shallow` or `deep`. `shallow` threading1216 makes every mail a reply to the head of the series,1217 where the head is chosen from the cover letter, the1218 `--in-reply-to`, and the first patch mail, in this order.1219 `deep` threading makes every mail a reply to the previous one.1220 A true boolean value is the same as `shallow`, and a false1221 value disables threading.12221223format.signOff::1224 A boolean value which lets you enable the `-s/--signoff` option of1225 format-patch by default. *Note:* Adding the Signed-off-by: line to a1226 patch should be a conscious act and means that you certify you have1227 the rights to submit this work under the same open source license.1228 Please see the 'SubmittingPatches' document for further discussion.12291230format.coverLetter::1231 A boolean that controls whether to generate a cover-letter when1232 format-patch is invoked, but in addition can be set to "auto", to1233 generate a cover-letter only when there's more than one patch.12341235filter.<driver>.clean::1236 The command which is used to convert the content of a worktree1237 file to a blob upon checkin. See linkgit:gitattributes[5] for1238 details.12391240filter.<driver>.smudge::1241 The command which is used to convert the content of a blob1242 object to a worktree file upon checkout. See1243 linkgit:gitattributes[5] for details.12441245fsck.<msg-id>::1246 Allows overriding the message type (error, warn or ignore) of a1247 specific message ID such as `missingEmail`.1248+1249For convenience, fsck prefixes the error/warning with the message ID,1250e.g. "missingEmail: invalid author/committer line - missing email" means1251that setting `fsck.missingEmail = ignore` will hide that issue.1252+1253This feature is intended to support working with legacy repositories1254which cannot be repaired without disruptive changes.12551256gc.aggressiveDepth::1257 The depth parameter used in the delta compression1258 algorithm used by 'git gc --aggressive'. This defaults1259 to 250.12601261gc.aggressiveWindow::1262 The window size parameter used in the delta compression1263 algorithm used by 'git gc --aggressive'. This defaults1264 to 250.12651266gc.auto::1267 When there are approximately more than this many loose1268 objects in the repository, `git gc --auto` will pack them.1269 Some Porcelain commands use this command to perform a1270 light-weight garbage collection from time to time. The1271 default value is 6700. Setting this to 0 disables it.12721273gc.autoPackLimit::1274 When there are more than this many packs that are not1275 marked with `*.keep` file in the repository, `git gc1276 --auto` consolidates them into one larger pack. The1277 default value is 50. Setting this to 0 disables it.12781279gc.autoDetach::1280 Make `git gc --auto` return immediately and run in background1281 if the system supports it. Default is true.12821283gc.packRefs::1284 Running `git pack-refs` in a repository renders it1285 unclonable by Git versions prior to 1.5.1.2 over dumb1286 transports such as HTTP. This variable determines whether1287 'git gc' runs `git pack-refs`. This can be set to `notbare`1288 to enable it within all non-bare repos or it can be set to a1289 boolean value. The default is `true`.12901291gc.pruneExpire::1292 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1293 Override the grace period with this config variable. The value1294 "now" may be used to disable this grace period and always prune1295 unreachable objects immediately.12961297gc.pruneWorktreesExpire::1298 When 'git gc' is run, it will call1299 'prune --worktrees --expire 3.months.ago'.1300 Override the grace period with this config variable. The value1301 "now" may be used to disable the grace period and prune1302 $GIT_DIR/worktrees immediately.13031304gc.reflogExpire::1305gc.<pattern>.reflogExpire::1306 'git reflog expire' removes reflog entries older than1307 this time; defaults to 90 days. With "<pattern>" (e.g.1308 "refs/stash") in the middle the setting applies only to1309 the refs that match the <pattern>.13101311gc.reflogExpireUnreachable::1312gc.<ref>.reflogExpireUnreachable::1313 'git reflog expire' removes reflog entries older than1314 this time and are not reachable from the current tip;1315 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")1316 in the middle, the setting applies only to the refs that1317 match the <pattern>.13181319gc.rerereResolved::1320 Records of conflicted merge you resolved earlier are1321 kept for this many days when 'git rerere gc' is run.1322 The default is 60 days. See linkgit:git-rerere[1].13231324gc.rerereUnresolved::1325 Records of conflicted merge you have not resolved are1326 kept for this many days when 'git rerere gc' is run.1327 The default is 15 days. See linkgit:git-rerere[1].13281329gitcvs.commitMsgAnnotation::1330 Append this string to each commit message. Set to empty string1331 to disable this feature. Defaults to "via git-CVS emulator".13321333gitcvs.enabled::1334 Whether the CVS server interface is enabled for this repository.1335 See linkgit:git-cvsserver[1].13361337gitcvs.logFile::1338 Path to a log file where the CVS server interface well... logs1339 various stuff. See linkgit:git-cvsserver[1].13401341gitcvs.usecrlfattr::1342 If true, the server will look up the end-of-line conversion1343 attributes for files to determine the '-k' modes to use. If1344 the attributes force Git to treat a file as text,1345 the '-k' mode will be left blank so CVS clients will1346 treat it as text. If they suppress text conversion, the file1347 will be set with '-kb' mode, which suppresses any newline munging1348 the client might otherwise do. If the attributes do not allow1349 the file type to be determined, then 'gitcvs.allBinary' is1350 used. See linkgit:gitattributes[5].13511352gitcvs.allBinary::1353 This is used if 'gitcvs.usecrlfattr' does not resolve1354 the correct '-kb' mode to use. If true, all1355 unresolved files are sent to the client in1356 mode '-kb'. This causes the client to treat them1357 as binary files, which suppresses any newline munging it1358 otherwise might do. Alternatively, if it is set to "guess",1359 then the contents of the file are examined to decide if1360 it is binary, similar to 'core.autocrlf'.13611362gitcvs.dbName::1363 Database used by git-cvsserver to cache revision information1364 derived from the Git repository. The exact meaning depends on the1365 used database driver, for SQLite (which is the default driver) this1366 is a filename. Supports variable substitution (see1367 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1368 Default: '%Ggitcvs.%m.sqlite'13691370gitcvs.dbDriver::1371 Used Perl DBI driver. You can specify any available driver1372 for this here, but it might not work. git-cvsserver is tested1373 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1374 reported *not* to work with 'DBD::mysql'. Experimental feature.1375 May not contain double colons (`:`). Default: 'SQLite'.1376 See linkgit:git-cvsserver[1].13771378gitcvs.dbUser, gitcvs.dbPass::1379 Database user and password. Only useful if setting 'gitcvs.dbDriver',1380 since SQLite has no concept of database users and/or passwords.1381 'gitcvs.dbUser' supports variable substitution (see1382 linkgit:git-cvsserver[1] for details).13831384gitcvs.dbTableNamePrefix::1385 Database table name prefix. Prepended to the names of any1386 database tables used, allowing a single database to be used1387 for several repositories. Supports variable substitution (see1388 linkgit:git-cvsserver[1] for details). Any non-alphabetic1389 characters will be replaced with underscores.13901391All gitcvs variables except for 'gitcvs.usecrlfattr' and1392'gitcvs.allBinary' can also be specified as1393'gitcvs.<access_method>.<varname>' (where 'access_method'1394is one of "ext" and "pserver") to make them apply only for the given1395access method.13961397gitweb.category::1398gitweb.description::1399gitweb.owner::1400gitweb.url::1401 See linkgit:gitweb[1] for description.14021403gitweb.avatar::1404gitweb.blame::1405gitweb.grep::1406gitweb.highlight::1407gitweb.patches::1408gitweb.pickaxe::1409gitweb.remote_heads::1410gitweb.showSizes::1411gitweb.snapshot::1412 See linkgit:gitweb.conf[5] for description.14131414grep.lineNumber::1415 If set to true, enable '-n' option by default.14161417grep.patternType::1418 Set the default matching behavior. Using a value of 'basic', 'extended',1419 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',1420 '--fixed-strings', or '--perl-regexp' option accordingly, while the1421 value 'default' will return to the default matching behavior.14221423grep.extendedRegexp::1424 If set to true, enable '--extended-regexp' option by default. This1425 option is ignored when the 'grep.patternType' option is set to a value1426 other than 'default'.14271428gpg.program::1429 Use this custom program instead of "gpg" found on $PATH when1430 making or verifying a PGP signature. The program must support the1431 same command-line interface as GPG, namely, to verify a detached1432 signature, "gpg --verify $file - <$signature" is run, and the1433 program is expected to signal a good signature by exiting with1434 code 0, and to generate an ASCII-armored detached signature, the1435 standard input of "gpg -bsau $key" is fed with the contents to be1436 signed, and the program is expected to send the result to its1437 standard output.14381439gui.commitMsgWidth::1440 Defines how wide the commit message window is in the1441 linkgit:git-gui[1]. "75" is the default.14421443gui.diffContext::1444 Specifies how many context lines should be used in calls to diff1445 made by the linkgit:git-gui[1]. The default is "5".14461447gui.displayUntracked::1448 Determines if linkgit::git-gui[1] shows untracked files1449 in the file list. The default is "true".14501451gui.encoding::1452 Specifies the default encoding to use for displaying of1453 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1454 It can be overridden by setting the 'encoding' attribute1455 for relevant files (see linkgit:gitattributes[5]).1456 If this option is not set, the tools default to the1457 locale encoding.14581459gui.matchTrackingBranch::1460 Determines if new branches created with linkgit:git-gui[1] should1461 default to tracking remote branches with matching names or1462 not. Default: "false".14631464gui.newBranchTemplate::1465 Is used as suggested name when creating new branches using the1466 linkgit:git-gui[1].14671468gui.pruneDuringFetch::1469 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1470 performing a fetch. The default value is "false".14711472gui.trustmtime::1473 Determines if linkgit:git-gui[1] should trust the file modification1474 timestamp or not. By default the timestamps are not trusted.14751476gui.spellingDictionary::1477 Specifies the dictionary used for spell checking commit messages in1478 the linkgit:git-gui[1]. When set to "none" spell checking is turned1479 off.14801481gui.fastCopyBlame::1482 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1483 location detection. It makes blame significantly faster on huge1484 repositories at the expense of less thorough copy detection.14851486gui.copyBlameThreshold::1487 Specifies the threshold to use in 'git gui blame' original location1488 detection, measured in alphanumeric characters. See the1489 linkgit:git-blame[1] manual for more information on copy detection.14901491gui.blamehistoryctx::1492 Specifies the radius of history context in days to show in1493 linkgit:gitk[1] for the selected commit, when the `Show History1494 Context` menu item is invoked from 'git gui blame'. If this1495 variable is set to zero, the whole history is shown.14961497guitool.<name>.cmd::1498 Specifies the shell command line to execute when the corresponding item1499 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1500 mandatory for every tool. The command is executed from the root of1501 the working directory, and in the environment it receives the name of1502 the tool as 'GIT_GUITOOL', the name of the currently selected file as1503 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1504 the head is detached, 'CUR_BRANCH' is empty).15051506guitool.<name>.needsFile::1507 Run the tool only if a diff is selected in the GUI. It guarantees1508 that 'FILENAME' is not empty.15091510guitool.<name>.noConsole::1511 Run the command silently, without creating a window to display its1512 output.15131514guitool.<name>.noRescan::1515 Don't rescan the working directory for changes after the tool1516 finishes execution.15171518guitool.<name>.confirm::1519 Show a confirmation dialog before actually running the tool.15201521guitool.<name>.argPrompt::1522 Request a string argument from the user, and pass it to the tool1523 through the 'ARGS' environment variable. Since requesting an1524 argument implies confirmation, the 'confirm' option has no effect1525 if this is enabled. If the option is set to 'true', 'yes', or '1',1526 the dialog uses a built-in generic prompt; otherwise the exact1527 value of the variable is used.15281529guitool.<name>.revPrompt::1530 Request a single valid revision from the user, and set the1531 'REVISION' environment variable. In other aspects this option1532 is similar to 'argPrompt', and can be used together with it.15331534guitool.<name>.revUnmerged::1535 Show only unmerged branches in the 'revPrompt' subdialog.1536 This is useful for tools similar to merge or rebase, but not1537 for things like checkout or reset.15381539guitool.<name>.title::1540 Specifies the title to use for the prompt dialog. The default1541 is the tool name.15421543guitool.<name>.prompt::1544 Specifies the general prompt string to display at the top of1545 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1546 The default value includes the actual command.15471548help.browser::1549 Specify the browser that will be used to display help in the1550 'web' format. See linkgit:git-help[1].15511552help.format::1553 Override the default help format used by linkgit:git-help[1].1554 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1555 the default. 'web' and 'html' are the same.15561557help.autoCorrect::1558 Automatically correct and execute mistyped commands after1559 waiting for the given number of deciseconds (0.1 sec). If more1560 than one command can be deduced from the entered text, nothing1561 will be executed. If the value of this option is negative,1562 the corrected command will be executed immediately. If the1563 value is 0 - the command will be just shown but not executed.1564 This is the default.15651566help.htmlPath::1567 Specify the path where the HTML documentation resides. File system paths1568 and URLs are supported. HTML pages will be prefixed with this path when1569 help is displayed in the 'web' format. This defaults to the documentation1570 path of your Git installation.15711572http.proxy::1573 Override the HTTP proxy, normally configured using the 'http_proxy',1574 'https_proxy', and 'all_proxy' environment variables (see1575 `curl(1)`). This can be overridden on a per-remote basis; see1576 remote.<name>.proxy15771578http.cookieFile::1579 File containing previously stored cookie lines which should be used1580 in the Git http session, if they match the server. The file format1581 of the file to read cookies from should be plain HTTP headers or1582 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).1583 NOTE that the file specified with http.cookieFile is only used as1584 input unless http.saveCookies is set.15851586http.saveCookies::1587 If set, store cookies received during requests to the file specified by1588 http.cookieFile. Has no effect if http.cookieFile is unset.15891590http.sslCipherList::1591 A list of SSL ciphers to use when negotiating an SSL connection.1592 The available ciphers depend on whether libcurl was built against1593 NSS or OpenSSL and the particular configuration of the crypto1594 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'1595 option; see the libcurl documentation for more details on the format1596 of this list.1597+1598Can be overridden by the 'GIT_SSL_CIPHER_LIST' environment variable.1599To force git to use libcurl's default cipher list and ignore any1600explicit http.sslCipherList option, set 'GIT_SSL_CIPHER_LIST' to the1601empty string.16021603http.sslVerify::1604 Whether to verify the SSL certificate when fetching or pushing1605 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment1606 variable.16071608http.sslCert::1609 File containing the SSL certificate when fetching or pushing1610 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment1611 variable.16121613http.sslKey::1614 File containing the SSL private key when fetching or pushing1615 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment1616 variable.16171618http.sslCertPasswordProtected::1619 Enable Git's password prompt for the SSL certificate. Otherwise1620 OpenSSL will prompt the user, possibly many times, if the1621 certificate or private key is encrypted. Can be overridden by the1622 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.16231624http.sslCAInfo::1625 File containing the certificates to verify the peer with when1626 fetching or pushing over HTTPS. Can be overridden by the1627 'GIT_SSL_CAINFO' environment variable.16281629http.sslCAPath::1630 Path containing files with the CA certificates to verify the peer1631 with when fetching or pushing over HTTPS. Can be overridden1632 by the 'GIT_SSL_CAPATH' environment variable.16331634http.sslTry::1635 Attempt to use AUTH SSL/TLS and encrypted data transfers1636 when connecting via regular FTP protocol. This might be needed1637 if the FTP server requires it for security reasons or you wish1638 to connect securely whenever remote FTP server supports it.1639 Default is false since it might trigger certificate verification1640 errors on misconfigured servers.16411642http.maxRequests::1643 How many HTTP requests to launch in parallel. Can be overridden1644 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.16451646http.minSessions::1647 The number of curl sessions (counted across slots) to be kept across1648 requests. They will not be ended with curl_easy_cleanup() until1649 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1650 value will be capped at 1. Defaults to 1.16511652http.postBuffer::1653 Maximum size in bytes of the buffer used by smart HTTP1654 transports when POSTing data to the remote system.1655 For requests larger than this buffer size, HTTP/1.1 and1656 Transfer-Encoding: chunked is used to avoid creating a1657 massive pack file locally. Default is 1 MiB, which is1658 sufficient for most requests.16591660http.lowSpeedLimit, http.lowSpeedTime::1661 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1662 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1663 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and1664 'GIT_HTTP_LOW_SPEED_TIME' environment variables.16651666http.noEPSV::1667 A boolean which disables using of EPSV ftp command by curl.1668 This can helpful with some "poor" ftp servers which don't1669 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'1670 environment variable. Default is false (curl will use EPSV).16711672http.userAgent::1673 The HTTP USER_AGENT string presented to an HTTP server. The default1674 value represents the version of the client Git such as git/1.7.1.1675 This option allows you to override this value to a more common value1676 such as Mozilla/4.0. This may be necessary, for instance, if1677 connecting through a firewall that restricts HTTP connections to a set1678 of common USER_AGENT strings (but not including those like git/1.7.1).1679 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.16801681http.<url>.*::1682 Any of the http.* options above can be applied selectively to some URLs.1683 For a config key to match a URL, each element of the config key is1684 compared to that of the URL, in the following order:1685+1686--1687. Scheme (e.g., `https` in `https://example.com/`). This field1688 must match exactly between the config key and the URL.16891690. Host/domain name (e.g., `example.com` in `https://example.com/`).1691 This field must match exactly between the config key and the URL.16921693. Port number (e.g., `8080` in `http://example.com:8080/`).1694 This field must match exactly between the config key and the URL.1695 Omitted port numbers are automatically converted to the correct1696 default for the scheme before matching.16971698. Path (e.g., `repo.git` in `https://example.com/repo.git`). The1699 path field of the config key must match the path field of the URL1700 either exactly or as a prefix of slash-delimited path elements. This means1701 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only1702 match on a slash (`/`) boundary. Longer matches take precedence (so a config1703 key with path `foo/bar` is a better match to URL path `foo/bar` than a config1704 key with just path `foo/`).17051706. User name (e.g., `user` in `https://user@example.com/repo.git`). If1707 the config key has a user name it must match the user name in the1708 URL exactly. If the config key does not have a user name, that1709 config key will match a URL with any user name (including none),1710 but at a lower precedence than a config key with a user name.1711--1712+1713The list above is ordered by decreasing precedence; a URL that matches1714a config key's path is preferred to one that matches its user name. For example,1715if the URL is `https://user@example.com/foo/bar` a config key match of1716`https://example.com/foo` will be preferred over a config key match of1717`https://user@example.com`.1718+1719All URLs are normalized before attempting any matching (the password part,1720if embedded in the URL, is always ignored for matching purposes) so that1721equivalent URLs that are simply spelled differently will match properly.1722Environment variable settings always override any matches. The URLs that are1723matched against are those given directly to Git commands. This means any URLs1724visited as a result of a redirection do not participate in matching.17251726i18n.commitEncoding::1727 Character encoding the commit messages are stored in; Git itself1728 does not care per se, but this information is necessary e.g. when1729 importing commits from emails or in the gitk graphical history1730 browser (and possibly at other places in the future or in other1731 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.17321733i18n.logOutputEncoding::1734 Character encoding the commit messages are converted to when1735 running 'git log' and friends.17361737imap::1738 The configuration variables in the 'imap' section are described1739 in linkgit:git-imap-send[1].17401741index.version::1742 Specify the version with which new index files should be1743 initialized. This does not affect existing repositories.17441745init.templateDir::1746 Specify the directory from which templates will be copied.1747 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)17481749instaweb.browser::1750 Specify the program that will be used to browse your working1751 repository in gitweb. See linkgit:git-instaweb[1].17521753instaweb.httpd::1754 The HTTP daemon command-line to start gitweb on your working1755 repository. See linkgit:git-instaweb[1].17561757instaweb.local::1758 If true the web server started by linkgit:git-instaweb[1] will1759 be bound to the local IP (127.0.0.1).17601761instaweb.modulePath::1762 The default module path for linkgit:git-instaweb[1] to use1763 instead of /usr/lib/apache2/modules. Only used if httpd1764 is Apache.17651766instaweb.port::1767 The port number to bind the gitweb httpd to. See1768 linkgit:git-instaweb[1].17691770interactive.singleKey::1771 In interactive commands, allow the user to provide one-letter1772 input with a single key (i.e., without hitting enter).1773 Currently this is used by the `--patch` mode of1774 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],1775 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this1776 setting is silently ignored if portable keystroke input1777 is not available; requires the Perl module Term::ReadKey.17781779log.abbrevCommit::1780 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1781 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may1782 override this option with `--no-abbrev-commit`.17831784log.date::1785 Set the default date-time mode for the 'log' command.1786 Setting a value for log.date is similar to using 'git log''s1787 `--date` option. Possible values are `relative`, `local`,1788 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]1789 for details.17901791log.decorate::1792 Print out the ref names of any commits that are shown by the log1793 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1794 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1795 specified, the full ref name (including prefix) will be printed.1796 This is the same as the log commands '--decorate' option.17971798log.showRoot::1799 If true, the initial commit will be shown as a big creation event.1800 This is equivalent to a diff against an empty tree.1801 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1802 normally hide the root commit will now show it. True by default.18031804log.mailmap::1805 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1806 linkgit:git-whatchanged[1] assume `--use-mailmap`.18071808mailinfo.scissors::1809 If true, makes linkgit:git-mailinfo[1] (and therefore1810 linkgit:git-am[1]) act by default as if the --scissors option1811 was provided on the command-line. When active, this features1812 removes everything from the message body before a scissors1813 line (i.e. consisting mainly of ">8", "8<" and "-").18141815mailmap.file::1816 The location of an augmenting mailmap file. The default1817 mailmap, located in the root of the repository, is loaded1818 first, then the mailmap file pointed to by this variable.1819 The location of the mailmap file may be in a repository1820 subdirectory, or somewhere outside of the repository itself.1821 See linkgit:git-shortlog[1] and linkgit:git-blame[1].18221823mailmap.blob::1824 Like `mailmap.file`, but consider the value as a reference to a1825 blob in the repository. If both `mailmap.file` and1826 `mailmap.blob` are given, both are parsed, with entries from1827 `mailmap.file` taking precedence. In a bare repository, this1828 defaults to `HEAD:.mailmap`. In a non-bare repository, it1829 defaults to empty.18301831man.viewer::1832 Specify the programs that may be used to display help in the1833 'man' format. See linkgit:git-help[1].18341835man.<tool>.cmd::1836 Specify the command to invoke the specified man viewer. The1837 specified command is evaluated in shell with the man page1838 passed as argument. (See linkgit:git-help[1].)18391840man.<tool>.path::1841 Override the path for the given tool that may be used to1842 display help in the 'man' format. See linkgit:git-help[1].18431844include::merge-config.txt[]18451846mergetool.<tool>.path::1847 Override the path for the given tool. This is useful in case1848 your tool is not in the PATH.18491850mergetool.<tool>.cmd::1851 Specify the command to invoke the specified merge tool. The1852 specified command is evaluated in shell with the following1853 variables available: 'BASE' is the name of a temporary file1854 containing the common base of the files to be merged, if available;1855 'LOCAL' is the name of a temporary file containing the contents of1856 the file on the current branch; 'REMOTE' is the name of a temporary1857 file containing the contents of the file from the branch being1858 merged; 'MERGED' contains the name of the file to which the merge1859 tool should write the results of a successful merge.18601861mergetool.<tool>.trustExitCode::1862 For a custom merge command, specify whether the exit code of1863 the merge command can be used to determine whether the merge was1864 successful. If this is not set to true then the merge target file1865 timestamp is checked and the merge assumed to have been successful1866 if the file has been updated, otherwise the user is prompted to1867 indicate the success of the merge.18681869mergetool.meld.hasOutput::1870 Older versions of `meld` do not support the `--output` option.1871 Git will attempt to detect whether `meld` supports `--output`1872 by inspecting the output of `meld --help`. Configuring1873 `mergetool.meld.hasOutput` will make Git skip these checks and1874 use the configured value instead. Setting `mergetool.meld.hasOutput`1875 to `true` tells Git to unconditionally use the `--output` option,1876 and `false` avoids using `--output`.18771878mergetool.keepBackup::1879 After performing a merge, the original file with conflict markers1880 can be saved as a file with a `.orig` extension. If this variable1881 is set to `false` then this file is not preserved. Defaults to1882 `true` (i.e. keep the backup files).18831884mergetool.keepTemporaries::1885 When invoking a custom merge tool, Git uses a set of temporary1886 files to pass to the tool. If the tool returns an error and this1887 variable is set to `true`, then these temporary files will be1888 preserved, otherwise they will be removed after the tool has1889 exited. Defaults to `false`.18901891mergetool.writeToTemp::1892 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of1893 conflicting files in the worktree by default. Git will attempt1894 to use a temporary directory for these files when set `true`.1895 Defaults to `false`.18961897mergetool.prompt::1898 Prompt before each invocation of the merge resolution program.18991900notes.displayRef::1901 The (fully qualified) refname from which to show notes when1902 showing commit messages. The value of this variable can be set1903 to a glob, in which case notes from all matching refs will be1904 shown. You may also specify this configuration variable1905 several times. A warning will be issued for refs that do not1906 exist, but a glob that does not match any refs is silently1907 ignored.1908+1909This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`1910environment variable, which must be a colon separated list of refs or1911globs.1912+1913The effective value of "core.notesRef" (possibly overridden by1914GIT_NOTES_REF) is also implicitly added to the list of refs to be1915displayed.19161917notes.rewrite.<command>::1918 When rewriting commits with <command> (currently `amend` or1919 `rebase`) and this variable is set to `true`, Git1920 automatically copies your notes from the original to the1921 rewritten commit. Defaults to `true`, but see1922 "notes.rewriteRef" below.19231924notes.rewriteMode::1925 When copying notes during a rewrite (see the1926 "notes.rewrite.<command>" option), determines what to do if1927 the target commit already has a note. Must be one of1928 `overwrite`, `concatenate`, or `ignore`. Defaults to1929 `concatenate`.1930+1931This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`1932environment variable.19331934notes.rewriteRef::1935 When copying notes during a rewrite, specifies the (fully1936 qualified) ref whose notes should be copied. The ref may be a1937 glob, in which case notes in all matching refs will be copied.1938 You may also specify this configuration several times.1939+1940Does not have a default value; you must configure this variable to1941enable note rewriting. Set it to `refs/notes/commits` to enable1942rewriting for the default commit notes.1943+1944This setting can be overridden with the `GIT_NOTES_REWRITE_REF`1945environment variable, which must be a colon separated list of refs or1946globs.19471948pack.window::1949 The size of the window used by linkgit:git-pack-objects[1] when no1950 window size is given on the command line. Defaults to 10.19511952pack.depth::1953 The maximum delta depth used by linkgit:git-pack-objects[1] when no1954 maximum depth is given on the command line. Defaults to 50.19551956pack.windowMemory::1957 The maximum size of memory that is consumed by each thread1958 in linkgit:git-pack-objects[1] for pack window memory when1959 no limit is given on the command line. The value can be1960 suffixed with "k", "m", or "g". When left unconfigured (or1961 set explicitly to 0), there will be no limit.19621963pack.compression::1964 An integer -1..9, indicating the compression level for objects1965 in a pack file. -1 is the zlib default. 0 means no1966 compression, and 1..9 are various speed/size tradeoffs, 9 being1967 slowest. If not set, defaults to core.compression. If that is1968 not set, defaults to -1, the zlib default, which is "a default1969 compromise between speed and compression (currently equivalent1970 to level 6)."1971+1972Note that changing the compression level will not automatically recompress1973all existing objects. You can force recompression by passing the -F option1974to linkgit:git-repack[1].19751976pack.deltaCacheSize::1977 The maximum memory in bytes used for caching deltas in1978 linkgit:git-pack-objects[1] before writing them out to a pack.1979 This cache is used to speed up the writing object phase by not1980 having to recompute the final delta result once the best match1981 for all objects is found. Repacking large repositories on machines1982 which are tight with memory might be badly impacted by this though,1983 especially if this cache pushes the system into swapping.1984 A value of 0 means no limit. The smallest size of 1 byte may be1985 used to virtually disable this cache. Defaults to 256 MiB.19861987pack.deltaCacheLimit::1988 The maximum size of a delta, that is cached in1989 linkgit:git-pack-objects[1]. This cache is used to speed up the1990 writing object phase by not having to recompute the final delta1991 result once the best match for all objects is found. Defaults to 1000.19921993pack.threads::1994 Specifies the number of threads to spawn when searching for best1995 delta matches. This requires that linkgit:git-pack-objects[1]1996 be compiled with pthreads otherwise this option is ignored with a1997 warning. This is meant to reduce packing time on multiprocessor1998 machines. The required amount of memory for the delta search window1999 is however multiplied by the number of threads.2000 Specifying 0 will cause Git to auto-detect the number of CPU's2001 and set the number of threads accordingly.20022003pack.indexVersion::2004 Specify the default pack index version. Valid values are 1 for2005 legacy pack index used by Git versions prior to 1.5.2, and 2 for2006 the new pack index with capabilities for packs larger than 4 GB2007 as well as proper protection against the repacking of corrupted2008 packs. Version 2 is the default. Note that version 2 is enforced2009 and this config option ignored whenever the corresponding pack is2010 larger than 2 GB.2011+2012If you have an old Git that does not understand the version 2 `*.idx` file,2013cloning or fetching over a non native protocol (e.g. "http" and "rsync")2014that will copy both `*.pack` file and corresponding `*.idx` file from the2015other side may give you a repository that cannot be accessed with your2016older version of Git. If the `*.pack` file is smaller than 2 GB, however,2017you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2018the `*.idx` file.20192020pack.packSizeLimit::2021 The maximum size of a pack. This setting only affects2022 packing to a file when repacking, i.e. the git:// protocol2023 is unaffected. It can be overridden by the `--max-pack-size`2024 option of linkgit:git-repack[1]. The minimum size allowed is2025 limited to 1 MiB. The default is unlimited.2026 Common unit suffixes of 'k', 'm', or 'g' are2027 supported.20282029pack.useBitmaps::2030 When true, git will use pack bitmaps (if available) when packing2031 to stdout (e.g., during the server side of a fetch). Defaults to2032 true. You should not generally need to turn this off unless2033 you are debugging pack bitmaps.20342035pack.writeBitmaps (deprecated)::2036 This is a deprecated synonym for `repack.writeBitmaps`.20372038pack.writeBitmapHashCache::2039 When true, git will include a "hash cache" section in the bitmap2040 index (if one is written). This cache can be used to feed git's2041 delta heuristics, potentially leading to better deltas between2042 bitmapped and non-bitmapped objects (e.g., when serving a fetch2043 between an older, bitmapped pack and objects that have been2044 pushed since the last gc). The downside is that it consumes 42045 bytes per object of disk space, and that JGit's bitmap2046 implementation does not understand it, causing it to complain if2047 Git and JGit are used on the same repository. Defaults to false.20482049pager.<cmd>::2050 If the value is boolean, turns on or off pagination of the2051 output of a particular Git subcommand when writing to a tty.2052 Otherwise, turns on pagination for the subcommand using the2053 pager specified by the value of `pager.<cmd>`. If `--paginate`2054 or `--no-pager` is specified on the command line, it takes2055 precedence over this option. To disable pagination for all2056 commands, set `core.pager` or `GIT_PAGER` to `cat`.20572058pretty.<name>::2059 Alias for a --pretty= format string, as specified in2060 linkgit:git-log[1]. Any aliases defined here can be used just2061 as the built-in pretty formats could. For example,2062 running `git config pretty.changelog "format:* %H %s"`2063 would cause the invocation `git log --pretty=changelog`2064 to be equivalent to running `git log "--pretty=format:* %H %s"`.2065 Note that an alias with the same name as a built-in format2066 will be silently ignored.20672068pull.ff::2069 By default, Git does not create an extra merge commit when merging2070 a commit that is a descendant of the current commit. Instead, the2071 tip of the current branch is fast-forwarded. When set to `false`,2072 this variable tells Git to create an extra merge commit in such2073 a case (equivalent to giving the `--no-ff` option from the command2074 line). When set to `only`, only such fast-forward merges are2075 allowed (equivalent to giving the `--ff-only` option from the2076 command line). This setting overrides `merge.ff` when pulling.20772078pull.rebase::2079 When true, rebase branches on top of the fetched branch, instead2080 of merging the default branch from the default remote when "git2081 pull" is run. See "branch.<name>.rebase" for setting this on a2082 per-branch basis.2083+2084 When preserve, also pass `--preserve-merges` along to 'git rebase'2085 so that locally committed merge commits will not be flattened2086 by running 'git pull'.2087+2088*NOTE*: this is a possibly dangerous operation; do *not* use2089it unless you understand the implications (see linkgit:git-rebase[1]2090for details).20912092pull.octopus::2093 The default merge strategy to use when pulling multiple branches2094 at once.20952096pull.twohead::2097 The default merge strategy to use when pulling a single branch.20982099push.default::2100 Defines the action `git push` should take if no refspec is2101 explicitly given. Different values are well-suited for2102 specific workflows; for instance, in a purely central workflow2103 (i.e. the fetch source is equal to the push destination),2104 `upstream` is probably what you want. Possible values are:2105+2106--21072108* `nothing` - do not push anything (error out) unless a refspec is2109 explicitly given. This is primarily meant for people who want to2110 avoid mistakes by always being explicit.21112112* `current` - push the current branch to update a branch with the same2113 name on the receiving end. Works in both central and non-central2114 workflows.21152116* `upstream` - push the current branch back to the branch whose2117 changes are usually integrated into the current branch (which is2118 called `@{upstream}`). This mode only makes sense if you are2119 pushing to the same repository you would normally pull from2120 (i.e. central workflow).21212122* `simple` - in centralized workflow, work like `upstream` with an2123 added safety to refuse to push if the upstream branch's name is2124 different from the local one.2125+2126When pushing to a remote that is different from the remote you normally2127pull from, work as `current`. This is the safest option and is suited2128for beginners.2129+2130This mode has become the default in Git 2.0.21312132* `matching` - push all branches having the same name on both ends.2133 This makes the repository you are pushing to remember the set of2134 branches that will be pushed out (e.g. if you always push 'maint'2135 and 'master' there and no other branches, the repository you push2136 to will have these two branches, and your local 'maint' and2137 'master' will be pushed there).2138+2139To use this mode effectively, you have to make sure _all_ the2140branches you would push out are ready to be pushed out before2141running 'git push', as the whole point of this mode is to allow you2142to push all of the branches in one go. If you usually finish work2143on only one branch and push out the result, while other branches are2144unfinished, this mode is not for you. Also this mode is not2145suitable for pushing into a shared central repository, as other2146people may add new branches there, or update the tip of existing2147branches outside your control.2148+2149This used to be the default, but not since Git 2.0 (`simple` is the2150new default).21512152--21532154push.followTags::2155 If set to true enable '--follow-tags' option by default. You2156 may override this configuration at time of push by specifying2157 '--no-follow-tags'.215821592160rebase.stat::2161 Whether to show a diffstat of what changed upstream since the last2162 rebase. False by default.21632164rebase.autoSquash::2165 If set to true enable '--autosquash' option by default.21662167rebase.autoStash::2168 When set to true, automatically create a temporary stash2169 before the operation begins, and apply it after the operation2170 ends. This means that you can run rebase on a dirty worktree.2171 However, use with care: the final stash application after a2172 successful rebase might result in non-trivial conflicts.2173 Defaults to false.21742175receive.advertiseAtomic::2176 By default, git-receive-pack will advertise the atomic push2177 capability to its clients. If you don't want to this capability2178 to be advertised, set this variable to false.21792180receive.autogc::2181 By default, git-receive-pack will run "git-gc --auto" after2182 receiving data from git-push and updating refs. You can stop2183 it by setting this variable to false.21842185receive.certNonceSeed::2186 By setting this variable to a string, `git receive-pack`2187 will accept a `git push --signed` and verifies it by using2188 a "nonce" protected by HMAC using this string as a secret2189 key.21902191receive.certNonceSlop::2192 When a `git push --signed` sent a push certificate with a2193 "nonce" that was issued by a receive-pack serving the same2194 repository within this many seconds, export the "nonce"2195 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2196 hooks (instead of what the receive-pack asked the sending2197 side to include). This may allow writing checks in2198 `pre-receive` and `post-receive` a bit easier. Instead of2199 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2200 that records by how many seconds the nonce is stale to2201 decide if they want to accept the certificate, they only2202 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.22032204receive.fsckObjects::2205 If it is set to true, git-receive-pack will check all received2206 objects. It will abort in the case of a malformed object or a2207 broken link. The result of an abort are only dangling objects.2208 Defaults to false. If not set, the value of `transfer.fsckObjects`2209 is used instead.22102211receive.fsck.<msg-id>::2212 When `receive.fsckObjects` is set to true, errors can be switched2213 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2214 setting where the `<msg-id>` is the fsck message ID and the value2215 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2216 the error/warning with the message ID, e.g. "missingEmail: invalid2217 author/committer line - missing email" means that setting2218 `receive.fsck.missingEmail = ignore` will hide that issue.2219+2220This feature is intended to support working with legacy repositories2221which would not pass pushing when `receive.fsckObjects = true`, allowing2222the host to accept repositories with certain known issues but still catch2223other issues.22242225receive.unpackLimit::2226 If the number of objects received in a push is below this2227 limit then the objects will be unpacked into loose object2228 files. However if the number of received objects equals or2229 exceeds this limit then the received pack will be stored as2230 a pack, after adding any missing delta bases. Storing the2231 pack from a push can make the push operation complete faster,2232 especially on slow filesystems. If not set, the value of2233 `transfer.unpackLimit` is used instead.22342235receive.denyDeletes::2236 If set to true, git-receive-pack will deny a ref update that deletes2237 the ref. Use this to prevent such a ref deletion via a push.22382239receive.denyDeleteCurrent::2240 If set to true, git-receive-pack will deny a ref update that2241 deletes the currently checked out branch of a non-bare repository.22422243receive.denyCurrentBranch::2244 If set to true or "refuse", git-receive-pack will deny a ref update2245 to the currently checked out branch of a non-bare repository.2246 Such a push is potentially dangerous because it brings the HEAD2247 out of sync with the index and working tree. If set to "warn",2248 print a warning of such a push to stderr, but allow the push to2249 proceed. If set to false or "ignore", allow such pushes with no2250 message. Defaults to "refuse".2251+2252Another option is "updateInstead" which will update the working2253tree if pushing into the current branch. This option is2254intended for synchronizing working directories when one side is not easily2255accessible via interactive ssh (e.g. a live web site, hence the requirement2256that the working directory be clean). This mode also comes in handy when2257developing inside a VM to test and fix code on different Operating Systems.2258+2259By default, "updateInstead" will refuse the push if the working tree or2260the index have any difference from the HEAD, but the `push-to-checkout`2261hook can be used to customize this. See linkgit:githooks[5].22622263receive.denyNonFastForwards::2264 If set to true, git-receive-pack will deny a ref update which is2265 not a fast-forward. Use this to prevent such an update via a push,2266 even if that push is forced. This configuration variable is2267 set when initializing a shared repository.22682269receive.hideRefs::2270 String(s) `receive-pack` uses to decide which refs to omit2271 from its initial advertisement. Use more than one2272 definitions to specify multiple prefix strings. A ref that2273 are under the hierarchies listed on the value of this2274 variable is excluded, and is hidden when responding to `git2275 push`, and an attempt to update or delete a hidden ref by2276 `git push` is rejected.22772278receive.updateServerInfo::2279 If set to true, git-receive-pack will run git-update-server-info2280 after receiving data from git-push and updating refs.22812282receive.shallowUpdate::2283 If set to true, .git/shallow can be updated when new refs2284 require new shallow roots. Otherwise those refs are rejected.22852286remote.pushDefault::2287 The remote to push to by default. Overrides2288 `branch.<name>.remote` for all branches, and is overridden by2289 `branch.<name>.pushRemote` for specific branches.22902291remote.<name>.url::2292 The URL of a remote repository. See linkgit:git-fetch[1] or2293 linkgit:git-push[1].22942295remote.<name>.pushurl::2296 The push URL of a remote repository. See linkgit:git-push[1].22972298remote.<name>.proxy::2299 For remotes that require curl (http, https and ftp), the URL to2300 the proxy to use for that remote. Set to the empty string to2301 disable proxying for that remote.23022303remote.<name>.fetch::2304 The default set of "refspec" for linkgit:git-fetch[1]. See2305 linkgit:git-fetch[1].23062307remote.<name>.push::2308 The default set of "refspec" for linkgit:git-push[1]. See2309 linkgit:git-push[1].23102311remote.<name>.mirror::2312 If true, pushing to this remote will automatically behave2313 as if the `--mirror` option was given on the command line.23142315remote.<name>.skipDefaultUpdate::2316 If true, this remote will be skipped by default when updating2317 using linkgit:git-fetch[1] or the `update` subcommand of2318 linkgit:git-remote[1].23192320remote.<name>.skipFetchAll::2321 If true, this remote will be skipped by default when updating2322 using linkgit:git-fetch[1] or the `update` subcommand of2323 linkgit:git-remote[1].23242325remote.<name>.receivepack::2326 The default program to execute on the remote side when pushing. See2327 option --receive-pack of linkgit:git-push[1].23282329remote.<name>.uploadpack::2330 The default program to execute on the remote side when fetching. See2331 option --upload-pack of linkgit:git-fetch-pack[1].23322333remote.<name>.tagOpt::2334 Setting this value to --no-tags disables automatic tag following when2335 fetching from remote <name>. Setting it to --tags will fetch every2336 tag from remote <name>, even if they are not reachable from remote2337 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2338 override this setting. See options --tags and --no-tags of2339 linkgit:git-fetch[1].23402341remote.<name>.vcs::2342 Setting this to a value <vcs> will cause Git to interact with2343 the remote with the git-remote-<vcs> helper.23442345remote.<name>.prune::2346 When set to true, fetching from this remote by default will also2347 remove any remote-tracking references that no longer exist on the2348 remote (as if the `--prune` option was given on the command line).2349 Overrides `fetch.prune` settings, if any.23502351remotes.<group>::2352 The list of remotes which are fetched by "git remote update2353 <group>". See linkgit:git-remote[1].23542355repack.useDeltaBaseOffset::2356 By default, linkgit:git-repack[1] creates packs that use2357 delta-base offset. If you need to share your repository with2358 Git older than version 1.4.4, either directly or via a dumb2359 protocol such as http, then you need to set this option to2360 "false" and repack. Access from old Git versions over the2361 native protocol are unaffected by this option.23622363repack.packKeptObjects::2364 If set to true, makes `git repack` act as if2365 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2366 details. Defaults to `false` normally, but `true` if a bitmap2367 index is being written (either via `--write-bitmap-index` or2368 `repack.writeBitmaps`).23692370repack.writeBitmaps::2371 When true, git will write a bitmap index when packing all2372 objects to disk (e.g., when `git repack -a` is run). This2373 index can speed up the "counting objects" phase of subsequent2374 packs created for clones and fetches, at the cost of some disk2375 space and extra time spent on the initial repack. Defaults to2376 false.23772378rerere.autoUpdate::2379 When set to true, `git-rerere` updates the index with the2380 resulting contents after it cleanly resolves conflicts using2381 previously recorded resolution. Defaults to false.23822383rerere.enabled::2384 Activate recording of resolved conflicts, so that identical2385 conflict hunks can be resolved automatically, should they be2386 encountered again. By default, linkgit:git-rerere[1] is2387 enabled if there is an `rr-cache` directory under the2388 `$GIT_DIR`, e.g. if "rerere" was previously used in the2389 repository.23902391sendemail.identity::2392 A configuration identity. When given, causes values in the2393 'sendemail.<identity>' subsection to take precedence over2394 values in the 'sendemail' section. The default identity is2395 the value of 'sendemail.identity'.23962397sendemail.smtpEncryption::2398 See linkgit:git-send-email[1] for description. Note that this2399 setting is not subject to the 'identity' mechanism.24002401sendemail.smtpssl (deprecated)::2402 Deprecated alias for 'sendemail.smtpEncryption = ssl'.24032404sendemail.smtpsslcertpath::2405 Path to ca-certificates (either a directory or a single file).2406 Set it to an empty string to disable certificate verification.24072408sendemail.<identity>.*::2409 Identity-specific versions of the 'sendemail.*' parameters2410 found below, taking precedence over those when the this2411 identity is selected, through command-line or2412 'sendemail.identity'.24132414sendemail.aliasesFile::2415sendemail.aliasFileType::2416sendemail.annotate::2417sendemail.bcc::2418sendemail.cc::2419sendemail.ccCmd::2420sendemail.chainReplyTo::2421sendemail.confirm::2422sendemail.envelopeSender::2423sendemail.from::2424sendemail.multiEdit::2425sendemail.signedoffbycc::2426sendemail.smtpPass::2427sendemail.suppresscc::2428sendemail.suppressFrom::2429sendemail.to::2430sendemail.smtpDomain::2431sendemail.smtpServer::2432sendemail.smtpServerPort::2433sendemail.smtpServerOption::2434sendemail.smtpUser::2435sendemail.thread::2436sendemail.transferEncoding::2437sendemail.validate::2438sendemail.xmailer::2439 See linkgit:git-send-email[1] for description.24402441sendemail.signedoffcc (deprecated)::2442 Deprecated alias for 'sendemail.signedoffbycc'.24432444showbranch.default::2445 The default set of branches for linkgit:git-show-branch[1].2446 See linkgit:git-show-branch[1].24472448status.relativePaths::2449 By default, linkgit:git-status[1] shows paths relative to the2450 current directory. Setting this variable to `false` shows paths2451 relative to the repository root (this was the default for Git2452 prior to v1.5.4).24532454status.short::2455 Set to true to enable --short by default in linkgit:git-status[1].2456 The option --no-short takes precedence over this variable.24572458status.branch::2459 Set to true to enable --branch by default in linkgit:git-status[1].2460 The option --no-branch takes precedence over this variable.24612462status.displayCommentPrefix::2463 If set to true, linkgit:git-status[1] will insert a comment2464 prefix before each output line (starting with2465 `core.commentChar`, i.e. `#` by default). This was the2466 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.2467 Defaults to false.24682469status.showUntrackedFiles::2470 By default, linkgit:git-status[1] and linkgit:git-commit[1] show2471 files which are not currently tracked by Git. Directories which2472 contain only untracked files, are shown with the directory name2473 only. Showing untracked files means that Git needs to lstat() all2474 the files in the whole repository, which might be slow on some2475 systems. So, this variable controls how the commands displays2476 the untracked files. Possible values are:2477+2478--2479* `no` - Show no untracked files.2480* `normal` - Show untracked files and directories.2481* `all` - Show also individual files in untracked directories.2482--2483+2484If this variable is not specified, it defaults to 'normal'.2485This variable can be overridden with the -u|--untracked-files option2486of linkgit:git-status[1] and linkgit:git-commit[1].24872488status.submoduleSummary::2489 Defaults to false.2490 If this is set to a non zero number or true (identical to -1 or an2491 unlimited number), the submodule summary will be enabled and a2492 summary of commits for modified submodules will be shown (see2493 --summary-limit option of linkgit:git-submodule[1]). Please note2494 that the summary output command will be suppressed for all2495 submodules when `diff.ignoreSubmodules` is set to 'all' or only2496 for those submodules where `submodule.<name>.ignore=all`. The only2497 exception to that rule is that status and commit will show staged2498 submodule changes. To2499 also view the summary for ignored submodules you can either use2500 the --ignore-submodules=dirty command-line option or the 'git2501 submodule summary' command, which shows a similar output but does2502 not honor these settings.25032504submodule.<name>.path::2505submodule.<name>.url::2506 The path within this project and URL for a submodule. These2507 variables are initially populated by 'git submodule init'. See2508 linkgit:git-submodule[1] and linkgit:gitmodules[5] for2509 details.25102511submodule.<name>.update::2512 The default update procedure for a submodule. This variable2513 is populated by `git submodule init` from the2514 linkgit:gitmodules[5] file. See description of 'update'2515 command in linkgit:git-submodule[1].25162517submodule.<name>.branch::2518 The remote branch name for a submodule, used by `git submodule2519 update --remote`. Set this option to override the value found in2520 the `.gitmodules` file. See linkgit:git-submodule[1] and2521 linkgit:gitmodules[5] for details.25222523submodule.<name>.fetchRecurseSubmodules::2524 This option can be used to control recursive fetching of this2525 submodule. It can be overridden by using the --[no-]recurse-submodules2526 command-line option to "git fetch" and "git pull".2527 This setting will override that from in the linkgit:gitmodules[5]2528 file.25292530submodule.<name>.ignore::2531 Defines under what circumstances "git status" and the diff family show2532 a submodule as modified. When set to "all", it will never be considered2533 modified (but it will nonetheless show up in the output of status and2534 commit when it has been staged), "dirty" will ignore all changes2535 to the submodules work tree and2536 takes only differences between the HEAD of the submodule and the commit2537 recorded in the superproject into account. "untracked" will additionally2538 let submodules with modified tracked files in their work tree show up.2539 Using "none" (the default when this option is not set) also shows2540 submodules that have untracked files in their work tree as changed.2541 This setting overrides any setting made in .gitmodules for this submodule,2542 both settings can be overridden on the command line by using the2543 "--ignore-submodules" option. The 'git submodule' commands are not2544 affected by this setting.25452546tag.sort::2547 This variable controls the sort ordering of tags when displayed by2548 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the2549 value of this variable will be used as the default.25502551tar.umask::2552 This variable can be used to restrict the permission bits of2553 tar archive entries. The default is 0002, which turns off the2554 world write bit. The special value "user" indicates that the2555 archiving user's umask will be used instead. See umask(2) and2556 linkgit:git-archive[1].25572558transfer.fsckObjects::2559 When `fetch.fsckObjects` or `receive.fsckObjects` are2560 not set, the value of this variable is used instead.2561 Defaults to false.25622563transfer.hideRefs::2564 This variable can be used to set both `receive.hideRefs`2565 and `uploadpack.hideRefs` at the same time to the same2566 values. See entries for these other variables.25672568transfer.unpackLimit::2569 When `fetch.unpackLimit` or `receive.unpackLimit` are2570 not set, the value of this variable is used instead.2571 The default value is 100.25722573uploadarchive.allowUnreachable::2574 If true, allow clients to use `git archive --remote` to request2575 any tree, whether reachable from the ref tips or not. See the2576 discussion in the `SECURITY` section of2577 linkgit:git-upload-archive[1] for more details. Defaults to2578 `false`.25792580uploadpack.hideRefs::2581 String(s) `upload-pack` uses to decide which refs to omit2582 from its initial advertisement. Use more than one2583 definitions to specify multiple prefix strings. A ref that2584 are under the hierarchies listed on the value of this2585 variable is excluded, and is hidden from `git ls-remote`,2586 `git fetch`, etc. An attempt to fetch a hidden ref by `git2587 fetch` will fail. See also `uploadpack.allowTipSHA1InWant`.25882589uploadpack.allowTipSHA1InWant::2590 When `uploadpack.hideRefs` is in effect, allow `upload-pack`2591 to accept a fetch request that asks for an object at the tip2592 of a hidden ref (by default, such a request is rejected).2593 see also `uploadpack.hideRefs`.25942595uploadpack.allowReachableSHA1InWant::2596 Allow `upload-pack` to accept a fetch request that asks for an2597 object that is reachable from any ref tip. However, note that2598 calculating object reachability is computationally expensive.2599 Defaults to `false`.26002601uploadpack.keepAlive::2602 When `upload-pack` has started `pack-objects`, there may be a2603 quiet period while `pack-objects` prepares the pack. Normally2604 it would output progress information, but if `--quiet` was used2605 for the fetch, `pack-objects` will output nothing at all until2606 the pack data begins. Some clients and networks may consider2607 the server to be hung and give up. Setting this option instructs2608 `upload-pack` to send an empty keepalive packet every2609 `uploadpack.keepAlive` seconds. Setting this option to 02610 disables keepalive packets entirely. The default is 5 seconds.26112612url.<base>.insteadOf::2613 Any URL that starts with this value will be rewritten to2614 start, instead, with <base>. In cases where some site serves a2615 large number of repositories, and serves them with multiple2616 access methods, and some users need to use different access2617 methods, this feature allows people to specify any of the2618 equivalent URLs and have Git automatically rewrite the URL to2619 the best alternative for the particular user, even for a2620 never-before-seen repository on the site. When more than one2621 insteadOf strings match a given URL, the longest match is used.26222623url.<base>.pushInsteadOf::2624 Any URL that starts with this value will not be pushed to;2625 instead, it will be rewritten to start with <base>, and the2626 resulting URL will be pushed to. In cases where some site serves2627 a large number of repositories, and serves them with multiple2628 access methods, some of which do not allow push, this feature2629 allows people to specify a pull-only URL and have Git2630 automatically use an appropriate URL to push, even for a2631 never-before-seen repository on the site. When more than one2632 pushInsteadOf strings match a given URL, the longest match is2633 used. If a remote has an explicit pushurl, Git will ignore this2634 setting for that remote.26352636user.email::2637 Your email address to be recorded in any newly created commits.2638 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and2639 'EMAIL' environment variables. See linkgit:git-commit-tree[1].26402641user.name::2642 Your full name to be recorded in any newly created commits.2643 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'2644 environment variables. See linkgit:git-commit-tree[1].26452646user.signingKey::2647 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the2648 key you want it to automatically when creating a signed tag or2649 commit, you can override the default selection with this variable.2650 This option is passed unchanged to gpg's --local-user parameter,2651 so you may specify a key using any method that gpg supports.26522653versionsort.prereleaseSuffix::2654 When version sort is used in linkgit:git-tag[1], prerelease2655 tags (e.g. "1.0-rc1") may appear after the main release2656 "1.0". By specifying the suffix "-rc" in this variable,2657 "1.0-rc1" will appear before "1.0".2658+2659This variable can be specified multiple times, once per suffix. The2660order of suffixes in the config file determines the sorting order2661(e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX2662is sorted before 1.0-rcXX). The sorting order between different2663suffixes is undefined if they are in multiple config files.26642665web.browser::2666 Specify a web browser that may be used by some commands.2667 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]2668 may use it.