blob: f79184c0a83170ea54298f2b8ac960372371b0f3 [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)
81and `\b` for backspace (BS). No other char escape sequence, nor octal
Junio C Hamanobee172f2007-01-23 08:44:1882char sequences are valid.
83
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
134in the appropriate manual page. You will find a description of non-core
Junio C Hamano07824ce2006-04-25 07:36:54135porcelain configuration variables in the respective porcelain documentation.
136
Junio C Hamano7df6dcf2009-09-13 09:51:17137advice.*::
Junio C Hamano0df92712011-12-21 22:30:44138These variables control various optional help messages designed to
139aid new users. All 'advice.*' variables default to 'true', and you
140can tell Git that you do not need help by setting these to 'false':
Junio C Hamano7df6dcf2009-09-13 09:51:17141+
142--
Junio C Hamanoabad6da2013-01-06 09:06:32143pushUpdateRejected::
Junio C Hamano0c1b64e2012-04-20 23:50:49144Set this variable to 'false' if you want to disable
Junio C Hamanoabad6da2013-01-06 09:06:32145'pushNonFFCurrent', 'pushNonFFDefault',
Junio C Hamano3f2ed6f2013-02-04 19:24:09146'pushNonFFMatching', 'pushAlreadyExists',
147'pushFetchFirst', and 'pushNeedsForce'
Junio C Hamanoabad6da2013-01-06 09:06:32148simultaneously.
Junio C Hamano0c1b64e2012-04-20 23:50:49149pushNonFFCurrent::
150Advice shown when linkgit:git-push[1] fails due to a
151non-fast-forward update to the current branch.
152pushNonFFDefault::
153Advice to set 'push.default' to 'upstream' or 'current'
154when you ran linkgit:git-push[1] and pushed 'matching
155refs' by default (i.e. you did not provide an explicit
156refspec, and no 'push.default' configuration was set)
157and it resulted in a non-fast-forward error.
158pushNonFFMatching::
159Advice shown when you ran linkgit:git-push[1] and pushed
160'matching refs' explicitly (i.e. you used ':', or
161specified a refspec that isn't your current branch) and
162it resulted in a non-fast-forward error.
Junio C Hamanoabad6da2013-01-06 09:06:32163pushAlreadyExists::
164Shown when linkgit:git-push[1] rejects an update that
165does not qualify for fast-forwarding (e.g., a tag.)
Junio C Hamano3f2ed6f2013-02-04 19:24:09166pushFetchFirst::
167Shown when linkgit:git-push[1] rejects an update that
168tries to overwrite a remote ref that points at an
169object we do not have.
170pushNeedsForce::
171Shown when linkgit:git-push[1] rejects an update that
172tries to overwrite a remote ref that points at an
173object that is not a committish, or make the remote
174ref point at an object that is not a committish.
Junio C Hamano7df6dcf2009-09-13 09:51:17175statusHints::
Junio C Hamano644936c2012-06-28 23:05:14176Show directions on how to proceed from the current
Junio C Hamano917cd4f2012-12-04 23:41:10177state in the output of linkgit:git-status[1], in
Junio C Hamano644936c2012-06-28 23:05:14178the template shown when writing commit messages in
Junio C Hamano917cd4f2012-12-04 23:41:10179linkgit:git-commit[1], and in the help message shown
180by linkgit:git-checkout[1] when switching branch.
Junio C Hamano5e7f1312013-03-21 22:49:01181statusUoption::
182Advise to consider using the `-u` option to linkgit:git-status[1]
183when the command takes more than 2 seconds to enumerate untracked
184files.
Junio C Hamano5706e0b2009-11-24 10:54:16185commitBeforeMerge::
186Advice shown when linkgit:git-merge[1] refuses to
Junio C Hamano619596a2010-08-18 22:15:35187merge to avoid overwriting local changes.
Junio C Hamanoa9701f02010-01-21 00:42:16188resolveConflict::
Junio C Hamano5dab5a92013-02-25 18:51:24189Advice shown by various commands when conflicts
Junio C Hamanoa9701f02010-01-21 00:42:16190prevent the operation from being performed.
Junio C Hamanoa9701f02010-01-21 00:42:16191implicitIdentity::
192Advice on how to set your identity configuration when
193your information is guessed from the system username and
Junio C Hamano0df92712011-12-21 22:30:44194domain name.
Junio C Hamano74a198f2010-02-22 00:13:31195detachedHead::
Junio C Hamano0df92712011-12-21 22:30:44196Advice shown when you used linkgit:git-checkout[1] to
Junio C Hamano74a198f2010-02-22 00:13:31197move to the detach HEAD state, to instruct how to create
Junio C Hamano0df92712011-12-21 22:30:44198a local branch after the fact.
Junio C Hamanobb300642012-07-22 21:09:14199amWorkDir::
200Advice that shows the location of the patch file when
201linkgit:git-am[1] fails to apply it.
Junio C Hamano7df6dcf2009-09-13 09:51:17202--
203
Junio C Hamano07824ce2006-04-25 07:36:54204core.fileMode::
205If false, the executable bit differences between the index and
Junio C Hamano8fb66e52011-10-05 20:59:51206the working tree are ignored; useful on broken filesystems like FAT.
Junio C Hamano9df0c662009-11-23 11:09:27207See linkgit:git-update-index[1].
208+
209The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
210will probe and set core.fileMode false if appropriate when the
211repository is created.
Junio C Hamano07824ce2006-04-25 07:36:54212
Junio C Hamanoa476efa2008-10-10 15:31:42213core.ignoreCygwinFSTricks::
214This option is only used by Cygwin implementation of Git. If false,
215the Cygwin stat() and lstat() functions are used. This may be useful
216if your repository consists of a few separate directories joined in
217one hierarchy using Cygwin mount. If true, Git uses native Win32 API
218whenever it is possible and falls back to Cygwin functions only to
219handle symbol links. The native mode is more than twice faster than
Junio C Hamano7d06a8a2008-10-20 05:42:33220normal Cygwin l/stat() functions. True by default, unless core.filemode
221is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
222POSIX emulation is required to support core.filemode.
Junio C Hamanoa476efa2008-10-10 15:31:42223
Junio C Hamano9df0c662009-11-23 11:09:27224core.ignorecase::
225If true, this option enables various workarounds to enable
Junio C Hamano076ffcc2013-02-06 05:13:21226Git to work better on filesystems that are not case sensitive,
Junio C Hamano9df0c662009-11-23 11:09:27227like FAT. For example, if a directory listing finds
Junio C Hamano076ffcc2013-02-06 05:13:21228"makefile" when Git expects "Makefile", Git will assume
Junio C Hamano9df0c662009-11-23 11:09:27229it is really the same file, and continue to remember it as
230"Makefile".
231+
232The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
233will probe and set core.ignorecase true if appropriate when the repository
234is created.
235
Junio C Hamanob61a7772012-07-13 23:34:48236core.precomposeunicode::
Junio C Hamano076ffcc2013-02-06 05:13:21237This option is only used by Mac OS implementation of Git.
238When core.precomposeunicode=true, Git reverts the unicode decomposition
Junio C Hamanob61a7772012-07-13 23:34:48239of filenames done by Mac OS. This is useful when sharing a repository
240between Mac OS and Linux or Windows.
Junio C Hamano076ffcc2013-02-06 05:13:21241(Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
242When false, file names are handled fully transparent by Git,
243which is backward compatible with older versions of Git.
Junio C Hamanob61a7772012-07-13 23:34:48244
Junio C Hamano90ccff32008-07-29 08:17:24245core.trustctime::
246If false, the ctime differences between the index and the
Junio C Hamano8fb66e52011-10-05 20:59:51247working tree are ignored; useful when the inode change time
Junio C Hamano90ccff32008-07-29 08:17:24248is regularly modified by something outside Git (file system
249crawlers and some backup systems).
250See linkgit:git-update-index[1]. True by default.
251
Junio C Hamano4cfed0c2013-01-30 17:58:54252core.checkstat::
253Determines which stat fields to match between the index
254and work tree. The user can set this to 'default' or
255'minimal'. Default (or explicitly 'default'), is to check
256all fields, including the sub-second part of mtime and ctime.
257
Junio C Hamanod526ba92007-07-02 00:17:42258core.quotepath::
Junio C Hamanoba4b9282008-07-06 05:20:31259The commands that output paths (e.g. 'ls-files',
260'diff'), when not given the `-z` option, will quote
Junio C Hamanod526ba92007-07-02 00:17:42261"unusual" characters in the pathname by enclosing the
262pathname in a double-quote pair and with backslashes the
263same way strings in C source code are quoted. If this
264variable is set to false, the bytes higher than 0x80 are
265not quoted but output as verbatim. Note that double
266quote, backslash and control characters are always
267quoted without `-z` regardless of the setting of this
268variable.
269
Junio C Hamanobb88cf42010-06-21 15:23:55270core.eol::
271Sets the line ending type to use in the working directory for
272files that have the `text` property set. Alternatives are
273'lf', 'crlf' and 'native', which uses the platform's native
274line ending. The default value is `native`. See
275linkgit:gitattributes[5] for more information on end-of-line
276conversion.
Junio C Hamanod9e0e5d2007-04-14 16:22:04277
Junio C Hamano26e590a2008-02-17 03:53:51278core.safecrlf::
Junio C Hamano076ffcc2013-02-06 05:13:21279If true, makes Git check if converting `CRLF` is reversible when
Junio C Hamanobb88cf42010-06-21 15:23:55280end-of-line conversion is active. Git will verify if a command
Junio C Hamano26e590a2008-02-17 03:53:51281modifies a file in the work tree either directly or indirectly.
282For example, committing a file followed by checking out the
283same file should yield the original file in the work tree. If
284this is not the case for the current setting of
Junio C Hamano076ffcc2013-02-06 05:13:21285`core.autocrlf`, Git will reject the file. The variable can
286be set to "warn", in which case Git will only warn about an
Junio C Hamano26e590a2008-02-17 03:53:51287irreversible conversion but continue the operation.
288+
289CRLF conversion bears a slight chance of corrupting data.
Junio C Hamano076ffcc2013-02-06 05:13:21290When it is enabled, Git will convert CRLF to LF during commit and LF to
Junio C Hamano26e590a2008-02-17 03:53:51291CRLF during checkout. A file that contains a mixture of LF and
Junio C Hamano076ffcc2013-02-06 05:13:21292CRLF before the commit cannot be recreated by Git. For text
Junio C Hamano26e590a2008-02-17 03:53:51293files this is the right thing to do: it corrects line endings
294such that we have only LF line endings in the repository.
295But for binary files that are accidentally classified as text the
296conversion can corrupt data.
297+
298If you recognize such corruption early you can easily fix it by
299setting the conversion type explicitly in .gitattributes. Right
300after committing you still have the original file in your work
301tree and this file is not yet corrupted. You can explicitly tell
Junio C Hamano076ffcc2013-02-06 05:13:21302Git that this file is binary and Git will handle the file
Junio C Hamano26e590a2008-02-17 03:53:51303appropriately.
304+
305Unfortunately, the desired effect of cleaning up text files with
306mixed line endings and the undesired effect of corrupting binary
307files cannot be distinguished. In both cases CRLFs are removed
308in an irreversible way. For text files this is the right thing
309to do because CRLFs are line endings, while for binary files
310converting CRLFs corrupts data.
311+
312Note, this safety check does not mean that a checkout will generate a
313file identical to the original file for a different setting of
Junio C Hamanobb88cf42010-06-21 15:23:55314`core.eol` and `core.autocrlf`, but only for the current one. For
315example, a text file with `LF` would be accepted with `core.eol=lf`
316and could later be checked out with `core.eol=crlf`, in which case the
Junio C Hamano26e590a2008-02-17 03:53:51317resulting file would contain `CRLF`, although the original file
318contained `LF`. However, in both work trees the line endings would be
319consistent, that is either all `LF` or all `CRLF`, but never mixed. A
320file with mixed line endings would be reported by the `core.safecrlf`
321mechanism.
322
Junio C Hamanobb88cf42010-06-21 15:23:55323core.autocrlf::
324Setting this variable to "true" is almost the same as setting
325the `text` attribute to "auto" on all files except that text
326files are not guaranteed to be normalized: files that contain
327`CRLF` in the repository will not be touched. Use this
328setting if you want to have `CRLF` line endings in your
329working directory even though the repository does not have
330normalized line endings. This variable can be set to 'input',
331in which case no output conversion is performed.
332
Junio C Hamanoaa83a7d2007-03-05 02:37:29333core.symlinks::
334If false, symbolic links are checked out as small plain files that
Junio C Hamano35738e82008-01-07 07:55:46335contain the link text. linkgit:git-update-index[1] and
336linkgit:git-add[1] will not change the recorded type to regular
Junio C Hamanoaa83a7d2007-03-05 02:37:29337file. Useful on filesystems like FAT that do not support
Junio C Hamano9df0c662009-11-23 11:09:27338symbolic links.
339+
340The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
341will probe and set core.symlinks false if appropriate when the repository
342is created.
Junio C Hamanoaa83a7d2007-03-05 02:37:29343
Junio C Hamano07824ce2006-04-25 07:36:54344core.gitProxy::
345A "proxy command" to execute (as 'command host port') instead
346of establishing direct connection to the remote server when
Junio C Hamano076ffcc2013-02-06 05:13:21347using the Git protocol for fetching. If the variable value is
Junio C Hamano07824ce2006-04-25 07:36:54348in the "COMMAND for DOMAIN" format, the command is applied only
349on hostnames ending with the specified domain string. This variable
350may be set multiple times and is matched in the given order;
351the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17352+
353Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
354(which always applies universally, without the special "for"
355handling).
Junio C Hamanoea82cff2009-03-18 01:54:48356+
357The special string `none` can be used as the proxy command to
358specify that no proxy be used for a given domain pattern.
359This is useful for excluding servers inside a firewall from
360proxy use, while defaulting to a common proxy for external domains.
Junio C Hamano07824ce2006-04-25 07:36:54361
362core.ignoreStat::
Junio C Hamano054ea082008-06-01 08:26:34363If true, commands which modify both the working tree and the index
364will mark the updated paths with the "assume unchanged" bit in the
365index. These marked files are then assumed to stay unchanged in the
Junio C Hamano8fb66e52011-10-05 20:59:51366working tree, until you mark them otherwise manually - Git will not
Junio C Hamano054ea082008-06-01 08:26:34367detect the file changes by lstat() calls. This is useful on systems
368where those are very slow, such as Microsoft Windows.
369See linkgit:git-update-index[1].
Junio C Hamano07824ce2006-04-25 07:36:54370False by default.
371
Junio C Hamano88a3a072006-05-04 08:01:43372core.preferSymlinkRefs::
373Instead of the default "symref" format for HEAD
374and other symbolic reference files, use symbolic links.
375This is sometimes needed to work with old scripts that
376expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54377
Junio C Hamano1025e752007-02-23 07:21:26378core.bare::
379If true this repository is assumed to be 'bare' and has no
380working directory associated with it. If this is the case a
381number of commands that require a working directory will be
Junio C Hamano35738e82008-01-07 07:55:46382disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Junio C Hamano1025e752007-02-23 07:21:26383+
Junio C Hamano35738e82008-01-07 07:55:46384This setting is automatically guessed by linkgit:git-clone[1] or
385linkgit:git-init[1] when the repository was created. By default a
Junio C Hamano1025e752007-02-23 07:21:26386repository that ends in "/.git" is assumed to be not bare (bare =
387false), while all other repositories are assumed to be bare (bare
388= true).
389
Junio C Hamanod526ba92007-07-02 00:17:42390core.worktree::
Junio C Hamano80d58462011-01-24 22:52:52391Set the path to the root of the working tree.
Junio C Hamano764a6672007-10-23 01:23:31392This can be overridden by the GIT_WORK_TREE environment
Junio C Hamano80d58462011-01-24 22:52:52393variable and the '--work-tree' command line option.
Junio C Hamano5cd15182011-04-05 00:21:10394The value can be an absolute path or relative to the path to
Junio C Hamano80d58462011-01-24 22:52:52395the .git directory, which is either specified by --git-dir
396or GIT_DIR, or automatically discovered.
397If --git-dir or GIT_DIR is specified but none of
Junio C Hamano7d575a52008-04-30 08:45:27398--work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamano80d58462011-01-24 22:52:52399the current working directory is regarded as the top level
Junio C Hamano3609b332010-12-29 01:34:52400of your working tree.
Junio C Hamano80d58462011-01-24 22:52:52401+
402Note that this variable is honored even when set in a configuration
403file in a ".git" subdirectory of a directory and its value differs
404from the latter directory (e.g. "/path/to/.git/config" has
405core.worktree set to "/different/path"), which is most likely a
Junio C Hamano076ffcc2013-02-06 05:13:21406misconfiguration. Running Git commands in the "/path/to" directory will
Junio C Hamano80d58462011-01-24 22:52:52407still use "/different/path" as the root of the work tree and can cause
408confusion unless you know what you are doing (e.g. you are creating a
409read-only snapshot of the same index to a location different from the
410repository's usual working tree).
Junio C Hamanod526ba92007-07-02 00:17:42411
Junio C Hamano341071d2006-06-04 07:24:48412core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49413Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamanoa2ec14f2006-11-02 00:22:48414"$GIT_DIR/logs/<ref>", by appending the new and old
415SHA1, the date/time and the reason of the update, but
416only when the file exists. If this configuration
417variable is set to true, missing "$GIT_DIR/logs/<ref>"
Junio C Hamano15567bc2011-07-23 00:51:59418file is automatically created for branch heads (i.e. under
419refs/heads/), remote refs (i.e. under refs/remotes/),
420note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
Junio C Hamano1caaf472006-12-31 08:29:35421+
422This information can be used to determine what commit
423was the tip of a branch "2 days ago".
424+
425This value is true by default in a repository that has
426a working directory associated with it, and false by
427default in a bare repository.
Junio C Hamano341071d2006-06-04 07:24:48428
Junio C Hamano07824ce2006-04-25 07:36:54429core.repositoryFormatVersion::
430Internal variable identifying the repository format and layout
431version.
432
433core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42434When 'group' (or 'true'), the repository is made shareable between
435several users in a group (making sure all the files and objects are
436group-writable). When 'all' (or 'world' or 'everybody'), the
437repository will be readable by all users, additionally to being
Junio C Hamano076ffcc2013-02-06 05:13:21438group-shareable. When 'umask' (or 'false'), Git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37439reported by umask(2). When '0xxx', where '0xxx' is an octal number,
440files in the repository will have this mode value. '0xxx' will override
Junio C Hamano83eded12009-04-20 08:18:00441user's umask value (whereas the other options will only override
442requested parts of the user's umask value). Examples: '0660' will make
443the repo read/write-able for the owner and group, but inaccessible to
444others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Junio C Hamano2f102bb2008-04-26 02:23:37445repository that is group-readable but not group-writable.
446See linkgit:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54447
448core.warnAmbiguousRefs::
Junio C Hamano076ffcc2013-02-06 05:13:21449If true, Git will warn you if the ref name you passed it is ambiguous
Junio C Hamano947ab822013-03-19 23:07:29450and might match multiple refs in the repository. True by default.
Junio C Hamano07824ce2006-04-25 07:36:54451
Junio C Hamano7ec15722006-07-07 02:03:59452core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09453An integer -1..9, indicating a default compression level.
454-1 is the zlib default. 0 means no compression,
455and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42456If set, this provides a default to other compression variables,
457such as 'core.loosecompression' and 'pack.compression'.
Junio C Hamanoa126a3b2006-07-04 04:55:26458
Junio C Hamanof2ce2972007-05-20 19:12:09459core.loosecompression::
460An integer -1..9, indicating the compression level for objects that
461are not in a pack file. -1 is the zlib default. 0 means no
462compression, and 1..9 are various speed/size tradeoffs, 9 being
463slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42464not set, defaults to 1 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49465
Junio C Hamanofc4d38c2007-01-08 06:53:32466core.packedGitWindowSize::
467Number of bytes of a pack file to map into memory in a
468single mapping operation. Larger window sizes may allow
469your system to process a smaller number of large pack files
470more quickly. Smaller window sizes will negatively affect
471performance due to increased calls to the operating system's
472memory manager, but may improve performance when accessing
473a large number of large pack files.
474+
475Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
476MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
477be reasonable for all users/operating systems. You probably do
478not need to adjust this value.
479+
480Common unit suffixes of 'k', 'm', or 'g' are supported.
481
482core.packedGitLimit::
483Maximum number of bytes to map simultaneously into memory
484from pack files. If Git needs to access more than this many
485bytes at once to complete an operation it will unmap existing
486regions to reclaim virtual address space within the process.
487+
488Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
489This should be reasonable for all users/operating systems, except on
490the largest projects. You probably do not need to adjust this value.
491+
492Common unit suffixes of 'k', 'm', or 'g' are supported.
493
Junio C Hamanob8c51282007-03-19 10:43:30494core.deltaBaseCacheLimit::
495Maximum number of bytes to reserve for caching base objects
Junio C Hamano619596a2010-08-18 22:15:35496that may be referenced by multiple deltified objects. By storing the
Junio C Hamanob8c51282007-03-19 10:43:30497entire decompressed base objects in a cache Git is able
498to avoid unpacking and decompressing frequently used base
499objects multiple times.
500+
501Default is 16 MiB on all platforms. This should be reasonable
502for all users/operating systems, except on the largest projects.
503You probably do not need to adjust this value.
504+
505Common unit suffixes of 'k', 'm', or 'g' are supported.
506
Junio C Hamano5c246f22010-02-03 07:34:53507core.bigFileThreshold::
508Files larger than this size are stored deflated, without
509attempting delta compression. Storing large files without
510delta compression avoids excessive memory usage, at the
511slight expense of increased disk usage.
512+
513Default is 512 MiB on all platforms. This should be reasonable
514for most projects as source code and other text files can still
515be delta compressed, but larger binary media files won't be.
516+
517Common unit suffixes of 'k', 'm', or 'g' are supported.
Junio C Hamano5c246f22010-02-03 07:34:53518
Junio C Hamano1d90cb02007-07-03 07:05:31519core.excludesfile::
Junio C Hamano5e284b42007-05-22 07:23:37520In addition to '.gitignore' (per-directory) and
Junio C Hamano076ffcc2013-02-06 05:13:21521'.git/info/exclude', Git looks into this file for patterns
Junio C Hamanob76a6862012-05-02 22:02:46522of files which are not meant to be tracked. "`~/`" is expanded
523to the value of `$HOME` and "`~user/`" to the specified user's
Junio C Hamano8edb4c72012-07-09 20:33:55524home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
525If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
526is used instead. See linkgit:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37527
Junio C Hamano3fd7b262010-09-08 22:44:20528core.askpass::
529Some commands (e.g. svn and http interfaces) that interactively
530ask for a password can be told to use an external program given
531via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
532environment variable. If not set, fall back to the value of the
533'SSH_ASKPASS' environment variable or, failing that, a simple password
534prompt. The external program shall be given a suitable prompt as
535command line argument and write the password on its STDOUT.
536
Junio C Hamano3b4609d2010-09-30 00:04:34537core.attributesfile::
538In addition to '.gitattributes' (per-directory) and
Junio C Hamano076ffcc2013-02-06 05:13:21539'.git/info/attributes', Git looks into this file for attributes
Junio C Hamano3b4609d2010-09-30 00:04:34540(see linkgit:gitattributes[5]). Path expansions are made the same
Junio C Hamano8edb4c72012-07-09 20:33:55541way as for `core.excludesfile`. Its default value is
542$XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
543set or empty, $HOME/.config/git/attributes is used instead.
Junio C Hamano3b4609d2010-09-30 00:04:34544
Junio C Hamanof6002a92007-07-20 10:28:22545core.editor::
546Commands such as `commit` and `tag` that lets you edit
Junio C Hamanoa6387422007-08-25 03:54:27547messages by launching an editor uses the value of this
Junio C Hamanof6002a92007-07-20 10:28:22548variable when it is set, and the environment variable
Junio C Hamano3b70d3c2009-11-21 17:37:37549`GIT_EDITOR` is not set. See linkgit:git-var[1].
Junio C Hamanof6002a92007-07-20 10:28:22550
Junio C Hamano3f2ed6f2013-02-04 19:24:09551core.commentchar::
552Commands such as `commit` and `tag` that lets you edit
553messages consider a line that begins with this character
554commented, and removes them after the editor returns
555(default '#').
556
Junio C Hamano6231f822011-10-24 05:18:52557sequence.editor::
Junio C Hamano778a3412013-03-28 23:24:30558Text editor used by `git rebase -i` for editing the rebase instruction file.
Junio C Hamano6231f822011-10-24 05:18:52559The value is meant to be interpreted by the shell when it is used.
560It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
561When not configured the default commit message editor is used instead.
562
Junio C Hamano28d8ede2007-07-05 05:51:38563core.pager::
Junio C Hamano076ffcc2013-02-06 05:13:21564The command that Git will use to paginate output. Can
Junio C Hamano0551f6a2008-08-25 00:33:33565be overridden with the `GIT_PAGER` environment
Junio C Hamano076ffcc2013-02-06 05:13:21566variable. Note that Git sets the `LESS` environment
Junio C Hamano0551f6a2008-08-25 00:33:33567variable to `FRSX` if it is unset when it runs the
568pager. One can change these settings by setting the
Junio C Hamanoa476efa2008-10-10 15:31:42569`LESS` variable to some other value. Alternately,
570these settings can be overridden on a project or
571global basis by setting the `core.pager` option.
Junio C Hamanoa1295452012-11-13 22:32:04572Setting `core.pager` has no effect on the `LESS`
Junio C Hamanoa476efa2008-10-10 15:31:42573environment variable behaviour above, so if you want
Junio C Hamano076ffcc2013-02-06 05:13:21574to override Git's default settings this way, you need
Junio C Hamanoa476efa2008-10-10 15:31:42575to be explicit. For example, to disable the S option
576in a backward compatible manner, set `core.pager`
Junio C Hamanoa1295452012-11-13 22:32:04577to `less -+S`. This will be passed to the shell by
Junio C Hamano076ffcc2013-02-06 05:13:21578Git, which will translate the final command to
Junio C Hamanoa1295452012-11-13 22:32:04579`LESS=FRSX less -+S`.
Junio C Hamano28d8ede2007-07-05 05:51:38580
Junio C Hamano942b35e2007-12-09 10:19:33581core.whitespace::
582A comma separated list of common whitespace problems to
Junio C Hamano1aa40d22010-01-21 17:46:43583notice. 'git diff' will use `color.diff.whitespace` to
584highlight them, and 'git apply --whitespace=error' will
Junio C Hamano3db8b412008-07-26 06:45:59585consider them as errors. You can prefix `-` to disable
586any of them (e.g. `-trailing-space`):
Junio C Hamano942b35e2007-12-09 10:19:33587+
Junio C Hamanob71a22d2009-10-17 08:23:47588* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano942b35e2007-12-09 10:19:33589 as an error (enabled by default).
590* `space-before-tab` treats a space character that appears immediately
591 before a tab character in the initial indent part of the line as an
592 error (enabled by default).
Junio C Hamano281fd392012-09-17 23:57:41593* `indent-with-non-tab` treats a line that is indented with space
594 characters instead of the equivalent tabs as an error (not enabled by
595 default).
Junio C Hamanocb39aea2010-05-09 07:24:48596* `tab-in-indent` treats a tab character in the initial indent part of
597 the line as an error (not enabled by default).
Junio C Hamanob71a22d2009-10-17 08:23:47598* `blank-at-eof` treats blank lines added at the end of file as an error
599 (enabled by default).
600* `trailing-space` is a short-hand to cover both `blank-at-eol` and
601 `blank-at-eof`.
Junio C Hamano601f3e52008-02-25 08:40:42602* `cr-at-eol` treats a carriage-return at the end of line as
603 part of the line terminator, i.e. with it, `trailing-space`
604 does not trigger if the character before such a carriage-return
605 is not a whitespace (not enabled by default).
Junio C Hamanoeef01fe2010-12-13 08:31:58606* `tabwidth=<n>` tells how many character positions a tab occupies; this
Junio C Hamano076ffcc2013-02-06 05:13:21607 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
Junio C Hamanoeef01fe2010-12-13 08:31:58608 errors. The default tab width is 8. Allowed values are 1 to 63.
Junio C Hamano942b35e2007-12-09 10:19:33609
Junio C Hamano9eb57532008-06-26 06:33:46610core.fsyncobjectfiles::
611This boolean will enable 'fsync()' when writing object files.
612+
613This is a total waste of time and effort on a filesystem that orders
614data writes properly, but can be useful for filesystems that do not use
615journalling (traditional UNIX filesystems) or that only journal metadata
616and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
617
Junio C Hamano610d1762008-11-28 06:27:13618core.preloadindex::
619Enable parallel index preload for operations like 'git diff'
620+
621This can speed up operations like 'git diff' and 'git status' especially
622on filesystems like NFS that have weak caching semantics and thus
Junio C Hamano076ffcc2013-02-06 05:13:21623relatively high IO latencies. With this set to 'true', Git will do the
Junio C Hamano610d1762008-11-28 06:27:13624index comparison to the filesystem data in parallel, allowing
625overlapping IO's.
626
Junio C Hamanoa9499de2009-04-30 03:38:48627core.createObject::
628You can set this to 'link', in which case a hardlink followed by
629a delete of the source are used to make sure that object creation
630will not overwrite existing objects.
631+
632On some file system/operating system combinations, this is unreliable.
633Set this config setting to 'rename' there; However, This will remove the
634check that makes sure that existing object files will not get overwritten.
Junio C Hamanoe91ea772009-04-26 01:41:41635
Junio C Hamano3b70d3c2009-11-21 17:37:37636core.notesRef::
637When showing commit messages, also show notes which are stored in
Junio C Hamanoa574a092010-06-13 19:57:10638the given ref. The ref must be fully qualified. If the given
639ref does not exist, it is not an error but means that no
640notes should be printed.
Junio C Hamano3b70d3c2009-11-21 17:37:37641+
Junio C Hamanoa574a092010-06-13 19:57:10642This setting defaults to "refs/notes/commits", and it can be overridden by
643the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
Junio C Hamano3b70d3c2009-11-21 17:37:37644
Junio C Hamano3c8d6702010-01-13 23:09:03645core.sparseCheckout::
646Enable "sparse checkout" feature. See section "Sparse checkout" in
647linkgit:git-read-tree[1] for more information.
648
Junio C Hamano6371b0e2011-03-23 23:36:21649core.abbrev::
650Set the length object names are abbreviated to. If unspecified,
651many commands abbreviate to 7 hexdigits, which may not be enough
652for abbreviated object names to stay unique for sufficiently long
653time.
654
Junio C Hamano3d141512009-06-01 01:22:40655add.ignore-errors::
Junio C Hamano60186642010-12-02 14:18:26656add.ignoreErrors::
Junio C Hamano1aa40d22010-01-21 17:46:43657Tells 'git add' to continue adding files when some files cannot be
Junio C Hamano3d141512009-06-01 01:22:40658added due to indexing errors. Equivalent to the '--ignore-errors'
Junio C Hamano076ffcc2013-02-06 05:13:21659option of linkgit:git-add[1]. Older versions of Git accept only
Junio C Hamano60186642010-12-02 14:18:26660`add.ignore-errors`, which does not follow the usual naming
Junio C Hamano076ffcc2013-02-06 05:13:21661convention for configuration variables. Newer versions of Git
Junio C Hamano60186642010-12-02 14:18:26662honor `add.ignoreErrors` as well.
Junio C Hamano3d141512009-06-01 01:22:40663
Junio C Hamano33db4372006-06-07 19:51:45664alias.*::
Junio C Hamano35738e82008-01-07 07:55:46665Command aliases for the linkgit:git[1] command wrapper - e.g.
Junio C Hamano33db4372006-06-07 19:51:45666after defining "alias.last = cat-file commit HEAD", the invocation
667"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17668confusion and troubles with script usage, aliases that
Junio C Hamano076ffcc2013-02-06 05:13:21669hide existing Git commands are ignored. Arguments are split by
Junio C Hamanof1d14802006-06-08 00:48:17670spaces, the usual shell quoting and escaping is supported.
671quote pair and a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39672+
673If the alias expansion is prefixed with an exclamation point,
674it will be treated as a shell command. For example, defining
675"alias.new = !gitk --all --not ORIG_HEAD", the invocation
676"git new" is equivalent to running the shell command
Junio C Hamano48bc1ce2009-07-09 16:49:19677"gitk --all --not ORIG_HEAD". Note that shell commands will be
678executed from the top-level directory of a repository, which may
679not necessarily be the current directory.
Junio C Hamano5f2627d2011-05-06 20:23:48680'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
681from the original current directory. See linkgit:git-rev-parse[1].
Junio C Hamano9cb74f22007-02-12 04:15:05682
Junio C Hamanocaa712a2010-03-11 01:17:35683am.keepcr::
684If true, git-am will call git-mailsplit for patches in mbox format
685with parameter '--keep-cr'. In this case git-mailsplit will
Junio C Hamano619596a2010-08-18 22:15:35686not remove `\r` from lines ending with `\r\n`. Can be overridden
Junio C Hamanocaa712a2010-03-11 01:17:35687by giving '--no-keep-cr' from the command line.
688See linkgit:git-am[1], linkgit:git-mailsplit[1].
689
Junio C Hamanofe24db02009-08-22 05:10:47690apply.ignorewhitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43691When set to 'change', tells 'git apply' to ignore changes in
Junio C Hamanofe24db02009-08-22 05:10:47692whitespace, in the same way as the '--ignore-space-change'
693option.
Junio C Hamano1aa40d22010-01-21 17:46:43694When set to one of: no, none, never, false tells 'git apply' to
Junio C Hamanofe24db02009-08-22 05:10:47695respect all whitespace differences.
696See linkgit:git-apply[1].
697
Junio C Hamano07824ce2006-04-25 07:36:54698apply.whitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43699Tells 'git apply' how to handle whitespaces, in the same way
Junio C Hamano35738e82008-01-07 07:55:46700as the '--whitespace' option. See linkgit:git-apply[1].
Junio C Hamano07824ce2006-04-25 07:36:54701
Junio C Hamano7fd84172007-05-24 07:00:32702branch.autosetupmerge::
Junio C Hamano1aa40d22010-01-21 17:46:43703Tells 'git branch' and 'git checkout' to set up new branches
Junio C Hamano24bc09a2008-02-28 00:27:44704so that linkgit:git-pull[1] will appropriately merge from the
705starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32706this behavior can be chosen per-branch using the `--track`
Junio C Hamano24bc09a2008-02-28 00:27:44707and `--no-track` options. The valid settings are: `false` -- no
708automatic setup is done; `true` -- automatic setup is done when the
Junio C Hamano97bcb482010-11-25 03:16:07709starting point is a remote-tracking branch; `always` --
710automatic setup is done when the starting point is either a
711local branch or remote-tracking
Junio C Hamano24bc09a2008-02-28 00:27:44712branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32713
Junio C Hamano869bb802008-05-12 00:29:47714branch.autosetuprebase::
Junio C Hamano1aa40d22010-01-21 17:46:43715When a new branch is created with 'git branch' or 'git checkout'
Junio C Hamano076ffcc2013-02-06 05:13:21716that tracks another branch, this variable tells Git to set
Junio C Hamano869bb802008-05-12 00:29:47717up pull to rebase instead of merge (see "branch.<name>.rebase").
718When `never`, rebase is never automatically set to true.
719When `local`, rebase is set to true for tracked branches of
720other local branches.
721When `remote`, rebase is set to true for tracked branches of
Junio C Hamano97bcb482010-11-25 03:16:07722remote-tracking branches.
Junio C Hamano869bb802008-05-12 00:29:47723When `always`, rebase will be set to true for all tracking
724branches.
725See "branch.autosetupmerge" for details on how to set up a
726branch to track another branch.
727This option defaults to never.
728
Junio C Hamano47c1e3c2006-09-25 04:45:55729branch.<name>.remote::
Junio C Hamano1aa40d22010-01-21 17:46:43730When in branch <name>, it tells 'git fetch' and 'git push' which
Junio C Hamano0706c802009-03-30 22:34:19731remote to fetch from/push to. It defaults to `origin` if no remote is
732configured. `origin` is also used if you are not on any branch.
Junio C Hamano47c1e3c2006-09-25 04:45:55733
734branch.<name>.merge::
Junio C Hamano0706c802009-03-30 22:34:19735Defines, together with branch.<name>.remote, the upstream branch
Junio C Hamanob02377c2011-04-28 22:26:02736for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
Junio C Hamano1aa40d22010-01-21 17:46:43737branch to merge and can also affect 'git push' (see push.default).
738When in branch <name>, it tells 'git fetch' the default
Junio C Hamanoc2b47092007-10-25 06:50:31739refspec to be marked for merging in FETCH_HEAD. The value is
740handled like the remote part of a refspec, and must match a
741ref which is fetched from the remote given by
742"branch.<name>.remote".
Junio C Hamano1aa40d22010-01-21 17:46:43743The merge information is used by 'git pull' (which at first calls
744'git fetch') to lookup the default branch for merging. Without
745this option, 'git pull' defaults to merge the first refspec fetched.
Junio C Hamano96010b22006-12-09 21:15:46746Specify multiple values to get an octopus merge.
Junio C Hamano1aa40d22010-01-21 17:46:43747If you wish to setup 'git pull' so that it merges into <name> from
Junio C Hamano6e149c02007-03-16 10:21:07748another branch in the local repository, you can point
749branch.<name>.merge to the desired branch, and use the special setting
750`.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:55751
Junio C Hamano1b50ce92007-10-03 12:05:53752branch.<name>.mergeoptions::
753Sets default options for merging into branch <name>. The syntax and
Junio C Hamanoc0e55e72009-10-10 00:56:29754supported options are the same as those of linkgit:git-merge[1], but
Junio C Hamano1b50ce92007-10-03 12:05:53755option values containing whitespace characters are currently not
756supported.
757
Junio C Hamano0c999702007-12-03 09:57:55758branch.<name>.rebase::
759When true, rebase the branch <name> on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:08760instead of merging the default branch from the default remote when
Junio C Hamano515ab1d2011-12-09 23:41:20761"git pull" is run. See "pull.rebase" for doing this in a non
762branch-specific manner.
763+
764*NOTE*: this is a possibly dangerous operation; do *not* use
765it unless you understand the implications (see linkgit:git-rebase[1]
766for details).
Junio C Hamano0c999702007-12-03 09:57:55767
Junio C Hamano46247182013-01-09 20:50:28768branch.<name>.description::
769Branch description, can be edited with
770`git branch --edit-description`. Branch description is
771automatically added in the format-patch cover letter or
772request-pull summary.
773
Junio C Hamano8760ea62008-03-14 08:58:45774browser.<tool>.cmd::
775Specify the command to invoke the specified browser. The
776specified command is evaluated in shell with the URLs passed
Junio C Hamano360e3a12011-07-13 23:51:56777as arguments. (See linkgit:git-web{litdd}browse[1].)
Junio C Hamano8760ea62008-03-14 08:58:45778
Junio C Hamanoe35a6fc2008-01-29 09:46:27779browser.<tool>.path::
780Override the path for the given tool that may be used to
781browse HTML help (see '-w' option in linkgit:git-help[1]) or a
782working repository in gitweb (see linkgit:git-instaweb[1]).
783
Junio C Hamano47b9acd2007-04-24 07:34:34784clean.requireForce::
Junio C Hamano422cfec2007-11-08 08:07:45785A boolean to make git-clean do nothing unless given -f
786or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:34787
Junio C Hamanoeb692952007-01-03 22:02:12788color.branch::
789A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46790linkgit:git-branch[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21791`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoeb692952007-01-03 22:02:12792only when the output is to a terminal. Defaults to false.
793
794color.branch.<slot>::
795Use customized color for branch coloration. `<slot>` is one of
796`current` (the current branch), `local` (a local branch),
Junio C Hamano97bcb482010-11-25 03:16:07797`remote` (a remote-tracking branch in refs/remotes/), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:22798refs).
799+
800The value for these configuration variables is a list of colors (at most
801two) and attributes (at most one), separated by spaces. The colors
802accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
803`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
804`blink` and `reverse`. The first color given is the foreground; the
805second is the background. The position of the attribute, if any,
806doesn't matter.
Junio C Hamanoeb692952007-01-03 22:02:12807
Junio C Hamano3f403b02006-12-13 10:14:13808color.diff::
Junio C Hamano5f2627d2011-05-06 20:23:48809Whether to use ANSI escape sequences to add color to patches.
810If this is set to `always`, linkgit:git-diff[1],
811linkgit:git-log[1], and linkgit:git-show[1] will use color
812for all patches. If it is set to `true` or `auto`, those
813commands will only use color when output is to the terminal.
814Defaults to false.
815+
816This does not affect linkgit:git-format-patch[1] nor the
817'git-diff-{asterisk}' plumbing commands. Can be overridden on the
818command line with the `--color[=<when>]` option.
Junio C Hamano9ae1a062006-07-10 08:12:34819
Junio C Hamano3f403b02006-12-13 10:14:13820color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:22821Use customized color for diff colorization. `<slot>` specifies
822which part of the patch to use the specified color, and is one
823of `plain` (context text), `meta` (metainformation), `frag`
Junio C Hamano2bd8a742009-12-01 21:16:59824(hunk header), 'func' (function in hunk header), `old` (removed lines),
825`new` (added lines), `commit` (commit headers), or `whitespace`
826(highlighting whitespace errors). The values of these variables may be
827specified as in color.branch.<slot>.
Junio C Hamano9ae1a062006-07-10 08:12:34828
Junio C Hamano7d449522010-07-01 00:08:51829color.decorate.<slot>::
830Use customized color for 'git log --decorate' output. `<slot>` is one
831of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
Junio C Hamano97bcb482010-11-25 03:16:07832branches, remote-tracking branches, tags, stash and HEAD, respectively.
Junio C Hamano7d449522010-07-01 00:08:51833
Junio C Hamanod257cff2009-03-18 05:27:16834color.grep::
835When set to `always`, always highlight matches. When `false` (or
836`never`), never. When set to `true` or `auto`, use color only
837when the output is written to the terminal. Defaults to `false`.
838
Junio C Hamano0299d922010-03-20 20:59:31839color.grep.<slot>::
840Use customized color for grep colorization. `<slot>` specifies which
841part of the line to use the specified color, and is one of
842+
843--
844`context`;;
845non-matching text in context lines (when using `-A`, `-B`, or `-C`)
846`filename`;;
847filename prefix (when not using `-h`)
848`function`;;
849function name lines (when using `-p`)
850`linenumber`;;
851line number prefix (when using `-n`)
852`match`;;
853matching text
854`selected`;;
855non-matching text in selected lines
856`separator`;;
857separators between fields on a line (`:`, `-`, and `=`)
858and between hunks (`--`)
859--
860+
861The values of these variables may be specified as in color.branch.<slot>.
Junio C Hamanod257cff2009-03-18 05:27:16862
Junio C Hamano00b8b632007-12-07 09:50:49863color.interactive::
Junio C Hamano35738e82008-01-07 07:55:46864When set to `always`, always use colors for interactive prompts
Junio C Hamanoba4b9282008-07-06 05:20:31865and displays (such as those used by "git-add --interactive").
Junio C Hamano00b8b632007-12-07 09:50:49866When false (or `never`), never. When set to `true` or `auto`, use
867colors only when the output is to the terminal. Defaults to false.
868
869color.interactive.<slot>::
Junio C Hamano1aa40d22010-01-21 17:46:43870Use customized color for 'git add --interactive'
Junio C Hamanoe5bf6c12009-02-07 21:43:10871output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
872four distinct types of normal output from interactive
Junio C Hamano27a128b2009-08-13 01:23:00873commands. The values of these variables may be specified as
Junio C Hamano00b8b632007-12-07 09:50:49874in color.branch.<slot>.
875
Junio C Hamanoe7935c42006-12-13 21:32:17876color.pager::
877A boolean to enable/disable colored output when the pager is in
878use (default is true).
879
Junio C Hamano52ba2952009-05-18 17:43:02880color.showbranch::
881A boolean to enable/disable color in the output of
882linkgit:git-show-branch[1]. May be set to `always`,
883`false` (or `never`) or `auto` (or `true`), in which case colors are used
884only when the output is to a terminal. Defaults to false.
885
Junio C Hamanoe7935c42006-12-13 21:32:17886color.status::
887A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46888linkgit:git-status[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21889`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoe7935c42006-12-13 21:32:17890only when the output is to a terminal. Defaults to false.
891
892color.status.<slot>::
893Use customized color for status colorization. `<slot>` is
894one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:04895`added` or `updated` (files which are added but not committed),
896`changed` (files which are changed but not added in the index),
Junio C Hamano076ffcc2013-02-06 05:13:21897`untracked` (files which are not tracked by Git),
Junio C Hamano0d75e872010-12-17 06:57:26898`branch` (the current branch), or
Junio C Hamanob713ff12008-05-24 01:12:30899`nobranch` (the color the 'no branch' warning is shown in, defaulting
900to red). The values of these variables may be specified as in
901color.branch.<slot>.
Junio C Hamanoe7935c42006-12-13 21:32:17902
Junio C Hamano83d46a22008-02-21 02:29:42903color.ui::
Junio C Hamano5f2627d2011-05-06 20:23:48904This variable determines the default value for variables such
905as `color.diff` and `color.grep` that control the use of color
906per command family. Its scope will expand as more commands learn
907configuration to set a default for the `--color` option. Set it
908to `always` if you want all output not intended for machine
909consumption to use color, to `true` or `auto` if you want such
910output to use color when written to the terminal, or to `false` or
Junio C Hamano076ffcc2013-02-06 05:13:21911`never` if you prefer Git commands not to use color unless enabled
Junio C Hamano5f2627d2011-05-06 20:23:48912explicitly with some other configuration or the `--color` option.
Junio C Hamano83d46a22008-02-21 02:29:42913
Junio C Hamano22700fb2012-05-03 23:07:25914column.ui::
915Specify whether supported commands should output in columns.
916This variable consists of a list of tokens separated by spaces
917or commas:
918+
919--
920`always`;;
921always show in columns
922`never`;;
923never show in columns
924`auto`;;
925show in columns if the output is to the terminal
926`column`;;
927fill columns before rows (default)
928`row`;;
929fill rows before columns
930`plain`;;
931show in one column
932`dense`;;
933make unequal size columns to utilize more space
934`nodense`;;
935make equal size columns
936--
937+
Junio C Hamanobcaa8bc2012-07-03 22:17:20938This option defaults to 'never'.
Junio C Hamano22700fb2012-05-03 23:07:25939
940column.branch::
941Specify whether to output branch listing in `git branch` in columns.
942See `column.ui` for details.
943
944column.status::
945Specify whether to output untracked files in `git status` in columns.
946See `column.ui` for details.
947
948column.tag::
949Specify whether to output tag listing in `git tag` in columns.
950See `column.ui` for details.
951
Junio C Hamanoce836cc2013-01-21 02:01:53952commit.cleanup::
953This setting overrides the default of the `--cleanup` option in
954`git commit`. See linkgit:git-commit[1] for details. Changing the
955default can be useful when you always want to keep lines that begin
956with comment character `#` in your log message, in which case you
957would do `git config commit.cleanup whitespace` (note that you will
958have to remove the help lines that begin with `#` in the commit log
959template yourself, if you do this).
960
Junio C Hamanod0d892c2010-01-24 20:06:29961commit.status::
Junio C Hamano6ce6b6c2010-01-18 01:25:50962A boolean to enable/disable inclusion of status information in the
963commit message template when using an editor to prepare the commit
964message. Defaults to true.
965
Junio C Hamano4653c6f2008-11-26 22:50:20966commit.template::
967Specify a file to use as the template for new commit messages.
Junio C Hamanob76a6862012-05-02 22:02:46968"`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
Junio C Hamanobf984de2009-11-23 06:11:19969specified user's home directory.
Junio C Hamano4653c6f2008-11-26 22:50:20970
Junio C Hamano0df92712011-12-21 22:30:44971credential.helper::
972Specify an external helper to be called when a username or
973password credential is needed; the helper may consult external
974storage to avoid prompting the user for the credentials. See
975linkgit:gitcredentials[7] for details.
976
977credential.useHttpPath::
978When acquiring credentials, consider the "path" component of an http
979or https URL to be important. Defaults to false. See
980linkgit:gitcredentials[7] for more information.
981
982credential.username::
983If no username is set for a network authentication, use this username
984by default. See credential.<context>.* below, and
985linkgit:gitcredentials[7].
986
987credential.<url>.*::
988Any of the credential.* options above can be applied selectively to
989some credentials. For example "credential.https://example.com.username"
990would set the default username only for https connections to
991example.com. See linkgit:gitcredentials[7] for details on how URLs are
992matched.
993
Junio C Hamano209ebe82011-04-27 21:09:59994include::diff-config.txt[]
Junio C Hamano3bd66e92009-04-18 06:17:56995
996difftool.<tool>.path::
997Override the path for the given tool. This is useful in case
998your tool is not in the PATH.
999
1000difftool.<tool>.cmd::
1001Specify the command to invoke the specified diff tool.
1002The specified command is evaluated in shell with the following
1003variables available: 'LOCAL' is set to the name of the temporary
1004file containing the contents of the diff pre-image and 'REMOTE'
1005is set to the name of the temporary file containing the contents
1006of the diff post-image.
1007
1008difftool.prompt::
1009Prompt before each invocation of the diff tool.
1010
Junio C Hamano0d75e872010-12-17 06:57:261011fetch.recurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:101012This option can be either set to a boolean value or to 'on-demand'.
1013Setting it to a boolean changes the behavior of fetch and pull to
1014unconditionally recurse into submodules when set to true or to not
1015recurse at all when set to false. When set to 'on-demand' (the default
1016value), fetch and pull will only recurse into a populated submodule
1017when its superproject retrieves a commit that updates the submodule's
1018reference.
Junio C Hamano0d75e872010-12-17 06:57:261019
Junio C Hamano8fb66e52011-10-05 20:59:511020fetch.fsckObjects::
1021If it is set to true, git-fetch-pack will check all fetched
1022objects. It will abort in the case of a malformed object or a
1023broken link. The result of an abort are only dangling objects.
1024Defaults to false. If not set, the value of `transfer.fsckObjects`
1025is used instead.
1026
Junio C Hamano54ea8d32007-01-25 07:59:481027fetch.unpackLimit::
Junio C Hamano076ffcc2013-02-06 05:13:211028If the number of objects fetched over the Git native
Junio C Hamano54ea8d32007-01-25 07:59:481029transfer is below this
1030limit, then the objects will be unpacked into loose object
1031files. However if the number of received objects equals or
1032exceeds this limit then the received pack will be stored as
1033a pack, after adding any missing delta bases. Storing the
1034pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:171035especially on slow filesystems. If not set, the value of
1036`transfer.unpackLimit` is used instead.
Junio C Hamano54ea8d32007-01-25 07:59:481037
Junio C Hamanof4581102009-04-25 08:29:591038format.attach::
1039Enable multipart/mixed attachments as the default for
1040'format-patch'. The value can also be a double quoted string
1041which will enable attachments as the default and set the
1042value as the boundary. See the --attach option in
1043linkgit:git-format-patch[1].
1044
Junio C Hamano8c5802d2007-11-15 00:13:361045format.numbered::
Junio C Hamano7d06a8a2008-10-20 05:42:331046A boolean which can enable or disable sequence numbers in patch
1047subjects. It defaults to "auto" which enables it only if there
1048is more than one patch. It can be enabled or disabled for all
1049messages by setting it to "true" or "false". See --numbered
1050option in linkgit:git-format-patch[1].
Junio C Hamano8c5802d2007-11-15 00:13:361051
Junio C Hamano07824ce2006-04-25 07:36:541052format.headers::
1053Additional email headers to include in a patch to be submitted
Junio C Hamano35738e82008-01-07 07:55:461054by mail. See linkgit:git-format-patch[1].
Junio C Hamano07824ce2006-04-25 07:36:541055
Junio C Hamano70664a02010-07-13 22:48:051056format.to::
Junio C Hamanof4581102009-04-25 08:29:591057format.cc::
Junio C Hamano70664a02010-07-13 22:48:051058Additional recipients to include in a patch to be submitted
1059by mail. See the --to and --cc options in
1060linkgit:git-format-patch[1].
Junio C Hamanof4581102009-04-25 08:29:591061
1062format.subjectprefix::
1063The default for format-patch is to output files with the '[PATCH]'
1064subject prefix. Use this variable to change that prefix.
1065
Junio C Hamano89a57342010-06-22 23:22:551066format.signature::
1067The default for format-patch is to output a signature containing
Junio C Hamano076ffcc2013-02-06 05:13:211068the Git version number. Use this variable to change that default.
Junio C Hamano89a57342010-06-22 23:22:551069Set this variable to the empty string ("") to suppress
1070signature generation.
1071
Junio C Hamanod4c8e112007-03-04 10:32:381072format.suffix::
1073The default for format-patch is to output files with the suffix
1074`.patch`. Use this variable to change that suffix (make sure to
1075include the dot if you want it).
1076
Junio C Hamano86bcccc2008-03-08 09:33:551077format.pretty::
1078The default pretty format for log/show/whatchanged command,
1079See linkgit:git-log[1], linkgit:git-show[1],
1080linkgit:git-whatchanged[1].
1081
Junio C Hamanoea6a7642009-03-11 23:56:191082format.thread::
Junio C Hamano1aa40d22010-01-21 17:46:431083The default threading style for 'git format-patch'. Can be
Junio C Hamanob141a922010-01-10 19:55:141084a boolean value, or `shallow` or `deep`. `shallow` threading
1085makes every mail a reply to the head of the series,
Junio C Hamanoea6a7642009-03-11 23:56:191086where the head is chosen from the cover letter, the
Junio C Hamanob76a6862012-05-02 22:02:461087`--in-reply-to`, and the first patch mail, in this order.
Junio C Hamanof4581102009-04-25 08:29:591088`deep` threading makes every mail a reply to the previous one.
Junio C Hamanoea6a7642009-03-11 23:56:191089A true boolean value is the same as `shallow`, and a false
1090value disables threading.
1091
Junio C Hamano5f9a6f02009-04-06 08:26:561092format.signoff::
1093 A boolean value which lets you enable the `-s/--signoff` option of
1094 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1095 patch should be a conscious act and means that you certify you have
1096 the rights to submit this work under the same open source license.
1097 Please see the 'SubmittingPatches' document for further discussion.
1098
Junio C Hamano209ebe82011-04-27 21:09:591099filter.<driver>.clean::
1100The command which is used to convert the content of a worktree
1101file to a blob upon checkin. See linkgit:gitattributes[5] for
1102details.
1103
1104filter.<driver>.smudge::
1105The command which is used to convert the content of a blob
1106object to a worktree file upon checkout. See
1107linkgit:gitattributes[5] for details.
1108
Junio C Hamanof2ce2972007-05-20 19:12:091109gc.aggressiveWindow::
1110The window size parameter used in the delta compression
Junio C Hamano1aa40d22010-01-21 17:46:431111algorithm used by 'git gc --aggressive'. This defaults
Junio C Hamanob04bb3f2010-04-14 14:07:361112to 250.
Junio C Hamanof2ce2972007-05-20 19:12:091113
Junio C Hamano1b50ce92007-10-03 12:05:531114gc.auto::
1115When there are approximately more than this many loose
1116objects in the repository, `git gc --auto` will pack them.
1117Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:171118light-weight garbage collection from time to time. The
1119default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531120
1121gc.autopacklimit::
1122When there are more than this many packs that are not
1123marked with `*.keep` file in the repository, `git gc
Junio C Hamanoe77b0152008-01-12 06:44:171124--auto` consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:371125default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531126
Junio C Hamano9d52e572007-02-13 23:48:201127gc.packrefs::
Junio C Hamanob141a922010-01-10 19:55:141128Running `git pack-refs` in a repository renders it
1129unclonable by Git versions prior to 1.5.1.2 over dumb
1130transports such as HTTP. This variable determines whether
Junio C Hamanocdd1c332010-12-20 10:08:001131'git gc' runs `git pack-refs`. This can be set to `notbare`
Junio C Hamanob141a922010-01-10 19:55:141132to enable it within all non-bare repos or it can be set to a
1133boolean value. The default is `true`.
Junio C Hamano9d52e572007-02-13 23:48:201134
Junio C Hamano09a926d2008-03-13 07:55:291135gc.pruneexpire::
Junio C Hamano1aa40d22010-01-21 17:46:431136When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
Junio C Hamanoa3148f52009-01-14 08:49:571137Override the grace period with this config variable. The value
1138"now" may be used to disable this grace period and always prune
1139unreachable objects immediately.
Junio C Hamano09a926d2008-03-13 07:55:291140
Junio C Hamano74640642006-12-27 10:59:551141gc.reflogexpire::
Junio C Hamanocc7636a2010-05-21 14:57:531142gc.<pattern>.reflogexpire::
Junio C Hamano1aa40d22010-01-21 17:46:431143'git reflog expire' removes reflog entries older than
Junio C Hamanocc7636a2010-05-21 14:57:531144this time; defaults to 90 days. With "<pattern>" (e.g.
1145"refs/stash") in the middle the setting applies only to
1146the refs that match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551147
1148gc.reflogexpireunreachable::
Junio C Hamanocc7636a2010-05-21 14:57:531149gc.<ref>.reflogexpireunreachable::
Junio C Hamano1aa40d22010-01-21 17:46:431150'git reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:551151this time and are not reachable from the current tip;
Junio C Hamanocc7636a2010-05-21 14:57:531152defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1153in the middle, the setting applies only to the refs that
1154match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551155
1156gc.rerereresolved::
1157Records of conflicted merge you resolved earlier are
Junio C Hamano1aa40d22010-01-21 17:46:431158kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461159The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551160
1161gc.rerereunresolved::
1162Records of conflicted merge you have not resolved are
Junio C Hamano1aa40d22010-01-21 17:46:431163kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461164The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551165
Junio C Hamanoa3148f52009-01-14 08:49:571166gitcvs.commitmsgannotation::
1167Append this string to each commit message. Set to empty string
1168to disable this feature. Defaults to "via git-CVS emulator".
1169
Junio C Hamano07824ce2006-04-25 07:36:541170gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:271171Whether the CVS server interface is enabled for this repository.
Junio C Hamano35738e82008-01-07 07:55:461172See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541173
1174gitcvs.logfile::
Junio C Hamanoa6387422007-08-25 03:54:271175Path to a log file where the CVS server interface well... logs
Junio C Hamano35738e82008-01-07 07:55:461176various stuff. See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541177
Junio C Hamano17bd2272008-09-01 06:11:171178gitcvs.usecrlfattr::
Junio C Hamanobb88cf42010-06-21 15:23:551179If true, the server will look up the end-of-line conversion
1180attributes for files to determine the '-k' modes to use. If
Junio C Hamano076ffcc2013-02-06 05:13:211181the attributes force Git to treat a file as text,
Junio C Hamano619596a2010-08-18 22:15:351182the '-k' mode will be left blank so CVS clients will
Junio C Hamanobb88cf42010-06-21 15:23:551183treat it as text. If they suppress text conversion, the file
Junio C Hamanocb1c44f2008-08-06 06:19:331184will be set with '-kb' mode, which suppresses any newline munging
Junio C Hamanobb88cf42010-06-21 15:23:551185the client might otherwise do. If the attributes do not allow
1186the file type to be determined, then 'gitcvs.allbinary' is
1187used. See linkgit:gitattributes[5].
Junio C Hamanodfccbb02008-05-26 01:16:141188
Junio C Hamanod9e0e5d2007-04-14 16:22:041189gitcvs.allbinary::
Junio C Hamanodfccbb02008-05-26 01:16:141190This is used if 'gitcvs.usecrlfattr' does not resolve
1191the correct '-kb' mode to use. If true, all
1192unresolved files are sent to the client in
1193mode '-kb'. This causes the client to treat them
1194as binary files, which suppresses any newline munging it
1195otherwise might do. Alternatively, if it is set to "guess",
1196then the contents of the file are examined to decide if
1197it is binary, similar to 'core.autocrlf'.
Junio C Hamanoa2ad99e2007-04-18 09:57:041198
1199gitcvs.dbname::
1200Database used by git-cvsserver to cache revision information
Junio C Hamano076ffcc2013-02-06 05:13:211201derived from the Git repository. The exact meaning depends on the
Junio C Hamanoa2ad99e2007-04-18 09:57:041202used database driver, for SQLite (which is the default driver) this
1203is a filename. Supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461204linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Junio C Hamanoa2ad99e2007-04-18 09:57:041205Default: '%Ggitcvs.%m.sqlite'
1206
1207gitcvs.dbdriver::
1208Used Perl DBI driver. You can specify any available driver
1209 for this here, but it might not work. git-cvsserver is tested
1210with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1211reported *not* to work with 'DBD::mysql'. Experimental feature.
1212May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamano35738e82008-01-07 07:55:461213See linkgit:git-cvsserver[1].
Junio C Hamanod9e0e5d2007-04-14 16:22:041214
Junio C Hamanoa2ad99e2007-04-18 09:57:041215gitcvs.dbuser, gitcvs.dbpass::
1216Database user and password. Only useful if setting 'gitcvs.dbdriver',
1217since SQLite has no concept of database users and/or passwords.
1218'gitcvs.dbuser' supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461219linkgit:git-cvsserver[1] for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:041220
Junio C Hamanoa74efce2008-04-02 08:39:081221gitcvs.dbTableNamePrefix::
1222Database table name prefix. Prepended to the names of any
1223database tables used, allowing a single database to be used
1224for several repositories. Supports variable substitution (see
1225linkgit:git-cvsserver[1] for details). Any non-alphabetic
1226characters will be replaced with underscores.
1227
Junio C Hamanodfccbb02008-05-26 01:16:141228All gitcvs variables except for 'gitcvs.usecrlfattr' and
1229'gitcvs.allbinary' can also be specified as
1230'gitcvs.<access_method>.<varname>' (where 'access_method'
Junio C Hamanoa6387422007-08-25 03:54:271231is one of "ext" and "pserver") to make them apply only for the given
1232access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:041233
Junio C Hamano11821ed2011-10-19 18:42:091234gitweb.category::
1235gitweb.description::
1236gitweb.owner::
1237gitweb.url::
1238See linkgit:gitweb[1] for description.
1239
1240gitweb.avatar::
1241gitweb.blame::
1242gitweb.grep::
1243gitweb.highlight::
1244gitweb.patches::
1245gitweb.pickaxe::
1246gitweb.remote_heads::
1247gitweb.showsizes::
1248gitweb.snapshot::
1249See linkgit:gitweb.conf[5] for description.
1250
Junio C Hamanoa03ac862011-04-02 04:32:291251grep.lineNumber::
1252If set to true, enable '-n' option by default.
1253
Junio C Hamanoa00504d2012-08-27 21:11:231254grep.patternType::
1255Set the default matching behavior. Using a value of 'basic', 'extended',
1256'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1257'--fixed-strings', or '--perl-regexp' option accordingly, while the
1258value 'default' will return to the default matching behavior.
1259
Junio C Hamanoa03ac862011-04-02 04:32:291260grep.extendedRegexp::
Junio C Hamanoa00504d2012-08-27 21:11:231261If set to true, enable '--extended-regexp' option by default. This
1262option is ignored when the 'grep.patternType' option is set to a value
1263other than 'default'.
Junio C Hamanoa03ac862011-04-02 04:32:291264
Junio C Hamano4fd24422012-01-06 21:52:431265gpg.program::
1266Use this custom program instead of "gpg" found on $PATH when
1267making or verifying a PGP signature. The program must support the
1268same command line interface as GPG, namely, to verify a detached
1269signature, "gpg --verify $file - <$signature" is run, and the
1270program is expected to signal a good signature by exiting with
1271code 0, and to generate an ascii-armored detached signature, the
1272standard input of "gpg -bsau $key" is fed with the contents to be
1273signed, and the program is expected to send the result to its
1274standard output.
1275
Junio C Hamano6d76d612008-05-09 05:46:081276gui.commitmsgwidth::
1277Defines how wide the commit message window is in the
1278linkgit:git-gui[1]. "75" is the default.
1279
1280gui.diffcontext::
1281Specifies how many context lines should be used in calls to diff
1282made by the linkgit:git-gui[1]. The default is "5".
1283
Junio C Hamanod3452a02008-11-15 08:07:551284gui.encoding::
1285Specifies the default encoding to use for displaying of
1286file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1287It can be overridden by setting the 'encoding' attribute
1288for relevant files (see linkgit:gitattributes[5]).
1289If this option is not set, the tools default to the
1290locale encoding.
1291
Junio C Hamano6d76d612008-05-09 05:46:081292gui.matchtrackingbranch::
1293Determines if new branches created with linkgit:git-gui[1] should
1294default to tracking remote branches with matching names or
1295not. Default: "false".
1296
1297gui.newbranchtemplate::
1298Is used as suggested name when creating new branches using the
1299linkgit:git-gui[1].
1300
1301gui.pruneduringfetch::
Junio C Hamano97bcb482010-11-25 03:16:071302"true" if linkgit:git-gui[1] should prune remote-tracking branches when
Junio C Hamano6d76d612008-05-09 05:46:081303performing a fetch. The default value is "false".
1304
1305gui.trustmtime::
1306Determines if linkgit:git-gui[1] should trust the file modification
1307timestamp or not. By default the timestamps are not trusted.
1308
1309gui.spellingdictionary::
1310Specifies the dictionary used for spell checking commit messages in
1311the linkgit:git-gui[1]. When set to "none" spell checking is turned
1312off.
1313
Junio C Hamanod3452a02008-11-15 08:07:551314gui.fastcopyblame::
Junio C Hamano1aa40d22010-01-21 17:46:431315If true, 'git gui blame' uses `-C` instead of `-C -C` for original
Junio C Hamanod3452a02008-11-15 08:07:551316location detection. It makes blame significantly faster on huge
1317repositories at the expense of less thorough copy detection.
1318
1319gui.copyblamethreshold::
Junio C Hamano610d1762008-11-28 06:27:131320Specifies the threshold to use in 'git gui blame' original location
Junio C Hamanod3452a02008-11-15 08:07:551321detection, measured in alphanumeric characters. See the
1322linkgit:git-blame[1] manual for more information on copy detection.
1323
1324gui.blamehistoryctx::
1325Specifies the radius of history context in days to show in
1326linkgit:gitk[1] for the selected commit, when the `Show History
1327Context` menu item is invoked from 'git gui blame'. If this
1328variable is set to zero, the whole history is shown.
1329
Junio C Hamano92d312a2008-12-15 07:22:201330guitool.<name>.cmd::
1331Specifies the shell command line to execute when the corresponding item
1332of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1333mandatory for every tool. The command is executed from the root of
1334the working directory, and in the environment it receives the name of
1335the tool as 'GIT_GUITOOL', the name of the currently selected file as
1336'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1337the head is detached, 'CUR_BRANCH' is empty).
1338
1339guitool.<name>.needsfile::
1340Run the tool only if a diff is selected in the GUI. It guarantees
1341that 'FILENAME' is not empty.
1342
1343guitool.<name>.noconsole::
1344Run the command silently, without creating a window to display its
1345output.
1346
1347guitool.<name>.norescan::
1348Don't rescan the working directory for changes after the tool
1349finishes execution.
1350
1351guitool.<name>.confirm::
1352Show a confirmation dialog before actually running the tool.
1353
1354guitool.<name>.argprompt::
1355Request a string argument from the user, and pass it to the tool
1356through the 'ARGS' environment variable. Since requesting an
1357argument implies confirmation, the 'confirm' option has no effect
1358if this is enabled. If the option is set to 'true', 'yes', or '1',
1359the dialog uses a built-in generic prompt; otherwise the exact
1360value of the variable is used.
1361
1362guitool.<name>.revprompt::
1363Request a single valid revision from the user, and set the
1364'REVISION' environment variable. In other aspects this option
1365is similar to 'argprompt', and can be used together with it.
1366
1367guitool.<name>.revunmerged::
1368Show only unmerged branches in the 'revprompt' subdialog.
1369This is useful for tools similar to merge or rebase, but not
1370for things like checkout or reset.
1371
1372guitool.<name>.title::
1373Specifies the title to use for the prompt dialog. The default
1374is the tool name.
1375
1376guitool.<name>.prompt::
1377Specifies the general prompt string to display at the top of
1378the dialog, before subsections for 'argprompt' and 'revprompt'.
1379The default value includes the actual command.
1380
Junio C Hamano4e272312008-01-08 09:13:211381help.browser::
1382Specify the browser that will be used to display help in the
1383'web' format. See linkgit:git-help[1].
1384
1385help.format::
1386Override the default help format used by linkgit:git-help[1].
1387Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1388the default. 'web' and 'html' are the same.
1389
Junio C Hamanof24b8062008-09-09 01:34:391390help.autocorrect::
1391Automatically correct and execute mistyped commands after
1392waiting for the given number of deciseconds (0.1 sec). If more
1393than one command can be deduced from the entered text, nothing
1394will be executed. If the value of this option is negative,
1395the corrected command will be executed immediately. If the
1396value is 0 - the command will be just shown but not executed.
1397This is the default.
1398
Junio C Hamano5dd5fae2013-01-18 21:06:491399help.htmlpath::
1400Specify the path where the HTML documentation resides. File system paths
1401and URLs are supported. HTML pages will be prefixed with this path when
1402help is displayed in the 'web' format. This defaults to the documentation
1403path of your Git installation.
1404
Junio C Hamano58256872007-12-04 08:31:131405http.proxy::
Junio C Hamano3dd93922012-03-05 07:49:111406Override the HTTP proxy, normally configured using the 'http_proxy',
1407'https_proxy', and 'all_proxy' environment variables (see
1408`curl(1)`). This can be overridden on a per-remote basis; see
1409remote.<name>.proxy
Junio C Hamano58256872007-12-04 08:31:131410
Junio C Hamano4c4b0122011-06-30 01:19:321411http.cookiefile::
1412File containing previously stored cookie lines which should be used
Junio C Hamano076ffcc2013-02-06 05:13:211413in the Git http session, if they match the server. The file format
Junio C Hamano4c4b0122011-06-30 01:19:321414of the file to read cookies from should be plain HTTP headers or
1415the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1416NOTE that the file specified with http.cookiefile is only used as
1417input. No cookies will be stored in the file.
1418
Junio C Hamano07824ce2006-04-25 07:36:541419http.sslVerify::
1420Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451421over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Junio C Hamano07824ce2006-04-25 07:36:541422variable.
1423
1424http.sslCert::
1425File containing the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451426over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Junio C Hamano07824ce2006-04-25 07:36:541427variable.
1428
1429http.sslKey::
1430File containing the SSL private key when fetching or pushing
Junio C Hamano341071d2006-06-04 07:24:481431over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Junio C Hamano07824ce2006-04-25 07:36:541432variable.
1433
Junio C Hamano48bc1ce2009-07-09 16:49:191434http.sslCertPasswordProtected::
Junio C Hamano076ffcc2013-02-06 05:13:211435Enable Git's password prompt for the SSL certificate. Otherwise
Junio C Hamano48bc1ce2009-07-09 16:49:191436OpenSSL will prompt the user, possibly many times, if the
1437certificate or private key is encrypted. Can be overridden by the
1438'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1439
Junio C Hamano07824ce2006-04-25 07:36:541440http.sslCAInfo::
1441File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:481442fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano07824ce2006-04-25 07:36:541443'GIT_SSL_CAINFO' environment variable.
1444
1445http.sslCAPath::
1446Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:451447with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541448by the 'GIT_SSL_CAPATH' environment variable.
1449
1450http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:481451How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541452by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1453
Junio C Hamanob141a922010-01-10 19:55:141454http.minSessions::
1455The number of curl sessions (counted across slots) to be kept across
1456requests. They will not be ended with curl_easy_cleanup() until
1457http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1458value will be capped at 1. Defaults to 1.
1459
Junio C Hamano3b70d3c2009-11-21 17:37:371460http.postBuffer::
1461Maximum size in bytes of the buffer used by smart HTTP
1462transports when POSTing data to the remote system.
1463For requests larger than this buffer size, HTTP/1.1 and
1464Transfer-Encoding: chunked is used to avoid creating a
1465massive pack file locally. Default is 1 MiB, which is
1466sufficient for most requests.
1467
Junio C Hamano07824ce2006-04-25 07:36:541468http.lowSpeedLimit, http.lowSpeedTime::
1469If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1470for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano341071d2006-06-04 07:24:481471Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Junio C Hamano07824ce2006-04-25 07:36:541472'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1473
Junio C Hamanof1dcdfe2006-09-29 08:10:511474http.noEPSV::
1475A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:041476This can helpful with some "poor" ftp servers which don't
Junio C Hamanof1dcdfe2006-09-29 08:10:511477support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1478environment variable. Default is false (curl will use EPSV).
1479
Junio C Hamano53ba6d02010-08-22 07:25:121480http.useragent::
1481The HTTP USER_AGENT string presented to an HTTP server. The default
Junio C Hamano076ffcc2013-02-06 05:13:211482value represents the version of the client Git such as git/1.7.1.
Junio C Hamano53ba6d02010-08-22 07:25:121483This option allows you to override this value to a more common value
1484such as Mozilla/4.0. This may be necessary, for instance, if
1485connecting through a firewall that restricts HTTP connections to a set
1486of common USER_AGENT strings (but not including those like git/1.7.1).
1487Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1488
Junio C Hamano07824ce2006-04-25 07:36:541489i18n.commitEncoding::
Junio C Hamano076ffcc2013-02-06 05:13:211490Character encoding the commit messages are stored in; Git itself
Junio C Hamano07824ce2006-04-25 07:36:541491does not care per se, but this information is necessary e.g. when
1492importing commits from emails or in the gitk graphical history
1493browser (and possibly at other places in the future or in other
Junio C Hamano35738e82008-01-07 07:55:461494porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Junio C Hamano07824ce2006-04-25 07:36:541495
Junio C Hamano51f92e22006-12-29 05:18:281496i18n.logOutputEncoding::
1497Character encoding the commit messages are converted to when
Junio C Hamano1aa40d22010-01-21 17:46:431498running 'git log' and friends.
Junio C Hamano51f92e22006-12-29 05:18:281499
Junio C Hamano4653c6f2008-11-26 22:50:201500imap::
1501The configuration variables in the 'imap' section are described
1502in linkgit:git-imap-send[1].
1503
Junio C Hamanocaa712a2010-03-11 01:17:351504init.templatedir::
1505Specify the directory from which templates will be copied.
1506(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1507
Junio C Hamano4e272312008-01-08 09:13:211508instaweb.browser::
1509Specify the program that will be used to browse your working
1510repository in gitweb. See linkgit:git-instaweb[1].
1511
1512instaweb.httpd::
1513The HTTP daemon command-line to start gitweb on your working
1514repository. See linkgit:git-instaweb[1].
1515
1516instaweb.local::
1517If true the web server started by linkgit:git-instaweb[1] will
1518be bound to the local IP (127.0.0.1).
1519
1520instaweb.modulepath::
Junio C Hamano619596a2010-08-18 22:15:351521The default module path for linkgit:git-instaweb[1] to use
1522instead of /usr/lib/apache2/modules. Only used if httpd
1523is Apache.
Junio C Hamano4e272312008-01-08 09:13:211524
1525instaweb.port::
1526The port number to bind the gitweb httpd to. See
1527linkgit:git-instaweb[1].
1528
Junio C Hamanoe5bf6c12009-02-07 21:43:101529interactive.singlekey::
Junio C Hamano27a128b2009-08-13 01:23:001530In interactive commands, allow the user to provide one-letter
Junio C Hamanoe5bf6c12009-02-07 21:43:101531input with a single key (i.e., without hitting enter).
Junio C Hamanob76a6862012-05-02 22:02:461532Currently this is used by the `--patch` mode of
Junio C Hamano3d050d62011-05-17 06:43:341533linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1534linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1535setting is silently ignored if portable keystroke input
1536is not available.
Junio C Hamanoe5bf6c12009-02-07 21:43:101537
Junio C Hamanof93530e2011-05-25 23:59:591538log.abbrevCommit::
1539If true, makes linkgit:git-log[1], linkgit:git-show[1], and
Junio C Hamanob76a6862012-05-02 22:02:461540linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1541override this option with `--no-abbrev-commit`.
Junio C Hamanof93530e2011-05-25 23:59:591542
Junio C Hamanob713ff12008-05-24 01:12:301543log.date::
Junio C Hamano2db3e752010-09-03 21:33:061544Set the default date-time mode for the 'log' command.
1545Setting a value for log.date is similar to using 'git log''s
Junio C Hamanob76a6862012-05-02 22:02:461546`--date` option. Possible values are `relative`, `local`,
Junio C Hamano2db3e752010-09-03 21:33:061547`default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1548for details.
Junio C Hamanob713ff12008-05-24 01:12:301549
Junio C Hamanocb39aea2010-05-09 07:24:481550log.decorate::
1551Print out the ref names of any commits that are shown by the log
1552command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1553'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1554specified, the full ref name (including prefix) will be printed.
1555This is the same as the log commands '--decorate' option.
1556
Junio C Hamanofe9acab2006-11-24 12:10:551557log.showroot::
1558If true, the initial commit will be shown as a big creation event.
1559This is equivalent to a diff against an empty tree.
Junio C Hamano35738e82008-01-07 07:55:461560Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Junio C Hamanofe9acab2006-11-24 12:10:551561normally hide the root commit will now show it. True by default.
1562
Junio C Hamanoce836cc2013-01-21 02:01:531563log.mailmap::
1564If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1565linkgit:git-whatchanged[1] assume `--use-mailmap`.
1566
Junio C Hamano8bc410e2009-02-15 10:38:191567mailmap.file::
1568The location of an augmenting mailmap file. The default
1569mailmap, located in the root of the repository, is loaded
1570first, then the mailmap file pointed to by this variable.
1571The location of the mailmap file may be in a repository
1572subdirectory, or somewhere outside of the repository itself.
1573See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1574
Junio C Hamanoabad6da2013-01-06 09:06:321575mailmap.blob::
1576Like `mailmap.file`, but consider the value as a reference to a
1577blob in the repository. If both `mailmap.file` and
1578`mailmap.blob` are given, both are parsed, with entries from
1579`mailmap.file` taking precedence. In a bare repository, this
1580defaults to `HEAD:.mailmap`. In a non-bare repository, it
1581defaults to empty.
1582
Junio C Hamano8b588d52008-03-15 09:48:371583man.viewer::
1584Specify the programs that may be used to display help in the
1585'man' format. See linkgit:git-help[1].
1586
Junio C Hamano6d76d612008-05-09 05:46:081587man.<tool>.cmd::
1588Specify the command to invoke the specified man viewer. The
1589specified command is evaluated in shell with the man page
1590passed as argument. (See linkgit:git-help[1].)
Junio C Hamano103ad7f2007-03-14 11:19:261591
Junio C Hamano6d76d612008-05-09 05:46:081592man.<tool>.path::
1593Override the path for the given tool that may be used to
1594display help in the 'man' format. See linkgit:git-help[1].
Junio C Hamanoe90436a2007-04-22 07:22:131595
Junio C Hamano4653c6f2008-11-26 22:50:201596include::merge-config.txt[]
Junio C Hamanoa476efa2008-10-10 15:31:421597
Junio C Hamano1fbbbc12007-12-18 07:01:271598mergetool.<tool>.path::
1599Override the path for the given tool. This is useful in case
1600your tool is not in the PATH.
1601
Junio C Hamano86bcccc2008-03-08 09:33:551602mergetool.<tool>.cmd::
1603Specify the command to invoke the specified merge tool. The
1604specified command is evaluated in shell with the following
1605variables available: 'BASE' is the name of a temporary file
1606containing the common base of the files to be merged, if available;
1607'LOCAL' is the name of a temporary file containing the contents of
1608the file on the current branch; 'REMOTE' is the name of a temporary
1609file containing the contents of the file from the branch being
1610merged; 'MERGED' contains the name of the file to which the merge
1611tool should write the results of a successful merge.
1612
1613mergetool.<tool>.trustExitCode::
1614For a custom merge command, specify whether the exit code of
1615the merge command can be used to determine whether the merge was
1616successful. If this is not set to true then the merge target file
1617timestamp is checked and the merge assumed to have been successful
1618if the file has been updated, otherwise the user is prompted to
1619indicate the success of the merge.
1620
1621mergetool.keepBackup::
1622After performing a merge, the original file with conflict markers
1623can be saved as a file with a `.orig` extension. If this variable
1624is set to `false` then this file is not preserved. Defaults to
1625`true` (i.e. keep the backup files).
1626
Junio C Hamano10b7a342009-01-01 22:05:171627mergetool.keepTemporaries::
Junio C Hamano076ffcc2013-02-06 05:13:211628When invoking a custom merge tool, Git uses a set of temporary
Junio C Hamano10b7a342009-01-01 22:05:171629files to pass to the tool. If the tool returns an error and this
1630variable is set to `true`, then these temporary files will be
1631preserved, otherwise they will be removed after the tool has
1632exited. Defaults to `false`.
1633
1634mergetool.prompt::
1635Prompt before each invocation of the merge resolution program.
1636
Junio C Hamano31667362010-03-25 00:38:531637notes.displayRef::
1638The (fully qualified) refname from which to show notes when
1639showing commit messages. The value of this variable can be set
1640to a glob, in which case notes from all matching refs will be
1641shown. You may also specify this configuration variable
1642several times. A warning will be issued for refs that do not
1643exist, but a glob that does not match any refs is silently
1644ignored.
1645+
1646This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1647environment variable, which must be a colon separated list of refs or
1648globs.
1649+
1650The effective value of "core.notesRef" (possibly overridden by
1651GIT_NOTES_REF) is also implicitly added to the list of refs to be
1652displayed.
1653
1654notes.rewrite.<command>::
1655When rewriting commits with <command> (currently `amend` or
Junio C Hamano076ffcc2013-02-06 05:13:211656`rebase`) and this variable is set to `true`, Git
Junio C Hamano31667362010-03-25 00:38:531657automatically copies your notes from the original to the
1658rewritten commit. Defaults to `true`, but see
1659"notes.rewriteRef" below.
Junio C Hamano31667362010-03-25 00:38:531660
1661notes.rewriteMode::
1662When copying notes during a rewrite (see the
1663"notes.rewrite.<command>" option), determines what to do if
1664the target commit already has a note. Must be one of
1665`overwrite`, `concatenate`, or `ignore`. Defaults to
1666`concatenate`.
1667+
1668This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1669environment variable.
1670
1671notes.rewriteRef::
1672When copying notes during a rewrite, specifies the (fully
1673qualified) ref whose notes should be copied. The ref may be a
1674glob, in which case notes in all matching refs will be copied.
1675You may also specify this configuration several times.
1676+
1677Does not have a default value; you must configure this variable to
Junio C Hamano8fb66e52011-10-05 20:59:511678enable note rewriting. Set it to `refs/notes/commits` to enable
1679rewriting for the default commit notes.
Junio C Hamano2b3ee5d2010-05-08 05:41:181680+
1681This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1682environment variable, which must be a colon separated list of refs or
1683globs.
Junio C Hamano31667362010-03-25 00:38:531684
Junio C Hamano75cc4c92006-07-24 08:25:031685pack.window::
Junio C Hamano35738e82008-01-07 07:55:461686The size of the window used by linkgit:git-pack-objects[1] when no
Junio C Hamano75cc4c92006-07-24 08:25:031687window size is given on the command line. Defaults to 10.
1688
Junio C Hamano91d44c52007-05-09 07:16:071689pack.depth::
Junio C Hamano35738e82008-01-07 07:55:461690The maximum delta depth used by linkgit:git-pack-objects[1] when no
Junio C Hamano91d44c52007-05-09 07:16:071691maximum depth is given on the command line. Defaults to 50.
1692
Junio C Hamano235d53f2007-07-13 00:25:151693pack.windowMemory::
Junio C Hamano35738e82008-01-07 07:55:461694The window memory size limit used by linkgit:git-pack-objects[1]
Junio C Hamano235d53f2007-07-13 00:25:151695when no limit is given on the command line. The value can be
1696suffixed with "k", "m", or "g". Defaults to 0, meaning no
1697limit.
1698
Junio C Hamanof2ce2972007-05-20 19:12:091699pack.compression::
1700An integer -1..9, indicating the compression level for objects
1701in a pack file. -1 is the zlib default. 0 means no
1702compression, and 1..9 are various speed/size tradeoffs, 9 being
1703slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:421704not set, defaults to -1, the zlib default, which is "a default
1705compromise between speed and compression (currently equivalent
1706to level 6)."
Junio C Hamano657fd8a2010-10-07 00:01:241707+
1708Note that changing the compression level will not automatically recompress
1709all existing objects. You can force recompression by passing the -F option
1710to linkgit:git-repack[1].
Junio C Hamanof2ce2972007-05-20 19:12:091711
Junio C Hamano679d22d2007-06-02 21:13:441712pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:271713The maximum memory in bytes used for caching deltas in
Junio C Hamano9f883862009-08-11 06:23:521714linkgit:git-pack-objects[1] before writing them out to a pack.
1715This cache is used to speed up the writing object phase by not
1716having to recompute the final delta result once the best match
1717for all objects is found. Repacking large repositories on machines
1718which are tight with memory might be badly impacted by this though,
1719especially if this cache pushes the system into swapping.
1720A value of 0 means no limit. The smallest size of 1 byte may be
1721used to virtually disable this cache. Defaults to 256 MiB.
Junio C Hamano679d22d2007-06-02 21:13:441722
1723pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:141724The maximum size of a delta, that is cached in
Junio C Hamano9f883862009-08-11 06:23:521725linkgit:git-pack-objects[1]. This cache is used to speed up the
1726writing object phase by not having to recompute the final delta
1727result once the best match for all objects is found. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:441728
Junio C Hamano58155b42007-09-15 07:46:141729pack.threads::
1730Specifies the number of threads to spawn when searching for best
Junio C Hamano35738e82008-01-07 07:55:461731delta matches. This requires that linkgit:git-pack-objects[1]
Junio C Hamano58155b42007-09-15 07:46:141732be compiled with pthreads otherwise this option is ignored with a
1733warning. This is meant to reduce packing time on multiprocessor
1734machines. The required amount of memory for the delta search window
1735is however multiplied by the number of threads.
Junio C Hamano076ffcc2013-02-06 05:13:211736Specifying 0 will cause Git to auto-detect the number of CPU's
Junio C Hamano24bc09a2008-02-28 00:27:441737and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:141738
Junio C Hamanod814b6d2007-11-04 11:13:491739pack.indexVersion::
1740Specify the default pack index version. Valid values are 1 for
1741legacy pack index used by Git versions prior to 1.5.2, and 2 for
1742the new pack index with capabilities for packs larger than 4 GB
1743as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:381744packs. Version 2 is the default. Note that version 2 is enforced
1745and this config option ignored whenever the corresponding pack is
1746larger than 2 GB.
1747+
Junio C Hamano076ffcc2013-02-06 05:13:211748If you have an old Git that does not understand the version 2 `*.idx` file,
Junio C Hamanofce7c7e2008-07-02 03:06:381749cloning or fetching over a non native protocol (e.g. "http" and "rsync")
Junio C Hamanob76a6862012-05-02 22:02:461750that will copy both `*.pack` file and corresponding `*.idx` file from the
Junio C Hamanofce7c7e2008-07-02 03:06:381751other side may give you a repository that cannot be accessed with your
Junio C Hamano076ffcc2013-02-06 05:13:211752older version of Git. If the `*.pack` file is smaller than 2 GB, however,
Junio C Hamanofce7c7e2008-07-02 03:06:381753you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
Junio C Hamanob76a6862012-05-02 22:02:461754the `*.idx` file.
Junio C Hamanod814b6d2007-11-04 11:13:491755
Junio C Hamano09a926d2008-03-13 07:55:291756pack.packSizeLimit::
Junio C Hamano4d979582010-02-04 06:27:291757The maximum size of a pack. This setting only affects
1758packing to a file when repacking, i.e. the git:// protocol
Junio C Hamanob76a6862012-05-02 22:02:461759is unaffected. It can be overridden by the `--max-pack-size`
Junio C Hamano4d979582010-02-04 06:27:291760option of linkgit:git-repack[1]. The minimum size allowed is
1761limited to 1 MiB. The default is unlimited.
1762Common unit suffixes of 'k', 'm', or 'g' are
1763supported.
Junio C Hamano49dccaf2008-02-10 10:48:011764
Junio C Hamano9e96a1a2008-08-16 10:23:181765pager.<cmd>::
Junio C Hamano788eeba2010-12-08 22:50:431766If the value is boolean, turns on or off pagination of the
Junio C Hamano076ffcc2013-02-06 05:13:211767output of a particular Git subcommand when writing to a tty.
Junio C Hamano788eeba2010-12-08 22:50:431768Otherwise, turns on pagination for the subcommand using the
Junio C Hamanob76a6862012-05-02 22:02:461769pager specified by the value of `pager.<cmd>`. If `--paginate`
1770or `--no-pager` is specified on the command line, it takes
Junio C Hamano788eeba2010-12-08 22:50:431771precedence over this option. To disable pagination for all
1772commands, set `core.pager` or `GIT_PAGER` to `cat`.
Junio C Hamano9e96a1a2008-08-16 10:23:181773
Junio C Hamanoa574a092010-06-13 19:57:101774pretty.<name>::
1775Alias for a --pretty= format string, as specified in
1776linkgit:git-log[1]. Any aliases defined here can be used just
1777as the built-in pretty formats could. For example,
Junio C Hamanob76a6862012-05-02 22:02:461778running `git config pretty.changelog "format:* %H %s"`
Junio C Hamanoa574a092010-06-13 19:57:101779would cause the invocation `git log --pretty=changelog`
Junio C Hamanob76a6862012-05-02 22:02:461780to be equivalent to running `git log "--pretty=format:* %H %s"`.
Junio C Hamanoa574a092010-06-13 19:57:101781Note that an alias with the same name as a built-in format
1782will be silently ignored.
1783
Junio C Hamano515ab1d2011-12-09 23:41:201784pull.rebase::
1785When true, rebase branches on top of the fetched branch, instead
1786of merging the default branch from the default remote when "git
1787pull" is run. See "branch.<name>.rebase" for setting this on a
1788per-branch basis.
1789+
1790*NOTE*: this is a possibly dangerous operation; do *not* use
1791it unless you understand the implications (see linkgit:git-rebase[1]
1792for details).
1793
Junio C Hamano07824ce2006-04-25 07:36:541794pull.octopus::
1795The default merge strategy to use when pulling multiple branches
1796at once.
1797
1798pull.twohead::
1799The default merge strategy to use when pulling a single branch.
1800
Junio C Hamano1de75722009-03-26 08:39:381801push.default::
Junio C Hamano076ffcc2013-02-06 05:13:211802Defines the action `git push` should take if no refspec is given
Junio C Hamano1de75722009-03-26 08:39:381803on the command line, no refspec is configured in the remote, and
1804no refspec is implied by any of the options given on the command
Junio C Hamano0706c802009-03-30 22:34:191805line. Possible values are:
Junio C Hamano1de75722009-03-26 08:39:381806+
Junio C Hamanobcaa8bc2012-07-03 22:17:201807--
Junio C Hamano7f9fa862010-10-19 23:51:141808* `nothing` - do not push anything.
Junio C Hamanob76a6862012-05-02 22:02:461809* `matching` - push all branches having the same name in both ends.
1810 This is for those who prepare all the branches into a publishable
1811 shape and then push them out with a single command. It is not
1812 appropriate for pushing into a repository shared by multiple users,
1813 since locally stalled branches will attempt a non-fast forward push
1814 if other users updated the branch.
1815 +
1816 This is currently the default, but Git 2.0 will change the default
1817 to `simple`.
Junio C Hamano2da4ac42013-02-19 00:41:171818* `upstream` - push the current branch to its upstream branch
1819 (`tracking` is a deprecated synonym for this).
Junio C Hamanob76a6862012-05-02 22:02:461820 With this, `git push` will update the same remote ref as the one which
1821 is merged by `git pull`, making `push` and `pull` symmetrical.
1822 See "branch.<name>.merge" for how to configure the upstream branch.
1823* `simple` - like `upstream`, but refuses to push if the upstream
1824 branch's name is different from the local one. This is the safest
1825 option and is well-suited for beginners. It will become the default
1826 in Git 2.0.
Junio C Hamano7f9fa862010-10-19 23:51:141827* `current` - push the current branch to a branch of the same name.
Junio C Hamanobcaa8bc2012-07-03 22:17:201828--
1829+
1830The `simple`, `current` and `upstream` modes are for those who want to
1831push out a single branch after finishing work, even when the other
1832branches are not yet ready to be pushed out. If you are working with
1833other people to push into the same shared repository, you would want
1834to use one of these.
Junio C Hamano1de75722009-03-26 08:39:381835
Junio C Hamanoea6a7642009-03-11 23:56:191836rebase.stat::
1837Whether to show a diffstat of what changed upstream since the last
1838rebase. False by default.
1839
Junio C Hamano075ae872010-09-01 18:43:071840rebase.autosquash::
1841If set to true enable '--autosquash' option by default.
1842
Junio C Hamano621e1232009-10-26 05:16:471843receive.autogc::
1844By default, git-receive-pack will run "git-gc --auto" after
1845receiving data from git-push and updating refs. You can stop
1846it by setting this variable to false.
1847
Junio C Hamano4653c6f2008-11-26 22:50:201848receive.fsckObjects::
1849If it is set to true, git-receive-pack will check all received
1850objects. It will abort in the case of a malformed object or a
1851broken link. The result of an abort are only dangling objects.
Junio C Hamano8fb66e52011-10-05 20:59:511852Defaults to false. If not set, the value of `transfer.fsckObjects`
1853is used instead.
Junio C Hamano4653c6f2008-11-26 22:50:201854
1855receive.unpackLimit::
1856If the number of objects received in a push is below this
1857limit then the objects will be unpacked into loose object
1858files. However if the number of received objects equals or
1859exceeds this limit then the received pack will be stored as
1860a pack, after adding any missing delta bases. Storing the
1861pack from a push can make the push operation complete faster,
1862especially on slow filesystems. If not set, the value of
1863`transfer.unpackLimit` is used instead.
1864
1865receive.denyDeletes::
1866If set to true, git-receive-pack will deny a ref update that deletes
1867the ref. Use this to prevent such a ref deletion via a push.
1868
Junio C Hamanob4448a82010-07-26 09:02:321869receive.denyDeleteCurrent::
1870If set to true, git-receive-pack will deny a ref update that
1871deletes the currently checked out branch of a non-bare repository.
1872
Junio C Hamano4653c6f2008-11-26 22:50:201873receive.denyCurrentBranch::
Junio C Hamanoe97d5772010-05-19 08:13:581874If set to true or "refuse", git-receive-pack will deny a ref update
Junio C Hamano4653c6f2008-11-26 22:50:201875to the currently checked out branch of a non-bare repository.
1876Such a push is potentially dangerous because it brings the HEAD
1877out of sync with the index and working tree. If set to "warn",
1878print a warning of such a push to stderr, but allow the push to
1879proceed. If set to false or "ignore", allow such pushes with no
Junio C Hamanoafb395b2010-03-17 22:16:151880message. Defaults to "refuse".
Junio C Hamano4653c6f2008-11-26 22:50:201881
1882receive.denyNonFastForwards::
1883If set to true, git-receive-pack will deny a ref update which is
Junio C Hamano3f680f32009-11-16 02:10:541884not a fast-forward. Use this to prevent such an update via a push,
Junio C Hamano4653c6f2008-11-26 22:50:201885even if that push is forced. This configuration variable is
1886set when initializing a shared repository.
1887
Junio C Hamano80ad00d2013-02-18 00:19:031888receive.hiderefs::
1889String(s) `receive-pack` uses to decide which refs to omit
1890from its initial advertisement. Use more than one
1891definitions to specify multiple prefix strings. A ref that
1892are under the hierarchies listed on the value of this
1893variable is excluded, and is hidden when responding to `git
1894push`, and an attempt to update or delete a hidden ref by
1895`git push` is rejected.
1896
Junio C Hamano621e1232009-10-26 05:16:471897receive.updateserverinfo::
1898If set to true, git-receive-pack will run git-update-server-info
1899after receiving data from git-push and updating refs.
1900
Junio C Hamano249572f2006-10-24 05:44:081901remote.<name>.url::
Junio C Hamano35738e82008-01-07 07:55:461902The URL of a remote repository. See linkgit:git-fetch[1] or
1903linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:081904
Junio C Hamano0e88f3e2009-06-21 08:03:251905remote.<name>.pushurl::
1906The push URL of a remote repository. See linkgit:git-push[1].
1907
Junio C Hamano58256872007-12-04 08:31:131908remote.<name>.proxy::
1909For remotes that require curl (http, https and ftp), the URL to
1910the proxy to use for that remote. Set to the empty string to
1911disable proxying for that remote.
1912
Junio C Hamano249572f2006-10-24 05:44:081913remote.<name>.fetch::
Junio C Hamano35738e82008-01-07 07:55:461914The default set of "refspec" for linkgit:git-fetch[1]. See
1915linkgit:git-fetch[1].
Junio C Hamano249572f2006-10-24 05:44:081916
1917remote.<name>.push::
Junio C Hamano35738e82008-01-07 07:55:461918The default set of "refspec" for linkgit:git-push[1]. See
1919linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:081920
Junio C Hamano47d68a52008-05-06 06:35:401921remote.<name>.mirror::
1922If true, pushing to this remote will automatically behave
Junio C Hamanob76a6862012-05-02 22:02:461923as if the `--mirror` option was given on the command line.
Junio C Hamano47d68a52008-05-06 06:35:401924
Junio C Hamano118d2772007-02-21 20:24:101925remote.<name>.skipDefaultUpdate::
1926If true, this remote will be skipped by default when updating
Junio C Hamano9df0c662009-11-23 11:09:271927using linkgit:git-fetch[1] or the `update` subcommand of
1928linkgit:git-remote[1].
1929
1930remote.<name>.skipFetchAll::
1931If true, this remote will be skipped by default when updating
1932using linkgit:git-fetch[1] or the `update` subcommand of
1933linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101934
Junio C Hamano4ad294b2007-01-20 02:22:501935remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:481936The default program to execute on the remote side when pushing. See
Junio C Hamano86bcccc2008-03-08 09:33:551937option \--receive-pack of linkgit:git-push[1].
Junio C Hamano4ad294b2007-01-20 02:22:501938
Junio C Hamano54ea8d32007-01-25 07:59:481939remote.<name>.uploadpack::
1940The default program to execute on the remote side when fetching. See
Junio C Hamano86bcccc2008-03-08 09:33:551941option \--upload-pack of linkgit:git-fetch-pack[1].
Junio C Hamano54ea8d32007-01-25 07:59:481942
Junio C Hamano17dde0e2007-02-26 09:50:211943remote.<name>.tagopt::
Junio C Hamano86bcccc2008-03-08 09:33:551944Setting this value to \--no-tags disables automatic tag following when
Junio C Hamanocc7636a2010-05-21 14:57:531945fetching from remote <name>. Setting it to \--tags will fetch every
1946tag from remote <name>, even if they are not reachable from remote
Junio C Hamano075ae872010-09-01 18:43:071947branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1948override this setting. See options \--tags and \--no-tags of
1949linkgit:git-fetch[1].
Junio C Hamano17dde0e2007-02-26 09:50:211950
Junio C Hamano096dde22009-12-26 23:14:111951remote.<name>.vcs::
Junio C Hamano076ffcc2013-02-06 05:13:211952Setting this to a value <vcs> will cause Git to interact with
Junio C Hamano096dde22009-12-26 23:14:111953the remote with the git-remote-<vcs> helper.
1954
Junio C Hamano118d2772007-02-21 20:24:101955remotes.<group>::
1956The list of remotes which are fetched by "git remote update
Junio C Hamano35738e82008-01-07 07:55:461957<group>". See linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101958
Junio C Hamano77b7e902006-10-23 07:18:501959repack.usedeltabaseoffset::
Junio C Hamanofce7c7e2008-07-02 03:06:381960By default, linkgit:git-repack[1] creates packs that use
1961delta-base offset. If you need to share your repository with
Junio C Hamano076ffcc2013-02-06 05:13:211962Git older than version 1.4.4, either directly or via a dumb
Junio C Hamanofce7c7e2008-07-02 03:06:381963protocol such as http, then you need to set this option to
Junio C Hamano076ffcc2013-02-06 05:13:211964"false" and repack. Access from old Git versions over the
Junio C Hamanofce7c7e2008-07-02 03:06:381965native protocol are unaffected by this option.
Junio C Hamano77b7e902006-10-23 07:18:501966
Junio C Hamano4653c6f2008-11-26 22:50:201967rerere.autoupdate::
1968When set to true, `git-rerere` updates the index with the
1969resulting contents after it cleanly resolves conflicts using
1970previously recorded resolution. Defaults to false.
1971
1972rerere.enabled::
1973Activate recording of resolved conflicts, so that identical
Junio C Hamano4fd24422012-01-06 21:52:431974conflict hunks can be resolved automatically, should they be
1975encountered again. By default, linkgit:git-rerere[1] is
1976enabled if there is an `rr-cache` directory under the
Junio C Hamano864ba892012-01-13 17:42:051977`$GIT_DIR`, e.g. if "rerere" was previously used in the
1978repository.
Junio C Hamano4653c6f2008-11-26 22:50:201979
Junio C Hamano1bbd0f42009-07-23 06:20:291980sendemail.identity::
1981A configuration identity. When given, causes values in the
1982'sendemail.<identity>' subsection to take precedence over
1983values in the 'sendemail' section. The default identity is
1984the value of 'sendemail.identity'.
1985
1986sendemail.smtpencryption::
1987See linkgit:git-send-email[1] for description. Note that this
1988setting is not subject to the 'identity' mechanism.
1989
1990sendemail.smtpssl::
1991Deprecated alias for 'sendemail.smtpencryption = ssl'.
1992
1993sendemail.<identity>.*::
1994Identity-specific versions of the 'sendemail.*' parameters
1995found below, taking precedence over those when the this
1996identity is selected, through command-line or
1997'sendemail.identity'.
1998
1999sendemail.aliasesfile::
2000sendemail.aliasfiletype::
2001sendemail.bcc::
2002sendemail.cc::
2003sendemail.cccmd::
2004sendemail.chainreplyto::
2005sendemail.confirm::
2006sendemail.envelopesender::
2007sendemail.from::
2008sendemail.multiedit::
2009sendemail.signedoffbycc::
2010sendemail.smtppass::
2011sendemail.suppresscc::
2012sendemail.suppressfrom::
2013sendemail.to::
Junio C Hamanocb39aea2010-05-09 07:24:482014sendemail.smtpdomain::
Junio C Hamano1bbd0f42009-07-23 06:20:292015sendemail.smtpserver::
2016sendemail.smtpserverport::
Junio C Hamano39c7a692010-10-27 06:08:542017sendemail.smtpserveroption::
Junio C Hamano1bbd0f42009-07-23 06:20:292018sendemail.smtpuser::
2019sendemail.thread::
2020sendemail.validate::
2021See linkgit:git-send-email[1] for description.
2022
2023sendemail.signedoffcc::
2024Deprecated alias for 'sendemail.signedoffbycc'.
2025
Junio C Hamano07824ce2006-04-25 07:36:542026showbranch.default::
Junio C Hamano35738e82008-01-07 07:55:462027The default set of branches for linkgit:git-show-branch[1].
2028See linkgit:git-show-branch[1].
Junio C Hamano07824ce2006-04-25 07:36:542029
Junio C Hamano942b35e2007-12-09 10:19:332030status.relativePaths::
Junio C Hamano35738e82008-01-07 07:55:462031By default, linkgit:git-status[1] shows paths relative to the
Junio C Hamano942b35e2007-12-09 10:19:332032current directory. Setting this variable to `false` shows paths
Junio C Hamano076ffcc2013-02-06 05:13:212033relative to the repository root (this was the default for Git
Junio C Hamano942b35e2007-12-09 10:19:332034prior to v1.5.4).
2035
Junio C Hamano4224f992008-06-23 07:14:082036status.showUntrackedFiles::
2037By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2038files which are not currently tracked by Git. Directories which
2039contain only untracked files, are shown with the directory name
2040only. Showing untracked files means that Git needs to lstat() all
2041all the files in the whole repository, which might be slow on some
2042systems. So, this variable controls how the commands displays
2043the untracked files. Possible values are:
2044+
2045--
Junio C Hamano7f9fa862010-10-19 23:51:142046* `no` - Show no untracked files.
2047* `normal` - Show untracked files and directories.
2048* `all` - Show also individual files in untracked directories.
Junio C Hamano4224f992008-06-23 07:14:082049--
2050+
2051If this variable is not specified, it defaults to 'normal'.
2052This variable can be overridden with the -u|--untracked-files option
2053of linkgit:git-status[1] and linkgit:git-commit[1].
2054
Junio C Hamanob671fb52010-06-01 05:06:142055status.submodulesummary::
2056Defaults to false.
2057If this is set to a non zero number or true (identical to -1 or an
2058unlimited number), the submodule summary will be enabled and a
2059summary of commits for modified submodules will be shown (see
2060--summary-limit option of linkgit:git-submodule[1]).
2061
Junio C Hamano78e3a782010-07-15 22:24:452062submodule.<name>.path::
2063submodule.<name>.url::
2064submodule.<name>.update::
2065The path within this project, URL, and the updating strategy
2066for a submodule. These variables are initially populated
2067by 'git submodule init'; edit them to override the
2068URL and other values found in the `.gitmodules` file. See
2069linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2070
Junio C Hamanoabad6da2013-01-06 09:06:322071submodule.<name>.branch::
2072The remote branch name for a submodule, used by `git submodule
2073update --remote`. Set this option to override the value found in
2074the `.gitmodules` file. See linkgit:git-submodule[1] and
2075linkgit:gitmodules[5] for details.
2076
Junio C Hamano0d75e872010-12-17 06:57:262077submodule.<name>.fetchRecurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:102078This option can be used to control recursive fetching of this
Junio C Hamano7165bf72011-01-04 22:06:182079submodule. It can be overridden by using the --[no-]recurse-submodules
Junio C Hamano0d75e872010-12-17 06:57:262080command line option to "git fetch" and "git pull".
2081This setting will override that from in the linkgit:gitmodules[5]
2082file.
2083
Junio C Hamano619596a2010-08-18 22:15:352084submodule.<name>.ignore::
2085Defines under what circumstances "git status" and the diff family show
2086a submodule as modified. When set to "all", it will never be considered
2087modified, "dirty" will ignore all changes to the submodules work tree and
2088takes only differences between the HEAD of the submodule and the commit
2089recorded in the superproject into account. "untracked" will additionally
2090let submodules with modified tracked files in their work tree show up.
2091Using "none" (the default when this option is not set) also shows
2092submodules that have untracked files in their work tree as changed.
2093This setting overrides any setting made in .gitmodules for this submodule,
Junio C Hamanode9745c2010-08-23 17:10:182094both settings can be overridden on the command line by using the
Junio C Hamano619596a2010-08-18 22:15:352095"--ignore-submodules" option.
2096
Junio C Hamano75cc4c92006-07-24 08:25:032097tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:092098This variable can be used to restrict the permission bits of
2099tar archive entries. The default is 0002, which turns off the
2100world write bit. The special value "user" indicates that the
2101archiving user's umask will be used instead. See umask(2) and
Junio C Hamano35738e82008-01-07 07:55:462102linkgit:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:032103
Junio C Hamano8fb66e52011-10-05 20:59:512104transfer.fsckObjects::
2105When `fetch.fsckObjects` or `receive.fsckObjects` are
2106not set, the value of this variable is used instead.
2107Defaults to false.
2108
Junio C Hamano80ad00d2013-02-18 00:19:032109transfer.hiderefs::
2110This variable can be used to set both `receive.hiderefs`
2111and `uploadpack.hiderefs` at the same time to the same
2112values. See entries for these other variables.
2113
Junio C Hamano4653c6f2008-11-26 22:50:202114transfer.unpackLimit::
2115When `fetch.unpackLimit` or `receive.unpackLimit` are
2116not set, the value of this variable is used instead.
2117The default value is 100.
2118
Junio C Hamano80ad00d2013-02-18 00:19:032119uploadpack.hiderefs::
2120String(s) `upload-pack` uses to decide which refs to omit
2121from its initial advertisement. Use more than one
2122definitions to specify multiple prefix strings. A ref that
2123are under the hierarchies listed on the value of this
2124variable is excluded, and is hidden from `git ls-remote`,
2125`git fetch`, etc. An attempt to fetch a hidden ref by `git
Junio C Hamano5e7f1312013-03-21 22:49:012126fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2127
2128uploadpack.allowtipsha1inwant::
2129When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2130to accept a fetch request that asks for an object at the tip
2131of a hidden ref (by default, such a request is rejected).
2132see also `uploadpack.hiderefs`.
Junio C Hamano80ad00d2013-02-18 00:19:032133
Junio C Hamano24bc09a2008-02-28 00:27:442134url.<base>.insteadOf::
2135Any URL that starts with this value will be rewritten to
2136start, instead, with <base>. In cases where some site serves a
2137large number of repositories, and serves them with multiple
2138access methods, and some users need to use different access
2139methods, this feature allows people to specify any of the
Junio C Hamano076ffcc2013-02-06 05:13:212140equivalent URLs and have Git automatically rewrite the URL to
Junio C Hamano24bc09a2008-02-28 00:27:442141the best alternative for the particular user, even for a
2142never-before-seen repository on the site. When more than one
2143insteadOf strings match a given URL, the longest match is used.
2144
Junio C Hamano7df6dcf2009-09-13 09:51:172145url.<base>.pushInsteadOf::
2146Any URL that starts with this value will not be pushed to;
2147instead, it will be rewritten to start with <base>, and the
2148resulting URL will be pushed to. In cases where some site serves
2149a large number of repositories, and serves them with multiple
2150access methods, some of which do not allow push, this feature
Junio C Hamano076ffcc2013-02-06 05:13:212151allows people to specify a pull-only URL and have Git
Junio C Hamano7df6dcf2009-09-13 09:51:172152automatically use an appropriate URL to push, even for a
2153never-before-seen repository on the site. When more than one
2154pushInsteadOf strings match a given URL, the longest match is
Junio C Hamano076ffcc2013-02-06 05:13:212155used. If a remote has an explicit pushurl, Git will ignore this
Junio C Hamano7df6dcf2009-09-13 09:51:172156setting for that remote.
2157
Junio C Hamano07824ce2006-04-25 07:36:542158user.email::
2159Your email address to be recorded in any newly created commits.
Junio C Hamano469d60e2007-04-29 18:30:342160Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Junio C Hamano35738e82008-01-07 07:55:462161'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:542162
2163user.name::
2164Your full name to be recorded in any newly created commits.
Junio C Hamano341071d2006-06-04 07:24:482165Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Junio C Hamano35738e82008-01-07 07:55:462166environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:542167
Junio C Hamanoa890c4f2007-01-28 10:29:212168user.signingkey::
Junio C Hamano35738e82008-01-07 07:55:462169If linkgit:git-tag[1] is not selecting the key you want it to
Junio C Hamanoa890c4f2007-01-28 10:29:212170automatically when creating a signed tag, you can override the
2171default selection with this variable. This option is passed
2172unchanged to gpg's --local-user parameter, so you may specify a key
2173using any method that gpg supports.
2174
Junio C Hamano4e272312008-01-08 09:13:212175web.browser::
2176Specify a web browser that may be used by some commands.
2177Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2178may use it.