blob: cc887b1279cb04c33cc2e67c373c6ed61daff520 [file] [log] [blame]
Junio C Hamano07824ce2006-04-25 07:36:541CONFIGURATION FILE
2------------------
3
Junio C Hamano076ffcc2013-02-06 05:13:214The Git configuration file contains a number of variables that affect
5the Git commands' behavior. The `.git/config` file in each repository
Junio C Hamanof4581102009-04-25 08:29:596is used to store the configuration for that repository, and
7`$HOME/.gitconfig` is used to store a per-user configuration as
8fallback values for the `.git/config` file. The file `/etc/gitconfig`
9can be used to store a system-wide default configuration.
Junio C Hamano8f76dc62007-01-17 07:24:2510
Junio C Hamano076ffcc2013-02-06 05:13:2111The configuration variables are used by both the Git plumbing
Junio C Hamanof4581102009-04-25 08:29:5912and the porcelains. The variables are divided into sections, wherein
13the fully qualified variable name of the variable itself is the last
Junio C Hamano07824ce2006-04-25 07:36:5414dot-separated segment and the section name is everything before the last
Junio C Hamano81d540a2012-03-02 19:52:4715dot. The variable names are case-insensitive, allow only alphanumeric
16characters and `-`, and must start with an alphabetic character. Some
17variables may appear multiple times.
Junio C Hamano07824ce2006-04-25 07:36:5418
Junio C Hamanobee172f2007-01-23 08:44:1819Syntax
20~~~~~~
21
Junio C Hamano07824ce2006-04-25 07:36:5422The syntax is fairly flexible and permissive; whitespaces are mostly
Junio C Hamanobee172f2007-01-23 08:44:1823ignored. The '#' and ';' characters begin comments to the end of line,
24blank lines are ignored.
25
26The file consists of sections and variables. A section begins with
27the name of the section in square brackets and continues until the next
28section begins. Section names are not case sensitive. Only alphanumeric
Junio C Hamanoea82cff2009-03-18 01:54:4829characters, `-` and `.` are allowed in section names. Each variable
Junio C Hamanof4581102009-04-25 08:29:5930must belong to some section, which means that there must be a section
31header before the first setting of a variable.
Junio C Hamanobee172f2007-01-23 08:44:1832
33Sections can be further divided into subsections. To begin a subsection
34put its name in double quotes, separated by space from the section name,
Junio C Hamanof4581102009-04-25 08:29:5935in the section header, like in the example below:
Junio C Hamanobee172f2007-01-23 08:44:1836
37--------
38[section "subsection"]
39
40--------
41
Junio C Hamanof4581102009-04-25 08:29:5942Subsection names are case sensitive and can contain any characters except
43newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
44respectively). Section headers cannot span multiple
Junio C Hamanobee172f2007-01-23 08:44:1845lines. Variables may belong directly to a section or to a given subsection.
46You can have `[section]` if you have `[section "subsection"]`, but you
47don't need to.
48
Junio C Hamano6231f822011-10-24 05:18:5249There is also a deprecated `[section.subsection]` syntax. With this
50syntax, the subsection name is converted to lower-case and is also
51compared case sensitively. These subsection names follow the same
52restrictions as section names.
Junio C Hamanobee172f2007-01-23 08:44:1853
Junio C Hamanoaa2cd762009-07-26 08:14:0154All the other lines (and the remainder of the line after the section
55header) are recognized as setting variables, in the form
Junio C Hamanobee172f2007-01-23 08:44:1856'name = value'. If there is no equal sign on the line, the entire line
57is taken as 'name' and the variable is recognized as boolean "true".
Junio C Hamano81d540a2012-03-02 19:52:4758The variable names are case-insensitive, allow only alphanumeric characters
59and `-`, and must start with an alphabetic character. There can be more
60than one value for a given variable; we say then that the variable is
61multivalued.
Junio C Hamanobee172f2007-01-23 08:44:1862
63Leading and trailing whitespace in a variable value is discarded.
64Internal whitespace within a variable value is retained verbatim.
65
66The values following the equals sign in variable assign are all either
67a string, an integer, or a boolean. Boolean values may be given as yes/no,
Junio C Hamano059bca52011-03-30 22:47:46681/0, true/false or on/off. Case is not significant in boolean values, when
Junio C Hamanobee172f2007-01-23 08:44:1869converting value to the canonical form using '--bool' type specifier;
Junio C Hamano1aa40d22010-01-21 17:46:4370'git config' will ensure that the output is "true" or "false".
Junio C Hamanobee172f2007-01-23 08:44:1871
72String values may be entirely or partially enclosed in double quotes.
Junio C Hamanof4581102009-04-25 08:29:5973You need to enclose variable values in double quotes if you want to
74preserve leading or trailing whitespace, or if the variable value contains
75comment characters (i.e. it contains '#' or ';').
76Double quote `"` and backslash `\` characters in variable values must
Junio C Hamanoea82cff2009-03-18 01:54:4877be escaped: use `\"` for `"` and `\\` for `\`.
Junio C Hamanobee172f2007-01-23 08:44:1878
Junio C Hamanoea82cff2009-03-18 01:54:4879The following escape sequences (beside `\"` and `\\`) are recognized:
80`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
Junio C Hamanod75148a2014-04-08 19:48:3881and `\b` for backspace (BS). Other char escape sequences (including octal
82escape sequences) are invalid.
Junio C Hamanobee172f2007-01-23 08:44:1883
Junio C Hamanof4581102009-04-25 08:29:5984Variable values ending in a `\` are continued on the next line in the
Junio C Hamanobee172f2007-01-23 08:44:1885customary UNIX fashion.
86
Junio C Hamanof4581102009-04-25 08:29:5987Some variables may require a special value format.
Junio C Hamano07824ce2006-04-25 07:36:5488
Junio C Hamanoe0238c22012-02-23 22:45:5089Includes
90~~~~~~~~
91
92You 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
94included file is expanded immediately, as if its contents had been
95found 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
97relative to the configuration file in which the include directive was
Junio C Hamano22700fb2012-05-03 23:07:2598found. The value of `include.path` is subject to tilde expansion: `~/`
99is expanded to the value of `$HOME`, and `~user/` to the specified
Junio C Hamano4d61c4a2012-04-30 01:10:22100user's home directory. See below for examples.
Junio C Hamanoe0238c22012-02-23 22:45:50101
Junio C Hamano07824ce2006-04-25 07:36:54102Example
103~~~~~~~
104
105# Core variables
106[core]
107; Don't trust file modes
108filemode = false
109
110# Our diff algorithm
111[diff]
Junio C Hamano85c71572008-07-28 00:03:31112external = /usr/local/bin/diff-wrapper
Junio C Hamano07824ce2006-04-25 07:36:54113renames = true
114
Junio C Hamano52401ef2006-12-19 00:54:38115[branch "devel"]
116remote = origin
117merge = refs/heads/devel
118
Junio C Hamanobee172f2007-01-23 08:44:18119# Proxy settings
120[core]
Junio C Hamanoc71a8732007-08-04 00:27:26121gitProxy="ssh" for "kernel.org"
Junio C Hamanobee172f2007-01-23 08:44:18122gitProxy=default-proxy ; for the rest
Junio C Hamano52401ef2006-12-19 00:54:38123
Junio C Hamanoe0238c22012-02-23 22:45:50124[include]
125path = /path/to/foo.inc ; include by absolute path
126path = foo ; expand "foo" relative to the current file
Junio C Hamano4d61c4a2012-04-30 01:10:22127path = ~/foo ; expand "foo" in your $HOME directory
Junio C Hamanoe0238c22012-02-23 22:45:50128
Junio C Hamano07824ce2006-04-25 07:36:54129Variables
130~~~~~~~~~
131
132Note that this list is non-comprehensive and not necessarily complete.
Junio C Hamanof1d14802006-06-08 00:48:17133For command-specific variables, you will find a more detailed description
Junio C Hamano52b6ba32014-04-01 00:26:48134in the appropriate manual page.
135
136Other git-related tools may and do use their own variables. When
137inventing new variables for use in your own tool, make sure their
138names do not conflict with those that are used by Git itself and
139other popular tools, and describe them in your documentation.
140
Junio C Hamano07824ce2006-04-25 07:36:54141
Junio C Hamano7df6dcf2009-09-13 09:51:17142advice.*::
Junio C Hamano0df92712011-12-21 22:30:44143These variables control various optional help messages designed to
144aid new users. All 'advice.*' variables default to 'true', and you
145can tell Git that you do not need help by setting these to 'false':
Junio C Hamano7df6dcf2009-09-13 09:51:17146+
147--
Junio C Hamanoabad6da2013-01-06 09:06:32148pushUpdateRejected::
Junio C Hamano0c1b64e2012-04-20 23:50:49149Set this variable to 'false' if you want to disable
Junio C Hamano1d669b82014-03-11 21:36:00150'pushNonFFCurrent',
Junio C Hamano3f2ed6f2013-02-04 19:24:09151'pushNonFFMatching', 'pushAlreadyExists',
152'pushFetchFirst', and 'pushNeedsForce'
Junio C Hamanoabad6da2013-01-06 09:06:32153simultaneously.
Junio C Hamano0c1b64e2012-04-20 23:50:49154pushNonFFCurrent::
155Advice shown when linkgit:git-push[1] fails due to a
156non-fast-forward update to the current branch.
Junio C Hamano0c1b64e2012-04-20 23:50:49157pushNonFFMatching::
158Advice shown when you ran linkgit:git-push[1] and pushed
159'matching refs' explicitly (i.e. you used ':', or
160specified a refspec that isn't your current branch) and
161it resulted in a non-fast-forward error.
Junio C Hamanoabad6da2013-01-06 09:06:32162pushAlreadyExists::
163Shown when linkgit:git-push[1] rejects an update that
164does not qualify for fast-forwarding (e.g., a tag.)
Junio C Hamano3f2ed6f2013-02-04 19:24:09165pushFetchFirst::
166Shown when linkgit:git-push[1] rejects an update that
167tries to overwrite a remote ref that points at an
168object we do not have.
169pushNeedsForce::
170Shown when linkgit:git-push[1] rejects an update that
171tries to overwrite a remote ref that points at an
Junio C Hamanoe6f28d02013-09-17 21:34:00172object that is not a commit-ish, or make the remote
173ref point at an object that is not a commit-ish.
Junio C Hamano7df6dcf2009-09-13 09:51:17174statusHints::
Junio C Hamano644936c2012-06-28 23:05:14175Show directions on how to proceed from the current
Junio C Hamano917cd4f2012-12-04 23:41:10176state in the output of linkgit:git-status[1], in
Junio C Hamano644936c2012-06-28 23:05:14177the template shown when writing commit messages in
Junio C Hamano917cd4f2012-12-04 23:41:10178linkgit:git-commit[1], and in the help message shown
179by linkgit:git-checkout[1] when switching branch.
Junio C Hamano5e7f1312013-03-21 22:49:01180statusUoption::
181Advise to consider using the `-u` option to linkgit:git-status[1]
182when the command takes more than 2 seconds to enumerate untracked
183files.
Junio C Hamano5706e0b2009-11-24 10:54:16184commitBeforeMerge::
185Advice shown when linkgit:git-merge[1] refuses to
Junio C Hamano619596a2010-08-18 22:15:35186merge to avoid overwriting local changes.
Junio C Hamanoa9701f02010-01-21 00:42:16187resolveConflict::
Junio C Hamano5dab5a92013-02-25 18:51:24188Advice shown by various commands when conflicts
Junio C Hamanoa9701f02010-01-21 00:42:16189prevent the operation from being performed.
Junio C Hamanoa9701f02010-01-21 00:42:16190implicitIdentity::
191Advice on how to set your identity configuration when
192your information is guessed from the system username and
Junio C Hamano0df92712011-12-21 22:30:44193domain name.
Junio C Hamano74a198f2010-02-22 00:13:31194detachedHead::
Junio C Hamano0df92712011-12-21 22:30:44195Advice shown when you used linkgit:git-checkout[1] to
Junio C Hamano74a198f2010-02-22 00:13:31196move to the detach HEAD state, to instruct how to create
Junio C Hamano0df92712011-12-21 22:30:44197a local branch after the fact.
Junio C Hamanobb300642012-07-22 21:09:14198amWorkDir::
199Advice that shows the location of the patch file when
200linkgit:git-am[1] fails to apply it.
Junio C Hamano8ab94942013-06-24 21:55:30201rmHints::
202In case of failure in the output of linkgit:git-rm[1],
203show directions on how to proceed from the current state.
Junio C Hamano7df6dcf2009-09-13 09:51:17204--
205
Junio C Hamano07824ce2006-04-25 07:36:54206core.fileMode::
Junio C Hamanod2c28482014-10-24 22:28:25207Tells Git if the executable bit of files in the working tree
208is to be honored.
Junio C Hamano9df0c662009-11-23 11:09:27209+
Junio C Hamanod2c28482014-10-24 22:28:25210Some filesystems lose the executable bit when a file that is
211marked as executable is checked out, or checks out an
212non-executable file with executable bit on.
213linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
214to see if it handles the executable bit correctly
215and this variable is automatically set as necessary.
216+
217A repository, however, may be on a filesystem that handles
218the filemode correctly, and this variable is set to 'true'
219when created, but later may be made accessible from another
220environment that loses the filemode (e.g. exporting ext4 via
221CIFS mount, visiting a Cygwin created repository with
222Git for Windows or Eclipse).
223In such a case it may be necessary to set this variable to 'false'.
224See linkgit:git-update-index[1].
225+
226The default is true (when core.filemode is not specified in the config file).
Junio C Hamano07824ce2006-04-25 07:36:54227
Junio C Hamano9df0c662009-11-23 11:09:27228core.ignorecase::
229If true, this option enables various workarounds to enable
Junio C Hamano076ffcc2013-02-06 05:13:21230Git to work better on filesystems that are not case sensitive,
Junio C Hamano9df0c662009-11-23 11:09:27231like FAT. For example, if a directory listing finds
Junio C Hamano076ffcc2013-02-06 05:13:21232"makefile" when Git expects "Makefile", Git will assume
Junio C Hamano9df0c662009-11-23 11:09:27233it is really the same file, and continue to remember it as
234"Makefile".
235+
236The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
237will probe and set core.ignorecase true if appropriate when the repository
238is created.
239
Junio C Hamanob61a7772012-07-13 23:34:48240core.precomposeunicode::
Junio C Hamano076ffcc2013-02-06 05:13:21241This option is only used by Mac OS implementation of Git.
242When core.precomposeunicode=true, Git reverts the unicode decomposition
Junio C Hamanob61a7772012-07-13 23:34:48243of filenames done by Mac OS. This is useful when sharing a repository
244between Mac OS and Linux or Windows.
Junio C Hamano076ffcc2013-02-06 05:13:21245(Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
246When false, file names are handled fully transparent by Git,
247which is backward compatible with older versions of Git.
Junio C Hamanob61a7772012-07-13 23:34:48248
Junio C Hamano30758bd2014-12-18 20:44:14249core.protectHFS::
250If set to true, do not allow checkout of paths that would
251be considered equivalent to `.git` on an HFS+ filesystem.
252Defaults to `true` on Mac OS, and `false` elsewhere.
253
254core.protectNTFS::
255If set to true, do not allow checkout of paths that would
256cause problems with the NTFS filesystem, e.g. conflict with
2578.3 "short" names.
258Defaults to `true` on Windows, and `false` elsewhere.
259
Junio C Hamano90ccff32008-07-29 08:17:24260core.trustctime::
261If false, the ctime differences between the index and the
Junio C Hamano8fb66e52011-10-05 20:59:51262working tree are ignored; useful when the inode change time
Junio C Hamano90ccff32008-07-29 08:17:24263is regularly modified by something outside Git (file system
264crawlers and some backup systems).
265See linkgit:git-update-index[1]. True by default.
266
Junio C Hamano4cfed0c2013-01-30 17:58:54267core.checkstat::
268Determines which stat fields to match between the index
269and work tree. The user can set this to 'default' or
270'minimal'. Default (or explicitly 'default'), is to check
271all fields, including the sub-second part of mtime and ctime.
272
Junio C Hamanod526ba92007-07-02 00:17:42273core.quotepath::
Junio C Hamanoba4b9282008-07-06 05:20:31274The commands that output paths (e.g. 'ls-files',
275'diff'), when not given the `-z` option, will quote
Junio C Hamanod526ba92007-07-02 00:17:42276"unusual" characters in the pathname by enclosing the
277pathname in a double-quote pair and with backslashes the
278same way strings in C source code are quoted. If this
279variable is set to false, the bytes higher than 0x80 are
280not quoted but output as verbatim. Note that double
281quote, backslash and control characters are always
282quoted without `-z` regardless of the setting of this
283variable.
284
Junio C Hamanobb88cf42010-06-21 15:23:55285core.eol::
286Sets the line ending type to use in the working directory for
287files that have the `text` property set. Alternatives are
288'lf', 'crlf' and 'native', which uses the platform's native
289line ending. The default value is `native`. See
290linkgit:gitattributes[5] for more information on end-of-line
291conversion.
Junio C Hamanod9e0e5d2007-04-14 16:22:04292
Junio C Hamano26e590a2008-02-17 03:53:51293core.safecrlf::
Junio C Hamano076ffcc2013-02-06 05:13:21294If true, makes Git check if converting `CRLF` is reversible when
Junio C Hamanobb88cf42010-06-21 15:23:55295end-of-line conversion is active. Git will verify if a command
Junio C Hamano26e590a2008-02-17 03:53:51296modifies a file in the work tree either directly or indirectly.
297For example, committing a file followed by checking out the
298same file should yield the original file in the work tree. If
299this is not the case for the current setting of
Junio C Hamano076ffcc2013-02-06 05:13:21300`core.autocrlf`, Git will reject the file. The variable can
301be set to "warn", in which case Git will only warn about an
Junio C Hamano26e590a2008-02-17 03:53:51302irreversible conversion but continue the operation.
303+
304CRLF conversion bears a slight chance of corrupting data.
Junio C Hamano076ffcc2013-02-06 05:13:21305When it is enabled, Git will convert CRLF to LF during commit and LF to
Junio C Hamano26e590a2008-02-17 03:53:51306CRLF during checkout. A file that contains a mixture of LF and
Junio C Hamano076ffcc2013-02-06 05:13:21307CRLF before the commit cannot be recreated by Git. For text
Junio C Hamano26e590a2008-02-17 03:53:51308files this is the right thing to do: it corrects line endings
309such that we have only LF line endings in the repository.
310But for binary files that are accidentally classified as text the
311conversion can corrupt data.
312+
313If you recognize such corruption early you can easily fix it by
314setting the conversion type explicitly in .gitattributes. Right
315after committing you still have the original file in your work
316tree and this file is not yet corrupted. You can explicitly tell
Junio C Hamano076ffcc2013-02-06 05:13:21317Git that this file is binary and Git will handle the file
Junio C Hamano26e590a2008-02-17 03:53:51318appropriately.
319+
320Unfortunately, the desired effect of cleaning up text files with
321mixed line endings and the undesired effect of corrupting binary
322files cannot be distinguished. In both cases CRLFs are removed
323in an irreversible way. For text files this is the right thing
324to do because CRLFs are line endings, while for binary files
325converting CRLFs corrupts data.
326+
327Note, this safety check does not mean that a checkout will generate a
328file identical to the original file for a different setting of
Junio C Hamanobb88cf42010-06-21 15:23:55329`core.eol` and `core.autocrlf`, but only for the current one. For
330example, a text file with `LF` would be accepted with `core.eol=lf`
331and could later be checked out with `core.eol=crlf`, in which case the
Junio C Hamano26e590a2008-02-17 03:53:51332resulting file would contain `CRLF`, although the original file
333contained `LF`. However, in both work trees the line endings would be
334consistent, that is either all `LF` or all `CRLF`, but never mixed. A
335file with mixed line endings would be reported by the `core.safecrlf`
336mechanism.
337
Junio C Hamanobb88cf42010-06-21 15:23:55338core.autocrlf::
339Setting this variable to "true" is almost the same as setting
340the `text` attribute to "auto" on all files except that text
341files are not guaranteed to be normalized: files that contain
342`CRLF` in the repository will not be touched. Use this
343setting if you want to have `CRLF` line endings in your
344working directory even though the repository does not have
345normalized line endings. This variable can be set to 'input',
346in which case no output conversion is performed.
347
Junio C Hamanoaa83a7d2007-03-05 02:37:29348core.symlinks::
349If false, symbolic links are checked out as small plain files that
Junio C Hamano35738e82008-01-07 07:55:46350contain the link text. linkgit:git-update-index[1] and
351linkgit:git-add[1] will not change the recorded type to regular
Junio C Hamanoaa83a7d2007-03-05 02:37:29352file. Useful on filesystems like FAT that do not support
Junio C Hamano9df0c662009-11-23 11:09:27353symbolic links.
354+
355The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
356will probe and set core.symlinks false if appropriate when the repository
357is created.
Junio C Hamanoaa83a7d2007-03-05 02:37:29358
Junio C Hamano07824ce2006-04-25 07:36:54359core.gitProxy::
360A "proxy command" to execute (as 'command host port') instead
361of establishing direct connection to the remote server when
Junio C Hamano076ffcc2013-02-06 05:13:21362using the Git protocol for fetching. If the variable value is
Junio C Hamano07824ce2006-04-25 07:36:54363in the "COMMAND for DOMAIN" format, the command is applied only
364on hostnames ending with the specified domain string. This variable
365may be set multiple times and is matched in the given order;
366the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17367+
368Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
369(which always applies universally, without the special "for"
370handling).
Junio C Hamanoea82cff2009-03-18 01:54:48371+
372The special string `none` can be used as the proxy command to
373specify that no proxy be used for a given domain pattern.
374This is useful for excluding servers inside a firewall from
375proxy use, while defaulting to a common proxy for external domains.
Junio C Hamano07824ce2006-04-25 07:36:54376
377core.ignoreStat::
Junio C Hamano054ea082008-06-01 08:26:34378If true, commands which modify both the working tree and the index
379will mark the updated paths with the "assume unchanged" bit in the
380index. These marked files are then assumed to stay unchanged in the
Junio C Hamano8fb66e52011-10-05 20:59:51381working tree, until you mark them otherwise manually - Git will not
Junio C Hamano054ea082008-06-01 08:26:34382detect the file changes by lstat() calls. This is useful on systems
383where those are very slow, such as Microsoft Windows.
384See linkgit:git-update-index[1].
Junio C Hamano07824ce2006-04-25 07:36:54385False by default.
386
Junio C Hamano88a3a072006-05-04 08:01:43387core.preferSymlinkRefs::
388Instead of the default "symref" format for HEAD
389and other symbolic reference files, use symbolic links.
390This is sometimes needed to work with old scripts that
391expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54392
Junio C Hamano1025e752007-02-23 07:21:26393core.bare::
394If true this repository is assumed to be 'bare' and has no
395working directory associated with it. If this is the case a
396number of commands that require a working directory will be
Junio C Hamano35738e82008-01-07 07:55:46397disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Junio C Hamano1025e752007-02-23 07:21:26398+
Junio C Hamano35738e82008-01-07 07:55:46399This setting is automatically guessed by linkgit:git-clone[1] or
400linkgit:git-init[1] when the repository was created. By default a
Junio C Hamano1025e752007-02-23 07:21:26401repository that ends in "/.git" is assumed to be not bare (bare =
402false), while all other repositories are assumed to be bare (bare
403= true).
404
Junio C Hamanod526ba92007-07-02 00:17:42405core.worktree::
Junio C Hamano80d58462011-01-24 22:52:52406Set the path to the root of the working tree.
Junio C Hamano764a6672007-10-23 01:23:31407This can be overridden by the GIT_WORK_TREE environment
Junio C Hamanoe1aeb5e2014-06-06 19:16:29408variable and the '--work-tree' command-line option.
Junio C Hamano5cd15182011-04-05 00:21:10409The value can be an absolute path or relative to the path to
Junio C Hamano80d58462011-01-24 22:52:52410the .git directory, which is either specified by --git-dir
411or GIT_DIR, or automatically discovered.
412If --git-dir or GIT_DIR is specified but none of
Junio C Hamano7d575a52008-04-30 08:45:27413--work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamano80d58462011-01-24 22:52:52414the current working directory is regarded as the top level
Junio C Hamano3609b332010-12-29 01:34:52415of your working tree.
Junio C Hamano80d58462011-01-24 22:52:52416+
417Note that this variable is honored even when set in a configuration
418file in a ".git" subdirectory of a directory and its value differs
419from the latter directory (e.g. "/path/to/.git/config" has
420core.worktree set to "/different/path"), which is most likely a
Junio C Hamano076ffcc2013-02-06 05:13:21421misconfiguration. Running Git commands in the "/path/to" directory will
Junio C Hamano80d58462011-01-24 22:52:52422still use "/different/path" as the root of the work tree and can cause
423confusion unless you know what you are doing (e.g. you are creating a
424read-only snapshot of the same index to a location different from the
425repository's usual working tree).
Junio C Hamanod526ba92007-07-02 00:17:42426
Junio C Hamano341071d2006-06-04 07:24:48427core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49428Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamanoa2ec14f2006-11-02 00:22:48429"$GIT_DIR/logs/<ref>", by appending the new and old
Junio C Hamanoe3f080d2013-04-22 02:27:13430SHA-1, the date/time and the reason of the update, but
Junio C Hamanoa2ec14f2006-11-02 00:22:48431only when the file exists. If this configuration
432variable is set to true, missing "$GIT_DIR/logs/<ref>"
Junio C Hamano15567bc2011-07-23 00:51:59433file is automatically created for branch heads (i.e. under
434refs/heads/), remote refs (i.e. under refs/remotes/),
435note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
Junio C Hamano1caaf472006-12-31 08:29:35436+
437This information can be used to determine what commit
438was the tip of a branch "2 days ago".
439+
440This value is true by default in a repository that has
441a working directory associated with it, and false by
442default in a bare repository.
Junio C Hamano341071d2006-06-04 07:24:48443
Junio C Hamano07824ce2006-04-25 07:36:54444core.repositoryFormatVersion::
445Internal variable identifying the repository format and layout
446version.
447
448core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42449When 'group' (or 'true'), the repository is made shareable between
450several users in a group (making sure all the files and objects are
451group-writable). When 'all' (or 'world' or 'everybody'), the
452repository will be readable by all users, additionally to being
Junio C Hamano076ffcc2013-02-06 05:13:21453group-shareable. When 'umask' (or 'false'), Git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37454reported by umask(2). When '0xxx', where '0xxx' is an octal number,
455files in the repository will have this mode value. '0xxx' will override
Junio C Hamano83eded12009-04-20 08:18:00456user's umask value (whereas the other options will only override
457requested parts of the user's umask value). Examples: '0660' will make
458the repo read/write-able for the owner and group, but inaccessible to
459others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Junio C Hamano2f102bb2008-04-26 02:23:37460repository that is group-readable but not group-writable.
461See linkgit:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54462
463core.warnAmbiguousRefs::
Junio C Hamano076ffcc2013-02-06 05:13:21464If true, Git will warn you if the ref name you passed it is ambiguous
Junio C Hamano947ab822013-03-19 23:07:29465and might match multiple refs in the repository. True by default.
Junio C Hamano07824ce2006-04-25 07:36:54466
Junio C Hamano7ec15722006-07-07 02:03:59467core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09468An integer -1..9, indicating a default compression level.
469-1 is the zlib default. 0 means no compression,
470and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42471If set, this provides a default to other compression variables,
472such as 'core.loosecompression' and 'pack.compression'.
Junio C Hamanoa126a3b2006-07-04 04:55:26473
Junio C Hamanof2ce2972007-05-20 19:12:09474core.loosecompression::
475An integer -1..9, indicating the compression level for objects that
476are not in a pack file. -1 is the zlib default. 0 means no
477compression, and 1..9 are various speed/size tradeoffs, 9 being
478slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42479not set, defaults to 1 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49480
Junio C Hamanofc4d38c2007-01-08 06:53:32481core.packedGitWindowSize::
482Number of bytes of a pack file to map into memory in a
483single mapping operation. Larger window sizes may allow
484your system to process a smaller number of large pack files
485more quickly. Smaller window sizes will negatively affect
486performance due to increased calls to the operating system's
487memory manager, but may improve performance when accessing
488a large number of large pack files.
489+
490Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
491MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
492be reasonable for all users/operating systems. You probably do
493not need to adjust this value.
494+
495Common unit suffixes of 'k', 'm', or 'g' are supported.
496
497core.packedGitLimit::
498Maximum number of bytes to map simultaneously into memory
499from pack files. If Git needs to access more than this many
500bytes at once to complete an operation it will unmap existing
501regions to reclaim virtual address space within the process.
502+
503Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
504This should be reasonable for all users/operating systems, except on
505the largest projects. You probably do not need to adjust this value.
506+
507Common unit suffixes of 'k', 'm', or 'g' are supported.
508
Junio C Hamanob8c51282007-03-19 10:43:30509core.deltaBaseCacheLimit::
510Maximum number of bytes to reserve for caching base objects
Junio C Hamano619596a2010-08-18 22:15:35511that may be referenced by multiple deltified objects. By storing the
Junio C Hamanob8c51282007-03-19 10:43:30512entire decompressed base objects in a cache Git is able
513to avoid unpacking and decompressing frequently used base
514objects multiple times.
515+
Junio C Hamanoe1aeb5e2014-06-06 19:16:29516Default is 96 MiB on all platforms. This should be reasonable
Junio C Hamanob8c51282007-03-19 10:43:30517for all users/operating systems, except on the largest projects.
518You probably do not need to adjust this value.
519+
520Common unit suffixes of 'k', 'm', or 'g' are supported.
521
Junio C Hamano5c246f22010-02-03 07:34:53522core.bigFileThreshold::
523Files larger than this size are stored deflated, without
524attempting delta compression. Storing large files without
525delta compression avoids excessive memory usage, at the
Junio C Hamano8e61f1f2014-09-11 21:53:45526slight expense of increased disk usage. Additionally files
527larger than this size are always treated as binary.
Junio C Hamano5c246f22010-02-03 07:34:53528+
529Default is 512 MiB on all platforms. This should be reasonable
530for most projects as source code and other text files can still
531be delta compressed, but larger binary media files won't be.
532+
533Common unit suffixes of 'k', 'm', or 'g' are supported.
Junio C Hamano5c246f22010-02-03 07:34:53534
Junio C Hamano1d90cb02007-07-03 07:05:31535core.excludesfile::
Junio C Hamano5e284b42007-05-22 07:23:37536In addition to '.gitignore' (per-directory) and
Junio C Hamano076ffcc2013-02-06 05:13:21537'.git/info/exclude', Git looks into this file for patterns
Junio C Hamanob76a6862012-05-02 22:02:46538of files which are not meant to be tracked. "`~/`" is expanded
539to the value of `$HOME` and "`~user/`" to the specified user's
Junio C Hamano8edb4c72012-07-09 20:33:55540home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
541If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
542is used instead. See linkgit:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37543
Junio C Hamano3fd7b262010-09-08 22:44:20544core.askpass::
545Some commands (e.g. svn and http interfaces) that interactively
546ask for a password can be told to use an external program given
547via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
548environment variable. If not set, fall back to the value of the
549'SSH_ASKPASS' environment variable or, failing that, a simple password
550prompt. The external program shall be given a suitable prompt as
Junio C Hamanoe1aeb5e2014-06-06 19:16:29551command-line argument and write the password on its STDOUT.
Junio C Hamano3fd7b262010-09-08 22:44:20552
Junio C Hamano3b4609d2010-09-30 00:04:34553core.attributesfile::
554In addition to '.gitattributes' (per-directory) and
Junio C Hamano076ffcc2013-02-06 05:13:21555'.git/info/attributes', Git looks into this file for attributes
Junio C Hamano3b4609d2010-09-30 00:04:34556(see linkgit:gitattributes[5]). Path expansions are made the same
Junio C Hamano8edb4c72012-07-09 20:33:55557way as for `core.excludesfile`. Its default value is
558$XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
559set or empty, $HOME/.config/git/attributes is used instead.
Junio C Hamano3b4609d2010-09-30 00:04:34560
Junio C Hamanof6002a92007-07-20 10:28:22561core.editor::
562Commands such as `commit` and `tag` that lets you edit
Junio C Hamanoa6387422007-08-25 03:54:27563messages by launching an editor uses the value of this
Junio C Hamanof6002a92007-07-20 10:28:22564variable when it is set, and the environment variable
Junio C Hamano3b70d3c2009-11-21 17:37:37565`GIT_EDITOR` is not set. See linkgit:git-var[1].
Junio C Hamanof6002a92007-07-20 10:28:22566
Junio C Hamano3f2ed6f2013-02-04 19:24:09567core.commentchar::
568Commands such as `commit` and `tag` that lets you edit
569messages consider a line that begins with this character
570commented, and removes them after the editor returns
571(default '#').
Junio C Hamanoe1aeb5e2014-06-06 19:16:29572+
573If set to "auto", `git-commit` would select a character that is not
574the beginning character of any line in existing commit messages.
Junio C Hamano3f2ed6f2013-02-04 19:24:09575
Junio C Hamano6231f822011-10-24 05:18:52576sequence.editor::
Junio C Hamano778a3412013-03-28 23:24:30577Text editor used by `git rebase -i` for editing the rebase instruction file.
Junio C Hamano6231f822011-10-24 05:18:52578The value is meant to be interpreted by the shell when it is used.
579It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
580When not configured the default commit message editor is used instead.
581
Junio C Hamano28d8ede2007-07-05 05:51:38582core.pager::
Junio C Hamano0e0e0d22013-09-12 23:25:03583Text viewer for use by Git commands (e.g., 'less'). The value
584is meant to be interpreted by the shell. The order of preference
585is the `$GIT_PAGER` environment variable, then `core.pager`
586configuration, then `$PAGER`, and then the default chosen at
587compile time (usually 'less').
588+
Junio C Hamanoe1aeb5e2014-06-06 19:16:29589When the `LESS` environment variable is unset, Git sets it to `FRX`
Junio C Hamano0e0e0d22013-09-12 23:25:03590(if `LESS` environment variable is set, Git does not change it at
591all). If you want to selectively override Git's default setting
Junio C Hamanoe1aeb5e2014-06-06 19:16:29592for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
Junio C Hamano0e0e0d22013-09-12 23:25:03593be passed to the shell by Git, which will translate the final
Junio C Hamanoe1aeb5e2014-06-06 19:16:29594command to `LESS=FRX less -S`. The environment does not set the
595`S` option but the command line does, instructing less to truncate
596long lines. Similarly, setting `core.pager` to `less -+F` will
597deactivate the `F` option specified by the environment from the
598command-line, deactivating the "quit if one screen" behavior of
599`less`. One can specifically activate some flags for particular
600commands: for example, setting `pager.blame` to `less -S` enables
601line truncation only for `git blame`.
Junio C Hamanobc8d4782014-01-13 23:35:50602+
603Likewise, when the `LV` environment variable is unset, Git sets it
604to `-c`. You can override this setting by exporting `LV` with
605another value or setting `core.pager` to `lv +c`.
Junio C Hamano28d8ede2007-07-05 05:51:38606
Junio C Hamano942b35e2007-12-09 10:19:33607core.whitespace::
608A comma separated list of common whitespace problems to
Junio C Hamano1aa40d22010-01-21 17:46:43609notice. 'git diff' will use `color.diff.whitespace` to
610highlight them, and 'git apply --whitespace=error' will
Junio C Hamano3db8b412008-07-26 06:45:59611consider them as errors. You can prefix `-` to disable
612any of them (e.g. `-trailing-space`):
Junio C Hamano942b35e2007-12-09 10:19:33613+
Junio C Hamanob71a22d2009-10-17 08:23:47614* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano942b35e2007-12-09 10:19:33615 as an error (enabled by default).
616* `space-before-tab` treats a space character that appears immediately
617 before a tab character in the initial indent part of the line as an
618 error (enabled by default).
Junio C Hamano281fd392012-09-17 23:57:41619* `indent-with-non-tab` treats a line that is indented with space
620 characters instead of the equivalent tabs as an error (not enabled by
621 default).
Junio C Hamanocb39aea2010-05-09 07:24:48622* `tab-in-indent` treats a tab character in the initial indent part of
623 the line as an error (not enabled by default).
Junio C Hamanob71a22d2009-10-17 08:23:47624* `blank-at-eof` treats blank lines added at the end of file as an error
625 (enabled by default).
626* `trailing-space` is a short-hand to cover both `blank-at-eol` and
627 `blank-at-eof`.
Junio C Hamano601f3e52008-02-25 08:40:42628* `cr-at-eol` treats a carriage-return at the end of line as
629 part of the line terminator, i.e. with it, `trailing-space`
630 does not trigger if the character before such a carriage-return
631 is not a whitespace (not enabled by default).
Junio C Hamanoeef01fe2010-12-13 08:31:58632* `tabwidth=<n>` tells how many character positions a tab occupies; this
Junio C Hamano076ffcc2013-02-06 05:13:21633 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
Junio C Hamanoeef01fe2010-12-13 08:31:58634 errors. The default tab width is 8. Allowed values are 1 to 63.
Junio C Hamano942b35e2007-12-09 10:19:33635
Junio C Hamano9eb57532008-06-26 06:33:46636core.fsyncobjectfiles::
637This boolean will enable 'fsync()' when writing object files.
638+
639This is a total waste of time and effort on a filesystem that orders
640data writes properly, but can be useful for filesystems that do not use
641journalling (traditional UNIX filesystems) or that only journal metadata
642and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
643
Junio C Hamano610d1762008-11-28 06:27:13644core.preloadindex::
645Enable parallel index preload for operations like 'git diff'
646+
647This can speed up operations like 'git diff' and 'git status' especially
648on filesystems like NFS that have weak caching semantics and thus
Junio C Hamanoc8c398a2014-06-16 21:14:05649relatively high IO latencies. When enabled, Git will do the
Junio C Hamano610d1762008-11-28 06:27:13650index comparison to the filesystem data in parallel, allowing
Junio C Hamanoc8c398a2014-06-16 21:14:05651overlapping IO's. Defaults to true.
Junio C Hamano610d1762008-11-28 06:27:13652
Junio C Hamanoa9499de2009-04-30 03:38:48653core.createObject::
654You can set this to 'link', in which case a hardlink followed by
655a delete of the source are used to make sure that object creation
656will not overwrite existing objects.
657+
658On some file system/operating system combinations, this is unreliable.
659Set this config setting to 'rename' there; However, This will remove the
660check that makes sure that existing object files will not get overwritten.
Junio C Hamanoe91ea772009-04-26 01:41:41661
Junio C Hamano3b70d3c2009-11-21 17:37:37662core.notesRef::
663When showing commit messages, also show notes which are stored in
Junio C Hamanoa574a092010-06-13 19:57:10664the given ref. The ref must be fully qualified. If the given
665ref does not exist, it is not an error but means that no
666notes should be printed.
Junio C Hamano3b70d3c2009-11-21 17:37:37667+
Junio C Hamanoa574a092010-06-13 19:57:10668This setting defaults to "refs/notes/commits", and it can be overridden by
669the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
Junio C Hamano3b70d3c2009-11-21 17:37:37670
Junio C Hamano3c8d6702010-01-13 23:09:03671core.sparseCheckout::
672Enable "sparse checkout" feature. See section "Sparse checkout" in
673linkgit:git-read-tree[1] for more information.
674
Junio C Hamano6371b0e2011-03-23 23:36:21675core.abbrev::
676Set the length object names are abbreviated to. If unspecified,
677many commands abbreviate to 7 hexdigits, which may not be enough
678for abbreviated object names to stay unique for sufficiently long
679time.
680
Junio C Hamano3d141512009-06-01 01:22:40681add.ignore-errors::
Junio C Hamano60186642010-12-02 14:18:26682add.ignoreErrors::
Junio C Hamano1aa40d22010-01-21 17:46:43683Tells 'git add' to continue adding files when some files cannot be
Junio C Hamano3d141512009-06-01 01:22:40684added due to indexing errors. Equivalent to the '--ignore-errors'
Junio C Hamano076ffcc2013-02-06 05:13:21685option of linkgit:git-add[1]. Older versions of Git accept only
Junio C Hamano60186642010-12-02 14:18:26686`add.ignore-errors`, which does not follow the usual naming
Junio C Hamano076ffcc2013-02-06 05:13:21687convention for configuration variables. Newer versions of Git
Junio C Hamano60186642010-12-02 14:18:26688honor `add.ignoreErrors` as well.
Junio C Hamano3d141512009-06-01 01:22:40689
Junio C Hamano33db4372006-06-07 19:51:45690alias.*::
Junio C Hamano35738e82008-01-07 07:55:46691Command aliases for the linkgit:git[1] command wrapper - e.g.
Junio C Hamano33db4372006-06-07 19:51:45692after defining "alias.last = cat-file commit HEAD", the invocation
693"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17694confusion and troubles with script usage, aliases that
Junio C Hamano076ffcc2013-02-06 05:13:21695hide existing Git commands are ignored. Arguments are split by
Junio C Hamanof1d14802006-06-08 00:48:17696spaces, the usual shell quoting and escaping is supported.
Junio C Hamano2efd5e42014-11-10 22:38:52697A quote pair or a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39698+
699If the alias expansion is prefixed with an exclamation point,
700it will be treated as a shell command. For example, defining
701"alias.new = !gitk --all --not ORIG_HEAD", the invocation
702"git new" is equivalent to running the shell command
Junio C Hamano48bc1ce2009-07-09 16:49:19703"gitk --all --not ORIG_HEAD". Note that shell commands will be
704executed from the top-level directory of a repository, which may
705not necessarily be the current directory.
Junio C Hamano5f2627d2011-05-06 20:23:48706'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
707from the original current directory. See linkgit:git-rev-parse[1].
Junio C Hamano9cb74f22007-02-12 04:15:05708
Junio C Hamanocaa712a2010-03-11 01:17:35709am.keepcr::
710If true, git-am will call git-mailsplit for patches in mbox format
711with parameter '--keep-cr'. In this case git-mailsplit will
Junio C Hamano619596a2010-08-18 22:15:35712not remove `\r` from lines ending with `\r\n`. Can be overridden
Junio C Hamanocaa712a2010-03-11 01:17:35713by giving '--no-keep-cr' from the command line.
714See linkgit:git-am[1], linkgit:git-mailsplit[1].
715
Junio C Hamanofe24db02009-08-22 05:10:47716apply.ignorewhitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43717When set to 'change', tells 'git apply' to ignore changes in
Junio C Hamanofe24db02009-08-22 05:10:47718whitespace, in the same way as the '--ignore-space-change'
719option.
Junio C Hamano1aa40d22010-01-21 17:46:43720When set to one of: no, none, never, false tells 'git apply' to
Junio C Hamanofe24db02009-08-22 05:10:47721respect all whitespace differences.
722See linkgit:git-apply[1].
723
Junio C Hamano07824ce2006-04-25 07:36:54724apply.whitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43725Tells 'git apply' how to handle whitespaces, in the same way
Junio C Hamano35738e82008-01-07 07:55:46726as the '--whitespace' option. See linkgit:git-apply[1].
Junio C Hamano07824ce2006-04-25 07:36:54727
Junio C Hamano7fd84172007-05-24 07:00:32728branch.autosetupmerge::
Junio C Hamano1aa40d22010-01-21 17:46:43729Tells 'git branch' and 'git checkout' to set up new branches
Junio C Hamano24bc09a2008-02-28 00:27:44730so that linkgit:git-pull[1] will appropriately merge from the
731starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32732this behavior can be chosen per-branch using the `--track`
Junio C Hamano24bc09a2008-02-28 00:27:44733and `--no-track` options. The valid settings are: `false` -- no
734automatic setup is done; `true` -- automatic setup is done when the
Junio C Hamano97bcb482010-11-25 03:16:07735starting point is a remote-tracking branch; `always` --
736automatic setup is done when the starting point is either a
737local branch or remote-tracking
Junio C Hamano24bc09a2008-02-28 00:27:44738branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32739
Junio C Hamano869bb802008-05-12 00:29:47740branch.autosetuprebase::
Junio C Hamano1aa40d22010-01-21 17:46:43741When a new branch is created with 'git branch' or 'git checkout'
Junio C Hamano076ffcc2013-02-06 05:13:21742that tracks another branch, this variable tells Git to set
Junio C Hamano869bb802008-05-12 00:29:47743up pull to rebase instead of merge (see "branch.<name>.rebase").
744When `never`, rebase is never automatically set to true.
745When `local`, rebase is set to true for tracked branches of
746other local branches.
747When `remote`, rebase is set to true for tracked branches of
Junio C Hamano97bcb482010-11-25 03:16:07748remote-tracking branches.
Junio C Hamano869bb802008-05-12 00:29:47749When `always`, rebase will be set to true for all tracking
750branches.
751See "branch.autosetupmerge" for details on how to set up a
752branch to track another branch.
753This option defaults to never.
754
Junio C Hamano47c1e3c2006-09-25 04:45:55755branch.<name>.remote::
Junio C Hamano63b6fdb2013-04-07 23:37:13756When on branch <name>, it tells 'git fetch' and 'git push'
757which remote to fetch from/push to. The remote to push to
758may be overridden with `remote.pushdefault` (for all branches).
759The remote to push to, for the current branch, may be further
760overridden by `branch.<name>.pushremote`. If no remote is
761configured, or if you are not on any branch, it defaults to
762`origin` for fetching and `remote.pushdefault` for pushing.
Junio C Hamano238ce9c2013-10-23 21:56:38763Additionally, `.` (a period) is the current local repository
764(a dot-repository), see `branch.<name>.merge`'s final note below.
Junio C Hamano63b6fdb2013-04-07 23:37:13765
766branch.<name>.pushremote::
767When on branch <name>, it overrides `branch.<name>.remote` for
768pushing. It also overrides `remote.pushdefault` for pushing
769from branch <name>. When you pull from one place (e.g. your
770upstream) and push to another place (e.g. your own publishing
771repository), you would want to set `remote.pushdefault` to
772specify the remote to push to for all branches, and use this
773option to override it for a specific branch.
Junio C Hamano47c1e3c2006-09-25 04:45:55774
775branch.<name>.merge::
Junio C Hamano0706c802009-03-30 22:34:19776Defines, together with branch.<name>.remote, the upstream branch
Junio C Hamanob02377c2011-04-28 22:26:02777for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
Junio C Hamano1aa40d22010-01-21 17:46:43778branch to merge and can also affect 'git push' (see push.default).
779When in branch <name>, it tells 'git fetch' the default
Junio C Hamanoc2b47092007-10-25 06:50:31780refspec to be marked for merging in FETCH_HEAD. The value is
781handled like the remote part of a refspec, and must match a
782ref which is fetched from the remote given by
783"branch.<name>.remote".
Junio C Hamano1aa40d22010-01-21 17:46:43784The merge information is used by 'git pull' (which at first calls
785'git fetch') to lookup the default branch for merging. Without
786this option, 'git pull' defaults to merge the first refspec fetched.
Junio C Hamano96010b22006-12-09 21:15:46787Specify multiple values to get an octopus merge.
Junio C Hamano1aa40d22010-01-21 17:46:43788If you wish to setup 'git pull' so that it merges into <name> from
Junio C Hamano6e149c02007-03-16 10:21:07789another branch in the local repository, you can point
Junio C Hamano238ce9c2013-10-23 21:56:38790branch.<name>.merge to the desired branch, and use the relative path
791setting `.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:55792
Junio C Hamano1b50ce92007-10-03 12:05:53793branch.<name>.mergeoptions::
794Sets default options for merging into branch <name>. The syntax and
Junio C Hamanoc0e55e72009-10-10 00:56:29795supported options are the same as those of linkgit:git-merge[1], but
Junio C Hamano1b50ce92007-10-03 12:05:53796option values containing whitespace characters are currently not
797supported.
798
Junio C Hamano0c999702007-12-03 09:57:55799branch.<name>.rebase::
800When true, rebase the branch <name> on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:08801instead of merging the default branch from the default remote when
Junio C Hamano515ab1d2011-12-09 23:41:20802"git pull" is run. See "pull.rebase" for doing this in a non
803branch-specific manner.
804+
Junio C Hamanocf4a1742013-09-11 22:57:50805When preserve, also pass `--preserve-merges` along to 'git rebase'
806so that locally committed merge commits will not be flattened
807by running 'git pull'.
808+
Junio C Hamano515ab1d2011-12-09 23:41:20809*NOTE*: this is a possibly dangerous operation; do *not* use
810it unless you understand the implications (see linkgit:git-rebase[1]
811for details).
Junio C Hamano0c999702007-12-03 09:57:55812
Junio C Hamano46247182013-01-09 20:50:28813branch.<name>.description::
814Branch description, can be edited with
815`git branch --edit-description`. Branch description is
816automatically added in the format-patch cover letter or
817request-pull summary.
818
Junio C Hamano8760ea62008-03-14 08:58:45819browser.<tool>.cmd::
820Specify the command to invoke the specified browser. The
821specified command is evaluated in shell with the URLs passed
Junio C Hamano360e3a12011-07-13 23:51:56822as arguments. (See linkgit:git-web{litdd}browse[1].)
Junio C Hamano8760ea62008-03-14 08:58:45823
Junio C Hamanoe35a6fc2008-01-29 09:46:27824browser.<tool>.path::
825Override the path for the given tool that may be used to
826browse HTML help (see '-w' option in linkgit:git-help[1]) or a
827working repository in gitweb (see linkgit:git-instaweb[1]).
828
Junio C Hamano47b9acd2007-04-24 07:34:34829clean.requireForce::
Junio C Hamanoe6f28d02013-09-17 21:34:00830A boolean to make git-clean do nothing unless given -f,
831-i or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:34832
Junio C Hamanoeb692952007-01-03 22:02:12833color.branch::
834A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46835linkgit:git-branch[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21836`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoeb692952007-01-03 22:02:12837only when the output is to a terminal. Defaults to false.
838
839color.branch.<slot>::
840Use customized color for branch coloration. `<slot>` is one of
841`current` (the current branch), `local` (a local branch),
Junio C Hamano76927822013-04-19 21:26:57842`remote` (a remote-tracking branch in refs/remotes/),
843`upstream` (upstream tracking branch), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:22844refs).
845+
846The value for these configuration variables is a list of colors (at most
847two) and attributes (at most one), separated by spaces. The colors
848accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
849`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
850`blink` and `reverse`. The first color given is the foreground; the
851second is the background. The position of the attribute, if any,
Junio C Hamano6df93d92014-12-22 22:48:09852doesn't matter. Attributes may be turned off specifically by prefixing
853them with `no` (e.g., `noreverse`, `noul`, etc).
Junio C Hamanoe3b2b332014-12-12 23:34:53854+
855Colors (foreground and background) may also be given as numbers between
8560 and 255; these use ANSI 256-color mode (but note that not all
Junio C Hamano6df93d92014-12-22 22:48:09857terminals may support this). If your terminal supports it, you may also
858specify 24-bit RGB values as hex, like `#ff0ab3`.
Junio C Hamanoeb692952007-01-03 22:02:12859
Junio C Hamano3f403b02006-12-13 10:14:13860color.diff::
Junio C Hamano5f2627d2011-05-06 20:23:48861Whether to use ANSI escape sequences to add color to patches.
862If this is set to `always`, linkgit:git-diff[1],
863linkgit:git-log[1], and linkgit:git-show[1] will use color
864for all patches. If it is set to `true` or `auto`, those
865commands will only use color when output is to the terminal.
866Defaults to false.
867+
Junio C Hamanod75148a2014-04-08 19:48:38868This does not affect linkgit:git-format-patch[1] or the
Junio C Hamano5f2627d2011-05-06 20:23:48869'git-diff-{asterisk}' plumbing commands. Can be overridden on the
870command line with the `--color[=<when>]` option.
Junio C Hamano9ae1a062006-07-10 08:12:34871
Junio C Hamano3f403b02006-12-13 10:14:13872color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:22873Use customized color for diff colorization. `<slot>` specifies
874which part of the patch to use the specified color, and is one
875of `plain` (context text), `meta` (metainformation), `frag`
Junio C Hamano2bd8a742009-12-01 21:16:59876(hunk header), 'func' (function in hunk header), `old` (removed lines),
877`new` (added lines), `commit` (commit headers), or `whitespace`
878(highlighting whitespace errors). The values of these variables may be
879specified as in color.branch.<slot>.
Junio C Hamano9ae1a062006-07-10 08:12:34880
Junio C Hamano7d449522010-07-01 00:08:51881color.decorate.<slot>::
882Use customized color for 'git log --decorate' output. `<slot>` is one
883of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
Junio C Hamano97bcb482010-11-25 03:16:07884branches, remote-tracking branches, tags, stash and HEAD, respectively.
Junio C Hamano7d449522010-07-01 00:08:51885
Junio C Hamanod257cff2009-03-18 05:27:16886color.grep::
887When set to `always`, always highlight matches. When `false` (or
888`never`), never. When set to `true` or `auto`, use color only
889when the output is written to the terminal. Defaults to `false`.
890
Junio C Hamano0299d922010-03-20 20:59:31891color.grep.<slot>::
892Use customized color for grep colorization. `<slot>` specifies which
893part of the line to use the specified color, and is one of
894+
895--
896`context`;;
897non-matching text in context lines (when using `-A`, `-B`, or `-C`)
898`filename`;;
899filename prefix (when not using `-h`)
900`function`;;
901function name lines (when using `-p`)
902`linenumber`;;
903line number prefix (when using `-n`)
904`match`;;
Junio C Hamanoc14e6ad2014-10-31 20:25:53905matching text (same as setting `matchContext` and `matchSelected`)
906`matchContext`;;
907matching text in context lines
908`matchSelected`;;
909matching text in selected lines
Junio C Hamano0299d922010-03-20 20:59:31910`selected`;;
911non-matching text in selected lines
912`separator`;;
913separators between fields on a line (`:`, `-`, and `=`)
914and between hunks (`--`)
915--
916+
917The values of these variables may be specified as in color.branch.<slot>.
Junio C Hamanod257cff2009-03-18 05:27:16918
Junio C Hamano00b8b632007-12-07 09:50:49919color.interactive::
Junio C Hamano35738e82008-01-07 07:55:46920When set to `always`, always use colors for interactive prompts
Junio C Hamano58f587a2013-07-22 19:20:59921and displays (such as those used by "git-add --interactive" and
922"git-clean --interactive"). When false (or `never`), never.
923When set to `true` or `auto`, use colors only when the output is
924to the terminal. Defaults to false.
Junio C Hamano00b8b632007-12-07 09:50:49925
926color.interactive.<slot>::
Junio C Hamano58f587a2013-07-22 19:20:59927Use customized color for 'git add --interactive' and 'git clean
928--interactive' output. `<slot>` may be `prompt`, `header`, `help`
929or `error`, for four distinct types of normal output from
930interactive commands. The values of these variables may be
931specified as in color.branch.<slot>.
Junio C Hamano00b8b632007-12-07 09:50:49932
Junio C Hamanoe7935c42006-12-13 21:32:17933color.pager::
934A boolean to enable/disable colored output when the pager is in
935use (default is true).
936
Junio C Hamano52ba2952009-05-18 17:43:02937color.showbranch::
938A boolean to enable/disable color in the output of
939linkgit:git-show-branch[1]. May be set to `always`,
940`false` (or `never`) or `auto` (or `true`), in which case colors are used
941only when the output is to a terminal. Defaults to false.
942
Junio C Hamanoe7935c42006-12-13 21:32:17943color.status::
944A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46945linkgit:git-status[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21946`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoe7935c42006-12-13 21:32:17947only when the output is to a terminal. Defaults to false.
948
949color.status.<slot>::
950Use customized color for status colorization. `<slot>` is
951one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:04952`added` or `updated` (files which are added but not committed),
953`changed` (files which are changed but not added in the index),
Junio C Hamano076ffcc2013-02-06 05:13:21954`untracked` (files which are not tracked by Git),
Junio C Hamano0d75e872010-12-17 06:57:26955`branch` (the current branch), or
Junio C Hamanob713ff12008-05-24 01:12:30956`nobranch` (the color the 'no branch' warning is shown in, defaulting
957to red). The values of these variables may be specified as in
958color.branch.<slot>.
Junio C Hamanoe7935c42006-12-13 21:32:17959
Junio C Hamano83d46a22008-02-21 02:29:42960color.ui::
Junio C Hamano5f2627d2011-05-06 20:23:48961This variable determines the default value for variables such
962as `color.diff` and `color.grep` that control the use of color
963per command family. Its scope will expand as more commands learn
964configuration to set a default for the `--color` option. Set it
Junio C Hamanofa1d3492013-06-20 23:39:43965to `false` or `never` if you prefer Git commands not to use
966color unless enabled explicitly with some other configuration
967or the `--color` option. Set it to `always` if you want all
968output not intended for machine consumption to use color, to
969`true` or `auto` (this is the default since Git 1.8.4) if you
970want such output to use color when written to the terminal.
Junio C Hamano83d46a22008-02-21 02:29:42971
Junio C Hamano22700fb2012-05-03 23:07:25972column.ui::
973Specify whether supported commands should output in columns.
974This variable consists of a list of tokens separated by spaces
975or commas:
976+
Junio C Hamanoa1952302013-07-01 21:31:18977These options control when the feature should be enabled
978(defaults to 'never'):
979+
Junio C Hamano22700fb2012-05-03 23:07:25980--
981`always`;;
982always show in columns
983`never`;;
984never show in columns
985`auto`;;
986show in columns if the output is to the terminal
Junio C Hamanoa1952302013-07-01 21:31:18987--
988+
989These options control layout (defaults to 'column'). Setting any
990of these implies 'always' if none of 'always', 'never', or 'auto' are
991specified.
992+
993--
Junio C Hamano22700fb2012-05-03 23:07:25994`column`;;
Junio C Hamanoa1952302013-07-01 21:31:18995fill columns before rows
Junio C Hamano22700fb2012-05-03 23:07:25996`row`;;
997fill rows before columns
998`plain`;;
999show in one column
Junio C Hamanoa1952302013-07-01 21:31:181000--
1001+
1002Finally, these options can be combined with a layout option (defaults
1003to 'nodense'):
1004+
1005--
Junio C Hamano22700fb2012-05-03 23:07:251006`dense`;;
1007make unequal size columns to utilize more space
1008`nodense`;;
1009make equal size columns
1010--
Junio C Hamano22700fb2012-05-03 23:07:251011
1012column.branch::
1013Specify whether to output branch listing in `git branch` in columns.
1014See `column.ui` for details.
1015
Junio C Hamano58f587a2013-07-22 19:20:591016column.clean::
1017Specify the layout when list items in `git clean -i`, which always
1018shows files and directories in columns. See `column.ui` for details.
1019
Junio C Hamano22700fb2012-05-03 23:07:251020column.status::
1021Specify whether to output untracked files in `git status` in columns.
1022See `column.ui` for details.
1023
1024column.tag::
1025Specify whether to output tag listing in `git tag` in columns.
1026See `column.ui` for details.
1027
Junio C Hamanoce836cc2013-01-21 02:01:531028commit.cleanup::
1029This setting overrides the default of the `--cleanup` option in
1030`git commit`. See linkgit:git-commit[1] for details. Changing the
1031default can be useful when you always want to keep lines that begin
1032with comment character `#` in your log message, in which case you
1033would do `git config commit.cleanup whitespace` (note that you will
1034have to remove the help lines that begin with `#` in the commit log
1035template yourself, if you do this).
1036
Junio C Hamano5b3533d2014-02-27 23:07:151037commit.gpgsign::
1038
1039A boolean to specify whether all commits should be GPG signed.
1040Use of this option when doing operations such as rebase can
1041result in a large number of commits being signed. It may be
1042convenient to use an agent to avoid typing your GPG passphrase
1043several times.
1044
Junio C Hamanod0d892c2010-01-24 20:06:291045commit.status::
Junio C Hamano6ce6b6c2010-01-18 01:25:501046A boolean to enable/disable inclusion of status information in the
1047commit message template when using an editor to prepare the commit
1048message. Defaults to true.
1049
Junio C Hamano4653c6f2008-11-26 22:50:201050commit.template::
1051Specify a file to use as the template for new commit messages.
Junio C Hamanob76a6862012-05-02 22:02:461052"`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
Junio C Hamanobf984de2009-11-23 06:11:191053specified user's home directory.
Junio C Hamano4653c6f2008-11-26 22:50:201054
Junio C Hamano0df92712011-12-21 22:30:441055credential.helper::
1056Specify an external helper to be called when a username or
1057password credential is needed; the helper may consult external
1058storage to avoid prompting the user for the credentials. See
1059linkgit:gitcredentials[7] for details.
1060
1061credential.useHttpPath::
1062When acquiring credentials, consider the "path" component of an http
1063or https URL to be important. Defaults to false. See
1064linkgit:gitcredentials[7] for more information.
1065
1066credential.username::
1067If no username is set for a network authentication, use this username
1068by default. See credential.<context>.* below, and
1069linkgit:gitcredentials[7].
1070
1071credential.<url>.*::
1072Any of the credential.* options above can be applied selectively to
1073some credentials. For example "credential.https://example.com.username"
1074would set the default username only for https connections to
1075example.com. See linkgit:gitcredentials[7] for details on how URLs are
1076matched.
1077
Junio C Hamano209ebe82011-04-27 21:09:591078include::diff-config.txt[]
Junio C Hamano3bd66e92009-04-18 06:17:561079
1080difftool.<tool>.path::
1081Override the path for the given tool. This is useful in case
1082your tool is not in the PATH.
1083
1084difftool.<tool>.cmd::
1085Specify the command to invoke the specified diff tool.
1086The specified command is evaluated in shell with the following
1087variables available: 'LOCAL' is set to the name of the temporary
1088file containing the contents of the diff pre-image and 'REMOTE'
1089is set to the name of the temporary file containing the contents
1090of the diff post-image.
1091
1092difftool.prompt::
1093Prompt before each invocation of the diff tool.
1094
Junio C Hamano0d75e872010-12-17 06:57:261095fetch.recurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:101096This option can be either set to a boolean value or to 'on-demand'.
1097Setting it to a boolean changes the behavior of fetch and pull to
1098unconditionally recurse into submodules when set to true or to not
1099recurse at all when set to false. When set to 'on-demand' (the default
1100value), fetch and pull will only recurse into a populated submodule
1101when its superproject retrieves a commit that updates the submodule's
1102reference.
Junio C Hamano0d75e872010-12-17 06:57:261103
Junio C Hamano8fb66e52011-10-05 20:59:511104fetch.fsckObjects::
1105If it is set to true, git-fetch-pack will check all fetched
1106objects. It will abort in the case of a malformed object or a
1107broken link. The result of an abort are only dangling objects.
1108Defaults to false. If not set, the value of `transfer.fsckObjects`
1109is used instead.
1110
Junio C Hamano54ea8d32007-01-25 07:59:481111fetch.unpackLimit::
Junio C Hamano076ffcc2013-02-06 05:13:211112If the number of objects fetched over the Git native
Junio C Hamano54ea8d32007-01-25 07:59:481113transfer is below this
1114limit, then the objects will be unpacked into loose object
1115files. However if the number of received objects equals or
1116exceeds this limit then the received pack will be stored as
1117a pack, after adding any missing delta bases. Storing the
1118pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:171119especially on slow filesystems. If not set, the value of
1120`transfer.unpackLimit` is used instead.
Junio C Hamano54ea8d32007-01-25 07:59:481121
Junio C Hamano8eac2682013-09-09 22:35:201122fetch.prune::
1123If true, fetch will automatically behave as if the `--prune`
1124option was given on the command line. See also `remote.<name>.prune`.
1125
Junio C Hamanof4581102009-04-25 08:29:591126format.attach::
1127Enable multipart/mixed attachments as the default for
1128'format-patch'. The value can also be a double quoted string
1129which will enable attachments as the default and set the
1130value as the boundary. See the --attach option in
1131linkgit:git-format-patch[1].
1132
Junio C Hamano8c5802d2007-11-15 00:13:361133format.numbered::
Junio C Hamano7d06a8a2008-10-20 05:42:331134A boolean which can enable or disable sequence numbers in patch
1135subjects. It defaults to "auto" which enables it only if there
1136is more than one patch. It can be enabled or disabled for all
1137messages by setting it to "true" or "false". See --numbered
1138option in linkgit:git-format-patch[1].
Junio C Hamano8c5802d2007-11-15 00:13:361139
Junio C Hamano07824ce2006-04-25 07:36:541140format.headers::
1141Additional email headers to include in a patch to be submitted
Junio C Hamano35738e82008-01-07 07:55:461142by mail. See linkgit:git-format-patch[1].
Junio C Hamano07824ce2006-04-25 07:36:541143
Junio C Hamano70664a02010-07-13 22:48:051144format.to::
Junio C Hamanof4581102009-04-25 08:29:591145format.cc::
Junio C Hamano70664a02010-07-13 22:48:051146Additional recipients to include in a patch to be submitted
1147by mail. See the --to and --cc options in
1148linkgit:git-format-patch[1].
Junio C Hamanof4581102009-04-25 08:29:591149
1150format.subjectprefix::
1151The default for format-patch is to output files with the '[PATCH]'
1152subject prefix. Use this variable to change that prefix.
1153
Junio C Hamano89a57342010-06-22 23:22:551154format.signature::
1155The default for format-patch is to output a signature containing
Junio C Hamano076ffcc2013-02-06 05:13:211156the Git version number. Use this variable to change that default.
Junio C Hamano89a57342010-06-22 23:22:551157Set this variable to the empty string ("") to suppress
1158signature generation.
1159
Junio C Hamanoc8c398a2014-06-16 21:14:051160format.signaturefile::
1161Works just like format.signature except the contents of the
1162file specified by this variable will be used as the signature.
1163
Junio C Hamanod4c8e112007-03-04 10:32:381164format.suffix::
1165The default for format-patch is to output files with the suffix
1166`.patch`. Use this variable to change that suffix (make sure to
1167include the dot if you want it).
1168
Junio C Hamano86bcccc2008-03-08 09:33:551169format.pretty::
1170The default pretty format for log/show/whatchanged command,
1171See linkgit:git-log[1], linkgit:git-show[1],
1172linkgit:git-whatchanged[1].
1173
Junio C Hamanoea6a7642009-03-11 23:56:191174format.thread::
Junio C Hamano1aa40d22010-01-21 17:46:431175The default threading style for 'git format-patch'. Can be
Junio C Hamanob141a922010-01-10 19:55:141176a boolean value, or `shallow` or `deep`. `shallow` threading
1177makes every mail a reply to the head of the series,
Junio C Hamanoea6a7642009-03-11 23:56:191178where the head is chosen from the cover letter, the
Junio C Hamanob76a6862012-05-02 22:02:461179`--in-reply-to`, and the first patch mail, in this order.
Junio C Hamanof4581102009-04-25 08:29:591180`deep` threading makes every mail a reply to the previous one.
Junio C Hamanoea6a7642009-03-11 23:56:191181A true boolean value is the same as `shallow`, and a false
1182value disables threading.
1183
Junio C Hamano5f9a6f02009-04-06 08:26:561184format.signoff::
Junio C Hamano804a9742013-04-28 23:10:311185A boolean value which lets you enable the `-s/--signoff` option of
1186format-patch by default. *Note:* Adding the Signed-off-by: line to a
1187patch should be a conscious act and means that you certify you have
1188the rights to submit this work under the same open source license.
1189Please see the 'SubmittingPatches' document for further discussion.
Junio C Hamano5f9a6f02009-04-06 08:26:561190
Junio C Hamanoea3b7522013-04-18 19:37:531191format.coverLetter::
1192A boolean that controls whether to generate a cover-letter when
1193format-patch is invoked, but in addition can be set to "auto", to
1194generate a cover-letter only when there's more than one patch.
1195
Junio C Hamano209ebe82011-04-27 21:09:591196filter.<driver>.clean::
1197The command which is used to convert the content of a worktree
1198file to a blob upon checkin. See linkgit:gitattributes[5] for
1199details.
1200
1201filter.<driver>.smudge::
1202The command which is used to convert the content of a blob
1203object to a worktree file upon checkout. See
1204linkgit:gitattributes[5] for details.
1205
Junio C Hamano624dd4c2014-04-03 21:56:301206gc.aggressiveDepth::
1207The depth parameter used in the delta compression
1208algorithm used by 'git gc --aggressive'. This defaults
1209to 250.
1210
Junio C Hamanof2ce2972007-05-20 19:12:091211gc.aggressiveWindow::
1212The window size parameter used in the delta compression
Junio C Hamano1aa40d22010-01-21 17:46:431213algorithm used by 'git gc --aggressive'. This defaults
Junio C Hamanob04bb3f2010-04-14 14:07:361214to 250.
Junio C Hamanof2ce2972007-05-20 19:12:091215
Junio C Hamano1b50ce92007-10-03 12:05:531216gc.auto::
1217When there are approximately more than this many loose
1218objects in the repository, `git gc --auto` will pack them.
1219Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:171220light-weight garbage collection from time to time. The
1221default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531222
1223gc.autopacklimit::
1224When there are more than this many packs that are not
1225marked with `*.keep` file in the repository, `git gc
Junio C Hamanoe77b0152008-01-12 06:44:171226--auto` consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:371227default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531228
Junio C Hamano08ef8c22014-03-10 14:53:441229gc.autodetach::
Junio C Hamanofb5ffde2014-11-04 22:38:561230Make `git gc --auto` return immediately and run in background
Junio C Hamano08ef8c22014-03-10 14:53:441231if the system supports it. Default is true.
1232
Junio C Hamano9d52e572007-02-13 23:48:201233gc.packrefs::
Junio C Hamanob141a922010-01-10 19:55:141234Running `git pack-refs` in a repository renders it
1235unclonable by Git versions prior to 1.5.1.2 over dumb
1236transports such as HTTP. This variable determines whether
Junio C Hamanocdd1c332010-12-20 10:08:001237'git gc' runs `git pack-refs`. This can be set to `notbare`
Junio C Hamanob141a922010-01-10 19:55:141238to enable it within all non-bare repos or it can be set to a
1239boolean value. The default is `true`.
Junio C Hamano9d52e572007-02-13 23:48:201240
Junio C Hamano09a926d2008-03-13 07:55:291241gc.pruneexpire::
Junio C Hamano1aa40d22010-01-21 17:46:431242When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
Junio C Hamanoa3148f52009-01-14 08:49:571243Override the grace period with this config variable. The value
1244"now" may be used to disable this grace period and always prune
1245unreachable objects immediately.
Junio C Hamano09a926d2008-03-13 07:55:291246
Junio C Hamano74640642006-12-27 10:59:551247gc.reflogexpire::
Junio C Hamanocc7636a2010-05-21 14:57:531248gc.<pattern>.reflogexpire::
Junio C Hamano1aa40d22010-01-21 17:46:431249'git reflog expire' removes reflog entries older than
Junio C Hamanocc7636a2010-05-21 14:57:531250this time; defaults to 90 days. With "<pattern>" (e.g.
1251"refs/stash") in the middle the setting applies only to
1252the refs that match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551253
1254gc.reflogexpireunreachable::
Junio C Hamanocc7636a2010-05-21 14:57:531255gc.<ref>.reflogexpireunreachable::
Junio C Hamano1aa40d22010-01-21 17:46:431256'git reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:551257this time and are not reachable from the current tip;
Junio C Hamanocc7636a2010-05-21 14:57:531258defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1259in the middle, the setting applies only to the refs that
1260match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551261
1262gc.rerereresolved::
1263Records of conflicted merge you resolved earlier are
Junio C Hamano1aa40d22010-01-21 17:46:431264kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461265The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551266
1267gc.rerereunresolved::
1268Records of conflicted merge you have not resolved are
Junio C Hamano1aa40d22010-01-21 17:46:431269kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461270The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551271
Junio C Hamanoa3148f52009-01-14 08:49:571272gitcvs.commitmsgannotation::
1273Append this string to each commit message. Set to empty string
1274to disable this feature. Defaults to "via git-CVS emulator".
1275
Junio C Hamano07824ce2006-04-25 07:36:541276gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:271277Whether the CVS server interface is enabled for this repository.
Junio C Hamano35738e82008-01-07 07:55:461278See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541279
1280gitcvs.logfile::
Junio C Hamanoa6387422007-08-25 03:54:271281Path to a log file where the CVS server interface well... logs
Junio C Hamano35738e82008-01-07 07:55:461282various stuff. See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541283
Junio C Hamano17bd2272008-09-01 06:11:171284gitcvs.usecrlfattr::
Junio C Hamanobb88cf42010-06-21 15:23:551285If true, the server will look up the end-of-line conversion
1286attributes for files to determine the '-k' modes to use. If
Junio C Hamano076ffcc2013-02-06 05:13:211287the attributes force Git to treat a file as text,
Junio C Hamano619596a2010-08-18 22:15:351288the '-k' mode will be left blank so CVS clients will
Junio C Hamanobb88cf42010-06-21 15:23:551289treat it as text. If they suppress text conversion, the file
Junio C Hamanocb1c44f2008-08-06 06:19:331290will be set with '-kb' mode, which suppresses any newline munging
Junio C Hamanobb88cf42010-06-21 15:23:551291the client might otherwise do. If the attributes do not allow
1292the file type to be determined, then 'gitcvs.allbinary' is
1293used. See linkgit:gitattributes[5].
Junio C Hamanodfccbb02008-05-26 01:16:141294
Junio C Hamanod9e0e5d2007-04-14 16:22:041295gitcvs.allbinary::
Junio C Hamanodfccbb02008-05-26 01:16:141296This is used if 'gitcvs.usecrlfattr' does not resolve
1297the correct '-kb' mode to use. If true, all
1298unresolved files are sent to the client in
1299mode '-kb'. This causes the client to treat them
1300as binary files, which suppresses any newline munging it
1301otherwise might do. Alternatively, if it is set to "guess",
1302then the contents of the file are examined to decide if
1303it is binary, similar to 'core.autocrlf'.
Junio C Hamanoa2ad99e2007-04-18 09:57:041304
1305gitcvs.dbname::
1306Database used by git-cvsserver to cache revision information
Junio C Hamano076ffcc2013-02-06 05:13:211307derived from the Git repository. The exact meaning depends on the
Junio C Hamanoa2ad99e2007-04-18 09:57:041308used database driver, for SQLite (which is the default driver) this
1309is a filename. Supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461310linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Junio C Hamanoa2ad99e2007-04-18 09:57:041311Default: '%Ggitcvs.%m.sqlite'
1312
1313gitcvs.dbdriver::
1314Used Perl DBI driver. You can specify any available driver
Junio C Hamano804a9742013-04-28 23:10:311315for this here, but it might not work. git-cvsserver is tested
Junio C Hamanoa2ad99e2007-04-18 09:57:041316with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1317reported *not* to work with 'DBD::mysql'. Experimental feature.
1318May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamano35738e82008-01-07 07:55:461319See linkgit:git-cvsserver[1].
Junio C Hamanod9e0e5d2007-04-14 16:22:041320
Junio C Hamanoa2ad99e2007-04-18 09:57:041321gitcvs.dbuser, gitcvs.dbpass::
1322Database user and password. Only useful if setting 'gitcvs.dbdriver',
1323since SQLite has no concept of database users and/or passwords.
1324'gitcvs.dbuser' supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461325linkgit:git-cvsserver[1] for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:041326
Junio C Hamanoa74efce2008-04-02 08:39:081327gitcvs.dbTableNamePrefix::
1328Database table name prefix. Prepended to the names of any
1329database tables used, allowing a single database to be used
1330for several repositories. Supports variable substitution (see
1331linkgit:git-cvsserver[1] for details). Any non-alphabetic
1332characters will be replaced with underscores.
1333
Junio C Hamanodfccbb02008-05-26 01:16:141334All gitcvs variables except for 'gitcvs.usecrlfattr' and
1335'gitcvs.allbinary' can also be specified as
1336'gitcvs.<access_method>.<varname>' (where 'access_method'
Junio C Hamanoa6387422007-08-25 03:54:271337is one of "ext" and "pserver") to make them apply only for the given
1338access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:041339
Junio C Hamano11821ed2011-10-19 18:42:091340gitweb.category::
1341gitweb.description::
1342gitweb.owner::
1343gitweb.url::
1344See linkgit:gitweb[1] for description.
1345
1346gitweb.avatar::
1347gitweb.blame::
1348gitweb.grep::
1349gitweb.highlight::
1350gitweb.patches::
1351gitweb.pickaxe::
1352gitweb.remote_heads::
1353gitweb.showsizes::
1354gitweb.snapshot::
1355See linkgit:gitweb.conf[5] for description.
1356
Junio C Hamanoa03ac862011-04-02 04:32:291357grep.lineNumber::
1358If set to true, enable '-n' option by default.
1359
Junio C Hamanoa00504d2012-08-27 21:11:231360grep.patternType::
1361Set the default matching behavior. Using a value of 'basic', 'extended',
1362'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1363'--fixed-strings', or '--perl-regexp' option accordingly, while the
1364value 'default' will return to the default matching behavior.
1365
Junio C Hamanoa03ac862011-04-02 04:32:291366grep.extendedRegexp::
Junio C Hamanoa00504d2012-08-27 21:11:231367If set to true, enable '--extended-regexp' option by default. This
1368option is ignored when the 'grep.patternType' option is set to a value
1369other than 'default'.
Junio C Hamanoa03ac862011-04-02 04:32:291370
Junio C Hamano4fd24422012-01-06 21:52:431371gpg.program::
1372Use this custom program instead of "gpg" found on $PATH when
1373making or verifying a PGP signature. The program must support the
Junio C Hamanoe1aeb5e2014-06-06 19:16:291374same command-line interface as GPG, namely, to verify a detached
Junio C Hamano4fd24422012-01-06 21:52:431375signature, "gpg --verify $file - <$signature" is run, and the
1376program is expected to signal a good signature by exiting with
Junio C Hamanofb5ffde2014-11-04 22:38:561377code 0, and to generate an ASCII-armored detached signature, the
Junio C Hamano4fd24422012-01-06 21:52:431378standard input of "gpg -bsau $key" is fed with the contents to be
1379signed, and the program is expected to send the result to its
1380standard output.
1381
Junio C Hamano6d76d612008-05-09 05:46:081382gui.commitmsgwidth::
1383Defines how wide the commit message window is in the
1384linkgit:git-gui[1]. "75" is the default.
1385
1386gui.diffcontext::
1387Specifies how many context lines should be used in calls to diff
1388made by the linkgit:git-gui[1]. The default is "5".
1389
Junio C Hamano796c55f2014-05-02 21:45:151390gui.displayuntracked::
1391Determines if linkgit::git-gui[1] shows untracked files
1392in the file list. The default is "true".
1393
Junio C Hamanod3452a02008-11-15 08:07:551394gui.encoding::
1395Specifies the default encoding to use for displaying of
1396file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1397It can be overridden by setting the 'encoding' attribute
1398for relevant files (see linkgit:gitattributes[5]).
1399If this option is not set, the tools default to the
1400locale encoding.
1401
Junio C Hamano6d76d612008-05-09 05:46:081402gui.matchtrackingbranch::
1403Determines if new branches created with linkgit:git-gui[1] should
1404default to tracking remote branches with matching names or
1405not. Default: "false".
1406
1407gui.newbranchtemplate::
1408Is used as suggested name when creating new branches using the
1409linkgit:git-gui[1].
1410
1411gui.pruneduringfetch::
Junio C Hamano97bcb482010-11-25 03:16:071412"true" if linkgit:git-gui[1] should prune remote-tracking branches when
Junio C Hamano6d76d612008-05-09 05:46:081413performing a fetch. The default value is "false".
1414
1415gui.trustmtime::
1416Determines if linkgit:git-gui[1] should trust the file modification
1417timestamp or not. By default the timestamps are not trusted.
1418
1419gui.spellingdictionary::
1420Specifies the dictionary used for spell checking commit messages in
1421the linkgit:git-gui[1]. When set to "none" spell checking is turned
1422off.
1423
Junio C Hamanod3452a02008-11-15 08:07:551424gui.fastcopyblame::
Junio C Hamano1aa40d22010-01-21 17:46:431425If true, 'git gui blame' uses `-C` instead of `-C -C` for original
Junio C Hamanod3452a02008-11-15 08:07:551426location detection. It makes blame significantly faster on huge
1427repositories at the expense of less thorough copy detection.
1428
1429gui.copyblamethreshold::
Junio C Hamano610d1762008-11-28 06:27:131430Specifies the threshold to use in 'git gui blame' original location
Junio C Hamanod3452a02008-11-15 08:07:551431detection, measured in alphanumeric characters. See the
1432linkgit:git-blame[1] manual for more information on copy detection.
1433
1434gui.blamehistoryctx::
1435Specifies the radius of history context in days to show in
1436linkgit:gitk[1] for the selected commit, when the `Show History
1437Context` menu item is invoked from 'git gui blame'. If this
1438variable is set to zero, the whole history is shown.
1439
Junio C Hamano92d312a2008-12-15 07:22:201440guitool.<name>.cmd::
1441Specifies the shell command line to execute when the corresponding item
1442of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1443mandatory for every tool. The command is executed from the root of
1444the working directory, and in the environment it receives the name of
1445the tool as 'GIT_GUITOOL', the name of the currently selected file as
1446'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1447the head is detached, 'CUR_BRANCH' is empty).
1448
1449guitool.<name>.needsfile::
1450Run the tool only if a diff is selected in the GUI. It guarantees
1451that 'FILENAME' is not empty.
1452
1453guitool.<name>.noconsole::
1454Run the command silently, without creating a window to display its
1455output.
1456
1457guitool.<name>.norescan::
1458Don't rescan the working directory for changes after the tool
1459finishes execution.
1460
1461guitool.<name>.confirm::
1462Show a confirmation dialog before actually running the tool.
1463
1464guitool.<name>.argprompt::
1465Request a string argument from the user, and pass it to the tool
1466through the 'ARGS' environment variable. Since requesting an
1467argument implies confirmation, the 'confirm' option has no effect
1468if this is enabled. If the option is set to 'true', 'yes', or '1',
1469the dialog uses a built-in generic prompt; otherwise the exact
1470value of the variable is used.
1471
1472guitool.<name>.revprompt::
1473Request a single valid revision from the user, and set the
1474'REVISION' environment variable. In other aspects this option
1475is similar to 'argprompt', and can be used together with it.
1476
1477guitool.<name>.revunmerged::
1478Show only unmerged branches in the 'revprompt' subdialog.
1479This is useful for tools similar to merge or rebase, but not
1480for things like checkout or reset.
1481
1482guitool.<name>.title::
1483Specifies the title to use for the prompt dialog. The default
1484is the tool name.
1485
1486guitool.<name>.prompt::
1487Specifies the general prompt string to display at the top of
1488the dialog, before subsections for 'argprompt' and 'revprompt'.
1489The default value includes the actual command.
1490
Junio C Hamano4e272312008-01-08 09:13:211491help.browser::
1492Specify the browser that will be used to display help in the
1493'web' format. See linkgit:git-help[1].
1494
1495help.format::
1496Override the default help format used by linkgit:git-help[1].
1497Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1498the default. 'web' and 'html' are the same.
1499
Junio C Hamanof24b8062008-09-09 01:34:391500help.autocorrect::
1501Automatically correct and execute mistyped commands after
1502waiting for the given number of deciseconds (0.1 sec). If more
1503than one command can be deduced from the entered text, nothing
1504will be executed. If the value of this option is negative,
1505the corrected command will be executed immediately. If the
1506value is 0 - the command will be just shown but not executed.
1507This is the default.
1508
Junio C Hamano5dd5fae2013-01-18 21:06:491509help.htmlpath::
1510Specify the path where the HTML documentation resides. File system paths
1511and URLs are supported. HTML pages will be prefixed with this path when
1512help is displayed in the 'web' format. This defaults to the documentation
1513path of your Git installation.
1514
Junio C Hamano58256872007-12-04 08:31:131515http.proxy::
Junio C Hamano3dd93922012-03-05 07:49:111516Override the HTTP proxy, normally configured using the 'http_proxy',
1517'https_proxy', and 'all_proxy' environment variables (see
1518`curl(1)`). This can be overridden on a per-remote basis; see
1519remote.<name>.proxy
Junio C Hamano58256872007-12-04 08:31:131520
Junio C Hamano4c4b0122011-06-30 01:19:321521http.cookiefile::
1522File containing previously stored cookie lines which should be used
Junio C Hamano076ffcc2013-02-06 05:13:211523in the Git http session, if they match the server. The file format
Junio C Hamano4c4b0122011-06-30 01:19:321524of the file to read cookies from should be plain HTTP headers or
1525the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1526NOTE that the file specified with http.cookiefile is only used as
Junio C Hamano8eac2682013-09-09 22:35:201527input unless http.saveCookies is set.
1528
1529http.savecookies::
1530If set, store cookies received during requests to the file specified by
1531http.cookiefile. Has no effect if http.cookiefile is unset.
Junio C Hamano4c4b0122011-06-30 01:19:321532
Junio C Hamano07824ce2006-04-25 07:36:541533http.sslVerify::
1534Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451535over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Junio C Hamano07824ce2006-04-25 07:36:541536variable.
1537
1538http.sslCert::
1539File containing the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451540over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Junio C Hamano07824ce2006-04-25 07:36:541541variable.
1542
1543http.sslKey::
1544File containing the SSL private key when fetching or pushing
Junio C Hamano341071d2006-06-04 07:24:481545over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Junio C Hamano07824ce2006-04-25 07:36:541546variable.
1547
Junio C Hamano48bc1ce2009-07-09 16:49:191548http.sslCertPasswordProtected::
Junio C Hamano076ffcc2013-02-06 05:13:211549Enable Git's password prompt for the SSL certificate. Otherwise
Junio C Hamano48bc1ce2009-07-09 16:49:191550OpenSSL will prompt the user, possibly many times, if the
1551certificate or private key is encrypted. Can be overridden by the
1552'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1553
Junio C Hamano07824ce2006-04-25 07:36:541554http.sslCAInfo::
1555File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:481556fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano07824ce2006-04-25 07:36:541557'GIT_SSL_CAINFO' environment variable.
1558
1559http.sslCAPath::
1560Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:451561with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541562by the 'GIT_SSL_CAPATH' environment variable.
1563
Junio C Hamano76927822013-04-19 21:26:571564http.sslTry::
1565Attempt to use AUTH SSL/TLS and encrypted data transfers
1566when connecting via regular FTP protocol. This might be needed
1567if the FTP server requires it for security reasons or you wish
1568to connect securely whenever remote FTP server supports it.
1569Default is false since it might trigger certificate verification
1570errors on misconfigured servers.
1571
Junio C Hamano07824ce2006-04-25 07:36:541572http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:481573How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541574by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1575
Junio C Hamanob141a922010-01-10 19:55:141576http.minSessions::
1577The number of curl sessions (counted across slots) to be kept across
1578requests. They will not be ended with curl_easy_cleanup() until
1579http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1580value will be capped at 1. Defaults to 1.
1581
Junio C Hamano3b70d3c2009-11-21 17:37:371582http.postBuffer::
1583Maximum size in bytes of the buffer used by smart HTTP
1584transports when POSTing data to the remote system.
1585For requests larger than this buffer size, HTTP/1.1 and
1586Transfer-Encoding: chunked is used to avoid creating a
1587massive pack file locally. Default is 1 MiB, which is
1588sufficient for most requests.
1589
Junio C Hamano07824ce2006-04-25 07:36:541590http.lowSpeedLimit, http.lowSpeedTime::
1591If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1592for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano341071d2006-06-04 07:24:481593Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Junio C Hamano07824ce2006-04-25 07:36:541594'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1595
Junio C Hamanof1dcdfe2006-09-29 08:10:511596http.noEPSV::
1597A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:041598This can helpful with some "poor" ftp servers which don't
Junio C Hamanof1dcdfe2006-09-29 08:10:511599support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1600environment variable. Default is false (curl will use EPSV).
1601
Junio C Hamano53ba6d02010-08-22 07:25:121602http.useragent::
1603The HTTP USER_AGENT string presented to an HTTP server. The default
Junio C Hamano076ffcc2013-02-06 05:13:211604value represents the version of the client Git such as git/1.7.1.
Junio C Hamano53ba6d02010-08-22 07:25:121605This option allows you to override this value to a more common value
1606such as Mozilla/4.0. This may be necessary, for instance, if
1607connecting through a firewall that restricts HTTP connections to a set
1608of common USER_AGENT strings (but not including those like git/1.7.1).
1609Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1610
Junio C Hamano8eac2682013-09-09 22:35:201611http.<url>.*::
Junio C Hamanofb5ffde2014-11-04 22:38:561612Any of the http.* options above can be applied selectively to some URLs.
Junio C Hamano8eac2682013-09-09 22:35:201613For a config key to match a URL, each element of the config key is
1614compared to that of the URL, in the following order:
1615+
1616--
1617. Scheme (e.g., `https` in `https://example.com/`). This field
1618 must match exactly between the config key and the URL.
1619
1620. Host/domain name (e.g., `example.com` in `https://example.com/`).
1621 This field must match exactly between the config key and the URL.
1622
1623. Port number (e.g., `8080` in `http://example.com:8080/`).
1624 This field must match exactly between the config key and the URL.
1625 Omitted port numbers are automatically converted to the correct
1626 default for the scheme before matching.
1627
1628. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1629 path field of the config key must match the path field of the URL
1630 either exactly or as a prefix of slash-delimited path elements. This means
1631 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1632 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1633 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1634 key with just path `foo/`).
1635
1636. User name (e.g., `user` in `https://user@example.com/repo.git`). If
1637 the config key has a user name it must match the user name in the
1638 URL exactly. If the config key does not have a user name, that
1639 config key will match a URL with any user name (including none),
1640 but at a lower precedence than a config key with a user name.
1641--
1642+
1643The list above is ordered by decreasing precedence; a URL that matches
1644a config key's path is preferred to one that matches its user name. For example,
1645if the URL is `https://user@example.com/foo/bar` a config key match of
1646`https://example.com/foo` will be preferred over a config key match of
1647`https://user@example.com`.
1648+
1649All URLs are normalized before attempting any matching (the password part,
1650if embedded in the URL, is always ignored for matching purposes) so that
Junio C Hamanofb5ffde2014-11-04 22:38:561651equivalent URLs that are simply spelled differently will match properly.
1652Environment variable settings always override any matches. The URLs that are
Junio C Hamano8eac2682013-09-09 22:35:201653matched against are those given directly to Git commands. This means any URLs
1654visited as a result of a redirection do not participate in matching.
1655
Junio C Hamano07824ce2006-04-25 07:36:541656i18n.commitEncoding::
Junio C Hamano076ffcc2013-02-06 05:13:211657Character encoding the commit messages are stored in; Git itself
Junio C Hamano07824ce2006-04-25 07:36:541658does not care per se, but this information is necessary e.g. when
1659importing commits from emails or in the gitk graphical history
1660browser (and possibly at other places in the future or in other
Junio C Hamano35738e82008-01-07 07:55:461661porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Junio C Hamano07824ce2006-04-25 07:36:541662
Junio C Hamano51f92e22006-12-29 05:18:281663i18n.logOutputEncoding::
1664Character encoding the commit messages are converted to when
Junio C Hamano1aa40d22010-01-21 17:46:431665running 'git log' and friends.
Junio C Hamano51f92e22006-12-29 05:18:281666
Junio C Hamano4653c6f2008-11-26 22:50:201667imap::
1668The configuration variables in the 'imap' section are described
1669in linkgit:git-imap-send[1].
1670
Junio C Hamano81703b22014-03-14 22:00:271671index.version::
1672Specify the version with which new index files should be
1673initialized. This does not affect existing repositories.
1674
Junio C Hamanocaa712a2010-03-11 01:17:351675init.templatedir::
1676Specify the directory from which templates will be copied.
1677(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1678
Junio C Hamano4e272312008-01-08 09:13:211679instaweb.browser::
1680Specify the program that will be used to browse your working
1681repository in gitweb. See linkgit:git-instaweb[1].
1682
1683instaweb.httpd::
1684The HTTP daemon command-line to start gitweb on your working
1685repository. See linkgit:git-instaweb[1].
1686
1687instaweb.local::
1688If true the web server started by linkgit:git-instaweb[1] will
1689be bound to the local IP (127.0.0.1).
1690
1691instaweb.modulepath::
Junio C Hamano619596a2010-08-18 22:15:351692The default module path for linkgit:git-instaweb[1] to use
1693instead of /usr/lib/apache2/modules. Only used if httpd
1694is Apache.
Junio C Hamano4e272312008-01-08 09:13:211695
1696instaweb.port::
1697The port number to bind the gitweb httpd to. See
1698linkgit:git-instaweb[1].
1699
Junio C Hamanoe5bf6c12009-02-07 21:43:101700interactive.singlekey::
Junio C Hamano27a128b2009-08-13 01:23:001701In interactive commands, allow the user to provide one-letter
Junio C Hamanoe5bf6c12009-02-07 21:43:101702input with a single key (i.e., without hitting enter).
Junio C Hamanob76a6862012-05-02 22:02:461703Currently this is used by the `--patch` mode of
Junio C Hamano3d050d62011-05-17 06:43:341704linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1705linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1706setting is silently ignored if portable keystroke input
Junio C Hamano81703b22014-03-14 22:00:271707is not available; requires the Perl module Term::ReadKey.
Junio C Hamanoe5bf6c12009-02-07 21:43:101708
Junio C Hamanof93530e2011-05-25 23:59:591709log.abbrevCommit::
1710If true, makes linkgit:git-log[1], linkgit:git-show[1], and
Junio C Hamanob76a6862012-05-02 22:02:461711linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1712override this option with `--no-abbrev-commit`.
Junio C Hamanof93530e2011-05-25 23:59:591713
Junio C Hamanob713ff12008-05-24 01:12:301714log.date::
Junio C Hamano2db3e752010-09-03 21:33:061715Set the default date-time mode for the 'log' command.
1716Setting a value for log.date is similar to using 'git log''s
Junio C Hamanob76a6862012-05-02 22:02:461717`--date` option. Possible values are `relative`, `local`,
Junio C Hamano2db3e752010-09-03 21:33:061718`default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1719for details.
Junio C Hamanob713ff12008-05-24 01:12:301720
Junio C Hamanocb39aea2010-05-09 07:24:481721log.decorate::
1722Print out the ref names of any commits that are shown by the log
1723command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1724'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1725specified, the full ref name (including prefix) will be printed.
1726This is the same as the log commands '--decorate' option.
1727
Junio C Hamanofe9acab2006-11-24 12:10:551728log.showroot::
1729If true, the initial commit will be shown as a big creation event.
1730This is equivalent to a diff against an empty tree.
Junio C Hamano35738e82008-01-07 07:55:461731Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Junio C Hamanofe9acab2006-11-24 12:10:551732normally hide the root commit will now show it. True by default.
1733
Junio C Hamanoce836cc2013-01-21 02:01:531734log.mailmap::
1735If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1736linkgit:git-whatchanged[1] assume `--use-mailmap`.
1737
Junio C Hamano8bc410e2009-02-15 10:38:191738mailmap.file::
1739The location of an augmenting mailmap file. The default
1740mailmap, located in the root of the repository, is loaded
1741first, then the mailmap file pointed to by this variable.
1742The location of the mailmap file may be in a repository
1743subdirectory, or somewhere outside of the repository itself.
1744See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1745
Junio C Hamanoabad6da2013-01-06 09:06:321746mailmap.blob::
1747Like `mailmap.file`, but consider the value as a reference to a
1748blob in the repository. If both `mailmap.file` and
1749`mailmap.blob` are given, both are parsed, with entries from
1750`mailmap.file` taking precedence. In a bare repository, this
1751defaults to `HEAD:.mailmap`. In a non-bare repository, it
1752defaults to empty.
1753
Junio C Hamano8b588d52008-03-15 09:48:371754man.viewer::
1755Specify the programs that may be used to display help in the
1756'man' format. See linkgit:git-help[1].
1757
Junio C Hamano6d76d612008-05-09 05:46:081758man.<tool>.cmd::
1759Specify the command to invoke the specified man viewer. The
1760specified command is evaluated in shell with the man page
1761passed as argument. (See linkgit:git-help[1].)
Junio C Hamano103ad7f2007-03-14 11:19:261762
Junio C Hamano6d76d612008-05-09 05:46:081763man.<tool>.path::
1764Override the path for the given tool that may be used to
1765display help in the 'man' format. See linkgit:git-help[1].
Junio C Hamanoe90436a2007-04-22 07:22:131766
Junio C Hamano4653c6f2008-11-26 22:50:201767include::merge-config.txt[]
Junio C Hamanoa476efa2008-10-10 15:31:421768
Junio C Hamano1fbbbc12007-12-18 07:01:271769mergetool.<tool>.path::
1770Override the path for the given tool. This is useful in case
1771your tool is not in the PATH.
1772
Junio C Hamano86bcccc2008-03-08 09:33:551773mergetool.<tool>.cmd::
1774Specify the command to invoke the specified merge tool. The
1775specified command is evaluated in shell with the following
1776variables available: 'BASE' is the name of a temporary file
1777containing the common base of the files to be merged, if available;
1778'LOCAL' is the name of a temporary file containing the contents of
1779the file on the current branch; 'REMOTE' is the name of a temporary
1780file containing the contents of the file from the branch being
1781merged; 'MERGED' contains the name of the file to which the merge
1782tool should write the results of a successful merge.
1783
1784mergetool.<tool>.trustExitCode::
1785For a custom merge command, specify whether the exit code of
1786the merge command can be used to determine whether the merge was
1787successful. If this is not set to true then the merge target file
1788timestamp is checked and the merge assumed to have been successful
1789if the file has been updated, otherwise the user is prompted to
1790indicate the success of the merge.
1791
Junio C Hamanoe478e402014-10-21 22:14:451792mergetool.meld.hasOutput::
1793Older versions of `meld` do not support the `--output` option.
1794Git will attempt to detect whether `meld` supports `--output`
1795by inspecting the output of `meld --help`. Configuring
1796`mergetool.meld.hasOutput` will make Git skip these checks and
1797use the configured value instead. Setting `mergetool.meld.hasOutput`
1798to `true` tells Git to unconditionally use the `--output` option,
1799and `false` avoids using `--output`.
1800
Junio C Hamano86bcccc2008-03-08 09:33:551801mergetool.keepBackup::
1802After performing a merge, the original file with conflict markers
1803can be saved as a file with a `.orig` extension. If this variable
1804is set to `false` then this file is not preserved. Defaults to
1805`true` (i.e. keep the backup files).
1806
Junio C Hamano10b7a342009-01-01 22:05:171807mergetool.keepTemporaries::
Junio C Hamano076ffcc2013-02-06 05:13:211808When invoking a custom merge tool, Git uses a set of temporary
Junio C Hamano10b7a342009-01-01 22:05:171809files to pass to the tool. If the tool returns an error and this
1810variable is set to `true`, then these temporary files will be
1811preserved, otherwise they will be removed after the tool has
1812exited. Defaults to `false`.
1813
Junio C Hamanoe478e402014-10-21 22:14:451814mergetool.writeToTemp::
1815Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
1816conflicting files in the worktree by default. Git will attempt
1817to use a temporary directory for these files when set `true`.
1818Defaults to `false`.
1819
Junio C Hamano10b7a342009-01-01 22:05:171820mergetool.prompt::
1821Prompt before each invocation of the merge resolution program.
1822
Junio C Hamano31667362010-03-25 00:38:531823notes.displayRef::
1824The (fully qualified) refname from which to show notes when
1825showing commit messages. The value of this variable can be set
1826to a glob, in which case notes from all matching refs will be
1827shown. You may also specify this configuration variable
1828several times. A warning will be issued for refs that do not
1829exist, but a glob that does not match any refs is silently
1830ignored.
1831+
1832This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1833environment variable, which must be a colon separated list of refs or
1834globs.
1835+
1836The effective value of "core.notesRef" (possibly overridden by
1837GIT_NOTES_REF) is also implicitly added to the list of refs to be
1838displayed.
1839
1840notes.rewrite.<command>::
1841When rewriting commits with <command> (currently `amend` or
Junio C Hamano076ffcc2013-02-06 05:13:211842`rebase`) and this variable is set to `true`, Git
Junio C Hamano31667362010-03-25 00:38:531843automatically copies your notes from the original to the
1844rewritten commit. Defaults to `true`, but see
1845"notes.rewriteRef" below.
Junio C Hamano31667362010-03-25 00:38:531846
1847notes.rewriteMode::
1848When copying notes during a rewrite (see the
1849"notes.rewrite.<command>" option), determines what to do if
1850the target commit already has a note. Must be one of
1851`overwrite`, `concatenate`, or `ignore`. Defaults to
1852`concatenate`.
1853+
1854This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1855environment variable.
1856
1857notes.rewriteRef::
1858When copying notes during a rewrite, specifies the (fully
1859qualified) ref whose notes should be copied. The ref may be a
1860glob, in which case notes in all matching refs will be copied.
1861You may also specify this configuration several times.
1862+
1863Does not have a default value; you must configure this variable to
Junio C Hamano8fb66e52011-10-05 20:59:511864enable note rewriting. Set it to `refs/notes/commits` to enable
1865rewriting for the default commit notes.
Junio C Hamano2b3ee5d2010-05-08 05:41:181866+
1867This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1868environment variable, which must be a colon separated list of refs or
1869globs.
Junio C Hamano31667362010-03-25 00:38:531870
Junio C Hamano75cc4c92006-07-24 08:25:031871pack.window::
Junio C Hamano35738e82008-01-07 07:55:461872The size of the window used by linkgit:git-pack-objects[1] when no
Junio C Hamano75cc4c92006-07-24 08:25:031873window size is given on the command line. Defaults to 10.
1874
Junio C Hamano91d44c52007-05-09 07:16:071875pack.depth::
Junio C Hamano35738e82008-01-07 07:55:461876The maximum delta depth used by linkgit:git-pack-objects[1] when no
Junio C Hamano91d44c52007-05-09 07:16:071877maximum depth is given on the command line. Defaults to 50.
1878
Junio C Hamano235d53f2007-07-13 00:25:151879pack.windowMemory::
Junio C Hamano2a4bcbc2014-10-29 20:07:391880The maximum size of memory that is consumed by each thread
1881in linkgit:git-pack-objects[1] for pack window memory when
1882no limit is given on the command line. The value can be
1883suffixed with "k", "m", or "g". When left unconfigured (or
1884set explicitly to 0), there will be no limit.
Junio C Hamano235d53f2007-07-13 00:25:151885
Junio C Hamanof2ce2972007-05-20 19:12:091886pack.compression::
1887An integer -1..9, indicating the compression level for objects
1888in a pack file. -1 is the zlib default. 0 means no
1889compression, and 1..9 are various speed/size tradeoffs, 9 being
1890slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:421891not set, defaults to -1, the zlib default, which is "a default
1892compromise between speed and compression (currently equivalent
1893to level 6)."
Junio C Hamano657fd8a2010-10-07 00:01:241894+
1895Note that changing the compression level will not automatically recompress
1896all existing objects. You can force recompression by passing the -F option
1897to linkgit:git-repack[1].
Junio C Hamanof2ce2972007-05-20 19:12:091898
Junio C Hamano679d22d2007-06-02 21:13:441899pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:271900The maximum memory in bytes used for caching deltas in
Junio C Hamano9f883862009-08-11 06:23:521901linkgit:git-pack-objects[1] before writing them out to a pack.
1902This cache is used to speed up the writing object phase by not
1903having to recompute the final delta result once the best match
1904for all objects is found. Repacking large repositories on machines
1905which are tight with memory might be badly impacted by this though,
1906especially if this cache pushes the system into swapping.
1907A value of 0 means no limit. The smallest size of 1 byte may be
1908used to virtually disable this cache. Defaults to 256 MiB.
Junio C Hamano679d22d2007-06-02 21:13:441909
1910pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:141911The maximum size of a delta, that is cached in
Junio C Hamano9f883862009-08-11 06:23:521912linkgit:git-pack-objects[1]. This cache is used to speed up the
1913writing object phase by not having to recompute the final delta
1914result once the best match for all objects is found. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:441915
Junio C Hamano58155b42007-09-15 07:46:141916pack.threads::
1917Specifies the number of threads to spawn when searching for best
Junio C Hamano35738e82008-01-07 07:55:461918delta matches. This requires that linkgit:git-pack-objects[1]
Junio C Hamano58155b42007-09-15 07:46:141919be compiled with pthreads otherwise this option is ignored with a
1920warning. This is meant to reduce packing time on multiprocessor
1921machines. The required amount of memory for the delta search window
1922is however multiplied by the number of threads.
Junio C Hamano076ffcc2013-02-06 05:13:211923Specifying 0 will cause Git to auto-detect the number of CPU's
Junio C Hamano24bc09a2008-02-28 00:27:441924and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:141925
Junio C Hamanod814b6d2007-11-04 11:13:491926pack.indexVersion::
1927Specify the default pack index version. Valid values are 1 for
1928legacy pack index used by Git versions prior to 1.5.2, and 2 for
1929the new pack index with capabilities for packs larger than 4 GB
1930as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:381931packs. Version 2 is the default. Note that version 2 is enforced
1932and this config option ignored whenever the corresponding pack is
1933larger than 2 GB.
1934+
Junio C Hamano076ffcc2013-02-06 05:13:211935If you have an old Git that does not understand the version 2 `*.idx` file,
Junio C Hamanofce7c7e2008-07-02 03:06:381936cloning or fetching over a non native protocol (e.g. "http" and "rsync")
Junio C Hamanob76a6862012-05-02 22:02:461937that will copy both `*.pack` file and corresponding `*.idx` file from the
Junio C Hamanofce7c7e2008-07-02 03:06:381938other side may give you a repository that cannot be accessed with your
Junio C Hamano076ffcc2013-02-06 05:13:211939older version of Git. If the `*.pack` file is smaller than 2 GB, however,
Junio C Hamanofce7c7e2008-07-02 03:06:381940you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
Junio C Hamanob76a6862012-05-02 22:02:461941the `*.idx` file.
Junio C Hamanod814b6d2007-11-04 11:13:491942
Junio C Hamano09a926d2008-03-13 07:55:291943pack.packSizeLimit::
Junio C Hamano4d979582010-02-04 06:27:291944The maximum size of a pack. This setting only affects
1945packing to a file when repacking, i.e. the git:// protocol
Junio C Hamanob76a6862012-05-02 22:02:461946is unaffected. It can be overridden by the `--max-pack-size`
Junio C Hamano4d979582010-02-04 06:27:291947option of linkgit:git-repack[1]. The minimum size allowed is
1948limited to 1 MiB. The default is unlimited.
1949Common unit suffixes of 'k', 'm', or 'g' are
1950supported.
Junio C Hamano49dccaf2008-02-10 10:48:011951
Junio C Hamano5b3533d2014-02-27 23:07:151952pack.useBitmaps::
1953When true, git will use pack bitmaps (if available) when packing
1954to stdout (e.g., during the server side of a fetch). Defaults to
1955true. You should not generally need to turn this off unless
1956you are debugging pack bitmaps.
1957
1958pack.writebitmaps::
Junio C Hamano38d02532014-06-26 21:48:501959This is a deprecated synonym for `repack.writeBitmaps`.
Junio C Hamano5b3533d2014-02-27 23:07:151960
1961pack.writeBitmapHashCache::
1962When true, git will include a "hash cache" section in the bitmap
1963index (if one is written). This cache can be used to feed git's
1964delta heuristics, potentially leading to better deltas between
1965bitmapped and non-bitmapped objects (e.g., when serving a fetch
1966between an older, bitmapped pack and objects that have been
1967pushed since the last gc). The downside is that it consumes 4
1968bytes per object of disk space, and that JGit's bitmap
1969implementation does not understand it, causing it to complain if
1970Git and JGit are used on the same repository. Defaults to false.
1971
Junio C Hamano9e96a1a2008-08-16 10:23:181972pager.<cmd>::
Junio C Hamano788eeba2010-12-08 22:50:431973If the value is boolean, turns on or off pagination of the
Junio C Hamano076ffcc2013-02-06 05:13:211974output of a particular Git subcommand when writing to a tty.
Junio C Hamano788eeba2010-12-08 22:50:431975Otherwise, turns on pagination for the subcommand using the
Junio C Hamanob76a6862012-05-02 22:02:461976pager specified by the value of `pager.<cmd>`. If `--paginate`
1977or `--no-pager` is specified on the command line, it takes
Junio C Hamano788eeba2010-12-08 22:50:431978precedence over this option. To disable pagination for all
1979commands, set `core.pager` or `GIT_PAGER` to `cat`.
Junio C Hamano9e96a1a2008-08-16 10:23:181980
Junio C Hamanoa574a092010-06-13 19:57:101981pretty.<name>::
1982Alias for a --pretty= format string, as specified in
1983linkgit:git-log[1]. Any aliases defined here can be used just
1984as the built-in pretty formats could. For example,
Junio C Hamanob76a6862012-05-02 22:02:461985running `git config pretty.changelog "format:* %H %s"`
Junio C Hamanoa574a092010-06-13 19:57:101986would cause the invocation `git log --pretty=changelog`
Junio C Hamanob76a6862012-05-02 22:02:461987to be equivalent to running `git log "--pretty=format:* %H %s"`.
Junio C Hamanoa574a092010-06-13 19:57:101988Note that an alias with the same name as a built-in format
1989will be silently ignored.
1990
Junio C Hamano5b3533d2014-02-27 23:07:151991pull.ff::
1992By default, Git does not create an extra merge commit when merging
1993a commit that is a descendant of the current commit. Instead, the
1994tip of the current branch is fast-forwarded. When set to `false`,
1995this variable tells Git to create an extra merge commit in such
1996a case (equivalent to giving the `--no-ff` option from the command
1997line). When set to `only`, only such fast-forward merges are
1998allowed (equivalent to giving the `--ff-only` option from the
1999command line).
2000
Junio C Hamano515ab1d2011-12-09 23:41:202001pull.rebase::
2002When true, rebase branches on top of the fetched branch, instead
2003of merging the default branch from the default remote when "git
2004pull" is run. See "branch.<name>.rebase" for setting this on a
2005per-branch basis.
2006+
Junio C Hamanocf4a1742013-09-11 22:57:502007When preserve, also pass `--preserve-merges` along to 'git rebase'
2008so that locally committed merge commits will not be flattened
2009by running 'git pull'.
2010+
Junio C Hamano515ab1d2011-12-09 23:41:202011*NOTE*: this is a possibly dangerous operation; do *not* use
2012it unless you understand the implications (see linkgit:git-rebase[1]
2013for details).
2014
Junio C Hamano07824ce2006-04-25 07:36:542015pull.octopus::
2016The default merge strategy to use when pulling multiple branches
2017at once.
2018
2019pull.twohead::
2020The default merge strategy to use when pulling a single branch.
2021
Junio C Hamano1de75722009-03-26 08:39:382022push.default::
Junio C Hamano58655592013-07-11 20:52:332023Defines the action `git push` should take if no refspec is
2024explicitly given. Different values are well-suited for
2025specific workflows; for instance, in a purely central workflow
2026(i.e. the fetch source is equal to the push destination),
2027`upstream` is probably what you want. Possible values are:
Junio C Hamano1de75722009-03-26 08:39:382028+
Junio C Hamanobcaa8bc2012-07-03 22:17:202029--
Junio C Hamano58655592013-07-11 20:52:332030
2031* `nothing` - do not push anything (error out) unless a refspec is
2032 explicitly given. This is primarily meant for people who want to
2033 avoid mistakes by always being explicit.
2034
2035* `current` - push the current branch to update a branch with the same
2036 name on the receiving end. Works in both central and non-central
2037 workflows.
2038
2039* `upstream` - push the current branch back to the branch whose
2040 changes are usually integrated into the current branch (which is
2041 called `@{upstream}`). This mode only makes sense if you are
2042 pushing to the same repository you would normally pull from
2043 (i.e. central workflow).
2044
2045* `simple` - in centralized workflow, work like `upstream` with an
2046 added safety to refuse to push if the upstream branch's name is
2047 different from the local one.
Junio C Hamanobcaa8bc2012-07-03 22:17:202048+
Junio C Hamano58655592013-07-11 20:52:332049When pushing to a remote that is different from the remote you normally
2050pull from, work as `current`. This is the safest option and is suited
2051for beginners.
2052+
Junio C Hamano1d669b82014-03-11 21:36:002053This mode has become the default in Git 2.0.
Junio C Hamano58655592013-07-11 20:52:332054
2055* `matching` - push all branches having the same name on both ends.
2056 This makes the repository you are pushing to remember the set of
2057 branches that will be pushed out (e.g. if you always push 'maint'
2058 and 'master' there and no other branches, the repository you push
2059 to will have these two branches, and your local 'maint' and
2060 'master' will be pushed there).
2061+
2062To use this mode effectively, you have to make sure _all_ the
2063branches you would push out are ready to be pushed out before
2064running 'git push', as the whole point of this mode is to allow you
2065to push all of the branches in one go. If you usually finish work
2066on only one branch and push out the result, while other branches are
2067unfinished, this mode is not for you. Also this mode is not
2068suitable for pushing into a shared central repository, as other
2069people may add new branches there, or update the tip of existing
2070branches outside your control.
2071+
Junio C Hamano1d669b82014-03-11 21:36:002072This used to be the default, but not since Git 2.0 (`simple` is the
2073new default).
Junio C Hamano58655592013-07-11 20:52:332074
2075--
Junio C Hamano1de75722009-03-26 08:39:382076
Junio C Hamanoea6a7642009-03-11 23:56:192077rebase.stat::
2078Whether to show a diffstat of what changed upstream since the last
2079rebase. False by default.
2080
Junio C Hamano075ae872010-09-01 18:43:072081rebase.autosquash::
2082If set to true enable '--autosquash' option by default.
2083
Junio C Hamanof1f5a7b2013-06-11 22:23:522084rebase.autostash::
2085When set to true, automatically create a temporary stash
2086before the operation begins, and apply it after the operation
2087ends. This means that you can run rebase on a dirty worktree.
2088However, use with care: the final stash application after a
2089successful rebase might result in non-trivial conflicts.
2090Defaults to false.
2091
Junio C Hamano621e1232009-10-26 05:16:472092receive.autogc::
2093By default, git-receive-pack will run "git-gc --auto" after
2094receiving data from git-push and updating refs. You can stop
2095it by setting this variable to false.
2096
Junio C Hamano9236fea2014-10-14 22:28:092097receive.certnonceseed::
2098By setting this variable to a string, `git receive-pack`
2099will accept a `git push --signed` and verifies it by using
2100a "nonce" protected by HMAC using this string as a secret
2101key.
2102
2103receive.certnonceslop::
2104When a `git push --signed` sent a push certificate with a
2105"nonce" that was issued by a receive-pack serving the same
2106repository within this many seconds, export the "nonce"
2107found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2108hooks (instead of what the receive-pack asked the sending
2109side to include). This may allow writing checks in
2110`pre-receive` and `post-receive` a bit easier. Instead of
2111checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2112that records by how many seconds the nonce is stale to
2113decide if they want to accept the certificate, they only
2114can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2115
Junio C Hamano4653c6f2008-11-26 22:50:202116receive.fsckObjects::
2117If it is set to true, git-receive-pack will check all received
2118objects. It will abort in the case of a malformed object or a
2119broken link. The result of an abort are only dangling objects.
Junio C Hamano8fb66e52011-10-05 20:59:512120Defaults to false. If not set, the value of `transfer.fsckObjects`
2121is used instead.
Junio C Hamano4653c6f2008-11-26 22:50:202122
2123receive.unpackLimit::
2124If the number of objects received in a push is below this
2125limit then the objects will be unpacked into loose object
2126files. However if the number of received objects equals or
2127exceeds this limit then the received pack will be stored as
2128a pack, after adding any missing delta bases. Storing the
2129pack from a push can make the push operation complete faster,
2130especially on slow filesystems. If not set, the value of
2131`transfer.unpackLimit` is used instead.
2132
2133receive.denyDeletes::
2134If set to true, git-receive-pack will deny a ref update that deletes
2135the ref. Use this to prevent such a ref deletion via a push.
2136
Junio C Hamanob4448a82010-07-26 09:02:322137receive.denyDeleteCurrent::
2138If set to true, git-receive-pack will deny a ref update that
2139deletes the currently checked out branch of a non-bare repository.
2140
Junio C Hamano4653c6f2008-11-26 22:50:202141receive.denyCurrentBranch::
Junio C Hamanoe97d5772010-05-19 08:13:582142If set to true or "refuse", git-receive-pack will deny a ref update
Junio C Hamano4653c6f2008-11-26 22:50:202143to the currently checked out branch of a non-bare repository.
2144Such a push is potentially dangerous because it brings the HEAD
2145out of sync with the index and working tree. If set to "warn",
2146print a warning of such a push to stderr, but allow the push to
2147proceed. If set to false or "ignore", allow such pushes with no
Junio C Hamanoafb395b2010-03-17 22:16:152148message. Defaults to "refuse".
Junio C Hamano6df93d92014-12-22 22:48:092149+
2150Another option is "updateInstead" which will update the working
2151directory (must be clean) if pushing into the current branch. This option is
2152intended for synchronizing working directories when one side is not easily
2153accessible via interactive ssh (e.g. a live web site, hence the requirement
2154that the working directory be clean). This mode also comes in handy when
2155developing inside a VM to test and fix code on different Operating Systems.
Junio C Hamano4653c6f2008-11-26 22:50:202156
2157receive.denyNonFastForwards::
2158If set to true, git-receive-pack will deny a ref update which is
Junio C Hamano3f680f32009-11-16 02:10:542159not a fast-forward. Use this to prevent such an update via a push,
Junio C Hamano4653c6f2008-11-26 22:50:202160even if that push is forced. This configuration variable is
2161set when initializing a shared repository.
2162
Junio C Hamano80ad00d2013-02-18 00:19:032163receive.hiderefs::
2164String(s) `receive-pack` uses to decide which refs to omit
2165from its initial advertisement. Use more than one
2166definitions to specify multiple prefix strings. A ref that
2167are under the hierarchies listed on the value of this
2168variable is excluded, and is hidden when responding to `git
2169push`, and an attempt to update or delete a hidden ref by
2170`git push` is rejected.
2171
Junio C Hamano621e1232009-10-26 05:16:472172receive.updateserverinfo::
2173If set to true, git-receive-pack will run git-update-server-info
2174after receiving data from git-push and updating refs.
2175
Junio C Hamano61525f92014-01-17 22:46:492176receive.shallowupdate::
2177If set to true, .git/shallow can be updated when new refs
2178require new shallow roots. Otherwise those refs are rejected.
2179
Junio C Hamano63b6fdb2013-04-07 23:37:132180remote.pushdefault::
2181The remote to push to by default. Overrides
2182`branch.<name>.remote` for all branches, and is overridden by
2183`branch.<name>.pushremote` for specific branches.
2184
Junio C Hamano249572f2006-10-24 05:44:082185remote.<name>.url::
Junio C Hamano35738e82008-01-07 07:55:462186The URL of a remote repository. See linkgit:git-fetch[1] or
2187linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:082188
Junio C Hamano0e88f3e2009-06-21 08:03:252189remote.<name>.pushurl::
2190The push URL of a remote repository. See linkgit:git-push[1].
2191
Junio C Hamano58256872007-12-04 08:31:132192remote.<name>.proxy::
2193For remotes that require curl (http, https and ftp), the URL to
2194the proxy to use for that remote. Set to the empty string to
2195disable proxying for that remote.
2196
Junio C Hamano249572f2006-10-24 05:44:082197remote.<name>.fetch::
Junio C Hamano35738e82008-01-07 07:55:462198The default set of "refspec" for linkgit:git-fetch[1]. See
2199linkgit:git-fetch[1].
Junio C Hamano249572f2006-10-24 05:44:082200
2201remote.<name>.push::
Junio C Hamano35738e82008-01-07 07:55:462202The default set of "refspec" for linkgit:git-push[1]. See
2203linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:082204
Junio C Hamano47d68a52008-05-06 06:35:402205remote.<name>.mirror::
2206If true, pushing to this remote will automatically behave
Junio C Hamanob76a6862012-05-02 22:02:462207as if the `--mirror` option was given on the command line.
Junio C Hamano47d68a52008-05-06 06:35:402208
Junio C Hamano118d2772007-02-21 20:24:102209remote.<name>.skipDefaultUpdate::
2210If true, this remote will be skipped by default when updating
Junio C Hamano9df0c662009-11-23 11:09:272211using linkgit:git-fetch[1] or the `update` subcommand of
2212linkgit:git-remote[1].
2213
2214remote.<name>.skipFetchAll::
2215If true, this remote will be skipped by default when updating
2216using linkgit:git-fetch[1] or the `update` subcommand of
2217linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:102218
Junio C Hamano4ad294b2007-01-20 02:22:502219remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:482220The default program to execute on the remote side when pushing. See
Junio C Hamano86bcccc2008-03-08 09:33:552221option \--receive-pack of linkgit:git-push[1].
Junio C Hamano4ad294b2007-01-20 02:22:502222
Junio C Hamano54ea8d32007-01-25 07:59:482223remote.<name>.uploadpack::
2224The default program to execute on the remote side when fetching. See
Junio C Hamano86bcccc2008-03-08 09:33:552225option \--upload-pack of linkgit:git-fetch-pack[1].
Junio C Hamano54ea8d32007-01-25 07:59:482226
Junio C Hamano17dde0e2007-02-26 09:50:212227remote.<name>.tagopt::
Junio C Hamano86bcccc2008-03-08 09:33:552228Setting this value to \--no-tags disables automatic tag following when
Junio C Hamanocc7636a2010-05-21 14:57:532229fetching from remote <name>. Setting it to \--tags will fetch every
2230tag from remote <name>, even if they are not reachable from remote
Junio C Hamano075ae872010-09-01 18:43:072231branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2232override this setting. See options \--tags and \--no-tags of
2233linkgit:git-fetch[1].
Junio C Hamano17dde0e2007-02-26 09:50:212234
Junio C Hamano096dde22009-12-26 23:14:112235remote.<name>.vcs::
Junio C Hamano076ffcc2013-02-06 05:13:212236Setting this to a value <vcs> will cause Git to interact with
Junio C Hamano096dde22009-12-26 23:14:112237the remote with the git-remote-<vcs> helper.
2238
Junio C Hamano8eac2682013-09-09 22:35:202239remote.<name>.prune::
2240When set to true, fetching from this remote by default will also
Junio C Hamano4c8f2d92013-12-13 00:55:422241remove any remote-tracking references that no longer exist on the
2242remote (as if the `--prune` option was given on the command line).
Junio C Hamano8eac2682013-09-09 22:35:202243Overrides `fetch.prune` settings, if any.
2244
Junio C Hamano118d2772007-02-21 20:24:102245remotes.<group>::
2246The list of remotes which are fetched by "git remote update
Junio C Hamano35738e82008-01-07 07:55:462247<group>". See linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:102248
Junio C Hamano77b7e902006-10-23 07:18:502249repack.usedeltabaseoffset::
Junio C Hamanofce7c7e2008-07-02 03:06:382250By default, linkgit:git-repack[1] creates packs that use
2251delta-base offset. If you need to share your repository with
Junio C Hamano076ffcc2013-02-06 05:13:212252Git older than version 1.4.4, either directly or via a dumb
Junio C Hamanofce7c7e2008-07-02 03:06:382253protocol such as http, then you need to set this option to
Junio C Hamano076ffcc2013-02-06 05:13:212254"false" and repack. Access from old Git versions over the
Junio C Hamanofce7c7e2008-07-02 03:06:382255native protocol are unaffected by this option.
Junio C Hamano77b7e902006-10-23 07:18:502256
Junio C Hamano3b0cdc22014-03-18 22:06:162257repack.packKeptObjects::
2258If set to true, makes `git repack` act as if
2259`--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2260details. Defaults to `false` normally, but `true` if a bitmap
2261index is being written (either via `--write-bitmap-index` or
Junio C Hamano38d02532014-06-26 21:48:502262`repack.writeBitmaps`).
2263
2264repack.writeBitmaps::
2265When true, git will write a bitmap index when packing all
2266objects to disk (e.g., when `git repack -a` is run). This
2267index can speed up the "counting objects" phase of subsequent
2268packs created for clones and fetches, at the cost of some disk
2269space and extra time spent on the initial repack. Defaults to
2270false.
Junio C Hamano3b0cdc22014-03-18 22:06:162271
Junio C Hamano4653c6f2008-11-26 22:50:202272rerere.autoupdate::
2273When set to true, `git-rerere` updates the index with the
2274resulting contents after it cleanly resolves conflicts using
2275previously recorded resolution. Defaults to false.
2276
2277rerere.enabled::
2278Activate recording of resolved conflicts, so that identical
Junio C Hamano4fd24422012-01-06 21:52:432279conflict hunks can be resolved automatically, should they be
2280encountered again. By default, linkgit:git-rerere[1] is
2281enabled if there is an `rr-cache` directory under the
Junio C Hamano864ba892012-01-13 17:42:052282`$GIT_DIR`, e.g. if "rerere" was previously used in the
2283repository.
Junio C Hamano4653c6f2008-11-26 22:50:202284
Junio C Hamano1bbd0f42009-07-23 06:20:292285sendemail.identity::
2286A configuration identity. When given, causes values in the
2287'sendemail.<identity>' subsection to take precedence over
2288values in the 'sendemail' section. The default identity is
2289the value of 'sendemail.identity'.
2290
2291sendemail.smtpencryption::
2292See linkgit:git-send-email[1] for description. Note that this
2293setting is not subject to the 'identity' mechanism.
2294
2295sendemail.smtpssl::
2296Deprecated alias for 'sendemail.smtpencryption = ssl'.
2297
Junio C Hamano58f587a2013-07-22 19:20:592298sendemail.smtpsslcertpath::
2299Path to ca-certificates (either a directory or a single file).
2300Set it to an empty string to disable certificate verification.
2301
Junio C Hamano1bbd0f42009-07-23 06:20:292302sendemail.<identity>.*::
2303Identity-specific versions of the 'sendemail.*' parameters
2304found below, taking precedence over those when the this
2305identity is selected, through command-line or
2306'sendemail.identity'.
2307
2308sendemail.aliasesfile::
2309sendemail.aliasfiletype::
Junio C Hamanoea3b7522013-04-18 19:37:532310sendemail.annotate::
Junio C Hamano1bbd0f42009-07-23 06:20:292311sendemail.bcc::
2312sendemail.cc::
2313sendemail.cccmd::
2314sendemail.chainreplyto::
2315sendemail.confirm::
2316sendemail.envelopesender::
2317sendemail.from::
2318sendemail.multiedit::
2319sendemail.signedoffbycc::
2320sendemail.smtppass::
2321sendemail.suppresscc::
2322sendemail.suppressfrom::
2323sendemail.to::
Junio C Hamanocb39aea2010-05-09 07:24:482324sendemail.smtpdomain::
Junio C Hamano1bbd0f42009-07-23 06:20:292325sendemail.smtpserver::
2326sendemail.smtpserverport::
Junio C Hamano39c7a692010-10-27 06:08:542327sendemail.smtpserveroption::
Junio C Hamano1bbd0f42009-07-23 06:20:292328sendemail.smtpuser::
2329sendemail.thread::
Junio C Hamano6df93d92014-12-22 22:48:092330sendemail.transferencoding::
Junio C Hamano1bbd0f42009-07-23 06:20:292331sendemail.validate::
Junio C Hamanoc9394b22015-01-07 22:45:482332sendemail.xmailer::
Junio C Hamano1bbd0f42009-07-23 06:20:292333See linkgit:git-send-email[1] for description.
2334
2335sendemail.signedoffcc::
2336Deprecated alias for 'sendemail.signedoffbycc'.
2337
Junio C Hamano07824ce2006-04-25 07:36:542338showbranch.default::
Junio C Hamano35738e82008-01-07 07:55:462339The default set of branches for linkgit:git-show-branch[1].
2340See linkgit:git-show-branch[1].
Junio C Hamano07824ce2006-04-25 07:36:542341
Junio C Hamano942b35e2007-12-09 10:19:332342status.relativePaths::
Junio C Hamano35738e82008-01-07 07:55:462343By default, linkgit:git-status[1] shows paths relative to the
Junio C Hamano942b35e2007-12-09 10:19:332344current directory. Setting this variable to `false` shows paths
Junio C Hamano076ffcc2013-02-06 05:13:212345relative to the repository root (this was the default for Git
Junio C Hamano942b35e2007-12-09 10:19:332346prior to v1.5.4).
2347
Junio C Hamano58655592013-07-11 20:52:332348status.short::
2349Set to true to enable --short by default in linkgit:git-status[1].
2350The option --no-short takes precedence over this variable.
2351
2352status.branch::
2353Set to true to enable --branch by default in linkgit:git-status[1].
2354The option --no-branch takes precedence over this variable.
2355
Junio C Hamano79f4c7c2013-09-20 21:03:372356status.displayCommentPrefix::
2357If set to true, linkgit:git-status[1] will insert a comment
2358prefix before each output line (starting with
2359`core.commentChar`, i.e. `#` by default). This was the
2360behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2361Defaults to false.
2362
Junio C Hamano4224f992008-06-23 07:14:082363status.showUntrackedFiles::
2364By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2365files which are not currently tracked by Git. Directories which
2366contain only untracked files, are shown with the directory name
2367only. Showing untracked files means that Git needs to lstat() all
Junio C Hamano2efd5e42014-11-10 22:38:522368the files in the whole repository, which might be slow on some
Junio C Hamano4224f992008-06-23 07:14:082369systems. So, this variable controls how the commands displays
2370the untracked files. Possible values are:
2371+
2372--
Junio C Hamano7f9fa862010-10-19 23:51:142373* `no` - Show no untracked files.
2374* `normal` - Show untracked files and directories.
2375* `all` - Show also individual files in untracked directories.
Junio C Hamano4224f992008-06-23 07:14:082376--
2377+
2378If this variable is not specified, it defaults to 'normal'.
2379This variable can be overridden with the -u|--untracked-files option
2380of linkgit:git-status[1] and linkgit:git-commit[1].
2381
Junio C Hamanob671fb52010-06-01 05:06:142382status.submodulesummary::
2383Defaults to false.
2384If this is set to a non zero number or true (identical to -1 or an
2385unlimited number), the submodule summary will be enabled and a
2386summary of commits for modified submodules will be shown (see
Junio C Hamano369e3402013-10-15 18:40:252387--summary-limit option of linkgit:git-submodule[1]). Please note
2388that the summary output command will be suppressed for all
2389submodules when `diff.ignoreSubmodules` is set to 'all' or only
Junio C Hamanoc8c398a2014-06-16 21:14:052390for those submodules where `submodule.<name>.ignore=all`. The only
2391exception to that rule is that status and commit will show staged
2392submodule changes. To
Junio C Hamano369e3402013-10-15 18:40:252393also view the summary for ignored submodules you can either use
Junio C Hamanoe1aeb5e2014-06-06 19:16:292394the --ignore-submodules=dirty command-line option or the 'git
Junio C Hamano369e3402013-10-15 18:40:252395submodule summary' command, which shows a similar output but does
2396not honor these settings.
Junio C Hamanob671fb52010-06-01 05:06:142397
Junio C Hamano78e3a782010-07-15 22:24:452398submodule.<name>.path::
2399submodule.<name>.url::
2400submodule.<name>.update::
2401The path within this project, URL, and the updating strategy
2402for a submodule. These variables are initially populated
2403by 'git submodule init'; edit them to override the
2404URL and other values found in the `.gitmodules` file. See
2405linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2406
Junio C Hamanoabad6da2013-01-06 09:06:322407submodule.<name>.branch::
2408The remote branch name for a submodule, used by `git submodule
2409update --remote`. Set this option to override the value found in
2410the `.gitmodules` file. See linkgit:git-submodule[1] and
2411linkgit:gitmodules[5] for details.
2412
Junio C Hamano0d75e872010-12-17 06:57:262413submodule.<name>.fetchRecurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:102414This option can be used to control recursive fetching of this
Junio C Hamano7165bf72011-01-04 22:06:182415submodule. It can be overridden by using the --[no-]recurse-submodules
Junio C Hamanoe1aeb5e2014-06-06 19:16:292416command-line option to "git fetch" and "git pull".
Junio C Hamano0d75e872010-12-17 06:57:262417This setting will override that from in the linkgit:gitmodules[5]
2418file.
2419
Junio C Hamano619596a2010-08-18 22:15:352420submodule.<name>.ignore::
2421Defines under what circumstances "git status" and the diff family show
2422a submodule as modified. When set to "all", it will never be considered
Junio C Hamanoc8c398a2014-06-16 21:14:052423modified (but it will nonetheless show up in the output of status and
2424commit when it has been staged), "dirty" will ignore all changes
2425to the submodules work tree and
Junio C Hamano619596a2010-08-18 22:15:352426takes only differences between the HEAD of the submodule and the commit
2427recorded in the superproject into account. "untracked" will additionally
2428let submodules with modified tracked files in their work tree show up.
2429Using "none" (the default when this option is not set) also shows
2430submodules that have untracked files in their work tree as changed.
2431This setting overrides any setting made in .gitmodules for this submodule,
Junio C Hamanode9745c2010-08-23 17:10:182432both settings can be overridden on the command line by using the
Junio C Hamano369e3402013-10-15 18:40:252433"--ignore-submodules" option. The 'git submodule' commands are not
2434affected by this setting.
Junio C Hamano619596a2010-08-18 22:15:352435
Junio C Hamano7b43d412014-07-23 23:09:442436tag.sort::
2437This variable controls the sort ordering of tags when displayed by
2438linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2439value of this variable will be used as the default.
2440
Junio C Hamano75cc4c92006-07-24 08:25:032441tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:092442This variable can be used to restrict the permission bits of
2443tar archive entries. The default is 0002, which turns off the
2444world write bit. The special value "user" indicates that the
2445archiving user's umask will be used instead. See umask(2) and
Junio C Hamano35738e82008-01-07 07:55:462446linkgit:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:032447
Junio C Hamano8fb66e52011-10-05 20:59:512448transfer.fsckObjects::
2449When `fetch.fsckObjects` or `receive.fsckObjects` are
2450not set, the value of this variable is used instead.
2451Defaults to false.
2452
Junio C Hamano80ad00d2013-02-18 00:19:032453transfer.hiderefs::
2454This variable can be used to set both `receive.hiderefs`
2455and `uploadpack.hiderefs` at the same time to the same
2456values. See entries for these other variables.
2457
Junio C Hamano4653c6f2008-11-26 22:50:202458transfer.unpackLimit::
2459When `fetch.unpackLimit` or `receive.unpackLimit` are
2460not set, the value of this variable is used instead.
2461The default value is 100.
2462
Junio C Hamano81703b22014-03-14 22:00:272463uploadarchive.allowUnreachable::
2464If true, allow clients to use `git archive --remote` to request
2465any tree, whether reachable from the ref tips or not. See the
2466discussion in the `SECURITY` section of
2467linkgit:git-upload-archive[1] for more details. Defaults to
2468`false`.
2469
Junio C Hamano80ad00d2013-02-18 00:19:032470uploadpack.hiderefs::
2471String(s) `upload-pack` uses to decide which refs to omit
2472from its initial advertisement. Use more than one
2473definitions to specify multiple prefix strings. A ref that
2474are under the hierarchies listed on the value of this
2475variable is excluded, and is hidden from `git ls-remote`,
2476`git fetch`, etc. An attempt to fetch a hidden ref by `git
Junio C Hamano5e7f1312013-03-21 22:49:012477fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2478
2479uploadpack.allowtipsha1inwant::
2480When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2481to accept a fetch request that asks for an object at the tip
2482of a hidden ref (by default, such a request is rejected).
2483see also `uploadpack.hiderefs`.
Junio C Hamano80ad00d2013-02-18 00:19:032484
Junio C Hamano79f4c7c2013-09-20 21:03:372485uploadpack.keepalive::
2486When `upload-pack` has started `pack-objects`, there may be a
2487quiet period while `pack-objects` prepares the pack. Normally
2488it would output progress information, but if `--quiet` was used
2489for the fetch, `pack-objects` will output nothing at all until
2490the pack data begins. Some clients and networks may consider
2491the server to be hung and give up. Setting this option instructs
2492`upload-pack` to send an empty keepalive packet every
2493`uploadpack.keepalive` seconds. Setting this option to 0
2494disables keepalive packets entirely. The default is 5 seconds.
2495
Junio C Hamano24bc09a2008-02-28 00:27:442496url.<base>.insteadOf::
2497Any URL that starts with this value will be rewritten to
2498start, instead, with <base>. In cases where some site serves a
2499large number of repositories, and serves them with multiple
2500access methods, and some users need to use different access
2501methods, this feature allows people to specify any of the
Junio C Hamano076ffcc2013-02-06 05:13:212502equivalent URLs and have Git automatically rewrite the URL to
Junio C Hamano24bc09a2008-02-28 00:27:442503the best alternative for the particular user, even for a
2504never-before-seen repository on the site. When more than one
2505insteadOf strings match a given URL, the longest match is used.
2506
Junio C Hamano7df6dcf2009-09-13 09:51:172507url.<base>.pushInsteadOf::
2508Any URL that starts with this value will not be pushed to;
2509instead, it will be rewritten to start with <base>, and the
2510resulting URL will be pushed to. In cases where some site serves
2511a large number of repositories, and serves them with multiple
2512access methods, some of which do not allow push, this feature
Junio C Hamano076ffcc2013-02-06 05:13:212513allows people to specify a pull-only URL and have Git
Junio C Hamano7df6dcf2009-09-13 09:51:172514automatically use an appropriate URL to push, even for a
2515never-before-seen repository on the site. When more than one
2516pushInsteadOf strings match a given URL, the longest match is
Junio C Hamano076ffcc2013-02-06 05:13:212517used. If a remote has an explicit pushurl, Git will ignore this
Junio C Hamano7df6dcf2009-09-13 09:51:172518setting for that remote.
2519
Junio C Hamano07824ce2006-04-25 07:36:542520user.email::
2521Your email address to be recorded in any newly created commits.
Junio C Hamano469d60e2007-04-29 18:30:342522Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Junio C Hamano35738e82008-01-07 07:55:462523'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:542524
2525user.name::
2526Your full name to be recorded in any newly created commits.
Junio C Hamano341071d2006-06-04 07:24:482527Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Junio C Hamano35738e82008-01-07 07:55:462528environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:542529
Junio C Hamanoa890c4f2007-01-28 10:29:212530user.signingkey::
Junio C Hamano369e3402013-10-15 18:40:252531If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2532key you want it to automatically when creating a signed tag or
2533commit, you can override the default selection with this variable.
2534This option is passed unchanged to gpg's --local-user parameter,
2535so you may specify a key using any method that gpg supports.
Junio C Hamanoa890c4f2007-01-28 10:29:212536
Junio C Hamano4e272312008-01-08 09:13:212537web.browser::
2538Specify a web browser that may be used by some commands.
2539Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2540may use it.