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