blob: 16dc22d9cf9e89a8c0914f72e7699bba05a59b99 [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
Junio C Hamano07622622015-03-20 21:47:2617variables may appear multiple times; we say then that the variable is
18multivalued.
Junio C Hamano07824ce2006-04-25 07:36:5419
Junio C Hamanobee172f2007-01-23 08:44:1820Syntax
21~~~~~~
22
Junio C Hamano07824ce2006-04-25 07:36:5423The syntax is fairly flexible and permissive; whitespaces are mostly
Junio C Hamanobee172f2007-01-23 08:44:1824ignored. The '#' and ';' characters begin comments to the end of line,
25blank lines are ignored.
26
27The file consists of sections and variables. A section begins with
28the name of the section in square brackets and continues until the next
Junio C Hamano07622622015-03-20 21:47:2629section begins. Section names are case-insensitive. Only alphanumeric
Junio C Hamanoea82cff2009-03-18 01:54:4830characters, `-` and `.` are allowed in section names. Each variable
Junio C Hamanof4581102009-04-25 08:29:5931must belong to some section, which means that there must be a section
32header before the first setting of a variable.
Junio C Hamanobee172f2007-01-23 08:44:1833
34Sections can be further divided into subsections. To begin a subsection
35put its name in double quotes, separated by space from the section name,
Junio C Hamanof4581102009-04-25 08:29:5936in the section header, like in the example below:
Junio C Hamanobee172f2007-01-23 08:44:1837
38--------
39[section "subsection"]
40
41--------
42
Junio C Hamanof4581102009-04-25 08:29:5943Subsection names are case sensitive and can contain any characters except
Junio C Hamano07622622015-03-20 21:47:2644newline (doublequote `"` and backslash can be included by escaping them
45as `\"` and `\\`, respectively). Section headers cannot span multiple
Junio C Hamanobee172f2007-01-23 08:44:1846lines. Variables may belong directly to a section or to a given subsection.
47You can have `[section]` if you have `[section "subsection"]`, but you
48don't need to.
49
Junio C Hamano6231f822011-10-24 05:18:5250There is also a deprecated `[section.subsection]` syntax. With this
51syntax, the subsection name is converted to lower-case and is also
52compared case sensitively. These subsection names follow the same
53restrictions as section names.
Junio C Hamanobee172f2007-01-23 08:44:1854
Junio C Hamanoaa2cd762009-07-26 08:14:0155All the other lines (and the remainder of the line after the section
56header) are recognized as setting variables, in the form
Junio C Hamano07622622015-03-20 21:47:2657'name = value' (or just 'name', which is a short-hand to say that
58the variable is the boolean "true").
Junio C Hamano81d540a2012-03-02 19:52:4759The variable names are case-insensitive, allow only alphanumeric characters
Junio C Hamano07622622015-03-20 21:47:2660and `-`, and must start with an alphabetic character.
Junio C Hamanobee172f2007-01-23 08:44:1861
Junio C Hamano07622622015-03-20 21:47:2662A line that defines a value can be continued to the next line by
63ending it with a `\`; the backquote and the end-of-line are
64stripped. Leading whitespaces after 'name =', the remainder of the
65line after the first comment character '#' or ';', and trailing
66whitespaces of the line are discarded unless they are enclosed in
67double quotes. Internal whitespaces within the value are retained
68verbatim.
Junio C Hamanobee172f2007-01-23 08:44:1869
Junio C Hamano07622622015-03-20 21:47:2670Inside double quotes, double quote `"` and backslash `\` characters
71must be escaped: use `\"` for `"` and `\\` for `\`.
Junio C Hamanobee172f2007-01-23 08:44:1872
Junio C Hamanoea82cff2009-03-18 01:54:4873The following escape sequences (beside `\"` and `\\`) are recognized:
74`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
Junio C Hamanod75148a2014-04-08 19:48:3875and `\b` for backspace (BS). Other char escape sequences (including octal
76escape sequences) are invalid.
Junio C Hamanobee172f2007-01-23 08:44:1877
Junio C Hamano07824ce2006-04-25 07:36:5478
Junio C Hamanoe0238c22012-02-23 22:45:5079Includes
80~~~~~~~~
81
82You can include one config file from another by setting the special
83`include.path` variable to the name of the file to be included. The
Junio C Hamano198b1f12016-05-17 22:27:2484variable takes a pathname as its value, and is subject to tilde
85expansion.
86
87The
Junio C Hamanoe0238c22012-02-23 22:45:5088included file is expanded immediately, as if its contents had been
89found at the location of the include directive. If the value of the
90`include.path` variable is a relative path, the path is considered to be
91relative to the configuration file in which the include directive was
Junio C Hamano198b1f12016-05-17 22:27:2492found. See below for examples.
93
Junio C Hamanoe0238c22012-02-23 22:45:5094
Junio C Hamano07824ce2006-04-25 07:36:5495Example
96~~~~~~~
97
98# Core variables
99[core]
100; Don't trust file modes
101filemode = false
102
103# Our diff algorithm
104[diff]
Junio C Hamano85c71572008-07-28 00:03:31105external = /usr/local/bin/diff-wrapper
Junio C Hamano07824ce2006-04-25 07:36:54106renames = true
107
Junio C Hamano52401ef2006-12-19 00:54:38108[branch "devel"]
109remote = origin
110merge = refs/heads/devel
111
Junio C Hamanobee172f2007-01-23 08:44:18112# Proxy settings
113[core]
Junio C Hamanoc71a8732007-08-04 00:27:26114gitProxy="ssh" for "kernel.org"
Junio C Hamanobee172f2007-01-23 08:44:18115gitProxy=default-proxy ; for the rest
Junio C Hamano52401ef2006-12-19 00:54:38116
Junio C Hamanoe0238c22012-02-23 22:45:50117[include]
118path = /path/to/foo.inc ; include by absolute path
119path = foo ; expand "foo" relative to the current file
Junio C Hamano198b1f12016-05-17 22:27:24120path = ~/foo ; expand "foo" in your `$HOME` directory
Junio C Hamanoe0238c22012-02-23 22:45:50121
Junio C Hamano07622622015-03-20 21:47:26122
123Values
124~~~~~~
125
126Values of many variables are treated as a simple string, but there
127are variables that take values of specific types and there are rules
128as to how to spell them.
129
130boolean::
131
132 When a variable is said to take a boolean value, many
133 synonyms are accepted for 'true' and 'false'; these are all
134 case-insensitive.
135
136 true;; Boolean true can be spelled as `yes`, `on`, `true`,
137or `1`. Also, a variable defined without `= <value>`
138is taken as true.
139
140 false;; Boolean false can be spelled as `no`, `off`,
141`false`, or `0`.
142+
Junio C Hamano92d80372016-07-13 22:00:05143When converting value to the canonical form using `--bool` type
Junio C Hamano07622622015-03-20 21:47:26144specifier; 'git config' will ensure that the output is "true" or
145"false" (spelled in lowercase).
146
147integer::
148 The value for many variables that specify various sizes can
149 be suffixed with `k`, `M`,... to mean "scale the number by
150 1024", "by 1024x1024", etc.
151
152color::
Junio C Hamano48931e22016-07-11 20:08:47153 The value for a variable that takes a color is a list of
154 colors (at most two, one for foreground and one for background)
155 and attributes (as many as you want), separated by spaces.
Junio C Hamano07622622015-03-20 21:47:26156+
Junio C Hamano48931e22016-07-11 20:08:47157The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
158`blue`, `magenta`, `cyan` and `white`. The first color given is the
159foreground; the second is the background.
Junio C Hamano07622622015-03-20 21:47:26160+
Junio C Hamano48931e22016-07-11 20:08:47161Colors may also be given as numbers between 0 and 255; these use ANSI
162256-color mode (but note that not all terminals may support this). If
163your terminal supports it, you may also specify 24-bit RGB values as
164hex, like `#ff0ab3`.
165+
166The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
167`italic`, and `strike` (for crossed-out or "strikethrough" letters).
168The position of any attributes with respect to the colors
169(before, after, or in between), doesn't matter. Specific attributes may
170be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
171`no-ul`, etc).
172+
173For git's pre-defined color slots, the attributes are meant to be reset
174at the beginning of each item in the colored output. So setting
175`color.decorate.branch` to `black` will paint that branch name in a
176plain `black`, even if the previous thing on the same output line (e.g.
177opening parenthesis before the list of branch names in `log --decorate`
178output) is set to be painted with `bold` or some other attribute.
179However, custom log formats may do more complicated and layered
180coloring, and the negated forms may be useful there.
Junio C Hamano07622622015-03-20 21:47:26181
Junio C Hamano198b1f12016-05-17 22:27:24182pathname::
183A variable that takes a pathname value can be given a
184string that begins with "`~/`" or "`~user/`", and the usual
185tilde expansion happens to such a string: `~/`
186is expanded to the value of `$HOME`, and `~user/` to the
187specified user's home directory.
188
Junio C Hamano07622622015-03-20 21:47:26189
Junio C Hamano07824ce2006-04-25 07:36:54190Variables
191~~~~~~~~~
192
193Note that this list is non-comprehensive and not necessarily complete.
Junio C Hamanof1d14802006-06-08 00:48:17194For command-specific variables, you will find a more detailed description
Junio C Hamano52b6ba32014-04-01 00:26:48195in the appropriate manual page.
196
197Other git-related tools may and do use their own variables. When
198inventing new variables for use in your own tool, make sure their
199names do not conflict with those that are used by Git itself and
200other popular tools, and describe them in your documentation.
201
Junio C Hamano07824ce2006-04-25 07:36:54202
Junio C Hamano7df6dcf2009-09-13 09:51:17203advice.*::
Junio C Hamano0df92712011-12-21 22:30:44204These variables control various optional help messages designed to
205aid new users. All 'advice.*' variables default to 'true', and you
206can tell Git that you do not need help by setting these to 'false':
Junio C Hamano7df6dcf2009-09-13 09:51:17207+
208--
Junio C Hamanoabad6da2013-01-06 09:06:32209pushUpdateRejected::
Junio C Hamano0c1b64e2012-04-20 23:50:49210Set this variable to 'false' if you want to disable
Junio C Hamano1d669b82014-03-11 21:36:00211'pushNonFFCurrent',
Junio C Hamano3f2ed6f2013-02-04 19:24:09212'pushNonFFMatching', 'pushAlreadyExists',
213'pushFetchFirst', and 'pushNeedsForce'
Junio C Hamanoabad6da2013-01-06 09:06:32214simultaneously.
Junio C Hamano0c1b64e2012-04-20 23:50:49215pushNonFFCurrent::
216Advice shown when linkgit:git-push[1] fails due to a
217non-fast-forward update to the current branch.
Junio C Hamano0c1b64e2012-04-20 23:50:49218pushNonFFMatching::
219Advice shown when you ran linkgit:git-push[1] and pushed
220'matching refs' explicitly (i.e. you used ':', or
221specified a refspec that isn't your current branch) and
222it resulted in a non-fast-forward error.
Junio C Hamanoabad6da2013-01-06 09:06:32223pushAlreadyExists::
224Shown when linkgit:git-push[1] rejects an update that
225does not qualify for fast-forwarding (e.g., a tag.)
Junio C Hamano3f2ed6f2013-02-04 19:24:09226pushFetchFirst::
227Shown when linkgit:git-push[1] rejects an update that
228tries to overwrite a remote ref that points at an
229object we do not have.
230pushNeedsForce::
231Shown when linkgit:git-push[1] rejects an update that
232tries to overwrite a remote ref that points at an
Junio C Hamanoe6f28d02013-09-17 21:34:00233object that is not a commit-ish, or make the remote
234ref point at an object that is not a commit-ish.
Junio C Hamano7df6dcf2009-09-13 09:51:17235statusHints::
Junio C Hamano644936c2012-06-28 23:05:14236Show directions on how to proceed from the current
Junio C Hamano917cd4f2012-12-04 23:41:10237state in the output of linkgit:git-status[1], in
Junio C Hamano644936c2012-06-28 23:05:14238the template shown when writing commit messages in
Junio C Hamano917cd4f2012-12-04 23:41:10239linkgit:git-commit[1], and in the help message shown
240by linkgit:git-checkout[1] when switching branch.
Junio C Hamano5e7f1312013-03-21 22:49:01241statusUoption::
242Advise to consider using the `-u` option to linkgit:git-status[1]
243when the command takes more than 2 seconds to enumerate untracked
244files.
Junio C Hamano5706e0b2009-11-24 10:54:16245commitBeforeMerge::
246Advice shown when linkgit:git-merge[1] refuses to
Junio C Hamano619596a2010-08-18 22:15:35247merge to avoid overwriting local changes.
Junio C Hamanoa9701f02010-01-21 00:42:16248resolveConflict::
Junio C Hamano5dab5a92013-02-25 18:51:24249Advice shown by various commands when conflicts
Junio C Hamanoa9701f02010-01-21 00:42:16250prevent the operation from being performed.
Junio C Hamanoa9701f02010-01-21 00:42:16251implicitIdentity::
252Advice on how to set your identity configuration when
253your information is guessed from the system username and
Junio C Hamano0df92712011-12-21 22:30:44254domain name.
Junio C Hamano74a198f2010-02-22 00:13:31255detachedHead::
Junio C Hamano0df92712011-12-21 22:30:44256Advice shown when you used linkgit:git-checkout[1] to
Junio C Hamano74a198f2010-02-22 00:13:31257move to the detach HEAD state, to instruct how to create
Junio C Hamano0df92712011-12-21 22:30:44258a local branch after the fact.
Junio C Hamanobb300642012-07-22 21:09:14259amWorkDir::
260Advice that shows the location of the patch file when
261linkgit:git-am[1] fails to apply it.
Junio C Hamano8ab94942013-06-24 21:55:30262rmHints::
263In case of failure in the output of linkgit:git-rm[1],
264show directions on how to proceed from the current state.
Junio C Hamano7df6dcf2009-09-13 09:51:17265--
266
Junio C Hamano07824ce2006-04-25 07:36:54267core.fileMode::
Junio C Hamanod2c28482014-10-24 22:28:25268Tells Git if the executable bit of files in the working tree
269is to be honored.
Junio C Hamano9df0c662009-11-23 11:09:27270+
Junio C Hamanod2c28482014-10-24 22:28:25271Some filesystems lose the executable bit when a file that is
272marked as executable is checked out, or checks out an
273non-executable file with executable bit on.
274linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
275to see if it handles the executable bit correctly
276and this variable is automatically set as necessary.
277+
278A repository, however, may be on a filesystem that handles
279the filemode correctly, and this variable is set to 'true'
280when created, but later may be made accessible from another
281environment that loses the filemode (e.g. exporting ext4 via
282CIFS mount, visiting a Cygwin created repository with
283Git for Windows or Eclipse).
284In such a case it may be necessary to set this variable to 'false'.
285See linkgit:git-update-index[1].
286+
287The default is true (when core.filemode is not specified in the config file).
Junio C Hamano07824ce2006-04-25 07:36:54288
Junio C Hamano198b1f12016-05-17 22:27:24289core.hideDotFiles::
290(Windows-only) If true, mark newly-created directories and files whose
291name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
292directory is hidden, but no other files starting with a dot. The
293default mode is 'dotGitOnly'.
294
Junio C Hamano322c6242015-03-23 21:32:46295core.ignoreCase::
Junio C Hamano9df0c662009-11-23 11:09:27296If true, this option enables various workarounds to enable
Junio C Hamano076ffcc2013-02-06 05:13:21297Git to work better on filesystems that are not case sensitive,
Junio C Hamano9df0c662009-11-23 11:09:27298like FAT. For example, if a directory listing finds
Junio C Hamano076ffcc2013-02-06 05:13:21299"makefile" when Git expects "Makefile", Git will assume
Junio C Hamano9df0c662009-11-23 11:09:27300it is really the same file, and continue to remember it as
301"Makefile".
302+
303The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
Junio C Hamano322c6242015-03-23 21:32:46304will probe and set core.ignoreCase true if appropriate when the repository
Junio C Hamano9df0c662009-11-23 11:09:27305is created.
306
Junio C Hamano322c6242015-03-23 21:32:46307core.precomposeUnicode::
Junio C Hamano076ffcc2013-02-06 05:13:21308This option is only used by Mac OS implementation of Git.
Junio C Hamano322c6242015-03-23 21:32:46309When core.precomposeUnicode=true, Git reverts the unicode decomposition
Junio C Hamanob61a7772012-07-13 23:34:48310of filenames done by Mac OS. This is useful when sharing a repository
311between Mac OS and Linux or Windows.
Junio C Hamano076ffcc2013-02-06 05:13:21312(Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
313When false, file names are handled fully transparent by Git,
314which is backward compatible with older versions of Git.
Junio C Hamanob61a7772012-07-13 23:34:48315
Junio C Hamano30758bd2014-12-18 20:44:14316core.protectHFS::
317If set to true, do not allow checkout of paths that would
318be considered equivalent to `.git` on an HFS+ filesystem.
319Defaults to `true` on Mac OS, and `false` elsewhere.
320
321core.protectNTFS::
322If set to true, do not allow checkout of paths that would
323cause problems with the NTFS filesystem, e.g. conflict with
3248.3 "short" names.
325Defaults to `true` on Windows, and `false` elsewhere.
326
Junio C Hamano90ccff32008-07-29 08:17:24327core.trustctime::
328If false, the ctime differences between the index and the
Junio C Hamano8fb66e52011-10-05 20:59:51329working tree are ignored; useful when the inode change time
Junio C Hamano90ccff32008-07-29 08:17:24330is regularly modified by something outside Git (file system
331crawlers and some backup systems).
332See linkgit:git-update-index[1]. True by default.
333
Junio C Hamano9099a7c2016-02-10 23:42:05334core.untrackedCache::
335Determines what to do about the untracked cache feature of the
336index. It will be kept, if this variable is unset or set to
337`keep`. It will automatically be added if set to `true`. And
338it will automatically be removed, if set to `false`. Before
339setting it to `true`, you should check that mtime is working
340properly on your system.
341See linkgit:git-update-index[1]. `keep` by default.
342
Junio C Hamano322c6242015-03-23 21:32:46343core.checkStat::
Junio C Hamano4cfed0c2013-01-30 17:58:54344Determines which stat fields to match between the index
345and work tree. The user can set this to 'default' or
346'minimal'. Default (or explicitly 'default'), is to check
347all fields, including the sub-second part of mtime and ctime.
348
Junio C Hamano322c6242015-03-23 21:32:46349core.quotePath::
Junio C Hamanoba4b9282008-07-06 05:20:31350The commands that output paths (e.g. 'ls-files',
351'diff'), when not given the `-z` option, will quote
Junio C Hamanod526ba92007-07-02 00:17:42352"unusual" characters in the pathname by enclosing the
353pathname in a double-quote pair and with backslashes the
354same way strings in C source code are quoted. If this
355variable is set to false, the bytes higher than 0x80 are
356not quoted but output as verbatim. Note that double
357quote, backslash and control characters are always
358quoted without `-z` regardless of the setting of this
359variable.
360
Junio C Hamanobb88cf42010-06-21 15:23:55361core.eol::
362Sets the line ending type to use in the working directory for
Junio C Hamanof2a3a752016-05-23 22:54:39363files that have the `text` property set when core.autocrlf is false.
364Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
365native line ending. The default value is `native`. See
Junio C Hamanobb88cf42010-06-21 15:23:55366linkgit:gitattributes[5] for more information on end-of-line
367conversion.
Junio C Hamanod9e0e5d2007-04-14 16:22:04368
Junio C Hamano26e590a2008-02-17 03:53:51369core.safecrlf::
Junio C Hamano076ffcc2013-02-06 05:13:21370If true, makes Git check if converting `CRLF` is reversible when
Junio C Hamanobb88cf42010-06-21 15:23:55371end-of-line conversion is active. Git will verify if a command
Junio C Hamano26e590a2008-02-17 03:53:51372modifies a file in the work tree either directly or indirectly.
373For example, committing a file followed by checking out the
374same file should yield the original file in the work tree. If
375this is not the case for the current setting of
Junio C Hamano076ffcc2013-02-06 05:13:21376`core.autocrlf`, Git will reject the file. The variable can
377be set to "warn", in which case Git will only warn about an
Junio C Hamano26e590a2008-02-17 03:53:51378irreversible conversion but continue the operation.
379+
380CRLF conversion bears a slight chance of corrupting data.
Junio C Hamano076ffcc2013-02-06 05:13:21381When it is enabled, Git will convert CRLF to LF during commit and LF to
Junio C Hamano26e590a2008-02-17 03:53:51382CRLF during checkout. A file that contains a mixture of LF and
Junio C Hamano076ffcc2013-02-06 05:13:21383CRLF before the commit cannot be recreated by Git. For text
Junio C Hamano26e590a2008-02-17 03:53:51384files this is the right thing to do: it corrects line endings
385such that we have only LF line endings in the repository.
386But for binary files that are accidentally classified as text the
387conversion can corrupt data.
388+
389If you recognize such corruption early you can easily fix it by
390setting the conversion type explicitly in .gitattributes. Right
391after committing you still have the original file in your work
392tree and this file is not yet corrupted. You can explicitly tell
Junio C Hamano076ffcc2013-02-06 05:13:21393Git that this file is binary and Git will handle the file
Junio C Hamano26e590a2008-02-17 03:53:51394appropriately.
395+
396Unfortunately, the desired effect of cleaning up text files with
397mixed line endings and the undesired effect of corrupting binary
398files cannot be distinguished. In both cases CRLFs are removed
399in an irreversible way. For text files this is the right thing
400to do because CRLFs are line endings, while for binary files
401converting CRLFs corrupts data.
402+
403Note, this safety check does not mean that a checkout will generate a
404file identical to the original file for a different setting of
Junio C Hamanobb88cf42010-06-21 15:23:55405`core.eol` and `core.autocrlf`, but only for the current one. For
406example, a text file with `LF` would be accepted with `core.eol=lf`
407and could later be checked out with `core.eol=crlf`, in which case the
Junio C Hamano26e590a2008-02-17 03:53:51408resulting file would contain `CRLF`, although the original file
409contained `LF`. However, in both work trees the line endings would be
410consistent, that is either all `LF` or all `CRLF`, but never mixed. A
411file with mixed line endings would be reported by the `core.safecrlf`
412mechanism.
413
Junio C Hamanobb88cf42010-06-21 15:23:55414core.autocrlf::
415Setting this variable to "true" is almost the same as setting
416the `text` attribute to "auto" on all files except that text
417files are not guaranteed to be normalized: files that contain
418`CRLF` in the repository will not be touched. Use this
419setting if you want to have `CRLF` line endings in your
420working directory even though the repository does not have
421normalized line endings. This variable can be set to 'input',
422in which case no output conversion is performed.
423
Junio C Hamanoaa83a7d2007-03-05 02:37:29424core.symlinks::
425If false, symbolic links are checked out as small plain files that
Junio C Hamano35738e82008-01-07 07:55:46426contain the link text. linkgit:git-update-index[1] and
427linkgit:git-add[1] will not change the recorded type to regular
Junio C Hamanoaa83a7d2007-03-05 02:37:29428file. Useful on filesystems like FAT that do not support
Junio C Hamano9df0c662009-11-23 11:09:27429symbolic links.
430+
431The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
432will probe and set core.symlinks false if appropriate when the repository
433is created.
Junio C Hamanoaa83a7d2007-03-05 02:37:29434
Junio C Hamano07824ce2006-04-25 07:36:54435core.gitProxy::
436A "proxy command" to execute (as 'command host port') instead
437of establishing direct connection to the remote server when
Junio C Hamano076ffcc2013-02-06 05:13:21438using the Git protocol for fetching. If the variable value is
Junio C Hamano07824ce2006-04-25 07:36:54439in the "COMMAND for DOMAIN" format, the command is applied only
440on hostnames ending with the specified domain string. This variable
441may be set multiple times and is matched in the given order;
442the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17443+
Junio C Hamano042f2142016-06-27 18:05:05444Can be overridden by the `GIT_PROXY_COMMAND` environment variable
Junio C Hamanof1d14802006-06-08 00:48:17445(which always applies universally, without the special "for"
446handling).
Junio C Hamanoea82cff2009-03-18 01:54:48447+
448The special string `none` can be used as the proxy command to
449specify that no proxy be used for a given domain pattern.
450This is useful for excluding servers inside a firewall from
451proxy use, while defaulting to a common proxy for external domains.
Junio C Hamano07824ce2006-04-25 07:36:54452
453core.ignoreStat::
Junio C Hamanoe8acc8e2015-01-14 22:01:34454If true, Git will avoid using lstat() calls to detect if files have
455changed by setting the "assume-unchanged" bit for those tracked files
456which it has updated identically in both the index and working tree.
457+
458When files are modified outside of Git, the user will need to stage
459the modified files explicitly (e.g. see 'Examples' section in
460linkgit:git-update-index[1]).
461Git will not normally detect changes to those files.
462+
463This is useful on systems where lstat() calls are very slow, such as
464CIFS/Microsoft Windows.
465+
466False by default.
Junio C Hamano07824ce2006-04-25 07:36:54467
Junio C Hamano88a3a072006-05-04 08:01:43468core.preferSymlinkRefs::
469Instead of the default "symref" format for HEAD
470and other symbolic reference files, use symbolic links.
471This is sometimes needed to work with old scripts that
472expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54473
Junio C Hamano1025e752007-02-23 07:21:26474core.bare::
475If true this repository is assumed to be 'bare' and has no
476working directory associated with it. If this is the case a
477number of commands that require a working directory will be
Junio C Hamano35738e82008-01-07 07:55:46478disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Junio C Hamano1025e752007-02-23 07:21:26479+
Junio C Hamano35738e82008-01-07 07:55:46480This setting is automatically guessed by linkgit:git-clone[1] or
481linkgit:git-init[1] when the repository was created. By default a
Junio C Hamano1025e752007-02-23 07:21:26482repository that ends in "/.git" is assumed to be not bare (bare =
483false), while all other repositories are assumed to be bare (bare
484= true).
485
Junio C Hamanod526ba92007-07-02 00:17:42486core.worktree::
Junio C Hamano80d58462011-01-24 22:52:52487Set the path to the root of the working tree.
Junio C Hamano042f2142016-06-27 18:05:05488If `GIT_COMMON_DIR` environment variable is set, core.worktree
Junio C Hamano4cc4a842015-05-11 22:41:02489is ignored and not used for determining the root of working tree.
Junio C Hamano042f2142016-06-27 18:05:05490This can be overridden by the `GIT_WORK_TREE` environment
Junio C Hamano92d80372016-07-13 22:00:05491variable and the `--work-tree` command-line option.
Junio C Hamano5cd15182011-04-05 00:21:10492The value can be an absolute path or relative to the path to
Junio C Hamano80d58462011-01-24 22:52:52493the .git directory, which is either specified by --git-dir
494or GIT_DIR, or automatically discovered.
495If --git-dir or GIT_DIR is specified but none of
Junio C Hamano7d575a52008-04-30 08:45:27496--work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamano80d58462011-01-24 22:52:52497the current working directory is regarded as the top level
Junio C Hamano3609b332010-12-29 01:34:52498of your working tree.
Junio C Hamano80d58462011-01-24 22:52:52499+
500Note that this variable is honored even when set in a configuration
501file in a ".git" subdirectory of a directory and its value differs
502from the latter directory (e.g. "/path/to/.git/config" has
503core.worktree set to "/different/path"), which is most likely a
Junio C Hamano076ffcc2013-02-06 05:13:21504misconfiguration. Running Git commands in the "/path/to" directory will
Junio C Hamano80d58462011-01-24 22:52:52505still use "/different/path" as the root of the work tree and can cause
506confusion unless you know what you are doing (e.g. you are creating a
507read-only snapshot of the same index to a location different from the
508repository's usual working tree).
Junio C Hamanod526ba92007-07-02 00:17:42509
Junio C Hamano341071d2006-06-04 07:24:48510core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49511Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamano198b1f12016-05-17 22:27:24512"`$GIT_DIR/logs/<ref>`", by appending the new and old
Junio C Hamanoe3f080d2013-04-22 02:27:13513SHA-1, the date/time and the reason of the update, but
Junio C Hamanoa2ec14f2006-11-02 00:22:48514only when the file exists. If this configuration
Junio C Hamano198b1f12016-05-17 22:27:24515variable is set to true, missing "`$GIT_DIR/logs/<ref>`"
Junio C Hamano15567bc2011-07-23 00:51:59516file is automatically created for branch heads (i.e. under
517refs/heads/), remote refs (i.e. under refs/remotes/),
518note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
Junio C Hamano1caaf472006-12-31 08:29:35519+
520This information can be used to determine what commit
521was the tip of a branch "2 days ago".
522+
523This value is true by default in a repository that has
524a working directory associated with it, and false by
525default in a bare repository.
Junio C Hamano341071d2006-06-04 07:24:48526
Junio C Hamano07824ce2006-04-25 07:36:54527core.repositoryFormatVersion::
528Internal variable identifying the repository format and layout
529version.
530
531core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42532When 'group' (or 'true'), the repository is made shareable between
533several users in a group (making sure all the files and objects are
534group-writable). When 'all' (or 'world' or 'everybody'), the
535repository will be readable by all users, additionally to being
Junio C Hamano076ffcc2013-02-06 05:13:21536group-shareable. When 'umask' (or 'false'), Git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37537reported by umask(2). When '0xxx', where '0xxx' is an octal number,
538files in the repository will have this mode value. '0xxx' will override
Junio C Hamano83eded12009-04-20 08:18:00539user's umask value (whereas the other options will only override
540requested parts of the user's umask value). Examples: '0660' will make
541the repo read/write-able for the owner and group, but inaccessible to
542others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Junio C Hamano2f102bb2008-04-26 02:23:37543repository that is group-readable but not group-writable.
544See linkgit:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54545
546core.warnAmbiguousRefs::
Junio C Hamano076ffcc2013-02-06 05:13:21547If true, Git will warn you if the ref name you passed it is ambiguous
Junio C Hamano947ab822013-03-19 23:07:29548and might match multiple refs in the repository. True by default.
Junio C Hamano07824ce2006-04-25 07:36:54549
Junio C Hamano7ec15722006-07-07 02:03:59550core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09551An integer -1..9, indicating a default compression level.
552-1 is the zlib default. 0 means no compression,
553and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42554If set, this provides a default to other compression variables,
Junio C Hamano042f2142016-06-27 18:05:05555such as `core.looseCompression` and `pack.compression`.
Junio C Hamanoa126a3b2006-07-04 04:55:26556
Junio C Hamano322c6242015-03-23 21:32:46557core.looseCompression::
Junio C Hamanof2ce2972007-05-20 19:12:09558An integer -1..9, indicating the compression level for objects that
559are not in a pack file. -1 is the zlib default. 0 means no
560compression, and 1..9 are various speed/size tradeoffs, 9 being
561slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42562not set, defaults to 1 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49563
Junio C Hamanofc4d38c2007-01-08 06:53:32564core.packedGitWindowSize::
565Number of bytes of a pack file to map into memory in a
566single mapping operation. Larger window sizes may allow
567your system to process a smaller number of large pack files
568more quickly. Smaller window sizes will negatively affect
569performance due to increased calls to the operating system's
570memory manager, but may improve performance when accessing
571a large number of large pack files.
572+
573Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
574MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
575be reasonable for all users/operating systems. You probably do
576not need to adjust this value.
577+
578Common unit suffixes of 'k', 'm', or 'g' are supported.
579
580core.packedGitLimit::
581Maximum number of bytes to map simultaneously into memory
582from pack files. If Git needs to access more than this many
583bytes at once to complete an operation it will unmap existing
584regions to reclaim virtual address space within the process.
585+
586Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
587This should be reasonable for all users/operating systems, except on
588the largest projects. You probably do not need to adjust this value.
589+
590Common unit suffixes of 'k', 'm', or 'g' are supported.
591
Junio C Hamanob8c51282007-03-19 10:43:30592core.deltaBaseCacheLimit::
593Maximum number of bytes to reserve for caching base objects
Junio C Hamano619596a2010-08-18 22:15:35594that may be referenced by multiple deltified objects. By storing the
Junio C Hamanob8c51282007-03-19 10:43:30595entire decompressed base objects in a cache Git is able
596to avoid unpacking and decompressing frequently used base
597objects multiple times.
598+
Junio C Hamanoe1aeb5e2014-06-06 19:16:29599Default is 96 MiB on all platforms. This should be reasonable
Junio C Hamanob8c51282007-03-19 10:43:30600for all users/operating systems, except on the largest projects.
601You probably do not need to adjust this value.
602+
603Common unit suffixes of 'k', 'm', or 'g' are supported.
604
Junio C Hamano5c246f22010-02-03 07:34:53605core.bigFileThreshold::
606Files larger than this size are stored deflated, without
607attempting delta compression. Storing large files without
608delta compression avoids excessive memory usage, at the
Junio C Hamano8e61f1f2014-09-11 21:53:45609slight expense of increased disk usage. Additionally files
610larger than this size are always treated as binary.
Junio C Hamano5c246f22010-02-03 07:34:53611+
612Default is 512 MiB on all platforms. This should be reasonable
613for most projects as source code and other text files can still
614be delta compressed, but larger binary media files won't be.
615+
616Common unit suffixes of 'k', 'm', or 'g' are supported.
Junio C Hamano5c246f22010-02-03 07:34:53617
Junio C Hamano322c6242015-03-23 21:32:46618core.excludesFile::
Junio C Hamano198b1f12016-05-17 22:27:24619Specifies the pathname to the file that contains patterns to
620describe paths that are not meant to be tracked, in addition
621to '.gitignore' (per-directory) and '.git/info/exclude'.
622Defaults to `$XDG_CONFIG_HOME/git/ignore`.
623If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
Junio C Hamano8edb4c72012-07-09 20:33:55624is used instead. See linkgit:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37625
Junio C Hamano322c6242015-03-23 21:32:46626core.askPass::
Junio C Hamano3fd7b262010-09-08 22:44:20627Some commands (e.g. svn and http interfaces) that interactively
628ask for a password can be told to use an external program given
Junio C Hamano042f2142016-06-27 18:05:05629via the value of this variable. Can be overridden by the `GIT_ASKPASS`
Junio C Hamano3fd7b262010-09-08 22:44:20630environment variable. If not set, fall back to the value of the
Junio C Hamano042f2142016-06-27 18:05:05631`SSH_ASKPASS` environment variable or, failing that, a simple password
Junio C Hamano3fd7b262010-09-08 22:44:20632prompt. The external program shall be given a suitable prompt as
Junio C Hamanoe1aeb5e2014-06-06 19:16:29633command-line argument and write the password on its STDOUT.
Junio C Hamano3fd7b262010-09-08 22:44:20634
Junio C Hamano322c6242015-03-23 21:32:46635core.attributesFile::
Junio C Hamano3b4609d2010-09-30 00:04:34636In addition to '.gitattributes' (per-directory) and
Junio C Hamano076ffcc2013-02-06 05:13:21637'.git/info/attributes', Git looks into this file for attributes
Junio C Hamano3b4609d2010-09-30 00:04:34638(see linkgit:gitattributes[5]). Path expansions are made the same
Junio C Hamano322c6242015-03-23 21:32:46639way as for `core.excludesFile`. Its default value is
Junio C Hamano198b1f12016-05-17 22:27:24640`$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
641set or empty, `$HOME/.config/git/attributes` is used instead.
642
643core.hooksPath::
644By default Git will look for your hooks in the
645'$GIT_DIR/hooks' directory. Set this to different path,
646e.g. '/etc/git/hooks', and Git will try to find your hooks in
647that directory, e.g. '/etc/git/hooks/pre-receive' instead of
648in '$GIT_DIR/hooks/pre-receive'.
649+
650The path can be either absolute or relative. A relative path is
651taken as relative to the directory where the hooks are run (see
652the "DESCRIPTION" section of linkgit:githooks[5]).
653+
654This configuration variable is useful in cases where you'd like to
655centrally configure your Git hooks instead of configuring them on a
656per-repository basis, or as a more flexible and centralized
657alternative to having an `init.templateDir` where you've changed
658default hooks.
Junio C Hamano3b4609d2010-09-30 00:04:34659
Junio C Hamanof6002a92007-07-20 10:28:22660core.editor::
661Commands such as `commit` and `tag` that lets you edit
Junio C Hamanoa6387422007-08-25 03:54:27662messages by launching an editor uses the value of this
Junio C Hamanof6002a92007-07-20 10:28:22663variable when it is set, and the environment variable
Junio C Hamano3b70d3c2009-11-21 17:37:37664`GIT_EDITOR` is not set. See linkgit:git-var[1].
Junio C Hamanof6002a92007-07-20 10:28:22665
Junio C Hamano322c6242015-03-23 21:32:46666core.commentChar::
Junio C Hamano3f2ed6f2013-02-04 19:24:09667Commands such as `commit` and `tag` that lets you edit
668messages consider a line that begins with this character
669commented, and removes them after the editor returns
670(default '#').
Junio C Hamanoe1aeb5e2014-06-06 19:16:29671+
672If set to "auto", `git-commit` would select a character that is not
673the beginning character of any line in existing commit messages.
Junio C Hamano3f2ed6f2013-02-04 19:24:09674
Junio C Hamano1dbca522015-05-22 20:48:55675core.packedRefsTimeout::
676The length of time, in milliseconds, to retry when trying to
677lock the `packed-refs` file. Value 0 means not to retry at
678all; -1 means to try indefinitely. Default is 1000 (i.e.,
679retry for 1 second).
680
Junio C Hamano6231f822011-10-24 05:18:52681sequence.editor::
Junio C Hamano778a3412013-03-28 23:24:30682Text editor used by `git rebase -i` for editing the rebase instruction file.
Junio C Hamano6231f822011-10-24 05:18:52683The value is meant to be interpreted by the shell when it is used.
684It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
685When not configured the default commit message editor is used instead.
686
Junio C Hamano28d8ede2007-07-05 05:51:38687core.pager::
Junio C Hamano0e0e0d22013-09-12 23:25:03688Text viewer for use by Git commands (e.g., 'less'). The value
689is meant to be interpreted by the shell. The order of preference
690is the `$GIT_PAGER` environment variable, then `core.pager`
691configuration, then `$PAGER`, and then the default chosen at
692compile time (usually 'less').
693+
Junio C Hamanoe1aeb5e2014-06-06 19:16:29694When the `LESS` environment variable is unset, Git sets it to `FRX`
Junio C Hamano0e0e0d22013-09-12 23:25:03695(if `LESS` environment variable is set, Git does not change it at
696all). If you want to selectively override Git's default setting
Junio C Hamanoe1aeb5e2014-06-06 19:16:29697for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
Junio C Hamano0e0e0d22013-09-12 23:25:03698be passed to the shell by Git, which will translate the final
Junio C Hamanoe1aeb5e2014-06-06 19:16:29699command to `LESS=FRX less -S`. The environment does not set the
700`S` option but the command line does, instructing less to truncate
701long lines. Similarly, setting `core.pager` to `less -+F` will
702deactivate the `F` option specified by the environment from the
703command-line, deactivating the "quit if one screen" behavior of
704`less`. One can specifically activate some flags for particular
705commands: for example, setting `pager.blame` to `less -S` enables
706line truncation only for `git blame`.
Junio C Hamanobc8d4782014-01-13 23:35:50707+
708Likewise, when the `LV` environment variable is unset, Git sets it
709to `-c`. You can override this setting by exporting `LV` with
710another value or setting `core.pager` to `lv +c`.
Junio C Hamano28d8ede2007-07-05 05:51:38711
Junio C Hamano942b35e2007-12-09 10:19:33712core.whitespace::
713A comma separated list of common whitespace problems to
Junio C Hamano1aa40d22010-01-21 17:46:43714notice. 'git diff' will use `color.diff.whitespace` to
715highlight them, and 'git apply --whitespace=error' will
Junio C Hamano3db8b412008-07-26 06:45:59716consider them as errors. You can prefix `-` to disable
717any of them (e.g. `-trailing-space`):
Junio C Hamano942b35e2007-12-09 10:19:33718+
Junio C Hamanob71a22d2009-10-17 08:23:47719* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano942b35e2007-12-09 10:19:33720 as an error (enabled by default).
721* `space-before-tab` treats a space character that appears immediately
722 before a tab character in the initial indent part of the line as an
723 error (enabled by default).
Junio C Hamano281fd392012-09-17 23:57:41724* `indent-with-non-tab` treats a line that is indented with space
725 characters instead of the equivalent tabs as an error (not enabled by
726 default).
Junio C Hamanocb39aea2010-05-09 07:24:48727* `tab-in-indent` treats a tab character in the initial indent part of
728 the line as an error (not enabled by default).
Junio C Hamanob71a22d2009-10-17 08:23:47729* `blank-at-eof` treats blank lines added at the end of file as an error
730 (enabled by default).
731* `trailing-space` is a short-hand to cover both `blank-at-eol` and
732 `blank-at-eof`.
Junio C Hamano601f3e52008-02-25 08:40:42733* `cr-at-eol` treats a carriage-return at the end of line as
734 part of the line terminator, i.e. with it, `trailing-space`
735 does not trigger if the character before such a carriage-return
736 is not a whitespace (not enabled by default).
Junio C Hamanoeef01fe2010-12-13 08:31:58737* `tabwidth=<n>` tells how many character positions a tab occupies; this
Junio C Hamano076ffcc2013-02-06 05:13:21738 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
Junio C Hamanoeef01fe2010-12-13 08:31:58739 errors. The default tab width is 8. Allowed values are 1 to 63.
Junio C Hamano942b35e2007-12-09 10:19:33740
Junio C Hamano322c6242015-03-23 21:32:46741core.fsyncObjectFiles::
Junio C Hamano9eb57532008-06-26 06:33:46742This boolean will enable 'fsync()' when writing object files.
743+
744This is a total waste of time and effort on a filesystem that orders
745data writes properly, but can be useful for filesystems that do not use
746journalling (traditional UNIX filesystems) or that only journal metadata
747and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
748
Junio C Hamano322c6242015-03-23 21:32:46749core.preloadIndex::
Junio C Hamano610d1762008-11-28 06:27:13750Enable parallel index preload for operations like 'git diff'
751+
752This can speed up operations like 'git diff' and 'git status' especially
753on filesystems like NFS that have weak caching semantics and thus
Junio C Hamanoc8c398a2014-06-16 21:14:05754relatively high IO latencies. When enabled, Git will do the
Junio C Hamano610d1762008-11-28 06:27:13755index comparison to the filesystem data in parallel, allowing
Junio C Hamanoc8c398a2014-06-16 21:14:05756overlapping IO's. Defaults to true.
Junio C Hamano610d1762008-11-28 06:27:13757
Junio C Hamanoa9499de2009-04-30 03:38:48758core.createObject::
759You can set this to 'link', in which case a hardlink followed by
760a delete of the source are used to make sure that object creation
761will not overwrite existing objects.
762+
763On some file system/operating system combinations, this is unreliable.
764Set this config setting to 'rename' there; However, This will remove the
765check that makes sure that existing object files will not get overwritten.
Junio C Hamanoe91ea772009-04-26 01:41:41766
Junio C Hamano3b70d3c2009-11-21 17:37:37767core.notesRef::
768When showing commit messages, also show notes which are stored in
Junio C Hamanoa574a092010-06-13 19:57:10769the given ref. The ref must be fully qualified. If the given
770ref does not exist, it is not an error but means that no
771notes should be printed.
Junio C Hamano3b70d3c2009-11-21 17:37:37772+
Junio C Hamanoa574a092010-06-13 19:57:10773This setting defaults to "refs/notes/commits", and it can be overridden by
Junio C Hamano042f2142016-06-27 18:05:05774the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
Junio C Hamano3b70d3c2009-11-21 17:37:37775
Junio C Hamano3c8d6702010-01-13 23:09:03776core.sparseCheckout::
777Enable "sparse checkout" feature. See section "Sparse checkout" in
778linkgit:git-read-tree[1] for more information.
779
Junio C Hamano6371b0e2011-03-23 23:36:21780core.abbrev::
781Set the length object names are abbreviated to. If unspecified,
782many commands abbreviate to 7 hexdigits, which may not be enough
783for abbreviated object names to stay unique for sufficiently long
784time.
785
Junio C Hamano60186642010-12-02 14:18:26786add.ignoreErrors::
Junio C Hamanobe087982015-02-22 21:29:39787add.ignore-errors (deprecated)::
Junio C Hamano1aa40d22010-01-21 17:46:43788Tells 'git add' to continue adding files when some files cannot be
Junio C Hamano92d80372016-07-13 22:00:05789added due to indexing errors. Equivalent to the `--ignore-errors`
Junio C Hamanobe087982015-02-22 21:29:39790option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
791as it does not follow the usual naming convention for configuration
792variables.
Junio C Hamano3d141512009-06-01 01:22:40793
Junio C Hamano33db4372006-06-07 19:51:45794alias.*::
Junio C Hamano35738e82008-01-07 07:55:46795Command aliases for the linkgit:git[1] command wrapper - e.g.
Junio C Hamano33db4372006-06-07 19:51:45796after defining "alias.last = cat-file commit HEAD", the invocation
797"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17798confusion and troubles with script usage, aliases that
Junio C Hamano076ffcc2013-02-06 05:13:21799hide existing Git commands are ignored. Arguments are split by
Junio C Hamanof1d14802006-06-08 00:48:17800spaces, the usual shell quoting and escaping is supported.
Junio C Hamano2efd5e42014-11-10 22:38:52801A quote pair or a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39802+
803If the alias expansion is prefixed with an exclamation point,
804it will be treated as a shell command. For example, defining
805"alias.new = !gitk --all --not ORIG_HEAD", the invocation
806"git new" is equivalent to running the shell command
Junio C Hamano48bc1ce2009-07-09 16:49:19807"gitk --all --not ORIG_HEAD". Note that shell commands will be
808executed from the top-level directory of a repository, which may
809not necessarily be the current directory.
Junio C Hamano042f2142016-06-27 18:05:05810`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
Junio C Hamano5f2627d2011-05-06 20:23:48811from the original current directory. See linkgit:git-rev-parse[1].
Junio C Hamano9cb74f22007-02-12 04:15:05812
Junio C Hamanocaa712a2010-03-11 01:17:35813am.keepcr::
814If true, git-am will call git-mailsplit for patches in mbox format
Junio C Hamano92d80372016-07-13 22:00:05815with parameter `--keep-cr`. In this case git-mailsplit will
Junio C Hamano619596a2010-08-18 22:15:35816not remove `\r` from lines ending with `\r\n`. Can be overridden
Junio C Hamano92d80372016-07-13 22:00:05817by giving `--no-keep-cr` from the command line.
Junio C Hamanocaa712a2010-03-11 01:17:35818See linkgit:git-am[1], linkgit:git-mailsplit[1].
819
Junio C Hamano9c512872015-08-12 21:59:25820am.threeWay::
821By default, `git am` will fail if the patch does not apply cleanly. When
822set to true, this setting tells `git am` to fall back on 3-way merge if
823the patch records the identity of blobs it is supposed to apply to and
824we have those blobs available locally (equivalent to giving the `--3way`
825option from the command line). Defaults to `false`.
826See linkgit:git-am[1].
827
Junio C Hamano322c6242015-03-23 21:32:46828apply.ignoreWhitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43829When set to 'change', tells 'git apply' to ignore changes in
Junio C Hamano92d80372016-07-13 22:00:05830whitespace, in the same way as the `--ignore-space-change`
Junio C Hamanofe24db02009-08-22 05:10:47831option.
Junio C Hamano1aa40d22010-01-21 17:46:43832When set to one of: no, none, never, false tells 'git apply' to
Junio C Hamanofe24db02009-08-22 05:10:47833respect all whitespace differences.
834See linkgit:git-apply[1].
835
Junio C Hamano07824ce2006-04-25 07:36:54836apply.whitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43837Tells 'git apply' how to handle whitespaces, in the same way
Junio C Hamano92d80372016-07-13 22:00:05838as the `--whitespace` option. See linkgit:git-apply[1].
Junio C Hamano07824ce2006-04-25 07:36:54839
Junio C Hamano322c6242015-03-23 21:32:46840branch.autoSetupMerge::
Junio C Hamano1aa40d22010-01-21 17:46:43841Tells 'git branch' and 'git checkout' to set up new branches
Junio C Hamano24bc09a2008-02-28 00:27:44842so that linkgit:git-pull[1] will appropriately merge from the
843starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32844this behavior can be chosen per-branch using the `--track`
Junio C Hamano24bc09a2008-02-28 00:27:44845and `--no-track` options. The valid settings are: `false` -- no
846automatic setup is done; `true` -- automatic setup is done when the
Junio C Hamano97bcb482010-11-25 03:16:07847starting point is a remote-tracking branch; `always` --
848automatic setup is done when the starting point is either a
849local branch or remote-tracking
Junio C Hamano24bc09a2008-02-28 00:27:44850branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32851
Junio C Hamano322c6242015-03-23 21:32:46852branch.autoSetupRebase::
Junio C Hamano1aa40d22010-01-21 17:46:43853When a new branch is created with 'git branch' or 'git checkout'
Junio C Hamano076ffcc2013-02-06 05:13:21854that tracks another branch, this variable tells Git to set
Junio C Hamano869bb802008-05-12 00:29:47855up pull to rebase instead of merge (see "branch.<name>.rebase").
856When `never`, rebase is never automatically set to true.
857When `local`, rebase is set to true for tracked branches of
858other local branches.
859When `remote`, rebase is set to true for tracked branches of
Junio C Hamano97bcb482010-11-25 03:16:07860remote-tracking branches.
Junio C Hamano869bb802008-05-12 00:29:47861When `always`, rebase will be set to true for all tracking
862branches.
Junio C Hamano322c6242015-03-23 21:32:46863See "branch.autoSetupMerge" for details on how to set up a
Junio C Hamano869bb802008-05-12 00:29:47864branch to track another branch.
865This option defaults to never.
866
Junio C Hamano47c1e3c2006-09-25 04:45:55867branch.<name>.remote::
Junio C Hamano63b6fdb2013-04-07 23:37:13868When on branch <name>, it tells 'git fetch' and 'git push'
869which remote to fetch from/push to. The remote to push to
Junio C Hamano322c6242015-03-23 21:32:46870may be overridden with `remote.pushDefault` (for all branches).
Junio C Hamano63b6fdb2013-04-07 23:37:13871The remote to push to, for the current branch, may be further
Junio C Hamano322c6242015-03-23 21:32:46872overridden by `branch.<name>.pushRemote`. If no remote is
Junio C Hamano63b6fdb2013-04-07 23:37:13873configured, or if you are not on any branch, it defaults to
Junio C Hamano322c6242015-03-23 21:32:46874`origin` for fetching and `remote.pushDefault` for pushing.
Junio C Hamano238ce9c2013-10-23 21:56:38875Additionally, `.` (a period) is the current local repository
876(a dot-repository), see `branch.<name>.merge`'s final note below.
Junio C Hamano63b6fdb2013-04-07 23:37:13877
Junio C Hamano322c6242015-03-23 21:32:46878branch.<name>.pushRemote::
Junio C Hamano63b6fdb2013-04-07 23:37:13879When on branch <name>, it overrides `branch.<name>.remote` for
Junio C Hamano322c6242015-03-23 21:32:46880pushing. It also overrides `remote.pushDefault` for pushing
Junio C Hamano63b6fdb2013-04-07 23:37:13881from branch <name>. When you pull from one place (e.g. your
882upstream) and push to another place (e.g. your own publishing
Junio C Hamano322c6242015-03-23 21:32:46883repository), you would want to set `remote.pushDefault` to
Junio C Hamano63b6fdb2013-04-07 23:37:13884specify the remote to push to for all branches, and use this
885option to override it for a specific branch.
Junio C Hamano47c1e3c2006-09-25 04:45:55886
887branch.<name>.merge::
Junio C Hamano0706c802009-03-30 22:34:19888Defines, together with branch.<name>.remote, the upstream branch
Junio C Hamanob02377c2011-04-28 22:26:02889for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
Junio C Hamano1aa40d22010-01-21 17:46:43890branch to merge and can also affect 'git push' (see push.default).
891When in branch <name>, it tells 'git fetch' the default
Junio C Hamanoc2b47092007-10-25 06:50:31892refspec to be marked for merging in FETCH_HEAD. The value is
893handled like the remote part of a refspec, and must match a
894ref which is fetched from the remote given by
895"branch.<name>.remote".
Junio C Hamano1aa40d22010-01-21 17:46:43896The merge information is used by 'git pull' (which at first calls
897'git fetch') to lookup the default branch for merging. Without
898this option, 'git pull' defaults to merge the first refspec fetched.
Junio C Hamano96010b22006-12-09 21:15:46899Specify multiple values to get an octopus merge.
Junio C Hamano1aa40d22010-01-21 17:46:43900If you wish to setup 'git pull' so that it merges into <name> from
Junio C Hamano6e149c02007-03-16 10:21:07901another branch in the local repository, you can point
Junio C Hamano238ce9c2013-10-23 21:56:38902branch.<name>.merge to the desired branch, and use the relative path
903setting `.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:55904
Junio C Hamano322c6242015-03-23 21:32:46905branch.<name>.mergeOptions::
Junio C Hamano1b50ce92007-10-03 12:05:53906Sets default options for merging into branch <name>. The syntax and
Junio C Hamanoc0e55e72009-10-10 00:56:29907supported options are the same as those of linkgit:git-merge[1], but
Junio C Hamano1b50ce92007-10-03 12:05:53908option values containing whitespace characters are currently not
909supported.
910
Junio C Hamano0c999702007-12-03 09:57:55911branch.<name>.rebase::
912When true, rebase the branch <name> on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:08913instead of merging the default branch from the default remote when
Junio C Hamano515ab1d2011-12-09 23:41:20914"git pull" is run. See "pull.rebase" for doing this in a non
915branch-specific manner.
916+
Junio C Hamano7db630e2015-09-17 20:26:22917When preserve, also pass `--preserve-merges` along to 'git rebase'
918so that locally committed merge commits will not be flattened
919by running 'git pull'.
Junio C Hamanocf4a1742013-09-11 22:57:50920+
Junio C Hamano289d7e82016-01-27 00:20:38921When the value is `interactive`, the rebase is run in interactive mode.
922+
Junio C Hamano515ab1d2011-12-09 23:41:20923*NOTE*: this is a possibly dangerous operation; do *not* use
924it unless you understand the implications (see linkgit:git-rebase[1]
925for details).
Junio C Hamano0c999702007-12-03 09:57:55926
Junio C Hamano46247182013-01-09 20:50:28927branch.<name>.description::
928Branch description, can be edited with
929`git branch --edit-description`. Branch description is
930automatically added in the format-patch cover letter or
931request-pull summary.
932
Junio C Hamano8760ea62008-03-14 08:58:45933browser.<tool>.cmd::
934Specify the command to invoke the specified browser. The
935specified command is evaluated in shell with the URLs passed
Junio C Hamano360e3a12011-07-13 23:51:56936as arguments. (See linkgit:git-web{litdd}browse[1].)
Junio C Hamano8760ea62008-03-14 08:58:45937
Junio C Hamanoe35a6fc2008-01-29 09:46:27938browser.<tool>.path::
939Override the path for the given tool that may be used to
Junio C Hamano92d80372016-07-13 22:00:05940browse HTML help (see `-w` option in linkgit:git-help[1]) or a
Junio C Hamanoe35a6fc2008-01-29 09:46:27941working repository in gitweb (see linkgit:git-instaweb[1]).
942
Junio C Hamano47b9acd2007-04-24 07:34:34943clean.requireForce::
Junio C Hamanoe6f28d02013-09-17 21:34:00944A boolean to make git-clean do nothing unless given -f,
945-i or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:34946
Junio C Hamanoeb692952007-01-03 22:02:12947color.branch::
948A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46949linkgit:git-branch[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21950`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoeb692952007-01-03 22:02:12951only when the output is to a terminal. Defaults to false.
952
953color.branch.<slot>::
954Use customized color for branch coloration. `<slot>` is one of
955`current` (the current branch), `local` (a local branch),
Junio C Hamano76927822013-04-19 21:26:57956`remote` (a remote-tracking branch in refs/remotes/),
957`upstream` (upstream tracking branch), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:22958refs).
Junio C Hamanoeb692952007-01-03 22:02:12959
Junio C Hamano3f403b02006-12-13 10:14:13960color.diff::
Junio C Hamano5f2627d2011-05-06 20:23:48961Whether to use ANSI escape sequences to add color to patches.
962If this is set to `always`, linkgit:git-diff[1],
963linkgit:git-log[1], and linkgit:git-show[1] will use color
964for all patches. If it is set to `true` or `auto`, those
965commands will only use color when output is to the terminal.
966Defaults to false.
967+
Junio C Hamanod75148a2014-04-08 19:48:38968This does not affect linkgit:git-format-patch[1] or the
Junio C Hamano5f2627d2011-05-06 20:23:48969'git-diff-{asterisk}' plumbing commands. Can be overridden on the
970command line with the `--color[=<when>]` option.
Junio C Hamano9ae1a062006-07-10 08:12:34971
Junio C Hamano3f403b02006-12-13 10:14:13972color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:22973Use customized color for diff colorization. `<slot>` specifies
974which part of the patch to use the specified color, and is one
Junio C Hamano8c5d5942015-06-11 19:37:48975of `context` (context text - `plain` is a historical synonym),
976`meta` (metainformation), `frag`
Junio C Hamano2bd8a742009-12-01 21:16:59977(hunk header), 'func' (function in hunk header), `old` (removed lines),
978`new` (added lines), `commit` (commit headers), or `whitespace`
Junio C Hamano07622622015-03-20 21:47:26979(highlighting whitespace errors).
Junio C Hamano9ae1a062006-07-10 08:12:34980
Junio C Hamano7d449522010-07-01 00:08:51981color.decorate.<slot>::
982Use customized color for 'git log --decorate' output. `<slot>` is one
983of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
Junio C Hamano97bcb482010-11-25 03:16:07984branches, remote-tracking branches, tags, stash and HEAD, respectively.
Junio C Hamano7d449522010-07-01 00:08:51985
Junio C Hamanod257cff2009-03-18 05:27:16986color.grep::
987When set to `always`, always highlight matches. When `false` (or
988`never`), never. When set to `true` or `auto`, use color only
989when the output is written to the terminal. Defaults to `false`.
990
Junio C Hamano0299d922010-03-20 20:59:31991color.grep.<slot>::
992Use customized color for grep colorization. `<slot>` specifies which
993part of the line to use the specified color, and is one of
994+
995--
996`context`;;
997non-matching text in context lines (when using `-A`, `-B`, or `-C`)
998`filename`;;
999filename prefix (when not using `-h`)
1000`function`;;
1001function name lines (when using `-p`)
1002`linenumber`;;
1003line number prefix (when using `-n`)
1004`match`;;
Junio C Hamanoc14e6ad2014-10-31 20:25:531005matching text (same as setting `matchContext` and `matchSelected`)
1006`matchContext`;;
1007matching text in context lines
1008`matchSelected`;;
1009matching text in selected lines
Junio C Hamano0299d922010-03-20 20:59:311010`selected`;;
1011non-matching text in selected lines
1012`separator`;;
1013separators between fields on a line (`:`, `-`, and `=`)
1014and between hunks (`--`)
1015--
Junio C Hamanod257cff2009-03-18 05:27:161016
Junio C Hamano00b8b632007-12-07 09:50:491017color.interactive::
Junio C Hamano35738e82008-01-07 07:55:461018When set to `always`, always use colors for interactive prompts
Junio C Hamano58f587a2013-07-22 19:20:591019and displays (such as those used by "git-add --interactive" and
1020"git-clean --interactive"). When false (or `never`), never.
1021When set to `true` or `auto`, use colors only when the output is
1022to the terminal. Defaults to false.
Junio C Hamano00b8b632007-12-07 09:50:491023
1024color.interactive.<slot>::
Junio C Hamano58f587a2013-07-22 19:20:591025Use customized color for 'git add --interactive' and 'git clean
1026--interactive' output. `<slot>` may be `prompt`, `header`, `help`
1027or `error`, for four distinct types of normal output from
Junio C Hamano07622622015-03-20 21:47:261028interactive commands.
Junio C Hamano00b8b632007-12-07 09:50:491029
Junio C Hamanoe7935c42006-12-13 21:32:171030color.pager::
1031A boolean to enable/disable colored output when the pager is in
1032use (default is true).
1033
Junio C Hamano322c6242015-03-23 21:32:461034color.showBranch::
Junio C Hamano52ba2952009-05-18 17:43:021035A boolean to enable/disable color in the output of
1036linkgit:git-show-branch[1]. May be set to `always`,
1037`false` (or `never`) or `auto` (or `true`), in which case colors are used
1038only when the output is to a terminal. Defaults to false.
1039
Junio C Hamanoe7935c42006-12-13 21:32:171040color.status::
1041A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:461042linkgit:git-status[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:211043`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoe7935c42006-12-13 21:32:171044only when the output is to a terminal. Defaults to false.
1045
1046color.status.<slot>::
1047Use customized color for status colorization. `<slot>` is
1048one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:041049`added` or `updated` (files which are added but not committed),
1050`changed` (files which are changed but not added in the index),
Junio C Hamano076ffcc2013-02-06 05:13:211051`untracked` (files which are not tracked by Git),
Junio C Hamano5992a252015-03-17 23:39:301052`branch` (the current branch),
Junio C Hamanob713ff12008-05-24 01:12:301053`nobranch` (the color the 'no branch' warning is shown in, defaulting
Junio C Hamano5992a252015-03-17 23:39:301054to red), or
1055`unmerged` (files which have unmerged changes).
Junio C Hamanoe7935c42006-12-13 21:32:171056
Junio C Hamano83d46a22008-02-21 02:29:421057color.ui::
Junio C Hamano5f2627d2011-05-06 20:23:481058This variable determines the default value for variables such
1059as `color.diff` and `color.grep` that control the use of color
1060per command family. Its scope will expand as more commands learn
1061configuration to set a default for the `--color` option. Set it
Junio C Hamanofa1d3492013-06-20 23:39:431062to `false` or `never` if you prefer Git commands not to use
1063color unless enabled explicitly with some other configuration
1064or the `--color` option. Set it to `always` if you want all
1065output not intended for machine consumption to use color, to
1066`true` or `auto` (this is the default since Git 1.8.4) if you
1067want such output to use color when written to the terminal.
Junio C Hamano83d46a22008-02-21 02:29:421068
Junio C Hamano22700fb2012-05-03 23:07:251069column.ui::
1070Specify whether supported commands should output in columns.
1071This variable consists of a list of tokens separated by spaces
1072or commas:
1073+
Junio C Hamanoa1952302013-07-01 21:31:181074These options control when the feature should be enabled
1075(defaults to 'never'):
1076+
Junio C Hamano22700fb2012-05-03 23:07:251077--
1078`always`;;
1079always show in columns
1080`never`;;
1081never show in columns
1082`auto`;;
1083show in columns if the output is to the terminal
Junio C Hamanoa1952302013-07-01 21:31:181084--
1085+
1086These options control layout (defaults to 'column'). Setting any
1087of these implies 'always' if none of 'always', 'never', or 'auto' are
1088specified.
1089+
1090--
Junio C Hamano22700fb2012-05-03 23:07:251091`column`;;
Junio C Hamanoa1952302013-07-01 21:31:181092fill columns before rows
Junio C Hamano22700fb2012-05-03 23:07:251093`row`;;
1094fill rows before columns
1095`plain`;;
1096show in one column
Junio C Hamanoa1952302013-07-01 21:31:181097--
1098+
1099Finally, these options can be combined with a layout option (defaults
1100to 'nodense'):
1101+
1102--
Junio C Hamano22700fb2012-05-03 23:07:251103`dense`;;
1104make unequal size columns to utilize more space
1105`nodense`;;
1106make equal size columns
1107--
Junio C Hamano22700fb2012-05-03 23:07:251108
1109column.branch::
1110Specify whether to output branch listing in `git branch` in columns.
1111See `column.ui` for details.
1112
Junio C Hamano58f587a2013-07-22 19:20:591113column.clean::
1114Specify the layout when list items in `git clean -i`, which always
1115shows files and directories in columns. See `column.ui` for details.
1116
Junio C Hamano22700fb2012-05-03 23:07:251117column.status::
1118Specify whether to output untracked files in `git status` in columns.
1119See `column.ui` for details.
1120
1121column.tag::
1122Specify whether to output tag listing in `git tag` in columns.
1123See `column.ui` for details.
1124
Junio C Hamanoce836cc2013-01-21 02:01:531125commit.cleanup::
1126This setting overrides the default of the `--cleanup` option in
1127`git commit`. See linkgit:git-commit[1] for details. Changing the
1128default can be useful when you always want to keep lines that begin
1129with comment character `#` in your log message, in which case you
1130would do `git config commit.cleanup whitespace` (note that you will
1131have to remove the help lines that begin with `#` in the commit log
1132template yourself, if you do this).
1133
Junio C Hamano322c6242015-03-23 21:32:461134commit.gpgSign::
Junio C Hamano5b3533d2014-02-27 23:07:151135
1136A boolean to specify whether all commits should be GPG signed.
1137Use of this option when doing operations such as rebase can
1138result in a large number of commits being signed. It may be
1139convenient to use an agent to avoid typing your GPG passphrase
1140several times.
1141
Junio C Hamanod0d892c2010-01-24 20:06:291142commit.status::
Junio C Hamano6ce6b6c2010-01-18 01:25:501143A boolean to enable/disable inclusion of status information in the
1144commit message template when using an editor to prepare the commit
1145message. Defaults to true.
1146
Junio C Hamano4653c6f2008-11-26 22:50:201147commit.template::
Junio C Hamano198b1f12016-05-17 22:27:241148Specify the pathname of a file to use as the template for
1149new commit messages.
Junio C Hamano4653c6f2008-11-26 22:50:201150
Junio C Hamanof2a3a752016-05-23 22:54:391151commit.verbose::
1152A boolean or int to specify the level of verbose with `git commit`.
1153See linkgit:git-commit[1].
1154
Junio C Hamano0df92712011-12-21 22:30:441155credential.helper::
1156Specify an external helper to be called when a username or
1157password credential is needed; the helper may consult external
Junio C Hamano4ba4a782016-04-03 19:11:321158storage to avoid prompting the user for the credentials. Note
1159that multiple helpers may be defined. See linkgit:gitcredentials[7]
1160for details.
Junio C Hamano0df92712011-12-21 22:30:441161
1162credential.useHttpPath::
1163When acquiring credentials, consider the "path" component of an http
1164or https URL to be important. Defaults to false. See
1165linkgit:gitcredentials[7] for more information.
1166
1167credential.username::
1168If no username is set for a network authentication, use this username
1169by default. See credential.<context>.* below, and
1170linkgit:gitcredentials[7].
1171
1172credential.<url>.*::
1173Any of the credential.* options above can be applied selectively to
1174some credentials. For example "credential.https://example.com.username"
1175would set the default username only for https connections to
1176example.com. See linkgit:gitcredentials[7] for details on how URLs are
1177matched.
1178
Junio C Hamanoabb8a052015-12-04 22:43:111179credentialCache.ignoreSIGHUP::
1180Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1181
Junio C Hamano209ebe82011-04-27 21:09:591182include::diff-config.txt[]
Junio C Hamano3bd66e92009-04-18 06:17:561183
1184difftool.<tool>.path::
1185Override the path for the given tool. This is useful in case
1186your tool is not in the PATH.
1187
1188difftool.<tool>.cmd::
1189Specify the command to invoke the specified diff tool.
1190The specified command is evaluated in shell with the following
1191variables available: 'LOCAL' is set to the name of the temporary
1192file containing the contents of the diff pre-image and 'REMOTE'
1193is set to the name of the temporary file containing the contents
1194of the diff post-image.
1195
1196difftool.prompt::
1197Prompt before each invocation of the diff tool.
1198
Junio C Hamanofedb1b42016-06-20 21:23:401199fastimport.unpackLimit::
1200If the number of objects imported by linkgit:git-fast-import[1]
1201is below this limit, then the objects will be unpacked into
1202loose object files. However if the number of imported objects
1203equals or exceeds this limit then the pack will be stored as a
1204pack. Storing the pack from a fast-import can make the import
1205operation complete faster, especially on slow filesystems. If
1206not set, the value of `transfer.unpackLimit` is used instead.
1207
Junio C Hamano0d75e872010-12-17 06:57:261208fetch.recurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:101209This option can be either set to a boolean value or to 'on-demand'.
1210Setting it to a boolean changes the behavior of fetch and pull to
1211unconditionally recurse into submodules when set to true or to not
1212recurse at all when set to false. When set to 'on-demand' (the default
1213value), fetch and pull will only recurse into a populated submodule
1214when its superproject retrieves a commit that updates the submodule's
1215reference.
Junio C Hamano0d75e872010-12-17 06:57:261216
Junio C Hamano8fb66e52011-10-05 20:59:511217fetch.fsckObjects::
1218If it is set to true, git-fetch-pack will check all fetched
1219objects. It will abort in the case of a malformed object or a
1220broken link. The result of an abort are only dangling objects.
1221Defaults to false. If not set, the value of `transfer.fsckObjects`
1222is used instead.
1223
Junio C Hamano54ea8d32007-01-25 07:59:481224fetch.unpackLimit::
Junio C Hamano076ffcc2013-02-06 05:13:211225If the number of objects fetched over the Git native
Junio C Hamano54ea8d32007-01-25 07:59:481226transfer is below this
1227limit, then the objects will be unpacked into loose object
1228files. However if the number of received objects equals or
1229exceeds this limit then the received pack will be stored as
1230a pack, after adding any missing delta bases. Storing the
1231pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:171232especially on slow filesystems. If not set, the value of
1233`transfer.unpackLimit` is used instead.
Junio C Hamano54ea8d32007-01-25 07:59:481234
Junio C Hamano8eac2682013-09-09 22:35:201235fetch.prune::
1236If true, fetch will automatically behave as if the `--prune`
1237option was given on the command line. See also `remote.<name>.prune`.
1238
Junio C Hamanof4581102009-04-25 08:29:591239format.attach::
1240Enable multipart/mixed attachments as the default for
1241'format-patch'. The value can also be a double quoted string
1242which will enable attachments as the default and set the
1243value as the boundary. See the --attach option in
1244linkgit:git-format-patch[1].
1245
Junio C Hamano8c5802d2007-11-15 00:13:361246format.numbered::
Junio C Hamano7d06a8a2008-10-20 05:42:331247A boolean which can enable or disable sequence numbers in patch
1248subjects. It defaults to "auto" which enables it only if there
1249is more than one patch. It can be enabled or disabled for all
1250messages by setting it to "true" or "false". See --numbered
1251option in linkgit:git-format-patch[1].
Junio C Hamano8c5802d2007-11-15 00:13:361252
Junio C Hamano07824ce2006-04-25 07:36:541253format.headers::
1254Additional email headers to include in a patch to be submitted
Junio C Hamano35738e82008-01-07 07:55:461255by mail. See linkgit:git-format-patch[1].
Junio C Hamano07824ce2006-04-25 07:36:541256
Junio C Hamano70664a02010-07-13 22:48:051257format.to::
Junio C Hamanof4581102009-04-25 08:29:591258format.cc::
Junio C Hamano70664a02010-07-13 22:48:051259Additional recipients to include in a patch to be submitted
1260by mail. See the --to and --cc options in
1261linkgit:git-format-patch[1].
Junio C Hamanof4581102009-04-25 08:29:591262
Junio C Hamano322c6242015-03-23 21:32:461263format.subjectPrefix::
Junio C Hamanof4581102009-04-25 08:29:591264The default for format-patch is to output files with the '[PATCH]'
1265subject prefix. Use this variable to change that prefix.
1266
Junio C Hamano89a57342010-06-22 23:22:551267format.signature::
1268The default for format-patch is to output a signature containing
Junio C Hamano076ffcc2013-02-06 05:13:211269the Git version number. Use this variable to change that default.
Junio C Hamano89a57342010-06-22 23:22:551270Set this variable to the empty string ("") to suppress
1271signature generation.
1272
Junio C Hamano322c6242015-03-23 21:32:461273format.signatureFile::
Junio C Hamanoc8c398a2014-06-16 21:14:051274Works just like format.signature except the contents of the
1275file specified by this variable will be used as the signature.
1276
Junio C Hamanod4c8e112007-03-04 10:32:381277format.suffix::
1278The default for format-patch is to output files with the suffix
1279`.patch`. Use this variable to change that suffix (make sure to
1280include the dot if you want it).
1281
Junio C Hamano86bcccc2008-03-08 09:33:551282format.pretty::
1283The default pretty format for log/show/whatchanged command,
1284See linkgit:git-log[1], linkgit:git-show[1],
1285linkgit:git-whatchanged[1].
1286
Junio C Hamanoea6a7642009-03-11 23:56:191287format.thread::
Junio C Hamano1aa40d22010-01-21 17:46:431288The default threading style for 'git format-patch'. Can be
Junio C Hamanob141a922010-01-10 19:55:141289a boolean value, or `shallow` or `deep`. `shallow` threading
1290makes every mail a reply to the head of the series,
Junio C Hamanoea6a7642009-03-11 23:56:191291where the head is chosen from the cover letter, the
Junio C Hamanob76a6862012-05-02 22:02:461292`--in-reply-to`, and the first patch mail, in this order.
Junio C Hamanof4581102009-04-25 08:29:591293`deep` threading makes every mail a reply to the previous one.
Junio C Hamanoea6a7642009-03-11 23:56:191294A true boolean value is the same as `shallow`, and a false
1295value disables threading.
1296
Junio C Hamano322c6242015-03-23 21:32:461297format.signOff::
Junio C Hamano804a9742013-04-28 23:10:311298A boolean value which lets you enable the `-s/--signoff` option of
1299format-patch by default. *Note:* Adding the Signed-off-by: line to a
1300patch should be a conscious act and means that you certify you have
1301the rights to submit this work under the same open source license.
1302Please see the 'SubmittingPatches' document for further discussion.
Junio C Hamano5f9a6f02009-04-06 08:26:561303
Junio C Hamanoea3b7522013-04-18 19:37:531304format.coverLetter::
1305A boolean that controls whether to generate a cover-letter when
1306format-patch is invoked, but in addition can be set to "auto", to
1307generate a cover-letter only when there's more than one patch.
1308
Junio C Hamano289d7e82016-01-27 00:20:381309format.outputDirectory::
1310Set a custom directory to store the resulting files instead of the
1311current working directory.
1312
Junio C Hamanof2a3a752016-05-23 22:54:391313format.useAutoBase::
1314A boolean value which lets you enable the `--base=auto` option of
1315format-patch by default.
1316
Junio C Hamano209ebe82011-04-27 21:09:591317filter.<driver>.clean::
1318The command which is used to convert the content of a worktree
1319file to a blob upon checkin. See linkgit:gitattributes[5] for
1320details.
1321
1322filter.<driver>.smudge::
1323The command which is used to convert the content of a blob
1324object to a worktree file upon checkout. See
1325linkgit:gitattributes[5] for details.
1326
Junio C Hamanod7ed4042015-08-03 19:43:001327fsck.<msg-id>::
1328Allows overriding the message type (error, warn or ignore) of a
1329specific message ID such as `missingEmail`.
1330+
1331For convenience, fsck prefixes the error/warning with the message ID,
1332e.g. "missingEmail: invalid author/committer line - missing email" means
1333that setting `fsck.missingEmail = ignore` will hide that issue.
1334+
1335This feature is intended to support working with legacy repositories
1336which cannot be repaired without disruptive changes.
1337
1338fsck.skipList::
1339The path to a sorted list of object names (i.e. one SHA-1 per
1340line) that are known to be broken in a non-fatal way and should
1341be ignored. This feature is useful when an established project
1342should be accepted despite early commits containing errors that
1343can be safely ignored such as invalid committer email addresses.
1344Note: corrupt objects cannot be skipped with this setting.
1345
Junio C Hamano624dd4c2014-04-03 21:56:301346gc.aggressiveDepth::
1347The depth parameter used in the delta compression
1348algorithm used by 'git gc --aggressive'. This defaults
1349to 250.
1350
Junio C Hamanof2ce2972007-05-20 19:12:091351gc.aggressiveWindow::
1352The window size parameter used in the delta compression
Junio C Hamano1aa40d22010-01-21 17:46:431353algorithm used by 'git gc --aggressive'. This defaults
Junio C Hamanob04bb3f2010-04-14 14:07:361354to 250.
Junio C Hamanof2ce2972007-05-20 19:12:091355
Junio C Hamano1b50ce92007-10-03 12:05:531356gc.auto::
1357When there are approximately more than this many loose
1358objects in the repository, `git gc --auto` will pack them.
1359Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:171360light-weight garbage collection from time to time. The
1361default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531362
Junio C Hamano322c6242015-03-23 21:32:461363gc.autoPackLimit::
Junio C Hamano1b50ce92007-10-03 12:05:531364When there are more than this many packs that are not
1365marked with `*.keep` file in the repository, `git gc
Junio C Hamanoe77b0152008-01-12 06:44:171366--auto` consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:371367default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531368
Junio C Hamano322c6242015-03-23 21:32:461369gc.autoDetach::
Junio C Hamanofb5ffde2014-11-04 22:38:561370Make `git gc --auto` return immediately and run in background
Junio C Hamano08ef8c22014-03-10 14:53:441371if the system supports it. Default is true.
1372
Junio C Hamano322c6242015-03-23 21:32:461373gc.packRefs::
Junio C Hamanob141a922010-01-10 19:55:141374Running `git pack-refs` in a repository renders it
1375unclonable by Git versions prior to 1.5.1.2 over dumb
1376transports such as HTTP. This variable determines whether
Junio C Hamanocdd1c332010-12-20 10:08:001377'git gc' runs `git pack-refs`. This can be set to `notbare`
Junio C Hamanob141a922010-01-10 19:55:141378to enable it within all non-bare repos or it can be set to a
1379boolean value. The default is `true`.
Junio C Hamano9d52e572007-02-13 23:48:201380
Junio C Hamano322c6242015-03-23 21:32:461381gc.pruneExpire::
Junio C Hamano1aa40d22010-01-21 17:46:431382When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
Junio C Hamanoa3148f52009-01-14 08:49:571383Override the grace period with this config variable. The value
Junio C Hamano9c512872015-08-12 21:59:251384"now" may be used to disable this grace period and always prune
1385unreachable objects immediately, or "never" may be used to
1386suppress pruning.
Junio C Hamano09a926d2008-03-13 07:55:291387
Junio C Hamano9c512872015-08-12 21:59:251388gc.worktreePruneExpire::
1389When 'git gc' is run, it calls
1390'git worktree prune --expire 3.months.ago'.
1391This config variable can be used to set a different grace
1392period. The value "now" may be used to disable the grace
Junio C Hamano198b1f12016-05-17 22:27:241393period and prune `$GIT_DIR/worktrees` immediately, or "never"
Junio C Hamano9c512872015-08-12 21:59:251394may be used to suppress pruning.
Junio C Hamano4cc4a842015-05-11 22:41:021395
Junio C Hamano322c6242015-03-23 21:32:461396gc.reflogExpire::
1397gc.<pattern>.reflogExpire::
Junio C Hamano1aa40d22010-01-21 17:46:431398'git reflog expire' removes reflog entries older than
Junio C Hamano9c512872015-08-12 21:59:251399this time; defaults to 90 days. The value "now" expires all
1400entries immediately, and "never" suppresses expiration
1401altogether. With "<pattern>" (e.g.
Junio C Hamanocc7636a2010-05-21 14:57:531402"refs/stash") in the middle the setting applies only to
1403the refs that match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551404
Junio C Hamano322c6242015-03-23 21:32:461405gc.reflogExpireUnreachable::
Junio C Hamanoa1746be2015-08-26 23:07:071406gc.<pattern>.reflogExpireUnreachable::
Junio C Hamano1aa40d22010-01-21 17:46:431407'git reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:551408this time and are not reachable from the current tip;
Junio C Hamano9c512872015-08-12 21:59:251409defaults to 30 days. The value "now" expires all entries
1410immediately, and "never" suppresses expiration altogether.
1411With "<pattern>" (e.g. "refs/stash")
Junio C Hamanocc7636a2010-05-21 14:57:531412in the middle, the setting applies only to the refs that
1413match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551414
Junio C Hamano322c6242015-03-23 21:32:461415gc.rerereResolved::
Junio C Hamano74640642006-12-27 10:59:551416Records of conflicted merge you resolved earlier are
Junio C Hamano1aa40d22010-01-21 17:46:431417kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461418The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551419
Junio C Hamano322c6242015-03-23 21:32:461420gc.rerereUnresolved::
Junio C Hamano74640642006-12-27 10:59:551421Records of conflicted merge you have not resolved are
Junio C Hamano1aa40d22010-01-21 17:46:431422kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461423The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551424
Junio C Hamano322c6242015-03-23 21:32:461425gitcvs.commitMsgAnnotation::
Junio C Hamanoa3148f52009-01-14 08:49:571426Append this string to each commit message. Set to empty string
1427to disable this feature. Defaults to "via git-CVS emulator".
1428
Junio C Hamano07824ce2006-04-25 07:36:541429gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:271430Whether the CVS server interface is enabled for this repository.
Junio C Hamano35738e82008-01-07 07:55:461431See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541432
Junio C Hamano322c6242015-03-23 21:32:461433gitcvs.logFile::
Junio C Hamanoa6387422007-08-25 03:54:271434Path to a log file where the CVS server interface well... logs
Junio C Hamano35738e82008-01-07 07:55:461435various stuff. See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541436
Junio C Hamano17bd2272008-09-01 06:11:171437gitcvs.usecrlfattr::
Junio C Hamanobb88cf42010-06-21 15:23:551438If true, the server will look up the end-of-line conversion
Junio C Hamano92d80372016-07-13 22:00:051439attributes for files to determine the `-k` modes to use. If
Junio C Hamano076ffcc2013-02-06 05:13:211440the attributes force Git to treat a file as text,
Junio C Hamano92d80372016-07-13 22:00:051441the `-k` mode will be left blank so CVS clients will
Junio C Hamanobb88cf42010-06-21 15:23:551442treat it as text. If they suppress text conversion, the file
Junio C Hamanocb1c44f2008-08-06 06:19:331443will be set with '-kb' mode, which suppresses any newline munging
Junio C Hamanobb88cf42010-06-21 15:23:551444the client might otherwise do. If the attributes do not allow
Junio C Hamano042f2142016-06-27 18:05:051445the file type to be determined, then `gitcvs.allBinary` is
Junio C Hamanobb88cf42010-06-21 15:23:551446used. See linkgit:gitattributes[5].
Junio C Hamanodfccbb02008-05-26 01:16:141447
Junio C Hamano322c6242015-03-23 21:32:461448gitcvs.allBinary::
Junio C Hamano042f2142016-06-27 18:05:051449This is used if `gitcvs.usecrlfattr` does not resolve
Junio C Hamanodfccbb02008-05-26 01:16:141450the correct '-kb' mode to use. If true, all
1451unresolved files are sent to the client in
1452mode '-kb'. This causes the client to treat them
1453as binary files, which suppresses any newline munging it
1454otherwise might do. Alternatively, if it is set to "guess",
1455then the contents of the file are examined to decide if
Junio C Hamano042f2142016-06-27 18:05:051456it is binary, similar to `core.autocrlf`.
Junio C Hamanoa2ad99e2007-04-18 09:57:041457
Junio C Hamano322c6242015-03-23 21:32:461458gitcvs.dbName::
Junio C Hamanoa2ad99e2007-04-18 09:57:041459Database used by git-cvsserver to cache revision information
Junio C Hamano076ffcc2013-02-06 05:13:211460derived from the Git repository. The exact meaning depends on the
Junio C Hamanoa2ad99e2007-04-18 09:57:041461used database driver, for SQLite (which is the default driver) this
1462is a filename. Supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461463linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Junio C Hamanoa2ad99e2007-04-18 09:57:041464Default: '%Ggitcvs.%m.sqlite'
1465
Junio C Hamano322c6242015-03-23 21:32:461466gitcvs.dbDriver::
Junio C Hamanoa2ad99e2007-04-18 09:57:041467Used Perl DBI driver. You can specify any available driver
Junio C Hamano804a9742013-04-28 23:10:311468for this here, but it might not work. git-cvsserver is tested
Junio C Hamanoa2ad99e2007-04-18 09:57:041469with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1470reported *not* to work with 'DBD::mysql'. Experimental feature.
1471May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamano35738e82008-01-07 07:55:461472See linkgit:git-cvsserver[1].
Junio C Hamanod9e0e5d2007-04-14 16:22:041473
Junio C Hamano322c6242015-03-23 21:32:461474gitcvs.dbUser, gitcvs.dbPass::
Junio C Hamano042f2142016-06-27 18:05:051475Database user and password. Only useful if setting `gitcvs.dbDriver`,
Junio C Hamanoa2ad99e2007-04-18 09:57:041476since SQLite has no concept of database users and/or passwords.
Junio C Hamano322c6242015-03-23 21:32:461477'gitcvs.dbUser' supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461478linkgit:git-cvsserver[1] for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:041479
Junio C Hamanoa74efce2008-04-02 08:39:081480gitcvs.dbTableNamePrefix::
1481Database table name prefix. Prepended to the names of any
1482database tables used, allowing a single database to be used
1483for several repositories. Supports variable substitution (see
1484linkgit:git-cvsserver[1] for details). Any non-alphabetic
1485characters will be replaced with underscores.
1486
Junio C Hamano042f2142016-06-27 18:05:051487All gitcvs variables except for `gitcvs.usecrlfattr` and
1488`gitcvs.allBinary` can also be specified as
Junio C Hamanodfccbb02008-05-26 01:16:141489'gitcvs.<access_method>.<varname>' (where 'access_method'
Junio C Hamanoa6387422007-08-25 03:54:271490is one of "ext" and "pserver") to make them apply only for the given
1491access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:041492
Junio C Hamano11821ed2011-10-19 18:42:091493gitweb.category::
1494gitweb.description::
1495gitweb.owner::
1496gitweb.url::
1497See linkgit:gitweb[1] for description.
1498
1499gitweb.avatar::
1500gitweb.blame::
1501gitweb.grep::
1502gitweb.highlight::
1503gitweb.patches::
1504gitweb.pickaxe::
1505gitweb.remote_heads::
Junio C Hamano322c6242015-03-23 21:32:461506gitweb.showSizes::
Junio C Hamano11821ed2011-10-19 18:42:091507gitweb.snapshot::
1508See linkgit:gitweb.conf[5] for description.
1509
Junio C Hamanoa03ac862011-04-02 04:32:291510grep.lineNumber::
Junio C Hamano92d80372016-07-13 22:00:051511If set to true, enable `-n` option by default.
Junio C Hamanoa03ac862011-04-02 04:32:291512
Junio C Hamanoa00504d2012-08-27 21:11:231513grep.patternType::
1514Set the default matching behavior. Using a value of 'basic', 'extended',
Junio C Hamano92d80372016-07-13 22:00:051515'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1516`--fixed-strings`, or `--perl-regexp` option accordingly, while the
Junio C Hamanoa00504d2012-08-27 21:11:231517value 'default' will return to the default matching behavior.
1518
Junio C Hamanoa03ac862011-04-02 04:32:291519grep.extendedRegexp::
Junio C Hamano92d80372016-07-13 22:00:051520If set to true, enable `--extended-regexp` option by default. This
Junio C Hamano042f2142016-06-27 18:05:051521option is ignored when the `grep.patternType` option is set to a value
Junio C Hamanoa00504d2012-08-27 21:11:231522other than 'default'.
Junio C Hamanoa03ac862011-04-02 04:32:291523
Junio C Hamanoa7da1ba2016-01-13 00:19:451524grep.threads::
1525Number of grep worker threads to use.
1526See `grep.threads` in linkgit:git-grep[1] for more information.
1527
Junio C Hamano4e6ba272016-01-20 23:23:191528grep.fallbackToNoIndex::
1529If set to true, fall back to git grep --no-index if git grep
1530is executed outside of a git repository. Defaults to false.
1531
Junio C Hamano4fd24422012-01-06 21:52:431532gpg.program::
Junio C Hamano198b1f12016-05-17 22:27:241533Use this custom program instead of "`gpg`" found on `$PATH` when
Junio C Hamano4fd24422012-01-06 21:52:431534making or verifying a PGP signature. The program must support the
Junio C Hamanoe1aeb5e2014-06-06 19:16:291535same command-line interface as GPG, namely, to verify a detached
Junio C Hamano198b1f12016-05-17 22:27:241536signature, "`gpg --verify $file - <$signature`" is run, and the
Junio C Hamano4fd24422012-01-06 21:52:431537program is expected to signal a good signature by exiting with
Junio C Hamanofb5ffde2014-11-04 22:38:561538code 0, and to generate an ASCII-armored detached signature, the
Junio C Hamano198b1f12016-05-17 22:27:241539standard input of "`gpg -bsau $key`" is fed with the contents to be
Junio C Hamano4fd24422012-01-06 21:52:431540signed, and the program is expected to send the result to its
1541standard output.
1542
Junio C Hamano322c6242015-03-23 21:32:461543gui.commitMsgWidth::
Junio C Hamano6d76d612008-05-09 05:46:081544Defines how wide the commit message window is in the
1545linkgit:git-gui[1]. "75" is the default.
1546
Junio C Hamano322c6242015-03-23 21:32:461547gui.diffContext::
Junio C Hamano6d76d612008-05-09 05:46:081548Specifies how many context lines should be used in calls to diff
1549made by the linkgit:git-gui[1]. The default is "5".
1550
Junio C Hamano322c6242015-03-23 21:32:461551gui.displayUntracked::
Junio C Hamano198b1f12016-05-17 22:27:241552Determines if linkgit:git-gui[1] shows untracked files
Junio C Hamano796c55f2014-05-02 21:45:151553in the file list. The default is "true".
1554
Junio C Hamanod3452a02008-11-15 08:07:551555gui.encoding::
1556Specifies the default encoding to use for displaying of
1557file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1558It can be overridden by setting the 'encoding' attribute
1559for relevant files (see linkgit:gitattributes[5]).
1560If this option is not set, the tools default to the
1561locale encoding.
1562
Junio C Hamano322c6242015-03-23 21:32:461563gui.matchTrackingBranch::
Junio C Hamano6d76d612008-05-09 05:46:081564Determines if new branches created with linkgit:git-gui[1] should
1565default to tracking remote branches with matching names or
1566not. Default: "false".
1567
Junio C Hamano322c6242015-03-23 21:32:461568gui.newBranchTemplate::
Junio C Hamano6d76d612008-05-09 05:46:081569Is used as suggested name when creating new branches using the
1570linkgit:git-gui[1].
1571
Junio C Hamano322c6242015-03-23 21:32:461572gui.pruneDuringFetch::
Junio C Hamano97bcb482010-11-25 03:16:071573"true" if linkgit:git-gui[1] should prune remote-tracking branches when
Junio C Hamano6d76d612008-05-09 05:46:081574performing a fetch. The default value is "false".
1575
1576gui.trustmtime::
1577Determines if linkgit:git-gui[1] should trust the file modification
1578timestamp or not. By default the timestamps are not trusted.
1579
Junio C Hamano322c6242015-03-23 21:32:461580gui.spellingDictionary::
Junio C Hamano6d76d612008-05-09 05:46:081581Specifies the dictionary used for spell checking commit messages in
1582the linkgit:git-gui[1]. When set to "none" spell checking is turned
1583off.
1584
Junio C Hamano322c6242015-03-23 21:32:461585gui.fastCopyBlame::
Junio C Hamano1aa40d22010-01-21 17:46:431586If true, 'git gui blame' uses `-C` instead of `-C -C` for original
Junio C Hamanod3452a02008-11-15 08:07:551587location detection. It makes blame significantly faster on huge
1588repositories at the expense of less thorough copy detection.
1589
Junio C Hamano322c6242015-03-23 21:32:461590gui.copyBlameThreshold::
Junio C Hamano610d1762008-11-28 06:27:131591Specifies the threshold to use in 'git gui blame' original location
Junio C Hamanod3452a02008-11-15 08:07:551592detection, measured in alphanumeric characters. See the
1593linkgit:git-blame[1] manual for more information on copy detection.
1594
1595gui.blamehistoryctx::
1596Specifies the radius of history context in days to show in
1597linkgit:gitk[1] for the selected commit, when the `Show History
1598Context` menu item is invoked from 'git gui blame'. If this
1599variable is set to zero, the whole history is shown.
1600
Junio C Hamano92d312a2008-12-15 07:22:201601guitool.<name>.cmd::
1602Specifies the shell command line to execute when the corresponding item
1603of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1604mandatory for every tool. The command is executed from the root of
1605the working directory, and in the environment it receives the name of
Junio C Hamano042f2142016-06-27 18:05:051606the tool as `GIT_GUITOOL`, the name of the currently selected file as
Junio C Hamano92d312a2008-12-15 07:22:201607'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1608the head is detached, 'CUR_BRANCH' is empty).
1609
Junio C Hamano322c6242015-03-23 21:32:461610guitool.<name>.needsFile::
Junio C Hamano92d312a2008-12-15 07:22:201611Run the tool only if a diff is selected in the GUI. It guarantees
1612that 'FILENAME' is not empty.
1613
Junio C Hamano322c6242015-03-23 21:32:461614guitool.<name>.noConsole::
Junio C Hamano92d312a2008-12-15 07:22:201615Run the command silently, without creating a window to display its
1616output.
1617
Junio C Hamano322c6242015-03-23 21:32:461618guitool.<name>.noRescan::
Junio C Hamano92d312a2008-12-15 07:22:201619Don't rescan the working directory for changes after the tool
1620finishes execution.
1621
1622guitool.<name>.confirm::
1623Show a confirmation dialog before actually running the tool.
1624
Junio C Hamano322c6242015-03-23 21:32:461625guitool.<name>.argPrompt::
Junio C Hamano92d312a2008-12-15 07:22:201626Request a string argument from the user, and pass it to the tool
Junio C Hamano042f2142016-06-27 18:05:051627through the `ARGS` environment variable. Since requesting an
Junio C Hamano92d312a2008-12-15 07:22:201628argument implies confirmation, the 'confirm' option has no effect
1629if this is enabled. If the option is set to 'true', 'yes', or '1',
1630the dialog uses a built-in generic prompt; otherwise the exact
1631value of the variable is used.
1632
Junio C Hamano322c6242015-03-23 21:32:461633guitool.<name>.revPrompt::
Junio C Hamano92d312a2008-12-15 07:22:201634Request a single valid revision from the user, and set the
Junio C Hamano042f2142016-06-27 18:05:051635`REVISION` environment variable. In other aspects this option
Junio C Hamano322c6242015-03-23 21:32:461636is similar to 'argPrompt', and can be used together with it.
Junio C Hamano92d312a2008-12-15 07:22:201637
Junio C Hamano322c6242015-03-23 21:32:461638guitool.<name>.revUnmerged::
1639Show only unmerged branches in the 'revPrompt' subdialog.
Junio C Hamano92d312a2008-12-15 07:22:201640This is useful for tools similar to merge or rebase, but not
1641for things like checkout or reset.
1642
1643guitool.<name>.title::
1644Specifies the title to use for the prompt dialog. The default
1645is the tool name.
1646
1647guitool.<name>.prompt::
1648Specifies the general prompt string to display at the top of
Junio C Hamano322c6242015-03-23 21:32:461649the dialog, before subsections for 'argPrompt' and 'revPrompt'.
Junio C Hamano92d312a2008-12-15 07:22:201650The default value includes the actual command.
1651
Junio C Hamano4e272312008-01-08 09:13:211652help.browser::
1653Specify the browser that will be used to display help in the
1654'web' format. See linkgit:git-help[1].
1655
1656help.format::
1657Override the default help format used by linkgit:git-help[1].
1658Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1659the default. 'web' and 'html' are the same.
1660
Junio C Hamano322c6242015-03-23 21:32:461661help.autoCorrect::
Junio C Hamanof24b8062008-09-09 01:34:391662Automatically correct and execute mistyped commands after
1663waiting for the given number of deciseconds (0.1 sec). If more
1664than one command can be deduced from the entered text, nothing
1665will be executed. If the value of this option is negative,
1666the corrected command will be executed immediately. If the
1667value is 0 - the command will be just shown but not executed.
1668This is the default.
1669
Junio C Hamano322c6242015-03-23 21:32:461670help.htmlPath::
Junio C Hamano5dd5fae2013-01-18 21:06:491671Specify the path where the HTML documentation resides. File system paths
1672and URLs are supported. HTML pages will be prefixed with this path when
1673help is displayed in the 'web' format. This defaults to the documentation
1674path of your Git installation.
1675
Junio C Hamano58256872007-12-04 08:31:131676http.proxy::
Junio C Hamano3dd93922012-03-05 07:49:111677Override the HTTP proxy, normally configured using the 'http_proxy',
Junio C Hamanoffe10ca2016-02-04 00:44:231678'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1679addition to the syntax understood by curl, it is possible to specify a
1680proxy string with a user name but no password, in which case git will
1681attempt to acquire one in the same way it does for other credentials. See
1682linkgit:gitcredentials[7] for more information. The syntax thus is
1683'[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1684on a per-remote basis; see remote.<name>.proxy
1685
1686http.proxyAuthMethod::
1687Set the method with which to authenticate against the HTTP proxy. This
1688only takes effect if the configured proxy string contains a user name part
1689(i.e. is of the form 'user@host' or 'user@host:port'). This can be
1690overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
Junio C Hamano042f2142016-06-27 18:05:051691Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
Junio C Hamanoffe10ca2016-02-04 00:44:231692variable. Possible values are:
1693+
1694--
1695* `anyauth` - Automatically pick a suitable authentication method. It is
1696 assumed that the proxy answers an unauthenticated request with a 407
1697 status code and one or more Proxy-authenticate headers with supported
1698 authentication methods. This is the default.
1699* `basic` - HTTP Basic authentication
1700* `digest` - HTTP Digest authentication; this prevents the password from being
1701 transmitted to the proxy in clear text
1702* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1703 of `curl(1)`)
1704* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1705--
Junio C Hamano58256872007-12-04 08:31:131706
Junio C Hamano3fcdd072016-02-24 23:41:081707http.emptyAuth::
1708Attempt authentication without seeking a username or password. This
1709can be used to attempt GSS-Negotiate authentication without specifying
1710a username in the URL, as libcurl normally requires a username for
1711authentication.
1712
Junio C Hamanoccdabca2016-05-06 22:27:091713http.extraHeader::
1714Pass an additional HTTP header when communicating with a server. If
1715more than one such entry exists, all of them are added as extra
1716headers. To allow overriding the settings inherited from the system
1717config, an empty value will reset the extra headers to the empty list.
1718
Junio C Hamano322c6242015-03-23 21:32:461719http.cookieFile::
Junio C Hamano198b1f12016-05-17 22:27:241720The pathname of a file containing previously stored cookie lines,
1721which should be used
Junio C Hamano076ffcc2013-02-06 05:13:211722in the Git http session, if they match the server. The file format
Junio C Hamano4c4b0122011-06-30 01:19:321723of the file to read cookies from should be plain HTTP headers or
Junio C Hamano198b1f12016-05-17 22:27:241724the Netscape/Mozilla cookie file format (see `curl(1)`).
1725NOTE that the file specified with http.cookieFile is used only as
Junio C Hamano8eac2682013-09-09 22:35:201726input unless http.saveCookies is set.
1727
Junio C Hamano322c6242015-03-23 21:32:461728http.saveCookies::
Junio C Hamano8eac2682013-09-09 22:35:201729If set, store cookies received during requests to the file specified by
Junio C Hamano322c6242015-03-23 21:32:461730http.cookieFile. Has no effect if http.cookieFile is unset.
Junio C Hamano4c4b0122011-06-30 01:19:321731
Junio C Hamanoa1746be2015-08-26 23:07:071732http.sslVersion::
1733The SSL version to use when negotiating an SSL connection, if you
1734want to force the default. The available and default version
1735depend on whether libcurl was built against NSS or OpenSSL and the
1736particular configuration of the crypto library in use. Internally
1737this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1738documentation for more details on the format of this option and
1739for the ssl version supported. Actually the possible values of
1740this option are:
1741
1742- sslv2
1743- sslv3
1744- tlsv1
1745- tlsv1.0
1746- tlsv1.1
1747- tlsv1.2
1748
1749+
Junio C Hamano042f2142016-06-27 18:05:051750Can be overridden by the `GIT_SSL_VERSION` environment variable.
Junio C Hamanoa1746be2015-08-26 23:07:071751To force git to use libcurl's default ssl version and ignore any
Junio C Hamano042f2142016-06-27 18:05:051752explicit http.sslversion option, set `GIT_SSL_VERSION` to the
Junio C Hamanoa1746be2015-08-26 23:07:071753empty string.
1754
Junio C Hamano1dbca522015-05-22 20:48:551755http.sslCipherList::
1756 A list of SSL ciphers to use when negotiating an SSL connection.
1757 The available ciphers depend on whether libcurl was built against
1758 NSS or OpenSSL and the particular configuration of the crypto
1759 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1760 option; see the libcurl documentation for more details on the format
1761 of this list.
1762+
Junio C Hamano042f2142016-06-27 18:05:051763Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
Junio C Hamano1dbca522015-05-22 20:48:551764To force git to use libcurl's default cipher list and ignore any
Junio C Hamano042f2142016-06-27 18:05:051765explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
Junio C Hamano1dbca522015-05-22 20:48:551766empty string.
1767
Junio C Hamano07824ce2006-04-25 07:36:541768http.sslVerify::
1769Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano042f2142016-06-27 18:05:051770over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment
Junio C Hamano07824ce2006-04-25 07:36:541771variable.
1772
1773http.sslCert::
1774File containing the SSL certificate when fetching or pushing
Junio C Hamano042f2142016-06-27 18:05:051775over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
Junio C Hamano07824ce2006-04-25 07:36:541776variable.
1777
1778http.sslKey::
1779File containing the SSL private key when fetching or pushing
Junio C Hamano042f2142016-06-27 18:05:051780over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
Junio C Hamano07824ce2006-04-25 07:36:541781variable.
1782
Junio C Hamano48bc1ce2009-07-09 16:49:191783http.sslCertPasswordProtected::
Junio C Hamano076ffcc2013-02-06 05:13:211784Enable Git's password prompt for the SSL certificate. Otherwise
Junio C Hamano48bc1ce2009-07-09 16:49:191785OpenSSL will prompt the user, possibly many times, if the
1786certificate or private key is encrypted. Can be overridden by the
Junio C Hamano042f2142016-06-27 18:05:051787`GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
Junio C Hamano48bc1ce2009-07-09 16:49:191788
Junio C Hamano07824ce2006-04-25 07:36:541789http.sslCAInfo::
1790File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:481791fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano042f2142016-06-27 18:05:051792`GIT_SSL_CAINFO` environment variable.
Junio C Hamano07824ce2006-04-25 07:36:541793
1794http.sslCAPath::
1795Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:451796with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano042f2142016-06-27 18:05:051797by the `GIT_SSL_CAPATH` environment variable.
Junio C Hamano07824ce2006-04-25 07:36:541798
Junio C Hamano3fcdd072016-02-24 23:41:081799http.pinnedpubkey::
1800Public key of the https service. It may either be the filename of
1801a PEM or DER encoded public key file or a string starting with
1802'sha256//' followed by the base64 encoded sha256 hash of the
1803public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
1804exit with an error if this option is set but not supported by
1805cURL.
1806
Junio C Hamano76927822013-04-19 21:26:571807http.sslTry::
1808Attempt to use AUTH SSL/TLS and encrypted data transfers
1809when connecting via regular FTP protocol. This might be needed
1810if the FTP server requires it for security reasons or you wish
1811to connect securely whenever remote FTP server supports it.
1812Default is false since it might trigger certificate verification
1813errors on misconfigured servers.
1814
Junio C Hamano07824ce2006-04-25 07:36:541815http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:481816How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano042f2142016-06-27 18:05:051817by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
Junio C Hamano07824ce2006-04-25 07:36:541818
Junio C Hamanob141a922010-01-10 19:55:141819http.minSessions::
1820The number of curl sessions (counted across slots) to be kept across
1821requests. They will not be ended with curl_easy_cleanup() until
1822http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1823value will be capped at 1. Defaults to 1.
1824
Junio C Hamano3b70d3c2009-11-21 17:37:371825http.postBuffer::
1826Maximum size in bytes of the buffer used by smart HTTP
1827transports when POSTing data to the remote system.
1828For requests larger than this buffer size, HTTP/1.1 and
1829Transfer-Encoding: chunked is used to avoid creating a
1830massive pack file locally. Default is 1 MiB, which is
1831sufficient for most requests.
1832
Junio C Hamano07824ce2006-04-25 07:36:541833http.lowSpeedLimit, http.lowSpeedTime::
1834If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1835for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano042f2142016-06-27 18:05:051836Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
1837`GIT_HTTP_LOW_SPEED_TIME` environment variables.
Junio C Hamano07824ce2006-04-25 07:36:541838
Junio C Hamanof1dcdfe2006-09-29 08:10:511839http.noEPSV::
1840A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:041841This can helpful with some "poor" ftp servers which don't
Junio C Hamano042f2142016-06-27 18:05:051842support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
Junio C Hamanof1dcdfe2006-09-29 08:10:511843environment variable. Default is false (curl will use EPSV).
1844
Junio C Hamano322c6242015-03-23 21:32:461845http.userAgent::
Junio C Hamano53ba6d02010-08-22 07:25:121846The HTTP USER_AGENT string presented to an HTTP server. The default
Junio C Hamano076ffcc2013-02-06 05:13:211847value represents the version of the client Git such as git/1.7.1.
Junio C Hamano53ba6d02010-08-22 07:25:121848This option allows you to override this value to a more common value
1849such as Mozilla/4.0. This may be necessary, for instance, if
1850connecting through a firewall that restricts HTTP connections to a set
1851of common USER_AGENT strings (but not including those like git/1.7.1).
Junio C Hamano042f2142016-06-27 18:05:051852Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
Junio C Hamano53ba6d02010-08-22 07:25:121853
Junio C Hamano8eac2682013-09-09 22:35:201854http.<url>.*::
Junio C Hamanofb5ffde2014-11-04 22:38:561855Any of the http.* options above can be applied selectively to some URLs.
Junio C Hamano8eac2682013-09-09 22:35:201856For a config key to match a URL, each element of the config key is
1857compared to that of the URL, in the following order:
1858+
1859--
1860. Scheme (e.g., `https` in `https://example.com/`). This field
1861 must match exactly between the config key and the URL.
1862
1863. Host/domain name (e.g., `example.com` in `https://example.com/`).
1864 This field must match exactly between the config key and the URL.
1865
1866. Port number (e.g., `8080` in `http://example.com:8080/`).
1867 This field must match exactly between the config key and the URL.
1868 Omitted port numbers are automatically converted to the correct
1869 default for the scheme before matching.
1870
1871. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1872 path field of the config key must match the path field of the URL
1873 either exactly or as a prefix of slash-delimited path elements. This means
1874 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1875 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1876 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1877 key with just path `foo/`).
1878
1879. User name (e.g., `user` in `https://user@example.com/repo.git`). If
1880 the config key has a user name it must match the user name in the
1881 URL exactly. If the config key does not have a user name, that
1882 config key will match a URL with any user name (including none),
1883 but at a lower precedence than a config key with a user name.
1884--
1885+
1886The list above is ordered by decreasing precedence; a URL that matches
1887a config key's path is preferred to one that matches its user name. For example,
1888if the URL is `https://user@example.com/foo/bar` a config key match of
1889`https://example.com/foo` will be preferred over a config key match of
1890`https://user@example.com`.
1891+
1892All URLs are normalized before attempting any matching (the password part,
1893if embedded in the URL, is always ignored for matching purposes) so that
Junio C Hamanofb5ffde2014-11-04 22:38:561894equivalent URLs that are simply spelled differently will match properly.
1895Environment variable settings always override any matches. The URLs that are
Junio C Hamano8eac2682013-09-09 22:35:201896matched against are those given directly to Git commands. This means any URLs
1897visited as a result of a redirection do not participate in matching.
1898
Junio C Hamano07824ce2006-04-25 07:36:541899i18n.commitEncoding::
Junio C Hamano076ffcc2013-02-06 05:13:211900Character encoding the commit messages are stored in; Git itself
Junio C Hamano07824ce2006-04-25 07:36:541901does not care per se, but this information is necessary e.g. when
1902importing commits from emails or in the gitk graphical history
1903browser (and possibly at other places in the future or in other
Junio C Hamano35738e82008-01-07 07:55:461904porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Junio C Hamano07824ce2006-04-25 07:36:541905
Junio C Hamano51f92e22006-12-29 05:18:281906i18n.logOutputEncoding::
1907Character encoding the commit messages are converted to when
Junio C Hamano1aa40d22010-01-21 17:46:431908running 'git log' and friends.
Junio C Hamano51f92e22006-12-29 05:18:281909
Junio C Hamano4653c6f2008-11-26 22:50:201910imap::
1911The configuration variables in the 'imap' section are described
1912in linkgit:git-imap-send[1].
1913
Junio C Hamano81703b22014-03-14 22:00:271914index.version::
1915Specify the version with which new index files should be
1916initialized. This does not affect existing repositories.
1917
Junio C Hamano322c6242015-03-23 21:32:461918init.templateDir::
Junio C Hamanocaa712a2010-03-11 01:17:351919Specify the directory from which templates will be copied.
1920(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1921
Junio C Hamano4e272312008-01-08 09:13:211922instaweb.browser::
1923Specify the program that will be used to browse your working
1924repository in gitweb. See linkgit:git-instaweb[1].
1925
1926instaweb.httpd::
1927The HTTP daemon command-line to start gitweb on your working
1928repository. See linkgit:git-instaweb[1].
1929
1930instaweb.local::
1931If true the web server started by linkgit:git-instaweb[1] will
1932be bound to the local IP (127.0.0.1).
1933
Junio C Hamano322c6242015-03-23 21:32:461934instaweb.modulePath::
Junio C Hamano619596a2010-08-18 22:15:351935The default module path for linkgit:git-instaweb[1] to use
1936instead of /usr/lib/apache2/modules. Only used if httpd
1937is Apache.
Junio C Hamano4e272312008-01-08 09:13:211938
1939instaweb.port::
1940The port number to bind the gitweb httpd to. See
1941linkgit:git-instaweb[1].
1942
Junio C Hamano322c6242015-03-23 21:32:461943interactive.singleKey::
Junio C Hamano27a128b2009-08-13 01:23:001944In interactive commands, allow the user to provide one-letter
Junio C Hamanoe5bf6c12009-02-07 21:43:101945input with a single key (i.e., without hitting enter).
Junio C Hamanob76a6862012-05-02 22:02:461946Currently this is used by the `--patch` mode of
Junio C Hamano3d050d62011-05-17 06:43:341947linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1948linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1949setting is silently ignored if portable keystroke input
Junio C Hamano81703b22014-03-14 22:00:271950is not available; requires the Perl module Term::ReadKey.
Junio C Hamanoe5bf6c12009-02-07 21:43:101951
Junio C Hamano4ba4a782016-04-03 19:11:321952interactive.diffFilter::
1953When an interactive command (such as `git add --patch`) shows
1954a colorized diff, git will pipe the diff through the shell
1955command defined by this configuration variable. The command may
1956mark up the diff further for human consumption, provided that it
1957retains a one-to-one correspondence with the lines in the
1958original diff. Defaults to disabled (no filtering).
1959
Junio C Hamanof93530e2011-05-25 23:59:591960log.abbrevCommit::
1961If true, makes linkgit:git-log[1], linkgit:git-show[1], and
Junio C Hamanob76a6862012-05-02 22:02:461962linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1963override this option with `--no-abbrev-commit`.
Junio C Hamanof93530e2011-05-25 23:59:591964
Junio C Hamanob713ff12008-05-24 01:12:301965log.date::
Junio C Hamano2db3e752010-09-03 21:33:061966Set the default date-time mode for the 'log' command.
1967Setting a value for log.date is similar to using 'git log''s
Junio C Hamano1eb56092015-10-05 20:39:531968`--date` option. See linkgit:git-log[1] for details.
Junio C Hamanob713ff12008-05-24 01:12:301969
Junio C Hamanocb39aea2010-05-09 07:24:481970log.decorate::
1971Print out the ref names of any commits that are shown by the log
1972command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1973'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1974specified, the full ref name (including prefix) will be printed.
Junio C Hamano37cf4082016-05-30 01:22:141975If 'auto' is specified, then if the output is going to a terminal,
1976the ref names are shown as if 'short' were given, otherwise no ref
Junio C Hamano92d80372016-07-13 22:00:051977names are shown. This is the same as the `--decorate` option
Junio C Hamano37cf4082016-05-30 01:22:141978of the `git log`.
Junio C Hamanocb39aea2010-05-09 07:24:481979
Junio C Hamanob0a1e832015-10-15 23:08:311980log.follow::
1981If `true`, `git log` will act as if the `--follow` option was used when
1982a single <path> is given. This has the same limitations as `--follow`,
1983i.e. it cannot be used to follow multiple files and does not work well
1984on non-linear history.
1985
Junio C Hamano322c6242015-03-23 21:32:461986log.showRoot::
Junio C Hamanofe9acab2006-11-24 12:10:551987If true, the initial commit will be shown as a big creation event.
1988This is equivalent to a diff against an empty tree.
Junio C Hamano35738e82008-01-07 07:55:461989Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Junio C Hamanofe9acab2006-11-24 12:10:551990normally hide the root commit will now show it. True by default.
1991
Junio C Hamanoce836cc2013-01-21 02:01:531992log.mailmap::
1993If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1994linkgit:git-whatchanged[1] assume `--use-mailmap`.
1995
Junio C Hamano7f1bc9d2015-03-05 22:38:261996mailinfo.scissors::
1997If true, makes linkgit:git-mailinfo[1] (and therefore
1998linkgit:git-am[1]) act by default as if the --scissors option
1999was provided on the command-line. When active, this features
2000removes everything from the message body before a scissors
2001line (i.e. consisting mainly of ">8", "8<" and "-").
2002
Junio C Hamano8bc410e2009-02-15 10:38:192003mailmap.file::
2004The location of an augmenting mailmap file. The default
2005mailmap, located in the root of the repository, is loaded
2006first, then the mailmap file pointed to by this variable.
2007The location of the mailmap file may be in a repository
2008subdirectory, or somewhere outside of the repository itself.
2009See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2010
Junio C Hamanoabad6da2013-01-06 09:06:322011mailmap.blob::
2012Like `mailmap.file`, but consider the value as a reference to a
2013blob in the repository. If both `mailmap.file` and
2014`mailmap.blob` are given, both are parsed, with entries from
2015`mailmap.file` taking precedence. In a bare repository, this
2016defaults to `HEAD:.mailmap`. In a non-bare repository, it
2017defaults to empty.
2018
Junio C Hamano8b588d52008-03-15 09:48:372019man.viewer::
2020Specify the programs that may be used to display help in the
2021'man' format. See linkgit:git-help[1].
2022
Junio C Hamano6d76d612008-05-09 05:46:082023man.<tool>.cmd::
2024Specify the command to invoke the specified man viewer. The
2025specified command is evaluated in shell with the man page
2026passed as argument. (See linkgit:git-help[1].)
Junio C Hamano103ad7f2007-03-14 11:19:262027
Junio C Hamano6d76d612008-05-09 05:46:082028man.<tool>.path::
2029Override the path for the given tool that may be used to
2030display help in the 'man' format. See linkgit:git-help[1].
Junio C Hamanoe90436a2007-04-22 07:22:132031
Junio C Hamano4653c6f2008-11-26 22:50:202032include::merge-config.txt[]
Junio C Hamanoa476efa2008-10-10 15:31:422033
Junio C Hamano1fbbbc12007-12-18 07:01:272034mergetool.<tool>.path::
2035Override the path for the given tool. This is useful in case
2036your tool is not in the PATH.
2037
Junio C Hamano86bcccc2008-03-08 09:33:552038mergetool.<tool>.cmd::
2039Specify the command to invoke the specified merge tool. The
2040specified command is evaluated in shell with the following
2041variables available: 'BASE' is the name of a temporary file
2042containing the common base of the files to be merged, if available;
2043'LOCAL' is the name of a temporary file containing the contents of
2044the file on the current branch; 'REMOTE' is the name of a temporary
2045file containing the contents of the file from the branch being
2046merged; 'MERGED' contains the name of the file to which the merge
2047tool should write the results of a successful merge.
2048
2049mergetool.<tool>.trustExitCode::
2050For a custom merge command, specify whether the exit code of
2051the merge command can be used to determine whether the merge was
2052successful. If this is not set to true then the merge target file
2053timestamp is checked and the merge assumed to have been successful
2054if the file has been updated, otherwise the user is prompted to
2055indicate the success of the merge.
2056
Junio C Hamanoe478e402014-10-21 22:14:452057mergetool.meld.hasOutput::
2058Older versions of `meld` do not support the `--output` option.
2059Git will attempt to detect whether `meld` supports `--output`
2060by inspecting the output of `meld --help`. Configuring
2061`mergetool.meld.hasOutput` will make Git skip these checks and
2062use the configured value instead. Setting `mergetool.meld.hasOutput`
2063to `true` tells Git to unconditionally use the `--output` option,
2064and `false` avoids using `--output`.
2065
Junio C Hamano86bcccc2008-03-08 09:33:552066mergetool.keepBackup::
2067After performing a merge, the original file with conflict markers
2068can be saved as a file with a `.orig` extension. If this variable
2069is set to `false` then this file is not preserved. Defaults to
2070`true` (i.e. keep the backup files).
2071
Junio C Hamano10b7a342009-01-01 22:05:172072mergetool.keepTemporaries::
Junio C Hamano076ffcc2013-02-06 05:13:212073When invoking a custom merge tool, Git uses a set of temporary
Junio C Hamano10b7a342009-01-01 22:05:172074files to pass to the tool. If the tool returns an error and this
2075variable is set to `true`, then these temporary files will be
2076preserved, otherwise they will be removed after the tool has
2077exited. Defaults to `false`.
2078
Junio C Hamanoe478e402014-10-21 22:14:452079mergetool.writeToTemp::
2080Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2081conflicting files in the worktree by default. Git will attempt
2082to use a temporary directory for these files when set `true`.
2083Defaults to `false`.
2084
Junio C Hamano10b7a342009-01-01 22:05:172085mergetool.prompt::
2086Prompt before each invocation of the merge resolution program.
2087
Junio C Hamano3891e252015-08-31 23:06:132088notes.mergeStrategy::
2089Which merge strategy to choose by default when resolving notes
2090conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2091`cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2092section of linkgit:git-notes[1] for more information on each strategy.
2093
2094notes.<name>.mergeStrategy::
2095Which merge strategy to choose when doing a notes merge into
2096refs/notes/<name>. This overrides the more general
2097"notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2098linkgit:git-notes[1] for more information on the available strategies.
2099
Junio C Hamano31667362010-03-25 00:38:532100notes.displayRef::
2101The (fully qualified) refname from which to show notes when
2102showing commit messages. The value of this variable can be set
2103to a glob, in which case notes from all matching refs will be
2104shown. You may also specify this configuration variable
2105several times. A warning will be issued for refs that do not
2106exist, but a glob that does not match any refs is silently
2107ignored.
2108+
2109This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2110environment variable, which must be a colon separated list of refs or
2111globs.
2112+
2113The effective value of "core.notesRef" (possibly overridden by
2114GIT_NOTES_REF) is also implicitly added to the list of refs to be
2115displayed.
2116
2117notes.rewrite.<command>::
2118When rewriting commits with <command> (currently `amend` or
Junio C Hamano076ffcc2013-02-06 05:13:212119`rebase`) and this variable is set to `true`, Git
Junio C Hamano31667362010-03-25 00:38:532120automatically copies your notes from the original to the
2121rewritten commit. Defaults to `true`, but see
2122"notes.rewriteRef" below.
Junio C Hamano31667362010-03-25 00:38:532123
2124notes.rewriteMode::
2125When copying notes during a rewrite (see the
2126"notes.rewrite.<command>" option), determines what to do if
2127the target commit already has a note. Must be one of
Junio C Hamano3891e252015-08-31 23:06:132128`overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2129Defaults to `concatenate`.
Junio C Hamano31667362010-03-25 00:38:532130+
2131This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2132environment variable.
2133
2134notes.rewriteRef::
2135When copying notes during a rewrite, specifies the (fully
2136qualified) ref whose notes should be copied. The ref may be a
2137glob, in which case notes in all matching refs will be copied.
2138You may also specify this configuration several times.
2139+
2140Does not have a default value; you must configure this variable to
Junio C Hamano8fb66e52011-10-05 20:59:512141enable note rewriting. Set it to `refs/notes/commits` to enable
2142rewriting for the default commit notes.
Junio C Hamano2b3ee5d2010-05-08 05:41:182143+
2144This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2145environment variable, which must be a colon separated list of refs or
2146globs.
Junio C Hamano31667362010-03-25 00:38:532147
Junio C Hamano75cc4c92006-07-24 08:25:032148pack.window::
Junio C Hamano35738e82008-01-07 07:55:462149The size of the window used by linkgit:git-pack-objects[1] when no
Junio C Hamano75cc4c92006-07-24 08:25:032150window size is given on the command line. Defaults to 10.
2151
Junio C Hamano91d44c52007-05-09 07:16:072152pack.depth::
Junio C Hamano35738e82008-01-07 07:55:462153The maximum delta depth used by linkgit:git-pack-objects[1] when no
Junio C Hamano91d44c52007-05-09 07:16:072154maximum depth is given on the command line. Defaults to 50.
2155
Junio C Hamano235d53f2007-07-13 00:25:152156pack.windowMemory::
Junio C Hamano2a4bcbc2014-10-29 20:07:392157The maximum size of memory that is consumed by each thread
2158in linkgit:git-pack-objects[1] for pack window memory when
2159no limit is given on the command line. The value can be
2160suffixed with "k", "m", or "g". When left unconfigured (or
2161set explicitly to 0), there will be no limit.
Junio C Hamano235d53f2007-07-13 00:25:152162
Junio C Hamanof2ce2972007-05-20 19:12:092163pack.compression::
2164An integer -1..9, indicating the compression level for objects
2165in a pack file. -1 is the zlib default. 0 means no
2166compression, and 1..9 are various speed/size tradeoffs, 9 being
2167slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:422168not set, defaults to -1, the zlib default, which is "a default
2169compromise between speed and compression (currently equivalent
2170to level 6)."
Junio C Hamano657fd8a2010-10-07 00:01:242171+
2172Note that changing the compression level will not automatically recompress
2173all existing objects. You can force recompression by passing the -F option
2174to linkgit:git-repack[1].
Junio C Hamanof2ce2972007-05-20 19:12:092175
Junio C Hamano679d22d2007-06-02 21:13:442176pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:272177The maximum memory in bytes used for caching deltas in
Junio C Hamano9f883862009-08-11 06:23:522178linkgit:git-pack-objects[1] before writing them out to a pack.
2179This cache is used to speed up the writing object phase by not
2180having to recompute the final delta result once the best match
2181for all objects is found. Repacking large repositories on machines
2182which are tight with memory might be badly impacted by this though,
2183especially if this cache pushes the system into swapping.
2184A value of 0 means no limit. The smallest size of 1 byte may be
2185used to virtually disable this cache. Defaults to 256 MiB.
Junio C Hamano679d22d2007-06-02 21:13:442186
2187pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:142188The maximum size of a delta, that is cached in
Junio C Hamano9f883862009-08-11 06:23:522189linkgit:git-pack-objects[1]. This cache is used to speed up the
2190writing object phase by not having to recompute the final delta
2191result once the best match for all objects is found. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:442192
Junio C Hamano58155b42007-09-15 07:46:142193pack.threads::
2194Specifies the number of threads to spawn when searching for best
Junio C Hamano35738e82008-01-07 07:55:462195delta matches. This requires that linkgit:git-pack-objects[1]
Junio C Hamano58155b42007-09-15 07:46:142196be compiled with pthreads otherwise this option is ignored with a
2197warning. This is meant to reduce packing time on multiprocessor
2198machines. The required amount of memory for the delta search window
2199is however multiplied by the number of threads.
Junio C Hamano076ffcc2013-02-06 05:13:212200Specifying 0 will cause Git to auto-detect the number of CPU's
Junio C Hamano24bc09a2008-02-28 00:27:442201and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:142202
Junio C Hamanod814b6d2007-11-04 11:13:492203pack.indexVersion::
2204Specify the default pack index version. Valid values are 1 for
2205legacy pack index used by Git versions prior to 1.5.2, and 2 for
2206the new pack index with capabilities for packs larger than 4 GB
2207as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:382208packs. Version 2 is the default. Note that version 2 is enforced
2209and this config option ignored whenever the corresponding pack is
2210larger than 2 GB.
2211+
Junio C Hamano076ffcc2013-02-06 05:13:212212If you have an old Git that does not understand the version 2 `*.idx` file,
Junio C Hamanof85ef632016-02-17 22:31:062213cloning or fetching over a non native protocol (e.g. "http")
Junio C Hamanob76a6862012-05-02 22:02:462214that will copy both `*.pack` file and corresponding `*.idx` file from the
Junio C Hamanofce7c7e2008-07-02 03:06:382215other side may give you a repository that cannot be accessed with your
Junio C Hamano076ffcc2013-02-06 05:13:212216older version of Git. If the `*.pack` file is smaller than 2 GB, however,
Junio C Hamanofce7c7e2008-07-02 03:06:382217you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
Junio C Hamanob76a6862012-05-02 22:02:462218the `*.idx` file.
Junio C Hamanod814b6d2007-11-04 11:13:492219
Junio C Hamano09a926d2008-03-13 07:55:292220pack.packSizeLimit::
Junio C Hamano4d979582010-02-04 06:27:292221The maximum size of a pack. This setting only affects
2222packing to a file when repacking, i.e. the git:// protocol
Junio C Hamanob76a6862012-05-02 22:02:462223is unaffected. It can be overridden by the `--max-pack-size`
Junio C Hamano74fd0fc2016-05-10 21:23:562224option of linkgit:git-repack[1]. Reaching this limit results
2225in the creation of multiple packfiles; which in turn prevents
2226bitmaps from being created.
2227The minimum size allowed is limited to 1 MiB.
2228The default is unlimited.
Junio C Hamano4d979582010-02-04 06:27:292229Common unit suffixes of 'k', 'm', or 'g' are
2230supported.
Junio C Hamano49dccaf2008-02-10 10:48:012231
Junio C Hamano5b3533d2014-02-27 23:07:152232pack.useBitmaps::
2233When true, git will use pack bitmaps (if available) when packing
2234to stdout (e.g., during the server side of a fetch). Defaults to
2235true. You should not generally need to turn this off unless
2236you are debugging pack bitmaps.
2237
Junio C Hamano322c6242015-03-23 21:32:462238pack.writeBitmaps (deprecated)::
Junio C Hamano38d02532014-06-26 21:48:502239This is a deprecated synonym for `repack.writeBitmaps`.
Junio C Hamano5b3533d2014-02-27 23:07:152240
2241pack.writeBitmapHashCache::
2242When true, git will include a "hash cache" section in the bitmap
2243index (if one is written). This cache can be used to feed git's
2244delta heuristics, potentially leading to better deltas between
2245bitmapped and non-bitmapped objects (e.g., when serving a fetch
2246between an older, bitmapped pack and objects that have been
2247pushed since the last gc). The downside is that it consumes 4
2248bytes per object of disk space, and that JGit's bitmap
2249implementation does not understand it, causing it to complain if
2250Git and JGit are used on the same repository. Defaults to false.
2251
Junio C Hamano9e96a1a2008-08-16 10:23:182252pager.<cmd>::
Junio C Hamano788eeba2010-12-08 22:50:432253If the value is boolean, turns on or off pagination of the
Junio C Hamano076ffcc2013-02-06 05:13:212254output of a particular Git subcommand when writing to a tty.
Junio C Hamano788eeba2010-12-08 22:50:432255Otherwise, turns on pagination for the subcommand using the
Junio C Hamanob76a6862012-05-02 22:02:462256pager specified by the value of `pager.<cmd>`. If `--paginate`
2257or `--no-pager` is specified on the command line, it takes
Junio C Hamano788eeba2010-12-08 22:50:432258precedence over this option. To disable pagination for all
2259commands, set `core.pager` or `GIT_PAGER` to `cat`.
Junio C Hamano9e96a1a2008-08-16 10:23:182260
Junio C Hamanoa574a092010-06-13 19:57:102261pretty.<name>::
2262Alias for a --pretty= format string, as specified in
2263linkgit:git-log[1]. Any aliases defined here can be used just
2264as the built-in pretty formats could. For example,
Junio C Hamanob76a6862012-05-02 22:02:462265running `git config pretty.changelog "format:* %H %s"`
Junio C Hamanoa574a092010-06-13 19:57:102266would cause the invocation `git log --pretty=changelog`
Junio C Hamanob76a6862012-05-02 22:02:462267to be equivalent to running `git log "--pretty=format:* %H %s"`.
Junio C Hamanoa574a092010-06-13 19:57:102268Note that an alias with the same name as a built-in format
2269will be silently ignored.
2270
Junio C Hamano5b3533d2014-02-27 23:07:152271pull.ff::
2272By default, Git does not create an extra merge commit when merging
2273a commit that is a descendant of the current commit. Instead, the
2274tip of the current branch is fast-forwarded. When set to `false`,
2275this variable tells Git to create an extra merge commit in such
2276a case (equivalent to giving the `--no-ff` option from the command
2277line). When set to `only`, only such fast-forward merges are
2278allowed (equivalent to giving the `--ff-only` option from the
Junio C Hamanoc4e2a202015-05-26 21:38:472279command line). This setting overrides `merge.ff` when pulling.
Junio C Hamano5b3533d2014-02-27 23:07:152280
Junio C Hamano515ab1d2011-12-09 23:41:202281pull.rebase::
2282When true, rebase branches on top of the fetched branch, instead
2283of merging the default branch from the default remote when "git
2284pull" is run. See "branch.<name>.rebase" for setting this on a
2285per-branch basis.
2286+
Junio C Hamano7db630e2015-09-17 20:26:222287When preserve, also pass `--preserve-merges` along to 'git rebase'
2288so that locally committed merge commits will not be flattened
2289by running 'git pull'.
Junio C Hamanocf4a1742013-09-11 22:57:502290+
Junio C Hamano289d7e82016-01-27 00:20:382291When the value is `interactive`, the rebase is run in interactive mode.
2292+
Junio C Hamano515ab1d2011-12-09 23:41:202293*NOTE*: this is a possibly dangerous operation; do *not* use
2294it unless you understand the implications (see linkgit:git-rebase[1]
2295for details).
2296
Junio C Hamano07824ce2006-04-25 07:36:542297pull.octopus::
2298The default merge strategy to use when pulling multiple branches
2299at once.
2300
2301pull.twohead::
2302The default merge strategy to use when pulling a single branch.
2303
Junio C Hamano1de75722009-03-26 08:39:382304push.default::
Junio C Hamano58655592013-07-11 20:52:332305Defines the action `git push` should take if no refspec is
2306explicitly given. Different values are well-suited for
2307specific workflows; for instance, in a purely central workflow
2308(i.e. the fetch source is equal to the push destination),
2309`upstream` is probably what you want. Possible values are:
Junio C Hamano1de75722009-03-26 08:39:382310+
Junio C Hamanobcaa8bc2012-07-03 22:17:202311--
Junio C Hamano58655592013-07-11 20:52:332312
2313* `nothing` - do not push anything (error out) unless a refspec is
2314 explicitly given. This is primarily meant for people who want to
2315 avoid mistakes by always being explicit.
2316
2317* `current` - push the current branch to update a branch with the same
2318 name on the receiving end. Works in both central and non-central
2319 workflows.
2320
2321* `upstream` - push the current branch back to the branch whose
2322 changes are usually integrated into the current branch (which is
2323 called `@{upstream}`). This mode only makes sense if you are
2324 pushing to the same repository you would normally pull from
2325 (i.e. central workflow).
2326
2327* `simple` - in centralized workflow, work like `upstream` with an
2328 added safety to refuse to push if the upstream branch's name is
2329 different from the local one.
Junio C Hamanobcaa8bc2012-07-03 22:17:202330+
Junio C Hamano58655592013-07-11 20:52:332331When pushing to a remote that is different from the remote you normally
2332pull from, work as `current`. This is the safest option and is suited
2333for beginners.
2334+
Junio C Hamano1d669b82014-03-11 21:36:002335This mode has become the default in Git 2.0.
Junio C Hamano58655592013-07-11 20:52:332336
2337* `matching` - push all branches having the same name on both ends.
2338 This makes the repository you are pushing to remember the set of
2339 branches that will be pushed out (e.g. if you always push 'maint'
2340 and 'master' there and no other branches, the repository you push
2341 to will have these two branches, and your local 'maint' and
2342 'master' will be pushed there).
2343+
2344To use this mode effectively, you have to make sure _all_ the
2345branches you would push out are ready to be pushed out before
2346running 'git push', as the whole point of this mode is to allow you
2347to push all of the branches in one go. If you usually finish work
2348on only one branch and push out the result, while other branches are
2349unfinished, this mode is not for you. Also this mode is not
2350suitable for pushing into a shared central repository, as other
2351people may add new branches there, or update the tip of existing
2352branches outside your control.
2353+
Junio C Hamano1d669b82014-03-11 21:36:002354This used to be the default, but not since Git 2.0 (`simple` is the
2355new default).
Junio C Hamano58655592013-07-11 20:52:332356
2357--
Junio C Hamano1de75722009-03-26 08:39:382358
Junio C Hamano322c6242015-03-23 21:32:462359push.followTags::
Junio C Hamano92d80372016-07-13 22:00:052360If set to true enable `--follow-tags` option by default. You
Junio C Hamano322c6242015-03-23 21:32:462361may override this configuration at time of push by specifying
Junio C Hamano92d80372016-07-13 22:00:052362`--no-follow-tags`.
Junio C Hamano322c6242015-03-23 21:32:462363
Junio C Hamano3891e252015-08-31 23:06:132364push.gpgSign::
2365May be set to a boolean value, or the string 'if-asked'. A true
Junio C Hamano92d80372016-07-13 22:00:052366value causes all pushes to be GPG signed, as if `--signed` is
Junio C Hamano3891e252015-08-31 23:06:132367passed to linkgit:git-push[1]. The string 'if-asked' causes
2368pushes to be signed if the server supports it, as if
Junio C Hamano92d80372016-07-13 22:00:052369`--signed=if-asked` is passed to 'git push'. A false value may
Junio C Hamano3891e252015-08-31 23:06:132370override a value from a lower-priority config file. An explicit
2371command-line flag always overrides this config option.
Junio C Hamano322c6242015-03-23 21:32:462372
Junio C Hamano409a33a2015-12-22 23:45:232373push.recurseSubmodules::
2374Make sure all submodule commits used by the revisions to be pushed
2375are available on a remote-tracking branch. If the value is 'check'
2376then Git will verify that all submodule commits that changed in the
2377revisions to be pushed are available on at least one remote of the
2378submodule. If any commits are missing, the push will be aborted and
2379exit with non-zero status. If the value is 'on-demand' then all
2380submodules that changed in the revisions to be pushed will be
2381pushed. If on-demand was not able to push all necessary revisions
2382it will also be aborted and exit with non-zero status. If the value
2383is 'no' then default behavior of ignoring submodules when pushing
2384is retained. You may override this configuration at time of push by
2385specifying '--recurse-submodules=check|on-demand|no'.
2386
Junio C Hamanoea6a7642009-03-11 23:56:192387rebase.stat::
2388Whether to show a diffstat of what changed upstream since the last
2389rebase. False by default.
2390
Junio C Hamano322c6242015-03-23 21:32:462391rebase.autoSquash::
Junio C Hamano92d80372016-07-13 22:00:052392If set to true enable `--autosquash` option by default.
Junio C Hamano075ae872010-09-01 18:43:072393
Junio C Hamano322c6242015-03-23 21:32:462394rebase.autoStash::
Junio C Hamanof1f5a7b2013-06-11 22:23:522395When set to true, automatically create a temporary stash
2396before the operation begins, and apply it after the operation
2397ends. This means that you can run rebase on a dirty worktree.
2398However, use with care: the final stash application after a
2399successful rebase might result in non-trivial conflicts.
2400Defaults to false.
2401
Junio C Hamanod7ed4042015-08-03 19:43:002402rebase.missingCommitsCheck::
2403If set to "warn", git rebase -i will print a warning if some
2404commits are removed (e.g. a line was deleted), however the
2405rebase will still proceed. If set to "error", it will print
2406the previous warning and stop the rebase, 'git rebase
2407--edit-todo' can then be used to correct the error. If set to
2408"ignore", no checking is done.
2409To drop a commit without warning or error, use the `drop`
2410command in the todo-list.
2411Defaults to "ignore".
2412
2413rebase.instructionFormat
2414A format string, as specified in linkgit:git-log[1], to be used for
2415the instruction list during an interactive rebase. The format will automatically
2416have the long commit hash prepended to the format.
2417
Junio C Hamano322c6242015-03-23 21:32:462418receive.advertiseAtomic::
Junio C Hamano6bb32e62015-02-17 22:11:262419By default, git-receive-pack will advertise the atomic push
2420capability to its clients. If you don't want to this capability
2421to be advertised, set this variable to false.
2422
Junio C Hamano621e1232009-10-26 05:16:472423receive.autogc::
2424By default, git-receive-pack will run "git-gc --auto" after
2425receiving data from git-push and updating refs. You can stop
2426it by setting this variable to false.
2427
Junio C Hamano322c6242015-03-23 21:32:462428receive.certNonceSeed::
Junio C Hamano9236fea2014-10-14 22:28:092429By setting this variable to a string, `git receive-pack`
2430will accept a `git push --signed` and verifies it by using
2431a "nonce" protected by HMAC using this string as a secret
2432key.
2433
Junio C Hamano322c6242015-03-23 21:32:462434receive.certNonceSlop::
Junio C Hamano9236fea2014-10-14 22:28:092435When a `git push --signed` sent a push certificate with a
2436"nonce" that was issued by a receive-pack serving the same
2437repository within this many seconds, export the "nonce"
2438found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2439hooks (instead of what the receive-pack asked the sending
2440side to include). This may allow writing checks in
2441`pre-receive` and `post-receive` a bit easier. Instead of
2442checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2443that records by how many seconds the nonce is stale to
2444decide if they want to accept the certificate, they only
2445can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2446
Junio C Hamano4653c6f2008-11-26 22:50:202447receive.fsckObjects::
2448If it is set to true, git-receive-pack will check all received
2449objects. It will abort in the case of a malformed object or a
2450broken link. The result of an abort are only dangling objects.
Junio C Hamano8fb66e52011-10-05 20:59:512451Defaults to false. If not set, the value of `transfer.fsckObjects`
2452is used instead.
Junio C Hamano4653c6f2008-11-26 22:50:202453
Junio C Hamanod7ed4042015-08-03 19:43:002454receive.fsck.<msg-id>::
2455When `receive.fsckObjects` is set to true, errors can be switched
2456to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2457setting where the `<msg-id>` is the fsck message ID and the value
2458is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2459the error/warning with the message ID, e.g. "missingEmail: invalid
2460author/committer line - missing email" means that setting
2461`receive.fsck.missingEmail = ignore` will hide that issue.
2462+
2463This feature is intended to support working with legacy repositories
2464which would not pass pushing when `receive.fsckObjects = true`, allowing
2465the host to accept repositories with certain known issues but still catch
2466other issues.
2467
2468receive.fsck.skipList::
2469The path to a sorted list of object names (i.e. one SHA-1 per
2470line) that are known to be broken in a non-fatal way and should
2471be ignored. This feature is useful when an established project
2472should be accepted despite early commits containing errors that
2473can be safely ignored such as invalid committer email addresses.
2474Note: corrupt objects cannot be skipped with this setting.
2475
Junio C Hamano4653c6f2008-11-26 22:50:202476receive.unpackLimit::
2477If the number of objects received in a push is below this
2478limit then the objects will be unpacked into loose object
2479files. However if the number of received objects equals or
2480exceeds this limit then the received pack will be stored as
2481a pack, after adding any missing delta bases. Storing the
2482pack from a push can make the push operation complete faster,
2483especially on slow filesystems. If not set, the value of
2484`transfer.unpackLimit` is used instead.
2485
2486receive.denyDeletes::
2487If set to true, git-receive-pack will deny a ref update that deletes
2488the ref. Use this to prevent such a ref deletion via a push.
2489
Junio C Hamanob4448a82010-07-26 09:02:322490receive.denyDeleteCurrent::
2491If set to true, git-receive-pack will deny a ref update that
2492deletes the currently checked out branch of a non-bare repository.
2493
Junio C Hamano4653c6f2008-11-26 22:50:202494receive.denyCurrentBranch::
Junio C Hamanoe97d5772010-05-19 08:13:582495If set to true or "refuse", git-receive-pack will deny a ref update
Junio C Hamano4653c6f2008-11-26 22:50:202496to the currently checked out branch of a non-bare repository.
2497Such a push is potentially dangerous because it brings the HEAD
2498out of sync with the index and working tree. If set to "warn",
2499print a warning of such a push to stderr, but allow the push to
2500proceed. If set to false or "ignore", allow such pushes with no
Junio C Hamanoafb395b2010-03-17 22:16:152501message. Defaults to "refuse".
Junio C Hamano6df93d92014-12-22 22:48:092502+
2503Another option is "updateInstead" which will update the working
Junio C Hamano6bb32e62015-02-17 22:11:262504tree if pushing into the current branch. This option is
Junio C Hamano6df93d92014-12-22 22:48:092505intended for synchronizing working directories when one side is not easily
2506accessible via interactive ssh (e.g. a live web site, hence the requirement
2507that the working directory be clean). This mode also comes in handy when
2508developing inside a VM to test and fix code on different Operating Systems.
Junio C Hamano6bb32e62015-02-17 22:11:262509+
2510By default, "updateInstead" will refuse the push if the working tree or
2511the index have any difference from the HEAD, but the `push-to-checkout`
2512hook can be used to customize this. See linkgit:githooks[5].
Junio C Hamano4653c6f2008-11-26 22:50:202513
2514receive.denyNonFastForwards::
2515If set to true, git-receive-pack will deny a ref update which is
Junio C Hamano3f680f32009-11-16 02:10:542516not a fast-forward. Use this to prevent such an update via a push,
Junio C Hamano4653c6f2008-11-26 22:50:202517even if that push is forced. This configuration variable is
2518set when initializing a shared repository.
2519
Junio C Hamano322c6242015-03-23 21:32:462520receive.hideRefs::
Junio C Hamanob6aa12e2015-08-19 22:40:172521This variable is the same as `transfer.hideRefs`, but applies
2522only to `receive-pack` (and so affects pushes, but not fetches).
2523An attempt to update or delete a hidden ref by `git push` is
2524rejected.
Junio C Hamano80ad00d2013-02-18 00:19:032525
Junio C Hamano322c6242015-03-23 21:32:462526receive.updateServerInfo::
Junio C Hamano621e1232009-10-26 05:16:472527If set to true, git-receive-pack will run git-update-server-info
2528after receiving data from git-push and updating refs.
2529
Junio C Hamano322c6242015-03-23 21:32:462530receive.shallowUpdate::
Junio C Hamano61525f92014-01-17 22:46:492531If set to true, .git/shallow can be updated when new refs
2532require new shallow roots. Otherwise those refs are rejected.
2533
Junio C Hamano322c6242015-03-23 21:32:462534remote.pushDefault::
Junio C Hamano63b6fdb2013-04-07 23:37:132535The remote to push to by default. Overrides
2536`branch.<name>.remote` for all branches, and is overridden by
Junio C Hamano322c6242015-03-23 21:32:462537`branch.<name>.pushRemote` for specific branches.
Junio C Hamano63b6fdb2013-04-07 23:37:132538
Junio C Hamano249572f2006-10-24 05:44:082539remote.<name>.url::
Junio C Hamano35738e82008-01-07 07:55:462540The URL of a remote repository. See linkgit:git-fetch[1] or
2541linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:082542
Junio C Hamano0e88f3e2009-06-21 08:03:252543remote.<name>.pushurl::
2544The push URL of a remote repository. See linkgit:git-push[1].
2545
Junio C Hamano58256872007-12-04 08:31:132546remote.<name>.proxy::
2547For remotes that require curl (http, https and ftp), the URL to
2548the proxy to use for that remote. Set to the empty string to
2549disable proxying for that remote.
2550
Junio C Hamanoffe10ca2016-02-04 00:44:232551remote.<name>.proxyAuthMethod::
2552For remotes that require curl (http, https and ftp), the method to use for
2553authenticating against the proxy in use (probably set in
2554`remote.<name>.proxy`). See `http.proxyAuthMethod`.
2555
Junio C Hamano249572f2006-10-24 05:44:082556remote.<name>.fetch::
Junio C Hamano35738e82008-01-07 07:55:462557The default set of "refspec" for linkgit:git-fetch[1]. See
2558linkgit:git-fetch[1].
Junio C Hamano249572f2006-10-24 05:44:082559
2560remote.<name>.push::
Junio C Hamano35738e82008-01-07 07:55:462561The default set of "refspec" for linkgit:git-push[1]. See
2562linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:082563
Junio C Hamano47d68a52008-05-06 06:35:402564remote.<name>.mirror::
2565If true, pushing to this remote will automatically behave
Junio C Hamanob76a6862012-05-02 22:02:462566as if the `--mirror` option was given on the command line.
Junio C Hamano47d68a52008-05-06 06:35:402567
Junio C Hamano118d2772007-02-21 20:24:102568remote.<name>.skipDefaultUpdate::
2569If true, this remote will be skipped by default when updating
Junio C Hamano9df0c662009-11-23 11:09:272570using linkgit:git-fetch[1] or the `update` subcommand of
2571linkgit:git-remote[1].
2572
2573remote.<name>.skipFetchAll::
2574If true, this remote will be skipped by default when updating
2575using linkgit:git-fetch[1] or the `update` subcommand of
2576linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:102577
Junio C Hamano4ad294b2007-01-20 02:22:502578remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:482579The default program to execute on the remote side when pushing. See
Junio C Hamano1dbca522015-05-22 20:48:552580option --receive-pack of linkgit:git-push[1].
Junio C Hamano4ad294b2007-01-20 02:22:502581
Junio C Hamano54ea8d32007-01-25 07:59:482582remote.<name>.uploadpack::
2583The default program to execute on the remote side when fetching. See
Junio C Hamano1dbca522015-05-22 20:48:552584option --upload-pack of linkgit:git-fetch-pack[1].
Junio C Hamano54ea8d32007-01-25 07:59:482585
Junio C Hamano322c6242015-03-23 21:32:462586remote.<name>.tagOpt::
Junio C Hamano1dbca522015-05-22 20:48:552587Setting this value to --no-tags disables automatic tag following when
2588fetching from remote <name>. Setting it to --tags will fetch every
Junio C Hamanocc7636a2010-05-21 14:57:532589tag from remote <name>, even if they are not reachable from remote
Junio C Hamano075ae872010-09-01 18:43:072590branch heads. Passing these flags directly to linkgit:git-fetch[1] can
Junio C Hamano1dbca522015-05-22 20:48:552591override this setting. See options --tags and --no-tags of
Junio C Hamano075ae872010-09-01 18:43:072592linkgit:git-fetch[1].
Junio C Hamano17dde0e2007-02-26 09:50:212593
Junio C Hamano096dde22009-12-26 23:14:112594remote.<name>.vcs::
Junio C Hamano076ffcc2013-02-06 05:13:212595Setting this to a value <vcs> will cause Git to interact with
Junio C Hamano096dde22009-12-26 23:14:112596the remote with the git-remote-<vcs> helper.
2597
Junio C Hamano8eac2682013-09-09 22:35:202598remote.<name>.prune::
2599When set to true, fetching from this remote by default will also
Junio C Hamano4c8f2d92013-12-13 00:55:422600remove any remote-tracking references that no longer exist on the
2601remote (as if the `--prune` option was given on the command line).
Junio C Hamano8eac2682013-09-09 22:35:202602Overrides `fetch.prune` settings, if any.
2603
Junio C Hamano118d2772007-02-21 20:24:102604remotes.<group>::
2605The list of remotes which are fetched by "git remote update
Junio C Hamano35738e82008-01-07 07:55:462606<group>". See linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:102607
Junio C Hamano322c6242015-03-23 21:32:462608repack.useDeltaBaseOffset::
Junio C Hamanofce7c7e2008-07-02 03:06:382609By default, linkgit:git-repack[1] creates packs that use
2610delta-base offset. If you need to share your repository with
Junio C Hamano076ffcc2013-02-06 05:13:212611Git older than version 1.4.4, either directly or via a dumb
Junio C Hamanofce7c7e2008-07-02 03:06:382612protocol such as http, then you need to set this option to
Junio C Hamano076ffcc2013-02-06 05:13:212613"false" and repack. Access from old Git versions over the
Junio C Hamanofce7c7e2008-07-02 03:06:382614native protocol are unaffected by this option.
Junio C Hamano77b7e902006-10-23 07:18:502615
Junio C Hamano3b0cdc22014-03-18 22:06:162616repack.packKeptObjects::
2617If set to true, makes `git repack` act as if
2618`--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2619details. Defaults to `false` normally, but `true` if a bitmap
2620index is being written (either via `--write-bitmap-index` or
Junio C Hamano38d02532014-06-26 21:48:502621`repack.writeBitmaps`).
2622
2623repack.writeBitmaps::
2624When true, git will write a bitmap index when packing all
2625objects to disk (e.g., when `git repack -a` is run). This
2626index can speed up the "counting objects" phase of subsequent
2627packs created for clones and fetches, at the cost of some disk
Junio C Hamano74fd0fc2016-05-10 21:23:562628space and extra time spent on the initial repack. This has
2629no effect if multiple packfiles are created.
2630Defaults to false.
Junio C Hamano3b0cdc22014-03-18 22:06:162631
Junio C Hamano322c6242015-03-23 21:32:462632rerere.autoUpdate::
Junio C Hamano4653c6f2008-11-26 22:50:202633When set to true, `git-rerere` updates the index with the
2634resulting contents after it cleanly resolves conflicts using
2635previously recorded resolution. Defaults to false.
2636
2637rerere.enabled::
2638Activate recording of resolved conflicts, so that identical
Junio C Hamano4fd24422012-01-06 21:52:432639conflict hunks can be resolved automatically, should they be
2640encountered again. By default, linkgit:git-rerere[1] is
2641enabled if there is an `rr-cache` directory under the
Junio C Hamano864ba892012-01-13 17:42:052642`$GIT_DIR`, e.g. if "rerere" was previously used in the
2643repository.
Junio C Hamano4653c6f2008-11-26 22:50:202644
Junio C Hamano1bbd0f42009-07-23 06:20:292645sendemail.identity::
2646A configuration identity. When given, causes values in the
2647'sendemail.<identity>' subsection to take precedence over
2648values in the 'sendemail' section. The default identity is
Junio C Hamano042f2142016-06-27 18:05:052649the value of `sendemail.identity`.
Junio C Hamano1bbd0f42009-07-23 06:20:292650
Junio C Hamano322c6242015-03-23 21:32:462651sendemail.smtpEncryption::
Junio C Hamano1bbd0f42009-07-23 06:20:292652See linkgit:git-send-email[1] for description. Note that this
2653setting is not subject to the 'identity' mechanism.
2654
Junio C Hamanobe087982015-02-22 21:29:392655sendemail.smtpssl (deprecated)::
Junio C Hamano322c6242015-03-23 21:32:462656Deprecated alias for 'sendemail.smtpEncryption = ssl'.
Junio C Hamano1bbd0f42009-07-23 06:20:292657
Junio C Hamano58f587a2013-07-22 19:20:592658sendemail.smtpsslcertpath::
2659Path to ca-certificates (either a directory or a single file).
2660Set it to an empty string to disable certificate verification.
2661
Junio C Hamano1bbd0f42009-07-23 06:20:292662sendemail.<identity>.*::
2663Identity-specific versions of the 'sendemail.*' parameters
2664found below, taking precedence over those when the this
2665identity is selected, through command-line or
Junio C Hamano042f2142016-06-27 18:05:052666`sendemail.identity`.
Junio C Hamano1bbd0f42009-07-23 06:20:292667
Junio C Hamano322c6242015-03-23 21:32:462668sendemail.aliasesFile::
2669sendemail.aliasFileType::
Junio C Hamanoea3b7522013-04-18 19:37:532670sendemail.annotate::
Junio C Hamano1bbd0f42009-07-23 06:20:292671sendemail.bcc::
2672sendemail.cc::
Junio C Hamano322c6242015-03-23 21:32:462673sendemail.ccCmd::
2674sendemail.chainReplyTo::
Junio C Hamano1bbd0f42009-07-23 06:20:292675sendemail.confirm::
Junio C Hamano322c6242015-03-23 21:32:462676sendemail.envelopeSender::
Junio C Hamano1bbd0f42009-07-23 06:20:292677sendemail.from::
Junio C Hamano322c6242015-03-23 21:32:462678sendemail.multiEdit::
Junio C Hamano1bbd0f42009-07-23 06:20:292679sendemail.signedoffbycc::
Junio C Hamano322c6242015-03-23 21:32:462680sendemail.smtpPass::
Junio C Hamano1bbd0f42009-07-23 06:20:292681sendemail.suppresscc::
Junio C Hamano322c6242015-03-23 21:32:462682sendemail.suppressFrom::
Junio C Hamano1bbd0f42009-07-23 06:20:292683sendemail.to::
Junio C Hamano322c6242015-03-23 21:32:462684sendemail.smtpDomain::
2685sendemail.smtpServer::
2686sendemail.smtpServerPort::
2687sendemail.smtpServerOption::
2688sendemail.smtpUser::
Junio C Hamano1bbd0f42009-07-23 06:20:292689sendemail.thread::
Junio C Hamano322c6242015-03-23 21:32:462690sendemail.transferEncoding::
Junio C Hamano1bbd0f42009-07-23 06:20:292691sendemail.validate::
Junio C Hamanoc9394b22015-01-07 22:45:482692sendemail.xmailer::
Junio C Hamano1bbd0f42009-07-23 06:20:292693See linkgit:git-send-email[1] for description.
2694
Junio C Hamanobe087982015-02-22 21:29:392695sendemail.signedoffcc (deprecated)::
Junio C Hamano042f2142016-06-27 18:05:052696Deprecated alias for `sendemail.signedoffbycc`.
Junio C Hamano1bbd0f42009-07-23 06:20:292697
Junio C Hamano07824ce2006-04-25 07:36:542698showbranch.default::
Junio C Hamano35738e82008-01-07 07:55:462699The default set of branches for linkgit:git-show-branch[1].
2700See linkgit:git-show-branch[1].
Junio C Hamano07824ce2006-04-25 07:36:542701
Junio C Hamano942b35e2007-12-09 10:19:332702status.relativePaths::
Junio C Hamano35738e82008-01-07 07:55:462703By default, linkgit:git-status[1] shows paths relative to the
Junio C Hamano942b35e2007-12-09 10:19:332704current directory. Setting this variable to `false` shows paths
Junio C Hamano076ffcc2013-02-06 05:13:212705relative to the repository root (this was the default for Git
Junio C Hamano942b35e2007-12-09 10:19:332706prior to v1.5.4).
2707
Junio C Hamano58655592013-07-11 20:52:332708status.short::
2709Set to true to enable --short by default in linkgit:git-status[1].
2710The option --no-short takes precedence over this variable.
2711
2712status.branch::
2713Set to true to enable --branch by default in linkgit:git-status[1].
2714The option --no-branch takes precedence over this variable.
2715
Junio C Hamano79f4c7c2013-09-20 21:03:372716status.displayCommentPrefix::
2717If set to true, linkgit:git-status[1] will insert a comment
2718prefix before each output line (starting with
2719`core.commentChar`, i.e. `#` by default). This was the
2720behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2721Defaults to false.
2722
Junio C Hamano4224f992008-06-23 07:14:082723status.showUntrackedFiles::
2724By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2725files which are not currently tracked by Git. Directories which
2726contain only untracked files, are shown with the directory name
2727only. Showing untracked files means that Git needs to lstat() all
Junio C Hamano2efd5e42014-11-10 22:38:522728the files in the whole repository, which might be slow on some
Junio C Hamano4224f992008-06-23 07:14:082729systems. So, this variable controls how the commands displays
2730the untracked files. Possible values are:
2731+
2732--
Junio C Hamano7f9fa862010-10-19 23:51:142733* `no` - Show no untracked files.
2734* `normal` - Show untracked files and directories.
2735* `all` - Show also individual files in untracked directories.
Junio C Hamano4224f992008-06-23 07:14:082736--
2737+
2738If this variable is not specified, it defaults to 'normal'.
2739This variable can be overridden with the -u|--untracked-files option
2740of linkgit:git-status[1] and linkgit:git-commit[1].
2741
Junio C Hamano322c6242015-03-23 21:32:462742status.submoduleSummary::
Junio C Hamanob671fb52010-06-01 05:06:142743Defaults to false.
2744If this is set to a non zero number or true (identical to -1 or an
2745unlimited number), the submodule summary will be enabled and a
2746summary of commits for modified submodules will be shown (see
Junio C Hamano369e3402013-10-15 18:40:252747--summary-limit option of linkgit:git-submodule[1]). Please note
2748that the summary output command will be suppressed for all
2749submodules when `diff.ignoreSubmodules` is set to 'all' or only
Junio C Hamanoc8c398a2014-06-16 21:14:052750for those submodules where `submodule.<name>.ignore=all`. The only
2751exception to that rule is that status and commit will show staged
2752submodule changes. To
Junio C Hamano369e3402013-10-15 18:40:252753also view the summary for ignored submodules you can either use
Junio C Hamanoe1aeb5e2014-06-06 19:16:292754the --ignore-submodules=dirty command-line option or the 'git
Junio C Hamano369e3402013-10-15 18:40:252755submodule summary' command, which shows a similar output but does
2756not honor these settings.
Junio C Hamanob671fb52010-06-01 05:06:142757
Junio C Hamano1eb56092015-10-05 20:39:532758stash.showPatch::
2759If this is set to true, the `git stash show` command without an
2760option will show the stash in patch form. Defaults to false.
2761See description of 'show' command in linkgit:git-stash[1].
2762
2763stash.showStat::
2764If this is set to true, the `git stash show` command without an
2765option will show diffstat of the stash. Defaults to true.
2766See description of 'show' command in linkgit:git-stash[1].
2767
Junio C Hamano78e3a782010-07-15 22:24:452768submodule.<name>.path::
2769submodule.<name>.url::
Junio C Hamano6bf68cf2015-03-06 23:46:292770The path within this project and URL for a submodule. These
2771variables are initially populated by 'git submodule init'. See
2772linkgit:git-submodule[1] and linkgit:gitmodules[5] for
2773details.
2774
Junio C Hamano78e3a782010-07-15 22:24:452775submodule.<name>.update::
Junio C Hamano6bf68cf2015-03-06 23:46:292776The default update procedure for a submodule. This variable
2777is populated by `git submodule init` from the
2778linkgit:gitmodules[5] file. See description of 'update'
2779command in linkgit:git-submodule[1].
Junio C Hamano78e3a782010-07-15 22:24:452780
Junio C Hamanoabad6da2013-01-06 09:06:322781submodule.<name>.branch::
2782The remote branch name for a submodule, used by `git submodule
2783update --remote`. Set this option to override the value found in
2784the `.gitmodules` file. See linkgit:git-submodule[1] and
2785linkgit:gitmodules[5] for details.
2786
Junio C Hamano0d75e872010-12-17 06:57:262787submodule.<name>.fetchRecurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:102788This option can be used to control recursive fetching of this
Junio C Hamano7165bf72011-01-04 22:06:182789submodule. It can be overridden by using the --[no-]recurse-submodules
Junio C Hamanoe1aeb5e2014-06-06 19:16:292790command-line option to "git fetch" and "git pull".
Junio C Hamano0d75e872010-12-17 06:57:262791This setting will override that from in the linkgit:gitmodules[5]
2792file.
2793
Junio C Hamano619596a2010-08-18 22:15:352794submodule.<name>.ignore::
2795Defines under what circumstances "git status" and the diff family show
2796a submodule as modified. When set to "all", it will never be considered
Junio C Hamanoc8c398a2014-06-16 21:14:052797modified (but it will nonetheless show up in the output of status and
2798commit when it has been staged), "dirty" will ignore all changes
2799to the submodules work tree and
Junio C Hamano619596a2010-08-18 22:15:352800takes only differences between the HEAD of the submodule and the commit
2801recorded in the superproject into account. "untracked" will additionally
2802let submodules with modified tracked files in their work tree show up.
2803Using "none" (the default when this option is not set) also shows
2804submodules that have untracked files in their work tree as changed.
2805This setting overrides any setting made in .gitmodules for this submodule,
Junio C Hamanode9745c2010-08-23 17:10:182806both settings can be overridden on the command line by using the
Junio C Hamano369e3402013-10-15 18:40:252807"--ignore-submodules" option. The 'git submodule' commands are not
2808affected by this setting.
Junio C Hamano619596a2010-08-18 22:15:352809
Junio C Hamanobec5da42016-04-06 22:58:212810submodule.fetchJobs::
2811Specifies how many submodules are fetched/cloned at the same time.
2812A positive integer allows up to that number of submodules fetched
2813in parallel. A value of 0 will give some reasonable default.
2814If unset, it defaults to 1.
2815
2816tag.forceSignAnnotated::
2817A boolean to specify whether annotated tags created should be GPG signed.
2818If `--annotate` is specified on the command line, it takes
2819precedence over this option.
2820
Junio C Hamano7b43d412014-07-23 23:09:442821tag.sort::
2822This variable controls the sort ordering of tags when displayed by
2823linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2824value of this variable will be used as the default.
2825
Junio C Hamano75cc4c92006-07-24 08:25:032826tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:092827This variable can be used to restrict the permission bits of
2828tar archive entries. The default is 0002, which turns off the
2829world write bit. The special value "user" indicates that the
2830archiving user's umask will be used instead. See umask(2) and
Junio C Hamano35738e82008-01-07 07:55:462831linkgit:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:032832
Junio C Hamano8fb66e52011-10-05 20:59:512833transfer.fsckObjects::
2834When `fetch.fsckObjects` or `receive.fsckObjects` are
2835not set, the value of this variable is used instead.
2836Defaults to false.
2837
Junio C Hamano322c6242015-03-23 21:32:462838transfer.hideRefs::
Junio C Hamanob6aa12e2015-08-19 22:40:172839String(s) `receive-pack` and `upload-pack` use to decide which
2840refs to omit from their initial advertisements. Use more than
2841one definition to specify multiple prefix strings. A ref that is
2842under the hierarchies listed in the value of this variable is
2843excluded, and is hidden when responding to `git push` or `git
2844fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
2845program-specific versions of this config.
2846+
2847You may also include a `!` in front of the ref name to negate the entry,
2848explicitly exposing it, even if an earlier entry marked it as hidden.
2849If you have multiple hideRefs values, later entries override earlier ones
2850(and entries in more-specific config files override less-specific ones).
Junio C Hamano713eded2015-12-03 00:24:022851+
2852If a namespace is in use, the namespace prefix is stripped from each
2853reference before it is matched against `transfer.hiderefs` patterns.
2854For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
2855the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
2856is omitted from the advertisements but `refs/heads/master` and
2857`refs/namespaces/bar/refs/heads/master` are still advertised as so-called
2858"have" lines. In order to match refs before stripping, add a `^` in front of
2859the ref name. If you combine `!` and `^`, `!` must be specified first.
Junio C Hamano80ad00d2013-02-18 00:19:032860
Junio C Hamano4653c6f2008-11-26 22:50:202861transfer.unpackLimit::
2862When `fetch.unpackLimit` or `receive.unpackLimit` are
2863not set, the value of this variable is used instead.
2864The default value is 100.
2865
Junio C Hamano81703b22014-03-14 22:00:272866uploadarchive.allowUnreachable::
2867If true, allow clients to use `git archive --remote` to request
2868any tree, whether reachable from the ref tips or not. See the
2869discussion in the `SECURITY` section of
2870linkgit:git-upload-archive[1] for more details. Defaults to
2871`false`.
2872
Junio C Hamano322c6242015-03-23 21:32:462873uploadpack.hideRefs::
Junio C Hamanob6aa12e2015-08-19 22:40:172874This variable is the same as `transfer.hideRefs`, but applies
2875only to `upload-pack` (and so affects only fetches, not pushes).
2876An attempt to fetch a hidden ref by `git fetch` will fail. See
2877also `uploadpack.allowTipSHA1InWant`.
Junio C Hamano5e7f1312013-03-21 22:49:012878
Junio C Hamano85f1fde2015-06-01 20:37:322879uploadpack.allowTipSHA1InWant::
Junio C Hamano322c6242015-03-23 21:32:462880When `uploadpack.hideRefs` is in effect, allow `upload-pack`
Junio C Hamano5e7f1312013-03-21 22:49:012881to accept a fetch request that asks for an object at the tip
2882of a hidden ref (by default, such a request is rejected).
Junio C Hamano322c6242015-03-23 21:32:462883see also `uploadpack.hideRefs`.
Junio C Hamano80ad00d2013-02-18 00:19:032884
Junio C Hamano85f1fde2015-06-01 20:37:322885uploadpack.allowReachableSHA1InWant::
2886Allow `upload-pack` to accept a fetch request that asks for an
2887object that is reachable from any ref tip. However, note that
2888calculating object reachability is computationally expensive.
2889Defaults to `false`.
2890
Junio C Hamano322c6242015-03-23 21:32:462891uploadpack.keepAlive::
Junio C Hamano79f4c7c2013-09-20 21:03:372892When `upload-pack` has started `pack-objects`, there may be a
2893quiet period while `pack-objects` prepares the pack. Normally
2894it would output progress information, but if `--quiet` was used
2895for the fetch, `pack-objects` will output nothing at all until
2896the pack data begins. Some clients and networks may consider
2897the server to be hung and give up. Setting this option instructs
2898`upload-pack` to send an empty keepalive packet every
Junio C Hamano322c6242015-03-23 21:32:462899`uploadpack.keepAlive` seconds. Setting this option to 0
Junio C Hamano79f4c7c2013-09-20 21:03:372900disables keepalive packets entirely. The default is 5 seconds.
2901
Junio C Hamanoc6c919b2016-07-06 21:34:152902uploadpack.packObjectsHook::
2903If this option is set, when `upload-pack` would run
2904`git pack-objects` to create a packfile for a client, it will
2905run this shell command instead. The `pack-objects` command and
2906arguments it _would_ have run (including the `git pack-objects`
2907at the beginning) are appended to the shell command. The stdin
2908and stdout of the hook are treated as if `pack-objects` itself
2909was run. I.e., `upload-pack` will feed input intended for
2910`pack-objects` to the hook, and expects a completed packfile on
2911stdout.
2912+
2913Note that this configuration variable is ignored if it is seen in the
2914repository-level config (this is a safety measure against fetching from
2915untrusted repositories).
2916
Junio C Hamano24bc09a2008-02-28 00:27:442917url.<base>.insteadOf::
2918Any URL that starts with this value will be rewritten to
2919start, instead, with <base>. In cases where some site serves a
2920large number of repositories, and serves them with multiple
2921access methods, and some users need to use different access
2922methods, this feature allows people to specify any of the
Junio C Hamano076ffcc2013-02-06 05:13:212923equivalent URLs and have Git automatically rewrite the URL to
Junio C Hamano24bc09a2008-02-28 00:27:442924the best alternative for the particular user, even for a
2925never-before-seen repository on the site. When more than one
2926insteadOf strings match a given URL, the longest match is used.
2927
Junio C Hamano7df6dcf2009-09-13 09:51:172928url.<base>.pushInsteadOf::
2929Any URL that starts with this value will not be pushed to;
2930instead, it will be rewritten to start with <base>, and the
2931resulting URL will be pushed to. In cases where some site serves
2932a large number of repositories, and serves them with multiple
2933access methods, some of which do not allow push, this feature
Junio C Hamano076ffcc2013-02-06 05:13:212934allows people to specify a pull-only URL and have Git
Junio C Hamano7df6dcf2009-09-13 09:51:172935automatically use an appropriate URL to push, even for a
2936never-before-seen repository on the site. When more than one
2937pushInsteadOf strings match a given URL, the longest match is
Junio C Hamano076ffcc2013-02-06 05:13:212938used. If a remote has an explicit pushurl, Git will ignore this
Junio C Hamano7df6dcf2009-09-13 09:51:172939setting for that remote.
2940
Junio C Hamano07824ce2006-04-25 07:36:542941user.email::
2942Your email address to be recorded in any newly created commits.
Junio C Hamano042f2142016-06-27 18:05:052943Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
2944`EMAIL` environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:542945
2946user.name::
2947Your full name to be recorded in any newly created commits.
Junio C Hamano042f2142016-06-27 18:05:052948Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
Junio C Hamano35738e82008-01-07 07:55:462949environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:542950
Junio C Hamanof85ef632016-02-17 22:31:062951user.useConfigOnly::
Junio C Hamano042f2142016-06-27 18:05:052952Instruct Git to avoid trying to guess defaults for `user.email`
2953and `user.name`, and instead retrieve the values only from the
Junio C Hamanof85ef632016-02-17 22:31:062954configuration. For example, if you have multiple email addresses
2955and would like to use a different one for each repository, then
2956with this configuration option set to `true` in the global config
2957along with a name, Git will prompt you to set up an email before
2958making new commits in a newly cloned repository.
2959Defaults to `false`.
2960
Junio C Hamano322c6242015-03-23 21:32:462961user.signingKey::
Junio C Hamano369e3402013-10-15 18:40:252962If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2963key you want it to automatically when creating a signed tag or
2964commit, you can override the default selection with this variable.
2965This option is passed unchanged to gpg's --local-user parameter,
2966so you may specify a key using any method that gpg supports.
Junio C Hamanoa890c4f2007-01-28 10:29:212967
Junio C Hamano07622622015-03-20 21:47:262968versionsort.prereleaseSuffix::
2969When version sort is used in linkgit:git-tag[1], prerelease
2970tags (e.g. "1.0-rc1") may appear after the main release
2971"1.0". By specifying the suffix "-rc" in this variable,
2972"1.0-rc1" will appear before "1.0".
2973+
2974This variable can be specified multiple times, once per suffix. The
2975order of suffixes in the config file determines the sorting order
2976(e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX
2977is sorted before 1.0-rcXX). The sorting order between different
2978suffixes is undefined if they are in multiple config files.
2979
Junio C Hamano4e272312008-01-08 09:13:212980web.browser::
2981Specify a web browser that may be used by some commands.
2982Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2983may use it.