Merge branch 'cb/byte-order'
[git/git.git] / Documentation / config.txt
1 CONFIGURATION FILE
2 ------------------
3
4 The Git configuration file contains a number of variables that affect
5 the Git commands' behavior. The `.git/config` file in each repository
6 is used to store the configuration for that repository, and
7 `$HOME/.gitconfig` is used to store a per-user configuration as
8 fallback values for the `.git/config` file. The file `/etc/gitconfig`
9 can be used to store a system-wide default configuration.
10
11 The configuration variables are used by both the Git plumbing
12 and the porcelains. The variables are divided into sections, wherein
13 the fully qualified variable name of the variable itself is the last
14 dot-separated segment and the section name is everything before the last
15 dot. The variable names are case-insensitive, allow only alphanumeric
16 characters and `-`, and must start with an alphabetic character. Some
17 variables may appear multiple times.
18
19 Syntax
20 ~~~~~~
21
22 The syntax is fairly flexible and permissive; whitespaces are mostly
23 ignored. The '#' and ';' characters begin comments to the end of line,
24 blank lines are ignored.
25
26 The file consists of sections and variables. A section begins with
27 the name of the section in square brackets and continues until the next
28 section begins. Section names are not case sensitive. Only alphanumeric
29 characters, `-` and `.` are allowed in section names. Each variable
30 must belong to some section, which means that there must be a section
31 header before the first setting of a variable.
32
33 Sections can be further divided into subsections. To begin a subsection
34 put its name in double quotes, separated by space from the section name,
35 in the section header, like in the example below:
36
37 --------
38 [section "subsection"]
39
40 --------
41
42 Subsection names are case sensitive and can contain any characters except
43 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
44 respectively). Section headers cannot span multiple
45 lines. Variables may belong directly to a section or to a given subsection.
46 You can have `[section]` if you have `[section "subsection"]`, but you
47 don't need to.
48
49 There is also a deprecated `[section.subsection]` syntax. With this
50 syntax, the subsection name is converted to lower-case and is also
51 compared case sensitively. These subsection names follow the same
52 restrictions as section names.
53
54 All the other lines (and the remainder of the line after the section
55 header) are recognized as setting variables, in the form
56 'name = value'. If there is no equal sign on the line, the entire line
57 is taken as 'name' and the variable is recognized as boolean "true".
58 The variable names are case-insensitive, allow only alphanumeric characters
59 and `-`, and must start with an alphabetic character. There can be more
60 than one value for a given variable; we say then that the variable is
61 multivalued.
62
63 Leading and trailing whitespace in a variable value is discarded.
64 Internal whitespace within a variable value is retained verbatim.
65
66 The values following the equals sign in variable assign are all either
67 a string, an integer, or a boolean. Boolean values may be given as yes/no,
68 1/0, true/false or on/off. Case is not significant in boolean values, when
69 converting value to the canonical form using '--bool' type specifier;
70 'git config' will ensure that the output is "true" or "false".
71
72 String values may be entirely or partially enclosed in double quotes.
73 You need to enclose variable values in double quotes if you want to
74 preserve leading or trailing whitespace, or if the variable value contains
75 comment characters (i.e. it contains '#' or ';').
76 Double quote `"` and backslash `\` characters in variable values must
77 be escaped: use `\"` for `"` and `\\` for `\`.
78
79 The following escape sequences (beside `\"` and `\\`) are recognized:
80 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
81 and `\b` for backspace (BS). Other char escape sequences (including octal
82 escape sequences) are invalid.
83
84 Variable values ending in a `\` are continued on the next line in the
85 customary UNIX fashion.
86
87 Some variables may require a special value format.
88
89 Includes
90 ~~~~~~~~
91
92 You can include one config file from another by setting the special
93 `include.path` variable to the name of the file to be included. The
94 included file is expanded immediately, as if its contents had been
95 found at the location of the include directive. If the value of the
96 `include.path` variable is a relative path, the path is considered to be
97 relative to the configuration file in which the include directive was
98 found. The value of `include.path` is subject to tilde expansion: `~/`
99 is expanded to the value of `$HOME`, and `~user/` to the specified
100 user's home directory. See below for examples.
101
102 Example
103 ~~~~~~~
104
105 # Core variables
106 [core]
107 ; Don't trust file modes
108 filemode = false
109
110 # Our diff algorithm
111 [diff]
112 external = /usr/local/bin/diff-wrapper
113 renames = true
114
115 [branch "devel"]
116 remote = origin
117 merge = refs/heads/devel
118
119 # Proxy settings
120 [core]
121 gitProxy="ssh" for "kernel.org"
122 gitProxy=default-proxy ; for the rest
123
124 [include]
125 path = /path/to/foo.inc ; include by absolute path
126 path = foo ; expand "foo" relative to the current file
127 path = ~/foo ; expand "foo" in your $HOME directory
128
129 Variables
130 ~~~~~~~~~
131
132 Note that this list is non-comprehensive and not necessarily complete.
133 For command-specific variables, you will find a more detailed description
134 in the appropriate manual page.
135
136 Other git-related tools may and do use their own variables. When
137 inventing new variables for use in your own tool, make sure their
138 names do not conflict with those that are used by Git itself and
139 other popular tools, and describe them in your documentation.
140
141
142 advice.*::
143 These variables control various optional help messages designed to
144 aid new users. All 'advice.*' variables default to 'true', and you
145 can tell Git that you do not need help by setting these to 'false':
146 +
147 --
148 pushUpdateRejected::
149 Set this variable to 'false' if you want to disable
150 'pushNonFFCurrent',
151 'pushNonFFMatching', 'pushAlreadyExists',
152 'pushFetchFirst', and 'pushNeedsForce'
153 simultaneously.
154 pushNonFFCurrent::
155 Advice shown when linkgit:git-push[1] fails due to a
156 non-fast-forward update to the current branch.
157 pushNonFFMatching::
158 Advice shown when you ran linkgit:git-push[1] and pushed
159 'matching refs' explicitly (i.e. you used ':', or
160 specified a refspec that isn't your current branch) and
161 it resulted in a non-fast-forward error.
162 pushAlreadyExists::
163 Shown when linkgit:git-push[1] rejects an update that
164 does not qualify for fast-forwarding (e.g., a tag.)
165 pushFetchFirst::
166 Shown when linkgit:git-push[1] rejects an update that
167 tries to overwrite a remote ref that points at an
168 object we do not have.
169 pushNeedsForce::
170 Shown when linkgit:git-push[1] rejects an update that
171 tries to overwrite a remote ref that points at an
172 object that is not a commit-ish, or make the remote
173 ref point at an object that is not a commit-ish.
174 statusHints::
175 Show directions on how to proceed from the current
176 state in the output of linkgit:git-status[1], in
177 the template shown when writing commit messages in
178 linkgit:git-commit[1], and in the help message shown
179 by linkgit:git-checkout[1] when switching branch.
180 statusUoption::
181 Advise to consider using the `-u` option to linkgit:git-status[1]
182 when the command takes more than 2 seconds to enumerate untracked
183 files.
184 commitBeforeMerge::
185 Advice shown when linkgit:git-merge[1] refuses to
186 merge to avoid overwriting local changes.
187 resolveConflict::
188 Advice shown by various commands when conflicts
189 prevent the operation from being performed.
190 implicitIdentity::
191 Advice on how to set your identity configuration when
192 your information is guessed from the system username and
193 domain name.
194 detachedHead::
195 Advice shown when you used linkgit:git-checkout[1] to
196 move to the detach HEAD state, to instruct how to create
197 a local branch after the fact.
198 amWorkDir::
199 Advice that shows the location of the patch file when
200 linkgit:git-am[1] fails to apply it.
201 rmHints::
202 In case of failure in the output of linkgit:git-rm[1],
203 show directions on how to proceed from the current state.
204 --
205
206 core.fileMode::
207 If false, the executable bit differences between the index and
208 the working tree are ignored; useful on broken filesystems like FAT.
209 See linkgit:git-update-index[1].
210 +
211 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
212 will probe and set core.fileMode false if appropriate when the
213 repository is created.
214
215 core.ignorecase::
216 If true, this option enables various workarounds to enable
217 Git to work better on filesystems that are not case sensitive,
218 like FAT. For example, if a directory listing finds
219 "makefile" when Git expects "Makefile", Git will assume
220 it is really the same file, and continue to remember it as
221 "Makefile".
222 +
223 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
224 will probe and set core.ignorecase true if appropriate when the repository
225 is created.
226
227 core.precomposeunicode::
228 This option is only used by Mac OS implementation of Git.
229 When core.precomposeunicode=true, Git reverts the unicode decomposition
230 of filenames done by Mac OS. This is useful when sharing a repository
231 between Mac OS and Linux or Windows.
232 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
233 When false, file names are handled fully transparent by Git,
234 which is backward compatible with older versions of Git.
235
236 core.trustctime::
237 If false, the ctime differences between the index and the
238 working tree are ignored; useful when the inode change time
239 is regularly modified by something outside Git (file system
240 crawlers and some backup systems).
241 See linkgit:git-update-index[1]. True by default.
242
243 core.checkstat::
244 Determines which stat fields to match between the index
245 and work tree. The user can set this to 'default' or
246 'minimal'. Default (or explicitly 'default'), is to check
247 all fields, including the sub-second part of mtime and ctime.
248
249 core.quotepath::
250 The commands that output paths (e.g. 'ls-files',
251 'diff'), when not given the `-z` option, will quote
252 "unusual" characters in the pathname by enclosing the
253 pathname in a double-quote pair and with backslashes the
254 same way strings in C source code are quoted. If this
255 variable is set to false, the bytes higher than 0x80 are
256 not quoted but output as verbatim. Note that double
257 quote, backslash and control characters are always
258 quoted without `-z` regardless of the setting of this
259 variable.
260
261 core.eol::
262 Sets the line ending type to use in the working directory for
263 files that have the `text` property set. Alternatives are
264 'lf', 'crlf' and 'native', which uses the platform's native
265 line ending. The default value is `native`. See
266 linkgit:gitattributes[5] for more information on end-of-line
267 conversion.
268
269 core.safecrlf::
270 If true, makes Git check if converting `CRLF` is reversible when
271 end-of-line conversion is active. Git will verify if a command
272 modifies a file in the work tree either directly or indirectly.
273 For example, committing a file followed by checking out the
274 same file should yield the original file in the work tree. If
275 this is not the case for the current setting of
276 `core.autocrlf`, Git will reject the file. The variable can
277 be set to "warn", in which case Git will only warn about an
278 irreversible conversion but continue the operation.
279 +
280 CRLF conversion bears a slight chance of corrupting data.
281 When it is enabled, Git will convert CRLF to LF during commit and LF to
282 CRLF during checkout. A file that contains a mixture of LF and
283 CRLF before the commit cannot be recreated by Git. For text
284 files this is the right thing to do: it corrects line endings
285 such that we have only LF line endings in the repository.
286 But for binary files that are accidentally classified as text the
287 conversion can corrupt data.
288 +
289 If you recognize such corruption early you can easily fix it by
290 setting the conversion type explicitly in .gitattributes. Right
291 after committing you still have the original file in your work
292 tree and this file is not yet corrupted. You can explicitly tell
293 Git that this file is binary and Git will handle the file
294 appropriately.
295 +
296 Unfortunately, the desired effect of cleaning up text files with
297 mixed line endings and the undesired effect of corrupting binary
298 files cannot be distinguished. In both cases CRLFs are removed
299 in an irreversible way. For text files this is the right thing
300 to do because CRLFs are line endings, while for binary files
301 converting CRLFs corrupts data.
302 +
303 Note, this safety check does not mean that a checkout will generate a
304 file identical to the original file for a different setting of
305 `core.eol` and `core.autocrlf`, but only for the current one. For
306 example, a text file with `LF` would be accepted with `core.eol=lf`
307 and could later be checked out with `core.eol=crlf`, in which case the
308 resulting file would contain `CRLF`, although the original file
309 contained `LF`. However, in both work trees the line endings would be
310 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
311 file with mixed line endings would be reported by the `core.safecrlf`
312 mechanism.
313
314 core.autocrlf::
315 Setting this variable to "true" is almost the same as setting
316 the `text` attribute to "auto" on all files except that text
317 files are not guaranteed to be normalized: files that contain
318 `CRLF` in the repository will not be touched. Use this
319 setting if you want to have `CRLF` line endings in your
320 working directory even though the repository does not have
321 normalized line endings. This variable can be set to 'input',
322 in which case no output conversion is performed.
323
324 core.symlinks::
325 If false, symbolic links are checked out as small plain files that
326 contain the link text. linkgit:git-update-index[1] and
327 linkgit:git-add[1] will not change the recorded type to regular
328 file. Useful on filesystems like FAT that do not support
329 symbolic links.
330 +
331 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
332 will probe and set core.symlinks false if appropriate when the repository
333 is created.
334
335 core.gitProxy::
336 A "proxy command" to execute (as 'command host port') instead
337 of establishing direct connection to the remote server when
338 using the Git protocol for fetching. If the variable value is
339 in the "COMMAND for DOMAIN" format, the command is applied only
340 on hostnames ending with the specified domain string. This variable
341 may be set multiple times and is matched in the given order;
342 the first match wins.
343 +
344 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
345 (which always applies universally, without the special "for"
346 handling).
347 +
348 The special string `none` can be used as the proxy command to
349 specify that no proxy be used for a given domain pattern.
350 This is useful for excluding servers inside a firewall from
351 proxy use, while defaulting to a common proxy for external domains.
352
353 core.ignoreStat::
354 If true, commands which modify both the working tree and the index
355 will mark the updated paths with the "assume unchanged" bit in the
356 index. These marked files are then assumed to stay unchanged in the
357 working tree, until you mark them otherwise manually - Git will not
358 detect the file changes by lstat() calls. This is useful on systems
359 where those are very slow, such as Microsoft Windows.
360 See linkgit:git-update-index[1].
361 False by default.
362
363 core.preferSymlinkRefs::
364 Instead of the default "symref" format for HEAD
365 and other symbolic reference files, use symbolic links.
366 This is sometimes needed to work with old scripts that
367 expect HEAD to be a symbolic link.
368
369 core.bare::
370 If true this repository is assumed to be 'bare' and has no
371 working directory associated with it. If this is the case a
372 number of commands that require a working directory will be
373 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
374 +
375 This setting is automatically guessed by linkgit:git-clone[1] or
376 linkgit:git-init[1] when the repository was created. By default a
377 repository that ends in "/.git" is assumed to be not bare (bare =
378 false), while all other repositories are assumed to be bare (bare
379 = true).
380
381 core.worktree::
382 Set the path to the root of the working tree.
383 This can be overridden by the GIT_WORK_TREE environment
384 variable and the '--work-tree' command-line option.
385 The value can be an absolute path or relative to the path to
386 the .git directory, which is either specified by --git-dir
387 or GIT_DIR, or automatically discovered.
388 If --git-dir or GIT_DIR is specified but none of
389 --work-tree, GIT_WORK_TREE and core.worktree is specified,
390 the current working directory is regarded as the top level
391 of your working tree.
392 +
393 Note that this variable is honored even when set in a configuration
394 file in a ".git" subdirectory of a directory and its value differs
395 from the latter directory (e.g. "/path/to/.git/config" has
396 core.worktree set to "/different/path"), which is most likely a
397 misconfiguration. Running Git commands in the "/path/to" directory will
398 still use "/different/path" as the root of the work tree and can cause
399 confusion unless you know what you are doing (e.g. you are creating a
400 read-only snapshot of the same index to a location different from the
401 repository's usual working tree).
402
403 core.logAllRefUpdates::
404 Enable the reflog. Updates to a ref <ref> is logged to the file
405 "$GIT_DIR/logs/<ref>", by appending the new and old
406 SHA-1, the date/time and the reason of the update, but
407 only when the file exists. If this configuration
408 variable is set to true, missing "$GIT_DIR/logs/<ref>"
409 file is automatically created for branch heads (i.e. under
410 refs/heads/), remote refs (i.e. under refs/remotes/),
411 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
412 +
413 This information can be used to determine what commit
414 was the tip of a branch "2 days ago".
415 +
416 This value is true by default in a repository that has
417 a working directory associated with it, and false by
418 default in a bare repository.
419
420 core.repositoryFormatVersion::
421 Internal variable identifying the repository format and layout
422 version.
423
424 core.sharedRepository::
425 When 'group' (or 'true'), the repository is made shareable between
426 several users in a group (making sure all the files and objects are
427 group-writable). When 'all' (or 'world' or 'everybody'), the
428 repository will be readable by all users, additionally to being
429 group-shareable. When 'umask' (or 'false'), Git will use permissions
430 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
431 files in the repository will have this mode value. '0xxx' will override
432 user's umask value (whereas the other options will only override
433 requested parts of the user's umask value). Examples: '0660' will make
434 the repo read/write-able for the owner and group, but inaccessible to
435 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
436 repository that is group-readable but not group-writable.
437 See linkgit:git-init[1]. False by default.
438
439 core.warnAmbiguousRefs::
440 If true, Git will warn you if the ref name you passed it is ambiguous
441 and might match multiple refs in the repository. True by default.
442
443 core.compression::
444 An integer -1..9, indicating a default compression level.
445 -1 is the zlib default. 0 means no compression,
446 and 1..9 are various speed/size tradeoffs, 9 being slowest.
447 If set, this provides a default to other compression variables,
448 such as 'core.loosecompression' and 'pack.compression'.
449
450 core.loosecompression::
451 An integer -1..9, indicating the compression level for objects that
452 are not in a pack file. -1 is the zlib default. 0 means no
453 compression, and 1..9 are various speed/size tradeoffs, 9 being
454 slowest. If not set, defaults to core.compression. If that is
455 not set, defaults to 1 (best speed).
456
457 core.packedGitWindowSize::
458 Number of bytes of a pack file to map into memory in a
459 single mapping operation. Larger window sizes may allow
460 your system to process a smaller number of large pack files
461 more quickly. Smaller window sizes will negatively affect
462 performance due to increased calls to the operating system's
463 memory manager, but may improve performance when accessing
464 a large number of large pack files.
465 +
466 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
467 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
468 be reasonable for all users/operating systems. You probably do
469 not need to adjust this value.
470 +
471 Common unit suffixes of 'k', 'm', or 'g' are supported.
472
473 core.packedGitLimit::
474 Maximum number of bytes to map simultaneously into memory
475 from pack files. If Git needs to access more than this many
476 bytes at once to complete an operation it will unmap existing
477 regions to reclaim virtual address space within the process.
478 +
479 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
480 This should be reasonable for all users/operating systems, except on
481 the largest projects. You probably do not need to adjust this value.
482 +
483 Common unit suffixes of 'k', 'm', or 'g' are supported.
484
485 core.deltaBaseCacheLimit::
486 Maximum number of bytes to reserve for caching base objects
487 that may be referenced by multiple deltified objects. By storing the
488 entire decompressed base objects in a cache Git is able
489 to avoid unpacking and decompressing frequently used base
490 objects multiple times.
491 +
492 Default is 96 MiB on all platforms. This should be reasonable
493 for all users/operating systems, except on the largest projects.
494 You probably do not need to adjust this value.
495 +
496 Common unit suffixes of 'k', 'm', or 'g' are supported.
497
498 core.bigFileThreshold::
499 Files larger than this size are stored deflated, without
500 attempting delta compression. Storing large files without
501 delta compression avoids excessive memory usage, at the
502 slight expense of increased disk usage.
503 +
504 Default is 512 MiB on all platforms. This should be reasonable
505 for most projects as source code and other text files can still
506 be delta compressed, but larger binary media files won't be.
507 +
508 Common unit suffixes of 'k', 'm', or 'g' are supported.
509
510 core.excludesfile::
511 In addition to '.gitignore' (per-directory) and
512 '.git/info/exclude', Git looks into this file for patterns
513 of files which are not meant to be tracked. "`~/`" is expanded
514 to the value of `$HOME` and "`~user/`" to the specified user's
515 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
516 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
517 is used instead. See linkgit:gitignore[5].
518
519 core.askpass::
520 Some commands (e.g. svn and http interfaces) that interactively
521 ask for a password can be told to use an external program given
522 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
523 environment variable. If not set, fall back to the value of the
524 'SSH_ASKPASS' environment variable or, failing that, a simple password
525 prompt. The external program shall be given a suitable prompt as
526 command-line argument and write the password on its STDOUT.
527
528 core.attributesfile::
529 In addition to '.gitattributes' (per-directory) and
530 '.git/info/attributes', Git looks into this file for attributes
531 (see linkgit:gitattributes[5]). Path expansions are made the same
532 way as for `core.excludesfile`. Its default value is
533 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
534 set or empty, $HOME/.config/git/attributes is used instead.
535
536 core.editor::
537 Commands such as `commit` and `tag` that lets you edit
538 messages by launching an editor uses the value of this
539 variable when it is set, and the environment variable
540 `GIT_EDITOR` is not set. See linkgit:git-var[1].
541
542 core.commentchar::
543 Commands such as `commit` and `tag` that lets you edit
544 messages consider a line that begins with this character
545 commented, and removes them after the editor returns
546 (default '#').
547 +
548 If set to "auto", `git-commit` would select a character that is not
549 the beginning character of any line in existing commit messages.
550
551 sequence.editor::
552 Text editor used by `git rebase -i` for editing the rebase instruction file.
553 The value is meant to be interpreted by the shell when it is used.
554 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
555 When not configured the default commit message editor is used instead.
556
557 core.pager::
558 Text viewer for use by Git commands (e.g., 'less'). The value
559 is meant to be interpreted by the shell. The order of preference
560 is the `$GIT_PAGER` environment variable, then `core.pager`
561 configuration, then `$PAGER`, and then the default chosen at
562 compile time (usually 'less').
563 +
564 When the `LESS` environment variable is unset, Git sets it to `FRX`
565 (if `LESS` environment variable is set, Git does not change it at
566 all). If you want to selectively override Git's default setting
567 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
568 be passed to the shell by Git, which will translate the final
569 command to `LESS=FRX less -S`. The environment does not set the
570 `S` option but the command line does, instructing less to truncate
571 long lines. Similarly, setting `core.pager` to `less -+F` will
572 deactivate the `F` option specified by the environment from the
573 command-line, deactivating the "quit if one screen" behavior of
574 `less`. One can specifically activate some flags for particular
575 commands: for example, setting `pager.blame` to `less -S` enables
576 line truncation only for `git blame`.
577 +
578 Likewise, when the `LV` environment variable is unset, Git sets it
579 to `-c`. You can override this setting by exporting `LV` with
580 another value or setting `core.pager` to `lv +c`.
581
582 core.whitespace::
583 A comma separated list of common whitespace problems to
584 notice. 'git diff' will use `color.diff.whitespace` to
585 highlight them, and 'git apply --whitespace=error' will
586 consider them as errors. You can prefix `-` to disable
587 any of them (e.g. `-trailing-space`):
588 +
589 * `blank-at-eol` treats trailing whitespaces at the end of the line
590 as an error (enabled by default).
591 * `space-before-tab` treats a space character that appears immediately
592 before a tab character in the initial indent part of the line as an
593 error (enabled by default).
594 * `indent-with-non-tab` treats a line that is indented with space
595 characters instead of the equivalent tabs as an error (not enabled by
596 default).
597 * `tab-in-indent` treats a tab character in the initial indent part of
598 the line as an error (not enabled by default).
599 * `blank-at-eof` treats blank lines added at the end of file as an error
600 (enabled by default).
601 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
602 `blank-at-eof`.
603 * `cr-at-eol` treats a carriage-return at the end of line as
604 part of the line terminator, i.e. with it, `trailing-space`
605 does not trigger if the character before such a carriage-return
606 is not a whitespace (not enabled by default).
607 * `tabwidth=<n>` tells how many character positions a tab occupies; this
608 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
609 errors. The default tab width is 8. Allowed values are 1 to 63.
610
611 core.fsyncobjectfiles::
612 This boolean will enable 'fsync()' when writing object files.
613 +
614 This is a total waste of time and effort on a filesystem that orders
615 data writes properly, but can be useful for filesystems that do not use
616 journalling (traditional UNIX filesystems) or that only journal metadata
617 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
618
619 core.preloadindex::
620 Enable parallel index preload for operations like 'git diff'
621 +
622 This can speed up operations like 'git diff' and 'git status' especially
623 on filesystems like NFS that have weak caching semantics and thus
624 relatively high IO latencies. With this set to 'true', Git will do the
625 index comparison to the filesystem data in parallel, allowing
626 overlapping IO's.
627
628 core.createObject::
629 You can set this to 'link', in which case a hardlink followed by
630 a delete of the source are used to make sure that object creation
631 will not overwrite existing objects.
632 +
633 On some file system/operating system combinations, this is unreliable.
634 Set this config setting to 'rename' there; However, This will remove the
635 check that makes sure that existing object files will not get overwritten.
636
637 core.notesRef::
638 When showing commit messages, also show notes which are stored in
639 the given ref. The ref must be fully qualified. If the given
640 ref does not exist, it is not an error but means that no
641 notes should be printed.
642 +
643 This setting defaults to "refs/notes/commits", and it can be overridden by
644 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
645
646 core.sparseCheckout::
647 Enable "sparse checkout" feature. See section "Sparse checkout" in
648 linkgit:git-read-tree[1] for more information.
649
650 core.abbrev::
651 Set the length object names are abbreviated to. If unspecified,
652 many commands abbreviate to 7 hexdigits, which may not be enough
653 for abbreviated object names to stay unique for sufficiently long
654 time.
655
656 add.ignore-errors::
657 add.ignoreErrors::
658 Tells 'git add' to continue adding files when some files cannot be
659 added due to indexing errors. Equivalent to the '--ignore-errors'
660 option of linkgit:git-add[1]. Older versions of Git accept only
661 `add.ignore-errors`, which does not follow the usual naming
662 convention for configuration variables. Newer versions of Git
663 honor `add.ignoreErrors` as well.
664
665 alias.*::
666 Command aliases for the linkgit:git[1] command wrapper - e.g.
667 after defining "alias.last = cat-file commit HEAD", the invocation
668 "git last" is equivalent to "git cat-file commit HEAD". To avoid
669 confusion and troubles with script usage, aliases that
670 hide existing Git commands are ignored. Arguments are split by
671 spaces, the usual shell quoting and escaping is supported.
672 quote pair and a backslash can be used to quote them.
673 +
674 If the alias expansion is prefixed with an exclamation point,
675 it will be treated as a shell command. For example, defining
676 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
677 "git new" is equivalent to running the shell command
678 "gitk --all --not ORIG_HEAD". Note that shell commands will be
679 executed from the top-level directory of a repository, which may
680 not necessarily be the current directory.
681 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
682 from the original current directory. See linkgit:git-rev-parse[1].
683
684 am.keepcr::
685 If true, git-am will call git-mailsplit for patches in mbox format
686 with parameter '--keep-cr'. In this case git-mailsplit will
687 not remove `\r` from lines ending with `\r\n`. Can be overridden
688 by giving '--no-keep-cr' from the command line.
689 See linkgit:git-am[1], linkgit:git-mailsplit[1].
690
691 apply.ignorewhitespace::
692 When set to 'change', tells 'git apply' to ignore changes in
693 whitespace, in the same way as the '--ignore-space-change'
694 option.
695 When set to one of: no, none, never, false tells 'git apply' to
696 respect all whitespace differences.
697 See linkgit:git-apply[1].
698
699 apply.whitespace::
700 Tells 'git apply' how to handle whitespaces, in the same way
701 as the '--whitespace' option. See linkgit:git-apply[1].
702
703 branch.autosetupmerge::
704 Tells 'git branch' and 'git checkout' to set up new branches
705 so that linkgit:git-pull[1] will appropriately merge from the
706 starting point branch. Note that even if this option is not set,
707 this behavior can be chosen per-branch using the `--track`
708 and `--no-track` options. The valid settings are: `false` -- no
709 automatic setup is done; `true` -- automatic setup is done when the
710 starting point is a remote-tracking branch; `always` --
711 automatic setup is done when the starting point is either a
712 local branch or remote-tracking
713 branch. This option defaults to true.
714
715 branch.autosetuprebase::
716 When a new branch is created with 'git branch' or 'git checkout'
717 that tracks another branch, this variable tells Git to set
718 up pull to rebase instead of merge (see "branch.<name>.rebase").
719 When `never`, rebase is never automatically set to true.
720 When `local`, rebase is set to true for tracked branches of
721 other local branches.
722 When `remote`, rebase is set to true for tracked branches of
723 remote-tracking branches.
724 When `always`, rebase will be set to true for all tracking
725 branches.
726 See "branch.autosetupmerge" for details on how to set up a
727 branch to track another branch.
728 This option defaults to never.
729
730 branch.<name>.remote::
731 When on branch <name>, it tells 'git fetch' and 'git push'
732 which remote to fetch from/push to. The remote to push to
733 may be overridden with `remote.pushdefault` (for all branches).
734 The remote to push to, for the current branch, may be further
735 overridden by `branch.<name>.pushremote`. If no remote is
736 configured, or if you are not on any branch, it defaults to
737 `origin` for fetching and `remote.pushdefault` for pushing.
738 Additionally, `.` (a period) is the current local repository
739 (a dot-repository), see `branch.<name>.merge`'s final note below.
740
741 branch.<name>.pushremote::
742 When on branch <name>, it overrides `branch.<name>.remote` for
743 pushing. It also overrides `remote.pushdefault` for pushing
744 from branch <name>. When you pull from one place (e.g. your
745 upstream) and push to another place (e.g. your own publishing
746 repository), you would want to set `remote.pushdefault` to
747 specify the remote to push to for all branches, and use this
748 option to override it for a specific branch.
749
750 branch.<name>.merge::
751 Defines, together with branch.<name>.remote, the upstream branch
752 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
753 branch to merge and can also affect 'git push' (see push.default).
754 When in branch <name>, it tells 'git fetch' the default
755 refspec to be marked for merging in FETCH_HEAD. The value is
756 handled like the remote part of a refspec, and must match a
757 ref which is fetched from the remote given by
758 "branch.<name>.remote".
759 The merge information is used by 'git pull' (which at first calls
760 'git fetch') to lookup the default branch for merging. Without
761 this option, 'git pull' defaults to merge the first refspec fetched.
762 Specify multiple values to get an octopus merge.
763 If you wish to setup 'git pull' so that it merges into <name> from
764 another branch in the local repository, you can point
765 branch.<name>.merge to the desired branch, and use the relative path
766 setting `.` (a period) for branch.<name>.remote.
767
768 branch.<name>.mergeoptions::
769 Sets default options for merging into branch <name>. The syntax and
770 supported options are the same as those of linkgit:git-merge[1], but
771 option values containing whitespace characters are currently not
772 supported.
773
774 branch.<name>.rebase::
775 When true, rebase the branch <name> on top of the fetched branch,
776 instead of merging the default branch from the default remote when
777 "git pull" is run. See "pull.rebase" for doing this in a non
778 branch-specific manner.
779 +
780 When preserve, also pass `--preserve-merges` along to 'git rebase'
781 so that locally committed merge commits will not be flattened
782 by running 'git pull'.
783 +
784 *NOTE*: this is a possibly dangerous operation; do *not* use
785 it unless you understand the implications (see linkgit:git-rebase[1]
786 for details).
787
788 branch.<name>.description::
789 Branch description, can be edited with
790 `git branch --edit-description`. Branch description is
791 automatically added in the format-patch cover letter or
792 request-pull summary.
793
794 browser.<tool>.cmd::
795 Specify the command to invoke the specified browser. The
796 specified command is evaluated in shell with the URLs passed
797 as arguments. (See linkgit:git-web{litdd}browse[1].)
798
799 browser.<tool>.path::
800 Override the path for the given tool that may be used to
801 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
802 working repository in gitweb (see linkgit:git-instaweb[1]).
803
804 clean.requireForce::
805 A boolean to make git-clean do nothing unless given -f,
806 -i or -n. Defaults to true.
807
808 color.branch::
809 A boolean to enable/disable color in the output of
810 linkgit:git-branch[1]. May be set to `always`,
811 `false` (or `never`) or `auto` (or `true`), in which case colors are used
812 only when the output is to a terminal. Defaults to false.
813
814 color.branch.<slot>::
815 Use customized color for branch coloration. `<slot>` is one of
816 `current` (the current branch), `local` (a local branch),
817 `remote` (a remote-tracking branch in refs/remotes/),
818 `upstream` (upstream tracking branch), `plain` (other
819 refs).
820 +
821 The value for these configuration variables is a list of colors (at most
822 two) and attributes (at most one), separated by spaces. The colors
823 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
824 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
825 `blink` and `reverse`. The first color given is the foreground; the
826 second is the background. The position of the attribute, if any,
827 doesn't matter.
828
829 color.diff::
830 Whether to use ANSI escape sequences to add color to patches.
831 If this is set to `always`, linkgit:git-diff[1],
832 linkgit:git-log[1], and linkgit:git-show[1] will use color
833 for all patches. If it is set to `true` or `auto`, those
834 commands will only use color when output is to the terminal.
835 Defaults to false.
836 +
837 This does not affect linkgit:git-format-patch[1] or the
838 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
839 command line with the `--color[=<when>]` option.
840
841 color.diff.<slot>::
842 Use customized color for diff colorization. `<slot>` specifies
843 which part of the patch to use the specified color, and is one
844 of `plain` (context text), `meta` (metainformation), `frag`
845 (hunk header), 'func' (function in hunk header), `old` (removed lines),
846 `new` (added lines), `commit` (commit headers), or `whitespace`
847 (highlighting whitespace errors). The values of these variables may be
848 specified as in color.branch.<slot>.
849
850 color.decorate.<slot>::
851 Use customized color for 'git log --decorate' output. `<slot>` is one
852 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
853 branches, remote-tracking branches, tags, stash and HEAD, respectively.
854
855 color.grep::
856 When set to `always`, always highlight matches. When `false` (or
857 `never`), never. When set to `true` or `auto`, use color only
858 when the output is written to the terminal. Defaults to `false`.
859
860 color.grep.<slot>::
861 Use customized color for grep colorization. `<slot>` specifies which
862 part of the line to use the specified color, and is one of
863 +
864 --
865 `context`;;
866 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
867 `filename`;;
868 filename prefix (when not using `-h`)
869 `function`;;
870 function name lines (when using `-p`)
871 `linenumber`;;
872 line number prefix (when using `-n`)
873 `match`;;
874 matching text
875 `selected`;;
876 non-matching text in selected lines
877 `separator`;;
878 separators between fields on a line (`:`, `-`, and `=`)
879 and between hunks (`--`)
880 --
881 +
882 The values of these variables may be specified as in color.branch.<slot>.
883
884 color.interactive::
885 When set to `always`, always use colors for interactive prompts
886 and displays (such as those used by "git-add --interactive" and
887 "git-clean --interactive"). When false (or `never`), never.
888 When set to `true` or `auto`, use colors only when the output is
889 to the terminal. Defaults to false.
890
891 color.interactive.<slot>::
892 Use customized color for 'git add --interactive' and 'git clean
893 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
894 or `error`, for four distinct types of normal output from
895 interactive commands. The values of these variables may be
896 specified as in color.branch.<slot>.
897
898 color.pager::
899 A boolean to enable/disable colored output when the pager is in
900 use (default is true).
901
902 color.showbranch::
903 A boolean to enable/disable color in the output of
904 linkgit:git-show-branch[1]. May be set to `always`,
905 `false` (or `never`) or `auto` (or `true`), in which case colors are used
906 only when the output is to a terminal. Defaults to false.
907
908 color.status::
909 A boolean to enable/disable color in the output of
910 linkgit:git-status[1]. May be set to `always`,
911 `false` (or `never`) or `auto` (or `true`), in which case colors are used
912 only when the output is to a terminal. Defaults to false.
913
914 color.status.<slot>::
915 Use customized color for status colorization. `<slot>` is
916 one of `header` (the header text of the status message),
917 `added` or `updated` (files which are added but not committed),
918 `changed` (files which are changed but not added in the index),
919 `untracked` (files which are not tracked by Git),
920 `branch` (the current branch), or
921 `nobranch` (the color the 'no branch' warning is shown in, defaulting
922 to red). The values of these variables may be specified as in
923 color.branch.<slot>.
924
925 color.ui::
926 This variable determines the default value for variables such
927 as `color.diff` and `color.grep` that control the use of color
928 per command family. Its scope will expand as more commands learn
929 configuration to set a default for the `--color` option. Set it
930 to `false` or `never` if you prefer Git commands not to use
931 color unless enabled explicitly with some other configuration
932 or the `--color` option. Set it to `always` if you want all
933 output not intended for machine consumption to use color, to
934 `true` or `auto` (this is the default since Git 1.8.4) if you
935 want such output to use color when written to the terminal.
936
937 column.ui::
938 Specify whether supported commands should output in columns.
939 This variable consists of a list of tokens separated by spaces
940 or commas:
941 +
942 These options control when the feature should be enabled
943 (defaults to 'never'):
944 +
945 --
946 `always`;;
947 always show in columns
948 `never`;;
949 never show in columns
950 `auto`;;
951 show in columns if the output is to the terminal
952 --
953 +
954 These options control layout (defaults to 'column'). Setting any
955 of these implies 'always' if none of 'always', 'never', or 'auto' are
956 specified.
957 +
958 --
959 `column`;;
960 fill columns before rows
961 `row`;;
962 fill rows before columns
963 `plain`;;
964 show in one column
965 --
966 +
967 Finally, these options can be combined with a layout option (defaults
968 to 'nodense'):
969 +
970 --
971 `dense`;;
972 make unequal size columns to utilize more space
973 `nodense`;;
974 make equal size columns
975 --
976
977 column.branch::
978 Specify whether to output branch listing in `git branch` in columns.
979 See `column.ui` for details.
980
981 column.clean::
982 Specify the layout when list items in `git clean -i`, which always
983 shows files and directories in columns. See `column.ui` for details.
984
985 column.status::
986 Specify whether to output untracked files in `git status` in columns.
987 See `column.ui` for details.
988
989 column.tag::
990 Specify whether to output tag listing in `git tag` in columns.
991 See `column.ui` for details.
992
993 commit.cleanup::
994 This setting overrides the default of the `--cleanup` option in
995 `git commit`. See linkgit:git-commit[1] for details. Changing the
996 default can be useful when you always want to keep lines that begin
997 with comment character `#` in your log message, in which case you
998 would do `git config commit.cleanup whitespace` (note that you will
999 have to remove the help lines that begin with `#` in the commit log
1000 template yourself, if you do this).
1001
1002 commit.gpgsign::
1003
1004 A boolean to specify whether all commits should be GPG signed.
1005 Use of this option when doing operations such as rebase can
1006 result in a large number of commits being signed. It may be
1007 convenient to use an agent to avoid typing your GPG passphrase
1008 several times.
1009
1010 commit.status::
1011 A boolean to enable/disable inclusion of status information in the
1012 commit message template when using an editor to prepare the commit
1013 message. Defaults to true.
1014
1015 commit.template::
1016 Specify a file to use as the template for new commit messages.
1017 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1018 specified user's home directory.
1019
1020 credential.helper::
1021 Specify an external helper to be called when a username or
1022 password credential is needed; the helper may consult external
1023 storage to avoid prompting the user for the credentials. See
1024 linkgit:gitcredentials[7] for details.
1025
1026 credential.useHttpPath::
1027 When acquiring credentials, consider the "path" component of an http
1028 or https URL to be important. Defaults to false. See
1029 linkgit:gitcredentials[7] for more information.
1030
1031 credential.username::
1032 If no username is set for a network authentication, use this username
1033 by default. See credential.<context>.* below, and
1034 linkgit:gitcredentials[7].
1035
1036 credential.<url>.*::
1037 Any of the credential.* options above can be applied selectively to
1038 some credentials. For example "credential.https://example.com.username"
1039 would set the default username only for https connections to
1040 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1041 matched.
1042
1043 include::diff-config.txt[]
1044
1045 difftool.<tool>.path::
1046 Override the path for the given tool. This is useful in case
1047 your tool is not in the PATH.
1048
1049 difftool.<tool>.cmd::
1050 Specify the command to invoke the specified diff tool.
1051 The specified command is evaluated in shell with the following
1052 variables available: 'LOCAL' is set to the name of the temporary
1053 file containing the contents of the diff pre-image and 'REMOTE'
1054 is set to the name of the temporary file containing the contents
1055 of the diff post-image.
1056
1057 difftool.prompt::
1058 Prompt before each invocation of the diff tool.
1059
1060 fetch.recurseSubmodules::
1061 This option can be either set to a boolean value or to 'on-demand'.
1062 Setting it to a boolean changes the behavior of fetch and pull to
1063 unconditionally recurse into submodules when set to true or to not
1064 recurse at all when set to false. When set to 'on-demand' (the default
1065 value), fetch and pull will only recurse into a populated submodule
1066 when its superproject retrieves a commit that updates the submodule's
1067 reference.
1068
1069 fetch.fsckObjects::
1070 If it is set to true, git-fetch-pack will check all fetched
1071 objects. It will abort in the case of a malformed object or a
1072 broken link. The result of an abort are only dangling objects.
1073 Defaults to false. If not set, the value of `transfer.fsckObjects`
1074 is used instead.
1075
1076 fetch.unpackLimit::
1077 If the number of objects fetched over the Git native
1078 transfer is below this
1079 limit, then the objects will be unpacked into loose object
1080 files. However if the number of received objects equals or
1081 exceeds this limit then the received pack will be stored as
1082 a pack, after adding any missing delta bases. Storing the
1083 pack from a push can make the push operation complete faster,
1084 especially on slow filesystems. If not set, the value of
1085 `transfer.unpackLimit` is used instead.
1086
1087 fetch.prune::
1088 If true, fetch will automatically behave as if the `--prune`
1089 option was given on the command line. See also `remote.<name>.prune`.
1090
1091 format.attach::
1092 Enable multipart/mixed attachments as the default for
1093 'format-patch'. The value can also be a double quoted string
1094 which will enable attachments as the default and set the
1095 value as the boundary. See the --attach option in
1096 linkgit:git-format-patch[1].
1097
1098 format.numbered::
1099 A boolean which can enable or disable sequence numbers in patch
1100 subjects. It defaults to "auto" which enables it only if there
1101 is more than one patch. It can be enabled or disabled for all
1102 messages by setting it to "true" or "false". See --numbered
1103 option in linkgit:git-format-patch[1].
1104
1105 format.headers::
1106 Additional email headers to include in a patch to be submitted
1107 by mail. See linkgit:git-format-patch[1].
1108
1109 format.to::
1110 format.cc::
1111 Additional recipients to include in a patch to be submitted
1112 by mail. See the --to and --cc options in
1113 linkgit:git-format-patch[1].
1114
1115 format.subjectprefix::
1116 The default for format-patch is to output files with the '[PATCH]'
1117 subject prefix. Use this variable to change that prefix.
1118
1119 format.signature::
1120 The default for format-patch is to output a signature containing
1121 the Git version number. Use this variable to change that default.
1122 Set this variable to the empty string ("") to suppress
1123 signature generation.
1124
1125 format.suffix::
1126 The default for format-patch is to output files with the suffix
1127 `.patch`. Use this variable to change that suffix (make sure to
1128 include the dot if you want it).
1129
1130 format.pretty::
1131 The default pretty format for log/show/whatchanged command,
1132 See linkgit:git-log[1], linkgit:git-show[1],
1133 linkgit:git-whatchanged[1].
1134
1135 format.thread::
1136 The default threading style for 'git format-patch'. Can be
1137 a boolean value, or `shallow` or `deep`. `shallow` threading
1138 makes every mail a reply to the head of the series,
1139 where the head is chosen from the cover letter, the
1140 `--in-reply-to`, and the first patch mail, in this order.
1141 `deep` threading makes every mail a reply to the previous one.
1142 A true boolean value is the same as `shallow`, and a false
1143 value disables threading.
1144
1145 format.signoff::
1146 A boolean value which lets you enable the `-s/--signoff` option of
1147 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1148 patch should be a conscious act and means that you certify you have
1149 the rights to submit this work under the same open source license.
1150 Please see the 'SubmittingPatches' document for further discussion.
1151
1152 format.coverLetter::
1153 A boolean that controls whether to generate a cover-letter when
1154 format-patch is invoked, but in addition can be set to "auto", to
1155 generate a cover-letter only when there's more than one patch.
1156
1157 filter.<driver>.clean::
1158 The command which is used to convert the content of a worktree
1159 file to a blob upon checkin. See linkgit:gitattributes[5] for
1160 details.
1161
1162 filter.<driver>.smudge::
1163 The command which is used to convert the content of a blob
1164 object to a worktree file upon checkout. See
1165 linkgit:gitattributes[5] for details.
1166
1167 gc.aggressiveDepth::
1168 The depth parameter used in the delta compression
1169 algorithm used by 'git gc --aggressive'. This defaults
1170 to 250.
1171
1172 gc.aggressiveWindow::
1173 The window size parameter used in the delta compression
1174 algorithm used by 'git gc --aggressive'. This defaults
1175 to 250.
1176
1177 gc.auto::
1178 When there are approximately more than this many loose
1179 objects in the repository, `git gc --auto` will pack them.
1180 Some Porcelain commands use this command to perform a
1181 light-weight garbage collection from time to time. The
1182 default value is 6700. Setting this to 0 disables it.
1183
1184 gc.autopacklimit::
1185 When there are more than this many packs that are not
1186 marked with `*.keep` file in the repository, `git gc
1187 --auto` consolidates them into one larger pack. The
1188 default value is 50. Setting this to 0 disables it.
1189
1190 gc.autodetach::
1191 Make `git gc --auto` return immediately andrun in background
1192 if the system supports it. Default is true.
1193
1194 gc.packrefs::
1195 Running `git pack-refs` in a repository renders it
1196 unclonable by Git versions prior to 1.5.1.2 over dumb
1197 transports such as HTTP. This variable determines whether
1198 'git gc' runs `git pack-refs`. This can be set to `notbare`
1199 to enable it within all non-bare repos or it can be set to a
1200 boolean value. The default is `true`.
1201
1202 gc.pruneexpire::
1203 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1204 Override the grace period with this config variable. The value
1205 "now" may be used to disable this grace period and always prune
1206 unreachable objects immediately.
1207
1208 gc.reflogexpire::
1209 gc.<pattern>.reflogexpire::
1210 'git reflog expire' removes reflog entries older than
1211 this time; defaults to 90 days. With "<pattern>" (e.g.
1212 "refs/stash") in the middle the setting applies only to
1213 the refs that match the <pattern>.
1214
1215 gc.reflogexpireunreachable::
1216 gc.<ref>.reflogexpireunreachable::
1217 'git reflog expire' removes reflog entries older than
1218 this time and are not reachable from the current tip;
1219 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1220 in the middle, the setting applies only to the refs that
1221 match the <pattern>.
1222
1223 gc.rerereresolved::
1224 Records of conflicted merge you resolved earlier are
1225 kept for this many days when 'git rerere gc' is run.
1226 The default is 60 days. See linkgit:git-rerere[1].
1227
1228 gc.rerereunresolved::
1229 Records of conflicted merge you have not resolved are
1230 kept for this many days when 'git rerere gc' is run.
1231 The default is 15 days. See linkgit:git-rerere[1].
1232
1233 gitcvs.commitmsgannotation::
1234 Append this string to each commit message. Set to empty string
1235 to disable this feature. Defaults to "via git-CVS emulator".
1236
1237 gitcvs.enabled::
1238 Whether the CVS server interface is enabled for this repository.
1239 See linkgit:git-cvsserver[1].
1240
1241 gitcvs.logfile::
1242 Path to a log file where the CVS server interface well... logs
1243 various stuff. See linkgit:git-cvsserver[1].
1244
1245 gitcvs.usecrlfattr::
1246 If true, the server will look up the end-of-line conversion
1247 attributes for files to determine the '-k' modes to use. If
1248 the attributes force Git to treat a file as text,
1249 the '-k' mode will be left blank so CVS clients will
1250 treat it as text. If they suppress text conversion, the file
1251 will be set with '-kb' mode, which suppresses any newline munging
1252 the client might otherwise do. If the attributes do not allow
1253 the file type to be determined, then 'gitcvs.allbinary' is
1254 used. See linkgit:gitattributes[5].
1255
1256 gitcvs.allbinary::
1257 This is used if 'gitcvs.usecrlfattr' does not resolve
1258 the correct '-kb' mode to use. If true, all
1259 unresolved files are sent to the client in
1260 mode '-kb'. This causes the client to treat them
1261 as binary files, which suppresses any newline munging it
1262 otherwise might do. Alternatively, if it is set to "guess",
1263 then the contents of the file are examined to decide if
1264 it is binary, similar to 'core.autocrlf'.
1265
1266 gitcvs.dbname::
1267 Database used by git-cvsserver to cache revision information
1268 derived from the Git repository. The exact meaning depends on the
1269 used database driver, for SQLite (which is the default driver) this
1270 is a filename. Supports variable substitution (see
1271 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1272 Default: '%Ggitcvs.%m.sqlite'
1273
1274 gitcvs.dbdriver::
1275 Used Perl DBI driver. You can specify any available driver
1276 for this here, but it might not work. git-cvsserver is tested
1277 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1278 reported *not* to work with 'DBD::mysql'. Experimental feature.
1279 May not contain double colons (`:`). Default: 'SQLite'.
1280 See linkgit:git-cvsserver[1].
1281
1282 gitcvs.dbuser, gitcvs.dbpass::
1283 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1284 since SQLite has no concept of database users and/or passwords.
1285 'gitcvs.dbuser' supports variable substitution (see
1286 linkgit:git-cvsserver[1] for details).
1287
1288 gitcvs.dbTableNamePrefix::
1289 Database table name prefix. Prepended to the names of any
1290 database tables used, allowing a single database to be used
1291 for several repositories. Supports variable substitution (see
1292 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1293 characters will be replaced with underscores.
1294
1295 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1296 'gitcvs.allbinary' can also be specified as
1297 'gitcvs.<access_method>.<varname>' (where 'access_method'
1298 is one of "ext" and "pserver") to make them apply only for the given
1299 access method.
1300
1301 gitweb.category::
1302 gitweb.description::
1303 gitweb.owner::
1304 gitweb.url::
1305 See linkgit:gitweb[1] for description.
1306
1307 gitweb.avatar::
1308 gitweb.blame::
1309 gitweb.grep::
1310 gitweb.highlight::
1311 gitweb.patches::
1312 gitweb.pickaxe::
1313 gitweb.remote_heads::
1314 gitweb.showsizes::
1315 gitweb.snapshot::
1316 See linkgit:gitweb.conf[5] for description.
1317
1318 grep.lineNumber::
1319 If set to true, enable '-n' option by default.
1320
1321 grep.patternType::
1322 Set the default matching behavior. Using a value of 'basic', 'extended',
1323 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1324 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1325 value 'default' will return to the default matching behavior.
1326
1327 grep.extendedRegexp::
1328 If set to true, enable '--extended-regexp' option by default. This
1329 option is ignored when the 'grep.patternType' option is set to a value
1330 other than 'default'.
1331
1332 gpg.program::
1333 Use this custom program instead of "gpg" found on $PATH when
1334 making or verifying a PGP signature. The program must support the
1335 same command-line interface as GPG, namely, to verify a detached
1336 signature, "gpg --verify $file - <$signature" is run, and the
1337 program is expected to signal a good signature by exiting with
1338 code 0, and to generate an ascii-armored detached signature, the
1339 standard input of "gpg -bsau $key" is fed with the contents to be
1340 signed, and the program is expected to send the result to its
1341 standard output.
1342
1343 gui.commitmsgwidth::
1344 Defines how wide the commit message window is in the
1345 linkgit:git-gui[1]. "75" is the default.
1346
1347 gui.diffcontext::
1348 Specifies how many context lines should be used in calls to diff
1349 made by the linkgit:git-gui[1]. The default is "5".
1350
1351 gui.displayuntracked::
1352 Determines if linkgit::git-gui[1] shows untracked files
1353 in the file list. The default is "true".
1354
1355 gui.encoding::
1356 Specifies the default encoding to use for displaying of
1357 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1358 It can be overridden by setting the 'encoding' attribute
1359 for relevant files (see linkgit:gitattributes[5]).
1360 If this option is not set, the tools default to the
1361 locale encoding.
1362
1363 gui.matchtrackingbranch::
1364 Determines if new branches created with linkgit:git-gui[1] should
1365 default to tracking remote branches with matching names or
1366 not. Default: "false".
1367
1368 gui.newbranchtemplate::
1369 Is used as suggested name when creating new branches using the
1370 linkgit:git-gui[1].
1371
1372 gui.pruneduringfetch::
1373 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1374 performing a fetch. The default value is "false".
1375
1376 gui.trustmtime::
1377 Determines if linkgit:git-gui[1] should trust the file modification
1378 timestamp or not. By default the timestamps are not trusted.
1379
1380 gui.spellingdictionary::
1381 Specifies the dictionary used for spell checking commit messages in
1382 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1383 off.
1384
1385 gui.fastcopyblame::
1386 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1387 location detection. It makes blame significantly faster on huge
1388 repositories at the expense of less thorough copy detection.
1389
1390 gui.copyblamethreshold::
1391 Specifies the threshold to use in 'git gui blame' original location
1392 detection, measured in alphanumeric characters. See the
1393 linkgit:git-blame[1] manual for more information on copy detection.
1394
1395 gui.blamehistoryctx::
1396 Specifies the radius of history context in days to show in
1397 linkgit:gitk[1] for the selected commit, when the `Show History
1398 Context` menu item is invoked from 'git gui blame'. If this
1399 variable is set to zero, the whole history is shown.
1400
1401 guitool.<name>.cmd::
1402 Specifies the shell command line to execute when the corresponding item
1403 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1404 mandatory for every tool. The command is executed from the root of
1405 the working directory, and in the environment it receives the name of
1406 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1407 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1408 the head is detached, 'CUR_BRANCH' is empty).
1409
1410 guitool.<name>.needsfile::
1411 Run the tool only if a diff is selected in the GUI. It guarantees
1412 that 'FILENAME' is not empty.
1413
1414 guitool.<name>.noconsole::
1415 Run the command silently, without creating a window to display its
1416 output.
1417
1418 guitool.<name>.norescan::
1419 Don't rescan the working directory for changes after the tool
1420 finishes execution.
1421
1422 guitool.<name>.confirm::
1423 Show a confirmation dialog before actually running the tool.
1424
1425 guitool.<name>.argprompt::
1426 Request a string argument from the user, and pass it to the tool
1427 through the 'ARGS' environment variable. Since requesting an
1428 argument implies confirmation, the 'confirm' option has no effect
1429 if this is enabled. If the option is set to 'true', 'yes', or '1',
1430 the dialog uses a built-in generic prompt; otherwise the exact
1431 value of the variable is used.
1432
1433 guitool.<name>.revprompt::
1434 Request a single valid revision from the user, and set the
1435 'REVISION' environment variable. In other aspects this option
1436 is similar to 'argprompt', and can be used together with it.
1437
1438 guitool.<name>.revunmerged::
1439 Show only unmerged branches in the 'revprompt' subdialog.
1440 This is useful for tools similar to merge or rebase, but not
1441 for things like checkout or reset.
1442
1443 guitool.<name>.title::
1444 Specifies the title to use for the prompt dialog. The default
1445 is the tool name.
1446
1447 guitool.<name>.prompt::
1448 Specifies the general prompt string to display at the top of
1449 the dialog, before subsections for 'argprompt' and 'revprompt'.
1450 The default value includes the actual command.
1451
1452 help.browser::
1453 Specify the browser that will be used to display help in the
1454 'web' format. See linkgit:git-help[1].
1455
1456 help.format::
1457 Override the default help format used by linkgit:git-help[1].
1458 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1459 the default. 'web' and 'html' are the same.
1460
1461 help.autocorrect::
1462 Automatically correct and execute mistyped commands after
1463 waiting for the given number of deciseconds (0.1 sec). If more
1464 than one command can be deduced from the entered text, nothing
1465 will be executed. If the value of this option is negative,
1466 the corrected command will be executed immediately. If the
1467 value is 0 - the command will be just shown but not executed.
1468 This is the default.
1469
1470 help.htmlpath::
1471 Specify the path where the HTML documentation resides. File system paths
1472 and URLs are supported. HTML pages will be prefixed with this path when
1473 help is displayed in the 'web' format. This defaults to the documentation
1474 path of your Git installation.
1475
1476 http.proxy::
1477 Override the HTTP proxy, normally configured using the 'http_proxy',
1478 'https_proxy', and 'all_proxy' environment variables (see
1479 `curl(1)`). This can be overridden on a per-remote basis; see
1480 remote.<name>.proxy
1481
1482 http.cookiefile::
1483 File containing previously stored cookie lines which should be used
1484 in the Git http session, if they match the server. The file format
1485 of the file to read cookies from should be plain HTTP headers or
1486 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1487 NOTE that the file specified with http.cookiefile is only used as
1488 input unless http.saveCookies is set.
1489
1490 http.savecookies::
1491 If set, store cookies received during requests to the file specified by
1492 http.cookiefile. Has no effect if http.cookiefile is unset.
1493
1494 http.sslVerify::
1495 Whether to verify the SSL certificate when fetching or pushing
1496 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1497 variable.
1498
1499 http.sslCert::
1500 File containing the SSL certificate when fetching or pushing
1501 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1502 variable.
1503
1504 http.sslKey::
1505 File containing the SSL private key when fetching or pushing
1506 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1507 variable.
1508
1509 http.sslCertPasswordProtected::
1510 Enable Git's password prompt for the SSL certificate. Otherwise
1511 OpenSSL will prompt the user, possibly many times, if the
1512 certificate or private key is encrypted. Can be overridden by the
1513 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1514
1515 http.sslCAInfo::
1516 File containing the certificates to verify the peer with when
1517 fetching or pushing over HTTPS. Can be overridden by the
1518 'GIT_SSL_CAINFO' environment variable.
1519
1520 http.sslCAPath::
1521 Path containing files with the CA certificates to verify the peer
1522 with when fetching or pushing over HTTPS. Can be overridden
1523 by the 'GIT_SSL_CAPATH' environment variable.
1524
1525 http.sslTry::
1526 Attempt to use AUTH SSL/TLS and encrypted data transfers
1527 when connecting via regular FTP protocol. This might be needed
1528 if the FTP server requires it for security reasons or you wish
1529 to connect securely whenever remote FTP server supports it.
1530 Default is false since it might trigger certificate verification
1531 errors on misconfigured servers.
1532
1533 http.maxRequests::
1534 How many HTTP requests to launch in parallel. Can be overridden
1535 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1536
1537 http.minSessions::
1538 The number of curl sessions (counted across slots) to be kept across
1539 requests. They will not be ended with curl_easy_cleanup() until
1540 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1541 value will be capped at 1. Defaults to 1.
1542
1543 http.postBuffer::
1544 Maximum size in bytes of the buffer used by smart HTTP
1545 transports when POSTing data to the remote system.
1546 For requests larger than this buffer size, HTTP/1.1 and
1547 Transfer-Encoding: chunked is used to avoid creating a
1548 massive pack file locally. Default is 1 MiB, which is
1549 sufficient for most requests.
1550
1551 http.lowSpeedLimit, http.lowSpeedTime::
1552 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1553 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1554 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1555 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1556
1557 http.noEPSV::
1558 A boolean which disables using of EPSV ftp command by curl.
1559 This can helpful with some "poor" ftp servers which don't
1560 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1561 environment variable. Default is false (curl will use EPSV).
1562
1563 http.useragent::
1564 The HTTP USER_AGENT string presented to an HTTP server. The default
1565 value represents the version of the client Git such as git/1.7.1.
1566 This option allows you to override this value to a more common value
1567 such as Mozilla/4.0. This may be necessary, for instance, if
1568 connecting through a firewall that restricts HTTP connections to a set
1569 of common USER_AGENT strings (but not including those like git/1.7.1).
1570 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1571
1572 http.<url>.*::
1573 Any of the http.* options above can be applied selectively to some urls.
1574 For a config key to match a URL, each element of the config key is
1575 compared to that of the URL, in the following order:
1576 +
1577 --
1578 . Scheme (e.g., `https` in `https://example.com/`). This field
1579 must match exactly between the config key and the URL.
1580
1581 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1582 This field must match exactly between the config key and the URL.
1583
1584 . Port number (e.g., `8080` in `http://example.com:8080/`).
1585 This field must match exactly between the config key and the URL.
1586 Omitted port numbers are automatically converted to the correct
1587 default for the scheme before matching.
1588
1589 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1590 path field of the config key must match the path field of the URL
1591 either exactly or as a prefix of slash-delimited path elements. This means
1592 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1593 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1594 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1595 key with just path `foo/`).
1596
1597 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1598 the config key has a user name it must match the user name in the
1599 URL exactly. If the config key does not have a user name, that
1600 config key will match a URL with any user name (including none),
1601 but at a lower precedence than a config key with a user name.
1602 --
1603 +
1604 The list above is ordered by decreasing precedence; a URL that matches
1605 a config key's path is preferred to one that matches its user name. For example,
1606 if the URL is `https://user@example.com/foo/bar` a config key match of
1607 `https://example.com/foo` will be preferred over a config key match of
1608 `https://user@example.com`.
1609 +
1610 All URLs are normalized before attempting any matching (the password part,
1611 if embedded in the URL, is always ignored for matching purposes) so that
1612 equivalent urls that are simply spelled differently will match properly.
1613 Environment variable settings always override any matches. The urls that are
1614 matched against are those given directly to Git commands. This means any URLs
1615 visited as a result of a redirection do not participate in matching.
1616
1617 i18n.commitEncoding::
1618 Character encoding the commit messages are stored in; Git itself
1619 does not care per se, but this information is necessary e.g. when
1620 importing commits from emails or in the gitk graphical history
1621 browser (and possibly at other places in the future or in other
1622 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1623
1624 i18n.logOutputEncoding::
1625 Character encoding the commit messages are converted to when
1626 running 'git log' and friends.
1627
1628 imap::
1629 The configuration variables in the 'imap' section are described
1630 in linkgit:git-imap-send[1].
1631
1632 index.version::
1633 Specify the version with which new index files should be
1634 initialized. This does not affect existing repositories.
1635
1636 init.templatedir::
1637 Specify the directory from which templates will be copied.
1638 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1639
1640 instaweb.browser::
1641 Specify the program that will be used to browse your working
1642 repository in gitweb. See linkgit:git-instaweb[1].
1643
1644 instaweb.httpd::
1645 The HTTP daemon command-line to start gitweb on your working
1646 repository. See linkgit:git-instaweb[1].
1647
1648 instaweb.local::
1649 If true the web server started by linkgit:git-instaweb[1] will
1650 be bound to the local IP (127.0.0.1).
1651
1652 instaweb.modulepath::
1653 The default module path for linkgit:git-instaweb[1] to use
1654 instead of /usr/lib/apache2/modules. Only used if httpd
1655 is Apache.
1656
1657 instaweb.port::
1658 The port number to bind the gitweb httpd to. See
1659 linkgit:git-instaweb[1].
1660
1661 interactive.singlekey::
1662 In interactive commands, allow the user to provide one-letter
1663 input with a single key (i.e., without hitting enter).
1664 Currently this is used by the `--patch` mode of
1665 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1666 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1667 setting is silently ignored if portable keystroke input
1668 is not available; requires the Perl module Term::ReadKey.
1669
1670 log.abbrevCommit::
1671 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1672 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1673 override this option with `--no-abbrev-commit`.
1674
1675 log.date::
1676 Set the default date-time mode for the 'log' command.
1677 Setting a value for log.date is similar to using 'git log''s
1678 `--date` option. Possible values are `relative`, `local`,
1679 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1680 for details.
1681
1682 log.decorate::
1683 Print out the ref names of any commits that are shown by the log
1684 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1685 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1686 specified, the full ref name (including prefix) will be printed.
1687 This is the same as the log commands '--decorate' option.
1688
1689 log.showroot::
1690 If true, the initial commit will be shown as a big creation event.
1691 This is equivalent to a diff against an empty tree.
1692 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1693 normally hide the root commit will now show it. True by default.
1694
1695 log.mailmap::
1696 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1697 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1698
1699 mailmap.file::
1700 The location of an augmenting mailmap file. The default
1701 mailmap, located in the root of the repository, is loaded
1702 first, then the mailmap file pointed to by this variable.
1703 The location of the mailmap file may be in a repository
1704 subdirectory, or somewhere outside of the repository itself.
1705 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1706
1707 mailmap.blob::
1708 Like `mailmap.file`, but consider the value as a reference to a
1709 blob in the repository. If both `mailmap.file` and
1710 `mailmap.blob` are given, both are parsed, with entries from
1711 `mailmap.file` taking precedence. In a bare repository, this
1712 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1713 defaults to empty.
1714
1715 man.viewer::
1716 Specify the programs that may be used to display help in the
1717 'man' format. See linkgit:git-help[1].
1718
1719 man.<tool>.cmd::
1720 Specify the command to invoke the specified man viewer. The
1721 specified command is evaluated in shell with the man page
1722 passed as argument. (See linkgit:git-help[1].)
1723
1724 man.<tool>.path::
1725 Override the path for the given tool that may be used to
1726 display help in the 'man' format. See linkgit:git-help[1].
1727
1728 include::merge-config.txt[]
1729
1730 mergetool.<tool>.path::
1731 Override the path for the given tool. This is useful in case
1732 your tool is not in the PATH.
1733
1734 mergetool.<tool>.cmd::
1735 Specify the command to invoke the specified merge tool. The
1736 specified command is evaluated in shell with the following
1737 variables available: 'BASE' is the name of a temporary file
1738 containing the common base of the files to be merged, if available;
1739 'LOCAL' is the name of a temporary file containing the contents of
1740 the file on the current branch; 'REMOTE' is the name of a temporary
1741 file containing the contents of the file from the branch being
1742 merged; 'MERGED' contains the name of the file to which the merge
1743 tool should write the results of a successful merge.
1744
1745 mergetool.<tool>.trustExitCode::
1746 For a custom merge command, specify whether the exit code of
1747 the merge command can be used to determine whether the merge was
1748 successful. If this is not set to true then the merge target file
1749 timestamp is checked and the merge assumed to have been successful
1750 if the file has been updated, otherwise the user is prompted to
1751 indicate the success of the merge.
1752
1753 mergetool.keepBackup::
1754 After performing a merge, the original file with conflict markers
1755 can be saved as a file with a `.orig` extension. If this variable
1756 is set to `false` then this file is not preserved. Defaults to
1757 `true` (i.e. keep the backup files).
1758
1759 mergetool.keepTemporaries::
1760 When invoking a custom merge tool, Git uses a set of temporary
1761 files to pass to the tool. If the tool returns an error and this
1762 variable is set to `true`, then these temporary files will be
1763 preserved, otherwise they will be removed after the tool has
1764 exited. Defaults to `false`.
1765
1766 mergetool.prompt::
1767 Prompt before each invocation of the merge resolution program.
1768
1769 notes.displayRef::
1770 The (fully qualified) refname from which to show notes when
1771 showing commit messages. The value of this variable can be set
1772 to a glob, in which case notes from all matching refs will be
1773 shown. You may also specify this configuration variable
1774 several times. A warning will be issued for refs that do not
1775 exist, but a glob that does not match any refs is silently
1776 ignored.
1777 +
1778 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1779 environment variable, which must be a colon separated list of refs or
1780 globs.
1781 +
1782 The effective value of "core.notesRef" (possibly overridden by
1783 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1784 displayed.
1785
1786 notes.rewrite.<command>::
1787 When rewriting commits with <command> (currently `amend` or
1788 `rebase`) and this variable is set to `true`, Git
1789 automatically copies your notes from the original to the
1790 rewritten commit. Defaults to `true`, but see
1791 "notes.rewriteRef" below.
1792
1793 notes.rewriteMode::
1794 When copying notes during a rewrite (see the
1795 "notes.rewrite.<command>" option), determines what to do if
1796 the target commit already has a note. Must be one of
1797 `overwrite`, `concatenate`, or `ignore`. Defaults to
1798 `concatenate`.
1799 +
1800 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1801 environment variable.
1802
1803 notes.rewriteRef::
1804 When copying notes during a rewrite, specifies the (fully
1805 qualified) ref whose notes should be copied. The ref may be a
1806 glob, in which case notes in all matching refs will be copied.
1807 You may also specify this configuration several times.
1808 +
1809 Does not have a default value; you must configure this variable to
1810 enable note rewriting. Set it to `refs/notes/commits` to enable
1811 rewriting for the default commit notes.
1812 +
1813 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1814 environment variable, which must be a colon separated list of refs or
1815 globs.
1816
1817 pack.window::
1818 The size of the window used by linkgit:git-pack-objects[1] when no
1819 window size is given on the command line. Defaults to 10.
1820
1821 pack.depth::
1822 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1823 maximum depth is given on the command line. Defaults to 50.
1824
1825 pack.windowMemory::
1826 The window memory size limit used by linkgit:git-pack-objects[1]
1827 when no limit is given on the command line. The value can be
1828 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1829 limit.
1830
1831 pack.compression::
1832 An integer -1..9, indicating the compression level for objects
1833 in a pack file. -1 is the zlib default. 0 means no
1834 compression, and 1..9 are various speed/size tradeoffs, 9 being
1835 slowest. If not set, defaults to core.compression. If that is
1836 not set, defaults to -1, the zlib default, which is "a default
1837 compromise between speed and compression (currently equivalent
1838 to level 6)."
1839 +
1840 Note that changing the compression level will not automatically recompress
1841 all existing objects. You can force recompression by passing the -F option
1842 to linkgit:git-repack[1].
1843
1844 pack.deltaCacheSize::
1845 The maximum memory in bytes used for caching deltas in
1846 linkgit:git-pack-objects[1] before writing them out to a pack.
1847 This cache is used to speed up the writing object phase by not
1848 having to recompute the final delta result once the best match
1849 for all objects is found. Repacking large repositories on machines
1850 which are tight with memory might be badly impacted by this though,
1851 especially if this cache pushes the system into swapping.
1852 A value of 0 means no limit. The smallest size of 1 byte may be
1853 used to virtually disable this cache. Defaults to 256 MiB.
1854
1855 pack.deltaCacheLimit::
1856 The maximum size of a delta, that is cached in
1857 linkgit:git-pack-objects[1]. This cache is used to speed up the
1858 writing object phase by not having to recompute the final delta
1859 result once the best match for all objects is found. Defaults to 1000.
1860
1861 pack.threads::
1862 Specifies the number of threads to spawn when searching for best
1863 delta matches. This requires that linkgit:git-pack-objects[1]
1864 be compiled with pthreads otherwise this option is ignored with a
1865 warning. This is meant to reduce packing time on multiprocessor
1866 machines. The required amount of memory for the delta search window
1867 is however multiplied by the number of threads.
1868 Specifying 0 will cause Git to auto-detect the number of CPU's
1869 and set the number of threads accordingly.
1870
1871 pack.indexVersion::
1872 Specify the default pack index version. Valid values are 1 for
1873 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1874 the new pack index with capabilities for packs larger than 4 GB
1875 as well as proper protection against the repacking of corrupted
1876 packs. Version 2 is the default. Note that version 2 is enforced
1877 and this config option ignored whenever the corresponding pack is
1878 larger than 2 GB.
1879 +
1880 If you have an old Git that does not understand the version 2 `*.idx` file,
1881 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1882 that will copy both `*.pack` file and corresponding `*.idx` file from the
1883 other side may give you a repository that cannot be accessed with your
1884 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1885 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1886 the `*.idx` file.
1887
1888 pack.packSizeLimit::
1889 The maximum size of a pack. This setting only affects
1890 packing to a file when repacking, i.e. the git:// protocol
1891 is unaffected. It can be overridden by the `--max-pack-size`
1892 option of linkgit:git-repack[1]. The minimum size allowed is
1893 limited to 1 MiB. The default is unlimited.
1894 Common unit suffixes of 'k', 'm', or 'g' are
1895 supported.
1896
1897 pack.useBitmaps::
1898 When true, git will use pack bitmaps (if available) when packing
1899 to stdout (e.g., during the server side of a fetch). Defaults to
1900 true. You should not generally need to turn this off unless
1901 you are debugging pack bitmaps.
1902
1903 pack.writebitmaps::
1904 When true, git will write a bitmap index when packing all
1905 objects to disk (e.g., when `git repack -a` is run). This
1906 index can speed up the "counting objects" phase of subsequent
1907 packs created for clones and fetches, at the cost of some disk
1908 space and extra time spent on the initial repack. Defaults to
1909 false.
1910
1911 pack.writeBitmapHashCache::
1912 When true, git will include a "hash cache" section in the bitmap
1913 index (if one is written). This cache can be used to feed git's
1914 delta heuristics, potentially leading to better deltas between
1915 bitmapped and non-bitmapped objects (e.g., when serving a fetch
1916 between an older, bitmapped pack and objects that have been
1917 pushed since the last gc). The downside is that it consumes 4
1918 bytes per object of disk space, and that JGit's bitmap
1919 implementation does not understand it, causing it to complain if
1920 Git and JGit are used on the same repository. Defaults to false.
1921
1922 pager.<cmd>::
1923 If the value is boolean, turns on or off pagination of the
1924 output of a particular Git subcommand when writing to a tty.
1925 Otherwise, turns on pagination for the subcommand using the
1926 pager specified by the value of `pager.<cmd>`. If `--paginate`
1927 or `--no-pager` is specified on the command line, it takes
1928 precedence over this option. To disable pagination for all
1929 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1930
1931 pretty.<name>::
1932 Alias for a --pretty= format string, as specified in
1933 linkgit:git-log[1]. Any aliases defined here can be used just
1934 as the built-in pretty formats could. For example,
1935 running `git config pretty.changelog "format:* %H %s"`
1936 would cause the invocation `git log --pretty=changelog`
1937 to be equivalent to running `git log "--pretty=format:* %H %s"`.
1938 Note that an alias with the same name as a built-in format
1939 will be silently ignored.
1940
1941 pull.ff::
1942 By default, Git does not create an extra merge commit when merging
1943 a commit that is a descendant of the current commit. Instead, the
1944 tip of the current branch is fast-forwarded. When set to `false`,
1945 this variable tells Git to create an extra merge commit in such
1946 a case (equivalent to giving the `--no-ff` option from the command
1947 line). When set to `only`, only such fast-forward merges are
1948 allowed (equivalent to giving the `--ff-only` option from the
1949 command line).
1950
1951 pull.rebase::
1952 When true, rebase branches on top of the fetched branch, instead
1953 of merging the default branch from the default remote when "git
1954 pull" is run. See "branch.<name>.rebase" for setting this on a
1955 per-branch basis.
1956 +
1957 When preserve, also pass `--preserve-merges` along to 'git rebase'
1958 so that locally committed merge commits will not be flattened
1959 by running 'git pull'.
1960 +
1961 *NOTE*: this is a possibly dangerous operation; do *not* use
1962 it unless you understand the implications (see linkgit:git-rebase[1]
1963 for details).
1964
1965 pull.octopus::
1966 The default merge strategy to use when pulling multiple branches
1967 at once.
1968
1969 pull.twohead::
1970 The default merge strategy to use when pulling a single branch.
1971
1972 push.default::
1973 Defines the action `git push` should take if no refspec is
1974 explicitly given. Different values are well-suited for
1975 specific workflows; for instance, in a purely central workflow
1976 (i.e. the fetch source is equal to the push destination),
1977 `upstream` is probably what you want. Possible values are:
1978 +
1979 --
1980
1981 * `nothing` - do not push anything (error out) unless a refspec is
1982 explicitly given. This is primarily meant for people who want to
1983 avoid mistakes by always being explicit.
1984
1985 * `current` - push the current branch to update a branch with the same
1986 name on the receiving end. Works in both central and non-central
1987 workflows.
1988
1989 * `upstream` - push the current branch back to the branch whose
1990 changes are usually integrated into the current branch (which is
1991 called `@{upstream}`). This mode only makes sense if you are
1992 pushing to the same repository you would normally pull from
1993 (i.e. central workflow).
1994
1995 * `simple` - in centralized workflow, work like `upstream` with an
1996 added safety to refuse to push if the upstream branch's name is
1997 different from the local one.
1998 +
1999 When pushing to a remote that is different from the remote you normally
2000 pull from, work as `current`. This is the safest option and is suited
2001 for beginners.
2002 +
2003 This mode has become the default in Git 2.0.
2004
2005 * `matching` - push all branches having the same name on both ends.
2006 This makes the repository you are pushing to remember the set of
2007 branches that will be pushed out (e.g. if you always push 'maint'
2008 and 'master' there and no other branches, the repository you push
2009 to will have these two branches, and your local 'maint' and
2010 'master' will be pushed there).
2011 +
2012 To use this mode effectively, you have to make sure _all_ the
2013 branches you would push out are ready to be pushed out before
2014 running 'git push', as the whole point of this mode is to allow you
2015 to push all of the branches in one go. If you usually finish work
2016 on only one branch and push out the result, while other branches are
2017 unfinished, this mode is not for you. Also this mode is not
2018 suitable for pushing into a shared central repository, as other
2019 people may add new branches there, or update the tip of existing
2020 branches outside your control.
2021 +
2022 This used to be the default, but not since Git 2.0 (`simple` is the
2023 new default).
2024
2025 --
2026
2027 rebase.stat::
2028 Whether to show a diffstat of what changed upstream since the last
2029 rebase. False by default.
2030
2031 rebase.autosquash::
2032 If set to true enable '--autosquash' option by default.
2033
2034 rebase.autostash::
2035 When set to true, automatically create a temporary stash
2036 before the operation begins, and apply it after the operation
2037 ends. This means that you can run rebase on a dirty worktree.
2038 However, use with care: the final stash application after a
2039 successful rebase might result in non-trivial conflicts.
2040 Defaults to false.
2041
2042 receive.autogc::
2043 By default, git-receive-pack will run "git-gc --auto" after
2044 receiving data from git-push and updating refs. You can stop
2045 it by setting this variable to false.
2046
2047 receive.fsckObjects::
2048 If it is set to true, git-receive-pack will check all received
2049 objects. It will abort in the case of a malformed object or a
2050 broken link. The result of an abort are only dangling objects.
2051 Defaults to false. If not set, the value of `transfer.fsckObjects`
2052 is used instead.
2053
2054 receive.unpackLimit::
2055 If the number of objects received in a push is below this
2056 limit then the objects will be unpacked into loose object
2057 files. However if the number of received objects equals or
2058 exceeds this limit then the received pack will be stored as
2059 a pack, after adding any missing delta bases. Storing the
2060 pack from a push can make the push operation complete faster,
2061 especially on slow filesystems. If not set, the value of
2062 `transfer.unpackLimit` is used instead.
2063
2064 receive.denyDeletes::
2065 If set to true, git-receive-pack will deny a ref update that deletes
2066 the ref. Use this to prevent such a ref deletion via a push.
2067
2068 receive.denyDeleteCurrent::
2069 If set to true, git-receive-pack will deny a ref update that
2070 deletes the currently checked out branch of a non-bare repository.
2071
2072 receive.denyCurrentBranch::
2073 If set to true or "refuse", git-receive-pack will deny a ref update
2074 to the currently checked out branch of a non-bare repository.
2075 Such a push is potentially dangerous because it brings the HEAD
2076 out of sync with the index and working tree. If set to "warn",
2077 print a warning of such a push to stderr, but allow the push to
2078 proceed. If set to false or "ignore", allow such pushes with no
2079 message. Defaults to "refuse".
2080
2081 receive.denyNonFastForwards::
2082 If set to true, git-receive-pack will deny a ref update which is
2083 not a fast-forward. Use this to prevent such an update via a push,
2084 even if that push is forced. This configuration variable is
2085 set when initializing a shared repository.
2086
2087 receive.hiderefs::
2088 String(s) `receive-pack` uses to decide which refs to omit
2089 from its initial advertisement. Use more than one
2090 definitions to specify multiple prefix strings. A ref that
2091 are under the hierarchies listed on the value of this
2092 variable is excluded, and is hidden when responding to `git
2093 push`, and an attempt to update or delete a hidden ref by
2094 `git push` is rejected.
2095
2096 receive.updateserverinfo::
2097 If set to true, git-receive-pack will run git-update-server-info
2098 after receiving data from git-push and updating refs.
2099
2100 receive.shallowupdate::
2101 If set to true, .git/shallow can be updated when new refs
2102 require new shallow roots. Otherwise those refs are rejected.
2103
2104 remote.pushdefault::
2105 The remote to push to by default. Overrides
2106 `branch.<name>.remote` for all branches, and is overridden by
2107 `branch.<name>.pushremote` for specific branches.
2108
2109 remote.<name>.url::
2110 The URL of a remote repository. See linkgit:git-fetch[1] or
2111 linkgit:git-push[1].
2112
2113 remote.<name>.pushurl::
2114 The push URL of a remote repository. See linkgit:git-push[1].
2115
2116 remote.<name>.proxy::
2117 For remotes that require curl (http, https and ftp), the URL to
2118 the proxy to use for that remote. Set to the empty string to
2119 disable proxying for that remote.
2120
2121 remote.<name>.fetch::
2122 The default set of "refspec" for linkgit:git-fetch[1]. See
2123 linkgit:git-fetch[1].
2124
2125 remote.<name>.push::
2126 The default set of "refspec" for linkgit:git-push[1]. See
2127 linkgit:git-push[1].
2128
2129 remote.<name>.mirror::
2130 If true, pushing to this remote will automatically behave
2131 as if the `--mirror` option was given on the command line.
2132
2133 remote.<name>.skipDefaultUpdate::
2134 If true, this remote will be skipped by default when updating
2135 using linkgit:git-fetch[1] or the `update` subcommand of
2136 linkgit:git-remote[1].
2137
2138 remote.<name>.skipFetchAll::
2139 If true, this remote will be skipped by default when updating
2140 using linkgit:git-fetch[1] or the `update` subcommand of
2141 linkgit:git-remote[1].
2142
2143 remote.<name>.receivepack::
2144 The default program to execute on the remote side when pushing. See
2145 option \--receive-pack of linkgit:git-push[1].
2146
2147 remote.<name>.uploadpack::
2148 The default program to execute on the remote side when fetching. See
2149 option \--upload-pack of linkgit:git-fetch-pack[1].
2150
2151 remote.<name>.tagopt::
2152 Setting this value to \--no-tags disables automatic tag following when
2153 fetching from remote <name>. Setting it to \--tags will fetch every
2154 tag from remote <name>, even if they are not reachable from remote
2155 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2156 override this setting. See options \--tags and \--no-tags of
2157 linkgit:git-fetch[1].
2158
2159 remote.<name>.vcs::
2160 Setting this to a value <vcs> will cause Git to interact with
2161 the remote with the git-remote-<vcs> helper.
2162
2163 remote.<name>.prune::
2164 When set to true, fetching from this remote by default will also
2165 remove any remote-tracking references that no longer exist on the
2166 remote (as if the `--prune` option was given on the command line).
2167 Overrides `fetch.prune` settings, if any.
2168
2169 remotes.<group>::
2170 The list of remotes which are fetched by "git remote update
2171 <group>". See linkgit:git-remote[1].
2172
2173 repack.usedeltabaseoffset::
2174 By default, linkgit:git-repack[1] creates packs that use
2175 delta-base offset. If you need to share your repository with
2176 Git older than version 1.4.4, either directly or via a dumb
2177 protocol such as http, then you need to set this option to
2178 "false" and repack. Access from old Git versions over the
2179 native protocol are unaffected by this option.
2180
2181 repack.packKeptObjects::
2182 If set to true, makes `git repack` act as if
2183 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2184 details. Defaults to `false` normally, but `true` if a bitmap
2185 index is being written (either via `--write-bitmap-index` or
2186 `pack.writeBitmaps`).
2187
2188 rerere.autoupdate::
2189 When set to true, `git-rerere` updates the index with the
2190 resulting contents after it cleanly resolves conflicts using
2191 previously recorded resolution. Defaults to false.
2192
2193 rerere.enabled::
2194 Activate recording of resolved conflicts, so that identical
2195 conflict hunks can be resolved automatically, should they be
2196 encountered again. By default, linkgit:git-rerere[1] is
2197 enabled if there is an `rr-cache` directory under the
2198 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2199 repository.
2200
2201 sendemail.identity::
2202 A configuration identity. When given, causes values in the
2203 'sendemail.<identity>' subsection to take precedence over
2204 values in the 'sendemail' section. The default identity is
2205 the value of 'sendemail.identity'.
2206
2207 sendemail.smtpencryption::
2208 See linkgit:git-send-email[1] for description. Note that this
2209 setting is not subject to the 'identity' mechanism.
2210
2211 sendemail.smtpssl::
2212 Deprecated alias for 'sendemail.smtpencryption = ssl'.
2213
2214 sendemail.smtpsslcertpath::
2215 Path to ca-certificates (either a directory or a single file).
2216 Set it to an empty string to disable certificate verification.
2217
2218 sendemail.<identity>.*::
2219 Identity-specific versions of the 'sendemail.*' parameters
2220 found below, taking precedence over those when the this
2221 identity is selected, through command-line or
2222 'sendemail.identity'.
2223
2224 sendemail.aliasesfile::
2225 sendemail.aliasfiletype::
2226 sendemail.annotate::
2227 sendemail.bcc::
2228 sendemail.cc::
2229 sendemail.cccmd::
2230 sendemail.chainreplyto::
2231 sendemail.confirm::
2232 sendemail.envelopesender::
2233 sendemail.from::
2234 sendemail.multiedit::
2235 sendemail.signedoffbycc::
2236 sendemail.smtppass::
2237 sendemail.suppresscc::
2238 sendemail.suppressfrom::
2239 sendemail.to::
2240 sendemail.smtpdomain::
2241 sendemail.smtpserver::
2242 sendemail.smtpserverport::
2243 sendemail.smtpserveroption::
2244 sendemail.smtpuser::
2245 sendemail.thread::
2246 sendemail.validate::
2247 See linkgit:git-send-email[1] for description.
2248
2249 sendemail.signedoffcc::
2250 Deprecated alias for 'sendemail.signedoffbycc'.
2251
2252 showbranch.default::
2253 The default set of branches for linkgit:git-show-branch[1].
2254 See linkgit:git-show-branch[1].
2255
2256 status.relativePaths::
2257 By default, linkgit:git-status[1] shows paths relative to the
2258 current directory. Setting this variable to `false` shows paths
2259 relative to the repository root (this was the default for Git
2260 prior to v1.5.4).
2261
2262 status.short::
2263 Set to true to enable --short by default in linkgit:git-status[1].
2264 The option --no-short takes precedence over this variable.
2265
2266 status.branch::
2267 Set to true to enable --branch by default in linkgit:git-status[1].
2268 The option --no-branch takes precedence over this variable.
2269
2270 status.displayCommentPrefix::
2271 If set to true, linkgit:git-status[1] will insert a comment
2272 prefix before each output line (starting with
2273 `core.commentChar`, i.e. `#` by default). This was the
2274 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2275 Defaults to false.
2276
2277 status.showUntrackedFiles::
2278 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2279 files which are not currently tracked by Git. Directories which
2280 contain only untracked files, are shown with the directory name
2281 only. Showing untracked files means that Git needs to lstat() all
2282 all the files in the whole repository, which might be slow on some
2283 systems. So, this variable controls how the commands displays
2284 the untracked files. Possible values are:
2285 +
2286 --
2287 * `no` - Show no untracked files.
2288 * `normal` - Show untracked files and directories.
2289 * `all` - Show also individual files in untracked directories.
2290 --
2291 +
2292 If this variable is not specified, it defaults to 'normal'.
2293 This variable can be overridden with the -u|--untracked-files option
2294 of linkgit:git-status[1] and linkgit:git-commit[1].
2295
2296 status.submodulesummary::
2297 Defaults to false.
2298 If this is set to a non zero number or true (identical to -1 or an
2299 unlimited number), the submodule summary will be enabled and a
2300 summary of commits for modified submodules will be shown (see
2301 --summary-limit option of linkgit:git-submodule[1]). Please note
2302 that the summary output command will be suppressed for all
2303 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2304 for those submodules where `submodule.<name>.ignore=all`. To
2305 also view the summary for ignored submodules you can either use
2306 the --ignore-submodules=dirty command-line option or the 'git
2307 submodule summary' command, which shows a similar output but does
2308 not honor these settings.
2309
2310 submodule.<name>.path::
2311 submodule.<name>.url::
2312 submodule.<name>.update::
2313 The path within this project, URL, and the updating strategy
2314 for a submodule. These variables are initially populated
2315 by 'git submodule init'; edit them to override the
2316 URL and other values found in the `.gitmodules` file. See
2317 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2318
2319 submodule.<name>.branch::
2320 The remote branch name for a submodule, used by `git submodule
2321 update --remote`. Set this option to override the value found in
2322 the `.gitmodules` file. See linkgit:git-submodule[1] and
2323 linkgit:gitmodules[5] for details.
2324
2325 submodule.<name>.fetchRecurseSubmodules::
2326 This option can be used to control recursive fetching of this
2327 submodule. It can be overridden by using the --[no-]recurse-submodules
2328 command-line option to "git fetch" and "git pull".
2329 This setting will override that from in the linkgit:gitmodules[5]
2330 file.
2331
2332 submodule.<name>.ignore::
2333 Defines under what circumstances "git status" and the diff family show
2334 a submodule as modified. When set to "all", it will never be considered
2335 modified, "dirty" will ignore all changes to the submodules work tree and
2336 takes only differences between the HEAD of the submodule and the commit
2337 recorded in the superproject into account. "untracked" will additionally
2338 let submodules with modified tracked files in their work tree show up.
2339 Using "none" (the default when this option is not set) also shows
2340 submodules that have untracked files in their work tree as changed.
2341 This setting overrides any setting made in .gitmodules for this submodule,
2342 both settings can be overridden on the command line by using the
2343 "--ignore-submodules" option. The 'git submodule' commands are not
2344 affected by this setting.
2345
2346 tar.umask::
2347 This variable can be used to restrict the permission bits of
2348 tar archive entries. The default is 0002, which turns off the
2349 world write bit. The special value "user" indicates that the
2350 archiving user's umask will be used instead. See umask(2) and
2351 linkgit:git-archive[1].
2352
2353 transfer.fsckObjects::
2354 When `fetch.fsckObjects` or `receive.fsckObjects` are
2355 not set, the value of this variable is used instead.
2356 Defaults to false.
2357
2358 transfer.hiderefs::
2359 This variable can be used to set both `receive.hiderefs`
2360 and `uploadpack.hiderefs` at the same time to the same
2361 values. See entries for these other variables.
2362
2363 transfer.unpackLimit::
2364 When `fetch.unpackLimit` or `receive.unpackLimit` are
2365 not set, the value of this variable is used instead.
2366 The default value is 100.
2367
2368 uploadarchive.allowUnreachable::
2369 If true, allow clients to use `git archive --remote` to request
2370 any tree, whether reachable from the ref tips or not. See the
2371 discussion in the `SECURITY` section of
2372 linkgit:git-upload-archive[1] for more details. Defaults to
2373 `false`.
2374
2375 uploadpack.hiderefs::
2376 String(s) `upload-pack` uses to decide which refs to omit
2377 from its initial advertisement. Use more than one
2378 definitions to specify multiple prefix strings. A ref that
2379 are under the hierarchies listed on the value of this
2380 variable is excluded, and is hidden from `git ls-remote`,
2381 `git fetch`, etc. An attempt to fetch a hidden ref by `git
2382 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2383
2384 uploadpack.allowtipsha1inwant::
2385 When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2386 to accept a fetch request that asks for an object at the tip
2387 of a hidden ref (by default, such a request is rejected).
2388 see also `uploadpack.hiderefs`.
2389
2390 uploadpack.keepalive::
2391 When `upload-pack` has started `pack-objects`, there may be a
2392 quiet period while `pack-objects` prepares the pack. Normally
2393 it would output progress information, but if `--quiet` was used
2394 for the fetch, `pack-objects` will output nothing at all until
2395 the pack data begins. Some clients and networks may consider
2396 the server to be hung and give up. Setting this option instructs
2397 `upload-pack` to send an empty keepalive packet every
2398 `uploadpack.keepalive` seconds. Setting this option to 0
2399 disables keepalive packets entirely. The default is 5 seconds.
2400
2401 url.<base>.insteadOf::
2402 Any URL that starts with this value will be rewritten to
2403 start, instead, with <base>. In cases where some site serves a
2404 large number of repositories, and serves them with multiple
2405 access methods, and some users need to use different access
2406 methods, this feature allows people to specify any of the
2407 equivalent URLs and have Git automatically rewrite the URL to
2408 the best alternative for the particular user, even for a
2409 never-before-seen repository on the site. When more than one
2410 insteadOf strings match a given URL, the longest match is used.
2411
2412 url.<base>.pushInsteadOf::
2413 Any URL that starts with this value will not be pushed to;
2414 instead, it will be rewritten to start with <base>, and the
2415 resulting URL will be pushed to. In cases where some site serves
2416 a large number of repositories, and serves them with multiple
2417 access methods, some of which do not allow push, this feature
2418 allows people to specify a pull-only URL and have Git
2419 automatically use an appropriate URL to push, even for a
2420 never-before-seen repository on the site. When more than one
2421 pushInsteadOf strings match a given URL, the longest match is
2422 used. If a remote has an explicit pushurl, Git will ignore this
2423 setting for that remote.
2424
2425 user.email::
2426 Your email address to be recorded in any newly created commits.
2427 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2428 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2429
2430 user.name::
2431 Your full name to be recorded in any newly created commits.
2432 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2433 environment variables. See linkgit:git-commit-tree[1].
2434
2435 user.signingkey::
2436 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2437 key you want it to automatically when creating a signed tag or
2438 commit, you can override the default selection with this variable.
2439 This option is passed unchanged to gpg's --local-user parameter,
2440 so you may specify a key using any method that gpg supports.
2441
2442 web.browser::
2443 Specify a web browser that may be used by some commands.
2444 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2445 may use it.