blob: 1932e9b9a2be5437dd467f91472318a5bf1bb992 [file] [log] [blame]
Junio C Hamano07824ce2006-04-25 07:36:541CONFIGURATION FILE
2------------------
3
Junio C Hamano076ffcc2013-02-06 05:13:214The Git configuration file contains a number of variables that affect
5the Git commands' behavior. The `.git/config` file in each repository
Junio C Hamanof4581102009-04-25 08:29:596is used to store the configuration for that repository, and
7`$HOME/.gitconfig` is used to store a per-user configuration as
8fallback values for the `.git/config` file. The file `/etc/gitconfig`
9can be used to store a system-wide default configuration.
Junio C Hamano8f76dc62007-01-17 07:24:2510
Junio C Hamano076ffcc2013-02-06 05:13:2111The configuration variables are used by both the Git plumbing
Junio C Hamanof4581102009-04-25 08:29:5912and the porcelains. The variables are divided into sections, wherein
13the fully qualified variable name of the variable itself is the last
Junio C Hamano07824ce2006-04-25 07:36:5414dot-separated segment and the section name is everything before the last
Junio C Hamano81d540a2012-03-02 19:52:4715dot. The variable names are case-insensitive, allow only alphanumeric
16characters and `-`, and must start with an alphabetic character. Some
17variables may appear multiple times.
Junio C Hamano07824ce2006-04-25 07:36:5418
Junio C Hamanobee172f2007-01-23 08:44:1819Syntax
20~~~~~~
21
Junio C Hamano07824ce2006-04-25 07:36:5422The syntax is fairly flexible and permissive; whitespaces are mostly
Junio C Hamanobee172f2007-01-23 08:44:1823ignored. The '#' and ';' characters begin comments to the end of line,
24blank lines are ignored.
25
26The file consists of sections and variables. A section begins with
27the name of the section in square brackets and continues until the next
28section begins. Section names are not case sensitive. Only alphanumeric
Junio C Hamanoea82cff2009-03-18 01:54:4829characters, `-` and `.` are allowed in section names. Each variable
Junio C Hamanof4581102009-04-25 08:29:5930must belong to some section, which means that there must be a section
31header before the first setting of a variable.
Junio C Hamanobee172f2007-01-23 08:44:1832
33Sections can be further divided into subsections. To begin a subsection
34put its name in double quotes, separated by space from the section name,
Junio C Hamanof4581102009-04-25 08:29:5935in the section header, like in the example below:
Junio C Hamanobee172f2007-01-23 08:44:1836
37--------
38[section "subsection"]
39
40--------
41
Junio C Hamanof4581102009-04-25 08:29:5942Subsection names are case sensitive and can contain any characters except
43newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
44respectively). Section headers cannot span multiple
Junio C Hamanobee172f2007-01-23 08:44:1845lines. Variables may belong directly to a section or to a given subsection.
46You can have `[section]` if you have `[section "subsection"]`, but you
47don't need to.
48
Junio C Hamano6231f822011-10-24 05:18:5249There is also a deprecated `[section.subsection]` syntax. With this
50syntax, the subsection name is converted to lower-case and is also
51compared case sensitively. These subsection names follow the same
52restrictions as section names.
Junio C Hamanobee172f2007-01-23 08:44:1853
Junio C Hamanoaa2cd762009-07-26 08:14:0154All the other lines (and the remainder of the line after the section
55header) are recognized as setting variables, in the form
Junio C Hamanobee172f2007-01-23 08:44:1856'name = value'. If there is no equal sign on the line, the entire line
57is taken as 'name' and the variable is recognized as boolean "true".
Junio C Hamano81d540a2012-03-02 19:52:4758The variable names are case-insensitive, allow only alphanumeric characters
59and `-`, and must start with an alphabetic character. There can be more
60than one value for a given variable; we say then that the variable is
61multivalued.
Junio C Hamanobee172f2007-01-23 08:44:1862
63Leading and trailing whitespace in a variable value is discarded.
64Internal whitespace within a variable value is retained verbatim.
65
66The values following the equals sign in variable assign are all either
67a string, an integer, or a boolean. Boolean values may be given as yes/no,
Junio C Hamano059bca52011-03-30 22:47:46681/0, true/false or on/off. Case is not significant in boolean values, when
Junio C Hamanobee172f2007-01-23 08:44:1869converting value to the canonical form using '--bool' type specifier;
Junio C Hamano1aa40d22010-01-21 17:46:4370'git config' will ensure that the output is "true" or "false".
Junio C Hamanobee172f2007-01-23 08:44:1871
72String values may be entirely or partially enclosed in double quotes.
Junio C Hamanof4581102009-04-25 08:29:5973You need to enclose variable values in double quotes if you want to
74preserve leading or trailing whitespace, or if the variable value contains
75comment characters (i.e. it contains '#' or ';').
76Double quote `"` and backslash `\` characters in variable values must
Junio C Hamanoea82cff2009-03-18 01:54:4877be escaped: use `\"` for `"` and `\\` for `\`.
Junio C Hamanobee172f2007-01-23 08:44:1878
Junio C Hamanoea82cff2009-03-18 01:54:4879The following escape sequences (beside `\"` and `\\`) are recognized:
80`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
Junio C Hamanod75148a2014-04-08 19:48:3881and `\b` for backspace (BS). Other char escape sequences (including octal
82escape sequences) are invalid.
Junio C Hamanobee172f2007-01-23 08:44:1883
Junio C Hamanof4581102009-04-25 08:29:5984Variable values ending in a `\` are continued on the next line in the
Junio C Hamanobee172f2007-01-23 08:44:1885customary UNIX fashion.
86
Junio C Hamanof4581102009-04-25 08:29:5987Some variables may require a special value format.
Junio C Hamano07824ce2006-04-25 07:36:5488
Junio C Hamanoe0238c22012-02-23 22:45:5089Includes
90~~~~~~~~
91
92You can include one config file from another by setting the special
93`include.path` variable to the name of the file to be included. The
94included file is expanded immediately, as if its contents had been
95found at the location of the include directive. If the value of the
96`include.path` variable is a relative path, the path is considered to be
97relative to the configuration file in which the include directive was
Junio C Hamano22700fb2012-05-03 23:07:2598found. The value of `include.path` is subject to tilde expansion: `~/`
99is expanded to the value of `$HOME`, and `~user/` to the specified
Junio C Hamano4d61c4a2012-04-30 01:10:22100user's home directory. See below for examples.
Junio C Hamanoe0238c22012-02-23 22:45:50101
Junio C Hamano07824ce2006-04-25 07:36:54102Example
103~~~~~~~
104
105# Core variables
106[core]
107; Don't trust file modes
108filemode = false
109
110# Our diff algorithm
111[diff]
Junio C Hamano85c71572008-07-28 00:03:31112external = /usr/local/bin/diff-wrapper
Junio C Hamano07824ce2006-04-25 07:36:54113renames = true
114
Junio C Hamano52401ef2006-12-19 00:54:38115[branch "devel"]
116remote = origin
117merge = refs/heads/devel
118
Junio C Hamanobee172f2007-01-23 08:44:18119# Proxy settings
120[core]
Junio C Hamanoc71a8732007-08-04 00:27:26121gitProxy="ssh" for "kernel.org"
Junio C Hamanobee172f2007-01-23 08:44:18122gitProxy=default-proxy ; for the rest
Junio C Hamano52401ef2006-12-19 00:54:38123
Junio C Hamanoe0238c22012-02-23 22:45:50124[include]
125path = /path/to/foo.inc ; include by absolute path
126path = foo ; expand "foo" relative to the current file
Junio C Hamano4d61c4a2012-04-30 01:10:22127path = ~/foo ; expand "foo" in your $HOME directory
Junio C Hamanoe0238c22012-02-23 22:45:50128
Junio C Hamano07824ce2006-04-25 07:36:54129Variables
130~~~~~~~~~
131
132Note that this list is non-comprehensive and not necessarily complete.
Junio C Hamanof1d14802006-06-08 00:48:17133For command-specific variables, you will find a more detailed description
Junio C Hamano52b6ba32014-04-01 00:26:48134in the appropriate manual page.
135
136Other git-related tools may and do use their own variables. When
137inventing new variables for use in your own tool, make sure their
138names do not conflict with those that are used by Git itself and
139other popular tools, and describe them in your documentation.
140
Junio C Hamano07824ce2006-04-25 07:36:54141
Junio C Hamano7df6dcf2009-09-13 09:51:17142advice.*::
Junio C Hamano0df92712011-12-21 22:30:44143These variables control various optional help messages designed to
144aid new users. All 'advice.*' variables default to 'true', and you
145can tell Git that you do not need help by setting these to 'false':
Junio C Hamano7df6dcf2009-09-13 09:51:17146+
147--
Junio C Hamanoabad6da2013-01-06 09:06:32148pushUpdateRejected::
Junio C Hamano0c1b64e2012-04-20 23:50:49149Set this variable to 'false' if you want to disable
Junio C Hamano1d669b82014-03-11 21:36:00150'pushNonFFCurrent',
Junio C Hamano3f2ed6f2013-02-04 19:24:09151'pushNonFFMatching', 'pushAlreadyExists',
152'pushFetchFirst', and 'pushNeedsForce'
Junio C Hamanoabad6da2013-01-06 09:06:32153simultaneously.
Junio C Hamano0c1b64e2012-04-20 23:50:49154pushNonFFCurrent::
155Advice shown when linkgit:git-push[1] fails due to a
156non-fast-forward update to the current branch.
Junio C Hamano0c1b64e2012-04-20 23:50:49157pushNonFFMatching::
158Advice shown when you ran linkgit:git-push[1] and pushed
159'matching refs' explicitly (i.e. you used ':', or
160specified a refspec that isn't your current branch) and
161it resulted in a non-fast-forward error.
Junio C Hamanoabad6da2013-01-06 09:06:32162pushAlreadyExists::
163Shown when linkgit:git-push[1] rejects an update that
164does not qualify for fast-forwarding (e.g., a tag.)
Junio C Hamano3f2ed6f2013-02-04 19:24:09165pushFetchFirst::
166Shown when linkgit:git-push[1] rejects an update that
167tries to overwrite a remote ref that points at an
168object we do not have.
169pushNeedsForce::
170Shown when linkgit:git-push[1] rejects an update that
171tries to overwrite a remote ref that points at an
Junio C Hamanoe6f28d02013-09-17 21:34:00172object that is not a commit-ish, or make the remote
173ref point at an object that is not a commit-ish.
Junio C Hamano7df6dcf2009-09-13 09:51:17174statusHints::
Junio C Hamano644936c2012-06-28 23:05:14175Show directions on how to proceed from the current
Junio C Hamano917cd4f2012-12-04 23:41:10176state in the output of linkgit:git-status[1], in
Junio C Hamano644936c2012-06-28 23:05:14177the template shown when writing commit messages in
Junio C Hamano917cd4f2012-12-04 23:41:10178linkgit:git-commit[1], and in the help message shown
179by linkgit:git-checkout[1] when switching branch.
Junio C Hamano5e7f1312013-03-21 22:49:01180statusUoption::
181Advise to consider using the `-u` option to linkgit:git-status[1]
182when the command takes more than 2 seconds to enumerate untracked
183files.
Junio C Hamano5706e0b2009-11-24 10:54:16184commitBeforeMerge::
185Advice shown when linkgit:git-merge[1] refuses to
Junio C Hamano619596a2010-08-18 22:15:35186merge to avoid overwriting local changes.
Junio C Hamanoa9701f02010-01-21 00:42:16187resolveConflict::
Junio C Hamano5dab5a92013-02-25 18:51:24188Advice shown by various commands when conflicts
Junio C Hamanoa9701f02010-01-21 00:42:16189prevent the operation from being performed.
Junio C Hamanoa9701f02010-01-21 00:42:16190implicitIdentity::
191Advice on how to set your identity configuration when
192your information is guessed from the system username and
Junio C Hamano0df92712011-12-21 22:30:44193domain name.
Junio C Hamano74a198f2010-02-22 00:13:31194detachedHead::
Junio C Hamano0df92712011-12-21 22:30:44195Advice shown when you used linkgit:git-checkout[1] to
Junio C Hamano74a198f2010-02-22 00:13:31196move to the detach HEAD state, to instruct how to create
Junio C Hamano0df92712011-12-21 22:30:44197a local branch after the fact.
Junio C Hamanobb300642012-07-22 21:09:14198amWorkDir::
199Advice that shows the location of the patch file when
200linkgit:git-am[1] fails to apply it.
Junio C Hamano8ab94942013-06-24 21:55:30201rmHints::
202In case of failure in the output of linkgit:git-rm[1],
203show directions on how to proceed from the current state.
Junio C Hamano7df6dcf2009-09-13 09:51:17204--
205
Junio C Hamano07824ce2006-04-25 07:36:54206core.fileMode::
207If false, the executable bit differences between the index and
Junio C Hamano8fb66e52011-10-05 20:59:51208the working tree are ignored; useful on broken filesystems like FAT.
Junio C Hamano9df0c662009-11-23 11:09:27209See linkgit:git-update-index[1].
210+
211The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
212will probe and set core.fileMode false if appropriate when the
213repository is created.
Junio C Hamano07824ce2006-04-25 07:36:54214
Junio C Hamano9df0c662009-11-23 11:09:27215core.ignorecase::
216If true, this option enables various workarounds to enable
Junio C Hamano076ffcc2013-02-06 05:13:21217Git to work better on filesystems that are not case sensitive,
Junio C Hamano9df0c662009-11-23 11:09:27218like FAT. For example, if a directory listing finds
Junio C Hamano076ffcc2013-02-06 05:13:21219"makefile" when Git expects "Makefile", Git will assume
Junio C Hamano9df0c662009-11-23 11:09:27220it is really the same file, and continue to remember it as
221"Makefile".
222+
223The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
224will probe and set core.ignorecase true if appropriate when the repository
225is created.
226
Junio C Hamanob61a7772012-07-13 23:34:48227core.precomposeunicode::
Junio C Hamano076ffcc2013-02-06 05:13:21228This option is only used by Mac OS implementation of Git.
229When core.precomposeunicode=true, Git reverts the unicode decomposition
Junio C Hamanob61a7772012-07-13 23:34:48230of filenames done by Mac OS. This is useful when sharing a repository
231between Mac OS and Linux or Windows.
Junio C Hamano076ffcc2013-02-06 05:13:21232(Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
233When false, file names are handled fully transparent by Git,
234which is backward compatible with older versions of Git.
Junio C Hamanob61a7772012-07-13 23:34:48235
Junio C Hamano90ccff32008-07-29 08:17:24236core.trustctime::
237If false, the ctime differences between the index and the
Junio C Hamano8fb66e52011-10-05 20:59:51238working tree are ignored; useful when the inode change time
Junio C Hamano90ccff32008-07-29 08:17:24239is regularly modified by something outside Git (file system
240crawlers and some backup systems).
241See linkgit:git-update-index[1]. True by default.
242
Junio C Hamano4cfed0c2013-01-30 17:58:54243core.checkstat::
244Determines which stat fields to match between the index
245and work tree. The user can set this to 'default' or
246'minimal'. Default (or explicitly 'default'), is to check
247all fields, including the sub-second part of mtime and ctime.
248
Junio C Hamanod526ba92007-07-02 00:17:42249core.quotepath::
Junio C Hamanoba4b9282008-07-06 05:20:31250The commands that output paths (e.g. 'ls-files',
251'diff'), when not given the `-z` option, will quote
Junio C Hamanod526ba92007-07-02 00:17:42252"unusual" characters in the pathname by enclosing the
253pathname in a double-quote pair and with backslashes the
254same way strings in C source code are quoted. If this
255variable is set to false, the bytes higher than 0x80 are
256not quoted but output as verbatim. Note that double
257quote, backslash and control characters are always
258quoted without `-z` regardless of the setting of this
259variable.
260
Junio C Hamanobb88cf42010-06-21 15:23:55261core.eol::
262Sets the line ending type to use in the working directory for
263files that have the `text` property set. Alternatives are
264'lf', 'crlf' and 'native', which uses the platform's native
265line ending. The default value is `native`. See
266linkgit:gitattributes[5] for more information on end-of-line
267conversion.
Junio C Hamanod9e0e5d2007-04-14 16:22:04268
Junio C Hamano26e590a2008-02-17 03:53:51269core.safecrlf::
Junio C Hamano076ffcc2013-02-06 05:13:21270If true, makes Git check if converting `CRLF` is reversible when
Junio C Hamanobb88cf42010-06-21 15:23:55271end-of-line conversion is active. Git will verify if a command
Junio C Hamano26e590a2008-02-17 03:53:51272modifies a file in the work tree either directly or indirectly.
273For example, committing a file followed by checking out the
274same file should yield the original file in the work tree. If
275this is not the case for the current setting of
Junio C Hamano076ffcc2013-02-06 05:13:21276`core.autocrlf`, Git will reject the file. The variable can
277be set to "warn", in which case Git will only warn about an
Junio C Hamano26e590a2008-02-17 03:53:51278irreversible conversion but continue the operation.
279+
280CRLF conversion bears a slight chance of corrupting data.
Junio C Hamano076ffcc2013-02-06 05:13:21281When it is enabled, Git will convert CRLF to LF during commit and LF to
Junio C Hamano26e590a2008-02-17 03:53:51282CRLF during checkout. A file that contains a mixture of LF and
Junio C Hamano076ffcc2013-02-06 05:13:21283CRLF before the commit cannot be recreated by Git. For text
Junio C Hamano26e590a2008-02-17 03:53:51284files this is the right thing to do: it corrects line endings
285such that we have only LF line endings in the repository.
286But for binary files that are accidentally classified as text the
287conversion can corrupt data.
288+
289If you recognize such corruption early you can easily fix it by
290setting the conversion type explicitly in .gitattributes. Right
291after committing you still have the original file in your work
292tree and this file is not yet corrupted. You can explicitly tell
Junio C Hamano076ffcc2013-02-06 05:13:21293Git that this file is binary and Git will handle the file
Junio C Hamano26e590a2008-02-17 03:53:51294appropriately.
295+
296Unfortunately, the desired effect of cleaning up text files with
297mixed line endings and the undesired effect of corrupting binary
298files cannot be distinguished. In both cases CRLFs are removed
299in an irreversible way. For text files this is the right thing
300to do because CRLFs are line endings, while for binary files
301converting CRLFs corrupts data.
302+
303Note, this safety check does not mean that a checkout will generate a
304file identical to the original file for a different setting of
Junio C Hamanobb88cf42010-06-21 15:23:55305`core.eol` and `core.autocrlf`, but only for the current one. For
306example, a text file with `LF` would be accepted with `core.eol=lf`
307and could later be checked out with `core.eol=crlf`, in which case the
Junio C Hamano26e590a2008-02-17 03:53:51308resulting file would contain `CRLF`, although the original file
309contained `LF`. However, in both work trees the line endings would be
310consistent, that is either all `LF` or all `CRLF`, but never mixed. A
311file with mixed line endings would be reported by the `core.safecrlf`
312mechanism.
313
Junio C Hamanobb88cf42010-06-21 15:23:55314core.autocrlf::
315Setting this variable to "true" is almost the same as setting
316the `text` attribute to "auto" on all files except that text
317files are not guaranteed to be normalized: files that contain
318`CRLF` in the repository will not be touched. Use this
319setting if you want to have `CRLF` line endings in your
320working directory even though the repository does not have
321normalized line endings. This variable can be set to 'input',
322in which case no output conversion is performed.
323
Junio C Hamanoaa83a7d2007-03-05 02:37:29324core.symlinks::
325If false, symbolic links are checked out as small plain files that
Junio C Hamano35738e82008-01-07 07:55:46326contain the link text. linkgit:git-update-index[1] and
327linkgit:git-add[1] will not change the recorded type to regular
Junio C Hamanoaa83a7d2007-03-05 02:37:29328file. Useful on filesystems like FAT that do not support
Junio C Hamano9df0c662009-11-23 11:09:27329symbolic links.
330+
331The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
332will probe and set core.symlinks false if appropriate when the repository
333is created.
Junio C Hamanoaa83a7d2007-03-05 02:37:29334
Junio C Hamano07824ce2006-04-25 07:36:54335core.gitProxy::
336A "proxy command" to execute (as 'command host port') instead
337of establishing direct connection to the remote server when
Junio C Hamano076ffcc2013-02-06 05:13:21338using the Git protocol for fetching. If the variable value is
Junio C Hamano07824ce2006-04-25 07:36:54339in the "COMMAND for DOMAIN" format, the command is applied only
340on hostnames ending with the specified domain string. This variable
341may be set multiple times and is matched in the given order;
342the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17343+
344Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
345(which always applies universally, without the special "for"
346handling).
Junio C Hamanoea82cff2009-03-18 01:54:48347+
348The special string `none` can be used as the proxy command to
349specify that no proxy be used for a given domain pattern.
350This is useful for excluding servers inside a firewall from
351proxy use, while defaulting to a common proxy for external domains.
Junio C Hamano07824ce2006-04-25 07:36:54352
353core.ignoreStat::
Junio C Hamano054ea082008-06-01 08:26:34354If true, commands which modify both the working tree and the index
355will mark the updated paths with the "assume unchanged" bit in the
356index. These marked files are then assumed to stay unchanged in the
Junio C Hamano8fb66e52011-10-05 20:59:51357working tree, until you mark them otherwise manually - Git will not
Junio C Hamano054ea082008-06-01 08:26:34358detect the file changes by lstat() calls. This is useful on systems
359where those are very slow, such as Microsoft Windows.
360See linkgit:git-update-index[1].
Junio C Hamano07824ce2006-04-25 07:36:54361False by default.
362
Junio C Hamano88a3a072006-05-04 08:01:43363core.preferSymlinkRefs::
364Instead of the default "symref" format for HEAD
365and other symbolic reference files, use symbolic links.
366This is sometimes needed to work with old scripts that
367expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54368
Junio C Hamano1025e752007-02-23 07:21:26369core.bare::
370If true this repository is assumed to be 'bare' and has no
371working directory associated with it. If this is the case a
372number of commands that require a working directory will be
Junio C Hamano35738e82008-01-07 07:55:46373disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Junio C Hamano1025e752007-02-23 07:21:26374+
Junio C Hamano35738e82008-01-07 07:55:46375This setting is automatically guessed by linkgit:git-clone[1] or
376linkgit:git-init[1] when the repository was created. By default a
Junio C Hamano1025e752007-02-23 07:21:26377repository that ends in "/.git" is assumed to be not bare (bare =
378false), while all other repositories are assumed to be bare (bare
379= true).
380
Junio C Hamanod526ba92007-07-02 00:17:42381core.worktree::
Junio C Hamano80d58462011-01-24 22:52:52382Set the path to the root of the working tree.
Junio C Hamano764a6672007-10-23 01:23:31383This can be overridden by the GIT_WORK_TREE environment
Junio C Hamano80d58462011-01-24 22:52:52384variable and the '--work-tree' command line option.
Junio C Hamano5cd15182011-04-05 00:21:10385The value can be an absolute path or relative to the path to
Junio C Hamano80d58462011-01-24 22:52:52386the .git directory, which is either specified by --git-dir
387or GIT_DIR, or automatically discovered.
388If --git-dir or GIT_DIR is specified but none of
Junio C Hamano7d575a52008-04-30 08:45:27389--work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamano80d58462011-01-24 22:52:52390the current working directory is regarded as the top level
Junio C Hamano3609b332010-12-29 01:34:52391of your working tree.
Junio C Hamano80d58462011-01-24 22:52:52392+
393Note that this variable is honored even when set in a configuration
394file in a ".git" subdirectory of a directory and its value differs
395from the latter directory (e.g. "/path/to/.git/config" has
396core.worktree set to "/different/path"), which is most likely a
Junio C Hamano076ffcc2013-02-06 05:13:21397misconfiguration. Running Git commands in the "/path/to" directory will
Junio C Hamano80d58462011-01-24 22:52:52398still use "/different/path" as the root of the work tree and can cause
399confusion unless you know what you are doing (e.g. you are creating a
400read-only snapshot of the same index to a location different from the
401repository's usual working tree).
Junio C Hamanod526ba92007-07-02 00:17:42402
Junio C Hamano341071d2006-06-04 07:24:48403core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49404Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamanoa2ec14f2006-11-02 00:22:48405"$GIT_DIR/logs/<ref>", by appending the new and old
Junio C Hamanoe3f080d2013-04-22 02:27:13406SHA-1, the date/time and the reason of the update, but
Junio C Hamanoa2ec14f2006-11-02 00:22:48407only when the file exists. If this configuration
408variable is set to true, missing "$GIT_DIR/logs/<ref>"
Junio C Hamano15567bc2011-07-23 00:51:59409file is automatically created for branch heads (i.e. under
410refs/heads/), remote refs (i.e. under refs/remotes/),
411note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
Junio C Hamano1caaf472006-12-31 08:29:35412+
413This information can be used to determine what commit
414was the tip of a branch "2 days ago".
415+
416This value is true by default in a repository that has
417a working directory associated with it, and false by
418default in a bare repository.
Junio C Hamano341071d2006-06-04 07:24:48419
Junio C Hamano07824ce2006-04-25 07:36:54420core.repositoryFormatVersion::
421Internal variable identifying the repository format and layout
422version.
423
424core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42425When 'group' (or 'true'), the repository is made shareable between
426several users in a group (making sure all the files and objects are
427group-writable). When 'all' (or 'world' or 'everybody'), the
428repository will be readable by all users, additionally to being
Junio C Hamano076ffcc2013-02-06 05:13:21429group-shareable. When 'umask' (or 'false'), Git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37430reported by umask(2). When '0xxx', where '0xxx' is an octal number,
431files in the repository will have this mode value. '0xxx' will override
Junio C Hamano83eded12009-04-20 08:18:00432user's umask value (whereas the other options will only override
433requested parts of the user's umask value). Examples: '0660' will make
434the repo read/write-able for the owner and group, but inaccessible to
435others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Junio C Hamano2f102bb2008-04-26 02:23:37436repository that is group-readable but not group-writable.
437See linkgit:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54438
439core.warnAmbiguousRefs::
Junio C Hamano076ffcc2013-02-06 05:13:21440If true, Git will warn you if the ref name you passed it is ambiguous
Junio C Hamano947ab822013-03-19 23:07:29441and might match multiple refs in the repository. True by default.
Junio C Hamano07824ce2006-04-25 07:36:54442
Junio C Hamano7ec15722006-07-07 02:03:59443core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09444An integer -1..9, indicating a default compression level.
445-1 is the zlib default. 0 means no compression,
446and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42447If set, this provides a default to other compression variables,
448such as 'core.loosecompression' and 'pack.compression'.
Junio C Hamanoa126a3b2006-07-04 04:55:26449
Junio C Hamanof2ce2972007-05-20 19:12:09450core.loosecompression::
451An integer -1..9, indicating the compression level for objects that
452are not in a pack file. -1 is the zlib default. 0 means no
453compression, and 1..9 are various speed/size tradeoffs, 9 being
454slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42455not set, defaults to 1 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49456
Junio C Hamanofc4d38c2007-01-08 06:53:32457core.packedGitWindowSize::
458Number of bytes of a pack file to map into memory in a
459single mapping operation. Larger window sizes may allow
460your system to process a smaller number of large pack files
461more quickly. Smaller window sizes will negatively affect
462performance due to increased calls to the operating system's
463memory manager, but may improve performance when accessing
464a large number of large pack files.
465+
466Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
467MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
468be reasonable for all users/operating systems. You probably do
469not need to adjust this value.
470+
471Common unit suffixes of 'k', 'm', or 'g' are supported.
472
473core.packedGitLimit::
474Maximum number of bytes to map simultaneously into memory
475from pack files. If Git needs to access more than this many
476bytes at once to complete an operation it will unmap existing
477regions to reclaim virtual address space within the process.
478+
479Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
480This should be reasonable for all users/operating systems, except on
481the largest projects. You probably do not need to adjust this value.
482+
483Common unit suffixes of 'k', 'm', or 'g' are supported.
484
Junio C Hamanob8c51282007-03-19 10:43:30485core.deltaBaseCacheLimit::
486Maximum number of bytes to reserve for caching base objects
Junio C Hamano619596a2010-08-18 22:15:35487that may be referenced by multiple deltified objects. By storing the
Junio C Hamanob8c51282007-03-19 10:43:30488entire decompressed base objects in a cache Git is able
489to avoid unpacking and decompressing frequently used base
490objects multiple times.
491+
492Default is 16 MiB on all platforms. This should be reasonable
493for all users/operating systems, except on the largest projects.
494You probably do not need to adjust this value.
495+
496Common unit suffixes of 'k', 'm', or 'g' are supported.
497
Junio C Hamano5c246f22010-02-03 07:34:53498core.bigFileThreshold::
499Files larger than this size are stored deflated, without
500attempting delta compression. Storing large files without
501delta compression avoids excessive memory usage, at the
502slight expense of increased disk usage.
503+
504Default is 512 MiB on all platforms. This should be reasonable
505for most projects as source code and other text files can still
506be delta compressed, but larger binary media files won't be.
507+
508Common unit suffixes of 'k', 'm', or 'g' are supported.
Junio C Hamano5c246f22010-02-03 07:34:53509
Junio C Hamano1d90cb02007-07-03 07:05:31510core.excludesfile::
Junio C Hamano5e284b42007-05-22 07:23:37511In addition to '.gitignore' (per-directory) and
Junio C Hamano076ffcc2013-02-06 05:13:21512'.git/info/exclude', Git looks into this file for patterns
Junio C Hamanob76a6862012-05-02 22:02:46513of files which are not meant to be tracked. "`~/`" is expanded
514to the value of `$HOME` and "`~user/`" to the specified user's
Junio C Hamano8edb4c72012-07-09 20:33:55515home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
516If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
517is used instead. See linkgit:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37518
Junio C Hamano3fd7b262010-09-08 22:44:20519core.askpass::
520Some commands (e.g. svn and http interfaces) that interactively
521ask for a password can be told to use an external program given
522via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
523environment variable. If not set, fall back to the value of the
524'SSH_ASKPASS' environment variable or, failing that, a simple password
525prompt. The external program shall be given a suitable prompt as
526command line argument and write the password on its STDOUT.
527
Junio C Hamano3b4609d2010-09-30 00:04:34528core.attributesfile::
529In addition to '.gitattributes' (per-directory) and
Junio C Hamano076ffcc2013-02-06 05:13:21530'.git/info/attributes', Git looks into this file for attributes
Junio C Hamano3b4609d2010-09-30 00:04:34531(see linkgit:gitattributes[5]). Path expansions are made the same
Junio C Hamano8edb4c72012-07-09 20:33:55532way as for `core.excludesfile`. Its default value is
533$XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
534set or empty, $HOME/.config/git/attributes is used instead.
Junio C Hamano3b4609d2010-09-30 00:04:34535
Junio C Hamanof6002a92007-07-20 10:28:22536core.editor::
537Commands such as `commit` and `tag` that lets you edit
Junio C Hamanoa6387422007-08-25 03:54:27538messages by launching an editor uses the value of this
Junio C Hamanof6002a92007-07-20 10:28:22539variable when it is set, and the environment variable
Junio C Hamano3b70d3c2009-11-21 17:37:37540`GIT_EDITOR` is not set. See linkgit:git-var[1].
Junio C Hamanof6002a92007-07-20 10:28:22541
Junio C Hamano3f2ed6f2013-02-04 19:24:09542core.commentchar::
543Commands such as `commit` and `tag` that lets you edit
544messages consider a line that begins with this character
545commented, and removes them after the editor returns
546(default '#').
547
Junio C Hamano6231f822011-10-24 05:18:52548sequence.editor::
Junio C Hamano778a3412013-03-28 23:24:30549Text editor used by `git rebase -i` for editing the rebase instruction file.
Junio C Hamano6231f822011-10-24 05:18:52550The value is meant to be interpreted by the shell when it is used.
551It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
552When not configured the default commit message editor is used instead.
553
Junio C Hamano28d8ede2007-07-05 05:51:38554core.pager::
Junio C Hamano0e0e0d22013-09-12 23:25:03555Text viewer for use by Git commands (e.g., 'less'). The value
556is meant to be interpreted by the shell. The order of preference
557is the `$GIT_PAGER` environment variable, then `core.pager`
558configuration, then `$PAGER`, and then the default chosen at
559compile time (usually 'less').
560+
561When the `LESS` environment variable is unset, Git sets it to `FRSX`
562(if `LESS` environment variable is set, Git does not change it at
563all). If you want to selectively override Git's default setting
564for `LESS`, you can set `core.pager` to e.g. `less -+S`. This will
565be passed to the shell by Git, which will translate the final
566command to `LESS=FRSX less -+S`. The environment tells the command
567to set the `S` option to chop long lines but the command line
568resets it to the default to fold long lines.
Junio C Hamanobc8d4782014-01-13 23:35:50569+
570Likewise, when the `LV` environment variable is unset, Git sets it
571to `-c`. You can override this setting by exporting `LV` with
572another value or setting `core.pager` to `lv +c`.
Junio C Hamano28d8ede2007-07-05 05:51:38573
Junio C Hamano942b35e2007-12-09 10:19:33574core.whitespace::
575A comma separated list of common whitespace problems to
Junio C Hamano1aa40d22010-01-21 17:46:43576notice. 'git diff' will use `color.diff.whitespace` to
577highlight them, and 'git apply --whitespace=error' will
Junio C Hamano3db8b412008-07-26 06:45:59578consider them as errors. You can prefix `-` to disable
579any of them (e.g. `-trailing-space`):
Junio C Hamano942b35e2007-12-09 10:19:33580+
Junio C Hamanob71a22d2009-10-17 08:23:47581* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano942b35e2007-12-09 10:19:33582 as an error (enabled by default).
583* `space-before-tab` treats a space character that appears immediately
584 before a tab character in the initial indent part of the line as an
585 error (enabled by default).
Junio C Hamano281fd392012-09-17 23:57:41586* `indent-with-non-tab` treats a line that is indented with space
587 characters instead of the equivalent tabs as an error (not enabled by
588 default).
Junio C Hamanocb39aea2010-05-09 07:24:48589* `tab-in-indent` treats a tab character in the initial indent part of
590 the line as an error (not enabled by default).
Junio C Hamanob71a22d2009-10-17 08:23:47591* `blank-at-eof` treats blank lines added at the end of file as an error
592 (enabled by default).
593* `trailing-space` is a short-hand to cover both `blank-at-eol` and
594 `blank-at-eof`.
Junio C Hamano601f3e52008-02-25 08:40:42595* `cr-at-eol` treats a carriage-return at the end of line as
596 part of the line terminator, i.e. with it, `trailing-space`
597 does not trigger if the character before such a carriage-return
598 is not a whitespace (not enabled by default).
Junio C Hamanoeef01fe2010-12-13 08:31:58599* `tabwidth=<n>` tells how many character positions a tab occupies; this
Junio C Hamano076ffcc2013-02-06 05:13:21600 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
Junio C Hamanoeef01fe2010-12-13 08:31:58601 errors. The default tab width is 8. Allowed values are 1 to 63.
Junio C Hamano942b35e2007-12-09 10:19:33602
Junio C Hamano9eb57532008-06-26 06:33:46603core.fsyncobjectfiles::
604This boolean will enable 'fsync()' when writing object files.
605+
606This is a total waste of time and effort on a filesystem that orders
607data writes properly, but can be useful for filesystems that do not use
608journalling (traditional UNIX filesystems) or that only journal metadata
609and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
610
Junio C Hamano610d1762008-11-28 06:27:13611core.preloadindex::
612Enable parallel index preload for operations like 'git diff'
613+
614This can speed up operations like 'git diff' and 'git status' especially
615on filesystems like NFS that have weak caching semantics and thus
Junio C Hamano076ffcc2013-02-06 05:13:21616relatively high IO latencies. With this set to 'true', Git will do the
Junio C Hamano610d1762008-11-28 06:27:13617index comparison to the filesystem data in parallel, allowing
618overlapping IO's.
619
Junio C Hamanoa9499de2009-04-30 03:38:48620core.createObject::
621You can set this to 'link', in which case a hardlink followed by
622a delete of the source are used to make sure that object creation
623will not overwrite existing objects.
624+
625On some file system/operating system combinations, this is unreliable.
626Set this config setting to 'rename' there; However, This will remove the
627check that makes sure that existing object files will not get overwritten.
Junio C Hamanoe91ea772009-04-26 01:41:41628
Junio C Hamano3b70d3c2009-11-21 17:37:37629core.notesRef::
630When showing commit messages, also show notes which are stored in
Junio C Hamanoa574a092010-06-13 19:57:10631the given ref. The ref must be fully qualified. If the given
632ref does not exist, it is not an error but means that no
633notes should be printed.
Junio C Hamano3b70d3c2009-11-21 17:37:37634+
Junio C Hamanoa574a092010-06-13 19:57:10635This setting defaults to "refs/notes/commits", and it can be overridden by
636the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
Junio C Hamano3b70d3c2009-11-21 17:37:37637
Junio C Hamano3c8d6702010-01-13 23:09:03638core.sparseCheckout::
639Enable "sparse checkout" feature. See section "Sparse checkout" in
640linkgit:git-read-tree[1] for more information.
641
Junio C Hamano6371b0e2011-03-23 23:36:21642core.abbrev::
643Set the length object names are abbreviated to. If unspecified,
644many commands abbreviate to 7 hexdigits, which may not be enough
645for abbreviated object names to stay unique for sufficiently long
646time.
647
Junio C Hamano3d141512009-06-01 01:22:40648add.ignore-errors::
Junio C Hamano60186642010-12-02 14:18:26649add.ignoreErrors::
Junio C Hamano1aa40d22010-01-21 17:46:43650Tells 'git add' to continue adding files when some files cannot be
Junio C Hamano3d141512009-06-01 01:22:40651added due to indexing errors. Equivalent to the '--ignore-errors'
Junio C Hamano076ffcc2013-02-06 05:13:21652option of linkgit:git-add[1]. Older versions of Git accept only
Junio C Hamano60186642010-12-02 14:18:26653`add.ignore-errors`, which does not follow the usual naming
Junio C Hamano076ffcc2013-02-06 05:13:21654convention for configuration variables. Newer versions of Git
Junio C Hamano60186642010-12-02 14:18:26655honor `add.ignoreErrors` as well.
Junio C Hamano3d141512009-06-01 01:22:40656
Junio C Hamano33db4372006-06-07 19:51:45657alias.*::
Junio C Hamano35738e82008-01-07 07:55:46658Command aliases for the linkgit:git[1] command wrapper - e.g.
Junio C Hamano33db4372006-06-07 19:51:45659after defining "alias.last = cat-file commit HEAD", the invocation
660"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17661confusion and troubles with script usage, aliases that
Junio C Hamano076ffcc2013-02-06 05:13:21662hide existing Git commands are ignored. Arguments are split by
Junio C Hamanof1d14802006-06-08 00:48:17663spaces, the usual shell quoting and escaping is supported.
664quote pair and a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39665+
666If the alias expansion is prefixed with an exclamation point,
667it will be treated as a shell command. For example, defining
668"alias.new = !gitk --all --not ORIG_HEAD", the invocation
669"git new" is equivalent to running the shell command
Junio C Hamano48bc1ce2009-07-09 16:49:19670"gitk --all --not ORIG_HEAD". Note that shell commands will be
671executed from the top-level directory of a repository, which may
672not necessarily be the current directory.
Junio C Hamano5f2627d2011-05-06 20:23:48673'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
674from the original current directory. See linkgit:git-rev-parse[1].
Junio C Hamano9cb74f22007-02-12 04:15:05675
Junio C Hamanocaa712a2010-03-11 01:17:35676am.keepcr::
677If true, git-am will call git-mailsplit for patches in mbox format
678with parameter '--keep-cr'. In this case git-mailsplit will
Junio C Hamano619596a2010-08-18 22:15:35679not remove `\r` from lines ending with `\r\n`. Can be overridden
Junio C Hamanocaa712a2010-03-11 01:17:35680by giving '--no-keep-cr' from the command line.
681See linkgit:git-am[1], linkgit:git-mailsplit[1].
682
Junio C Hamanofe24db02009-08-22 05:10:47683apply.ignorewhitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43684When set to 'change', tells 'git apply' to ignore changes in
Junio C Hamanofe24db02009-08-22 05:10:47685whitespace, in the same way as the '--ignore-space-change'
686option.
Junio C Hamano1aa40d22010-01-21 17:46:43687When set to one of: no, none, never, false tells 'git apply' to
Junio C Hamanofe24db02009-08-22 05:10:47688respect all whitespace differences.
689See linkgit:git-apply[1].
690
Junio C Hamano07824ce2006-04-25 07:36:54691apply.whitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43692Tells 'git apply' how to handle whitespaces, in the same way
Junio C Hamano35738e82008-01-07 07:55:46693as the '--whitespace' option. See linkgit:git-apply[1].
Junio C Hamano07824ce2006-04-25 07:36:54694
Junio C Hamano7fd84172007-05-24 07:00:32695branch.autosetupmerge::
Junio C Hamano1aa40d22010-01-21 17:46:43696Tells 'git branch' and 'git checkout' to set up new branches
Junio C Hamano24bc09a2008-02-28 00:27:44697so that linkgit:git-pull[1] will appropriately merge from the
698starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32699this behavior can be chosen per-branch using the `--track`
Junio C Hamano24bc09a2008-02-28 00:27:44700and `--no-track` options. The valid settings are: `false` -- no
701automatic setup is done; `true` -- automatic setup is done when the
Junio C Hamano97bcb482010-11-25 03:16:07702starting point is a remote-tracking branch; `always` --
703automatic setup is done when the starting point is either a
704local branch or remote-tracking
Junio C Hamano24bc09a2008-02-28 00:27:44705branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32706
Junio C Hamano869bb802008-05-12 00:29:47707branch.autosetuprebase::
Junio C Hamano1aa40d22010-01-21 17:46:43708When a new branch is created with 'git branch' or 'git checkout'
Junio C Hamano076ffcc2013-02-06 05:13:21709that tracks another branch, this variable tells Git to set
Junio C Hamano869bb802008-05-12 00:29:47710up pull to rebase instead of merge (see "branch.<name>.rebase").
711When `never`, rebase is never automatically set to true.
712When `local`, rebase is set to true for tracked branches of
713other local branches.
714When `remote`, rebase is set to true for tracked branches of
Junio C Hamano97bcb482010-11-25 03:16:07715remote-tracking branches.
Junio C Hamano869bb802008-05-12 00:29:47716When `always`, rebase will be set to true for all tracking
717branches.
718See "branch.autosetupmerge" for details on how to set up a
719branch to track another branch.
720This option defaults to never.
721
Junio C Hamano47c1e3c2006-09-25 04:45:55722branch.<name>.remote::
Junio C Hamano63b6fdb2013-04-07 23:37:13723When on branch <name>, it tells 'git fetch' and 'git push'
724which remote to fetch from/push to. The remote to push to
725may be overridden with `remote.pushdefault` (for all branches).
726The remote to push to, for the current branch, may be further
727overridden by `branch.<name>.pushremote`. If no remote is
728configured, or if you are not on any branch, it defaults to
729`origin` for fetching and `remote.pushdefault` for pushing.
Junio C Hamano238ce9c2013-10-23 21:56:38730Additionally, `.` (a period) is the current local repository
731(a dot-repository), see `branch.<name>.merge`'s final note below.
Junio C Hamano63b6fdb2013-04-07 23:37:13732
733branch.<name>.pushremote::
734When on branch <name>, it overrides `branch.<name>.remote` for
735pushing. It also overrides `remote.pushdefault` for pushing
736from branch <name>. When you pull from one place (e.g. your
737upstream) and push to another place (e.g. your own publishing
738repository), you would want to set `remote.pushdefault` to
739specify the remote to push to for all branches, and use this
740option to override it for a specific branch.
Junio C Hamano47c1e3c2006-09-25 04:45:55741
742branch.<name>.merge::
Junio C Hamano0706c802009-03-30 22:34:19743Defines, together with branch.<name>.remote, the upstream branch
Junio C Hamanob02377c2011-04-28 22:26:02744for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
Junio C Hamano1aa40d22010-01-21 17:46:43745branch to merge and can also affect 'git push' (see push.default).
746When in branch <name>, it tells 'git fetch' the default
Junio C Hamanoc2b47092007-10-25 06:50:31747refspec to be marked for merging in FETCH_HEAD. The value is
748handled like the remote part of a refspec, and must match a
749ref which is fetched from the remote given by
750"branch.<name>.remote".
Junio C Hamano1aa40d22010-01-21 17:46:43751The merge information is used by 'git pull' (which at first calls
752'git fetch') to lookup the default branch for merging. Without
753this option, 'git pull' defaults to merge the first refspec fetched.
Junio C Hamano96010b22006-12-09 21:15:46754Specify multiple values to get an octopus merge.
Junio C Hamano1aa40d22010-01-21 17:46:43755If you wish to setup 'git pull' so that it merges into <name> from
Junio C Hamano6e149c02007-03-16 10:21:07756another branch in the local repository, you can point
Junio C Hamano238ce9c2013-10-23 21:56:38757branch.<name>.merge to the desired branch, and use the relative path
758setting `.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:55759
Junio C Hamano1b50ce92007-10-03 12:05:53760branch.<name>.mergeoptions::
761Sets default options for merging into branch <name>. The syntax and
Junio C Hamanoc0e55e72009-10-10 00:56:29762supported options are the same as those of linkgit:git-merge[1], but
Junio C Hamano1b50ce92007-10-03 12:05:53763option values containing whitespace characters are currently not
764supported.
765
Junio C Hamano0c999702007-12-03 09:57:55766branch.<name>.rebase::
767When true, rebase the branch <name> on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:08768instead of merging the default branch from the default remote when
Junio C Hamano515ab1d2011-12-09 23:41:20769"git pull" is run. See "pull.rebase" for doing this in a non
770branch-specific manner.
771+
Junio C Hamanocf4a1742013-09-11 22:57:50772When preserve, also pass `--preserve-merges` along to 'git rebase'
773so that locally committed merge commits will not be flattened
774by running 'git pull'.
775+
Junio C Hamano515ab1d2011-12-09 23:41:20776*NOTE*: this is a possibly dangerous operation; do *not* use
777it unless you understand the implications (see linkgit:git-rebase[1]
778for details).
Junio C Hamano0c999702007-12-03 09:57:55779
Junio C Hamano46247182013-01-09 20:50:28780branch.<name>.description::
781Branch description, can be edited with
782`git branch --edit-description`. Branch description is
783automatically added in the format-patch cover letter or
784request-pull summary.
785
Junio C Hamano8760ea62008-03-14 08:58:45786browser.<tool>.cmd::
787Specify the command to invoke the specified browser. The
788specified command is evaluated in shell with the URLs passed
Junio C Hamano360e3a12011-07-13 23:51:56789as arguments. (See linkgit:git-web{litdd}browse[1].)
Junio C Hamano8760ea62008-03-14 08:58:45790
Junio C Hamanoe35a6fc2008-01-29 09:46:27791browser.<tool>.path::
792Override the path for the given tool that may be used to
793browse HTML help (see '-w' option in linkgit:git-help[1]) or a
794working repository in gitweb (see linkgit:git-instaweb[1]).
795
Junio C Hamano47b9acd2007-04-24 07:34:34796clean.requireForce::
Junio C Hamanoe6f28d02013-09-17 21:34:00797A boolean to make git-clean do nothing unless given -f,
798-i or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:34799
Junio C Hamanoeb692952007-01-03 22:02:12800color.branch::
801A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46802linkgit:git-branch[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21803`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoeb692952007-01-03 22:02:12804only when the output is to a terminal. Defaults to false.
805
806color.branch.<slot>::
807Use customized color for branch coloration. `<slot>` is one of
808`current` (the current branch), `local` (a local branch),
Junio C Hamano76927822013-04-19 21:26:57809`remote` (a remote-tracking branch in refs/remotes/),
810`upstream` (upstream tracking branch), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:22811refs).
812+
813The value for these configuration variables is a list of colors (at most
814two) and attributes (at most one), separated by spaces. The colors
815accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
816`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
817`blink` and `reverse`. The first color given is the foreground; the
818second is the background. The position of the attribute, if any,
819doesn't matter.
Junio C Hamanoeb692952007-01-03 22:02:12820
Junio C Hamano3f403b02006-12-13 10:14:13821color.diff::
Junio C Hamano5f2627d2011-05-06 20:23:48822Whether to use ANSI escape sequences to add color to patches.
823If this is set to `always`, linkgit:git-diff[1],
824linkgit:git-log[1], and linkgit:git-show[1] will use color
825for all patches. If it is set to `true` or `auto`, those
826commands will only use color when output is to the terminal.
827Defaults to false.
828+
Junio C Hamanod75148a2014-04-08 19:48:38829This does not affect linkgit:git-format-patch[1] or the
Junio C Hamano5f2627d2011-05-06 20:23:48830'git-diff-{asterisk}' plumbing commands. Can be overridden on the
831command line with the `--color[=<when>]` option.
Junio C Hamano9ae1a062006-07-10 08:12:34832
Junio C Hamano3f403b02006-12-13 10:14:13833color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:22834Use customized color for diff colorization. `<slot>` specifies
835which part of the patch to use the specified color, and is one
836of `plain` (context text), `meta` (metainformation), `frag`
Junio C Hamano2bd8a742009-12-01 21:16:59837(hunk header), 'func' (function in hunk header), `old` (removed lines),
838`new` (added lines), `commit` (commit headers), or `whitespace`
839(highlighting whitespace errors). The values of these variables may be
840specified as in color.branch.<slot>.
Junio C Hamano9ae1a062006-07-10 08:12:34841
Junio C Hamano7d449522010-07-01 00:08:51842color.decorate.<slot>::
843Use customized color for 'git log --decorate' output. `<slot>` is one
844of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
Junio C Hamano97bcb482010-11-25 03:16:07845branches, remote-tracking branches, tags, stash and HEAD, respectively.
Junio C Hamano7d449522010-07-01 00:08:51846
Junio C Hamanod257cff2009-03-18 05:27:16847color.grep::
848When set to `always`, always highlight matches. When `false` (or
849`never`), never. When set to `true` or `auto`, use color only
850when the output is written to the terminal. Defaults to `false`.
851
Junio C Hamano0299d922010-03-20 20:59:31852color.grep.<slot>::
853Use customized color for grep colorization. `<slot>` specifies which
854part of the line to use the specified color, and is one of
855+
856--
857`context`;;
858non-matching text in context lines (when using `-A`, `-B`, or `-C`)
859`filename`;;
860filename prefix (when not using `-h`)
861`function`;;
862function name lines (when using `-p`)
863`linenumber`;;
864line number prefix (when using `-n`)
865`match`;;
866matching text
867`selected`;;
868non-matching text in selected lines
869`separator`;;
870separators between fields on a line (`:`, `-`, and `=`)
871and between hunks (`--`)
872--
873+
874The values of these variables may be specified as in color.branch.<slot>.
Junio C Hamanod257cff2009-03-18 05:27:16875
Junio C Hamano00b8b632007-12-07 09:50:49876color.interactive::
Junio C Hamano35738e82008-01-07 07:55:46877When set to `always`, always use colors for interactive prompts
Junio C Hamano58f587a2013-07-22 19:20:59878and displays (such as those used by "git-add --interactive" and
879"git-clean --interactive"). When false (or `never`), never.
880When set to `true` or `auto`, use colors only when the output is
881to the terminal. Defaults to false.
Junio C Hamano00b8b632007-12-07 09:50:49882
883color.interactive.<slot>::
Junio C Hamano58f587a2013-07-22 19:20:59884Use customized color for 'git add --interactive' and 'git clean
885--interactive' output. `<slot>` may be `prompt`, `header`, `help`
886or `error`, for four distinct types of normal output from
887interactive commands. The values of these variables may be
888specified as in color.branch.<slot>.
Junio C Hamano00b8b632007-12-07 09:50:49889
Junio C Hamanoe7935c42006-12-13 21:32:17890color.pager::
891A boolean to enable/disable colored output when the pager is in
892use (default is true).
893
Junio C Hamano52ba2952009-05-18 17:43:02894color.showbranch::
895A boolean to enable/disable color in the output of
896linkgit:git-show-branch[1]. May be set to `always`,
897`false` (or `never`) or `auto` (or `true`), in which case colors are used
898only when the output is to a terminal. Defaults to false.
899
Junio C Hamanoe7935c42006-12-13 21:32:17900color.status::
901A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46902linkgit:git-status[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21903`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoe7935c42006-12-13 21:32:17904only when the output is to a terminal. Defaults to false.
905
906color.status.<slot>::
907Use customized color for status colorization. `<slot>` is
908one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:04909`added` or `updated` (files which are added but not committed),
910`changed` (files which are changed but not added in the index),
Junio C Hamano076ffcc2013-02-06 05:13:21911`untracked` (files which are not tracked by Git),
Junio C Hamano0d75e872010-12-17 06:57:26912`branch` (the current branch), or
Junio C Hamanob713ff12008-05-24 01:12:30913`nobranch` (the color the 'no branch' warning is shown in, defaulting
914to red). The values of these variables may be specified as in
915color.branch.<slot>.
Junio C Hamanoe7935c42006-12-13 21:32:17916
Junio C Hamano83d46a22008-02-21 02:29:42917color.ui::
Junio C Hamano5f2627d2011-05-06 20:23:48918This variable determines the default value for variables such
919as `color.diff` and `color.grep` that control the use of color
920per command family. Its scope will expand as more commands learn
921configuration to set a default for the `--color` option. Set it
Junio C Hamanofa1d3492013-06-20 23:39:43922to `false` or `never` if you prefer Git commands not to use
923color unless enabled explicitly with some other configuration
924or the `--color` option. Set it to `always` if you want all
925output not intended for machine consumption to use color, to
926`true` or `auto` (this is the default since Git 1.8.4) if you
927want such output to use color when written to the terminal.
Junio C Hamano83d46a22008-02-21 02:29:42928
Junio C Hamano22700fb2012-05-03 23:07:25929column.ui::
930Specify whether supported commands should output in columns.
931This variable consists of a list of tokens separated by spaces
932or commas:
933+
Junio C Hamanoa1952302013-07-01 21:31:18934These options control when the feature should be enabled
935(defaults to 'never'):
936+
Junio C Hamano22700fb2012-05-03 23:07:25937--
938`always`;;
939always show in columns
940`never`;;
941never show in columns
942`auto`;;
943show in columns if the output is to the terminal
Junio C Hamanoa1952302013-07-01 21:31:18944--
945+
946These options control layout (defaults to 'column'). Setting any
947of these implies 'always' if none of 'always', 'never', or 'auto' are
948specified.
949+
950--
Junio C Hamano22700fb2012-05-03 23:07:25951`column`;;
Junio C Hamanoa1952302013-07-01 21:31:18952fill columns before rows
Junio C Hamano22700fb2012-05-03 23:07:25953`row`;;
954fill rows before columns
955`plain`;;
956show in one column
Junio C Hamanoa1952302013-07-01 21:31:18957--
958+
959Finally, these options can be combined with a layout option (defaults
960to 'nodense'):
961+
962--
Junio C Hamano22700fb2012-05-03 23:07:25963`dense`;;
964make unequal size columns to utilize more space
965`nodense`;;
966make equal size columns
967--
Junio C Hamano22700fb2012-05-03 23:07:25968
969column.branch::
970Specify whether to output branch listing in `git branch` in columns.
971See `column.ui` for details.
972
Junio C Hamano58f587a2013-07-22 19:20:59973column.clean::
974Specify the layout when list items in `git clean -i`, which always
975shows files and directories in columns. See `column.ui` for details.
976
Junio C Hamano22700fb2012-05-03 23:07:25977column.status::
978Specify whether to output untracked files in `git status` in columns.
979See `column.ui` for details.
980
981column.tag::
982Specify whether to output tag listing in `git tag` in columns.
983See `column.ui` for details.
984
Junio C Hamanoce836cc2013-01-21 02:01:53985commit.cleanup::
986This setting overrides the default of the `--cleanup` option in
987`git commit`. See linkgit:git-commit[1] for details. Changing the
988default can be useful when you always want to keep lines that begin
989with comment character `#` in your log message, in which case you
990would do `git config commit.cleanup whitespace` (note that you will
991have to remove the help lines that begin with `#` in the commit log
992template yourself, if you do this).
993
Junio C Hamano5b3533d2014-02-27 23:07:15994commit.gpgsign::
995
996A boolean to specify whether all commits should be GPG signed.
997Use of this option when doing operations such as rebase can
998result in a large number of commits being signed. It may be
999convenient to use an agent to avoid typing your GPG passphrase
1000several times.
1001
Junio C Hamanod0d892c2010-01-24 20:06:291002commit.status::
Junio C Hamano6ce6b6c2010-01-18 01:25:501003A boolean to enable/disable inclusion of status information in the
1004commit message template when using an editor to prepare the commit
1005message. Defaults to true.
1006
Junio C Hamano4653c6f2008-11-26 22:50:201007commit.template::
1008Specify a file to use as the template for new commit messages.
Junio C Hamanob76a6862012-05-02 22:02:461009"`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
Junio C Hamanobf984de2009-11-23 06:11:191010specified user's home directory.
Junio C Hamano4653c6f2008-11-26 22:50:201011
Junio C Hamano0df92712011-12-21 22:30:441012credential.helper::
1013Specify an external helper to be called when a username or
1014password credential is needed; the helper may consult external
1015storage to avoid prompting the user for the credentials. See
1016linkgit:gitcredentials[7] for details.
1017
1018credential.useHttpPath::
1019When acquiring credentials, consider the "path" component of an http
1020or https URL to be important. Defaults to false. See
1021linkgit:gitcredentials[7] for more information.
1022
1023credential.username::
1024If no username is set for a network authentication, use this username
1025by default. See credential.<context>.* below, and
1026linkgit:gitcredentials[7].
1027
1028credential.<url>.*::
1029Any of the credential.* options above can be applied selectively to
1030some credentials. For example "credential.https://example.com.username"
1031would set the default username only for https connections to
1032example.com. See linkgit:gitcredentials[7] for details on how URLs are
1033matched.
1034
Junio C Hamano209ebe82011-04-27 21:09:591035include::diff-config.txt[]
Junio C Hamano3bd66e92009-04-18 06:17:561036
1037difftool.<tool>.path::
1038Override the path for the given tool. This is useful in case
1039your tool is not in the PATH.
1040
1041difftool.<tool>.cmd::
1042Specify the command to invoke the specified diff tool.
1043The specified command is evaluated in shell with the following
1044variables available: 'LOCAL' is set to the name of the temporary
1045file containing the contents of the diff pre-image and 'REMOTE'
1046is set to the name of the temporary file containing the contents
1047of the diff post-image.
1048
1049difftool.prompt::
1050Prompt before each invocation of the diff tool.
1051
Junio C Hamano0d75e872010-12-17 06:57:261052fetch.recurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:101053This option can be either set to a boolean value or to 'on-demand'.
1054Setting it to a boolean changes the behavior of fetch and pull to
1055unconditionally recurse into submodules when set to true or to not
1056recurse at all when set to false. When set to 'on-demand' (the default
1057value), fetch and pull will only recurse into a populated submodule
1058when its superproject retrieves a commit that updates the submodule's
1059reference.
Junio C Hamano0d75e872010-12-17 06:57:261060
Junio C Hamano8fb66e52011-10-05 20:59:511061fetch.fsckObjects::
1062If it is set to true, git-fetch-pack will check all fetched
1063objects. It will abort in the case of a malformed object or a
1064broken link. The result of an abort are only dangling objects.
1065Defaults to false. If not set, the value of `transfer.fsckObjects`
1066is used instead.
1067
Junio C Hamano54ea8d32007-01-25 07:59:481068fetch.unpackLimit::
Junio C Hamano076ffcc2013-02-06 05:13:211069If the number of objects fetched over the Git native
Junio C Hamano54ea8d32007-01-25 07:59:481070transfer is below this
1071limit, then the objects will be unpacked into loose object
1072files. However if the number of received objects equals or
1073exceeds this limit then the received pack will be stored as
1074a pack, after adding any missing delta bases. Storing the
1075pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:171076especially on slow filesystems. If not set, the value of
1077`transfer.unpackLimit` is used instead.
Junio C Hamano54ea8d32007-01-25 07:59:481078
Junio C Hamano8eac2682013-09-09 22:35:201079fetch.prune::
1080If true, fetch will automatically behave as if the `--prune`
1081option was given on the command line. See also `remote.<name>.prune`.
1082
Junio C Hamanof4581102009-04-25 08:29:591083format.attach::
1084Enable multipart/mixed attachments as the default for
1085'format-patch'. The value can also be a double quoted string
1086which will enable attachments as the default and set the
1087value as the boundary. See the --attach option in
1088linkgit:git-format-patch[1].
1089
Junio C Hamano8c5802d2007-11-15 00:13:361090format.numbered::
Junio C Hamano7d06a8a2008-10-20 05:42:331091A boolean which can enable or disable sequence numbers in patch
1092subjects. It defaults to "auto" which enables it only if there
1093is more than one patch. It can be enabled or disabled for all
1094messages by setting it to "true" or "false". See --numbered
1095option in linkgit:git-format-patch[1].
Junio C Hamano8c5802d2007-11-15 00:13:361096
Junio C Hamano07824ce2006-04-25 07:36:541097format.headers::
1098Additional email headers to include in a patch to be submitted
Junio C Hamano35738e82008-01-07 07:55:461099by mail. See linkgit:git-format-patch[1].
Junio C Hamano07824ce2006-04-25 07:36:541100
Junio C Hamano70664a02010-07-13 22:48:051101format.to::
Junio C Hamanof4581102009-04-25 08:29:591102format.cc::
Junio C Hamano70664a02010-07-13 22:48:051103Additional recipients to include in a patch to be submitted
1104by mail. See the --to and --cc options in
1105linkgit:git-format-patch[1].
Junio C Hamanof4581102009-04-25 08:29:591106
1107format.subjectprefix::
1108The default for format-patch is to output files with the '[PATCH]'
1109subject prefix. Use this variable to change that prefix.
1110
Junio C Hamano89a57342010-06-22 23:22:551111format.signature::
1112The default for format-patch is to output a signature containing
Junio C Hamano076ffcc2013-02-06 05:13:211113the Git version number. Use this variable to change that default.
Junio C Hamano89a57342010-06-22 23:22:551114Set this variable to the empty string ("") to suppress
1115signature generation.
1116
Junio C Hamanod4c8e112007-03-04 10:32:381117format.suffix::
1118The default for format-patch is to output files with the suffix
1119`.patch`. Use this variable to change that suffix (make sure to
1120include the dot if you want it).
1121
Junio C Hamano86bcccc2008-03-08 09:33:551122format.pretty::
1123The default pretty format for log/show/whatchanged command,
1124See linkgit:git-log[1], linkgit:git-show[1],
1125linkgit:git-whatchanged[1].
1126
Junio C Hamanoea6a7642009-03-11 23:56:191127format.thread::
Junio C Hamano1aa40d22010-01-21 17:46:431128The default threading style for 'git format-patch'. Can be
Junio C Hamanob141a922010-01-10 19:55:141129a boolean value, or `shallow` or `deep`. `shallow` threading
1130makes every mail a reply to the head of the series,
Junio C Hamanoea6a7642009-03-11 23:56:191131where the head is chosen from the cover letter, the
Junio C Hamanob76a6862012-05-02 22:02:461132`--in-reply-to`, and the first patch mail, in this order.
Junio C Hamanof4581102009-04-25 08:29:591133`deep` threading makes every mail a reply to the previous one.
Junio C Hamanoea6a7642009-03-11 23:56:191134A true boolean value is the same as `shallow`, and a false
1135value disables threading.
1136
Junio C Hamano5f9a6f02009-04-06 08:26:561137format.signoff::
Junio C Hamano804a9742013-04-28 23:10:311138A boolean value which lets you enable the `-s/--signoff` option of
1139format-patch by default. *Note:* Adding the Signed-off-by: line to a
1140patch should be a conscious act and means that you certify you have
1141the rights to submit this work under the same open source license.
1142Please see the 'SubmittingPatches' document for further discussion.
Junio C Hamano5f9a6f02009-04-06 08:26:561143
Junio C Hamanoea3b7522013-04-18 19:37:531144format.coverLetter::
1145A boolean that controls whether to generate a cover-letter when
1146format-patch is invoked, but in addition can be set to "auto", to
1147generate a cover-letter only when there's more than one patch.
1148
Junio C Hamano209ebe82011-04-27 21:09:591149filter.<driver>.clean::
1150The command which is used to convert the content of a worktree
1151file to a blob upon checkin. See linkgit:gitattributes[5] for
1152details.
1153
1154filter.<driver>.smudge::
1155The command which is used to convert the content of a blob
1156object to a worktree file upon checkout. See
1157linkgit:gitattributes[5] for details.
1158
Junio C Hamano624dd4c2014-04-03 21:56:301159gc.aggressiveDepth::
1160The depth parameter used in the delta compression
1161algorithm used by 'git gc --aggressive'. This defaults
1162to 250.
1163
Junio C Hamanof2ce2972007-05-20 19:12:091164gc.aggressiveWindow::
1165The window size parameter used in the delta compression
Junio C Hamano1aa40d22010-01-21 17:46:431166algorithm used by 'git gc --aggressive'. This defaults
Junio C Hamanob04bb3f2010-04-14 14:07:361167to 250.
Junio C Hamanof2ce2972007-05-20 19:12:091168
Junio C Hamano1b50ce92007-10-03 12:05:531169gc.auto::
1170When there are approximately more than this many loose
1171objects in the repository, `git gc --auto` will pack them.
1172Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:171173light-weight garbage collection from time to time. The
1174default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531175
1176gc.autopacklimit::
1177When there are more than this many packs that are not
1178marked with `*.keep` file in the repository, `git gc
Junio C Hamanoe77b0152008-01-12 06:44:171179--auto` consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:371180default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531181
Junio C Hamano08ef8c22014-03-10 14:53:441182gc.autodetach::
1183Make `git gc --auto` return immediately andrun in background
1184if the system supports it. Default is true.
1185
Junio C Hamano9d52e572007-02-13 23:48:201186gc.packrefs::
Junio C Hamanob141a922010-01-10 19:55:141187Running `git pack-refs` in a repository renders it
1188unclonable by Git versions prior to 1.5.1.2 over dumb
1189transports such as HTTP. This variable determines whether
Junio C Hamanocdd1c332010-12-20 10:08:001190'git gc' runs `git pack-refs`. This can be set to `notbare`
Junio C Hamanob141a922010-01-10 19:55:141191to enable it within all non-bare repos or it can be set to a
1192boolean value. The default is `true`.
Junio C Hamano9d52e572007-02-13 23:48:201193
Junio C Hamano09a926d2008-03-13 07:55:291194gc.pruneexpire::
Junio C Hamano1aa40d22010-01-21 17:46:431195When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
Junio C Hamanoa3148f52009-01-14 08:49:571196Override the grace period with this config variable. The value
1197"now" may be used to disable this grace period and always prune
1198unreachable objects immediately.
Junio C Hamano09a926d2008-03-13 07:55:291199
Junio C Hamano74640642006-12-27 10:59:551200gc.reflogexpire::
Junio C Hamanocc7636a2010-05-21 14:57:531201gc.<pattern>.reflogexpire::
Junio C Hamano1aa40d22010-01-21 17:46:431202'git reflog expire' removes reflog entries older than
Junio C Hamanocc7636a2010-05-21 14:57:531203this time; defaults to 90 days. With "<pattern>" (e.g.
1204"refs/stash") in the middle the setting applies only to
1205the refs that match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551206
1207gc.reflogexpireunreachable::
Junio C Hamanocc7636a2010-05-21 14:57:531208gc.<ref>.reflogexpireunreachable::
Junio C Hamano1aa40d22010-01-21 17:46:431209'git reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:551210this time and are not reachable from the current tip;
Junio C Hamanocc7636a2010-05-21 14:57:531211defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1212in the middle, the setting applies only to the refs that
1213match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551214
1215gc.rerereresolved::
1216Records of conflicted merge you resolved earlier are
Junio C Hamano1aa40d22010-01-21 17:46:431217kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461218The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551219
1220gc.rerereunresolved::
1221Records of conflicted merge you have not resolved are
Junio C Hamano1aa40d22010-01-21 17:46:431222kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461223The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551224
Junio C Hamanoa3148f52009-01-14 08:49:571225gitcvs.commitmsgannotation::
1226Append this string to each commit message. Set to empty string
1227to disable this feature. Defaults to "via git-CVS emulator".
1228
Junio C Hamano07824ce2006-04-25 07:36:541229gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:271230Whether the CVS server interface is enabled for this repository.
Junio C Hamano35738e82008-01-07 07:55:461231See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541232
1233gitcvs.logfile::
Junio C Hamanoa6387422007-08-25 03:54:271234Path to a log file where the CVS server interface well... logs
Junio C Hamano35738e82008-01-07 07:55:461235various stuff. See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541236
Junio C Hamano17bd2272008-09-01 06:11:171237gitcvs.usecrlfattr::
Junio C Hamanobb88cf42010-06-21 15:23:551238If true, the server will look up the end-of-line conversion
1239attributes for files to determine the '-k' modes to use. If
Junio C Hamano076ffcc2013-02-06 05:13:211240the attributes force Git to treat a file as text,
Junio C Hamano619596a2010-08-18 22:15:351241the '-k' mode will be left blank so CVS clients will
Junio C Hamanobb88cf42010-06-21 15:23:551242treat it as text. If they suppress text conversion, the file
Junio C Hamanocb1c44f2008-08-06 06:19:331243will be set with '-kb' mode, which suppresses any newline munging
Junio C Hamanobb88cf42010-06-21 15:23:551244the client might otherwise do. If the attributes do not allow
1245the file type to be determined, then 'gitcvs.allbinary' is
1246used. See linkgit:gitattributes[5].
Junio C Hamanodfccbb02008-05-26 01:16:141247
Junio C Hamanod9e0e5d2007-04-14 16:22:041248gitcvs.allbinary::
Junio C Hamanodfccbb02008-05-26 01:16:141249This is used if 'gitcvs.usecrlfattr' does not resolve
1250the correct '-kb' mode to use. If true, all
1251unresolved files are sent to the client in
1252mode '-kb'. This causes the client to treat them
1253as binary files, which suppresses any newline munging it
1254otherwise might do. Alternatively, if it is set to "guess",
1255then the contents of the file are examined to decide if
1256it is binary, similar to 'core.autocrlf'.
Junio C Hamanoa2ad99e2007-04-18 09:57:041257
1258gitcvs.dbname::
1259Database used by git-cvsserver to cache revision information
Junio C Hamano076ffcc2013-02-06 05:13:211260derived from the Git repository. The exact meaning depends on the
Junio C Hamanoa2ad99e2007-04-18 09:57:041261used database driver, for SQLite (which is the default driver) this
1262is a filename. Supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461263linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Junio C Hamanoa2ad99e2007-04-18 09:57:041264Default: '%Ggitcvs.%m.sqlite'
1265
1266gitcvs.dbdriver::
1267Used Perl DBI driver. You can specify any available driver
Junio C Hamano804a9742013-04-28 23:10:311268for this here, but it might not work. git-cvsserver is tested
Junio C Hamanoa2ad99e2007-04-18 09:57:041269with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1270reported *not* to work with 'DBD::mysql'. Experimental feature.
1271May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamano35738e82008-01-07 07:55:461272See linkgit:git-cvsserver[1].
Junio C Hamanod9e0e5d2007-04-14 16:22:041273
Junio C Hamanoa2ad99e2007-04-18 09:57:041274gitcvs.dbuser, gitcvs.dbpass::
1275Database user and password. Only useful if setting 'gitcvs.dbdriver',
1276since SQLite has no concept of database users and/or passwords.
1277'gitcvs.dbuser' supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461278linkgit:git-cvsserver[1] for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:041279
Junio C Hamanoa74efce2008-04-02 08:39:081280gitcvs.dbTableNamePrefix::
1281Database table name prefix. Prepended to the names of any
1282database tables used, allowing a single database to be used
1283for several repositories. Supports variable substitution (see
1284linkgit:git-cvsserver[1] for details). Any non-alphabetic
1285characters will be replaced with underscores.
1286
Junio C Hamanodfccbb02008-05-26 01:16:141287All gitcvs variables except for 'gitcvs.usecrlfattr' and
1288'gitcvs.allbinary' can also be specified as
1289'gitcvs.<access_method>.<varname>' (where 'access_method'
Junio C Hamanoa6387422007-08-25 03:54:271290is one of "ext" and "pserver") to make them apply only for the given
1291access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:041292
Junio C Hamano11821ed2011-10-19 18:42:091293gitweb.category::
1294gitweb.description::
1295gitweb.owner::
1296gitweb.url::
1297See linkgit:gitweb[1] for description.
1298
1299gitweb.avatar::
1300gitweb.blame::
1301gitweb.grep::
1302gitweb.highlight::
1303gitweb.patches::
1304gitweb.pickaxe::
1305gitweb.remote_heads::
1306gitweb.showsizes::
1307gitweb.snapshot::
1308See linkgit:gitweb.conf[5] for description.
1309
Junio C Hamanoa03ac862011-04-02 04:32:291310grep.lineNumber::
1311If set to true, enable '-n' option by default.
1312
Junio C Hamanoa00504d2012-08-27 21:11:231313grep.patternType::
1314Set the default matching behavior. Using a value of 'basic', 'extended',
1315'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1316'--fixed-strings', or '--perl-regexp' option accordingly, while the
1317value 'default' will return to the default matching behavior.
1318
Junio C Hamanoa03ac862011-04-02 04:32:291319grep.extendedRegexp::
Junio C Hamanoa00504d2012-08-27 21:11:231320If set to true, enable '--extended-regexp' option by default. This
1321option is ignored when the 'grep.patternType' option is set to a value
1322other than 'default'.
Junio C Hamanoa03ac862011-04-02 04:32:291323
Junio C Hamano4fd24422012-01-06 21:52:431324gpg.program::
1325Use this custom program instead of "gpg" found on $PATH when
1326making or verifying a PGP signature. The program must support the
1327same command line interface as GPG, namely, to verify a detached
1328signature, "gpg --verify $file - <$signature" is run, and the
1329program is expected to signal a good signature by exiting with
1330code 0, and to generate an ascii-armored detached signature, the
1331standard input of "gpg -bsau $key" is fed with the contents to be
1332signed, and the program is expected to send the result to its
1333standard output.
1334
Junio C Hamano6d76d612008-05-09 05:46:081335gui.commitmsgwidth::
1336Defines how wide the commit message window is in the
1337linkgit:git-gui[1]. "75" is the default.
1338
1339gui.diffcontext::
1340Specifies how many context lines should be used in calls to diff
1341made by the linkgit:git-gui[1]. The default is "5".
1342
Junio C Hamano796c55f2014-05-02 21:45:151343gui.displayuntracked::
1344Determines if linkgit::git-gui[1] shows untracked files
1345in the file list. The default is "true".
1346
Junio C Hamanod3452a02008-11-15 08:07:551347gui.encoding::
1348Specifies the default encoding to use for displaying of
1349file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1350It can be overridden by setting the 'encoding' attribute
1351for relevant files (see linkgit:gitattributes[5]).
1352If this option is not set, the tools default to the
1353locale encoding.
1354
Junio C Hamano6d76d612008-05-09 05:46:081355gui.matchtrackingbranch::
1356Determines if new branches created with linkgit:git-gui[1] should
1357default to tracking remote branches with matching names or
1358not. Default: "false".
1359
1360gui.newbranchtemplate::
1361Is used as suggested name when creating new branches using the
1362linkgit:git-gui[1].
1363
1364gui.pruneduringfetch::
Junio C Hamano97bcb482010-11-25 03:16:071365"true" if linkgit:git-gui[1] should prune remote-tracking branches when
Junio C Hamano6d76d612008-05-09 05:46:081366performing a fetch. The default value is "false".
1367
1368gui.trustmtime::
1369Determines if linkgit:git-gui[1] should trust the file modification
1370timestamp or not. By default the timestamps are not trusted.
1371
1372gui.spellingdictionary::
1373Specifies the dictionary used for spell checking commit messages in
1374the linkgit:git-gui[1]. When set to "none" spell checking is turned
1375off.
1376
Junio C Hamanod3452a02008-11-15 08:07:551377gui.fastcopyblame::
Junio C Hamano1aa40d22010-01-21 17:46:431378If true, 'git gui blame' uses `-C` instead of `-C -C` for original
Junio C Hamanod3452a02008-11-15 08:07:551379location detection. It makes blame significantly faster on huge
1380repositories at the expense of less thorough copy detection.
1381
1382gui.copyblamethreshold::
Junio C Hamano610d1762008-11-28 06:27:131383Specifies the threshold to use in 'git gui blame' original location
Junio C Hamanod3452a02008-11-15 08:07:551384detection, measured in alphanumeric characters. See the
1385linkgit:git-blame[1] manual for more information on copy detection.
1386
1387gui.blamehistoryctx::
1388Specifies the radius of history context in days to show in
1389linkgit:gitk[1] for the selected commit, when the `Show History
1390Context` menu item is invoked from 'git gui blame'. If this
1391variable is set to zero, the whole history is shown.
1392
Junio C Hamano92d312a2008-12-15 07:22:201393guitool.<name>.cmd::
1394Specifies the shell command line to execute when the corresponding item
1395of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1396mandatory for every tool. The command is executed from the root of
1397the working directory, and in the environment it receives the name of
1398the tool as 'GIT_GUITOOL', the name of the currently selected file as
1399'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1400the head is detached, 'CUR_BRANCH' is empty).
1401
1402guitool.<name>.needsfile::
1403Run the tool only if a diff is selected in the GUI. It guarantees
1404that 'FILENAME' is not empty.
1405
1406guitool.<name>.noconsole::
1407Run the command silently, without creating a window to display its
1408output.
1409
1410guitool.<name>.norescan::
1411Don't rescan the working directory for changes after the tool
1412finishes execution.
1413
1414guitool.<name>.confirm::
1415Show a confirmation dialog before actually running the tool.
1416
1417guitool.<name>.argprompt::
1418Request a string argument from the user, and pass it to the tool
1419through the 'ARGS' environment variable. Since requesting an
1420argument implies confirmation, the 'confirm' option has no effect
1421if this is enabled. If the option is set to 'true', 'yes', or '1',
1422the dialog uses a built-in generic prompt; otherwise the exact
1423value of the variable is used.
1424
1425guitool.<name>.revprompt::
1426Request a single valid revision from the user, and set the
1427'REVISION' environment variable. In other aspects this option
1428is similar to 'argprompt', and can be used together with it.
1429
1430guitool.<name>.revunmerged::
1431Show only unmerged branches in the 'revprompt' subdialog.
1432This is useful for tools similar to merge or rebase, but not
1433for things like checkout or reset.
1434
1435guitool.<name>.title::
1436Specifies the title to use for the prompt dialog. The default
1437is the tool name.
1438
1439guitool.<name>.prompt::
1440Specifies the general prompt string to display at the top of
1441the dialog, before subsections for 'argprompt' and 'revprompt'.
1442The default value includes the actual command.
1443
Junio C Hamano4e272312008-01-08 09:13:211444help.browser::
1445Specify the browser that will be used to display help in the
1446'web' format. See linkgit:git-help[1].
1447
1448help.format::
1449Override the default help format used by linkgit:git-help[1].
1450Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1451the default. 'web' and 'html' are the same.
1452
Junio C Hamanof24b8062008-09-09 01:34:391453help.autocorrect::
1454Automatically correct and execute mistyped commands after
1455waiting for the given number of deciseconds (0.1 sec). If more
1456than one command can be deduced from the entered text, nothing
1457will be executed. If the value of this option is negative,
1458the corrected command will be executed immediately. If the
1459value is 0 - the command will be just shown but not executed.
1460This is the default.
1461
Junio C Hamano5dd5fae2013-01-18 21:06:491462help.htmlpath::
1463Specify the path where the HTML documentation resides. File system paths
1464and URLs are supported. HTML pages will be prefixed with this path when
1465help is displayed in the 'web' format. This defaults to the documentation
1466path of your Git installation.
1467
Junio C Hamano58256872007-12-04 08:31:131468http.proxy::
Junio C Hamano3dd93922012-03-05 07:49:111469Override the HTTP proxy, normally configured using the 'http_proxy',
1470'https_proxy', and 'all_proxy' environment variables (see
1471`curl(1)`). This can be overridden on a per-remote basis; see
1472remote.<name>.proxy
Junio C Hamano58256872007-12-04 08:31:131473
Junio C Hamano4c4b0122011-06-30 01:19:321474http.cookiefile::
1475File containing previously stored cookie lines which should be used
Junio C Hamano076ffcc2013-02-06 05:13:211476in the Git http session, if they match the server. The file format
Junio C Hamano4c4b0122011-06-30 01:19:321477of the file to read cookies from should be plain HTTP headers or
1478the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1479NOTE that the file specified with http.cookiefile is only used as
Junio C Hamano8eac2682013-09-09 22:35:201480input unless http.saveCookies is set.
1481
1482http.savecookies::
1483If set, store cookies received during requests to the file specified by
1484http.cookiefile. Has no effect if http.cookiefile is unset.
Junio C Hamano4c4b0122011-06-30 01:19:321485
Junio C Hamano07824ce2006-04-25 07:36:541486http.sslVerify::
1487Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451488over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Junio C Hamano07824ce2006-04-25 07:36:541489variable.
1490
1491http.sslCert::
1492File containing the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451493over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Junio C Hamano07824ce2006-04-25 07:36:541494variable.
1495
1496http.sslKey::
1497File containing the SSL private key when fetching or pushing
Junio C Hamano341071d2006-06-04 07:24:481498over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Junio C Hamano07824ce2006-04-25 07:36:541499variable.
1500
Junio C Hamano48bc1ce2009-07-09 16:49:191501http.sslCertPasswordProtected::
Junio C Hamano076ffcc2013-02-06 05:13:211502Enable Git's password prompt for the SSL certificate. Otherwise
Junio C Hamano48bc1ce2009-07-09 16:49:191503OpenSSL will prompt the user, possibly many times, if the
1504certificate or private key is encrypted. Can be overridden by the
1505'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1506
Junio C Hamano07824ce2006-04-25 07:36:541507http.sslCAInfo::
1508File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:481509fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano07824ce2006-04-25 07:36:541510'GIT_SSL_CAINFO' environment variable.
1511
1512http.sslCAPath::
1513Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:451514with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541515by the 'GIT_SSL_CAPATH' environment variable.
1516
Junio C Hamano76927822013-04-19 21:26:571517http.sslTry::
1518Attempt to use AUTH SSL/TLS and encrypted data transfers
1519when connecting via regular FTP protocol. This might be needed
1520if the FTP server requires it for security reasons or you wish
1521to connect securely whenever remote FTP server supports it.
1522Default is false since it might trigger certificate verification
1523errors on misconfigured servers.
1524
Junio C Hamano07824ce2006-04-25 07:36:541525http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:481526How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541527by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1528
Junio C Hamanob141a922010-01-10 19:55:141529http.minSessions::
1530The number of curl sessions (counted across slots) to be kept across
1531requests. They will not be ended with curl_easy_cleanup() until
1532http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1533value will be capped at 1. Defaults to 1.
1534
Junio C Hamano3b70d3c2009-11-21 17:37:371535http.postBuffer::
1536Maximum size in bytes of the buffer used by smart HTTP
1537transports when POSTing data to the remote system.
1538For requests larger than this buffer size, HTTP/1.1 and
1539Transfer-Encoding: chunked is used to avoid creating a
1540massive pack file locally. Default is 1 MiB, which is
1541sufficient for most requests.
1542
Junio C Hamano07824ce2006-04-25 07:36:541543http.lowSpeedLimit, http.lowSpeedTime::
1544If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1545for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano341071d2006-06-04 07:24:481546Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Junio C Hamano07824ce2006-04-25 07:36:541547'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1548
Junio C Hamanof1dcdfe2006-09-29 08:10:511549http.noEPSV::
1550A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:041551This can helpful with some "poor" ftp servers which don't
Junio C Hamanof1dcdfe2006-09-29 08:10:511552support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1553environment variable. Default is false (curl will use EPSV).
1554
Junio C Hamano53ba6d02010-08-22 07:25:121555http.useragent::
1556The HTTP USER_AGENT string presented to an HTTP server. The default
Junio C Hamano076ffcc2013-02-06 05:13:211557value represents the version of the client Git such as git/1.7.1.
Junio C Hamano53ba6d02010-08-22 07:25:121558This option allows you to override this value to a more common value
1559such as Mozilla/4.0. This may be necessary, for instance, if
1560connecting through a firewall that restricts HTTP connections to a set
1561of common USER_AGENT strings (but not including those like git/1.7.1).
1562Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1563
Junio C Hamano8eac2682013-09-09 22:35:201564http.<url>.*::
1565Any of the http.* options above can be applied selectively to some urls.
1566For a config key to match a URL, each element of the config key is
1567compared to that of the URL, in the following order:
1568+
1569--
1570. Scheme (e.g., `https` in `https://example.com/`). This field
1571 must match exactly between the config key and the URL.
1572
1573. Host/domain name (e.g., `example.com` in `https://example.com/`).
1574 This field must match exactly between the config key and the URL.
1575
1576. Port number (e.g., `8080` in `http://example.com:8080/`).
1577 This field must match exactly between the config key and the URL.
1578 Omitted port numbers are automatically converted to the correct
1579 default for the scheme before matching.
1580
1581. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1582 path field of the config key must match the path field of the URL
1583 either exactly or as a prefix of slash-delimited path elements. This means
1584 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1585 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1586 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1587 key with just path `foo/`).
1588
1589. User name (e.g., `user` in `https://user@example.com/repo.git`). If
1590 the config key has a user name it must match the user name in the
1591 URL exactly. If the config key does not have a user name, that
1592 config key will match a URL with any user name (including none),
1593 but at a lower precedence than a config key with a user name.
1594--
1595+
1596The list above is ordered by decreasing precedence; a URL that matches
1597a config key's path is preferred to one that matches its user name. For example,
1598if the URL is `https://user@example.com/foo/bar` a config key match of
1599`https://example.com/foo` will be preferred over a config key match of
1600`https://user@example.com`.
1601+
1602All URLs are normalized before attempting any matching (the password part,
1603if embedded in the URL, is always ignored for matching purposes) so that
1604equivalent urls that are simply spelled differently will match properly.
1605Environment variable settings always override any matches. The urls that are
1606matched against are those given directly to Git commands. This means any URLs
1607visited as a result of a redirection do not participate in matching.
1608
Junio C Hamano07824ce2006-04-25 07:36:541609i18n.commitEncoding::
Junio C Hamano076ffcc2013-02-06 05:13:211610Character encoding the commit messages are stored in; Git itself
Junio C Hamano07824ce2006-04-25 07:36:541611does not care per se, but this information is necessary e.g. when
1612importing commits from emails or in the gitk graphical history
1613browser (and possibly at other places in the future or in other
Junio C Hamano35738e82008-01-07 07:55:461614porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Junio C Hamano07824ce2006-04-25 07:36:541615
Junio C Hamano51f92e22006-12-29 05:18:281616i18n.logOutputEncoding::
1617Character encoding the commit messages are converted to when
Junio C Hamano1aa40d22010-01-21 17:46:431618running 'git log' and friends.
Junio C Hamano51f92e22006-12-29 05:18:281619
Junio C Hamano4653c6f2008-11-26 22:50:201620imap::
1621The configuration variables in the 'imap' section are described
1622in linkgit:git-imap-send[1].
1623
Junio C Hamano81703b22014-03-14 22:00:271624index.version::
1625Specify the version with which new index files should be
1626initialized. This does not affect existing repositories.
1627
Junio C Hamanocaa712a2010-03-11 01:17:351628init.templatedir::
1629Specify the directory from which templates will be copied.
1630(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1631
Junio C Hamano4e272312008-01-08 09:13:211632instaweb.browser::
1633Specify the program that will be used to browse your working
1634repository in gitweb. See linkgit:git-instaweb[1].
1635
1636instaweb.httpd::
1637The HTTP daemon command-line to start gitweb on your working
1638repository. See linkgit:git-instaweb[1].
1639
1640instaweb.local::
1641If true the web server started by linkgit:git-instaweb[1] will
1642be bound to the local IP (127.0.0.1).
1643
1644instaweb.modulepath::
Junio C Hamano619596a2010-08-18 22:15:351645The default module path for linkgit:git-instaweb[1] to use
1646instead of /usr/lib/apache2/modules. Only used if httpd
1647is Apache.
Junio C Hamano4e272312008-01-08 09:13:211648
1649instaweb.port::
1650The port number to bind the gitweb httpd to. See
1651linkgit:git-instaweb[1].
1652
Junio C Hamanoe5bf6c12009-02-07 21:43:101653interactive.singlekey::
Junio C Hamano27a128b2009-08-13 01:23:001654In interactive commands, allow the user to provide one-letter
Junio C Hamanoe5bf6c12009-02-07 21:43:101655input with a single key (i.e., without hitting enter).
Junio C Hamanob76a6862012-05-02 22:02:461656Currently this is used by the `--patch` mode of
Junio C Hamano3d050d62011-05-17 06:43:341657linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1658linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1659setting is silently ignored if portable keystroke input
Junio C Hamano81703b22014-03-14 22:00:271660is not available; requires the Perl module Term::ReadKey.
Junio C Hamanoe5bf6c12009-02-07 21:43:101661
Junio C Hamanof93530e2011-05-25 23:59:591662log.abbrevCommit::
1663If true, makes linkgit:git-log[1], linkgit:git-show[1], and
Junio C Hamanob76a6862012-05-02 22:02:461664linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1665override this option with `--no-abbrev-commit`.
Junio C Hamanof93530e2011-05-25 23:59:591666
Junio C Hamanob713ff12008-05-24 01:12:301667log.date::
Junio C Hamano2db3e752010-09-03 21:33:061668Set the default date-time mode for the 'log' command.
1669Setting a value for log.date is similar to using 'git log''s
Junio C Hamanob76a6862012-05-02 22:02:461670`--date` option. Possible values are `relative`, `local`,
Junio C Hamano2db3e752010-09-03 21:33:061671`default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1672for details.
Junio C Hamanob713ff12008-05-24 01:12:301673
Junio C Hamanocb39aea2010-05-09 07:24:481674log.decorate::
1675Print out the ref names of any commits that are shown by the log
1676command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1677'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1678specified, the full ref name (including prefix) will be printed.
1679This is the same as the log commands '--decorate' option.
1680
Junio C Hamanofe9acab2006-11-24 12:10:551681log.showroot::
1682If true, the initial commit will be shown as a big creation event.
1683This is equivalent to a diff against an empty tree.
Junio C Hamano35738e82008-01-07 07:55:461684Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Junio C Hamanofe9acab2006-11-24 12:10:551685normally hide the root commit will now show it. True by default.
1686
Junio C Hamanoce836cc2013-01-21 02:01:531687log.mailmap::
1688If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1689linkgit:git-whatchanged[1] assume `--use-mailmap`.
1690
Junio C Hamano8bc410e2009-02-15 10:38:191691mailmap.file::
1692The location of an augmenting mailmap file. The default
1693mailmap, located in the root of the repository, is loaded
1694first, then the mailmap file pointed to by this variable.
1695The location of the mailmap file may be in a repository
1696subdirectory, or somewhere outside of the repository itself.
1697See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1698
Junio C Hamanoabad6da2013-01-06 09:06:321699mailmap.blob::
1700Like `mailmap.file`, but consider the value as a reference to a
1701blob in the repository. If both `mailmap.file` and
1702`mailmap.blob` are given, both are parsed, with entries from
1703`mailmap.file` taking precedence. In a bare repository, this
1704defaults to `HEAD:.mailmap`. In a non-bare repository, it
1705defaults to empty.
1706
Junio C Hamano8b588d52008-03-15 09:48:371707man.viewer::
1708Specify the programs that may be used to display help in the
1709'man' format. See linkgit:git-help[1].
1710
Junio C Hamano6d76d612008-05-09 05:46:081711man.<tool>.cmd::
1712Specify the command to invoke the specified man viewer. The
1713specified command is evaluated in shell with the man page
1714passed as argument. (See linkgit:git-help[1].)
Junio C Hamano103ad7f2007-03-14 11:19:261715
Junio C Hamano6d76d612008-05-09 05:46:081716man.<tool>.path::
1717Override the path for the given tool that may be used to
1718display help in the 'man' format. See linkgit:git-help[1].
Junio C Hamanoe90436a2007-04-22 07:22:131719
Junio C Hamano4653c6f2008-11-26 22:50:201720include::merge-config.txt[]
Junio C Hamanoa476efa2008-10-10 15:31:421721
Junio C Hamano1fbbbc12007-12-18 07:01:271722mergetool.<tool>.path::
1723Override the path for the given tool. This is useful in case
1724your tool is not in the PATH.
1725
Junio C Hamano86bcccc2008-03-08 09:33:551726mergetool.<tool>.cmd::
1727Specify the command to invoke the specified merge tool. The
1728specified command is evaluated in shell with the following
1729variables available: 'BASE' is the name of a temporary file
1730containing the common base of the files to be merged, if available;
1731'LOCAL' is the name of a temporary file containing the contents of
1732the file on the current branch; 'REMOTE' is the name of a temporary
1733file containing the contents of the file from the branch being
1734merged; 'MERGED' contains the name of the file to which the merge
1735tool should write the results of a successful merge.
1736
1737mergetool.<tool>.trustExitCode::
1738For a custom merge command, specify whether the exit code of
1739the merge command can be used to determine whether the merge was
1740successful. If this is not set to true then the merge target file
1741timestamp is checked and the merge assumed to have been successful
1742if the file has been updated, otherwise the user is prompted to
1743indicate the success of the merge.
1744
1745mergetool.keepBackup::
1746After performing a merge, the original file with conflict markers
1747can be saved as a file with a `.orig` extension. If this variable
1748is set to `false` then this file is not preserved. Defaults to
1749`true` (i.e. keep the backup files).
1750
Junio C Hamano10b7a342009-01-01 22:05:171751mergetool.keepTemporaries::
Junio C Hamano076ffcc2013-02-06 05:13:211752When invoking a custom merge tool, Git uses a set of temporary
Junio C Hamano10b7a342009-01-01 22:05:171753files to pass to the tool. If the tool returns an error and this
1754variable is set to `true`, then these temporary files will be
1755preserved, otherwise they will be removed after the tool has
1756exited. Defaults to `false`.
1757
1758mergetool.prompt::
1759Prompt before each invocation of the merge resolution program.
1760
Junio C Hamano31667362010-03-25 00:38:531761notes.displayRef::
1762The (fully qualified) refname from which to show notes when
1763showing commit messages. The value of this variable can be set
1764to a glob, in which case notes from all matching refs will be
1765shown. You may also specify this configuration variable
1766several times. A warning will be issued for refs that do not
1767exist, but a glob that does not match any refs is silently
1768ignored.
1769+
1770This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1771environment variable, which must be a colon separated list of refs or
1772globs.
1773+
1774The effective value of "core.notesRef" (possibly overridden by
1775GIT_NOTES_REF) is also implicitly added to the list of refs to be
1776displayed.
1777
1778notes.rewrite.<command>::
1779When rewriting commits with <command> (currently `amend` or
Junio C Hamano076ffcc2013-02-06 05:13:211780`rebase`) and this variable is set to `true`, Git
Junio C Hamano31667362010-03-25 00:38:531781automatically copies your notes from the original to the
1782rewritten commit. Defaults to `true`, but see
1783"notes.rewriteRef" below.
Junio C Hamano31667362010-03-25 00:38:531784
1785notes.rewriteMode::
1786When copying notes during a rewrite (see the
1787"notes.rewrite.<command>" option), determines what to do if
1788the target commit already has a note. Must be one of
1789`overwrite`, `concatenate`, or `ignore`. Defaults to
1790`concatenate`.
1791+
1792This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1793environment variable.
1794
1795notes.rewriteRef::
1796When copying notes during a rewrite, specifies the (fully
1797qualified) ref whose notes should be copied. The ref may be a
1798glob, in which case notes in all matching refs will be copied.
1799You may also specify this configuration several times.
1800+
1801Does not have a default value; you must configure this variable to
Junio C Hamano8fb66e52011-10-05 20:59:511802enable note rewriting. Set it to `refs/notes/commits` to enable
1803rewriting for the default commit notes.
Junio C Hamano2b3ee5d2010-05-08 05:41:181804+
1805This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1806environment variable, which must be a colon separated list of refs or
1807globs.
Junio C Hamano31667362010-03-25 00:38:531808
Junio C Hamano75cc4c92006-07-24 08:25:031809pack.window::
Junio C Hamano35738e82008-01-07 07:55:461810The size of the window used by linkgit:git-pack-objects[1] when no
Junio C Hamano75cc4c92006-07-24 08:25:031811window size is given on the command line. Defaults to 10.
1812
Junio C Hamano91d44c52007-05-09 07:16:071813pack.depth::
Junio C Hamano35738e82008-01-07 07:55:461814The maximum delta depth used by linkgit:git-pack-objects[1] when no
Junio C Hamano91d44c52007-05-09 07:16:071815maximum depth is given on the command line. Defaults to 50.
1816
Junio C Hamano235d53f2007-07-13 00:25:151817pack.windowMemory::
Junio C Hamano35738e82008-01-07 07:55:461818The window memory size limit used by linkgit:git-pack-objects[1]
Junio C Hamano235d53f2007-07-13 00:25:151819when no limit is given on the command line. The value can be
1820suffixed with "k", "m", or "g". Defaults to 0, meaning no
1821limit.
1822
Junio C Hamanof2ce2972007-05-20 19:12:091823pack.compression::
1824An integer -1..9, indicating the compression level for objects
1825in a pack file. -1 is the zlib default. 0 means no
1826compression, and 1..9 are various speed/size tradeoffs, 9 being
1827slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:421828not set, defaults to -1, the zlib default, which is "a default
1829compromise between speed and compression (currently equivalent
1830to level 6)."
Junio C Hamano657fd8a2010-10-07 00:01:241831+
1832Note that changing the compression level will not automatically recompress
1833all existing objects. You can force recompression by passing the -F option
1834to linkgit:git-repack[1].
Junio C Hamanof2ce2972007-05-20 19:12:091835
Junio C Hamano679d22d2007-06-02 21:13:441836pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:271837The maximum memory in bytes used for caching deltas in
Junio C Hamano9f883862009-08-11 06:23:521838linkgit:git-pack-objects[1] before writing them out to a pack.
1839This cache is used to speed up the writing object phase by not
1840having to recompute the final delta result once the best match
1841for all objects is found. Repacking large repositories on machines
1842which are tight with memory might be badly impacted by this though,
1843especially if this cache pushes the system into swapping.
1844A value of 0 means no limit. The smallest size of 1 byte may be
1845used to virtually disable this cache. Defaults to 256 MiB.
Junio C Hamano679d22d2007-06-02 21:13:441846
1847pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:141848The maximum size of a delta, that is cached in
Junio C Hamano9f883862009-08-11 06:23:521849linkgit:git-pack-objects[1]. This cache is used to speed up the
1850writing object phase by not having to recompute the final delta
1851result once the best match for all objects is found. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:441852
Junio C Hamano58155b42007-09-15 07:46:141853pack.threads::
1854Specifies the number of threads to spawn when searching for best
Junio C Hamano35738e82008-01-07 07:55:461855delta matches. This requires that linkgit:git-pack-objects[1]
Junio C Hamano58155b42007-09-15 07:46:141856be compiled with pthreads otherwise this option is ignored with a
1857warning. This is meant to reduce packing time on multiprocessor
1858machines. The required amount of memory for the delta search window
1859is however multiplied by the number of threads.
Junio C Hamano076ffcc2013-02-06 05:13:211860Specifying 0 will cause Git to auto-detect the number of CPU's
Junio C Hamano24bc09a2008-02-28 00:27:441861and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:141862
Junio C Hamanod814b6d2007-11-04 11:13:491863pack.indexVersion::
1864Specify the default pack index version. Valid values are 1 for
1865legacy pack index used by Git versions prior to 1.5.2, and 2 for
1866the new pack index with capabilities for packs larger than 4 GB
1867as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:381868packs. Version 2 is the default. Note that version 2 is enforced
1869and this config option ignored whenever the corresponding pack is
1870larger than 2 GB.
1871+
Junio C Hamano076ffcc2013-02-06 05:13:211872If you have an old Git that does not understand the version 2 `*.idx` file,
Junio C Hamanofce7c7e2008-07-02 03:06:381873cloning or fetching over a non native protocol (e.g. "http" and "rsync")
Junio C Hamanob76a6862012-05-02 22:02:461874that will copy both `*.pack` file and corresponding `*.idx` file from the
Junio C Hamanofce7c7e2008-07-02 03:06:381875other side may give you a repository that cannot be accessed with your
Junio C Hamano076ffcc2013-02-06 05:13:211876older version of Git. If the `*.pack` file is smaller than 2 GB, however,
Junio C Hamanofce7c7e2008-07-02 03:06:381877you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
Junio C Hamanob76a6862012-05-02 22:02:461878the `*.idx` file.
Junio C Hamanod814b6d2007-11-04 11:13:491879
Junio C Hamano09a926d2008-03-13 07:55:291880pack.packSizeLimit::
Junio C Hamano4d979582010-02-04 06:27:291881The maximum size of a pack. This setting only affects
1882packing to a file when repacking, i.e. the git:// protocol
Junio C Hamanob76a6862012-05-02 22:02:461883is unaffected. It can be overridden by the `--max-pack-size`
Junio C Hamano4d979582010-02-04 06:27:291884option of linkgit:git-repack[1]. The minimum size allowed is
1885limited to 1 MiB. The default is unlimited.
1886Common unit suffixes of 'k', 'm', or 'g' are
1887supported.
Junio C Hamano49dccaf2008-02-10 10:48:011888
Junio C Hamano5b3533d2014-02-27 23:07:151889pack.useBitmaps::
1890When true, git will use pack bitmaps (if available) when packing
1891to stdout (e.g., during the server side of a fetch). Defaults to
1892true. You should not generally need to turn this off unless
1893you are debugging pack bitmaps.
1894
1895pack.writebitmaps::
1896When true, git will write a bitmap index when packing all
1897objects to disk (e.g., when `git repack -a` is run). This
1898index can speed up the "counting objects" phase of subsequent
1899packs created for clones and fetches, at the cost of some disk
1900space and extra time spent on the initial repack. Defaults to
1901false.
1902
1903pack.writeBitmapHashCache::
1904When true, git will include a "hash cache" section in the bitmap
1905index (if one is written). This cache can be used to feed git's
1906delta heuristics, potentially leading to better deltas between
1907bitmapped and non-bitmapped objects (e.g., when serving a fetch
1908between an older, bitmapped pack and objects that have been
1909pushed since the last gc). The downside is that it consumes 4
1910bytes per object of disk space, and that JGit's bitmap
1911implementation does not understand it, causing it to complain if
1912Git and JGit are used on the same repository. Defaults to false.
1913
Junio C Hamano9e96a1a2008-08-16 10:23:181914pager.<cmd>::
Junio C Hamano788eeba2010-12-08 22:50:431915If the value is boolean, turns on or off pagination of the
Junio C Hamano076ffcc2013-02-06 05:13:211916output of a particular Git subcommand when writing to a tty.
Junio C Hamano788eeba2010-12-08 22:50:431917Otherwise, turns on pagination for the subcommand using the
Junio C Hamanob76a6862012-05-02 22:02:461918pager specified by the value of `pager.<cmd>`. If `--paginate`
1919or `--no-pager` is specified on the command line, it takes
Junio C Hamano788eeba2010-12-08 22:50:431920precedence over this option. To disable pagination for all
1921commands, set `core.pager` or `GIT_PAGER` to `cat`.
Junio C Hamano9e96a1a2008-08-16 10:23:181922
Junio C Hamanoa574a092010-06-13 19:57:101923pretty.<name>::
1924Alias for a --pretty= format string, as specified in
1925linkgit:git-log[1]. Any aliases defined here can be used just
1926as the built-in pretty formats could. For example,
Junio C Hamanob76a6862012-05-02 22:02:461927running `git config pretty.changelog "format:* %H %s"`
Junio C Hamanoa574a092010-06-13 19:57:101928would cause the invocation `git log --pretty=changelog`
Junio C Hamanob76a6862012-05-02 22:02:461929to be equivalent to running `git log "--pretty=format:* %H %s"`.
Junio C Hamanoa574a092010-06-13 19:57:101930Note that an alias with the same name as a built-in format
1931will be silently ignored.
1932
Junio C Hamano5b3533d2014-02-27 23:07:151933pull.ff::
1934By default, Git does not create an extra merge commit when merging
1935a commit that is a descendant of the current commit. Instead, the
1936tip of the current branch is fast-forwarded. When set to `false`,
1937this variable tells Git to create an extra merge commit in such
1938a case (equivalent to giving the `--no-ff` option from the command
1939line). When set to `only`, only such fast-forward merges are
1940allowed (equivalent to giving the `--ff-only` option from the
1941command line).
1942
Junio C Hamano515ab1d2011-12-09 23:41:201943pull.rebase::
1944When true, rebase branches on top of the fetched branch, instead
1945of merging the default branch from the default remote when "git
1946pull" is run. See "branch.<name>.rebase" for setting this on a
1947per-branch basis.
1948+
Junio C Hamanocf4a1742013-09-11 22:57:501949When preserve, also pass `--preserve-merges` along to 'git rebase'
1950so that locally committed merge commits will not be flattened
1951by running 'git pull'.
1952+
Junio C Hamano515ab1d2011-12-09 23:41:201953*NOTE*: this is a possibly dangerous operation; do *not* use
1954it unless you understand the implications (see linkgit:git-rebase[1]
1955for details).
1956
Junio C Hamano07824ce2006-04-25 07:36:541957pull.octopus::
1958The default merge strategy to use when pulling multiple branches
1959at once.
1960
1961pull.twohead::
1962The default merge strategy to use when pulling a single branch.
1963
Junio C Hamano1de75722009-03-26 08:39:381964push.default::
Junio C Hamano58655592013-07-11 20:52:331965Defines the action `git push` should take if no refspec is
1966explicitly given. Different values are well-suited for
1967specific workflows; for instance, in a purely central workflow
1968(i.e. the fetch source is equal to the push destination),
1969`upstream` is probably what you want. Possible values are:
Junio C Hamano1de75722009-03-26 08:39:381970+
Junio C Hamanobcaa8bc2012-07-03 22:17:201971--
Junio C Hamano58655592013-07-11 20:52:331972
1973* `nothing` - do not push anything (error out) unless a refspec is
1974 explicitly given. This is primarily meant for people who want to
1975 avoid mistakes by always being explicit.
1976
1977* `current` - push the current branch to update a branch with the same
1978 name on the receiving end. Works in both central and non-central
1979 workflows.
1980
1981* `upstream` - push the current branch back to the branch whose
1982 changes are usually integrated into the current branch (which is
1983 called `@{upstream}`). This mode only makes sense if you are
1984 pushing to the same repository you would normally pull from
1985 (i.e. central workflow).
1986
1987* `simple` - in centralized workflow, work like `upstream` with an
1988 added safety to refuse to push if the upstream branch's name is
1989 different from the local one.
Junio C Hamanobcaa8bc2012-07-03 22:17:201990+
Junio C Hamano58655592013-07-11 20:52:331991When pushing to a remote that is different from the remote you normally
1992pull from, work as `current`. This is the safest option and is suited
1993for beginners.
1994+
Junio C Hamano1d669b82014-03-11 21:36:001995This mode has become the default in Git 2.0.
Junio C Hamano58655592013-07-11 20:52:331996
1997* `matching` - push all branches having the same name on both ends.
1998 This makes the repository you are pushing to remember the set of
1999 branches that will be pushed out (e.g. if you always push 'maint'
2000 and 'master' there and no other branches, the repository you push
2001 to will have these two branches, and your local 'maint' and
2002 'master' will be pushed there).
2003+
2004To use this mode effectively, you have to make sure _all_ the
2005branches you would push out are ready to be pushed out before
2006running 'git push', as the whole point of this mode is to allow you
2007to push all of the branches in one go. If you usually finish work
2008on only one branch and push out the result, while other branches are
2009unfinished, this mode is not for you. Also this mode is not
2010suitable for pushing into a shared central repository, as other
2011people may add new branches there, or update the tip of existing
2012branches outside your control.
2013+
Junio C Hamano1d669b82014-03-11 21:36:002014This used to be the default, but not since Git 2.0 (`simple` is the
2015new default).
Junio C Hamano58655592013-07-11 20:52:332016
2017--
Junio C Hamano1de75722009-03-26 08:39:382018
Junio C Hamanoea6a7642009-03-11 23:56:192019rebase.stat::
2020Whether to show a diffstat of what changed upstream since the last
2021rebase. False by default.
2022
Junio C Hamano075ae872010-09-01 18:43:072023rebase.autosquash::
2024If set to true enable '--autosquash' option by default.
2025
Junio C Hamanof1f5a7b2013-06-11 22:23:522026rebase.autostash::
2027When set to true, automatically create a temporary stash
2028before the operation begins, and apply it after the operation
2029ends. This means that you can run rebase on a dirty worktree.
2030However, use with care: the final stash application after a
2031successful rebase might result in non-trivial conflicts.
2032Defaults to false.
2033
Junio C Hamano621e1232009-10-26 05:16:472034receive.autogc::
2035By default, git-receive-pack will run "git-gc --auto" after
2036receiving data from git-push and updating refs. You can stop
2037it by setting this variable to false.
2038
Junio C Hamano4653c6f2008-11-26 22:50:202039receive.fsckObjects::
2040If it is set to true, git-receive-pack will check all received
2041objects. It will abort in the case of a malformed object or a
2042broken link. The result of an abort are only dangling objects.
Junio C Hamano8fb66e52011-10-05 20:59:512043Defaults to false. If not set, the value of `transfer.fsckObjects`
2044is used instead.
Junio C Hamano4653c6f2008-11-26 22:50:202045
2046receive.unpackLimit::
2047If the number of objects received in a push is below this
2048limit then the objects will be unpacked into loose object
2049files. However if the number of received objects equals or
2050exceeds this limit then the received pack will be stored as
2051a pack, after adding any missing delta bases. Storing the
2052pack from a push can make the push operation complete faster,
2053especially on slow filesystems. If not set, the value of
2054`transfer.unpackLimit` is used instead.
2055
2056receive.denyDeletes::
2057If set to true, git-receive-pack will deny a ref update that deletes
2058the ref. Use this to prevent such a ref deletion via a push.
2059
Junio C Hamanob4448a82010-07-26 09:02:322060receive.denyDeleteCurrent::
2061If set to true, git-receive-pack will deny a ref update that
2062deletes the currently checked out branch of a non-bare repository.
2063
Junio C Hamano4653c6f2008-11-26 22:50:202064receive.denyCurrentBranch::
Junio C Hamanoe97d5772010-05-19 08:13:582065If set to true or "refuse", git-receive-pack will deny a ref update
Junio C Hamano4653c6f2008-11-26 22:50:202066to the currently checked out branch of a non-bare repository.
2067Such a push is potentially dangerous because it brings the HEAD
2068out of sync with the index and working tree. If set to "warn",
2069print a warning of such a push to stderr, but allow the push to
2070proceed. If set to false or "ignore", allow such pushes with no
Junio C Hamanoafb395b2010-03-17 22:16:152071message. Defaults to "refuse".
Junio C Hamano4653c6f2008-11-26 22:50:202072
2073receive.denyNonFastForwards::
2074If set to true, git-receive-pack will deny a ref update which is
Junio C Hamano3f680f32009-11-16 02:10:542075not a fast-forward. Use this to prevent such an update via a push,
Junio C Hamano4653c6f2008-11-26 22:50:202076even if that push is forced. This configuration variable is
2077set when initializing a shared repository.
2078
Junio C Hamano80ad00d2013-02-18 00:19:032079receive.hiderefs::
2080String(s) `receive-pack` uses to decide which refs to omit
2081from its initial advertisement. Use more than one
2082definitions to specify multiple prefix strings. A ref that
2083are under the hierarchies listed on the value of this
2084variable is excluded, and is hidden when responding to `git
2085push`, and an attempt to update or delete a hidden ref by
2086`git push` is rejected.
2087
Junio C Hamano621e1232009-10-26 05:16:472088receive.updateserverinfo::
2089If set to true, git-receive-pack will run git-update-server-info
2090after receiving data from git-push and updating refs.
2091
Junio C Hamano61525f92014-01-17 22:46:492092receive.shallowupdate::
2093If set to true, .git/shallow can be updated when new refs
2094require new shallow roots. Otherwise those refs are rejected.
2095
Junio C Hamano63b6fdb2013-04-07 23:37:132096remote.pushdefault::
2097The remote to push to by default. Overrides
2098`branch.<name>.remote` for all branches, and is overridden by
2099`branch.<name>.pushremote` for specific branches.
2100
Junio C Hamano249572f2006-10-24 05:44:082101remote.<name>.url::
Junio C Hamano35738e82008-01-07 07:55:462102The URL of a remote repository. See linkgit:git-fetch[1] or
2103linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:082104
Junio C Hamano0e88f3e2009-06-21 08:03:252105remote.<name>.pushurl::
2106The push URL of a remote repository. See linkgit:git-push[1].
2107
Junio C Hamano58256872007-12-04 08:31:132108remote.<name>.proxy::
2109For remotes that require curl (http, https and ftp), the URL to
2110the proxy to use for that remote. Set to the empty string to
2111disable proxying for that remote.
2112
Junio C Hamano249572f2006-10-24 05:44:082113remote.<name>.fetch::
Junio C Hamano35738e82008-01-07 07:55:462114The default set of "refspec" for linkgit:git-fetch[1]. See
2115linkgit:git-fetch[1].
Junio C Hamano249572f2006-10-24 05:44:082116
2117remote.<name>.push::
Junio C Hamano35738e82008-01-07 07:55:462118The default set of "refspec" for linkgit:git-push[1]. See
2119linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:082120
Junio C Hamano47d68a52008-05-06 06:35:402121remote.<name>.mirror::
2122If true, pushing to this remote will automatically behave
Junio C Hamanob76a6862012-05-02 22:02:462123as if the `--mirror` option was given on the command line.
Junio C Hamano47d68a52008-05-06 06:35:402124
Junio C Hamano118d2772007-02-21 20:24:102125remote.<name>.skipDefaultUpdate::
2126If true, this remote will be skipped by default when updating
Junio C Hamano9df0c662009-11-23 11:09:272127using linkgit:git-fetch[1] or the `update` subcommand of
2128linkgit:git-remote[1].
2129
2130remote.<name>.skipFetchAll::
2131If true, this remote will be skipped by default when updating
2132using linkgit:git-fetch[1] or the `update` subcommand of
2133linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:102134
Junio C Hamano4ad294b2007-01-20 02:22:502135remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:482136The default program to execute on the remote side when pushing. See
Junio C Hamano86bcccc2008-03-08 09:33:552137option \--receive-pack of linkgit:git-push[1].
Junio C Hamano4ad294b2007-01-20 02:22:502138
Junio C Hamano54ea8d32007-01-25 07:59:482139remote.<name>.uploadpack::
2140The default program to execute on the remote side when fetching. See
Junio C Hamano86bcccc2008-03-08 09:33:552141option \--upload-pack of linkgit:git-fetch-pack[1].
Junio C Hamano54ea8d32007-01-25 07:59:482142
Junio C Hamano17dde0e2007-02-26 09:50:212143remote.<name>.tagopt::
Junio C Hamano86bcccc2008-03-08 09:33:552144Setting this value to \--no-tags disables automatic tag following when
Junio C Hamanocc7636a2010-05-21 14:57:532145fetching from remote <name>. Setting it to \--tags will fetch every
2146tag from remote <name>, even if they are not reachable from remote
Junio C Hamano075ae872010-09-01 18:43:072147branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2148override this setting. See options \--tags and \--no-tags of
2149linkgit:git-fetch[1].
Junio C Hamano17dde0e2007-02-26 09:50:212150
Junio C Hamano096dde22009-12-26 23:14:112151remote.<name>.vcs::
Junio C Hamano076ffcc2013-02-06 05:13:212152Setting this to a value <vcs> will cause Git to interact with
Junio C Hamano096dde22009-12-26 23:14:112153the remote with the git-remote-<vcs> helper.
2154
Junio C Hamano8eac2682013-09-09 22:35:202155remote.<name>.prune::
2156When set to true, fetching from this remote by default will also
Junio C Hamano4c8f2d92013-12-13 00:55:422157remove any remote-tracking references that no longer exist on the
2158remote (as if the `--prune` option was given on the command line).
Junio C Hamano8eac2682013-09-09 22:35:202159Overrides `fetch.prune` settings, if any.
2160
Junio C Hamano118d2772007-02-21 20:24:102161remotes.<group>::
2162The list of remotes which are fetched by "git remote update
Junio C Hamano35738e82008-01-07 07:55:462163<group>". See linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:102164
Junio C Hamano77b7e902006-10-23 07:18:502165repack.usedeltabaseoffset::
Junio C Hamanofce7c7e2008-07-02 03:06:382166By default, linkgit:git-repack[1] creates packs that use
2167delta-base offset. If you need to share your repository with
Junio C Hamano076ffcc2013-02-06 05:13:212168Git older than version 1.4.4, either directly or via a dumb
Junio C Hamanofce7c7e2008-07-02 03:06:382169protocol such as http, then you need to set this option to
Junio C Hamano076ffcc2013-02-06 05:13:212170"false" and repack. Access from old Git versions over the
Junio C Hamanofce7c7e2008-07-02 03:06:382171native protocol are unaffected by this option.
Junio C Hamano77b7e902006-10-23 07:18:502172
Junio C Hamano3b0cdc22014-03-18 22:06:162173repack.packKeptObjects::
2174If set to true, makes `git repack` act as if
2175`--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2176details. Defaults to `false` normally, but `true` if a bitmap
2177index is being written (either via `--write-bitmap-index` or
2178`pack.writeBitmaps`).
2179
Junio C Hamano4653c6f2008-11-26 22:50:202180rerere.autoupdate::
2181When set to true, `git-rerere` updates the index with the
2182resulting contents after it cleanly resolves conflicts using
2183previously recorded resolution. Defaults to false.
2184
2185rerere.enabled::
2186Activate recording of resolved conflicts, so that identical
Junio C Hamano4fd24422012-01-06 21:52:432187conflict hunks can be resolved automatically, should they be
2188encountered again. By default, linkgit:git-rerere[1] is
2189enabled if there is an `rr-cache` directory under the
Junio C Hamano864ba892012-01-13 17:42:052190`$GIT_DIR`, e.g. if "rerere" was previously used in the
2191repository.
Junio C Hamano4653c6f2008-11-26 22:50:202192
Junio C Hamano1bbd0f42009-07-23 06:20:292193sendemail.identity::
2194A configuration identity. When given, causes values in the
2195'sendemail.<identity>' subsection to take precedence over
2196values in the 'sendemail' section. The default identity is
2197the value of 'sendemail.identity'.
2198
2199sendemail.smtpencryption::
2200See linkgit:git-send-email[1] for description. Note that this
2201setting is not subject to the 'identity' mechanism.
2202
2203sendemail.smtpssl::
2204Deprecated alias for 'sendemail.smtpencryption = ssl'.
2205
Junio C Hamano58f587a2013-07-22 19:20:592206sendemail.smtpsslcertpath::
2207Path to ca-certificates (either a directory or a single file).
2208Set it to an empty string to disable certificate verification.
2209
Junio C Hamano1bbd0f42009-07-23 06:20:292210sendemail.<identity>.*::
2211Identity-specific versions of the 'sendemail.*' parameters
2212found below, taking precedence over those when the this
2213identity is selected, through command-line or
2214'sendemail.identity'.
2215
2216sendemail.aliasesfile::
2217sendemail.aliasfiletype::
Junio C Hamanoea3b7522013-04-18 19:37:532218sendemail.annotate::
Junio C Hamano1bbd0f42009-07-23 06:20:292219sendemail.bcc::
2220sendemail.cc::
2221sendemail.cccmd::
2222sendemail.chainreplyto::
2223sendemail.confirm::
2224sendemail.envelopesender::
2225sendemail.from::
2226sendemail.multiedit::
2227sendemail.signedoffbycc::
2228sendemail.smtppass::
2229sendemail.suppresscc::
2230sendemail.suppressfrom::
2231sendemail.to::
Junio C Hamanocb39aea2010-05-09 07:24:482232sendemail.smtpdomain::
Junio C Hamano1bbd0f42009-07-23 06:20:292233sendemail.smtpserver::
2234sendemail.smtpserverport::
Junio C Hamano39c7a692010-10-27 06:08:542235sendemail.smtpserveroption::
Junio C Hamano1bbd0f42009-07-23 06:20:292236sendemail.smtpuser::
2237sendemail.thread::
2238sendemail.validate::
2239See linkgit:git-send-email[1] for description.
2240
2241sendemail.signedoffcc::
2242Deprecated alias for 'sendemail.signedoffbycc'.
2243
Junio C Hamano07824ce2006-04-25 07:36:542244showbranch.default::
Junio C Hamano35738e82008-01-07 07:55:462245The default set of branches for linkgit:git-show-branch[1].
2246See linkgit:git-show-branch[1].
Junio C Hamano07824ce2006-04-25 07:36:542247
Junio C Hamano942b35e2007-12-09 10:19:332248status.relativePaths::
Junio C Hamano35738e82008-01-07 07:55:462249By default, linkgit:git-status[1] shows paths relative to the
Junio C Hamano942b35e2007-12-09 10:19:332250current directory. Setting this variable to `false` shows paths
Junio C Hamano076ffcc2013-02-06 05:13:212251relative to the repository root (this was the default for Git
Junio C Hamano942b35e2007-12-09 10:19:332252prior to v1.5.4).
2253
Junio C Hamano58655592013-07-11 20:52:332254status.short::
2255Set to true to enable --short by default in linkgit:git-status[1].
2256The option --no-short takes precedence over this variable.
2257
2258status.branch::
2259Set to true to enable --branch by default in linkgit:git-status[1].
2260The option --no-branch takes precedence over this variable.
2261
Junio C Hamano79f4c7c2013-09-20 21:03:372262status.displayCommentPrefix::
2263If set to true, linkgit:git-status[1] will insert a comment
2264prefix before each output line (starting with
2265`core.commentChar`, i.e. `#` by default). This was the
2266behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2267Defaults to false.
2268
Junio C Hamano4224f992008-06-23 07:14:082269status.showUntrackedFiles::
2270By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2271files which are not currently tracked by Git. Directories which
2272contain only untracked files, are shown with the directory name
2273only. Showing untracked files means that Git needs to lstat() all
2274all the files in the whole repository, which might be slow on some
2275systems. So, this variable controls how the commands displays
2276the untracked files. Possible values are:
2277+
2278--
Junio C Hamano7f9fa862010-10-19 23:51:142279* `no` - Show no untracked files.
2280* `normal` - Show untracked files and directories.
2281* `all` - Show also individual files in untracked directories.
Junio C Hamano4224f992008-06-23 07:14:082282--
2283+
2284If this variable is not specified, it defaults to 'normal'.
2285This variable can be overridden with the -u|--untracked-files option
2286of linkgit:git-status[1] and linkgit:git-commit[1].
2287
Junio C Hamanob671fb52010-06-01 05:06:142288status.submodulesummary::
2289Defaults to false.
2290If this is set to a non zero number or true (identical to -1 or an
2291unlimited number), the submodule summary will be enabled and a
2292summary of commits for modified submodules will be shown (see
Junio C Hamano369e3402013-10-15 18:40:252293--summary-limit option of linkgit:git-submodule[1]). Please note
2294that the summary output command will be suppressed for all
2295submodules when `diff.ignoreSubmodules` is set to 'all' or only
2296for those submodules where `submodule.<name>.ignore=all`. To
2297also view the summary for ignored submodules you can either use
2298the --ignore-submodules=dirty command line option or the 'git
2299submodule summary' command, which shows a similar output but does
2300not honor these settings.
Junio C Hamanob671fb52010-06-01 05:06:142301
Junio C Hamano78e3a782010-07-15 22:24:452302submodule.<name>.path::
2303submodule.<name>.url::
2304submodule.<name>.update::
2305The path within this project, URL, and the updating strategy
2306for a submodule. These variables are initially populated
2307by 'git submodule init'; edit them to override the
2308URL and other values found in the `.gitmodules` file. See
2309linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2310
Junio C Hamanoabad6da2013-01-06 09:06:322311submodule.<name>.branch::
2312The remote branch name for a submodule, used by `git submodule
2313update --remote`. Set this option to override the value found in
2314the `.gitmodules` file. See linkgit:git-submodule[1] and
2315linkgit:gitmodules[5] for details.
2316
Junio C Hamano0d75e872010-12-17 06:57:262317submodule.<name>.fetchRecurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:102318This option can be used to control recursive fetching of this
Junio C Hamano7165bf72011-01-04 22:06:182319submodule. It can be overridden by using the --[no-]recurse-submodules
Junio C Hamano0d75e872010-12-17 06:57:262320command line option to "git fetch" and "git pull".
2321This setting will override that from in the linkgit:gitmodules[5]
2322file.
2323
Junio C Hamano619596a2010-08-18 22:15:352324submodule.<name>.ignore::
2325Defines under what circumstances "git status" and the diff family show
2326a submodule as modified. When set to "all", it will never be considered
2327modified, "dirty" will ignore all changes to the submodules work tree and
2328takes only differences between the HEAD of the submodule and the commit
2329recorded in the superproject into account. "untracked" will additionally
2330let submodules with modified tracked files in their work tree show up.
2331Using "none" (the default when this option is not set) also shows
2332submodules that have untracked files in their work tree as changed.
2333This setting overrides any setting made in .gitmodules for this submodule,
Junio C Hamanode9745c2010-08-23 17:10:182334both settings can be overridden on the command line by using the
Junio C Hamano369e3402013-10-15 18:40:252335"--ignore-submodules" option. The 'git submodule' commands are not
2336affected by this setting.
Junio C Hamano619596a2010-08-18 22:15:352337
Junio C Hamano75cc4c92006-07-24 08:25:032338tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:092339This variable can be used to restrict the permission bits of
2340tar archive entries. The default is 0002, which turns off the
2341world write bit. The special value "user" indicates that the
2342archiving user's umask will be used instead. See umask(2) and
Junio C Hamano35738e82008-01-07 07:55:462343linkgit:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:032344
Junio C Hamano8fb66e52011-10-05 20:59:512345transfer.fsckObjects::
2346When `fetch.fsckObjects` or `receive.fsckObjects` are
2347not set, the value of this variable is used instead.
2348Defaults to false.
2349
Junio C Hamano80ad00d2013-02-18 00:19:032350transfer.hiderefs::
2351This variable can be used to set both `receive.hiderefs`
2352and `uploadpack.hiderefs` at the same time to the same
2353values. See entries for these other variables.
2354
Junio C Hamano4653c6f2008-11-26 22:50:202355transfer.unpackLimit::
2356When `fetch.unpackLimit` or `receive.unpackLimit` are
2357not set, the value of this variable is used instead.
2358The default value is 100.
2359
Junio C Hamano81703b22014-03-14 22:00:272360uploadarchive.allowUnreachable::
2361If true, allow clients to use `git archive --remote` to request
2362any tree, whether reachable from the ref tips or not. See the
2363discussion in the `SECURITY` section of
2364linkgit:git-upload-archive[1] for more details. Defaults to
2365`false`.
2366
Junio C Hamano80ad00d2013-02-18 00:19:032367uploadpack.hiderefs::
2368String(s) `upload-pack` uses to decide which refs to omit
2369from its initial advertisement. Use more than one
2370definitions to specify multiple prefix strings. A ref that
2371are under the hierarchies listed on the value of this
2372variable is excluded, and is hidden from `git ls-remote`,
2373`git fetch`, etc. An attempt to fetch a hidden ref by `git
Junio C Hamano5e7f1312013-03-21 22:49:012374fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2375
2376uploadpack.allowtipsha1inwant::
2377When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2378to accept a fetch request that asks for an object at the tip
2379of a hidden ref (by default, such a request is rejected).
2380see also `uploadpack.hiderefs`.
Junio C Hamano80ad00d2013-02-18 00:19:032381
Junio C Hamano79f4c7c2013-09-20 21:03:372382uploadpack.keepalive::
2383When `upload-pack` has started `pack-objects`, there may be a
2384quiet period while `pack-objects` prepares the pack. Normally
2385it would output progress information, but if `--quiet` was used
2386for the fetch, `pack-objects` will output nothing at all until
2387the pack data begins. Some clients and networks may consider
2388the server to be hung and give up. Setting this option instructs
2389`upload-pack` to send an empty keepalive packet every
2390`uploadpack.keepalive` seconds. Setting this option to 0
2391disables keepalive packets entirely. The default is 5 seconds.
2392
Junio C Hamano24bc09a2008-02-28 00:27:442393url.<base>.insteadOf::
2394Any URL that starts with this value will be rewritten to
2395start, instead, with <base>. In cases where some site serves a
2396large number of repositories, and serves them with multiple
2397access methods, and some users need to use different access
2398methods, this feature allows people to specify any of the
Junio C Hamano076ffcc2013-02-06 05:13:212399equivalent URLs and have Git automatically rewrite the URL to
Junio C Hamano24bc09a2008-02-28 00:27:442400the best alternative for the particular user, even for a
2401never-before-seen repository on the site. When more than one
2402insteadOf strings match a given URL, the longest match is used.
2403
Junio C Hamano7df6dcf2009-09-13 09:51:172404url.<base>.pushInsteadOf::
2405Any URL that starts with this value will not be pushed to;
2406instead, it will be rewritten to start with <base>, and the
2407resulting URL will be pushed to. In cases where some site serves
2408a large number of repositories, and serves them with multiple
2409access methods, some of which do not allow push, this feature
Junio C Hamano076ffcc2013-02-06 05:13:212410allows people to specify a pull-only URL and have Git
Junio C Hamano7df6dcf2009-09-13 09:51:172411automatically use an appropriate URL to push, even for a
2412never-before-seen repository on the site. When more than one
2413pushInsteadOf strings match a given URL, the longest match is
Junio C Hamano076ffcc2013-02-06 05:13:212414used. If a remote has an explicit pushurl, Git will ignore this
Junio C Hamano7df6dcf2009-09-13 09:51:172415setting for that remote.
2416
Junio C Hamano07824ce2006-04-25 07:36:542417user.email::
2418Your email address to be recorded in any newly created commits.
Junio C Hamano469d60e2007-04-29 18:30:342419Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Junio C Hamano35738e82008-01-07 07:55:462420'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:542421
2422user.name::
2423Your full name to be recorded in any newly created commits.
Junio C Hamano341071d2006-06-04 07:24:482424Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Junio C Hamano35738e82008-01-07 07:55:462425environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:542426
Junio C Hamanoa890c4f2007-01-28 10:29:212427user.signingkey::
Junio C Hamano369e3402013-10-15 18:40:252428If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2429key you want it to automatically when creating a signed tag or
2430commit, you can override the default selection with this variable.
2431This option is passed unchanged to gpg's --local-user parameter,
2432so you may specify a key using any method that gpg supports.
Junio C Hamanoa890c4f2007-01-28 10:29:212433
Junio C Hamano4e272312008-01-08 09:13:212434web.browser::
2435Specify a web browser that may be used by some commands.
2436Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2437may use it.