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