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