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 84variable takes a pathname as its value, and is subject to tilde 85expansion. 86 87The 88included file is expanded immediately, as if its contents had been 89found at the location of the include directive. If the value of the 90`include.path` variable is a relative path, the path is considered to be 91relative to the configuration file in which the include directive was 92found. See below for examples. 93 94 95Example 96~~~~~~~ 97 98 # Core variables 99 [core] 100 ; Don't trust file modes 101 filemode = false 102 103 # Our diff algorithm 104 [diff] 105 external = /usr/local/bin/diff-wrapper 106 renames = true 107 108 [branch "devel"] 109 remote = origin 110 merge = refs/heads/devel 111 112 # Proxy settings 113 [core] 114 gitProxy="ssh" for "kernel.org" 115 gitProxy=default-proxy ; for the rest 116 117 [include] 118 path = /path/to/foo.inc ; include by absolute path 119 path = foo ; expand "foo" relative to the current file 120 path = ~/foo ; expand "foo" in your `$HOME` directory 121 122 123Values 124~~~~~~ 125 126Values of many variables are treated as a simple string, but there 127are variables that take values of specific types and there are rules 128as to how to spell them. 129 130boolean:: 131 132 When a variable is said to take a boolean value, many 133 synonyms are accepted for 'true' and 'false'; these are all 134 case-insensitive. 135 136 true;; Boolean true can be spelled as `yes`, `on`, `true`, 137 or `1`. Also, a variable defined without `= <value>` 138 is taken as true. 139 140 false;; Boolean false can be spelled as `no`, `off`, 141 `false`, or `0`. 142+ 143When converting value to the canonical form using `--bool` type 144specifier; 'git config' will ensure that the output is "true" or 145"false" (spelled in lowercase). 146 147integer:: 148 The value for many variables that specify various sizes can 149 be suffixed with `k`, `M`,... to mean "scale the number by 150 1024", "by 1024x1024", etc. 151 152color:: 153 The value for a variables that takes a color is a list of 154 colors (at most two) and attributes (at most one), separated 155 by spaces. The colors accepted are `normal`, `black`, 156 `red`, `green`, `yellow`, `blue`, `magenta`, `cyan` and 157 `white`; the attributes are `bold`, `dim`, `ul`, `blink` and 158 `reverse`. The first color given is the foreground; the 159 second is the background. The position of the attribute, if 160 any, doesn't matter. Attributes may be turned off specifically 161 by prefixing them with `no` (e.g., `noreverse`, `noul`, etc). 162+ 163Colors (foreground and background) may also be given as numbers between 1640 and 255; these use ANSI 256-color mode (but note that not all 165terminals may support this). If your terminal supports it, you may also 166specify 24-bit RGB values as hex, like `#ff0ab3`. 167+ 168The attributes are meant to be reset at the beginning of each item 169in the colored output, so setting color.decorate.branch to `black` 170will paint that branch name in a plain `black`, even if the previous 171thing on the same output line (e.g. opening parenthesis before the 172list of branch names in `log --decorate` output) is set to be 173painted with `bold` or some other attribute. 174 175pathname:: 176 A variable that takes a pathname value can be given a 177 string that begins with "`~/`" or "`~user/`", and the usual 178 tilde expansion happens to such a string: `~/` 179 is expanded to the value of `$HOME`, and `~user/` to the 180 specified user's home directory. 181 182 183Variables 184~~~~~~~~~ 185 186Note that this list is non-comprehensive and not necessarily complete. 187For command-specific variables, you will find a more detailed description 188in the appropriate manual page. 189 190Other git-related tools may and do use their own variables. When 191inventing new variables for use in your own tool, make sure their 192names do not conflict with those that are used by Git itself and 193other popular tools, and describe them in your documentation. 194 195 196advice.*:: 197 These variables control various optional help messages designed to 198 aid new users. All 'advice.*' variables default to 'true', and you 199 can tell Git that you do not need help by setting these to 'false': 200+ 201-- 202 pushUpdateRejected:: 203 Set this variable to 'false' if you want to disable 204 'pushNonFFCurrent', 205 'pushNonFFMatching', 'pushAlreadyExists', 206 'pushFetchFirst', and 'pushNeedsForce' 207 simultaneously. 208 pushNonFFCurrent:: 209 Advice shown when linkgit:git-push[1] fails due to a 210 non-fast-forward update to the current branch. 211 pushNonFFMatching:: 212 Advice shown when you ran linkgit:git-push[1] and pushed 213 'matching refs' explicitly (i.e. you used ':', or 214 specified a refspec that isn't your current branch) and 215 it resulted in a non-fast-forward error. 216 pushAlreadyExists:: 217 Shown when linkgit:git-push[1] rejects an update that 218 does not qualify for fast-forwarding (e.g., a tag.) 219 pushFetchFirst:: 220 Shown when linkgit:git-push[1] rejects an update that 221 tries to overwrite a remote ref that points at an 222 object we do not have. 223 pushNeedsForce:: 224 Shown when linkgit:git-push[1] rejects an update that 225 tries to overwrite a remote ref that points at an 226 object that is not a commit-ish, or make the remote 227 ref point at an object that is not a commit-ish. 228 statusHints:: 229 Show directions on how to proceed from the current 230 state in the output of linkgit:git-status[1], in 231 the template shown when writing commit messages in 232 linkgit:git-commit[1], and in the help message shown 233 by linkgit:git-checkout[1] when switching branch. 234 statusUoption:: 235 Advise to consider using the `-u` option to linkgit:git-status[1] 236 when the command takes more than 2 seconds to enumerate untracked 237 files. 238 commitBeforeMerge:: 239 Advice shown when linkgit:git-merge[1] refuses to 240 merge to avoid overwriting local changes. 241 resolveConflict:: 242 Advice shown by various commands when conflicts 243 prevent the operation from being performed. 244 implicitIdentity:: 245 Advice on how to set your identity configuration when 246 your information is guessed from the system username and 247 domain name. 248 detachedHead:: 249 Advice shown when you used linkgit:git-checkout[1] to 250 move to the detach HEAD state, to instruct how to create 251 a local branch after the fact. 252 amWorkDir:: 253 Advice that shows the location of the patch file when 254 linkgit:git-am[1] fails to apply it. 255 rmHints:: 256 In case of failure in the output of linkgit:git-rm[1], 257 show directions on how to proceed from the current state. 258-- 259 260core.fileMode:: 261 Tells Git if the executable bit of files in the working tree 262 is to be honored. 263+ 264Some filesystems lose the executable bit when a file that is 265marked as executable is checked out, or checks out an 266non-executable file with executable bit on. 267linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem 268to see if it handles the executable bit correctly 269and this variable is automatically set as necessary. 270+ 271A repository, however, may be on a filesystem that handles 272the filemode correctly, and this variable is set to 'true' 273when created, but later may be made accessible from another 274environment that loses the filemode (e.g. exporting ext4 via 275CIFS mount, visiting a Cygwin created repository with 276Git for Windows or Eclipse). 277In such a case it may be necessary to set this variable to 'false'. 278See linkgit:git-update-index[1]. 279+ 280The default is true (when core.filemode is not specified in the config file). 281 282core.hideDotFiles:: 283 (Windows-only) If true, mark newly-created directories and files whose 284 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/` 285 directory is hidden, but no other files starting with a dot. The 286 default mode is 'dotGitOnly'. 287 288core.ignoreCase:: 289 If true, this option enables various workarounds to enable 290 Git to work better on filesystems that are not case sensitive, 291 like FAT. For example, if a directory listing finds 292 "makefile" when Git expects "Makefile", Git will assume 293 it is really the same file, and continue to remember it as 294 "Makefile". 295+ 296The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] 297will probe and set core.ignoreCase true if appropriate when the repository 298is created. 299 300core.precomposeUnicode:: 301 This option is only used by Mac OS implementation of Git. 302 When core.precomposeUnicode=true, Git reverts the unicode decomposition 303 of filenames done by Mac OS. This is useful when sharing a repository 304 between Mac OS and Linux or Windows. 305 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). 306 When false, file names are handled fully transparent by Git, 307 which is backward compatible with older versions of Git. 308 309core.protectHFS:: 310 If set to true, do not allow checkout of paths that would 311 be considered equivalent to `.git` on an HFS+ filesystem. 312 Defaults to `true` on Mac OS, and `false` elsewhere. 313 314core.protectNTFS:: 315 If set to true, do not allow checkout of paths that would 316 cause problems with the NTFS filesystem, e.g. conflict with 317 8.3 "short" names. 318 Defaults to `true` on Windows, and `false` elsewhere. 319 320core.trustctime:: 321 If false, the ctime differences between the index and the 322 working tree are ignored; useful when the inode change time 323 is regularly modified by something outside Git (file system 324 crawlers and some backup systems). 325 See linkgit:git-update-index[1]. True by default. 326 327core.untrackedCache:: 328 Determines what to do about the untracked cache feature of the 329 index. It will be kept, if this variable is unset or set to 330 `keep`. It will automatically be added if set to `true`. And 331 it will automatically be removed, if set to `false`. Before 332 setting it to `true`, you should check that mtime is working 333 properly on your system. 334 See linkgit:git-update-index[1]. `keep` by default. 335 336core.checkStat:: 337 Determines which stat fields to match between the index 338 and work tree. The user can set this to 'default' or 339 'minimal'. Default (or explicitly 'default'), is to check 340 all fields, including the sub-second part of mtime and ctime. 341 342core.quotePath:: 343 The commands that output paths (e.g. 'ls-files', 344 'diff'), when not given the `-z` option, will quote 345 "unusual" characters in the pathname by enclosing the 346 pathname in a double-quote pair and with backslashes the 347 same way strings in C source code are quoted. If this 348 variable is set to false, the bytes higher than 0x80 are 349 not quoted but output as verbatim. Note that double 350 quote, backslash and control characters are always 351 quoted without `-z` regardless of the setting of this 352 variable. 353 354core.eol:: 355 Sets the line ending type to use in the working directory for 356 files that have the `text` property set when core.autocrlf is false. 357 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's 358 native line ending. The default value is `native`. See 359 linkgit:gitattributes[5] for more information on end-of-line 360 conversion. 361 362core.safecrlf:: 363 If true, makes Git check if converting `CRLF` is reversible when 364 end-of-line conversion is active. Git will verify if a command 365 modifies a file in the work tree either directly or indirectly. 366 For example, committing a file followed by checking out the 367 same file should yield the original file in the work tree. If 368 this is not the case for the current setting of 369 `core.autocrlf`, Git will reject the file. The variable can 370 be set to "warn", in which case Git will only warn about an 371 irreversible conversion but continue the operation. 372+ 373CRLF conversion bears a slight chance of corrupting data. 374When it is enabled, Git will convert CRLF to LF during commit and LF to 375CRLF during checkout. A file that contains a mixture of LF and 376CRLF before the commit cannot be recreated by Git. For text 377files this is the right thing to do: it corrects line endings 378such that we have only LF line endings in the repository. 379But for binary files that are accidentally classified as text the 380conversion can corrupt data. 381+ 382If you recognize such corruption early you can easily fix it by 383setting the conversion type explicitly in .gitattributes. Right 384after committing you still have the original file in your work 385tree and this file is not yet corrupted. You can explicitly tell 386Git that this file is binary and Git will handle the file 387appropriately. 388+ 389Unfortunately, the desired effect of cleaning up text files with 390mixed line endings and the undesired effect of corrupting binary 391files cannot be distinguished. In both cases CRLFs are removed 392in an irreversible way. For text files this is the right thing 393to do because CRLFs are line endings, while for binary files 394converting CRLFs corrupts data. 395+ 396Note, this safety check does not mean that a checkout will generate a 397file identical to the original file for a different setting of 398`core.eol` and `core.autocrlf`, but only for the current one. For 399example, a text file with `LF` would be accepted with `core.eol=lf` 400and could later be checked out with `core.eol=crlf`, in which case the 401resulting file would contain `CRLF`, although the original file 402contained `LF`. However, in both work trees the line endings would be 403consistent, that is either all `LF` or all `CRLF`, but never mixed. A 404file with mixed line endings would be reported by the `core.safecrlf` 405mechanism. 406 407core.autocrlf:: 408 Setting this variable to "true" is the same as setting 409 the `text` attribute to "auto" on all files and core.eol to "crlf". 410 Set to true if you want to have `CRLF` line endings in your 411 working directory and the repository has LF line endings. 412 This variable can be set to 'input', 413 in which case no output conversion is performed. 414 415core.symlinks:: 416 If false, symbolic links are checked out as small plain files that 417 contain the link text. linkgit:git-update-index[1] and 418 linkgit:git-add[1] will not change the recorded type to regular 419 file. Useful on filesystems like FAT that do not support 420 symbolic links. 421+ 422The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] 423will probe and set core.symlinks false if appropriate when the repository 424is created. 425 426core.gitProxy:: 427 A "proxy command" to execute (as 'command host port') instead 428 of establishing direct connection to the remote server when 429 using the Git protocol for fetching. If the variable value is 430 in the "COMMAND for DOMAIN" format, the command is applied only 431 on hostnames ending with the specified domain string. This variable 432 may be set multiple times and is matched in the given order; 433 the first match wins. 434+ 435Can be overridden by the `GIT_PROXY_COMMAND` environment variable 436(which always applies universally, without the special "for" 437handling). 438+ 439The special string `none` can be used as the proxy command to 440specify that no proxy be used for a given domain pattern. 441This is useful for excluding servers inside a firewall from 442proxy use, while defaulting to a common proxy for external domains. 443 444core.ignoreStat:: 445 If true, Git will avoid using lstat() calls to detect if files have 446 changed by setting the "assume-unchanged" bit for those tracked files 447 which it has updated identically in both the index and working tree. 448+ 449When files are modified outside of Git, the user will need to stage 450the modified files explicitly (e.g. see 'Examples' section in 451linkgit:git-update-index[1]). 452Git will not normally detect changes to those files. 453+ 454This is useful on systems where lstat() calls are very slow, such as 455CIFS/Microsoft Windows. 456+ 457False by default. 458 459core.preferSymlinkRefs:: 460 Instead of the default "symref" format for HEAD 461 and other symbolic reference files, use symbolic links. 462 This is sometimes needed to work with old scripts that 463 expect HEAD to be a symbolic link. 464 465core.bare:: 466 If true this repository is assumed to be 'bare' and has no 467 working directory associated with it. If this is the case a 468 number of commands that require a working directory will be 469 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. 470+ 471This setting is automatically guessed by linkgit:git-clone[1] or 472linkgit:git-init[1] when the repository was created. By default a 473repository that ends in "/.git" is assumed to be not bare (bare = 474false), while all other repositories are assumed to be bare (bare 475= true). 476 477core.worktree:: 478 Set the path to the root of the working tree. 479 If `GIT_COMMON_DIR` environment variable is set, core.worktree 480 is ignored and not used for determining the root of working tree. 481 This can be overridden by the `GIT_WORK_TREE` environment 482 variable and the `--work-tree` command-line option. 483 The value can be an absolute path or relative to the path to 484 the .git directory, which is either specified by --git-dir 485 or GIT_DIR, or automatically discovered. 486 If --git-dir or GIT_DIR is specified but none of 487 --work-tree, GIT_WORK_TREE and core.worktree is specified, 488 the current working directory is regarded as the top level 489 of your working tree. 490+ 491Note that this variable is honored even when set in a configuration 492file in a ".git" subdirectory of a directory and its value differs 493from the latter directory (e.g. "/path/to/.git/config" has 494core.worktree set to "/different/path"), which is most likely a 495misconfiguration. Running Git commands in the "/path/to" directory will 496still use "/different/path" as the root of the work tree and can cause 497confusion unless you know what you are doing (e.g. you are creating a 498read-only snapshot of the same index to a location different from the 499repository's usual working tree). 500 501core.logAllRefUpdates:: 502 Enable the reflog. Updates to a ref <ref> is logged to the file 503 "`$GIT_DIR/logs/<ref>`", by appending the new and old 504 SHA-1, the date/time and the reason of the update, but 505 only when the file exists. If this configuration 506 variable is set to true, missing "`$GIT_DIR/logs/<ref>`" 507 file is automatically created for branch heads (i.e. under 508 refs/heads/), remote refs (i.e. under refs/remotes/), 509 note refs (i.e. under refs/notes/), and the symbolic ref HEAD. 510+ 511This information can be used to determine what commit 512was the tip of a branch "2 days ago". 513+ 514This value is true by default in a repository that has 515a working directory associated with it, and false by 516default in a bare repository. 517 518core.repositoryFormatVersion:: 519 Internal variable identifying the repository format and layout 520 version. 521 522core.sharedRepository:: 523 When 'group' (or 'true'), the repository is made shareable between 524 several users in a group (making sure all the files and objects are 525 group-writable). When 'all' (or 'world' or 'everybody'), the 526 repository will be readable by all users, additionally to being 527 group-shareable. When 'umask' (or 'false'), Git will use permissions 528 reported by umask(2). When '0xxx', where '0xxx' is an octal number, 529 files in the repository will have this mode value. '0xxx' will override 530 user's umask value (whereas the other options will only override 531 requested parts of the user's umask value). Examples: '0660' will make 532 the repo read/write-able for the owner and group, but inaccessible to 533 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a 534 repository that is group-readable but not group-writable. 535 See linkgit:git-init[1]. False by default. 536 537core.warnAmbiguousRefs:: 538 If true, Git will warn you if the ref name you passed it is ambiguous 539 and might match multiple refs in the repository. True by default. 540 541core.compression:: 542 An integer -1..9, indicating a default compression level. 543 -1 is the zlib default. 0 means no compression, 544 and 1..9 are various speed/size tradeoffs, 9 being slowest. 545 If set, this provides a default to other compression variables, 546 such as `core.looseCompression` and `pack.compression`. 547 548core.looseCompression:: 549 An integer -1..9, indicating the compression level for objects that 550 are not in a pack file. -1 is the zlib default. 0 means no 551 compression, and 1..9 are various speed/size tradeoffs, 9 being 552 slowest. If not set, defaults to core.compression. If that is 553 not set, defaults to 1 (best speed). 554 555core.packedGitWindowSize:: 556 Number of bytes of a pack file to map into memory in a 557 single mapping operation. Larger window sizes may allow 558 your system to process a smaller number of large pack files 559 more quickly. Smaller window sizes will negatively affect 560 performance due to increased calls to the operating system's 561 memory manager, but may improve performance when accessing 562 a large number of large pack files. 563+ 564Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 565MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should 566be reasonable for all users/operating systems. You probably do 567not need to adjust this value. 568+ 569Common unit suffixes of 'k', 'm', or 'g' are supported. 570 571core.packedGitLimit:: 572 Maximum number of bytes to map simultaneously into memory 573 from pack files. If Git needs to access more than this many 574 bytes at once to complete an operation it will unmap existing 575 regions to reclaim virtual address space within the process. 576+ 577Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. 578This should be reasonable for all users/operating systems, except on 579the largest projects. You probably do not need to adjust this value. 580+ 581Common unit suffixes of 'k', 'm', or 'g' are supported. 582 583core.deltaBaseCacheLimit:: 584 Maximum number of bytes to reserve for caching base objects 585 that may be referenced by multiple deltified objects. By storing the 586 entire decompressed base objects in a cache Git is able 587 to avoid unpacking and decompressing frequently used base 588 objects multiple times. 589+ 590Default is 96 MiB on all platforms. This should be reasonable 591for all users/operating systems, except on the largest projects. 592You probably do not need to adjust this value. 593+ 594Common unit suffixes of 'k', 'm', or 'g' are supported. 595 596core.bigFileThreshold:: 597 Files larger than this size are stored deflated, without 598 attempting delta compression. Storing large files without 599 delta compression avoids excessive memory usage, at the 600 slight expense of increased disk usage. Additionally files 601 larger than this size are always treated as binary. 602+ 603Default is 512 MiB on all platforms. This should be reasonable 604for most projects as source code and other text files can still 605be delta compressed, but larger binary media files won't be. 606+ 607Common unit suffixes of 'k', 'm', or 'g' are supported. 608 609core.excludesFile:: 610 Specifies the pathname to the file that contains patterns to 611 describe paths that are not meant to be tracked, in addition 612 to '.gitignore' (per-directory) and '.git/info/exclude'. 613 Defaults to `$XDG_CONFIG_HOME/git/ignore`. 614 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` 615 is used instead. See linkgit:gitignore[5]. 616 617core.askPass:: 618 Some commands (e.g. svn and http interfaces) that interactively 619 ask for a password can be told to use an external program given 620 via the value of this variable. Can be overridden by the `GIT_ASKPASS` 621 environment variable. If not set, fall back to the value of the 622 `SSH_ASKPASS` environment variable or, failing that, a simple password 623 prompt. The external program shall be given a suitable prompt as 624 command-line argument and write the password on its STDOUT. 625 626core.attributesFile:: 627 In addition to '.gitattributes' (per-directory) and 628 '.git/info/attributes', Git looks into this file for attributes 629 (see linkgit:gitattributes[5]). Path expansions are made the same 630 way as for `core.excludesFile`. Its default value is 631 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not 632 set or empty, `$HOME/.config/git/attributes` is used instead. 633 634core.hooksPath:: 635 By default Git will look for your hooks in the 636 '$GIT_DIR/hooks' directory. Set this to different path, 637 e.g. '/etc/git/hooks', and Git will try to find your hooks in 638 that directory, e.g. '/etc/git/hooks/pre-receive' instead of 639 in '$GIT_DIR/hooks/pre-receive'. 640+ 641The path can be either absolute or relative. A relative path is 642taken as relative to the directory where the hooks are run (see 643the "DESCRIPTION" section of linkgit:githooks[5]). 644+ 645This configuration variable is useful in cases where you'd like to 646centrally configure your Git hooks instead of configuring them on a 647per-repository basis, or as a more flexible and centralized 648alternative to having an `init.templateDir` where you've changed 649default hooks. 650 651core.editor:: 652 Commands such as `commit` and `tag` that lets you edit 653 messages by launching an editor uses the value of this 654 variable when it is set, and the environment variable 655 `GIT_EDITOR` is not set. See linkgit:git-var[1]. 656 657core.commentChar:: 658 Commands such as `commit` and `tag` that lets you edit 659 messages consider a line that begins with this character 660 commented, and removes them after the editor returns 661 (default '#'). 662+ 663If set to "auto", `git-commit` would select a character that is not 664the beginning character of any line in existing commit messages. 665 666core.packedRefsTimeout:: 667 The length of time, in milliseconds, to retry when trying to 668 lock the `packed-refs` file. Value 0 means not to retry at 669 all; -1 means to try indefinitely. Default is 1000 (i.e., 670 retry for 1 second). 671 672sequence.editor:: 673 Text editor used by `git rebase -i` for editing the rebase instruction file. 674 The value is meant to be interpreted by the shell when it is used. 675 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. 676 When not configured the default commit message editor is used instead. 677 678core.pager:: 679 Text viewer for use by Git commands (e.g., 'less'). The value 680 is meant to be interpreted by the shell. The order of preference 681 is the `$GIT_PAGER` environment variable, then `core.pager` 682 configuration, then `$PAGER`, and then the default chosen at 683 compile time (usually 'less'). 684+ 685When the `LESS` environment variable is unset, Git sets it to `FRX` 686(if `LESS` environment variable is set, Git does not change it at 687all). If you want to selectively override Git's default setting 688for `LESS`, you can set `core.pager` to e.g. `less -S`. This will 689be passed to the shell by Git, which will translate the final 690command to `LESS=FRX less -S`. The environment does not set the 691`S` option but the command line does, instructing less to truncate 692long lines. Similarly, setting `core.pager` to `less -+F` will 693deactivate the `F` option specified by the environment from the 694command-line, deactivating the "quit if one screen" behavior of 695`less`. One can specifically activate some flags for particular 696commands: for example, setting `pager.blame` to `less -S` enables 697line truncation only for `git blame`. 698+ 699Likewise, when the `LV` environment variable is unset, Git sets it 700to `-c`. You can override this setting by exporting `LV` with 701another value or setting `core.pager` to `lv +c`. 702 703core.whitespace:: 704 A comma separated list of common whitespace problems to 705 notice. 'git diff' will use `color.diff.whitespace` to 706 highlight them, and 'git apply --whitespace=error' will 707 consider them as errors. You can prefix `-` to disable 708 any of them (e.g. `-trailing-space`): 709+ 710* `blank-at-eol` treats trailing whitespaces at the end of the line 711 as an error (enabled by default). 712* `space-before-tab` treats a space character that appears immediately 713 before a tab character in the initial indent part of the line as an 714 error (enabled by default). 715* `indent-with-non-tab` treats a line that is indented with space 716 characters instead of the equivalent tabs as an error (not enabled by 717 default). 718* `tab-in-indent` treats a tab character in the initial indent part of 719 the line as an error (not enabled by default). 720* `blank-at-eof` treats blank lines added at the end of file as an error 721 (enabled by default). 722* `trailing-space` is a short-hand to cover both `blank-at-eol` and 723 `blank-at-eof`. 724* `cr-at-eol` treats a carriage-return at the end of line as 725 part of the line terminator, i.e. with it, `trailing-space` 726 does not trigger if the character before such a carriage-return 727 is not a whitespace (not enabled by default). 728* `tabwidth=<n>` tells how many character positions a tab occupies; this 729 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` 730 errors. The default tab width is 8. Allowed values are 1 to 63. 731 732core.fsyncObjectFiles:: 733 This boolean will enable 'fsync()' when writing object files. 734+ 735This is a total waste of time and effort on a filesystem that orders 736data writes properly, but can be useful for filesystems that do not use 737journalling (traditional UNIX filesystems) or that only journal metadata 738and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). 739 740core.preloadIndex:: 741 Enable parallel index preload for operations like 'git diff' 742+ 743This can speed up operations like 'git diff' and 'git status' especially 744on filesystems like NFS that have weak caching semantics and thus 745relatively high IO latencies. When enabled, Git will do the 746index comparison to the filesystem data in parallel, allowing 747overlapping IO's. Defaults to true. 748 749core.createObject:: 750 You can set this to 'link', in which case a hardlink followed by 751 a delete of the source are used to make sure that object creation 752 will not overwrite existing objects. 753+ 754On some file system/operating system combinations, this is unreliable. 755Set this config setting to 'rename' there; However, This will remove the 756check that makes sure that existing object files will not get overwritten. 757 758core.notesRef:: 759 When showing commit messages, also show notes which are stored in 760 the given ref. The ref must be fully qualified. If the given 761 ref does not exist, it is not an error but means that no 762 notes should be printed. 763+ 764This setting defaults to "refs/notes/commits", and it can be overridden by 765the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. 766 767core.sparseCheckout:: 768 Enable "sparse checkout" feature. See section "Sparse checkout" in 769 linkgit:git-read-tree[1] for more information. 770 771core.abbrev:: 772 Set the length object names are abbreviated to. If unspecified, 773 many commands abbreviate to 7 hexdigits, which may not be enough 774 for abbreviated object names to stay unique for sufficiently long 775 time. 776 777add.ignoreErrors:: 778add.ignore-errors (deprecated):: 779 Tells 'git add' to continue adding files when some files cannot be 780 added due to indexing errors. Equivalent to the `--ignore-errors` 781 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, 782 as it does not follow the usual naming convention for configuration 783 variables. 784 785alias.*:: 786 Command aliases for the linkgit:git[1] command wrapper - e.g. 787 after defining "alias.last = cat-file commit HEAD", the invocation 788 "git last" is equivalent to "git cat-file commit HEAD". To avoid 789 confusion and troubles with script usage, aliases that 790 hide existing Git commands are ignored. Arguments are split by 791 spaces, the usual shell quoting and escaping is supported. 792 A quote pair or a backslash can be used to quote them. 793+ 794If the alias expansion is prefixed with an exclamation point, 795it will be treated as a shell command. For example, defining 796"alias.new = !gitk --all --not ORIG_HEAD", the invocation 797"git new" is equivalent to running the shell command 798"gitk --all --not ORIG_HEAD". Note that shell commands will be 799executed from the top-level directory of a repository, which may 800not necessarily be the current directory. 801`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix' 802from the original current directory. See linkgit:git-rev-parse[1]. 803 804am.keepcr:: 805 If true, git-am will call git-mailsplit for patches in mbox format 806 with parameter `--keep-cr`. In this case git-mailsplit will 807 not remove `\r` from lines ending with `\r\n`. Can be overridden 808 by giving `--no-keep-cr` from the command line. 809 See linkgit:git-am[1], linkgit:git-mailsplit[1]. 810 811am.threeWay:: 812 By default, `git am` will fail if the patch does not apply cleanly. When 813 set to true, this setting tells `git am` to fall back on 3-way merge if 814 the patch records the identity of blobs it is supposed to apply to and 815 we have those blobs available locally (equivalent to giving the `--3way` 816 option from the command line). Defaults to `false`. 817 See linkgit:git-am[1]. 818 819apply.ignoreWhitespace:: 820 When set to 'change', tells 'git apply' to ignore changes in 821 whitespace, in the same way as the `--ignore-space-change` 822 option. 823 When set to one of: no, none, never, false tells 'git apply' to 824 respect all whitespace differences. 825 See linkgit:git-apply[1]. 826 827apply.whitespace:: 828 Tells 'git apply' how to handle whitespaces, in the same way 829 as the `--whitespace` option. See linkgit:git-apply[1]. 830 831branch.autoSetupMerge:: 832 Tells 'git branch' and 'git checkout' to set up new branches 833 so that linkgit:git-pull[1] will appropriately merge from the 834 starting point branch. Note that even if this option is not set, 835 this behavior can be chosen per-branch using the `--track` 836 and `--no-track` options. The valid settings are: `false` -- no 837 automatic setup is done; `true` -- automatic setup is done when the 838 starting point is a remote-tracking branch; `always` -- 839 automatic setup is done when the starting point is either a 840 local branch or remote-tracking 841 branch. This option defaults to true. 842 843branch.autoSetupRebase:: 844 When a new branch is created with 'git branch' or 'git checkout' 845 that tracks another branch, this variable tells Git to set 846 up pull to rebase instead of merge (see "branch.<name>.rebase"). 847 When `never`, rebase is never automatically set to true. 848 When `local`, rebase is set to true for tracked branches of 849 other local branches. 850 When `remote`, rebase is set to true for tracked branches of 851 remote-tracking branches. 852 When `always`, rebase will be set to true for all tracking 853 branches. 854 See "branch.autoSetupMerge" for details on how to set up a 855 branch to track another branch. 856 This option defaults to never. 857 858branch.<name>.remote:: 859 When on branch <name>, it tells 'git fetch' and 'git push' 860 which remote to fetch from/push to. The remote to push to 861 may be overridden with `remote.pushDefault` (for all branches). 862 The remote to push to, for the current branch, may be further 863 overridden by `branch.<name>.pushRemote`. If no remote is 864 configured, or if you are not on any branch, it defaults to 865 `origin` for fetching and `remote.pushDefault` for pushing. 866 Additionally, `.` (a period) is the current local repository 867 (a dot-repository), see `branch.<name>.merge`'s final note below. 868 869branch.<name>.pushRemote:: 870 When on branch <name>, it overrides `branch.<name>.remote` for 871 pushing. It also overrides `remote.pushDefault` for pushing 872 from branch <name>. When you pull from one place (e.g. your 873 upstream) and push to another place (e.g. your own publishing 874 repository), you would want to set `remote.pushDefault` to 875 specify the remote to push to for all branches, and use this 876 option to override it for a specific branch. 877 878branch.<name>.merge:: 879 Defines, together with branch.<name>.remote, the upstream branch 880 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which 881 branch to merge and can also affect 'git push' (see push.default). 882 When in branch <name>, it tells 'git fetch' the default 883 refspec to be marked for merging in FETCH_HEAD. The value is 884 handled like the remote part of a refspec, and must match a 885 ref which is fetched from the remote given by 886 "branch.<name>.remote". 887 The merge information is used by 'git pull' (which at first calls 888 'git fetch') to lookup the default branch for merging. Without 889 this option, 'git pull' defaults to merge the first refspec fetched. 890 Specify multiple values to get an octopus merge. 891 If you wish to setup 'git pull' so that it merges into <name> from 892 another branch in the local repository, you can point 893 branch.<name>.merge to the desired branch, and use the relative path 894 setting `.` (a period) for branch.<name>.remote. 895 896branch.<name>.mergeOptions:: 897 Sets default options for merging into branch <name>. The syntax and 898 supported options are the same as those of linkgit:git-merge[1], but 899 option values containing whitespace characters are currently not 900 supported. 901 902branch.<name>.rebase:: 903 When true, rebase the branch <name> on top of the fetched branch, 904 instead of merging the default branch from the default remote when 905 "git pull" is run. See "pull.rebase" for doing this in a non 906 branch-specific manner. 907+ 908When preserve, also pass `--preserve-merges` along to 'git rebase' 909so that locally committed merge commits will not be flattened 910by running 'git pull'. 911+ 912When the value is `interactive`, the rebase is run in interactive mode. 913+ 914*NOTE*: this is a possibly dangerous operation; do *not* use 915it unless you understand the implications (see linkgit:git-rebase[1] 916for details). 917 918branch.<name>.description:: 919 Branch description, can be edited with 920 `git branch --edit-description`. Branch description is 921 automatically added in the format-patch cover letter or 922 request-pull summary. 923 924browser.<tool>.cmd:: 925 Specify the command to invoke the specified browser. The 926 specified command is evaluated in shell with the URLs passed 927 as arguments. (See linkgit:git-web{litdd}browse[1].) 928 929browser.<tool>.path:: 930 Override the path for the given tool that may be used to 931 browse HTML help (see `-w` option in linkgit:git-help[1]) or a 932 working repository in gitweb (see linkgit:git-instaweb[1]). 933 934clean.requireForce:: 935 A boolean to make git-clean do nothing unless given -f, 936 -i or -n. Defaults to true. 937 938color.branch:: 939 A boolean to enable/disable color in the output of 940 linkgit:git-branch[1]. May be set to `always`, 941 `false` (or `never`) or `auto` (or `true`), in which case colors are used 942 only when the output is to a terminal. Defaults to false. 943 944color.branch.<slot>:: 945 Use customized color for branch coloration. `<slot>` is one of 946 `current` (the current branch), `local` (a local branch), 947 `remote` (a remote-tracking branch in refs/remotes/), 948 `upstream` (upstream tracking branch), `plain` (other 949 refs). 950 951color.diff:: 952 Whether to use ANSI escape sequences to add color to patches. 953 If this is set to `always`, linkgit:git-diff[1], 954 linkgit:git-log[1], and linkgit:git-show[1] will use color 955 for all patches. If it is set to `true` or `auto`, those 956 commands will only use color when output is to the terminal. 957 Defaults to false. 958+ 959This does not affect linkgit:git-format-patch[1] or the 960'git-diff-{asterisk}' plumbing commands. Can be overridden on the 961command line with the `--color[=<when>]` option. 962 963color.diff.<slot>:: 964 Use customized color for diff colorization. `<slot>` specifies 965 which part of the patch to use the specified color, and is one 966 of `context` (context text - `plain` is a historical synonym), 967 `meta` (metainformation), `frag` 968 (hunk header), 'func' (function in hunk header), `old` (removed lines), 969 `new` (added lines), `commit` (commit headers), or `whitespace` 970 (highlighting whitespace errors). 971 972color.decorate.<slot>:: 973 Use customized color for 'git log --decorate' output. `<slot>` is one 974 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local 975 branches, remote-tracking branches, tags, stash and HEAD, respectively. 976 977color.grep:: 978 When set to `always`, always highlight matches. When `false` (or 979 `never`), never. When set to `true` or `auto`, use color only 980 when the output is written to the terminal. Defaults to `false`. 981 982color.grep.<slot>:: 983 Use customized color for grep colorization. `<slot>` specifies which 984 part of the line to use the specified color, and is one of 985+ 986-- 987`context`;; 988 non-matching text in context lines (when using `-A`, `-B`, or `-C`) 989`filename`;; 990 filename prefix (when not using `-h`) 991`function`;; 992 function name lines (when using `-p`) 993`linenumber`;; 994 line number prefix (when using `-n`) 995`match`;; 996 matching text (same as setting `matchContext` and `matchSelected`) 997`matchContext`;; 998 matching text in context lines 999`matchSelected`;;1000 matching text in selected lines1001`selected`;;1002 non-matching text in selected lines1003`separator`;;1004 separators between fields on a line (`:`, `-`, and `=`)1005 and between hunks (`--`)1006--10071008color.interactive::1009 When set to `always`, always use colors for interactive prompts1010 and displays (such as those used by "git-add --interactive" and1011 "git-clean --interactive"). When false (or `never`), never.1012 When set to `true` or `auto`, use colors only when the output is1013 to the terminal. Defaults to false.10141015color.interactive.<slot>::1016 Use customized color for 'git add --interactive' and 'git clean1017 --interactive' output. `<slot>` may be `prompt`, `header`, `help`1018 or `error`, for four distinct types of normal output from1019 interactive commands.10201021color.pager::1022 A boolean to enable/disable colored output when the pager is in1023 use (default is true).10241025color.showBranch::1026 A boolean to enable/disable color in the output of1027 linkgit:git-show-branch[1]. May be set to `always`,1028 `false` (or `never`) or `auto` (or `true`), in which case colors are used1029 only when the output is to a terminal. Defaults to false.10301031color.status::1032 A boolean to enable/disable color in the output of1033 linkgit:git-status[1]. May be set to `always`,1034 `false` (or `never`) or `auto` (or `true`), in which case colors are used1035 only when the output is to a terminal. Defaults to false.10361037color.status.<slot>::1038 Use customized color for status colorization. `<slot>` is1039 one of `header` (the header text of the status message),1040 `added` or `updated` (files which are added but not committed),1041 `changed` (files which are changed but not added in the index),1042 `untracked` (files which are not tracked by Git),1043 `branch` (the current branch),1044 `nobranch` (the color the 'no branch' warning is shown in, defaulting1045 to red), or1046 `unmerged` (files which have unmerged changes).10471048color.ui::1049 This variable determines the default value for variables such1050 as `color.diff` and `color.grep` that control the use of color1051 per command family. Its scope will expand as more commands learn1052 configuration to set a default for the `--color` option. Set it1053 to `false` or `never` if you prefer Git commands not to use1054 color unless enabled explicitly with some other configuration1055 or the `--color` option. Set it to `always` if you want all1056 output not intended for machine consumption to use color, to1057 `true` or `auto` (this is the default since Git 1.8.4) if you1058 want such output to use color when written to the terminal.10591060column.ui::1061 Specify whether supported commands should output in columns.1062 This variable consists of a list of tokens separated by spaces1063 or commas:1064+1065These options control when the feature should be enabled1066(defaults to 'never'):1067+1068--1069`always`;;1070 always show in columns1071`never`;;1072 never show in columns1073`auto`;;1074 show in columns if the output is to the terminal1075--1076+1077These options control layout (defaults to 'column'). Setting any1078of these implies 'always' if none of 'always', 'never', or 'auto' are1079specified.1080+1081--1082`column`;;1083 fill columns before rows1084`row`;;1085 fill rows before columns1086`plain`;;1087 show in one column1088--1089+1090Finally, these options can be combined with a layout option (defaults1091to 'nodense'):1092+1093--1094`dense`;;1095 make unequal size columns to utilize more space1096`nodense`;;1097 make equal size columns1098--10991100column.branch::1101 Specify whether to output branch listing in `git branch` in columns.1102 See `column.ui` for details.11031104column.clean::1105 Specify the layout when list items in `git clean -i`, which always1106 shows files and directories in columns. See `column.ui` for details.11071108column.status::1109 Specify whether to output untracked files in `git status` in columns.1110 See `column.ui` for details.11111112column.tag::1113 Specify whether to output tag listing in `git tag` in columns.1114 See `column.ui` for details.11151116commit.cleanup::1117 This setting overrides the default of the `--cleanup` option in1118 `git commit`. See linkgit:git-commit[1] for details. Changing the1119 default can be useful when you always want to keep lines that begin1120 with comment character `#` in your log message, in which case you1121 would do `git config commit.cleanup whitespace` (note that you will1122 have to remove the help lines that begin with `#` in the commit log1123 template yourself, if you do this).11241125commit.gpgSign::11261127 A boolean to specify whether all commits should be GPG signed.1128 Use of this option when doing operations such as rebase can1129 result in a large number of commits being signed. It may be1130 convenient to use an agent to avoid typing your GPG passphrase1131 several times.11321133commit.status::1134 A boolean to enable/disable inclusion of status information in the1135 commit message template when using an editor to prepare the commit1136 message. Defaults to true.11371138commit.template::1139 Specify the pathname of a file to use as the template for1140 new commit messages.11411142commit.verbose::1143 A boolean or int to specify the level of verbose with `git commit`.1144 See linkgit:git-commit[1].11451146credential.helper::1147 Specify an external helper to be called when a username or1148 password credential is needed; the helper may consult external1149 storage to avoid prompting the user for the credentials. Note1150 that multiple helpers may be defined. See linkgit:gitcredentials[7]1151 for details.11521153credential.useHttpPath::1154 When acquiring credentials, consider the "path" component of an http1155 or https URL to be important. Defaults to false. See1156 linkgit:gitcredentials[7] for more information.11571158credential.username::1159 If no username is set for a network authentication, use this username1160 by default. See credential.<context>.* below, and1161 linkgit:gitcredentials[7].11621163credential.<url>.*::1164 Any of the credential.* options above can be applied selectively to1165 some credentials. For example "credential.https://example.com.username"1166 would set the default username only for https connections to1167 example.com. See linkgit:gitcredentials[7] for details on how URLs are1168 matched.11691170credentialCache.ignoreSIGHUP::1171 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.11721173include::diff-config.txt[]11741175difftool.<tool>.path::1176 Override the path for the given tool. This is useful in case1177 your tool is not in the PATH.11781179difftool.<tool>.cmd::1180 Specify the command to invoke the specified diff tool.1181 The specified command is evaluated in shell with the following1182 variables available: 'LOCAL' is set to the name of the temporary1183 file containing the contents of the diff pre-image and 'REMOTE'1184 is set to the name of the temporary file containing the contents1185 of the diff post-image.11861187difftool.prompt::1188 Prompt before each invocation of the diff tool.11891190fetch.recurseSubmodules::1191 This option can be either set to a boolean value or to 'on-demand'.1192 Setting it to a boolean changes the behavior of fetch and pull to1193 unconditionally recurse into submodules when set to true or to not1194 recurse at all when set to false. When set to 'on-demand' (the default1195 value), fetch and pull will only recurse into a populated submodule1196 when its superproject retrieves a commit that updates the submodule's1197 reference.11981199fetch.fsckObjects::1200 If it is set to true, git-fetch-pack will check all fetched1201 objects. It will abort in the case of a malformed object or a1202 broken link. The result of an abort are only dangling objects.1203 Defaults to false. If not set, the value of `transfer.fsckObjects`1204 is used instead.12051206fetch.unpackLimit::1207 If the number of objects fetched over the Git native1208 transfer is below this1209 limit, then the objects will be unpacked into loose object1210 files. However if the number of received objects equals or1211 exceeds this limit then the received pack will be stored as1212 a pack, after adding any missing delta bases. Storing the1213 pack from a push can make the push operation complete faster,1214 especially on slow filesystems. If not set, the value of1215 `transfer.unpackLimit` is used instead.12161217fetch.prune::1218 If true, fetch will automatically behave as if the `--prune`1219 option was given on the command line. See also `remote.<name>.prune`.12201221format.attach::1222 Enable multipart/mixed attachments as the default for1223 'format-patch'. The value can also be a double quoted string1224 which will enable attachments as the default and set the1225 value as the boundary. See the --attach option in1226 linkgit:git-format-patch[1].12271228format.numbered::1229 A boolean which can enable or disable sequence numbers in patch1230 subjects. It defaults to "auto" which enables it only if there1231 is more than one patch. It can be enabled or disabled for all1232 messages by setting it to "true" or "false". See --numbered1233 option in linkgit:git-format-patch[1].12341235format.headers::1236 Additional email headers to include in a patch to be submitted1237 by mail. See linkgit:git-format-patch[1].12381239format.to::1240format.cc::1241 Additional recipients to include in a patch to be submitted1242 by mail. See the --to and --cc options in1243 linkgit:git-format-patch[1].12441245format.subjectPrefix::1246 The default for format-patch is to output files with the '[PATCH]'1247 subject prefix. Use this variable to change that prefix.12481249format.signature::1250 The default for format-patch is to output a signature containing1251 the Git version number. Use this variable to change that default.1252 Set this variable to the empty string ("") to suppress1253 signature generation.12541255format.signatureFile::1256 Works just like format.signature except the contents of the1257 file specified by this variable will be used as the signature.12581259format.suffix::1260 The default for format-patch is to output files with the suffix1261 `.patch`. Use this variable to change that suffix (make sure to1262 include the dot if you want it).12631264format.pretty::1265 The default pretty format for log/show/whatchanged command,1266 See linkgit:git-log[1], linkgit:git-show[1],1267 linkgit:git-whatchanged[1].12681269format.thread::1270 The default threading style for 'git format-patch'. Can be1271 a boolean value, or `shallow` or `deep`. `shallow` threading1272 makes every mail a reply to the head of the series,1273 where the head is chosen from the cover letter, the1274 `--in-reply-to`, and the first patch mail, in this order.1275 `deep` threading makes every mail a reply to the previous one.1276 A true boolean value is the same as `shallow`, and a false1277 value disables threading.12781279format.signOff::1280 A boolean value which lets you enable the `-s/--signoff` option of1281 format-patch by default. *Note:* Adding the Signed-off-by: line to a1282 patch should be a conscious act and means that you certify you have1283 the rights to submit this work under the same open source license.1284 Please see the 'SubmittingPatches' document for further discussion.12851286format.coverLetter::1287 A boolean that controls whether to generate a cover-letter when1288 format-patch is invoked, but in addition can be set to "auto", to1289 generate a cover-letter only when there's more than one patch.12901291format.outputDirectory::1292 Set a custom directory to store the resulting files instead of the1293 current working directory.12941295format.useAutoBase::1296 A boolean value which lets you enable the `--base=auto` option of1297 format-patch by default.12981299filter.<driver>.clean::1300 The command which is used to convert the content of a worktree1301 file to a blob upon checkin. See linkgit:gitattributes[5] for1302 details.13031304filter.<driver>.smudge::1305 The command which is used to convert the content of a blob1306 object to a worktree file upon checkout. See1307 linkgit:gitattributes[5] for details.13081309fsck.<msg-id>::1310 Allows overriding the message type (error, warn or ignore) of a1311 specific message ID such as `missingEmail`.1312+1313For convenience, fsck prefixes the error/warning with the message ID,1314e.g. "missingEmail: invalid author/committer line - missing email" means1315that setting `fsck.missingEmail = ignore` will hide that issue.1316+1317This feature is intended to support working with legacy repositories1318which cannot be repaired without disruptive changes.13191320fsck.skipList::1321 The path to a sorted list of object names (i.e. one SHA-1 per1322 line) that are known to be broken in a non-fatal way and should1323 be ignored. This feature is useful when an established project1324 should be accepted despite early commits containing errors that1325 can be safely ignored such as invalid committer email addresses.1326 Note: corrupt objects cannot be skipped with this setting.13271328gc.aggressiveDepth::1329 The depth parameter used in the delta compression1330 algorithm used by 'git gc --aggressive'. This defaults1331 to 250.13321333gc.aggressiveWindow::1334 The window size parameter used in the delta compression1335 algorithm used by 'git gc --aggressive'. This defaults1336 to 250.13371338gc.auto::1339 When there are approximately more than this many loose1340 objects in the repository, `git gc --auto` will pack them.1341 Some Porcelain commands use this command to perform a1342 light-weight garbage collection from time to time. The1343 default value is 6700. Setting this to 0 disables it.13441345gc.autoPackLimit::1346 When there are more than this many packs that are not1347 marked with `*.keep` file in the repository, `git gc1348 --auto` consolidates them into one larger pack. The1349 default value is 50. Setting this to 0 disables it.13501351gc.autoDetach::1352 Make `git gc --auto` return immediately and run in background1353 if the system supports it. Default is true.13541355gc.packRefs::1356 Running `git pack-refs` in a repository renders it1357 unclonable by Git versions prior to 1.5.1.2 over dumb1358 transports such as HTTP. This variable determines whether1359 'git gc' runs `git pack-refs`. This can be set to `notbare`1360 to enable it within all non-bare repos or it can be set to a1361 boolean value. The default is `true`.13621363gc.pruneExpire::1364 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.1365 Override the grace period with this config variable. The value1366 "now" may be used to disable this grace period and always prune1367 unreachable objects immediately, or "never" may be used to1368 suppress pruning.13691370gc.worktreePruneExpire::1371 When 'git gc' is run, it calls1372 'git worktree prune --expire 3.months.ago'.1373 This config variable can be used to set a different grace1374 period. The value "now" may be used to disable the grace1375 period and prune `$GIT_DIR/worktrees` immediately, or "never"1376 may be used to suppress pruning.13771378gc.reflogExpire::1379gc.<pattern>.reflogExpire::1380 'git reflog expire' removes reflog entries older than1381 this time; defaults to 90 days. The value "now" expires all1382 entries immediately, and "never" suppresses expiration1383 altogether. With "<pattern>" (e.g.1384 "refs/stash") in the middle the setting applies only to1385 the refs that match the <pattern>.13861387gc.reflogExpireUnreachable::1388gc.<pattern>.reflogExpireUnreachable::1389 'git reflog expire' removes reflog entries older than1390 this time and are not reachable from the current tip;1391 defaults to 30 days. The value "now" expires all entries1392 immediately, and "never" suppresses expiration altogether.1393 With "<pattern>" (e.g. "refs/stash")1394 in the middle, the setting applies only to the refs that1395 match the <pattern>.13961397gc.rerereResolved::1398 Records of conflicted merge you resolved earlier are1399 kept for this many days when 'git rerere gc' is run.1400 The default is 60 days. See linkgit:git-rerere[1].14011402gc.rerereUnresolved::1403 Records of conflicted merge you have not resolved are1404 kept for this many days when 'git rerere gc' is run.1405 The default is 15 days. See linkgit:git-rerere[1].14061407gitcvs.commitMsgAnnotation::1408 Append this string to each commit message. Set to empty string1409 to disable this feature. Defaults to "via git-CVS emulator".14101411gitcvs.enabled::1412 Whether the CVS server interface is enabled for this repository.1413 See linkgit:git-cvsserver[1].14141415gitcvs.logFile::1416 Path to a log file where the CVS server interface well... logs1417 various stuff. See linkgit:git-cvsserver[1].14181419gitcvs.usecrlfattr::1420 If true, the server will look up the end-of-line conversion1421 attributes for files to determine the `-k` modes to use. If1422 the attributes force Git to treat a file as text,1423 the `-k` mode will be left blank so CVS clients will1424 treat it as text. If they suppress text conversion, the file1425 will be set with '-kb' mode, which suppresses any newline munging1426 the client might otherwise do. If the attributes do not allow1427 the file type to be determined, then `gitcvs.allBinary` is1428 used. See linkgit:gitattributes[5].14291430gitcvs.allBinary::1431 This is used if `gitcvs.usecrlfattr` does not resolve1432 the correct '-kb' mode to use. If true, all1433 unresolved files are sent to the client in1434 mode '-kb'. This causes the client to treat them1435 as binary files, which suppresses any newline munging it1436 otherwise might do. Alternatively, if it is set to "guess",1437 then the contents of the file are examined to decide if1438 it is binary, similar to `core.autocrlf`.14391440gitcvs.dbName::1441 Database used by git-cvsserver to cache revision information1442 derived from the Git repository. The exact meaning depends on the1443 used database driver, for SQLite (which is the default driver) this1444 is a filename. Supports variable substitution (see1445 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).1446 Default: '%Ggitcvs.%m.sqlite'14471448gitcvs.dbDriver::1449 Used Perl DBI driver. You can specify any available driver1450 for this here, but it might not work. git-cvsserver is tested1451 with 'DBD::SQLite', reported to work with 'DBD::Pg', and1452 reported *not* to work with 'DBD::mysql'. Experimental feature.1453 May not contain double colons (`:`). Default: 'SQLite'.1454 See linkgit:git-cvsserver[1].14551456gitcvs.dbUser, gitcvs.dbPass::1457 Database user and password. Only useful if setting `gitcvs.dbDriver`,1458 since SQLite has no concept of database users and/or passwords.1459 'gitcvs.dbUser' supports variable substitution (see1460 linkgit:git-cvsserver[1] for details).14611462gitcvs.dbTableNamePrefix::1463 Database table name prefix. Prepended to the names of any1464 database tables used, allowing a single database to be used1465 for several repositories. Supports variable substitution (see1466 linkgit:git-cvsserver[1] for details). Any non-alphabetic1467 characters will be replaced with underscores.14681469All gitcvs variables except for `gitcvs.usecrlfattr` and1470`gitcvs.allBinary` can also be specified as1471'gitcvs.<access_method>.<varname>' (where 'access_method'1472is one of "ext" and "pserver") to make them apply only for the given1473access method.14741475gitweb.category::1476gitweb.description::1477gitweb.owner::1478gitweb.url::1479 See linkgit:gitweb[1] for description.14801481gitweb.avatar::1482gitweb.blame::1483gitweb.grep::1484gitweb.highlight::1485gitweb.patches::1486gitweb.pickaxe::1487gitweb.remote_heads::1488gitweb.showSizes::1489gitweb.snapshot::1490 See linkgit:gitweb.conf[5] for description.14911492grep.lineNumber::1493 If set to true, enable `-n` option by default.14941495grep.patternType::1496 Set the default matching behavior. Using a value of 'basic', 'extended',1497 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,1498 `--fixed-strings`, or `--perl-regexp` option accordingly, while the1499 value 'default' will return to the default matching behavior.15001501grep.extendedRegexp::1502 If set to true, enable `--extended-regexp` option by default. This1503 option is ignored when the `grep.patternType` option is set to a value1504 other than 'default'.15051506grep.threads::1507 Number of grep worker threads to use.1508 See `grep.threads` in linkgit:git-grep[1] for more information.15091510grep.fallbackToNoIndex::1511 If set to true, fall back to git grep --no-index if git grep1512 is executed outside of a git repository. Defaults to false.15131514gpg.program::1515 Use this custom program instead of "`gpg`" found on `$PATH` when1516 making or verifying a PGP signature. The program must support the1517 same command-line interface as GPG, namely, to verify a detached1518 signature, "`gpg --verify $file - <$signature`" is run, and the1519 program is expected to signal a good signature by exiting with1520 code 0, and to generate an ASCII-armored detached signature, the1521 standard input of "`gpg -bsau $key`" is fed with the contents to be1522 signed, and the program is expected to send the result to its1523 standard output.15241525gui.commitMsgWidth::1526 Defines how wide the commit message window is in the1527 linkgit:git-gui[1]. "75" is the default.15281529gui.diffContext::1530 Specifies how many context lines should be used in calls to diff1531 made by the linkgit:git-gui[1]. The default is "5".15321533gui.displayUntracked::1534 Determines if linkgit:git-gui[1] shows untracked files1535 in the file list. The default is "true".15361537gui.encoding::1538 Specifies the default encoding to use for displaying of1539 file contents in linkgit:git-gui[1] and linkgit:gitk[1].1540 It can be overridden by setting the 'encoding' attribute1541 for relevant files (see linkgit:gitattributes[5]).1542 If this option is not set, the tools default to the1543 locale encoding.15441545gui.matchTrackingBranch::1546 Determines if new branches created with linkgit:git-gui[1] should1547 default to tracking remote branches with matching names or1548 not. Default: "false".15491550gui.newBranchTemplate::1551 Is used as suggested name when creating new branches using the1552 linkgit:git-gui[1].15531554gui.pruneDuringFetch::1555 "true" if linkgit:git-gui[1] should prune remote-tracking branches when1556 performing a fetch. The default value is "false".15571558gui.trustmtime::1559 Determines if linkgit:git-gui[1] should trust the file modification1560 timestamp or not. By default the timestamps are not trusted.15611562gui.spellingDictionary::1563 Specifies the dictionary used for spell checking commit messages in1564 the linkgit:git-gui[1]. When set to "none" spell checking is turned1565 off.15661567gui.fastCopyBlame::1568 If true, 'git gui blame' uses `-C` instead of `-C -C` for original1569 location detection. It makes blame significantly faster on huge1570 repositories at the expense of less thorough copy detection.15711572gui.copyBlameThreshold::1573 Specifies the threshold to use in 'git gui blame' original location1574 detection, measured in alphanumeric characters. See the1575 linkgit:git-blame[1] manual for more information on copy detection.15761577gui.blamehistoryctx::1578 Specifies the radius of history context in days to show in1579 linkgit:gitk[1] for the selected commit, when the `Show History1580 Context` menu item is invoked from 'git gui blame'. If this1581 variable is set to zero, the whole history is shown.15821583guitool.<name>.cmd::1584 Specifies the shell command line to execute when the corresponding item1585 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is1586 mandatory for every tool. The command is executed from the root of1587 the working directory, and in the environment it receives the name of1588 the tool as `GIT_GUITOOL`, the name of the currently selected file as1589 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if1590 the head is detached, 'CUR_BRANCH' is empty).15911592guitool.<name>.needsFile::1593 Run the tool only if a diff is selected in the GUI. It guarantees1594 that 'FILENAME' is not empty.15951596guitool.<name>.noConsole::1597 Run the command silently, without creating a window to display its1598 output.15991600guitool.<name>.noRescan::1601 Don't rescan the working directory for changes after the tool1602 finishes execution.16031604guitool.<name>.confirm::1605 Show a confirmation dialog before actually running the tool.16061607guitool.<name>.argPrompt::1608 Request a string argument from the user, and pass it to the tool1609 through the `ARGS` environment variable. Since requesting an1610 argument implies confirmation, the 'confirm' option has no effect1611 if this is enabled. If the option is set to 'true', 'yes', or '1',1612 the dialog uses a built-in generic prompt; otherwise the exact1613 value of the variable is used.16141615guitool.<name>.revPrompt::1616 Request a single valid revision from the user, and set the1617 `REVISION` environment variable. In other aspects this option1618 is similar to 'argPrompt', and can be used together with it.16191620guitool.<name>.revUnmerged::1621 Show only unmerged branches in the 'revPrompt' subdialog.1622 This is useful for tools similar to merge or rebase, but not1623 for things like checkout or reset.16241625guitool.<name>.title::1626 Specifies the title to use for the prompt dialog. The default1627 is the tool name.16281629guitool.<name>.prompt::1630 Specifies the general prompt string to display at the top of1631 the dialog, before subsections for 'argPrompt' and 'revPrompt'.1632 The default value includes the actual command.16331634help.browser::1635 Specify the browser that will be used to display help in the1636 'web' format. See linkgit:git-help[1].16371638help.format::1639 Override the default help format used by linkgit:git-help[1].1640 Values 'man', 'info', 'web' and 'html' are supported. 'man' is1641 the default. 'web' and 'html' are the same.16421643help.autoCorrect::1644 Automatically correct and execute mistyped commands after1645 waiting for the given number of deciseconds (0.1 sec). If more1646 than one command can be deduced from the entered text, nothing1647 will be executed. If the value of this option is negative,1648 the corrected command will be executed immediately. If the1649 value is 0 - the command will be just shown but not executed.1650 This is the default.16511652help.htmlPath::1653 Specify the path where the HTML documentation resides. File system paths1654 and URLs are supported. HTML pages will be prefixed with this path when1655 help is displayed in the 'web' format. This defaults to the documentation1656 path of your Git installation.16571658http.proxy::1659 Override the HTTP proxy, normally configured using the 'http_proxy',1660 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In1661 addition to the syntax understood by curl, it is possible to specify a1662 proxy string with a user name but no password, in which case git will1663 attempt to acquire one in the same way it does for other credentials. See1664 linkgit:gitcredentials[7] for more information. The syntax thus is1665 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden1666 on a per-remote basis; see remote.<name>.proxy16671668http.proxyAuthMethod::1669 Set the method with which to authenticate against the HTTP proxy. This1670 only takes effect if the configured proxy string contains a user name part1671 (i.e. is of the form 'user@host' or 'user@host:port'). This can be1672 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.1673 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment1674 variable. Possible values are:1675+1676--1677* `anyauth` - Automatically pick a suitable authentication method. It is1678 assumed that the proxy answers an unauthenticated request with a 4071679 status code and one or more Proxy-authenticate headers with supported1680 authentication methods. This is the default.1681* `basic` - HTTP Basic authentication1682* `digest` - HTTP Digest authentication; this prevents the password from being1683 transmitted to the proxy in clear text1684* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option1685 of `curl(1)`)1686* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)1687--16881689http.emptyAuth::1690 Attempt authentication without seeking a username or password. This1691 can be used to attempt GSS-Negotiate authentication without specifying1692 a username in the URL, as libcurl normally requires a username for1693 authentication.16941695http.extraHeader::1696 Pass an additional HTTP header when communicating with a server. If1697 more than one such entry exists, all of them are added as extra1698 headers. To allow overriding the settings inherited from the system1699 config, an empty value will reset the extra headers to the empty list.17001701http.cookieFile::1702 The pathname of a file containing previously stored cookie lines,1703 which should be used1704 in the Git http session, if they match the server. The file format1705 of the file to read cookies from should be plain HTTP headers or1706 the Netscape/Mozilla cookie file format (see `curl(1)`).1707 NOTE that the file specified with http.cookieFile is used only as1708 input unless http.saveCookies is set.17091710http.saveCookies::1711 If set, store cookies received during requests to the file specified by1712 http.cookieFile. Has no effect if http.cookieFile is unset.17131714http.sslVersion::1715 The SSL version to use when negotiating an SSL connection, if you1716 want to force the default. The available and default version1717 depend on whether libcurl was built against NSS or OpenSSL and the1718 particular configuration of the crypto library in use. Internally1719 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl1720 documentation for more details on the format of this option and1721 for the ssl version supported. Actually the possible values of1722 this option are:17231724 - sslv21725 - sslv31726 - tlsv11727 - tlsv1.01728 - tlsv1.11729 - tlsv1.217301731+1732Can be overridden by the `GIT_SSL_VERSION` environment variable.1733To force git to use libcurl's default ssl version and ignore any1734explicit http.sslversion option, set `GIT_SSL_VERSION` to the1735empty string.17361737http.sslCipherList::1738 A list of SSL ciphers to use when negotiating an SSL connection.1739 The available ciphers depend on whether libcurl was built against1740 NSS or OpenSSL and the particular configuration of the crypto1741 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'1742 option; see the libcurl documentation for more details on the format1743 of this list.1744+1745Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.1746To force git to use libcurl's default cipher list and ignore any1747explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the1748empty string.17491750http.sslVerify::1751 Whether to verify the SSL certificate when fetching or pushing1752 over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment1753 variable.17541755http.sslCert::1756 File containing the SSL certificate when fetching or pushing1757 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment1758 variable.17591760http.sslKey::1761 File containing the SSL private key when fetching or pushing1762 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment1763 variable.17641765http.sslCertPasswordProtected::1766 Enable Git's password prompt for the SSL certificate. Otherwise1767 OpenSSL will prompt the user, possibly many times, if the1768 certificate or private key is encrypted. Can be overridden by the1769 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.17701771http.sslCAInfo::1772 File containing the certificates to verify the peer with when1773 fetching or pushing over HTTPS. Can be overridden by the1774 `GIT_SSL_CAINFO` environment variable.17751776http.sslCAPath::1777 Path containing files with the CA certificates to verify the peer1778 with when fetching or pushing over HTTPS. Can be overridden1779 by the `GIT_SSL_CAPATH` environment variable.17801781http.pinnedpubkey::1782 Public key of the https service. It may either be the filename of1783 a PEM or DER encoded public key file or a string starting with1784 'sha256//' followed by the base64 encoded sha256 hash of the1785 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will1786 exit with an error if this option is set but not supported by1787 cURL.17881789http.sslTry::1790 Attempt to use AUTH SSL/TLS and encrypted data transfers1791 when connecting via regular FTP protocol. This might be needed1792 if the FTP server requires it for security reasons or you wish1793 to connect securely whenever remote FTP server supports it.1794 Default is false since it might trigger certificate verification1795 errors on misconfigured servers.17961797http.maxRequests::1798 How many HTTP requests to launch in parallel. Can be overridden1799 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.18001801http.minSessions::1802 The number of curl sessions (counted across slots) to be kept across1803 requests. They will not be ended with curl_easy_cleanup() until1804 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this1805 value will be capped at 1. Defaults to 1.18061807http.postBuffer::1808 Maximum size in bytes of the buffer used by smart HTTP1809 transports when POSTing data to the remote system.1810 For requests larger than this buffer size, HTTP/1.1 and1811 Transfer-Encoding: chunked is used to avoid creating a1812 massive pack file locally. Default is 1 MiB, which is1813 sufficient for most requests.18141815http.lowSpeedLimit, http.lowSpeedTime::1816 If the HTTP transfer speed is less than 'http.lowSpeedLimit'1817 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.1818 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and1819 `GIT_HTTP_LOW_SPEED_TIME` environment variables.18201821http.noEPSV::1822 A boolean which disables using of EPSV ftp command by curl.1823 This can helpful with some "poor" ftp servers which don't1824 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`1825 environment variable. Default is false (curl will use EPSV).18261827http.userAgent::1828 The HTTP USER_AGENT string presented to an HTTP server. The default1829 value represents the version of the client Git such as git/1.7.1.1830 This option allows you to override this value to a more common value1831 such as Mozilla/4.0. This may be necessary, for instance, if1832 connecting through a firewall that restricts HTTP connections to a set1833 of common USER_AGENT strings (but not including those like git/1.7.1).1834 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.18351836http.<url>.*::1837 Any of the http.* options above can be applied selectively to some URLs.1838 For a config key to match a URL, each element of the config key is1839 compared to that of the URL, in the following order:1840+1841--1842. Scheme (e.g., `https` in `https://example.com/`). This field1843 must match exactly between the config key and the URL.18441845. Host/domain name (e.g., `example.com` in `https://example.com/`).1846 This field must match exactly between the config key and the URL.18471848. Port number (e.g., `8080` in `http://example.com:8080/`).1849 This field must match exactly between the config key and the URL.1850 Omitted port numbers are automatically converted to the correct1851 default for the scheme before matching.18521853. Path (e.g., `repo.git` in `https://example.com/repo.git`). The1854 path field of the config key must match the path field of the URL1855 either exactly or as a prefix of slash-delimited path elements. This means1856 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only1857 match on a slash (`/`) boundary. Longer matches take precedence (so a config1858 key with path `foo/bar` is a better match to URL path `foo/bar` than a config1859 key with just path `foo/`).18601861. User name (e.g., `user` in `https://user@example.com/repo.git`). If1862 the config key has a user name it must match the user name in the1863 URL exactly. If the config key does not have a user name, that1864 config key will match a URL with any user name (including none),1865 but at a lower precedence than a config key with a user name.1866--1867+1868The list above is ordered by decreasing precedence; a URL that matches1869a config key's path is preferred to one that matches its user name. For example,1870if the URL is `https://user@example.com/foo/bar` a config key match of1871`https://example.com/foo` will be preferred over a config key match of1872`https://user@example.com`.1873+1874All URLs are normalized before attempting any matching (the password part,1875if embedded in the URL, is always ignored for matching purposes) so that1876equivalent URLs that are simply spelled differently will match properly.1877Environment variable settings always override any matches. The URLs that are1878matched against are those given directly to Git commands. This means any URLs1879visited as a result of a redirection do not participate in matching.18801881i18n.commitEncoding::1882 Character encoding the commit messages are stored in; Git itself1883 does not care per se, but this information is necessary e.g. when1884 importing commits from emails or in the gitk graphical history1885 browser (and possibly at other places in the future or in other1886 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.18871888i18n.logOutputEncoding::1889 Character encoding the commit messages are converted to when1890 running 'git log' and friends.18911892imap::1893 The configuration variables in the 'imap' section are described1894 in linkgit:git-imap-send[1].18951896index.version::1897 Specify the version with which new index files should be1898 initialized. This does not affect existing repositories.18991900init.templateDir::1901 Specify the directory from which templates will be copied.1902 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)19031904instaweb.browser::1905 Specify the program that will be used to browse your working1906 repository in gitweb. See linkgit:git-instaweb[1].19071908instaweb.httpd::1909 The HTTP daemon command-line to start gitweb on your working1910 repository. See linkgit:git-instaweb[1].19111912instaweb.local::1913 If true the web server started by linkgit:git-instaweb[1] will1914 be bound to the local IP (127.0.0.1).19151916instaweb.modulePath::1917 The default module path for linkgit:git-instaweb[1] to use1918 instead of /usr/lib/apache2/modules. Only used if httpd1919 is Apache.19201921instaweb.port::1922 The port number to bind the gitweb httpd to. See1923 linkgit:git-instaweb[1].19241925interactive.singleKey::1926 In interactive commands, allow the user to provide one-letter1927 input with a single key (i.e., without hitting enter).1928 Currently this is used by the `--patch` mode of1929 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],1930 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this1931 setting is silently ignored if portable keystroke input1932 is not available; requires the Perl module Term::ReadKey.19331934interactive.diffFilter::1935 When an interactive command (such as `git add --patch`) shows1936 a colorized diff, git will pipe the diff through the shell1937 command defined by this configuration variable. The command may1938 mark up the diff further for human consumption, provided that it1939 retains a one-to-one correspondence with the lines in the1940 original diff. Defaults to disabled (no filtering).19411942log.abbrevCommit::1943 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1944 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may1945 override this option with `--no-abbrev-commit`.19461947log.date::1948 Set the default date-time mode for the 'log' command.1949 Setting a value for log.date is similar to using 'git log''s1950 `--date` option. See linkgit:git-log[1] for details.19511952log.decorate::1953 Print out the ref names of any commits that are shown by the log1954 command. If 'short' is specified, the ref name prefixes 'refs/heads/',1955 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is1956 specified, the full ref name (including prefix) will be printed.1957 If 'auto' is specified, then if the output is going to a terminal,1958 the ref names are shown as if 'short' were given, otherwise no ref1959 names are shown. This is the same as the `--decorate` option1960 of the `git log`.19611962log.follow::1963 If `true`, `git log` will act as if the `--follow` option was used when1964 a single <path> is given. This has the same limitations as `--follow`,1965 i.e. it cannot be used to follow multiple files and does not work well1966 on non-linear history.19671968log.showRoot::1969 If true, the initial commit will be shown as a big creation event.1970 This is equivalent to a diff against an empty tree.1971 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which1972 normally hide the root commit will now show it. True by default.19731974log.mailmap::1975 If true, makes linkgit:git-log[1], linkgit:git-show[1], and1976 linkgit:git-whatchanged[1] assume `--use-mailmap`.19771978mailinfo.scissors::1979 If true, makes linkgit:git-mailinfo[1] (and therefore1980 linkgit:git-am[1]) act by default as if the --scissors option1981 was provided on the command-line. When active, this features1982 removes everything from the message body before a scissors1983 line (i.e. consisting mainly of ">8", "8<" and "-").19841985mailmap.file::1986 The location of an augmenting mailmap file. The default1987 mailmap, located in the root of the repository, is loaded1988 first, then the mailmap file pointed to by this variable.1989 The location of the mailmap file may be in a repository1990 subdirectory, or somewhere outside of the repository itself.1991 See linkgit:git-shortlog[1] and linkgit:git-blame[1].19921993mailmap.blob::1994 Like `mailmap.file`, but consider the value as a reference to a1995 blob in the repository. If both `mailmap.file` and1996 `mailmap.blob` are given, both are parsed, with entries from1997 `mailmap.file` taking precedence. In a bare repository, this1998 defaults to `HEAD:.mailmap`. In a non-bare repository, it1999 defaults to empty.20002001man.viewer::2002 Specify the programs that may be used to display help in the2003 'man' format. See linkgit:git-help[1].20042005man.<tool>.cmd::2006 Specify the command to invoke the specified man viewer. The2007 specified command is evaluated in shell with the man page2008 passed as argument. (See linkgit:git-help[1].)20092010man.<tool>.path::2011 Override the path for the given tool that may be used to2012 display help in the 'man' format. See linkgit:git-help[1].20132014include::merge-config.txt[]20152016mergetool.<tool>.path::2017 Override the path for the given tool. This is useful in case2018 your tool is not in the PATH.20192020mergetool.<tool>.cmd::2021 Specify the command to invoke the specified merge tool. The2022 specified command is evaluated in shell with the following2023 variables available: 'BASE' is the name of a temporary file2024 containing the common base of the files to be merged, if available;2025 'LOCAL' is the name of a temporary file containing the contents of2026 the file on the current branch; 'REMOTE' is the name of a temporary2027 file containing the contents of the file from the branch being2028 merged; 'MERGED' contains the name of the file to which the merge2029 tool should write the results of a successful merge.20302031mergetool.<tool>.trustExitCode::2032 For a custom merge command, specify whether the exit code of2033 the merge command can be used to determine whether the merge was2034 successful. If this is not set to true then the merge target file2035 timestamp is checked and the merge assumed to have been successful2036 if the file has been updated, otherwise the user is prompted to2037 indicate the success of the merge.20382039mergetool.meld.hasOutput::2040 Older versions of `meld` do not support the `--output` option.2041 Git will attempt to detect whether `meld` supports `--output`2042 by inspecting the output of `meld --help`. Configuring2043 `mergetool.meld.hasOutput` will make Git skip these checks and2044 use the configured value instead. Setting `mergetool.meld.hasOutput`2045 to `true` tells Git to unconditionally use the `--output` option,2046 and `false` avoids using `--output`.20472048mergetool.keepBackup::2049 After performing a merge, the original file with conflict markers2050 can be saved as a file with a `.orig` extension. If this variable2051 is set to `false` then this file is not preserved. Defaults to2052 `true` (i.e. keep the backup files).20532054mergetool.keepTemporaries::2055 When invoking a custom merge tool, Git uses a set of temporary2056 files to pass to the tool. If the tool returns an error and this2057 variable is set to `true`, then these temporary files will be2058 preserved, otherwise they will be removed after the tool has2059 exited. Defaults to `false`.20602061mergetool.writeToTemp::2062 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of2063 conflicting files in the worktree by default. Git will attempt2064 to use a temporary directory for these files when set `true`.2065 Defaults to `false`.20662067mergetool.prompt::2068 Prompt before each invocation of the merge resolution program.20692070notes.mergeStrategy::2071 Which merge strategy to choose by default when resolving notes2072 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or2073 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"2074 section of linkgit:git-notes[1] for more information on each strategy.20752076notes.<name>.mergeStrategy::2077 Which merge strategy to choose when doing a notes merge into2078 refs/notes/<name>. This overrides the more general2079 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in2080 linkgit:git-notes[1] for more information on the available strategies.20812082notes.displayRef::2083 The (fully qualified) refname from which to show notes when2084 showing commit messages. The value of this variable can be set2085 to a glob, in which case notes from all matching refs will be2086 shown. You may also specify this configuration variable2087 several times. A warning will be issued for refs that do not2088 exist, but a glob that does not match any refs is silently2089 ignored.2090+2091This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`2092environment variable, which must be a colon separated list of refs or2093globs.2094+2095The effective value of "core.notesRef" (possibly overridden by2096GIT_NOTES_REF) is also implicitly added to the list of refs to be2097displayed.20982099notes.rewrite.<command>::2100 When rewriting commits with <command> (currently `amend` or2101 `rebase`) and this variable is set to `true`, Git2102 automatically copies your notes from the original to the2103 rewritten commit. Defaults to `true`, but see2104 "notes.rewriteRef" below.21052106notes.rewriteMode::2107 When copying notes during a rewrite (see the2108 "notes.rewrite.<command>" option), determines what to do if2109 the target commit already has a note. Must be one of2110 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.2111 Defaults to `concatenate`.2112+2113This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`2114environment variable.21152116notes.rewriteRef::2117 When copying notes during a rewrite, specifies the (fully2118 qualified) ref whose notes should be copied. The ref may be a2119 glob, in which case notes in all matching refs will be copied.2120 You may also specify this configuration several times.2121+2122Does not have a default value; you must configure this variable to2123enable note rewriting. Set it to `refs/notes/commits` to enable2124rewriting for the default commit notes.2125+2126This setting can be overridden with the `GIT_NOTES_REWRITE_REF`2127environment variable, which must be a colon separated list of refs or2128globs.21292130pack.window::2131 The size of the window used by linkgit:git-pack-objects[1] when no2132 window size is given on the command line. Defaults to 10.21332134pack.depth::2135 The maximum delta depth used by linkgit:git-pack-objects[1] when no2136 maximum depth is given on the command line. Defaults to 50.21372138pack.windowMemory::2139 The maximum size of memory that is consumed by each thread2140 in linkgit:git-pack-objects[1] for pack window memory when2141 no limit is given on the command line. The value can be2142 suffixed with "k", "m", or "g". When left unconfigured (or2143 set explicitly to 0), there will be no limit.21442145pack.compression::2146 An integer -1..9, indicating the compression level for objects2147 in a pack file. -1 is the zlib default. 0 means no2148 compression, and 1..9 are various speed/size tradeoffs, 9 being2149 slowest. If not set, defaults to core.compression. If that is2150 not set, defaults to -1, the zlib default, which is "a default2151 compromise between speed and compression (currently equivalent2152 to level 6)."2153+2154Note that changing the compression level will not automatically recompress2155all existing objects. You can force recompression by passing the -F option2156to linkgit:git-repack[1].21572158pack.deltaCacheSize::2159 The maximum memory in bytes used for caching deltas in2160 linkgit:git-pack-objects[1] before writing them out to a pack.2161 This cache is used to speed up the writing object phase by not2162 having to recompute the final delta result once the best match2163 for all objects is found. Repacking large repositories on machines2164 which are tight with memory might be badly impacted by this though,2165 especially if this cache pushes the system into swapping.2166 A value of 0 means no limit. The smallest size of 1 byte may be2167 used to virtually disable this cache. Defaults to 256 MiB.21682169pack.deltaCacheLimit::2170 The maximum size of a delta, that is cached in2171 linkgit:git-pack-objects[1]. This cache is used to speed up the2172 writing object phase by not having to recompute the final delta2173 result once the best match for all objects is found. Defaults to 1000.21742175pack.threads::2176 Specifies the number of threads to spawn when searching for best2177 delta matches. This requires that linkgit:git-pack-objects[1]2178 be compiled with pthreads otherwise this option is ignored with a2179 warning. This is meant to reduce packing time on multiprocessor2180 machines. The required amount of memory for the delta search window2181 is however multiplied by the number of threads.2182 Specifying 0 will cause Git to auto-detect the number of CPU's2183 and set the number of threads accordingly.21842185pack.indexVersion::2186 Specify the default pack index version. Valid values are 1 for2187 legacy pack index used by Git versions prior to 1.5.2, and 2 for2188 the new pack index with capabilities for packs larger than 4 GB2189 as well as proper protection against the repacking of corrupted2190 packs. Version 2 is the default. Note that version 2 is enforced2191 and this config option ignored whenever the corresponding pack is2192 larger than 2 GB.2193+2194If you have an old Git that does not understand the version 2 `*.idx` file,2195cloning or fetching over a non native protocol (e.g. "http")2196that will copy both `*.pack` file and corresponding `*.idx` file from the2197other side may give you a repository that cannot be accessed with your2198older version of Git. If the `*.pack` file is smaller than 2 GB, however,2199you can use linkgit:git-index-pack[1] on the *.pack file to regenerate2200the `*.idx` file.22012202pack.packSizeLimit::2203 The maximum size of a pack. This setting only affects2204 packing to a file when repacking, i.e. the git:// protocol2205 is unaffected. It can be overridden by the `--max-pack-size`2206 option of linkgit:git-repack[1]. Reaching this limit results2207 in the creation of multiple packfiles; which in turn prevents2208 bitmaps from being created.2209 The minimum size allowed is limited to 1 MiB.2210 The default is unlimited.2211 Common unit suffixes of 'k', 'm', or 'g' are2212 supported.22132214pack.useBitmaps::2215 When true, git will use pack bitmaps (if available) when packing2216 to stdout (e.g., during the server side of a fetch). Defaults to2217 true. You should not generally need to turn this off unless2218 you are debugging pack bitmaps.22192220pack.writeBitmaps (deprecated)::2221 This is a deprecated synonym for `repack.writeBitmaps`.22222223pack.writeBitmapHashCache::2224 When true, git will include a "hash cache" section in the bitmap2225 index (if one is written). This cache can be used to feed git's2226 delta heuristics, potentially leading to better deltas between2227 bitmapped and non-bitmapped objects (e.g., when serving a fetch2228 between an older, bitmapped pack and objects that have been2229 pushed since the last gc). The downside is that it consumes 42230 bytes per object of disk space, and that JGit's bitmap2231 implementation does not understand it, causing it to complain if2232 Git and JGit are used on the same repository. Defaults to false.22332234pager.<cmd>::2235 If the value is boolean, turns on or off pagination of the2236 output of a particular Git subcommand when writing to a tty.2237 Otherwise, turns on pagination for the subcommand using the2238 pager specified by the value of `pager.<cmd>`. If `--paginate`2239 or `--no-pager` is specified on the command line, it takes2240 precedence over this option. To disable pagination for all2241 commands, set `core.pager` or `GIT_PAGER` to `cat`.22422243pretty.<name>::2244 Alias for a --pretty= format string, as specified in2245 linkgit:git-log[1]. Any aliases defined here can be used just2246 as the built-in pretty formats could. For example,2247 running `git config pretty.changelog "format:* %H %s"`2248 would cause the invocation `git log --pretty=changelog`2249 to be equivalent to running `git log "--pretty=format:* %H %s"`.2250 Note that an alias with the same name as a built-in format2251 will be silently ignored.22522253pull.ff::2254 By default, Git does not create an extra merge commit when merging2255 a commit that is a descendant of the current commit. Instead, the2256 tip of the current branch is fast-forwarded. When set to `false`,2257 this variable tells Git to create an extra merge commit in such2258 a case (equivalent to giving the `--no-ff` option from the command2259 line). When set to `only`, only such fast-forward merges are2260 allowed (equivalent to giving the `--ff-only` option from the2261 command line). This setting overrides `merge.ff` when pulling.22622263pull.rebase::2264 When true, rebase branches on top of the fetched branch, instead2265 of merging the default branch from the default remote when "git2266 pull" is run. See "branch.<name>.rebase" for setting this on a2267 per-branch basis.2268+2269When preserve, also pass `--preserve-merges` along to 'git rebase'2270so that locally committed merge commits will not be flattened2271by running 'git pull'.2272+2273When the value is `interactive`, the rebase is run in interactive mode.2274+2275*NOTE*: this is a possibly dangerous operation; do *not* use2276it unless you understand the implications (see linkgit:git-rebase[1]2277for details).22782279pull.octopus::2280 The default merge strategy to use when pulling multiple branches2281 at once.22822283pull.twohead::2284 The default merge strategy to use when pulling a single branch.22852286push.default::2287 Defines the action `git push` should take if no refspec is2288 explicitly given. Different values are well-suited for2289 specific workflows; for instance, in a purely central workflow2290 (i.e. the fetch source is equal to the push destination),2291 `upstream` is probably what you want. Possible values are:2292+2293--22942295* `nothing` - do not push anything (error out) unless a refspec is2296 explicitly given. This is primarily meant for people who want to2297 avoid mistakes by always being explicit.22982299* `current` - push the current branch to update a branch with the same2300 name on the receiving end. Works in both central and non-central2301 workflows.23022303* `upstream` - push the current branch back to the branch whose2304 changes are usually integrated into the current branch (which is2305 called `@{upstream}`). This mode only makes sense if you are2306 pushing to the same repository you would normally pull from2307 (i.e. central workflow).23082309* `simple` - in centralized workflow, work like `upstream` with an2310 added safety to refuse to push if the upstream branch's name is2311 different from the local one.2312+2313When pushing to a remote that is different from the remote you normally2314pull from, work as `current`. This is the safest option and is suited2315for beginners.2316+2317This mode has become the default in Git 2.0.23182319* `matching` - push all branches having the same name on both ends.2320 This makes the repository you are pushing to remember the set of2321 branches that will be pushed out (e.g. if you always push 'maint'2322 and 'master' there and no other branches, the repository you push2323 to will have these two branches, and your local 'maint' and2324 'master' will be pushed there).2325+2326To use this mode effectively, you have to make sure _all_ the2327branches you would push out are ready to be pushed out before2328running 'git push', as the whole point of this mode is to allow you2329to push all of the branches in one go. If you usually finish work2330on only one branch and push out the result, while other branches are2331unfinished, this mode is not for you. Also this mode is not2332suitable for pushing into a shared central repository, as other2333people may add new branches there, or update the tip of existing2334branches outside your control.2335+2336This used to be the default, but not since Git 2.0 (`simple` is the2337new default).23382339--23402341push.followTags::2342 If set to true enable `--follow-tags` option by default. You2343 may override this configuration at time of push by specifying2344 `--no-follow-tags`.23452346push.gpgSign::2347 May be set to a boolean value, or the string 'if-asked'. A true2348 value causes all pushes to be GPG signed, as if `--signed` is2349 passed to linkgit:git-push[1]. The string 'if-asked' causes2350 pushes to be signed if the server supports it, as if2351 `--signed=if-asked` is passed to 'git push'. A false value may2352 override a value from a lower-priority config file. An explicit2353 command-line flag always overrides this config option.23542355push.recurseSubmodules::2356 Make sure all submodule commits used by the revisions to be pushed2357 are available on a remote-tracking branch. If the value is 'check'2358 then Git will verify that all submodule commits that changed in the2359 revisions to be pushed are available on at least one remote of the2360 submodule. If any commits are missing, the push will be aborted and2361 exit with non-zero status. If the value is 'on-demand' then all2362 submodules that changed in the revisions to be pushed will be2363 pushed. If on-demand was not able to push all necessary revisions2364 it will also be aborted and exit with non-zero status. If the value2365 is 'no' then default behavior of ignoring submodules when pushing2366 is retained. You may override this configuration at time of push by2367 specifying '--recurse-submodules=check|on-demand|no'.23682369rebase.stat::2370 Whether to show a diffstat of what changed upstream since the last2371 rebase. False by default.23722373rebase.autoSquash::2374 If set to true enable `--autosquash` option by default.23752376rebase.autoStash::2377 When set to true, automatically create a temporary stash2378 before the operation begins, and apply it after the operation2379 ends. This means that you can run rebase on a dirty worktree.2380 However, use with care: the final stash application after a2381 successful rebase might result in non-trivial conflicts.2382 Defaults to false.23832384rebase.missingCommitsCheck::2385 If set to "warn", git rebase -i will print a warning if some2386 commits are removed (e.g. a line was deleted), however the2387 rebase will still proceed. If set to "error", it will print2388 the previous warning and stop the rebase, 'git rebase2389 --edit-todo' can then be used to correct the error. If set to2390 "ignore", no checking is done.2391 To drop a commit without warning or error, use the `drop`2392 command in the todo-list.2393 Defaults to "ignore".23942395rebase.instructionFormat2396 A format string, as specified in linkgit:git-log[1], to be used for2397 the instruction list during an interactive rebase. The format will automatically2398 have the long commit hash prepended to the format.23992400receive.advertiseAtomic::2401 By default, git-receive-pack will advertise the atomic push2402 capability to its clients. If you don't want to this capability2403 to be advertised, set this variable to false.24042405receive.autogc::2406 By default, git-receive-pack will run "git-gc --auto" after2407 receiving data from git-push and updating refs. You can stop2408 it by setting this variable to false.24092410receive.certNonceSeed::2411 By setting this variable to a string, `git receive-pack`2412 will accept a `git push --signed` and verifies it by using2413 a "nonce" protected by HMAC using this string as a secret2414 key.24152416receive.certNonceSlop::2417 When a `git push --signed` sent a push certificate with a2418 "nonce" that was issued by a receive-pack serving the same2419 repository within this many seconds, export the "nonce"2420 found in the certificate to `GIT_PUSH_CERT_NONCE` to the2421 hooks (instead of what the receive-pack asked the sending2422 side to include). This may allow writing checks in2423 `pre-receive` and `post-receive` a bit easier. Instead of2424 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable2425 that records by how many seconds the nonce is stale to2426 decide if they want to accept the certificate, they only2427 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.24282429receive.fsckObjects::2430 If it is set to true, git-receive-pack will check all received2431 objects. It will abort in the case of a malformed object or a2432 broken link. The result of an abort are only dangling objects.2433 Defaults to false. If not set, the value of `transfer.fsckObjects`2434 is used instead.24352436receive.fsck.<msg-id>::2437 When `receive.fsckObjects` is set to true, errors can be switched2438 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`2439 setting where the `<msg-id>` is the fsck message ID and the value2440 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes2441 the error/warning with the message ID, e.g. "missingEmail: invalid2442 author/committer line - missing email" means that setting2443 `receive.fsck.missingEmail = ignore` will hide that issue.2444+2445This feature is intended to support working with legacy repositories2446which would not pass pushing when `receive.fsckObjects = true`, allowing2447the host to accept repositories with certain known issues but still catch2448other issues.24492450receive.fsck.skipList::2451 The path to a sorted list of object names (i.e. one SHA-1 per2452 line) that are known to be broken in a non-fatal way and should2453 be ignored. This feature is useful when an established project2454 should be accepted despite early commits containing errors that2455 can be safely ignored such as invalid committer email addresses.2456 Note: corrupt objects cannot be skipped with this setting.24572458receive.unpackLimit::2459 If the number of objects received in a push is below this2460 limit then the objects will be unpacked into loose object2461 files. However if the number of received objects equals or2462 exceeds this limit then the received pack will be stored as2463 a pack, after adding any missing delta bases. Storing the2464 pack from a push can make the push operation complete faster,2465 especially on slow filesystems. If not set, the value of2466 `transfer.unpackLimit` is used instead.24672468receive.denyDeletes::2469 If set to true, git-receive-pack will deny a ref update that deletes2470 the ref. Use this to prevent such a ref deletion via a push.24712472receive.denyDeleteCurrent::2473 If set to true, git-receive-pack will deny a ref update that2474 deletes the currently checked out branch of a non-bare repository.24752476receive.denyCurrentBranch::2477 If set to true or "refuse", git-receive-pack will deny a ref update2478 to the currently checked out branch of a non-bare repository.2479 Such a push is potentially dangerous because it brings the HEAD2480 out of sync with the index and working tree. If set to "warn",2481 print a warning of such a push to stderr, but allow the push to2482 proceed. If set to false or "ignore", allow such pushes with no2483 message. Defaults to "refuse".2484+2485Another option is "updateInstead" which will update the working2486tree if pushing into the current branch. This option is2487intended for synchronizing working directories when one side is not easily2488accessible via interactive ssh (e.g. a live web site, hence the requirement2489that the working directory be clean). This mode also comes in handy when2490developing inside a VM to test and fix code on different Operating Systems.2491+2492By default, "updateInstead" will refuse the push if the working tree or2493the index have any difference from the HEAD, but the `push-to-checkout`2494hook can be used to customize this. See linkgit:githooks[5].24952496receive.denyNonFastForwards::2497 If set to true, git-receive-pack will deny a ref update which is2498 not a fast-forward. Use this to prevent such an update via a push,2499 even if that push is forced. This configuration variable is2500 set when initializing a shared repository.25012502receive.hideRefs::2503 This variable is the same as `transfer.hideRefs`, but applies2504 only to `receive-pack` (and so affects pushes, but not fetches).2505 An attempt to update or delete a hidden ref by `git push` is2506 rejected.25072508receive.updateServerInfo::2509 If set to true, git-receive-pack will run git-update-server-info2510 after receiving data from git-push and updating refs.25112512receive.shallowUpdate::2513 If set to true, .git/shallow can be updated when new refs2514 require new shallow roots. Otherwise those refs are rejected.25152516remote.pushDefault::2517 The remote to push to by default. Overrides2518 `branch.<name>.remote` for all branches, and is overridden by2519 `branch.<name>.pushRemote` for specific branches.25202521remote.<name>.url::2522 The URL of a remote repository. See linkgit:git-fetch[1] or2523 linkgit:git-push[1].25242525remote.<name>.pushurl::2526 The push URL of a remote repository. See linkgit:git-push[1].25272528remote.<name>.proxy::2529 For remotes that require curl (http, https and ftp), the URL to2530 the proxy to use for that remote. Set to the empty string to2531 disable proxying for that remote.25322533remote.<name>.proxyAuthMethod::2534 For remotes that require curl (http, https and ftp), the method to use for2535 authenticating against the proxy in use (probably set in2536 `remote.<name>.proxy`). See `http.proxyAuthMethod`.25372538remote.<name>.fetch::2539 The default set of "refspec" for linkgit:git-fetch[1]. See2540 linkgit:git-fetch[1].25412542remote.<name>.push::2543 The default set of "refspec" for linkgit:git-push[1]. See2544 linkgit:git-push[1].25452546remote.<name>.mirror::2547 If true, pushing to this remote will automatically behave2548 as if the `--mirror` option was given on the command line.25492550remote.<name>.skipDefaultUpdate::2551 If true, this remote will be skipped by default when updating2552 using linkgit:git-fetch[1] or the `update` subcommand of2553 linkgit:git-remote[1].25542555remote.<name>.skipFetchAll::2556 If true, this remote will be skipped by default when updating2557 using linkgit:git-fetch[1] or the `update` subcommand of2558 linkgit:git-remote[1].25592560remote.<name>.receivepack::2561 The default program to execute on the remote side when pushing. See2562 option --receive-pack of linkgit:git-push[1].25632564remote.<name>.uploadpack::2565 The default program to execute on the remote side when fetching. See2566 option --upload-pack of linkgit:git-fetch-pack[1].25672568remote.<name>.tagOpt::2569 Setting this value to --no-tags disables automatic tag following when2570 fetching from remote <name>. Setting it to --tags will fetch every2571 tag from remote <name>, even if they are not reachable from remote2572 branch heads. Passing these flags directly to linkgit:git-fetch[1] can2573 override this setting. See options --tags and --no-tags of2574 linkgit:git-fetch[1].25752576remote.<name>.vcs::2577 Setting this to a value <vcs> will cause Git to interact with2578 the remote with the git-remote-<vcs> helper.25792580remote.<name>.prune::2581 When set to true, fetching from this remote by default will also2582 remove any remote-tracking references that no longer exist on the2583 remote (as if the `--prune` option was given on the command line).2584 Overrides `fetch.prune` settings, if any.25852586remotes.<group>::2587 The list of remotes which are fetched by "git remote update2588 <group>". See linkgit:git-remote[1].25892590repack.useDeltaBaseOffset::2591 By default, linkgit:git-repack[1] creates packs that use2592 delta-base offset. If you need to share your repository with2593 Git older than version 1.4.4, either directly or via a dumb2594 protocol such as http, then you need to set this option to2595 "false" and repack. Access from old Git versions over the2596 native protocol are unaffected by this option.25972598repack.packKeptObjects::2599 If set to true, makes `git repack` act as if2600 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for2601 details. Defaults to `false` normally, but `true` if a bitmap2602 index is being written (either via `--write-bitmap-index` or2603 `repack.writeBitmaps`).26042605repack.writeBitmaps::2606 When true, git will write a bitmap index when packing all2607 objects to disk (e.g., when `git repack -a` is run). This2608 index can speed up the "counting objects" phase of subsequent2609 packs created for clones and fetches, at the cost of some disk2610 space and extra time spent on the initial repack. This has2611 no effect if multiple packfiles are created.2612 Defaults to false.26132614rerere.autoUpdate::2615 When set to true, `git-rerere` updates the index with the2616 resulting contents after it cleanly resolves conflicts using2617 previously recorded resolution. Defaults to false.26182619rerere.enabled::2620 Activate recording of resolved conflicts, so that identical2621 conflict hunks can be resolved automatically, should they be2622 encountered again. By default, linkgit:git-rerere[1] is2623 enabled if there is an `rr-cache` directory under the2624 `$GIT_DIR`, e.g. if "rerere" was previously used in the2625 repository.26262627sendemail.identity::2628 A configuration identity. When given, causes values in the2629 'sendemail.<identity>' subsection to take precedence over2630 values in the 'sendemail' section. The default identity is2631 the value of `sendemail.identity`.26322633sendemail.smtpEncryption::2634 See linkgit:git-send-email[1] for description. Note that this2635 setting is not subject to the 'identity' mechanism.26362637sendemail.smtpssl (deprecated)::2638 Deprecated alias for 'sendemail.smtpEncryption = ssl'.26392640sendemail.smtpsslcertpath::2641 Path to ca-certificates (either a directory or a single file).2642 Set it to an empty string to disable certificate verification.26432644sendemail.<identity>.*::2645 Identity-specific versions of the 'sendemail.*' parameters2646 found below, taking precedence over those when the this2647 identity is selected, through command-line or2648 `sendemail.identity`.26492650sendemail.aliasesFile::2651sendemail.aliasFileType::2652sendemail.annotate::2653sendemail.bcc::2654sendemail.cc::2655sendemail.ccCmd::2656sendemail.chainReplyTo::2657sendemail.confirm::2658sendemail.envelopeSender::2659sendemail.from::2660sendemail.multiEdit::2661sendemail.signedoffbycc::2662sendemail.smtpPass::2663sendemail.suppresscc::2664sendemail.suppressFrom::2665sendemail.to::2666sendemail.smtpDomain::2667sendemail.smtpServer::2668sendemail.smtpServerPort::2669sendemail.smtpServerOption::2670sendemail.smtpUser::2671sendemail.thread::2672sendemail.transferEncoding::2673sendemail.validate::2674sendemail.xmailer::2675 See linkgit:git-send-email[1] for description.26762677sendemail.signedoffcc (deprecated)::2678 Deprecated alias for `sendemail.signedoffbycc`.26792680showbranch.default::2681 The default set of branches for linkgit:git-show-branch[1].2682 See linkgit:git-show-branch[1].26832684status.relativePaths::2685 By default, linkgit:git-status[1] shows paths relative to the2686 current directory. Setting this variable to `false` shows paths2687 relative to the repository root (this was the default for Git2688 prior to v1.5.4).26892690status.short::2691 Set to true to enable --short by default in linkgit:git-status[1].2692 The option --no-short takes precedence over this variable.26932694status.branch::2695 Set to true to enable --branch by default in linkgit:git-status[1].2696 The option --no-branch takes precedence over this variable.26972698status.displayCommentPrefix::2699 If set to true, linkgit:git-status[1] will insert a comment2700 prefix before each output line (starting with2701 `core.commentChar`, i.e. `#` by default). This was the2702 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.2703 Defaults to false.27042705status.showUntrackedFiles::2706 By default, linkgit:git-status[1] and linkgit:git-commit[1] show2707 files which are not currently tracked by Git. Directories which2708 contain only untracked files, are shown with the directory name2709 only. Showing untracked files means that Git needs to lstat() all2710 the files in the whole repository, which might be slow on some2711 systems. So, this variable controls how the commands displays2712 the untracked files. Possible values are:2713+2714--2715* `no` - Show no untracked files.2716* `normal` - Show untracked files and directories.2717* `all` - Show also individual files in untracked directories.2718--2719+2720If this variable is not specified, it defaults to 'normal'.2721This variable can be overridden with the -u|--untracked-files option2722of linkgit:git-status[1] and linkgit:git-commit[1].27232724status.submoduleSummary::2725 Defaults to false.2726 If this is set to a non zero number or true (identical to -1 or an2727 unlimited number), the submodule summary will be enabled and a2728 summary of commits for modified submodules will be shown (see2729 --summary-limit option of linkgit:git-submodule[1]). Please note2730 that the summary output command will be suppressed for all2731 submodules when `diff.ignoreSubmodules` is set to 'all' or only2732 for those submodules where `submodule.<name>.ignore=all`. The only2733 exception to that rule is that status and commit will show staged2734 submodule changes. To2735 also view the summary for ignored submodules you can either use2736 the --ignore-submodules=dirty command-line option or the 'git2737 submodule summary' command, which shows a similar output but does2738 not honor these settings.27392740stash.showPatch::2741 If this is set to true, the `git stash show` command without an2742 option will show the stash in patch form. Defaults to false.2743 See description of 'show' command in linkgit:git-stash[1].27442745stash.showStat::2746 If this is set to true, the `git stash show` command without an2747 option will show diffstat of the stash. Defaults to true.2748 See description of 'show' command in linkgit:git-stash[1].27492750submodule.<name>.path::2751submodule.<name>.url::2752 The path within this project and URL for a submodule. These2753 variables are initially populated by 'git submodule init'. See2754 linkgit:git-submodule[1] and linkgit:gitmodules[5] for2755 details.27562757submodule.<name>.update::2758 The default update procedure for a submodule. This variable2759 is populated by `git submodule init` from the2760 linkgit:gitmodules[5] file. See description of 'update'2761 command in linkgit:git-submodule[1].27622763submodule.<name>.branch::2764 The remote branch name for a submodule, used by `git submodule2765 update --remote`. Set this option to override the value found in2766 the `.gitmodules` file. See linkgit:git-submodule[1] and2767 linkgit:gitmodules[5] for details.27682769submodule.<name>.fetchRecurseSubmodules::2770 This option can be used to control recursive fetching of this2771 submodule. It can be overridden by using the --[no-]recurse-submodules2772 command-line option to "git fetch" and "git pull".2773 This setting will override that from in the linkgit:gitmodules[5]2774 file.27752776submodule.<name>.ignore::2777 Defines under what circumstances "git status" and the diff family show2778 a submodule as modified. When set to "all", it will never be considered2779 modified (but it will nonetheless show up in the output of status and2780 commit when it has been staged), "dirty" will ignore all changes2781 to the submodules work tree and2782 takes only differences between the HEAD of the submodule and the commit2783 recorded in the superproject into account. "untracked" will additionally2784 let submodules with modified tracked files in their work tree show up.2785 Using "none" (the default when this option is not set) also shows2786 submodules that have untracked files in their work tree as changed.2787 This setting overrides any setting made in .gitmodules for this submodule,2788 both settings can be overridden on the command line by using the2789 "--ignore-submodules" option. The 'git submodule' commands are not2790 affected by this setting.27912792submodule.fetchJobs::2793 Specifies how many submodules are fetched/cloned at the same time.2794 A positive integer allows up to that number of submodules fetched2795 in parallel. A value of 0 will give some reasonable default.2796 If unset, it defaults to 1.27972798tag.forceSignAnnotated::2799 A boolean to specify whether annotated tags created should be GPG signed.2800 If `--annotate` is specified on the command line, it takes2801 precedence over this option.28022803tag.sort::2804 This variable controls the sort ordering of tags when displayed by2805 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the2806 value of this variable will be used as the default.28072808tar.umask::2809 This variable can be used to restrict the permission bits of2810 tar archive entries. The default is 0002, which turns off the2811 world write bit. The special value "user" indicates that the2812 archiving user's umask will be used instead. See umask(2) and2813 linkgit:git-archive[1].28142815transfer.fsckObjects::2816 When `fetch.fsckObjects` or `receive.fsckObjects` are2817 not set, the value of this variable is used instead.2818 Defaults to false.28192820transfer.hideRefs::2821 String(s) `receive-pack` and `upload-pack` use to decide which2822 refs to omit from their initial advertisements. Use more than2823 one definition to specify multiple prefix strings. A ref that is2824 under the hierarchies listed in the value of this variable is2825 excluded, and is hidden when responding to `git push` or `git2826 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for2827 program-specific versions of this config.2828+2829You may also include a `!` in front of the ref name to negate the entry,2830explicitly exposing it, even if an earlier entry marked it as hidden.2831If you have multiple hideRefs values, later entries override earlier ones2832(and entries in more-specific config files override less-specific ones).2833+2834If a namespace is in use, the namespace prefix is stripped from each2835reference before it is matched against `transfer.hiderefs` patterns.2836For example, if `refs/heads/master` is specified in `transfer.hideRefs` and2837the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`2838is omitted from the advertisements but `refs/heads/master` and2839`refs/namespaces/bar/refs/heads/master` are still advertised as so-called2840"have" lines. In order to match refs before stripping, add a `^` in front of2841the ref name. If you combine `!` and `^`, `!` must be specified first.28422843transfer.unpackLimit::2844 When `fetch.unpackLimit` or `receive.unpackLimit` are2845 not set, the value of this variable is used instead.2846 The default value is 100.28472848uploadarchive.allowUnreachable::2849 If true, allow clients to use `git archive --remote` to request2850 any tree, whether reachable from the ref tips or not. See the2851 discussion in the `SECURITY` section of2852 linkgit:git-upload-archive[1] for more details. Defaults to2853 `false`.28542855uploadpack.hideRefs::2856 This variable is the same as `transfer.hideRefs`, but applies2857 only to `upload-pack` (and so affects only fetches, not pushes).2858 An attempt to fetch a hidden ref by `git fetch` will fail. See2859 also `uploadpack.allowTipSHA1InWant`.28602861uploadpack.allowTipSHA1InWant::2862 When `uploadpack.hideRefs` is in effect, allow `upload-pack`2863 to accept a fetch request that asks for an object at the tip2864 of a hidden ref (by default, such a request is rejected).2865 see also `uploadpack.hideRefs`.28662867uploadpack.allowReachableSHA1InWant::2868 Allow `upload-pack` to accept a fetch request that asks for an2869 object that is reachable from any ref tip. However, note that2870 calculating object reachability is computationally expensive.2871 Defaults to `false`.28722873uploadpack.keepAlive::2874 When `upload-pack` has started `pack-objects`, there may be a2875 quiet period while `pack-objects` prepares the pack. Normally2876 it would output progress information, but if `--quiet` was used2877 for the fetch, `pack-objects` will output nothing at all until2878 the pack data begins. Some clients and networks may consider2879 the server to be hung and give up. Setting this option instructs2880 `upload-pack` to send an empty keepalive packet every2881 `uploadpack.keepAlive` seconds. Setting this option to 02882 disables keepalive packets entirely. The default is 5 seconds.28832884url.<base>.insteadOf::2885 Any URL that starts with this value will be rewritten to2886 start, instead, with <base>. In cases where some site serves a2887 large number of repositories, and serves them with multiple2888 access methods, and some users need to use different access2889 methods, this feature allows people to specify any of the2890 equivalent URLs and have Git automatically rewrite the URL to2891 the best alternative for the particular user, even for a2892 never-before-seen repository on the site. When more than one2893 insteadOf strings match a given URL, the longest match is used.28942895url.<base>.pushInsteadOf::2896 Any URL that starts with this value will not be pushed to;2897 instead, it will be rewritten to start with <base>, and the2898 resulting URL will be pushed to. In cases where some site serves2899 a large number of repositories, and serves them with multiple2900 access methods, some of which do not allow push, this feature2901 allows people to specify a pull-only URL and have Git2902 automatically use an appropriate URL to push, even for a2903 never-before-seen repository on the site. When more than one2904 pushInsteadOf strings match a given URL, the longest match is2905 used. If a remote has an explicit pushurl, Git will ignore this2906 setting for that remote.29072908user.email::2909 Your email address to be recorded in any newly created commits.2910 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and2911 `EMAIL` environment variables. See linkgit:git-commit-tree[1].29122913user.name::2914 Your full name to be recorded in any newly created commits.2915 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`2916 environment variables. See linkgit:git-commit-tree[1].29172918user.useConfigOnly::2919 Instruct Git to avoid trying to guess defaults for `user.email`2920 and `user.name`, and instead retrieve the values only from the2921 configuration. For example, if you have multiple email addresses2922 and would like to use a different one for each repository, then2923 with this configuration option set to `true` in the global config2924 along with a name, Git will prompt you to set up an email before2925 making new commits in a newly cloned repository.2926 Defaults to `false`.29272928user.signingKey::2929 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the2930 key you want it to automatically when creating a signed tag or2931 commit, you can override the default selection with this variable.2932 This option is passed unchanged to gpg's --local-user parameter,2933 so you may specify a key using any method that gpg supports.29342935versionsort.prereleaseSuffix::2936 When version sort is used in linkgit:git-tag[1], prerelease2937 tags (e.g. "1.0-rc1") may appear after the main release2938 "1.0". By specifying the suffix "-rc" in this variable,2939 "1.0-rc1" will appear before "1.0".2940+2941This variable can be specified multiple times, once per suffix. The2942order of suffixes in the config file determines the sorting order2943(e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX2944is sorted before 1.0-rcXX). The sorting order between different2945suffixes is undefined if they are in multiple config files.29462947web.browser::2948 Specify a web browser that may be used by some commands.2949 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]2950 may use it.