blob: 02bcde6bb596ee5a82fa5630396fa78925abc2b0 [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
84included file is expanded immediately, as if its contents had been
85found at the location of the include directive. If the value of the
86`include.path` variable is a relative path, the path is considered to be
87relative to the configuration file in which the include directive was
Junio C Hamano22700fb2012-05-03 23:07:2588found. The value of `include.path` is subject to tilde expansion: `~/`
89is expanded to the value of `$HOME`, and `~user/` to the specified
Junio C Hamano4d61c4a2012-04-30 01:10:2290user's home directory. See below for examples.
Junio C Hamanoe0238c22012-02-23 22:45:5091
Junio C Hamano07824ce2006-04-25 07:36:5492Example
93~~~~~~~
94
95# Core variables
96[core]
97; Don't trust file modes
98filemode = false
99
100# Our diff algorithm
101[diff]
Junio C Hamano85c71572008-07-28 00:03:31102external = /usr/local/bin/diff-wrapper
Junio C Hamano07824ce2006-04-25 07:36:54103renames = true
104
Junio C Hamano52401ef2006-12-19 00:54:38105[branch "devel"]
106remote = origin
107merge = refs/heads/devel
108
Junio C Hamanobee172f2007-01-23 08:44:18109# Proxy settings
110[core]
Junio C Hamanoc71a8732007-08-04 00:27:26111gitProxy="ssh" for "kernel.org"
Junio C Hamanobee172f2007-01-23 08:44:18112gitProxy=default-proxy ; for the rest
Junio C Hamano52401ef2006-12-19 00:54:38113
Junio C Hamanoe0238c22012-02-23 22:45:50114[include]
115path = /path/to/foo.inc ; include by absolute path
116path = foo ; expand "foo" relative to the current file
Junio C Hamano4d61c4a2012-04-30 01:10:22117path = ~/foo ; expand "foo" in your $HOME directory
Junio C Hamanoe0238c22012-02-23 22:45:50118
Junio C Hamano07622622015-03-20 21:47:26119
120Values
121~~~~~~
122
123Values of many variables are treated as a simple string, but there
124are variables that take values of specific types and there are rules
125as to how to spell them.
126
127boolean::
128
129 When a variable is said to take a boolean value, many
130 synonyms are accepted for 'true' and 'false'; these are all
131 case-insensitive.
132
133 true;; Boolean true can be spelled as `yes`, `on`, `true`,
134or `1`. Also, a variable defined without `= <value>`
135is taken as true.
136
137 false;; Boolean false can be spelled as `no`, `off`,
138`false`, or `0`.
139+
140When converting value to the canonical form using '--bool' type
141specifier; 'git config' will ensure that the output is "true" or
142"false" (spelled in lowercase).
143
144integer::
145 The value for many variables that specify various sizes can
146 be suffixed with `k`, `M`,... to mean "scale the number by
147 1024", "by 1024x1024", etc.
148
149color::
150 The value for a variables that takes a color is a list of
151 colors (at most two) and attributes (at most one), separated
152 by spaces. The colors accepted are `normal`, `black`,
153 `red`, `green`, `yellow`, `blue`, `magenta`, `cyan` and
154 `white`; the attributes are `bold`, `dim`, `ul`, `blink` and
155 `reverse`. The first color given is the foreground; the
156 second is the background. The position of the attribute, if
157 any, doesn't matter. Attributes may be turned off specifically
158 by prefixing them with `no` (e.g., `noreverse`, `noul`, etc).
159+
160Colors (foreground and background) may also be given as numbers between
1610 and 255; these use ANSI 256-color mode (but note that not all
162terminals may support this). If your terminal supports it, you may also
163specify 24-bit RGB values as hex, like `#ff0ab3`.
164+
165The attributes are meant to be reset at the beginning of each item
166in the colored output, so setting color.decorate.branch to `black`
167will paint that branch name in a plain `black`, even if the previous
168thing on the same output line (e.g. opening parenthesis before the
169list of branch names in `log --decorate` output) is set to be
170painted with `bold` or some other attribute.
171
172
Junio C Hamano07824ce2006-04-25 07:36:54173Variables
174~~~~~~~~~
175
176Note that this list is non-comprehensive and not necessarily complete.
Junio C Hamanof1d14802006-06-08 00:48:17177For command-specific variables, you will find a more detailed description
Junio C Hamano52b6ba32014-04-01 00:26:48178in the appropriate manual page.
179
180Other git-related tools may and do use their own variables. When
181inventing new variables for use in your own tool, make sure their
182names do not conflict with those that are used by Git itself and
183other popular tools, and describe them in your documentation.
184
Junio C Hamano07824ce2006-04-25 07:36:54185
Junio C Hamano7df6dcf2009-09-13 09:51:17186advice.*::
Junio C Hamano0df92712011-12-21 22:30:44187These variables control various optional help messages designed to
188aid new users. All 'advice.*' variables default to 'true', and you
189can tell Git that you do not need help by setting these to 'false':
Junio C Hamano7df6dcf2009-09-13 09:51:17190+
191--
Junio C Hamanoabad6da2013-01-06 09:06:32192pushUpdateRejected::
Junio C Hamano0c1b64e2012-04-20 23:50:49193Set this variable to 'false' if you want to disable
Junio C Hamano1d669b82014-03-11 21:36:00194'pushNonFFCurrent',
Junio C Hamano3f2ed6f2013-02-04 19:24:09195'pushNonFFMatching', 'pushAlreadyExists',
196'pushFetchFirst', and 'pushNeedsForce'
Junio C Hamanoabad6da2013-01-06 09:06:32197simultaneously.
Junio C Hamano0c1b64e2012-04-20 23:50:49198pushNonFFCurrent::
199Advice shown when linkgit:git-push[1] fails due to a
200non-fast-forward update to the current branch.
Junio C Hamano0c1b64e2012-04-20 23:50:49201pushNonFFMatching::
202Advice shown when you ran linkgit:git-push[1] and pushed
203'matching refs' explicitly (i.e. you used ':', or
204specified a refspec that isn't your current branch) and
205it resulted in a non-fast-forward error.
Junio C Hamanoabad6da2013-01-06 09:06:32206pushAlreadyExists::
207Shown when linkgit:git-push[1] rejects an update that
208does not qualify for fast-forwarding (e.g., a tag.)
Junio C Hamano3f2ed6f2013-02-04 19:24:09209pushFetchFirst::
210Shown when linkgit:git-push[1] rejects an update that
211tries to overwrite a remote ref that points at an
212object we do not have.
213pushNeedsForce::
214Shown when linkgit:git-push[1] rejects an update that
215tries to overwrite a remote ref that points at an
Junio C Hamanoe6f28d02013-09-17 21:34:00216object that is not a commit-ish, or make the remote
217ref point at an object that is not a commit-ish.
Junio C Hamano7df6dcf2009-09-13 09:51:17218statusHints::
Junio C Hamano644936c2012-06-28 23:05:14219Show directions on how to proceed from the current
Junio C Hamano917cd4f2012-12-04 23:41:10220state in the output of linkgit:git-status[1], in
Junio C Hamano644936c2012-06-28 23:05:14221the template shown when writing commit messages in
Junio C Hamano917cd4f2012-12-04 23:41:10222linkgit:git-commit[1], and in the help message shown
223by linkgit:git-checkout[1] when switching branch.
Junio C Hamano5e7f1312013-03-21 22:49:01224statusUoption::
225Advise to consider using the `-u` option to linkgit:git-status[1]
226when the command takes more than 2 seconds to enumerate untracked
227files.
Junio C Hamano5706e0b2009-11-24 10:54:16228commitBeforeMerge::
229Advice shown when linkgit:git-merge[1] refuses to
Junio C Hamano619596a2010-08-18 22:15:35230merge to avoid overwriting local changes.
Junio C Hamanoa9701f02010-01-21 00:42:16231resolveConflict::
Junio C Hamano5dab5a92013-02-25 18:51:24232Advice shown by various commands when conflicts
Junio C Hamanoa9701f02010-01-21 00:42:16233prevent the operation from being performed.
Junio C Hamanoa9701f02010-01-21 00:42:16234implicitIdentity::
235Advice on how to set your identity configuration when
236your information is guessed from the system username and
Junio C Hamano0df92712011-12-21 22:30:44237domain name.
Junio C Hamano74a198f2010-02-22 00:13:31238detachedHead::
Junio C Hamano0df92712011-12-21 22:30:44239Advice shown when you used linkgit:git-checkout[1] to
Junio C Hamano74a198f2010-02-22 00:13:31240move to the detach HEAD state, to instruct how to create
Junio C Hamano0df92712011-12-21 22:30:44241a local branch after the fact.
Junio C Hamanobb300642012-07-22 21:09:14242amWorkDir::
243Advice that shows the location of the patch file when
244linkgit:git-am[1] fails to apply it.
Junio C Hamano8ab94942013-06-24 21:55:30245rmHints::
246In case of failure in the output of linkgit:git-rm[1],
247show directions on how to proceed from the current state.
Junio C Hamano7df6dcf2009-09-13 09:51:17248--
249
Junio C Hamano07824ce2006-04-25 07:36:54250core.fileMode::
Junio C Hamanod2c28482014-10-24 22:28:25251Tells Git if the executable bit of files in the working tree
252is to be honored.
Junio C Hamano9df0c662009-11-23 11:09:27253+
Junio C Hamanod2c28482014-10-24 22:28:25254Some filesystems lose the executable bit when a file that is
255marked as executable is checked out, or checks out an
256non-executable file with executable bit on.
257linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
258to see if it handles the executable bit correctly
259and this variable is automatically set as necessary.
260+
261A repository, however, may be on a filesystem that handles
262the filemode correctly, and this variable is set to 'true'
263when created, but later may be made accessible from another
264environment that loses the filemode (e.g. exporting ext4 via
265CIFS mount, visiting a Cygwin created repository with
266Git for Windows or Eclipse).
267In such a case it may be necessary to set this variable to 'false'.
268See linkgit:git-update-index[1].
269+
270The default is true (when core.filemode is not specified in the config file).
Junio C Hamano07824ce2006-04-25 07:36:54271
Junio C Hamano322c6242015-03-23 21:32:46272core.ignoreCase::
Junio C Hamano9df0c662009-11-23 11:09:27273If true, this option enables various workarounds to enable
Junio C Hamano076ffcc2013-02-06 05:13:21274Git to work better on filesystems that are not case sensitive,
Junio C Hamano9df0c662009-11-23 11:09:27275like FAT. For example, if a directory listing finds
Junio C Hamano076ffcc2013-02-06 05:13:21276"makefile" when Git expects "Makefile", Git will assume
Junio C Hamano9df0c662009-11-23 11:09:27277it is really the same file, and continue to remember it as
278"Makefile".
279+
280The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
Junio C Hamano322c6242015-03-23 21:32:46281will probe and set core.ignoreCase true if appropriate when the repository
Junio C Hamano9df0c662009-11-23 11:09:27282is created.
283
Junio C Hamano322c6242015-03-23 21:32:46284core.precomposeUnicode::
Junio C Hamano076ffcc2013-02-06 05:13:21285This option is only used by Mac OS implementation of Git.
Junio C Hamano322c6242015-03-23 21:32:46286When core.precomposeUnicode=true, Git reverts the unicode decomposition
Junio C Hamanob61a7772012-07-13 23:34:48287of filenames done by Mac OS. This is useful when sharing a repository
288between Mac OS and Linux or Windows.
Junio C Hamano076ffcc2013-02-06 05:13:21289(Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
290When false, file names are handled fully transparent by Git,
291which is backward compatible with older versions of Git.
Junio C Hamanob61a7772012-07-13 23:34:48292
Junio C Hamano30758bd2014-12-18 20:44:14293core.protectHFS::
294If set to true, do not allow checkout of paths that would
295be considered equivalent to `.git` on an HFS+ filesystem.
296Defaults to `true` on Mac OS, and `false` elsewhere.
297
298core.protectNTFS::
299If set to true, do not allow checkout of paths that would
300cause problems with the NTFS filesystem, e.g. conflict with
3018.3 "short" names.
302Defaults to `true` on Windows, and `false` elsewhere.
303
Junio C Hamano90ccff32008-07-29 08:17:24304core.trustctime::
305If false, the ctime differences between the index and the
Junio C Hamano8fb66e52011-10-05 20:59:51306working tree are ignored; useful when the inode change time
Junio C Hamano90ccff32008-07-29 08:17:24307is regularly modified by something outside Git (file system
308crawlers and some backup systems).
309See linkgit:git-update-index[1]. True by default.
310
Junio C Hamano322c6242015-03-23 21:32:46311core.checkStat::
Junio C Hamano4cfed0c2013-01-30 17:58:54312Determines which stat fields to match between the index
313and work tree. The user can set this to 'default' or
314'minimal'. Default (or explicitly 'default'), is to check
315all fields, including the sub-second part of mtime and ctime.
316
Junio C Hamano322c6242015-03-23 21:32:46317core.quotePath::
Junio C Hamanoba4b9282008-07-06 05:20:31318The commands that output paths (e.g. 'ls-files',
319'diff'), when not given the `-z` option, will quote
Junio C Hamanod526ba92007-07-02 00:17:42320"unusual" characters in the pathname by enclosing the
321pathname in a double-quote pair and with backslashes the
322same way strings in C source code are quoted. If this
323variable is set to false, the bytes higher than 0x80 are
324not quoted but output as verbatim. Note that double
325quote, backslash and control characters are always
326quoted without `-z` regardless of the setting of this
327variable.
328
Junio C Hamanobb88cf42010-06-21 15:23:55329core.eol::
330Sets the line ending type to use in the working directory for
331files that have the `text` property set. Alternatives are
332'lf', 'crlf' and 'native', which uses the platform's native
333line ending. The default value is `native`. See
334linkgit:gitattributes[5] for more information on end-of-line
335conversion.
Junio C Hamanod9e0e5d2007-04-14 16:22:04336
Junio C Hamano26e590a2008-02-17 03:53:51337core.safecrlf::
Junio C Hamano076ffcc2013-02-06 05:13:21338If true, makes Git check if converting `CRLF` is reversible when
Junio C Hamanobb88cf42010-06-21 15:23:55339end-of-line conversion is active. Git will verify if a command
Junio C Hamano26e590a2008-02-17 03:53:51340modifies a file in the work tree either directly or indirectly.
341For example, committing a file followed by checking out the
342same file should yield the original file in the work tree. If
343this is not the case for the current setting of
Junio C Hamano076ffcc2013-02-06 05:13:21344`core.autocrlf`, Git will reject the file. The variable can
345be set to "warn", in which case Git will only warn about an
Junio C Hamano26e590a2008-02-17 03:53:51346irreversible conversion but continue the operation.
347+
348CRLF conversion bears a slight chance of corrupting data.
Junio C Hamano076ffcc2013-02-06 05:13:21349When it is enabled, Git will convert CRLF to LF during commit and LF to
Junio C Hamano26e590a2008-02-17 03:53:51350CRLF during checkout. A file that contains a mixture of LF and
Junio C Hamano076ffcc2013-02-06 05:13:21351CRLF before the commit cannot be recreated by Git. For text
Junio C Hamano26e590a2008-02-17 03:53:51352files this is the right thing to do: it corrects line endings
353such that we have only LF line endings in the repository.
354But for binary files that are accidentally classified as text the
355conversion can corrupt data.
356+
357If you recognize such corruption early you can easily fix it by
358setting the conversion type explicitly in .gitattributes. Right
359after committing you still have the original file in your work
360tree and this file is not yet corrupted. You can explicitly tell
Junio C Hamano076ffcc2013-02-06 05:13:21361Git that this file is binary and Git will handle the file
Junio C Hamano26e590a2008-02-17 03:53:51362appropriately.
363+
364Unfortunately, the desired effect of cleaning up text files with
365mixed line endings and the undesired effect of corrupting binary
366files cannot be distinguished. In both cases CRLFs are removed
367in an irreversible way. For text files this is the right thing
368to do because CRLFs are line endings, while for binary files
369converting CRLFs corrupts data.
370+
371Note, this safety check does not mean that a checkout will generate a
372file identical to the original file for a different setting of
Junio C Hamanobb88cf42010-06-21 15:23:55373`core.eol` and `core.autocrlf`, but only for the current one. For
374example, a text file with `LF` would be accepted with `core.eol=lf`
375and could later be checked out with `core.eol=crlf`, in which case the
Junio C Hamano26e590a2008-02-17 03:53:51376resulting file would contain `CRLF`, although the original file
377contained `LF`. However, in both work trees the line endings would be
378consistent, that is either all `LF` or all `CRLF`, but never mixed. A
379file with mixed line endings would be reported by the `core.safecrlf`
380mechanism.
381
Junio C Hamanobb88cf42010-06-21 15:23:55382core.autocrlf::
383Setting this variable to "true" is almost the same as setting
384the `text` attribute to "auto" on all files except that text
385files are not guaranteed to be normalized: files that contain
386`CRLF` in the repository will not be touched. Use this
387setting if you want to have `CRLF` line endings in your
388working directory even though the repository does not have
389normalized line endings. This variable can be set to 'input',
390in which case no output conversion is performed.
391
Junio C Hamanoaa83a7d2007-03-05 02:37:29392core.symlinks::
393If false, symbolic links are checked out as small plain files that
Junio C Hamano35738e82008-01-07 07:55:46394contain the link text. linkgit:git-update-index[1] and
395linkgit:git-add[1] will not change the recorded type to regular
Junio C Hamanoaa83a7d2007-03-05 02:37:29396file. Useful on filesystems like FAT that do not support
Junio C Hamano9df0c662009-11-23 11:09:27397symbolic links.
398+
399The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
400will probe and set core.symlinks false if appropriate when the repository
401is created.
Junio C Hamanoaa83a7d2007-03-05 02:37:29402
Junio C Hamano07824ce2006-04-25 07:36:54403core.gitProxy::
404A "proxy command" to execute (as 'command host port') instead
405of establishing direct connection to the remote server when
Junio C Hamano076ffcc2013-02-06 05:13:21406using the Git protocol for fetching. If the variable value is
Junio C Hamano07824ce2006-04-25 07:36:54407in the "COMMAND for DOMAIN" format, the command is applied only
408on hostnames ending with the specified domain string. This variable
409may be set multiple times and is matched in the given order;
410the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17411+
412Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
413(which always applies universally, without the special "for"
414handling).
Junio C Hamanoea82cff2009-03-18 01:54:48415+
416The special string `none` can be used as the proxy command to
417specify that no proxy be used for a given domain pattern.
418This is useful for excluding servers inside a firewall from
419proxy use, while defaulting to a common proxy for external domains.
Junio C Hamano07824ce2006-04-25 07:36:54420
421core.ignoreStat::
Junio C Hamanoe8acc8e2015-01-14 22:01:34422If true, Git will avoid using lstat() calls to detect if files have
423changed by setting the "assume-unchanged" bit for those tracked files
424which it has updated identically in both the index and working tree.
425+
426When files are modified outside of Git, the user will need to stage
427the modified files explicitly (e.g. see 'Examples' section in
428linkgit:git-update-index[1]).
429Git will not normally detect changes to those files.
430+
431This is useful on systems where lstat() calls are very slow, such as
432CIFS/Microsoft Windows.
433+
434False by default.
Junio C Hamano07824ce2006-04-25 07:36:54435
Junio C Hamano88a3a072006-05-04 08:01:43436core.preferSymlinkRefs::
437Instead of the default "symref" format for HEAD
438and other symbolic reference files, use symbolic links.
439This is sometimes needed to work with old scripts that
440expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54441
Junio C Hamano1025e752007-02-23 07:21:26442core.bare::
443If true this repository is assumed to be 'bare' and has no
444working directory associated with it. If this is the case a
445number of commands that require a working directory will be
Junio C Hamano35738e82008-01-07 07:55:46446disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Junio C Hamano1025e752007-02-23 07:21:26447+
Junio C Hamano35738e82008-01-07 07:55:46448This setting is automatically guessed by linkgit:git-clone[1] or
449linkgit:git-init[1] when the repository was created. By default a
Junio C Hamano1025e752007-02-23 07:21:26450repository that ends in "/.git" is assumed to be not bare (bare =
451false), while all other repositories are assumed to be bare (bare
452= true).
453
Junio C Hamanod526ba92007-07-02 00:17:42454core.worktree::
Junio C Hamano80d58462011-01-24 22:52:52455Set the path to the root of the working tree.
Junio C Hamano4cc4a842015-05-11 22:41:02456If GIT_COMMON_DIR environment variable is set, core.worktree
457is ignored and not used for determining the root of working tree.
Junio C Hamano764a6672007-10-23 01:23:31458This can be overridden by the GIT_WORK_TREE environment
Junio C Hamanoe1aeb5e2014-06-06 19:16:29459variable and the '--work-tree' command-line option.
Junio C Hamano5cd15182011-04-05 00:21:10460The value can be an absolute path or relative to the path to
Junio C Hamano80d58462011-01-24 22:52:52461the .git directory, which is either specified by --git-dir
462or GIT_DIR, or automatically discovered.
463If --git-dir or GIT_DIR is specified but none of
Junio C Hamano7d575a52008-04-30 08:45:27464--work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamano80d58462011-01-24 22:52:52465the current working directory is regarded as the top level
Junio C Hamano3609b332010-12-29 01:34:52466of your working tree.
Junio C Hamano80d58462011-01-24 22:52:52467+
468Note that this variable is honored even when set in a configuration
469file in a ".git" subdirectory of a directory and its value differs
470from the latter directory (e.g. "/path/to/.git/config" has
471core.worktree set to "/different/path"), which is most likely a
Junio C Hamano076ffcc2013-02-06 05:13:21472misconfiguration. Running Git commands in the "/path/to" directory will
Junio C Hamano80d58462011-01-24 22:52:52473still use "/different/path" as the root of the work tree and can cause
474confusion unless you know what you are doing (e.g. you are creating a
475read-only snapshot of the same index to a location different from the
476repository's usual working tree).
Junio C Hamanod526ba92007-07-02 00:17:42477
Junio C Hamano341071d2006-06-04 07:24:48478core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49479Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamanoa2ec14f2006-11-02 00:22:48480"$GIT_DIR/logs/<ref>", by appending the new and old
Junio C Hamanoe3f080d2013-04-22 02:27:13481SHA-1, the date/time and the reason of the update, but
Junio C Hamanoa2ec14f2006-11-02 00:22:48482only when the file exists. If this configuration
483variable is set to true, missing "$GIT_DIR/logs/<ref>"
Junio C Hamano15567bc2011-07-23 00:51:59484file is automatically created for branch heads (i.e. under
485refs/heads/), remote refs (i.e. under refs/remotes/),
486note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
Junio C Hamano1caaf472006-12-31 08:29:35487+
488This information can be used to determine what commit
489was the tip of a branch "2 days ago".
490+
491This value is true by default in a repository that has
492a working directory associated with it, and false by
493default in a bare repository.
Junio C Hamano341071d2006-06-04 07:24:48494
Junio C Hamano07824ce2006-04-25 07:36:54495core.repositoryFormatVersion::
496Internal variable identifying the repository format and layout
497version.
498
499core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42500When 'group' (or 'true'), the repository is made shareable between
501several users in a group (making sure all the files and objects are
502group-writable). When 'all' (or 'world' or 'everybody'), the
503repository will be readable by all users, additionally to being
Junio C Hamano076ffcc2013-02-06 05:13:21504group-shareable. When 'umask' (or 'false'), Git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37505reported by umask(2). When '0xxx', where '0xxx' is an octal number,
506files in the repository will have this mode value. '0xxx' will override
Junio C Hamano83eded12009-04-20 08:18:00507user's umask value (whereas the other options will only override
508requested parts of the user's umask value). Examples: '0660' will make
509the repo read/write-able for the owner and group, but inaccessible to
510others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Junio C Hamano2f102bb2008-04-26 02:23:37511repository that is group-readable but not group-writable.
512See linkgit:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54513
514core.warnAmbiguousRefs::
Junio C Hamano076ffcc2013-02-06 05:13:21515If true, Git will warn you if the ref name you passed it is ambiguous
Junio C Hamano947ab822013-03-19 23:07:29516and might match multiple refs in the repository. True by default.
Junio C Hamano07824ce2006-04-25 07:36:54517
Junio C Hamano7ec15722006-07-07 02:03:59518core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09519An integer -1..9, indicating a default compression level.
520-1 is the zlib default. 0 means no compression,
521and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42522If set, this provides a default to other compression variables,
Junio C Hamano322c6242015-03-23 21:32:46523such as 'core.looseCompression' and 'pack.compression'.
Junio C Hamanoa126a3b2006-07-04 04:55:26524
Junio C Hamano322c6242015-03-23 21:32:46525core.looseCompression::
Junio C Hamanof2ce2972007-05-20 19:12:09526An integer -1..9, indicating the compression level for objects that
527are not in a pack file. -1 is the zlib default. 0 means no
528compression, and 1..9 are various speed/size tradeoffs, 9 being
529slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42530not set, defaults to 1 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49531
Junio C Hamanofc4d38c2007-01-08 06:53:32532core.packedGitWindowSize::
533Number of bytes of a pack file to map into memory in a
534single mapping operation. Larger window sizes may allow
535your system to process a smaller number of large pack files
536more quickly. Smaller window sizes will negatively affect
537performance due to increased calls to the operating system's
538memory manager, but may improve performance when accessing
539a large number of large pack files.
540+
541Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
542MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
543be reasonable for all users/operating systems. You probably do
544not need to adjust this value.
545+
546Common unit suffixes of 'k', 'm', or 'g' are supported.
547
548core.packedGitLimit::
549Maximum number of bytes to map simultaneously into memory
550from pack files. If Git needs to access more than this many
551bytes at once to complete an operation it will unmap existing
552regions to reclaim virtual address space within the process.
553+
554Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
555This should be reasonable for all users/operating systems, except on
556the largest projects. You probably do not need to adjust this value.
557+
558Common unit suffixes of 'k', 'm', or 'g' are supported.
559
Junio C Hamanob8c51282007-03-19 10:43:30560core.deltaBaseCacheLimit::
561Maximum number of bytes to reserve for caching base objects
Junio C Hamano619596a2010-08-18 22:15:35562that may be referenced by multiple deltified objects. By storing the
Junio C Hamanob8c51282007-03-19 10:43:30563entire decompressed base objects in a cache Git is able
564to avoid unpacking and decompressing frequently used base
565objects multiple times.
566+
Junio C Hamanoe1aeb5e2014-06-06 19:16:29567Default is 96 MiB on all platforms. This should be reasonable
Junio C Hamanob8c51282007-03-19 10:43:30568for all users/operating systems, except on the largest projects.
569You probably do not need to adjust this value.
570+
571Common unit suffixes of 'k', 'm', or 'g' are supported.
572
Junio C Hamano5c246f22010-02-03 07:34:53573core.bigFileThreshold::
574Files larger than this size are stored deflated, without
575attempting delta compression. Storing large files without
576delta compression avoids excessive memory usage, at the
Junio C Hamano8e61f1f2014-09-11 21:53:45577slight expense of increased disk usage. Additionally files
578larger than this size are always treated as binary.
Junio C Hamano5c246f22010-02-03 07:34:53579+
580Default is 512 MiB on all platforms. This should be reasonable
581for most projects as source code and other text files can still
582be delta compressed, but larger binary media files won't be.
583+
584Common unit suffixes of 'k', 'm', or 'g' are supported.
Junio C Hamano5c246f22010-02-03 07:34:53585
Junio C Hamano322c6242015-03-23 21:32:46586core.excludesFile::
Junio C Hamano5e284b42007-05-22 07:23:37587In addition to '.gitignore' (per-directory) and
Junio C Hamano076ffcc2013-02-06 05:13:21588'.git/info/exclude', Git looks into this file for patterns
Junio C Hamanob76a6862012-05-02 22:02:46589of files which are not meant to be tracked. "`~/`" is expanded
590to the value of `$HOME` and "`~user/`" to the specified user's
Junio C Hamano8edb4c72012-07-09 20:33:55591home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
592If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
593is used instead. See linkgit:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37594
Junio C Hamano322c6242015-03-23 21:32:46595core.askPass::
Junio C Hamano3fd7b262010-09-08 22:44:20596Some commands (e.g. svn and http interfaces) that interactively
597ask for a password can be told to use an external program given
598via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
599environment variable. If not set, fall back to the value of the
600'SSH_ASKPASS' environment variable or, failing that, a simple password
601prompt. The external program shall be given a suitable prompt as
Junio C Hamanoe1aeb5e2014-06-06 19:16:29602command-line argument and write the password on its STDOUT.
Junio C Hamano3fd7b262010-09-08 22:44:20603
Junio C Hamano322c6242015-03-23 21:32:46604core.attributesFile::
Junio C Hamano3b4609d2010-09-30 00:04:34605In addition to '.gitattributes' (per-directory) and
Junio C Hamano076ffcc2013-02-06 05:13:21606'.git/info/attributes', Git looks into this file for attributes
Junio C Hamano3b4609d2010-09-30 00:04:34607(see linkgit:gitattributes[5]). Path expansions are made the same
Junio C Hamano322c6242015-03-23 21:32:46608way as for `core.excludesFile`. Its default value is
Junio C Hamano8edb4c72012-07-09 20:33:55609$XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
610set or empty, $HOME/.config/git/attributes is used instead.
Junio C Hamano3b4609d2010-09-30 00:04:34611
Junio C Hamanof6002a92007-07-20 10:28:22612core.editor::
613Commands such as `commit` and `tag` that lets you edit
Junio C Hamanoa6387422007-08-25 03:54:27614messages by launching an editor uses the value of this
Junio C Hamanof6002a92007-07-20 10:28:22615variable when it is set, and the environment variable
Junio C Hamano3b70d3c2009-11-21 17:37:37616`GIT_EDITOR` is not set. See linkgit:git-var[1].
Junio C Hamanof6002a92007-07-20 10:28:22617
Junio C Hamano322c6242015-03-23 21:32:46618core.commentChar::
Junio C Hamano3f2ed6f2013-02-04 19:24:09619Commands such as `commit` and `tag` that lets you edit
620messages consider a line that begins with this character
621commented, and removes them after the editor returns
622(default '#').
Junio C Hamanoe1aeb5e2014-06-06 19:16:29623+
624If set to "auto", `git-commit` would select a character that is not
625the beginning character of any line in existing commit messages.
Junio C Hamano3f2ed6f2013-02-04 19:24:09626
Junio C Hamano1dbca522015-05-22 20:48:55627core.packedRefsTimeout::
628The length of time, in milliseconds, to retry when trying to
629lock the `packed-refs` file. Value 0 means not to retry at
630all; -1 means to try indefinitely. Default is 1000 (i.e.,
631retry for 1 second).
632
Junio C Hamano6231f822011-10-24 05:18:52633sequence.editor::
Junio C Hamano778a3412013-03-28 23:24:30634Text editor used by `git rebase -i` for editing the rebase instruction file.
Junio C Hamano6231f822011-10-24 05:18:52635The value is meant to be interpreted by the shell when it is used.
636It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
637When not configured the default commit message editor is used instead.
638
Junio C Hamano28d8ede2007-07-05 05:51:38639core.pager::
Junio C Hamano0e0e0d22013-09-12 23:25:03640Text viewer for use by Git commands (e.g., 'less'). The value
641is meant to be interpreted by the shell. The order of preference
642is the `$GIT_PAGER` environment variable, then `core.pager`
643configuration, then `$PAGER`, and then the default chosen at
644compile time (usually 'less').
645+
Junio C Hamanoe1aeb5e2014-06-06 19:16:29646When the `LESS` environment variable is unset, Git sets it to `FRX`
Junio C Hamano0e0e0d22013-09-12 23:25:03647(if `LESS` environment variable is set, Git does not change it at
648all). If you want to selectively override Git's default setting
Junio C Hamanoe1aeb5e2014-06-06 19:16:29649for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
Junio C Hamano0e0e0d22013-09-12 23:25:03650be passed to the shell by Git, which will translate the final
Junio C Hamanoe1aeb5e2014-06-06 19:16:29651command to `LESS=FRX less -S`. The environment does not set the
652`S` option but the command line does, instructing less to truncate
653long lines. Similarly, setting `core.pager` to `less -+F` will
654deactivate the `F` option specified by the environment from the
655command-line, deactivating the "quit if one screen" behavior of
656`less`. One can specifically activate some flags for particular
657commands: for example, setting `pager.blame` to `less -S` enables
658line truncation only for `git blame`.
Junio C Hamanobc8d4782014-01-13 23:35:50659+
660Likewise, when the `LV` environment variable is unset, Git sets it
661to `-c`. You can override this setting by exporting `LV` with
662another value or setting `core.pager` to `lv +c`.
Junio C Hamano28d8ede2007-07-05 05:51:38663
Junio C Hamano942b35e2007-12-09 10:19:33664core.whitespace::
665A comma separated list of common whitespace problems to
Junio C Hamano1aa40d22010-01-21 17:46:43666notice. 'git diff' will use `color.diff.whitespace` to
667highlight them, and 'git apply --whitespace=error' will
Junio C Hamano3db8b412008-07-26 06:45:59668consider them as errors. You can prefix `-` to disable
669any of them (e.g. `-trailing-space`):
Junio C Hamano942b35e2007-12-09 10:19:33670+
Junio C Hamanob71a22d2009-10-17 08:23:47671* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano942b35e2007-12-09 10:19:33672 as an error (enabled by default).
673* `space-before-tab` treats a space character that appears immediately
674 before a tab character in the initial indent part of the line as an
675 error (enabled by default).
Junio C Hamano281fd392012-09-17 23:57:41676* `indent-with-non-tab` treats a line that is indented with space
677 characters instead of the equivalent tabs as an error (not enabled by
678 default).
Junio C Hamanocb39aea2010-05-09 07:24:48679* `tab-in-indent` treats a tab character in the initial indent part of
680 the line as an error (not enabled by default).
Junio C Hamanob71a22d2009-10-17 08:23:47681* `blank-at-eof` treats blank lines added at the end of file as an error
682 (enabled by default).
683* `trailing-space` is a short-hand to cover both `blank-at-eol` and
684 `blank-at-eof`.
Junio C Hamano601f3e52008-02-25 08:40:42685* `cr-at-eol` treats a carriage-return at the end of line as
686 part of the line terminator, i.e. with it, `trailing-space`
687 does not trigger if the character before such a carriage-return
688 is not a whitespace (not enabled by default).
Junio C Hamanoeef01fe2010-12-13 08:31:58689* `tabwidth=<n>` tells how many character positions a tab occupies; this
Junio C Hamano076ffcc2013-02-06 05:13:21690 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
Junio C Hamanoeef01fe2010-12-13 08:31:58691 errors. The default tab width is 8. Allowed values are 1 to 63.
Junio C Hamano942b35e2007-12-09 10:19:33692
Junio C Hamano322c6242015-03-23 21:32:46693core.fsyncObjectFiles::
Junio C Hamano9eb57532008-06-26 06:33:46694This boolean will enable 'fsync()' when writing object files.
695+
696This is a total waste of time and effort on a filesystem that orders
697data writes properly, but can be useful for filesystems that do not use
698journalling (traditional UNIX filesystems) or that only journal metadata
699and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
700
Junio C Hamano322c6242015-03-23 21:32:46701core.preloadIndex::
Junio C Hamano610d1762008-11-28 06:27:13702Enable parallel index preload for operations like 'git diff'
703+
704This can speed up operations like 'git diff' and 'git status' especially
705on filesystems like NFS that have weak caching semantics and thus
Junio C Hamanoc8c398a2014-06-16 21:14:05706relatively high IO latencies. When enabled, Git will do the
Junio C Hamano610d1762008-11-28 06:27:13707index comparison to the filesystem data in parallel, allowing
Junio C Hamanoc8c398a2014-06-16 21:14:05708overlapping IO's. Defaults to true.
Junio C Hamano610d1762008-11-28 06:27:13709
Junio C Hamanoa9499de2009-04-30 03:38:48710core.createObject::
711You can set this to 'link', in which case a hardlink followed by
712a delete of the source are used to make sure that object creation
713will not overwrite existing objects.
714+
715On some file system/operating system combinations, this is unreliable.
716Set this config setting to 'rename' there; However, This will remove the
717check that makes sure that existing object files will not get overwritten.
Junio C Hamanoe91ea772009-04-26 01:41:41718
Junio C Hamano3b70d3c2009-11-21 17:37:37719core.notesRef::
720When showing commit messages, also show notes which are stored in
Junio C Hamanoa574a092010-06-13 19:57:10721the given ref. The ref must be fully qualified. If the given
722ref does not exist, it is not an error but means that no
723notes should be printed.
Junio C Hamano3b70d3c2009-11-21 17:37:37724+
Junio C Hamanoa574a092010-06-13 19:57:10725This setting defaults to "refs/notes/commits", and it can be overridden by
726the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
Junio C Hamano3b70d3c2009-11-21 17:37:37727
Junio C Hamano3c8d6702010-01-13 23:09:03728core.sparseCheckout::
729Enable "sparse checkout" feature. See section "Sparse checkout" in
730linkgit:git-read-tree[1] for more information.
731
Junio C Hamano6371b0e2011-03-23 23:36:21732core.abbrev::
733Set the length object names are abbreviated to. If unspecified,
734many commands abbreviate to 7 hexdigits, which may not be enough
735for abbreviated object names to stay unique for sufficiently long
736time.
737
Junio C Hamano60186642010-12-02 14:18:26738add.ignoreErrors::
Junio C Hamanobe087982015-02-22 21:29:39739add.ignore-errors (deprecated)::
Junio C Hamano1aa40d22010-01-21 17:46:43740Tells 'git add' to continue adding files when some files cannot be
Junio C Hamano3d141512009-06-01 01:22:40741added due to indexing errors. Equivalent to the '--ignore-errors'
Junio C Hamanobe087982015-02-22 21:29:39742option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
743as it does not follow the usual naming convention for configuration
744variables.
Junio C Hamano3d141512009-06-01 01:22:40745
Junio C Hamano33db4372006-06-07 19:51:45746alias.*::
Junio C Hamano35738e82008-01-07 07:55:46747Command aliases for the linkgit:git[1] command wrapper - e.g.
Junio C Hamano33db4372006-06-07 19:51:45748after defining "alias.last = cat-file commit HEAD", the invocation
749"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17750confusion and troubles with script usage, aliases that
Junio C Hamano076ffcc2013-02-06 05:13:21751hide existing Git commands are ignored. Arguments are split by
Junio C Hamanof1d14802006-06-08 00:48:17752spaces, the usual shell quoting and escaping is supported.
Junio C Hamano2efd5e42014-11-10 22:38:52753A quote pair or a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39754+
755If the alias expansion is prefixed with an exclamation point,
756it will be treated as a shell command. For example, defining
757"alias.new = !gitk --all --not ORIG_HEAD", the invocation
758"git new" is equivalent to running the shell command
Junio C Hamano48bc1ce2009-07-09 16:49:19759"gitk --all --not ORIG_HEAD". Note that shell commands will be
760executed from the top-level directory of a repository, which may
761not necessarily be the current directory.
Junio C Hamano5f2627d2011-05-06 20:23:48762'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
763from the original current directory. See linkgit:git-rev-parse[1].
Junio C Hamano9cb74f22007-02-12 04:15:05764
Junio C Hamanocaa712a2010-03-11 01:17:35765am.keepcr::
766If true, git-am will call git-mailsplit for patches in mbox format
767with parameter '--keep-cr'. In this case git-mailsplit will
Junio C Hamano619596a2010-08-18 22:15:35768not remove `\r` from lines ending with `\r\n`. Can be overridden
Junio C Hamanocaa712a2010-03-11 01:17:35769by giving '--no-keep-cr' from the command line.
770See linkgit:git-am[1], linkgit:git-mailsplit[1].
771
Junio C Hamano9c512872015-08-12 21:59:25772am.threeWay::
773By default, `git am` will fail if the patch does not apply cleanly. When
774set to true, this setting tells `git am` to fall back on 3-way merge if
775the patch records the identity of blobs it is supposed to apply to and
776we have those blobs available locally (equivalent to giving the `--3way`
777option from the command line). Defaults to `false`.
778See linkgit:git-am[1].
779
Junio C Hamano322c6242015-03-23 21:32:46780apply.ignoreWhitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43781When set to 'change', tells 'git apply' to ignore changes in
Junio C Hamanofe24db02009-08-22 05:10:47782whitespace, in the same way as the '--ignore-space-change'
783option.
Junio C Hamano1aa40d22010-01-21 17:46:43784When set to one of: no, none, never, false tells 'git apply' to
Junio C Hamanofe24db02009-08-22 05:10:47785respect all whitespace differences.
786See linkgit:git-apply[1].
787
Junio C Hamano07824ce2006-04-25 07:36:54788apply.whitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43789Tells 'git apply' how to handle whitespaces, in the same way
Junio C Hamano35738e82008-01-07 07:55:46790as the '--whitespace' option. See linkgit:git-apply[1].
Junio C Hamano07824ce2006-04-25 07:36:54791
Junio C Hamano322c6242015-03-23 21:32:46792branch.autoSetupMerge::
Junio C Hamano1aa40d22010-01-21 17:46:43793Tells 'git branch' and 'git checkout' to set up new branches
Junio C Hamano24bc09a2008-02-28 00:27:44794so that linkgit:git-pull[1] will appropriately merge from the
795starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32796this behavior can be chosen per-branch using the `--track`
Junio C Hamano24bc09a2008-02-28 00:27:44797and `--no-track` options. The valid settings are: `false` -- no
798automatic setup is done; `true` -- automatic setup is done when the
Junio C Hamano97bcb482010-11-25 03:16:07799starting point is a remote-tracking branch; `always` --
800automatic setup is done when the starting point is either a
801local branch or remote-tracking
Junio C Hamano24bc09a2008-02-28 00:27:44802branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32803
Junio C Hamano322c6242015-03-23 21:32:46804branch.autoSetupRebase::
Junio C Hamano1aa40d22010-01-21 17:46:43805When a new branch is created with 'git branch' or 'git checkout'
Junio C Hamano076ffcc2013-02-06 05:13:21806that tracks another branch, this variable tells Git to set
Junio C Hamano869bb802008-05-12 00:29:47807up pull to rebase instead of merge (see "branch.<name>.rebase").
808When `never`, rebase is never automatically set to true.
809When `local`, rebase is set to true for tracked branches of
810other local branches.
811When `remote`, rebase is set to true for tracked branches of
Junio C Hamano97bcb482010-11-25 03:16:07812remote-tracking branches.
Junio C Hamano869bb802008-05-12 00:29:47813When `always`, rebase will be set to true for all tracking
814branches.
Junio C Hamano322c6242015-03-23 21:32:46815See "branch.autoSetupMerge" for details on how to set up a
Junio C Hamano869bb802008-05-12 00:29:47816branch to track another branch.
817This option defaults to never.
818
Junio C Hamano47c1e3c2006-09-25 04:45:55819branch.<name>.remote::
Junio C Hamano63b6fdb2013-04-07 23:37:13820When on branch <name>, it tells 'git fetch' and 'git push'
821which remote to fetch from/push to. The remote to push to
Junio C Hamano322c6242015-03-23 21:32:46822may be overridden with `remote.pushDefault` (for all branches).
Junio C Hamano63b6fdb2013-04-07 23:37:13823The remote to push to, for the current branch, may be further
Junio C Hamano322c6242015-03-23 21:32:46824overridden by `branch.<name>.pushRemote`. If no remote is
Junio C Hamano63b6fdb2013-04-07 23:37:13825configured, or if you are not on any branch, it defaults to
Junio C Hamano322c6242015-03-23 21:32:46826`origin` for fetching and `remote.pushDefault` for pushing.
Junio C Hamano238ce9c2013-10-23 21:56:38827Additionally, `.` (a period) is the current local repository
828(a dot-repository), see `branch.<name>.merge`'s final note below.
Junio C Hamano63b6fdb2013-04-07 23:37:13829
Junio C Hamano322c6242015-03-23 21:32:46830branch.<name>.pushRemote::
Junio C Hamano63b6fdb2013-04-07 23:37:13831When on branch <name>, it overrides `branch.<name>.remote` for
Junio C Hamano322c6242015-03-23 21:32:46832pushing. It also overrides `remote.pushDefault` for pushing
Junio C Hamano63b6fdb2013-04-07 23:37:13833from branch <name>. When you pull from one place (e.g. your
834upstream) and push to another place (e.g. your own publishing
Junio C Hamano322c6242015-03-23 21:32:46835repository), you would want to set `remote.pushDefault` to
Junio C Hamano63b6fdb2013-04-07 23:37:13836specify the remote to push to for all branches, and use this
837option to override it for a specific branch.
Junio C Hamano47c1e3c2006-09-25 04:45:55838
839branch.<name>.merge::
Junio C Hamano0706c802009-03-30 22:34:19840Defines, together with branch.<name>.remote, the upstream branch
Junio C Hamanob02377c2011-04-28 22:26:02841for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
Junio C Hamano1aa40d22010-01-21 17:46:43842branch to merge and can also affect 'git push' (see push.default).
843When in branch <name>, it tells 'git fetch' the default
Junio C Hamanoc2b47092007-10-25 06:50:31844refspec to be marked for merging in FETCH_HEAD. The value is
845handled like the remote part of a refspec, and must match a
846ref which is fetched from the remote given by
847"branch.<name>.remote".
Junio C Hamano1aa40d22010-01-21 17:46:43848The merge information is used by 'git pull' (which at first calls
849'git fetch') to lookup the default branch for merging. Without
850this option, 'git pull' defaults to merge the first refspec fetched.
Junio C Hamano96010b22006-12-09 21:15:46851Specify multiple values to get an octopus merge.
Junio C Hamano1aa40d22010-01-21 17:46:43852If you wish to setup 'git pull' so that it merges into <name> from
Junio C Hamano6e149c02007-03-16 10:21:07853another branch in the local repository, you can point
Junio C Hamano238ce9c2013-10-23 21:56:38854branch.<name>.merge to the desired branch, and use the relative path
855setting `.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:55856
Junio C Hamano322c6242015-03-23 21:32:46857branch.<name>.mergeOptions::
Junio C Hamano1b50ce92007-10-03 12:05:53858Sets default options for merging into branch <name>. The syntax and
Junio C Hamanoc0e55e72009-10-10 00:56:29859supported options are the same as those of linkgit:git-merge[1], but
Junio C Hamano1b50ce92007-10-03 12:05:53860option values containing whitespace characters are currently not
861supported.
862
Junio C Hamano0c999702007-12-03 09:57:55863branch.<name>.rebase::
864When true, rebase the branch <name> on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:08865instead of merging the default branch from the default remote when
Junio C Hamano515ab1d2011-12-09 23:41:20866"git pull" is run. See "pull.rebase" for doing this in a non
867branch-specific manner.
868+
Junio C Hamano7db630e2015-09-17 20:26:22869When preserve, also pass `--preserve-merges` along to 'git rebase'
870so that locally committed merge commits will not be flattened
871by running 'git pull'.
Junio C Hamanocf4a1742013-09-11 22:57:50872+
Junio C Hamano289d7e82016-01-27 00:20:38873When the value is `interactive`, the rebase is run in interactive mode.
874+
Junio C Hamano515ab1d2011-12-09 23:41:20875*NOTE*: this is a possibly dangerous operation; do *not* use
876it unless you understand the implications (see linkgit:git-rebase[1]
877for details).
Junio C Hamano0c999702007-12-03 09:57:55878
Junio C Hamano46247182013-01-09 20:50:28879branch.<name>.description::
880Branch description, can be edited with
881`git branch --edit-description`. Branch description is
882automatically added in the format-patch cover letter or
883request-pull summary.
884
Junio C Hamano8760ea62008-03-14 08:58:45885browser.<tool>.cmd::
886Specify the command to invoke the specified browser. The
887specified command is evaluated in shell with the URLs passed
Junio C Hamano360e3a12011-07-13 23:51:56888as arguments. (See linkgit:git-web{litdd}browse[1].)
Junio C Hamano8760ea62008-03-14 08:58:45889
Junio C Hamanoe35a6fc2008-01-29 09:46:27890browser.<tool>.path::
891Override the path for the given tool that may be used to
892browse HTML help (see '-w' option in linkgit:git-help[1]) or a
893working repository in gitweb (see linkgit:git-instaweb[1]).
894
Junio C Hamano47b9acd2007-04-24 07:34:34895clean.requireForce::
Junio C Hamanoe6f28d02013-09-17 21:34:00896A boolean to make git-clean do nothing unless given -f,
897-i or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:34898
Junio C Hamanoeb692952007-01-03 22:02:12899color.branch::
900A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46901linkgit:git-branch[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21902`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoeb692952007-01-03 22:02:12903only when the output is to a terminal. Defaults to false.
904
905color.branch.<slot>::
906Use customized color for branch coloration. `<slot>` is one of
907`current` (the current branch), `local` (a local branch),
Junio C Hamano76927822013-04-19 21:26:57908`remote` (a remote-tracking branch in refs/remotes/),
909`upstream` (upstream tracking branch), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:22910refs).
Junio C Hamanoeb692952007-01-03 22:02:12911
Junio C Hamano3f403b02006-12-13 10:14:13912color.diff::
Junio C Hamano5f2627d2011-05-06 20:23:48913Whether to use ANSI escape sequences to add color to patches.
914If this is set to `always`, linkgit:git-diff[1],
915linkgit:git-log[1], and linkgit:git-show[1] will use color
916for all patches. If it is set to `true` or `auto`, those
917commands will only use color when output is to the terminal.
918Defaults to false.
919+
Junio C Hamanod75148a2014-04-08 19:48:38920This does not affect linkgit:git-format-patch[1] or the
Junio C Hamano5f2627d2011-05-06 20:23:48921'git-diff-{asterisk}' plumbing commands. Can be overridden on the
922command line with the `--color[=<when>]` option.
Junio C Hamano9ae1a062006-07-10 08:12:34923
Junio C Hamano3f403b02006-12-13 10:14:13924color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:22925Use customized color for diff colorization. `<slot>` specifies
926which part of the patch to use the specified color, and is one
Junio C Hamano8c5d5942015-06-11 19:37:48927of `context` (context text - `plain` is a historical synonym),
928`meta` (metainformation), `frag`
Junio C Hamano2bd8a742009-12-01 21:16:59929(hunk header), 'func' (function in hunk header), `old` (removed lines),
930`new` (added lines), `commit` (commit headers), or `whitespace`
Junio C Hamano07622622015-03-20 21:47:26931(highlighting whitespace errors).
Junio C Hamano9ae1a062006-07-10 08:12:34932
Junio C Hamano7d449522010-07-01 00:08:51933color.decorate.<slot>::
934Use customized color for 'git log --decorate' output. `<slot>` is one
935of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
Junio C Hamano97bcb482010-11-25 03:16:07936branches, remote-tracking branches, tags, stash and HEAD, respectively.
Junio C Hamano7d449522010-07-01 00:08:51937
Junio C Hamanod257cff2009-03-18 05:27:16938color.grep::
939When set to `always`, always highlight matches. When `false` (or
940`never`), never. When set to `true` or `auto`, use color only
941when the output is written to the terminal. Defaults to `false`.
942
Junio C Hamano0299d922010-03-20 20:59:31943color.grep.<slot>::
944Use customized color for grep colorization. `<slot>` specifies which
945part of the line to use the specified color, and is one of
946+
947--
948`context`;;
949non-matching text in context lines (when using `-A`, `-B`, or `-C`)
950`filename`;;
951filename prefix (when not using `-h`)
952`function`;;
953function name lines (when using `-p`)
954`linenumber`;;
955line number prefix (when using `-n`)
956`match`;;
Junio C Hamanoc14e6ad2014-10-31 20:25:53957matching text (same as setting `matchContext` and `matchSelected`)
958`matchContext`;;
959matching text in context lines
960`matchSelected`;;
961matching text in selected lines
Junio C Hamano0299d922010-03-20 20:59:31962`selected`;;
963non-matching text in selected lines
964`separator`;;
965separators between fields on a line (`:`, `-`, and `=`)
966and between hunks (`--`)
967--
Junio C Hamanod257cff2009-03-18 05:27:16968
Junio C Hamano00b8b632007-12-07 09:50:49969color.interactive::
Junio C Hamano35738e82008-01-07 07:55:46970When set to `always`, always use colors for interactive prompts
Junio C Hamano58f587a2013-07-22 19:20:59971and displays (such as those used by "git-add --interactive" and
972"git-clean --interactive"). When false (or `never`), never.
973When set to `true` or `auto`, use colors only when the output is
974to the terminal. Defaults to false.
Junio C Hamano00b8b632007-12-07 09:50:49975
976color.interactive.<slot>::
Junio C Hamano58f587a2013-07-22 19:20:59977Use customized color for 'git add --interactive' and 'git clean
978--interactive' output. `<slot>` may be `prompt`, `header`, `help`
979or `error`, for four distinct types of normal output from
Junio C Hamano07622622015-03-20 21:47:26980interactive commands.
Junio C Hamano00b8b632007-12-07 09:50:49981
Junio C Hamanoe7935c42006-12-13 21:32:17982color.pager::
983A boolean to enable/disable colored output when the pager is in
984use (default is true).
985
Junio C Hamano322c6242015-03-23 21:32:46986color.showBranch::
Junio C Hamano52ba2952009-05-18 17:43:02987A boolean to enable/disable color in the output of
988linkgit:git-show-branch[1]. May be set to `always`,
989`false` (or `never`) or `auto` (or `true`), in which case colors are used
990only when the output is to a terminal. Defaults to false.
991
Junio C Hamanoe7935c42006-12-13 21:32:17992color.status::
993A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46994linkgit:git-status[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21995`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoe7935c42006-12-13 21:32:17996only when the output is to a terminal. Defaults to false.
997
998color.status.<slot>::
999Use customized color for status colorization. `<slot>` is
1000one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:041001`added` or `updated` (files which are added but not committed),
1002`changed` (files which are changed but not added in the index),
Junio C Hamano076ffcc2013-02-06 05:13:211003`untracked` (files which are not tracked by Git),
Junio C Hamano5992a252015-03-17 23:39:301004`branch` (the current branch),
Junio C Hamanob713ff12008-05-24 01:12:301005`nobranch` (the color the 'no branch' warning is shown in, defaulting
Junio C Hamano5992a252015-03-17 23:39:301006to red), or
1007`unmerged` (files which have unmerged changes).
Junio C Hamanoe7935c42006-12-13 21:32:171008
Junio C Hamano83d46a22008-02-21 02:29:421009color.ui::
Junio C Hamano5f2627d2011-05-06 20:23:481010This variable determines the default value for variables such
1011as `color.diff` and `color.grep` that control the use of color
1012per command family. Its scope will expand as more commands learn
1013configuration to set a default for the `--color` option. Set it
Junio C Hamanofa1d3492013-06-20 23:39:431014to `false` or `never` if you prefer Git commands not to use
1015color unless enabled explicitly with some other configuration
1016or the `--color` option. Set it to `always` if you want all
1017output not intended for machine consumption to use color, to
1018`true` or `auto` (this is the default since Git 1.8.4) if you
1019want such output to use color when written to the terminal.
Junio C Hamano83d46a22008-02-21 02:29:421020
Junio C Hamano22700fb2012-05-03 23:07:251021column.ui::
1022Specify whether supported commands should output in columns.
1023This variable consists of a list of tokens separated by spaces
1024or commas:
1025+
Junio C Hamanoa1952302013-07-01 21:31:181026These options control when the feature should be enabled
1027(defaults to 'never'):
1028+
Junio C Hamano22700fb2012-05-03 23:07:251029--
1030`always`;;
1031always show in columns
1032`never`;;
1033never show in columns
1034`auto`;;
1035show in columns if the output is to the terminal
Junio C Hamanoa1952302013-07-01 21:31:181036--
1037+
1038These options control layout (defaults to 'column'). Setting any
1039of these implies 'always' if none of 'always', 'never', or 'auto' are
1040specified.
1041+
1042--
Junio C Hamano22700fb2012-05-03 23:07:251043`column`;;
Junio C Hamanoa1952302013-07-01 21:31:181044fill columns before rows
Junio C Hamano22700fb2012-05-03 23:07:251045`row`;;
1046fill rows before columns
1047`plain`;;
1048show in one column
Junio C Hamanoa1952302013-07-01 21:31:181049--
1050+
1051Finally, these options can be combined with a layout option (defaults
1052to 'nodense'):
1053+
1054--
Junio C Hamano22700fb2012-05-03 23:07:251055`dense`;;
1056make unequal size columns to utilize more space
1057`nodense`;;
1058make equal size columns
1059--
Junio C Hamano22700fb2012-05-03 23:07:251060
1061column.branch::
1062Specify whether to output branch listing in `git branch` in columns.
1063See `column.ui` for details.
1064
Junio C Hamano58f587a2013-07-22 19:20:591065column.clean::
1066Specify the layout when list items in `git clean -i`, which always
1067shows files and directories in columns. See `column.ui` for details.
1068
Junio C Hamano22700fb2012-05-03 23:07:251069column.status::
1070Specify whether to output untracked files in `git status` in columns.
1071See `column.ui` for details.
1072
1073column.tag::
1074Specify whether to output tag listing in `git tag` in columns.
1075See `column.ui` for details.
1076
Junio C Hamanoce836cc2013-01-21 02:01:531077commit.cleanup::
1078This setting overrides the default of the `--cleanup` option in
1079`git commit`. See linkgit:git-commit[1] for details. Changing the
1080default can be useful when you always want to keep lines that begin
1081with comment character `#` in your log message, in which case you
1082would do `git config commit.cleanup whitespace` (note that you will
1083have to remove the help lines that begin with `#` in the commit log
1084template yourself, if you do this).
1085
Junio C Hamano322c6242015-03-23 21:32:461086commit.gpgSign::
Junio C Hamano5b3533d2014-02-27 23:07:151087
1088A boolean to specify whether all commits should be GPG signed.
1089Use of this option when doing operations such as rebase can
1090result in a large number of commits being signed. It may be
1091convenient to use an agent to avoid typing your GPG passphrase
1092several times.
1093
Junio C Hamanod0d892c2010-01-24 20:06:291094commit.status::
Junio C Hamano6ce6b6c2010-01-18 01:25:501095A boolean to enable/disable inclusion of status information in the
1096commit message template when using an editor to prepare the commit
1097message. Defaults to true.
1098
Junio C Hamano4653c6f2008-11-26 22:50:201099commit.template::
1100Specify a file to use as the template for new commit messages.
Junio C Hamanob76a6862012-05-02 22:02:461101"`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
Junio C Hamanobf984de2009-11-23 06:11:191102specified user's home directory.
Junio C Hamano4653c6f2008-11-26 22:50:201103
Junio C Hamano0df92712011-12-21 22:30:441104credential.helper::
1105Specify an external helper to be called when a username or
1106password credential is needed; the helper may consult external
1107storage to avoid prompting the user for the credentials. See
1108linkgit:gitcredentials[7] for details.
1109
1110credential.useHttpPath::
1111When acquiring credentials, consider the "path" component of an http
1112or https URL to be important. Defaults to false. See
1113linkgit:gitcredentials[7] for more information.
1114
1115credential.username::
1116If no username is set for a network authentication, use this username
1117by default. See credential.<context>.* below, and
1118linkgit:gitcredentials[7].
1119
1120credential.<url>.*::
1121Any of the credential.* options above can be applied selectively to
1122some credentials. For example "credential.https://example.com.username"
1123would set the default username only for https connections to
1124example.com. See linkgit:gitcredentials[7] for details on how URLs are
1125matched.
1126
Junio C Hamanoabb8a052015-12-04 22:43:111127credentialCache.ignoreSIGHUP::
1128Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1129
Junio C Hamano209ebe82011-04-27 21:09:591130include::diff-config.txt[]
Junio C Hamano3bd66e92009-04-18 06:17:561131
1132difftool.<tool>.path::
1133Override the path for the given tool. This is useful in case
1134your tool is not in the PATH.
1135
1136difftool.<tool>.cmd::
1137Specify the command to invoke the specified diff tool.
1138The specified command is evaluated in shell with the following
1139variables available: 'LOCAL' is set to the name of the temporary
1140file containing the contents of the diff pre-image and 'REMOTE'
1141is set to the name of the temporary file containing the contents
1142of the diff post-image.
1143
1144difftool.prompt::
1145Prompt before each invocation of the diff tool.
1146
Junio C Hamano0d75e872010-12-17 06:57:261147fetch.recurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:101148This option can be either set to a boolean value or to 'on-demand'.
1149Setting it to a boolean changes the behavior of fetch and pull to
1150unconditionally recurse into submodules when set to true or to not
1151recurse at all when set to false. When set to 'on-demand' (the default
1152value), fetch and pull will only recurse into a populated submodule
1153when its superproject retrieves a commit that updates the submodule's
1154reference.
Junio C Hamano0d75e872010-12-17 06:57:261155
Junio C Hamano8fb66e52011-10-05 20:59:511156fetch.fsckObjects::
1157If it is set to true, git-fetch-pack will check all fetched
1158objects. It will abort in the case of a malformed object or a
1159broken link. The result of an abort are only dangling objects.
1160Defaults to false. If not set, the value of `transfer.fsckObjects`
1161is used instead.
1162
Junio C Hamano54ea8d32007-01-25 07:59:481163fetch.unpackLimit::
Junio C Hamano076ffcc2013-02-06 05:13:211164If the number of objects fetched over the Git native
Junio C Hamano54ea8d32007-01-25 07:59:481165transfer is below this
1166limit, then the objects will be unpacked into loose object
1167files. However if the number of received objects equals or
1168exceeds this limit then the received pack will be stored as
1169a pack, after adding any missing delta bases. Storing the
1170pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:171171especially on slow filesystems. If not set, the value of
1172`transfer.unpackLimit` is used instead.
Junio C Hamano54ea8d32007-01-25 07:59:481173
Junio C Hamano8eac2682013-09-09 22:35:201174fetch.prune::
1175If true, fetch will automatically behave as if the `--prune`
1176option was given on the command line. See also `remote.<name>.prune`.
1177
Junio C Hamanof4581102009-04-25 08:29:591178format.attach::
1179Enable multipart/mixed attachments as the default for
1180'format-patch'. The value can also be a double quoted string
1181which will enable attachments as the default and set the
1182value as the boundary. See the --attach option in
1183linkgit:git-format-patch[1].
1184
Junio C Hamano8c5802d2007-11-15 00:13:361185format.numbered::
Junio C Hamano7d06a8a2008-10-20 05:42:331186A boolean which can enable or disable sequence numbers in patch
1187subjects. It defaults to "auto" which enables it only if there
1188is more than one patch. It can be enabled or disabled for all
1189messages by setting it to "true" or "false". See --numbered
1190option in linkgit:git-format-patch[1].
Junio C Hamano8c5802d2007-11-15 00:13:361191
Junio C Hamano07824ce2006-04-25 07:36:541192format.headers::
1193Additional email headers to include in a patch to be submitted
Junio C Hamano35738e82008-01-07 07:55:461194by mail. See linkgit:git-format-patch[1].
Junio C Hamano07824ce2006-04-25 07:36:541195
Junio C Hamano70664a02010-07-13 22:48:051196format.to::
Junio C Hamanof4581102009-04-25 08:29:591197format.cc::
Junio C Hamano70664a02010-07-13 22:48:051198Additional recipients to include in a patch to be submitted
1199by mail. See the --to and --cc options in
1200linkgit:git-format-patch[1].
Junio C Hamanof4581102009-04-25 08:29:591201
Junio C Hamano322c6242015-03-23 21:32:461202format.subjectPrefix::
Junio C Hamanof4581102009-04-25 08:29:591203The default for format-patch is to output files with the '[PATCH]'
1204subject prefix. Use this variable to change that prefix.
1205
Junio C Hamano89a57342010-06-22 23:22:551206format.signature::
1207The default for format-patch is to output a signature containing
Junio C Hamano076ffcc2013-02-06 05:13:211208the Git version number. Use this variable to change that default.
Junio C Hamano89a57342010-06-22 23:22:551209Set this variable to the empty string ("") to suppress
1210signature generation.
1211
Junio C Hamano322c6242015-03-23 21:32:461212format.signatureFile::
Junio C Hamanoc8c398a2014-06-16 21:14:051213Works just like format.signature except the contents of the
1214file specified by this variable will be used as the signature.
1215
Junio C Hamanod4c8e112007-03-04 10:32:381216format.suffix::
1217The default for format-patch is to output files with the suffix
1218`.patch`. Use this variable to change that suffix (make sure to
1219include the dot if you want it).
1220
Junio C Hamano86bcccc2008-03-08 09:33:551221format.pretty::
1222The default pretty format for log/show/whatchanged command,
1223See linkgit:git-log[1], linkgit:git-show[1],
1224linkgit:git-whatchanged[1].
1225
Junio C Hamanoea6a7642009-03-11 23:56:191226format.thread::
Junio C Hamano1aa40d22010-01-21 17:46:431227The default threading style for 'git format-patch'. Can be
Junio C Hamanob141a922010-01-10 19:55:141228a boolean value, or `shallow` or `deep`. `shallow` threading
1229makes every mail a reply to the head of the series,
Junio C Hamanoea6a7642009-03-11 23:56:191230where the head is chosen from the cover letter, the
Junio C Hamanob76a6862012-05-02 22:02:461231`--in-reply-to`, and the first patch mail, in this order.
Junio C Hamanof4581102009-04-25 08:29:591232`deep` threading makes every mail a reply to the previous one.
Junio C Hamanoea6a7642009-03-11 23:56:191233A true boolean value is the same as `shallow`, and a false
1234value disables threading.
1235
Junio C Hamano322c6242015-03-23 21:32:461236format.signOff::
Junio C Hamano804a9742013-04-28 23:10:311237A boolean value which lets you enable the `-s/--signoff` option of
1238format-patch by default. *Note:* Adding the Signed-off-by: line to a
1239patch should be a conscious act and means that you certify you have
1240the rights to submit this work under the same open source license.
1241Please see the 'SubmittingPatches' document for further discussion.
Junio C Hamano5f9a6f02009-04-06 08:26:561242
Junio C Hamanoea3b7522013-04-18 19:37:531243format.coverLetter::
1244A boolean that controls whether to generate a cover-letter when
1245format-patch is invoked, but in addition can be set to "auto", to
1246generate a cover-letter only when there's more than one patch.
1247
Junio C Hamano289d7e82016-01-27 00:20:381248format.outputDirectory::
1249Set a custom directory to store the resulting files instead of the
1250current working directory.
1251
Junio C Hamano209ebe82011-04-27 21:09:591252filter.<driver>.clean::
1253The command which is used to convert the content of a worktree
1254file to a blob upon checkin. See linkgit:gitattributes[5] for
1255details.
1256
1257filter.<driver>.smudge::
1258The command which is used to convert the content of a blob
1259object to a worktree file upon checkout. See
1260linkgit:gitattributes[5] for details.
1261
Junio C Hamanod7ed4042015-08-03 19:43:001262fsck.<msg-id>::
1263Allows overriding the message type (error, warn or ignore) of a
1264specific message ID such as `missingEmail`.
1265+
1266For convenience, fsck prefixes the error/warning with the message ID,
1267e.g. "missingEmail: invalid author/committer line - missing email" means
1268that setting `fsck.missingEmail = ignore` will hide that issue.
1269+
1270This feature is intended to support working with legacy repositories
1271which cannot be repaired without disruptive changes.
1272
1273fsck.skipList::
1274The path to a sorted list of object names (i.e. one SHA-1 per
1275line) that are known to be broken in a non-fatal way and should
1276be ignored. This feature is useful when an established project
1277should be accepted despite early commits containing errors that
1278can be safely ignored such as invalid committer email addresses.
1279Note: corrupt objects cannot be skipped with this setting.
1280
Junio C Hamano624dd4c2014-04-03 21:56:301281gc.aggressiveDepth::
1282The depth parameter used in the delta compression
1283algorithm used by 'git gc --aggressive'. This defaults
1284to 250.
1285
Junio C Hamanof2ce2972007-05-20 19:12:091286gc.aggressiveWindow::
1287The window size parameter used in the delta compression
Junio C Hamano1aa40d22010-01-21 17:46:431288algorithm used by 'git gc --aggressive'. This defaults
Junio C Hamanob04bb3f2010-04-14 14:07:361289to 250.
Junio C Hamanof2ce2972007-05-20 19:12:091290
Junio C Hamano1b50ce92007-10-03 12:05:531291gc.auto::
1292When there are approximately more than this many loose
1293objects in the repository, `git gc --auto` will pack them.
1294Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:171295light-weight garbage collection from time to time. The
1296default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531297
Junio C Hamano322c6242015-03-23 21:32:461298gc.autoPackLimit::
Junio C Hamano1b50ce92007-10-03 12:05:531299When there are more than this many packs that are not
1300marked with `*.keep` file in the repository, `git gc
Junio C Hamanoe77b0152008-01-12 06:44:171301--auto` consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:371302default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531303
Junio C Hamano322c6242015-03-23 21:32:461304gc.autoDetach::
Junio C Hamanofb5ffde2014-11-04 22:38:561305Make `git gc --auto` return immediately and run in background
Junio C Hamano08ef8c22014-03-10 14:53:441306if the system supports it. Default is true.
1307
Junio C Hamano322c6242015-03-23 21:32:461308gc.packRefs::
Junio C Hamanob141a922010-01-10 19:55:141309Running `git pack-refs` in a repository renders it
1310unclonable by Git versions prior to 1.5.1.2 over dumb
1311transports such as HTTP. This variable determines whether
Junio C Hamanocdd1c332010-12-20 10:08:001312'git gc' runs `git pack-refs`. This can be set to `notbare`
Junio C Hamanob141a922010-01-10 19:55:141313to enable it within all non-bare repos or it can be set to a
1314boolean value. The default is `true`.
Junio C Hamano9d52e572007-02-13 23:48:201315
Junio C Hamano322c6242015-03-23 21:32:461316gc.pruneExpire::
Junio C Hamano1aa40d22010-01-21 17:46:431317When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
Junio C Hamanoa3148f52009-01-14 08:49:571318Override the grace period with this config variable. The value
Junio C Hamano9c512872015-08-12 21:59:251319"now" may be used to disable this grace period and always prune
1320unreachable objects immediately, or "never" may be used to
1321suppress pruning.
Junio C Hamano09a926d2008-03-13 07:55:291322
Junio C Hamano9c512872015-08-12 21:59:251323gc.worktreePruneExpire::
1324When 'git gc' is run, it calls
1325'git worktree prune --expire 3.months.ago'.
1326This config variable can be used to set a different grace
1327period. The value "now" may be used to disable the grace
1328period and prune $GIT_DIR/worktrees immediately, or "never"
1329may be used to suppress pruning.
Junio C Hamano4cc4a842015-05-11 22:41:021330
Junio C Hamano322c6242015-03-23 21:32:461331gc.reflogExpire::
1332gc.<pattern>.reflogExpire::
Junio C Hamano1aa40d22010-01-21 17:46:431333'git reflog expire' removes reflog entries older than
Junio C Hamano9c512872015-08-12 21:59:251334this time; defaults to 90 days. The value "now" expires all
1335entries immediately, and "never" suppresses expiration
1336altogether. With "<pattern>" (e.g.
Junio C Hamanocc7636a2010-05-21 14:57:531337"refs/stash") in the middle the setting applies only to
1338the refs that match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551339
Junio C Hamano322c6242015-03-23 21:32:461340gc.reflogExpireUnreachable::
Junio C Hamanoa1746be2015-08-26 23:07:071341gc.<pattern>.reflogExpireUnreachable::
Junio C Hamano1aa40d22010-01-21 17:46:431342'git reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:551343this time and are not reachable from the current tip;
Junio C Hamano9c512872015-08-12 21:59:251344defaults to 30 days. The value "now" expires all entries
1345immediately, and "never" suppresses expiration altogether.
1346With "<pattern>" (e.g. "refs/stash")
Junio C Hamanocc7636a2010-05-21 14:57:531347in the middle, the setting applies only to the refs that
1348match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551349
Junio C Hamano322c6242015-03-23 21:32:461350gc.rerereResolved::
Junio C Hamano74640642006-12-27 10:59:551351Records of conflicted merge you resolved earlier are
Junio C Hamano1aa40d22010-01-21 17:46:431352kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461353The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551354
Junio C Hamano322c6242015-03-23 21:32:461355gc.rerereUnresolved::
Junio C Hamano74640642006-12-27 10:59:551356Records of conflicted merge you have not resolved are
Junio C Hamano1aa40d22010-01-21 17:46:431357kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461358The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551359
Junio C Hamano322c6242015-03-23 21:32:461360gitcvs.commitMsgAnnotation::
Junio C Hamanoa3148f52009-01-14 08:49:571361Append this string to each commit message. Set to empty string
1362to disable this feature. Defaults to "via git-CVS emulator".
1363
Junio C Hamano07824ce2006-04-25 07:36:541364gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:271365Whether the CVS server interface is enabled for this repository.
Junio C Hamano35738e82008-01-07 07:55:461366See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541367
Junio C Hamano322c6242015-03-23 21:32:461368gitcvs.logFile::
Junio C Hamanoa6387422007-08-25 03:54:271369Path to a log file where the CVS server interface well... logs
Junio C Hamano35738e82008-01-07 07:55:461370various stuff. See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541371
Junio C Hamano17bd2272008-09-01 06:11:171372gitcvs.usecrlfattr::
Junio C Hamanobb88cf42010-06-21 15:23:551373If true, the server will look up the end-of-line conversion
1374attributes for files to determine the '-k' modes to use. If
Junio C Hamano076ffcc2013-02-06 05:13:211375the attributes force Git to treat a file as text,
Junio C Hamano619596a2010-08-18 22:15:351376the '-k' mode will be left blank so CVS clients will
Junio C Hamanobb88cf42010-06-21 15:23:551377treat it as text. If they suppress text conversion, the file
Junio C Hamanocb1c44f2008-08-06 06:19:331378will be set with '-kb' mode, which suppresses any newline munging
Junio C Hamanobb88cf42010-06-21 15:23:551379the client might otherwise do. If the attributes do not allow
Junio C Hamano322c6242015-03-23 21:32:461380the file type to be determined, then 'gitcvs.allBinary' is
Junio C Hamanobb88cf42010-06-21 15:23:551381used. See linkgit:gitattributes[5].
Junio C Hamanodfccbb02008-05-26 01:16:141382
Junio C Hamano322c6242015-03-23 21:32:461383gitcvs.allBinary::
Junio C Hamanodfccbb02008-05-26 01:16:141384This is used if 'gitcvs.usecrlfattr' does not resolve
1385the correct '-kb' mode to use. If true, all
1386unresolved files are sent to the client in
1387mode '-kb'. This causes the client to treat them
1388as binary files, which suppresses any newline munging it
1389otherwise might do. Alternatively, if it is set to "guess",
1390then the contents of the file are examined to decide if
1391it is binary, similar to 'core.autocrlf'.
Junio C Hamanoa2ad99e2007-04-18 09:57:041392
Junio C Hamano322c6242015-03-23 21:32:461393gitcvs.dbName::
Junio C Hamanoa2ad99e2007-04-18 09:57:041394Database used by git-cvsserver to cache revision information
Junio C Hamano076ffcc2013-02-06 05:13:211395derived from the Git repository. The exact meaning depends on the
Junio C Hamanoa2ad99e2007-04-18 09:57:041396used database driver, for SQLite (which is the default driver) this
1397is a filename. Supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461398linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Junio C Hamanoa2ad99e2007-04-18 09:57:041399Default: '%Ggitcvs.%m.sqlite'
1400
Junio C Hamano322c6242015-03-23 21:32:461401gitcvs.dbDriver::
Junio C Hamanoa2ad99e2007-04-18 09:57:041402Used Perl DBI driver. You can specify any available driver
Junio C Hamano804a9742013-04-28 23:10:311403for this here, but it might not work. git-cvsserver is tested
Junio C Hamanoa2ad99e2007-04-18 09:57:041404with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1405reported *not* to work with 'DBD::mysql'. Experimental feature.
1406May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamano35738e82008-01-07 07:55:461407See linkgit:git-cvsserver[1].
Junio C Hamanod9e0e5d2007-04-14 16:22:041408
Junio C Hamano322c6242015-03-23 21:32:461409gitcvs.dbUser, gitcvs.dbPass::
1410Database user and password. Only useful if setting 'gitcvs.dbDriver',
Junio C Hamanoa2ad99e2007-04-18 09:57:041411since SQLite has no concept of database users and/or passwords.
Junio C Hamano322c6242015-03-23 21:32:461412'gitcvs.dbUser' supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461413linkgit:git-cvsserver[1] for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:041414
Junio C Hamanoa74efce2008-04-02 08:39:081415gitcvs.dbTableNamePrefix::
1416Database table name prefix. Prepended to the names of any
1417database tables used, allowing a single database to be used
1418for several repositories. Supports variable substitution (see
1419linkgit:git-cvsserver[1] for details). Any non-alphabetic
1420characters will be replaced with underscores.
1421
Junio C Hamanodfccbb02008-05-26 01:16:141422All gitcvs variables except for 'gitcvs.usecrlfattr' and
Junio C Hamano322c6242015-03-23 21:32:461423'gitcvs.allBinary' can also be specified as
Junio C Hamanodfccbb02008-05-26 01:16:141424'gitcvs.<access_method>.<varname>' (where 'access_method'
Junio C Hamanoa6387422007-08-25 03:54:271425is one of "ext" and "pserver") to make them apply only for the given
1426access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:041427
Junio C Hamano11821ed2011-10-19 18:42:091428gitweb.category::
1429gitweb.description::
1430gitweb.owner::
1431gitweb.url::
1432See linkgit:gitweb[1] for description.
1433
1434gitweb.avatar::
1435gitweb.blame::
1436gitweb.grep::
1437gitweb.highlight::
1438gitweb.patches::
1439gitweb.pickaxe::
1440gitweb.remote_heads::
Junio C Hamano322c6242015-03-23 21:32:461441gitweb.showSizes::
Junio C Hamano11821ed2011-10-19 18:42:091442gitweb.snapshot::
1443See linkgit:gitweb.conf[5] for description.
1444
Junio C Hamanoa03ac862011-04-02 04:32:291445grep.lineNumber::
1446If set to true, enable '-n' option by default.
1447
Junio C Hamanoa00504d2012-08-27 21:11:231448grep.patternType::
1449Set the default matching behavior. Using a value of 'basic', 'extended',
1450'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1451'--fixed-strings', or '--perl-regexp' option accordingly, while the
1452value 'default' will return to the default matching behavior.
1453
Junio C Hamanoa03ac862011-04-02 04:32:291454grep.extendedRegexp::
Junio C Hamanoa00504d2012-08-27 21:11:231455If set to true, enable '--extended-regexp' option by default. This
1456option is ignored when the 'grep.patternType' option is set to a value
1457other than 'default'.
Junio C Hamanoa03ac862011-04-02 04:32:291458
Junio C Hamanoa7da1ba2016-01-13 00:19:451459grep.threads::
1460Number of grep worker threads to use.
1461See `grep.threads` in linkgit:git-grep[1] for more information.
1462
Junio C Hamano4e6ba272016-01-20 23:23:191463grep.fallbackToNoIndex::
1464If set to true, fall back to git grep --no-index if git grep
1465is executed outside of a git repository. Defaults to false.
1466
Junio C Hamano4fd24422012-01-06 21:52:431467gpg.program::
1468Use this custom program instead of "gpg" found on $PATH when
1469making or verifying a PGP signature. The program must support the
Junio C Hamanoe1aeb5e2014-06-06 19:16:291470same command-line interface as GPG, namely, to verify a detached
Junio C Hamano4fd24422012-01-06 21:52:431471signature, "gpg --verify $file - <$signature" is run, and the
1472program is expected to signal a good signature by exiting with
Junio C Hamanofb5ffde2014-11-04 22:38:561473code 0, and to generate an ASCII-armored detached signature, the
Junio C Hamano4fd24422012-01-06 21:52:431474standard input of "gpg -bsau $key" is fed with the contents to be
1475signed, and the program is expected to send the result to its
1476standard output.
1477
Junio C Hamano322c6242015-03-23 21:32:461478gui.commitMsgWidth::
Junio C Hamano6d76d612008-05-09 05:46:081479Defines how wide the commit message window is in the
1480linkgit:git-gui[1]. "75" is the default.
1481
Junio C Hamano322c6242015-03-23 21:32:461482gui.diffContext::
Junio C Hamano6d76d612008-05-09 05:46:081483Specifies how many context lines should be used in calls to diff
1484made by the linkgit:git-gui[1]. The default is "5".
1485
Junio C Hamano322c6242015-03-23 21:32:461486gui.displayUntracked::
Junio C Hamano796c55f2014-05-02 21:45:151487Determines if linkgit::git-gui[1] shows untracked files
1488in the file list. The default is "true".
1489
Junio C Hamanod3452a02008-11-15 08:07:551490gui.encoding::
1491Specifies the default encoding to use for displaying of
1492file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1493It can be overridden by setting the 'encoding' attribute
1494for relevant files (see linkgit:gitattributes[5]).
1495If this option is not set, the tools default to the
1496locale encoding.
1497
Junio C Hamano322c6242015-03-23 21:32:461498gui.matchTrackingBranch::
Junio C Hamano6d76d612008-05-09 05:46:081499Determines if new branches created with linkgit:git-gui[1] should
1500default to tracking remote branches with matching names or
1501not. Default: "false".
1502
Junio C Hamano322c6242015-03-23 21:32:461503gui.newBranchTemplate::
Junio C Hamano6d76d612008-05-09 05:46:081504Is used as suggested name when creating new branches using the
1505linkgit:git-gui[1].
1506
Junio C Hamano322c6242015-03-23 21:32:461507gui.pruneDuringFetch::
Junio C Hamano97bcb482010-11-25 03:16:071508"true" if linkgit:git-gui[1] should prune remote-tracking branches when
Junio C Hamano6d76d612008-05-09 05:46:081509performing a fetch. The default value is "false".
1510
1511gui.trustmtime::
1512Determines if linkgit:git-gui[1] should trust the file modification
1513timestamp or not. By default the timestamps are not trusted.
1514
Junio C Hamano322c6242015-03-23 21:32:461515gui.spellingDictionary::
Junio C Hamano6d76d612008-05-09 05:46:081516Specifies the dictionary used for spell checking commit messages in
1517the linkgit:git-gui[1]. When set to "none" spell checking is turned
1518off.
1519
Junio C Hamano322c6242015-03-23 21:32:461520gui.fastCopyBlame::
Junio C Hamano1aa40d22010-01-21 17:46:431521If true, 'git gui blame' uses `-C` instead of `-C -C` for original
Junio C Hamanod3452a02008-11-15 08:07:551522location detection. It makes blame significantly faster on huge
1523repositories at the expense of less thorough copy detection.
1524
Junio C Hamano322c6242015-03-23 21:32:461525gui.copyBlameThreshold::
Junio C Hamano610d1762008-11-28 06:27:131526Specifies the threshold to use in 'git gui blame' original location
Junio C Hamanod3452a02008-11-15 08:07:551527detection, measured in alphanumeric characters. See the
1528linkgit:git-blame[1] manual for more information on copy detection.
1529
1530gui.blamehistoryctx::
1531Specifies the radius of history context in days to show in
1532linkgit:gitk[1] for the selected commit, when the `Show History
1533Context` menu item is invoked from 'git gui blame'. If this
1534variable is set to zero, the whole history is shown.
1535
Junio C Hamano92d312a2008-12-15 07:22:201536guitool.<name>.cmd::
1537Specifies the shell command line to execute when the corresponding item
1538of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1539mandatory for every tool. The command is executed from the root of
1540the working directory, and in the environment it receives the name of
1541the tool as 'GIT_GUITOOL', the name of the currently selected file as
1542'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1543the head is detached, 'CUR_BRANCH' is empty).
1544
Junio C Hamano322c6242015-03-23 21:32:461545guitool.<name>.needsFile::
Junio C Hamano92d312a2008-12-15 07:22:201546Run the tool only if a diff is selected in the GUI. It guarantees
1547that 'FILENAME' is not empty.
1548
Junio C Hamano322c6242015-03-23 21:32:461549guitool.<name>.noConsole::
Junio C Hamano92d312a2008-12-15 07:22:201550Run the command silently, without creating a window to display its
1551output.
1552
Junio C Hamano322c6242015-03-23 21:32:461553guitool.<name>.noRescan::
Junio C Hamano92d312a2008-12-15 07:22:201554Don't rescan the working directory for changes after the tool
1555finishes execution.
1556
1557guitool.<name>.confirm::
1558Show a confirmation dialog before actually running the tool.
1559
Junio C Hamano322c6242015-03-23 21:32:461560guitool.<name>.argPrompt::
Junio C Hamano92d312a2008-12-15 07:22:201561Request a string argument from the user, and pass it to the tool
1562through the 'ARGS' environment variable. Since requesting an
1563argument implies confirmation, the 'confirm' option has no effect
1564if this is enabled. If the option is set to 'true', 'yes', or '1',
1565the dialog uses a built-in generic prompt; otherwise the exact
1566value of the variable is used.
1567
Junio C Hamano322c6242015-03-23 21:32:461568guitool.<name>.revPrompt::
Junio C Hamano92d312a2008-12-15 07:22:201569Request a single valid revision from the user, and set the
1570'REVISION' environment variable. In other aspects this option
Junio C Hamano322c6242015-03-23 21:32:461571is similar to 'argPrompt', and can be used together with it.
Junio C Hamano92d312a2008-12-15 07:22:201572
Junio C Hamano322c6242015-03-23 21:32:461573guitool.<name>.revUnmerged::
1574Show only unmerged branches in the 'revPrompt' subdialog.
Junio C Hamano92d312a2008-12-15 07:22:201575This is useful for tools similar to merge or rebase, but not
1576for things like checkout or reset.
1577
1578guitool.<name>.title::
1579Specifies the title to use for the prompt dialog. The default
1580is the tool name.
1581
1582guitool.<name>.prompt::
1583Specifies the general prompt string to display at the top of
Junio C Hamano322c6242015-03-23 21:32:461584the dialog, before subsections for 'argPrompt' and 'revPrompt'.
Junio C Hamano92d312a2008-12-15 07:22:201585The default value includes the actual command.
1586
Junio C Hamano4e272312008-01-08 09:13:211587help.browser::
1588Specify the browser that will be used to display help in the
1589'web' format. See linkgit:git-help[1].
1590
1591help.format::
1592Override the default help format used by linkgit:git-help[1].
1593Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1594the default. 'web' and 'html' are the same.
1595
Junio C Hamano322c6242015-03-23 21:32:461596help.autoCorrect::
Junio C Hamanof24b8062008-09-09 01:34:391597Automatically correct and execute mistyped commands after
1598waiting for the given number of deciseconds (0.1 sec). If more
1599than one command can be deduced from the entered text, nothing
1600will be executed. If the value of this option is negative,
1601the corrected command will be executed immediately. If the
1602value is 0 - the command will be just shown but not executed.
1603This is the default.
1604
Junio C Hamano322c6242015-03-23 21:32:461605help.htmlPath::
Junio C Hamano5dd5fae2013-01-18 21:06:491606Specify the path where the HTML documentation resides. File system paths
1607and URLs are supported. HTML pages will be prefixed with this path when
1608help is displayed in the 'web' format. This defaults to the documentation
1609path of your Git installation.
1610
Junio C Hamano58256872007-12-04 08:31:131611http.proxy::
Junio C Hamano3dd93922012-03-05 07:49:111612Override the HTTP proxy, normally configured using the 'http_proxy',
Junio C Hamanoffe10ca2016-02-04 00:44:231613'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1614addition to the syntax understood by curl, it is possible to specify a
1615proxy string with a user name but no password, in which case git will
1616attempt to acquire one in the same way it does for other credentials. See
1617linkgit:gitcredentials[7] for more information. The syntax thus is
1618'[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1619on a per-remote basis; see remote.<name>.proxy
1620
1621http.proxyAuthMethod::
1622Set the method with which to authenticate against the HTTP proxy. This
1623only takes effect if the configured proxy string contains a user name part
1624(i.e. is of the form 'user@host' or 'user@host:port'). This can be
1625overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1626Both can be overridden by the 'GIT_HTTP_PROXY_AUTHMETHOD' environment
1627variable. Possible values are:
1628+
1629--
1630* `anyauth` - Automatically pick a suitable authentication method. It is
1631 assumed that the proxy answers an unauthenticated request with a 407
1632 status code and one or more Proxy-authenticate headers with supported
1633 authentication methods. This is the default.
1634* `basic` - HTTP Basic authentication
1635* `digest` - HTTP Digest authentication; this prevents the password from being
1636 transmitted to the proxy in clear text
1637* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1638 of `curl(1)`)
1639* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1640--
Junio C Hamano58256872007-12-04 08:31:131641
Junio C Hamano322c6242015-03-23 21:32:461642http.cookieFile::
Junio C Hamano4c4b0122011-06-30 01:19:321643File containing previously stored cookie lines which should be used
Junio C Hamano076ffcc2013-02-06 05:13:211644in the Git http session, if they match the server. The file format
Junio C Hamano4c4b0122011-06-30 01:19:321645of the file to read cookies from should be plain HTTP headers or
1646the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
Junio C Hamano322c6242015-03-23 21:32:461647NOTE that the file specified with http.cookieFile is only used as
Junio C Hamano8eac2682013-09-09 22:35:201648input unless http.saveCookies is set.
1649
Junio C Hamano322c6242015-03-23 21:32:461650http.saveCookies::
Junio C Hamano8eac2682013-09-09 22:35:201651If set, store cookies received during requests to the file specified by
Junio C Hamano322c6242015-03-23 21:32:461652http.cookieFile. Has no effect if http.cookieFile is unset.
Junio C Hamano4c4b0122011-06-30 01:19:321653
Junio C Hamanoa1746be2015-08-26 23:07:071654http.sslVersion::
1655The SSL version to use when negotiating an SSL connection, if you
1656want to force the default. The available and default version
1657depend on whether libcurl was built against NSS or OpenSSL and the
1658particular configuration of the crypto library in use. Internally
1659this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1660documentation for more details on the format of this option and
1661for the ssl version supported. Actually the possible values of
1662this option are:
1663
1664- sslv2
1665- sslv3
1666- tlsv1
1667- tlsv1.0
1668- tlsv1.1
1669- tlsv1.2
1670
1671+
1672Can be overridden by the 'GIT_SSL_VERSION' environment variable.
1673To force git to use libcurl's default ssl version and ignore any
1674explicit http.sslversion option, set 'GIT_SSL_VERSION' to the
1675empty string.
1676
Junio C Hamano1dbca522015-05-22 20:48:551677http.sslCipherList::
1678 A list of SSL ciphers to use when negotiating an SSL connection.
1679 The available ciphers depend on whether libcurl was built against
1680 NSS or OpenSSL and the particular configuration of the crypto
1681 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1682 option; see the libcurl documentation for more details on the format
1683 of this list.
1684+
1685Can be overridden by the 'GIT_SSL_CIPHER_LIST' environment variable.
1686To force git to use libcurl's default cipher list and ignore any
1687explicit http.sslCipherList option, set 'GIT_SSL_CIPHER_LIST' to the
1688empty string.
1689
Junio C Hamano07824ce2006-04-25 07:36:541690http.sslVerify::
1691Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451692over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Junio C Hamano07824ce2006-04-25 07:36:541693variable.
1694
1695http.sslCert::
1696File containing the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451697over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Junio C Hamano07824ce2006-04-25 07:36:541698variable.
1699
1700http.sslKey::
1701File containing the SSL private key when fetching or pushing
Junio C Hamano341071d2006-06-04 07:24:481702over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Junio C Hamano07824ce2006-04-25 07:36:541703variable.
1704
Junio C Hamano48bc1ce2009-07-09 16:49:191705http.sslCertPasswordProtected::
Junio C Hamano076ffcc2013-02-06 05:13:211706Enable Git's password prompt for the SSL certificate. Otherwise
Junio C Hamano48bc1ce2009-07-09 16:49:191707OpenSSL will prompt the user, possibly many times, if the
1708certificate or private key is encrypted. Can be overridden by the
1709'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1710
Junio C Hamano07824ce2006-04-25 07:36:541711http.sslCAInfo::
1712File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:481713fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano07824ce2006-04-25 07:36:541714'GIT_SSL_CAINFO' environment variable.
1715
1716http.sslCAPath::
1717Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:451718with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541719by the 'GIT_SSL_CAPATH' environment variable.
1720
Junio C Hamano76927822013-04-19 21:26:571721http.sslTry::
1722Attempt to use AUTH SSL/TLS and encrypted data transfers
1723when connecting via regular FTP protocol. This might be needed
1724if the FTP server requires it for security reasons or you wish
1725to connect securely whenever remote FTP server supports it.
1726Default is false since it might trigger certificate verification
1727errors on misconfigured servers.
1728
Junio C Hamano07824ce2006-04-25 07:36:541729http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:481730How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541731by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1732
Junio C Hamanob141a922010-01-10 19:55:141733http.minSessions::
1734The number of curl sessions (counted across slots) to be kept across
1735requests. They will not be ended with curl_easy_cleanup() until
1736http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1737value will be capped at 1. Defaults to 1.
1738
Junio C Hamano3b70d3c2009-11-21 17:37:371739http.postBuffer::
1740Maximum size in bytes of the buffer used by smart HTTP
1741transports when POSTing data to the remote system.
1742For requests larger than this buffer size, HTTP/1.1 and
1743Transfer-Encoding: chunked is used to avoid creating a
1744massive pack file locally. Default is 1 MiB, which is
1745sufficient for most requests.
1746
Junio C Hamano07824ce2006-04-25 07:36:541747http.lowSpeedLimit, http.lowSpeedTime::
1748If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1749for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano341071d2006-06-04 07:24:481750Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Junio C Hamano07824ce2006-04-25 07:36:541751'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1752
Junio C Hamanof1dcdfe2006-09-29 08:10:511753http.noEPSV::
1754A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:041755This can helpful with some "poor" ftp servers which don't
Junio C Hamanof1dcdfe2006-09-29 08:10:511756support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1757environment variable. Default is false (curl will use EPSV).
1758
Junio C Hamano322c6242015-03-23 21:32:461759http.userAgent::
Junio C Hamano53ba6d02010-08-22 07:25:121760The HTTP USER_AGENT string presented to an HTTP server. The default
Junio C Hamano076ffcc2013-02-06 05:13:211761value represents the version of the client Git such as git/1.7.1.
Junio C Hamano53ba6d02010-08-22 07:25:121762This option allows you to override this value to a more common value
1763such as Mozilla/4.0. This may be necessary, for instance, if
1764connecting through a firewall that restricts HTTP connections to a set
1765of common USER_AGENT strings (but not including those like git/1.7.1).
1766Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1767
Junio C Hamano8eac2682013-09-09 22:35:201768http.<url>.*::
Junio C Hamanofb5ffde2014-11-04 22:38:561769Any of the http.* options above can be applied selectively to some URLs.
Junio C Hamano8eac2682013-09-09 22:35:201770For a config key to match a URL, each element of the config key is
1771compared to that of the URL, in the following order:
1772+
1773--
1774. Scheme (e.g., `https` in `https://example.com/`). This field
1775 must match exactly between the config key and the URL.
1776
1777. Host/domain name (e.g., `example.com` in `https://example.com/`).
1778 This field must match exactly between the config key and the URL.
1779
1780. Port number (e.g., `8080` in `http://example.com:8080/`).
1781 This field must match exactly between the config key and the URL.
1782 Omitted port numbers are automatically converted to the correct
1783 default for the scheme before matching.
1784
1785. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1786 path field of the config key must match the path field of the URL
1787 either exactly or as a prefix of slash-delimited path elements. This means
1788 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1789 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1790 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1791 key with just path `foo/`).
1792
1793. User name (e.g., `user` in `https://user@example.com/repo.git`). If
1794 the config key has a user name it must match the user name in the
1795 URL exactly. If the config key does not have a user name, that
1796 config key will match a URL with any user name (including none),
1797 but at a lower precedence than a config key with a user name.
1798--
1799+
1800The list above is ordered by decreasing precedence; a URL that matches
1801a config key's path is preferred to one that matches its user name. For example,
1802if the URL is `https://user@example.com/foo/bar` a config key match of
1803`https://example.com/foo` will be preferred over a config key match of
1804`https://user@example.com`.
1805+
1806All URLs are normalized before attempting any matching (the password part,
1807if embedded in the URL, is always ignored for matching purposes) so that
Junio C Hamanofb5ffde2014-11-04 22:38:561808equivalent URLs that are simply spelled differently will match properly.
1809Environment variable settings always override any matches. The URLs that are
Junio C Hamano8eac2682013-09-09 22:35:201810matched against are those given directly to Git commands. This means any URLs
1811visited as a result of a redirection do not participate in matching.
1812
Junio C Hamano07824ce2006-04-25 07:36:541813i18n.commitEncoding::
Junio C Hamano076ffcc2013-02-06 05:13:211814Character encoding the commit messages are stored in; Git itself
Junio C Hamano07824ce2006-04-25 07:36:541815does not care per se, but this information is necessary e.g. when
1816importing commits from emails or in the gitk graphical history
1817browser (and possibly at other places in the future or in other
Junio C Hamano35738e82008-01-07 07:55:461818porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Junio C Hamano07824ce2006-04-25 07:36:541819
Junio C Hamano51f92e22006-12-29 05:18:281820i18n.logOutputEncoding::
1821Character encoding the commit messages are converted to when
Junio C Hamano1aa40d22010-01-21 17:46:431822running 'git log' and friends.
Junio C Hamano51f92e22006-12-29 05:18:281823
Junio C Hamano4653c6f2008-11-26 22:50:201824imap::
1825The configuration variables in the 'imap' section are described
1826in linkgit:git-imap-send[1].
1827
Junio C Hamano81703b22014-03-14 22:00:271828index.version::
1829Specify the version with which new index files should be
1830initialized. This does not affect existing repositories.
1831
Junio C Hamano322c6242015-03-23 21:32:461832init.templateDir::
Junio C Hamanocaa712a2010-03-11 01:17:351833Specify the directory from which templates will be copied.
1834(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1835
Junio C Hamano4e272312008-01-08 09:13:211836instaweb.browser::
1837Specify the program that will be used to browse your working
1838repository in gitweb. See linkgit:git-instaweb[1].
1839
1840instaweb.httpd::
1841The HTTP daemon command-line to start gitweb on your working
1842repository. See linkgit:git-instaweb[1].
1843
1844instaweb.local::
1845If true the web server started by linkgit:git-instaweb[1] will
1846be bound to the local IP (127.0.0.1).
1847
Junio C Hamano322c6242015-03-23 21:32:461848instaweb.modulePath::
Junio C Hamano619596a2010-08-18 22:15:351849The default module path for linkgit:git-instaweb[1] to use
1850instead of /usr/lib/apache2/modules. Only used if httpd
1851is Apache.
Junio C Hamano4e272312008-01-08 09:13:211852
1853instaweb.port::
1854The port number to bind the gitweb httpd to. See
1855linkgit:git-instaweb[1].
1856
Junio C Hamano322c6242015-03-23 21:32:461857interactive.singleKey::
Junio C Hamano27a128b2009-08-13 01:23:001858In interactive commands, allow the user to provide one-letter
Junio C Hamanoe5bf6c12009-02-07 21:43:101859input with a single key (i.e., without hitting enter).
Junio C Hamanob76a6862012-05-02 22:02:461860Currently this is used by the `--patch` mode of
Junio C Hamano3d050d62011-05-17 06:43:341861linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1862linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1863setting is silently ignored if portable keystroke input
Junio C Hamano81703b22014-03-14 22:00:271864is not available; requires the Perl module Term::ReadKey.
Junio C Hamanoe5bf6c12009-02-07 21:43:101865
Junio C Hamanof93530e2011-05-25 23:59:591866log.abbrevCommit::
1867If true, makes linkgit:git-log[1], linkgit:git-show[1], and
Junio C Hamanob76a6862012-05-02 22:02:461868linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1869override this option with `--no-abbrev-commit`.
Junio C Hamanof93530e2011-05-25 23:59:591870
Junio C Hamanob713ff12008-05-24 01:12:301871log.date::
Junio C Hamano2db3e752010-09-03 21:33:061872Set the default date-time mode for the 'log' command.
1873Setting a value for log.date is similar to using 'git log''s
Junio C Hamano1eb56092015-10-05 20:39:531874`--date` option. See linkgit:git-log[1] for details.
Junio C Hamanob713ff12008-05-24 01:12:301875
Junio C Hamanocb39aea2010-05-09 07:24:481876log.decorate::
1877Print out the ref names of any commits that are shown by the log
1878command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1879'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1880specified, the full ref name (including prefix) will be printed.
1881This is the same as the log commands '--decorate' option.
1882
Junio C Hamanob0a1e832015-10-15 23:08:311883log.follow::
1884If `true`, `git log` will act as if the `--follow` option was used when
1885a single <path> is given. This has the same limitations as `--follow`,
1886i.e. it cannot be used to follow multiple files and does not work well
1887on non-linear history.
1888
Junio C Hamano322c6242015-03-23 21:32:461889log.showRoot::
Junio C Hamanofe9acab2006-11-24 12:10:551890If true, the initial commit will be shown as a big creation event.
1891This is equivalent to a diff against an empty tree.
Junio C Hamano35738e82008-01-07 07:55:461892Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Junio C Hamanofe9acab2006-11-24 12:10:551893normally hide the root commit will now show it. True by default.
1894
Junio C Hamanoce836cc2013-01-21 02:01:531895log.mailmap::
1896If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1897linkgit:git-whatchanged[1] assume `--use-mailmap`.
1898
Junio C Hamano7f1bc9d2015-03-05 22:38:261899mailinfo.scissors::
1900If true, makes linkgit:git-mailinfo[1] (and therefore
1901linkgit:git-am[1]) act by default as if the --scissors option
1902was provided on the command-line. When active, this features
1903removes everything from the message body before a scissors
1904line (i.e. consisting mainly of ">8", "8<" and "-").
1905
Junio C Hamano8bc410e2009-02-15 10:38:191906mailmap.file::
1907The location of an augmenting mailmap file. The default
1908mailmap, located in the root of the repository, is loaded
1909first, then the mailmap file pointed to by this variable.
1910The location of the mailmap file may be in a repository
1911subdirectory, or somewhere outside of the repository itself.
1912See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1913
Junio C Hamanoabad6da2013-01-06 09:06:321914mailmap.blob::
1915Like `mailmap.file`, but consider the value as a reference to a
1916blob in the repository. If both `mailmap.file` and
1917`mailmap.blob` are given, both are parsed, with entries from
1918`mailmap.file` taking precedence. In a bare repository, this
1919defaults to `HEAD:.mailmap`. In a non-bare repository, it
1920defaults to empty.
1921
Junio C Hamano8b588d52008-03-15 09:48:371922man.viewer::
1923Specify the programs that may be used to display help in the
1924'man' format. See linkgit:git-help[1].
1925
Junio C Hamano6d76d612008-05-09 05:46:081926man.<tool>.cmd::
1927Specify the command to invoke the specified man viewer. The
1928specified command is evaluated in shell with the man page
1929passed as argument. (See linkgit:git-help[1].)
Junio C Hamano103ad7f2007-03-14 11:19:261930
Junio C Hamano6d76d612008-05-09 05:46:081931man.<tool>.path::
1932Override the path for the given tool that may be used to
1933display help in the 'man' format. See linkgit:git-help[1].
Junio C Hamanoe90436a2007-04-22 07:22:131934
Junio C Hamano4653c6f2008-11-26 22:50:201935include::merge-config.txt[]
Junio C Hamanoa476efa2008-10-10 15:31:421936
Junio C Hamano1fbbbc12007-12-18 07:01:271937mergetool.<tool>.path::
1938Override the path for the given tool. This is useful in case
1939your tool is not in the PATH.
1940
Junio C Hamano86bcccc2008-03-08 09:33:551941mergetool.<tool>.cmd::
1942Specify the command to invoke the specified merge tool. The
1943specified command is evaluated in shell with the following
1944variables available: 'BASE' is the name of a temporary file
1945containing the common base of the files to be merged, if available;
1946'LOCAL' is the name of a temporary file containing the contents of
1947the file on the current branch; 'REMOTE' is the name of a temporary
1948file containing the contents of the file from the branch being
1949merged; 'MERGED' contains the name of the file to which the merge
1950tool should write the results of a successful merge.
1951
1952mergetool.<tool>.trustExitCode::
1953For a custom merge command, specify whether the exit code of
1954the merge command can be used to determine whether the merge was
1955successful. If this is not set to true then the merge target file
1956timestamp is checked and the merge assumed to have been successful
1957if the file has been updated, otherwise the user is prompted to
1958indicate the success of the merge.
1959
Junio C Hamanoe478e402014-10-21 22:14:451960mergetool.meld.hasOutput::
1961Older versions of `meld` do not support the `--output` option.
1962Git will attempt to detect whether `meld` supports `--output`
1963by inspecting the output of `meld --help`. Configuring
1964`mergetool.meld.hasOutput` will make Git skip these checks and
1965use the configured value instead. Setting `mergetool.meld.hasOutput`
1966to `true` tells Git to unconditionally use the `--output` option,
1967and `false` avoids using `--output`.
1968
Junio C Hamano86bcccc2008-03-08 09:33:551969mergetool.keepBackup::
1970After performing a merge, the original file with conflict markers
1971can be saved as a file with a `.orig` extension. If this variable
1972is set to `false` then this file is not preserved. Defaults to
1973`true` (i.e. keep the backup files).
1974
Junio C Hamano10b7a342009-01-01 22:05:171975mergetool.keepTemporaries::
Junio C Hamano076ffcc2013-02-06 05:13:211976When invoking a custom merge tool, Git uses a set of temporary
Junio C Hamano10b7a342009-01-01 22:05:171977files to pass to the tool. If the tool returns an error and this
1978variable is set to `true`, then these temporary files will be
1979preserved, otherwise they will be removed after the tool has
1980exited. Defaults to `false`.
1981
Junio C Hamanoe478e402014-10-21 22:14:451982mergetool.writeToTemp::
1983Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
1984conflicting files in the worktree by default. Git will attempt
1985to use a temporary directory for these files when set `true`.
1986Defaults to `false`.
1987
Junio C Hamano10b7a342009-01-01 22:05:171988mergetool.prompt::
1989Prompt before each invocation of the merge resolution program.
1990
Junio C Hamano3891e252015-08-31 23:06:131991notes.mergeStrategy::
1992Which merge strategy to choose by default when resolving notes
1993conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
1994`cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
1995section of linkgit:git-notes[1] for more information on each strategy.
1996
1997notes.<name>.mergeStrategy::
1998Which merge strategy to choose when doing a notes merge into
1999refs/notes/<name>. This overrides the more general
2000"notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2001linkgit:git-notes[1] for more information on the available strategies.
2002
Junio C Hamano31667362010-03-25 00:38:532003notes.displayRef::
2004The (fully qualified) refname from which to show notes when
2005showing commit messages. The value of this variable can be set
2006to a glob, in which case notes from all matching refs will be
2007shown. You may also specify this configuration variable
2008several times. A warning will be issued for refs that do not
2009exist, but a glob that does not match any refs is silently
2010ignored.
2011+
2012This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2013environment variable, which must be a colon separated list of refs or
2014globs.
2015+
2016The effective value of "core.notesRef" (possibly overridden by
2017GIT_NOTES_REF) is also implicitly added to the list of refs to be
2018displayed.
2019
2020notes.rewrite.<command>::
2021When rewriting commits with <command> (currently `amend` or
Junio C Hamano076ffcc2013-02-06 05:13:212022`rebase`) and this variable is set to `true`, Git
Junio C Hamano31667362010-03-25 00:38:532023automatically copies your notes from the original to the
2024rewritten commit. Defaults to `true`, but see
2025"notes.rewriteRef" below.
Junio C Hamano31667362010-03-25 00:38:532026
2027notes.rewriteMode::
2028When copying notes during a rewrite (see the
2029"notes.rewrite.<command>" option), determines what to do if
2030the target commit already has a note. Must be one of
Junio C Hamano3891e252015-08-31 23:06:132031`overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2032Defaults to `concatenate`.
Junio C Hamano31667362010-03-25 00:38:532033+
2034This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2035environment variable.
2036
2037notes.rewriteRef::
2038When copying notes during a rewrite, specifies the (fully
2039qualified) ref whose notes should be copied. The ref may be a
2040glob, in which case notes in all matching refs will be copied.
2041You may also specify this configuration several times.
2042+
2043Does not have a default value; you must configure this variable to
Junio C Hamano8fb66e52011-10-05 20:59:512044enable note rewriting. Set it to `refs/notes/commits` to enable
2045rewriting for the default commit notes.
Junio C Hamano2b3ee5d2010-05-08 05:41:182046+
2047This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2048environment variable, which must be a colon separated list of refs or
2049globs.
Junio C Hamano31667362010-03-25 00:38:532050
Junio C Hamano75cc4c92006-07-24 08:25:032051pack.window::
Junio C Hamano35738e82008-01-07 07:55:462052The size of the window used by linkgit:git-pack-objects[1] when no
Junio C Hamano75cc4c92006-07-24 08:25:032053window size is given on the command line. Defaults to 10.
2054
Junio C Hamano91d44c52007-05-09 07:16:072055pack.depth::
Junio C Hamano35738e82008-01-07 07:55:462056The maximum delta depth used by linkgit:git-pack-objects[1] when no
Junio C Hamano91d44c52007-05-09 07:16:072057maximum depth is given on the command line. Defaults to 50.
2058
Junio C Hamano235d53f2007-07-13 00:25:152059pack.windowMemory::
Junio C Hamano2a4bcbc2014-10-29 20:07:392060The maximum size of memory that is consumed by each thread
2061in linkgit:git-pack-objects[1] for pack window memory when
2062no limit is given on the command line. The value can be
2063suffixed with "k", "m", or "g". When left unconfigured (or
2064set explicitly to 0), there will be no limit.
Junio C Hamano235d53f2007-07-13 00:25:152065
Junio C Hamanof2ce2972007-05-20 19:12:092066pack.compression::
2067An integer -1..9, indicating the compression level for objects
2068in a pack file. -1 is the zlib default. 0 means no
2069compression, and 1..9 are various speed/size tradeoffs, 9 being
2070slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:422071not set, defaults to -1, the zlib default, which is "a default
2072compromise between speed and compression (currently equivalent
2073to level 6)."
Junio C Hamano657fd8a2010-10-07 00:01:242074+
2075Note that changing the compression level will not automatically recompress
2076all existing objects. You can force recompression by passing the -F option
2077to linkgit:git-repack[1].
Junio C Hamanof2ce2972007-05-20 19:12:092078
Junio C Hamano679d22d2007-06-02 21:13:442079pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:272080The maximum memory in bytes used for caching deltas in
Junio C Hamano9f883862009-08-11 06:23:522081linkgit:git-pack-objects[1] before writing them out to a pack.
2082This cache is used to speed up the writing object phase by not
2083having to recompute the final delta result once the best match
2084for all objects is found. Repacking large repositories on machines
2085which are tight with memory might be badly impacted by this though,
2086especially if this cache pushes the system into swapping.
2087A value of 0 means no limit. The smallest size of 1 byte may be
2088used to virtually disable this cache. Defaults to 256 MiB.
Junio C Hamano679d22d2007-06-02 21:13:442089
2090pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:142091The maximum size of a delta, that is cached in
Junio C Hamano9f883862009-08-11 06:23:522092linkgit:git-pack-objects[1]. This cache is used to speed up the
2093writing object phase by not having to recompute the final delta
2094result once the best match for all objects is found. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:442095
Junio C Hamano58155b42007-09-15 07:46:142096pack.threads::
2097Specifies the number of threads to spawn when searching for best
Junio C Hamano35738e82008-01-07 07:55:462098delta matches. This requires that linkgit:git-pack-objects[1]
Junio C Hamano58155b42007-09-15 07:46:142099be compiled with pthreads otherwise this option is ignored with a
2100warning. This is meant to reduce packing time on multiprocessor
2101machines. The required amount of memory for the delta search window
2102is however multiplied by the number of threads.
Junio C Hamano076ffcc2013-02-06 05:13:212103Specifying 0 will cause Git to auto-detect the number of CPU's
Junio C Hamano24bc09a2008-02-28 00:27:442104and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:142105
Junio C Hamanod814b6d2007-11-04 11:13:492106pack.indexVersion::
2107Specify the default pack index version. Valid values are 1 for
2108legacy pack index used by Git versions prior to 1.5.2, and 2 for
2109the new pack index with capabilities for packs larger than 4 GB
2110as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:382111packs. Version 2 is the default. Note that version 2 is enforced
2112and this config option ignored whenever the corresponding pack is
2113larger than 2 GB.
2114+
Junio C Hamano076ffcc2013-02-06 05:13:212115If you have an old Git that does not understand the version 2 `*.idx` file,
Junio C Hamanofce7c7e2008-07-02 03:06:382116cloning or fetching over a non native protocol (e.g. "http" and "rsync")
Junio C Hamanob76a6862012-05-02 22:02:462117that will copy both `*.pack` file and corresponding `*.idx` file from the
Junio C Hamanofce7c7e2008-07-02 03:06:382118other side may give you a repository that cannot be accessed with your
Junio C Hamano076ffcc2013-02-06 05:13:212119older version of Git. If the `*.pack` file is smaller than 2 GB, however,
Junio C Hamanofce7c7e2008-07-02 03:06:382120you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
Junio C Hamanob76a6862012-05-02 22:02:462121the `*.idx` file.
Junio C Hamanod814b6d2007-11-04 11:13:492122
Junio C Hamano09a926d2008-03-13 07:55:292123pack.packSizeLimit::
Junio C Hamano4d979582010-02-04 06:27:292124The maximum size of a pack. This setting only affects
2125packing to a file when repacking, i.e. the git:// protocol
Junio C Hamanob76a6862012-05-02 22:02:462126is unaffected. It can be overridden by the `--max-pack-size`
Junio C Hamano4d979582010-02-04 06:27:292127option of linkgit:git-repack[1]. The minimum size allowed is
2128limited to 1 MiB. The default is unlimited.
2129Common unit suffixes of 'k', 'm', or 'g' are
2130supported.
Junio C Hamano49dccaf2008-02-10 10:48:012131
Junio C Hamano5b3533d2014-02-27 23:07:152132pack.useBitmaps::
2133When true, git will use pack bitmaps (if available) when packing
2134to stdout (e.g., during the server side of a fetch). Defaults to
2135true. You should not generally need to turn this off unless
2136you are debugging pack bitmaps.
2137
Junio C Hamano322c6242015-03-23 21:32:462138pack.writeBitmaps (deprecated)::
Junio C Hamano38d02532014-06-26 21:48:502139This is a deprecated synonym for `repack.writeBitmaps`.
Junio C Hamano5b3533d2014-02-27 23:07:152140
2141pack.writeBitmapHashCache::
2142When true, git will include a "hash cache" section in the bitmap
2143index (if one is written). This cache can be used to feed git's
2144delta heuristics, potentially leading to better deltas between
2145bitmapped and non-bitmapped objects (e.g., when serving a fetch
2146between an older, bitmapped pack and objects that have been
2147pushed since the last gc). The downside is that it consumes 4
2148bytes per object of disk space, and that JGit's bitmap
2149implementation does not understand it, causing it to complain if
2150Git and JGit are used on the same repository. Defaults to false.
2151
Junio C Hamano9e96a1a2008-08-16 10:23:182152pager.<cmd>::
Junio C Hamano788eeba2010-12-08 22:50:432153If the value is boolean, turns on or off pagination of the
Junio C Hamano076ffcc2013-02-06 05:13:212154output of a particular Git subcommand when writing to a tty.
Junio C Hamano788eeba2010-12-08 22:50:432155Otherwise, turns on pagination for the subcommand using the
Junio C Hamanob76a6862012-05-02 22:02:462156pager specified by the value of `pager.<cmd>`. If `--paginate`
2157or `--no-pager` is specified on the command line, it takes
Junio C Hamano788eeba2010-12-08 22:50:432158precedence over this option. To disable pagination for all
2159commands, set `core.pager` or `GIT_PAGER` to `cat`.
Junio C Hamano9e96a1a2008-08-16 10:23:182160
Junio C Hamanoa574a092010-06-13 19:57:102161pretty.<name>::
2162Alias for a --pretty= format string, as specified in
2163linkgit:git-log[1]. Any aliases defined here can be used just
2164as the built-in pretty formats could. For example,
Junio C Hamanob76a6862012-05-02 22:02:462165running `git config pretty.changelog "format:* %H %s"`
Junio C Hamanoa574a092010-06-13 19:57:102166would cause the invocation `git log --pretty=changelog`
Junio C Hamanob76a6862012-05-02 22:02:462167to be equivalent to running `git log "--pretty=format:* %H %s"`.
Junio C Hamanoa574a092010-06-13 19:57:102168Note that an alias with the same name as a built-in format
2169will be silently ignored.
2170
Junio C Hamano5b3533d2014-02-27 23:07:152171pull.ff::
2172By default, Git does not create an extra merge commit when merging
2173a commit that is a descendant of the current commit. Instead, the
2174tip of the current branch is fast-forwarded. When set to `false`,
2175this variable tells Git to create an extra merge commit in such
2176a case (equivalent to giving the `--no-ff` option from the command
2177line). When set to `only`, only such fast-forward merges are
2178allowed (equivalent to giving the `--ff-only` option from the
Junio C Hamanoc4e2a202015-05-26 21:38:472179command line). This setting overrides `merge.ff` when pulling.
Junio C Hamano5b3533d2014-02-27 23:07:152180
Junio C Hamano515ab1d2011-12-09 23:41:202181pull.rebase::
2182When true, rebase branches on top of the fetched branch, instead
2183of merging the default branch from the default remote when "git
2184pull" is run. See "branch.<name>.rebase" for setting this on a
2185per-branch basis.
2186+
Junio C Hamano7db630e2015-09-17 20:26:222187When preserve, also pass `--preserve-merges` along to 'git rebase'
2188so that locally committed merge commits will not be flattened
2189by running 'git pull'.
Junio C Hamanocf4a1742013-09-11 22:57:502190+
Junio C Hamano289d7e82016-01-27 00:20:382191When the value is `interactive`, the rebase is run in interactive mode.
2192+
Junio C Hamano515ab1d2011-12-09 23:41:202193*NOTE*: this is a possibly dangerous operation; do *not* use
2194it unless you understand the implications (see linkgit:git-rebase[1]
2195for details).
2196
Junio C Hamano07824ce2006-04-25 07:36:542197pull.octopus::
2198The default merge strategy to use when pulling multiple branches
2199at once.
2200
2201pull.twohead::
2202The default merge strategy to use when pulling a single branch.
2203
Junio C Hamano1de75722009-03-26 08:39:382204push.default::
Junio C Hamano58655592013-07-11 20:52:332205Defines the action `git push` should take if no refspec is
2206explicitly given. Different values are well-suited for
2207specific workflows; for instance, in a purely central workflow
2208(i.e. the fetch source is equal to the push destination),
2209`upstream` is probably what you want. Possible values are:
Junio C Hamano1de75722009-03-26 08:39:382210+
Junio C Hamanobcaa8bc2012-07-03 22:17:202211--
Junio C Hamano58655592013-07-11 20:52:332212
2213* `nothing` - do not push anything (error out) unless a refspec is
2214 explicitly given. This is primarily meant for people who want to
2215 avoid mistakes by always being explicit.
2216
2217* `current` - push the current branch to update a branch with the same
2218 name on the receiving end. Works in both central and non-central
2219 workflows.
2220
2221* `upstream` - push the current branch back to the branch whose
2222 changes are usually integrated into the current branch (which is
2223 called `@{upstream}`). This mode only makes sense if you are
2224 pushing to the same repository you would normally pull from
2225 (i.e. central workflow).
2226
2227* `simple` - in centralized workflow, work like `upstream` with an
2228 added safety to refuse to push if the upstream branch's name is
2229 different from the local one.
Junio C Hamanobcaa8bc2012-07-03 22:17:202230+
Junio C Hamano58655592013-07-11 20:52:332231When pushing to a remote that is different from the remote you normally
2232pull from, work as `current`. This is the safest option and is suited
2233for beginners.
2234+
Junio C Hamano1d669b82014-03-11 21:36:002235This mode has become the default in Git 2.0.
Junio C Hamano58655592013-07-11 20:52:332236
2237* `matching` - push all branches having the same name on both ends.
2238 This makes the repository you are pushing to remember the set of
2239 branches that will be pushed out (e.g. if you always push 'maint'
2240 and 'master' there and no other branches, the repository you push
2241 to will have these two branches, and your local 'maint' and
2242 'master' will be pushed there).
2243+
2244To use this mode effectively, you have to make sure _all_ the
2245branches you would push out are ready to be pushed out before
2246running 'git push', as the whole point of this mode is to allow you
2247to push all of the branches in one go. If you usually finish work
2248on only one branch and push out the result, while other branches are
2249unfinished, this mode is not for you. Also this mode is not
2250suitable for pushing into a shared central repository, as other
2251people may add new branches there, or update the tip of existing
2252branches outside your control.
2253+
Junio C Hamano1d669b82014-03-11 21:36:002254This used to be the default, but not since Git 2.0 (`simple` is the
2255new default).
Junio C Hamano58655592013-07-11 20:52:332256
2257--
Junio C Hamano1de75722009-03-26 08:39:382258
Junio C Hamano322c6242015-03-23 21:32:462259push.followTags::
2260If set to true enable '--follow-tags' option by default. You
2261may override this configuration at time of push by specifying
2262'--no-follow-tags'.
2263
Junio C Hamano3891e252015-08-31 23:06:132264push.gpgSign::
2265May be set to a boolean value, or the string 'if-asked'. A true
2266value causes all pushes to be GPG signed, as if '--signed' is
2267passed to linkgit:git-push[1]. The string 'if-asked' causes
2268pushes to be signed if the server supports it, as if
2269'--signed=if-asked' is passed to 'git push'. A false value may
2270override a value from a lower-priority config file. An explicit
2271command-line flag always overrides this config option.
Junio C Hamano322c6242015-03-23 21:32:462272
Junio C Hamano409a33a2015-12-22 23:45:232273push.recurseSubmodules::
2274Make sure all submodule commits used by the revisions to be pushed
2275are available on a remote-tracking branch. If the value is 'check'
2276then Git will verify that all submodule commits that changed in the
2277revisions to be pushed are available on at least one remote of the
2278submodule. If any commits are missing, the push will be aborted and
2279exit with non-zero status. If the value is 'on-demand' then all
2280submodules that changed in the revisions to be pushed will be
2281pushed. If on-demand was not able to push all necessary revisions
2282it will also be aborted and exit with non-zero status. If the value
2283is 'no' then default behavior of ignoring submodules when pushing
2284is retained. You may override this configuration at time of push by
2285specifying '--recurse-submodules=check|on-demand|no'.
2286
Junio C Hamanoea6a7642009-03-11 23:56:192287rebase.stat::
2288Whether to show a diffstat of what changed upstream since the last
2289rebase. False by default.
2290
Junio C Hamano322c6242015-03-23 21:32:462291rebase.autoSquash::
Junio C Hamano075ae872010-09-01 18:43:072292If set to true enable '--autosquash' option by default.
2293
Junio C Hamano322c6242015-03-23 21:32:462294rebase.autoStash::
Junio C Hamanof1f5a7b2013-06-11 22:23:522295When set to true, automatically create a temporary stash
2296before the operation begins, and apply it after the operation
2297ends. This means that you can run rebase on a dirty worktree.
2298However, use with care: the final stash application after a
2299successful rebase might result in non-trivial conflicts.
2300Defaults to false.
2301
Junio C Hamanod7ed4042015-08-03 19:43:002302rebase.missingCommitsCheck::
2303If set to "warn", git rebase -i will print a warning if some
2304commits are removed (e.g. a line was deleted), however the
2305rebase will still proceed. If set to "error", it will print
2306the previous warning and stop the rebase, 'git rebase
2307--edit-todo' can then be used to correct the error. If set to
2308"ignore", no checking is done.
2309To drop a commit without warning or error, use the `drop`
2310command in the todo-list.
2311Defaults to "ignore".
2312
2313rebase.instructionFormat
2314A format string, as specified in linkgit:git-log[1], to be used for
2315the instruction list during an interactive rebase. The format will automatically
2316have the long commit hash prepended to the format.
2317
Junio C Hamano322c6242015-03-23 21:32:462318receive.advertiseAtomic::
Junio C Hamano6bb32e62015-02-17 22:11:262319By default, git-receive-pack will advertise the atomic push
2320capability to its clients. If you don't want to this capability
2321to be advertised, set this variable to false.
2322
Junio C Hamano621e1232009-10-26 05:16:472323receive.autogc::
2324By default, git-receive-pack will run "git-gc --auto" after
2325receiving data from git-push and updating refs. You can stop
2326it by setting this variable to false.
2327
Junio C Hamano322c6242015-03-23 21:32:462328receive.certNonceSeed::
Junio C Hamano9236fea2014-10-14 22:28:092329By setting this variable to a string, `git receive-pack`
2330will accept a `git push --signed` and verifies it by using
2331a "nonce" protected by HMAC using this string as a secret
2332key.
2333
Junio C Hamano322c6242015-03-23 21:32:462334receive.certNonceSlop::
Junio C Hamano9236fea2014-10-14 22:28:092335When a `git push --signed` sent a push certificate with a
2336"nonce" that was issued by a receive-pack serving the same
2337repository within this many seconds, export the "nonce"
2338found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2339hooks (instead of what the receive-pack asked the sending
2340side to include). This may allow writing checks in
2341`pre-receive` and `post-receive` a bit easier. Instead of
2342checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2343that records by how many seconds the nonce is stale to
2344decide if they want to accept the certificate, they only
2345can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2346
Junio C Hamano4653c6f2008-11-26 22:50:202347receive.fsckObjects::
2348If it is set to true, git-receive-pack will check all received
2349objects. It will abort in the case of a malformed object or a
2350broken link. The result of an abort are only dangling objects.
Junio C Hamano8fb66e52011-10-05 20:59:512351Defaults to false. If not set, the value of `transfer.fsckObjects`
2352is used instead.
Junio C Hamano4653c6f2008-11-26 22:50:202353
Junio C Hamanod7ed4042015-08-03 19:43:002354receive.fsck.<msg-id>::
2355When `receive.fsckObjects` is set to true, errors can be switched
2356to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2357setting where the `<msg-id>` is the fsck message ID and the value
2358is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2359the error/warning with the message ID, e.g. "missingEmail: invalid
2360author/committer line - missing email" means that setting
2361`receive.fsck.missingEmail = ignore` will hide that issue.
2362+
2363This feature is intended to support working with legacy repositories
2364which would not pass pushing when `receive.fsckObjects = true`, allowing
2365the host to accept repositories with certain known issues but still catch
2366other issues.
2367
2368receive.fsck.skipList::
2369The path to a sorted list of object names (i.e. one SHA-1 per
2370line) that are known to be broken in a non-fatal way and should
2371be ignored. This feature is useful when an established project
2372should be accepted despite early commits containing errors that
2373can be safely ignored such as invalid committer email addresses.
2374Note: corrupt objects cannot be skipped with this setting.
2375
Junio C Hamano4653c6f2008-11-26 22:50:202376receive.unpackLimit::
2377If the number of objects received in a push is below this
2378limit then the objects will be unpacked into loose object
2379files. However if the number of received objects equals or
2380exceeds this limit then the received pack will be stored as
2381a pack, after adding any missing delta bases. Storing the
2382pack from a push can make the push operation complete faster,
2383especially on slow filesystems. If not set, the value of
2384`transfer.unpackLimit` is used instead.
2385
2386receive.denyDeletes::
2387If set to true, git-receive-pack will deny a ref update that deletes
2388the ref. Use this to prevent such a ref deletion via a push.
2389
Junio C Hamanob4448a82010-07-26 09:02:322390receive.denyDeleteCurrent::
2391If set to true, git-receive-pack will deny a ref update that
2392deletes the currently checked out branch of a non-bare repository.
2393
Junio C Hamano4653c6f2008-11-26 22:50:202394receive.denyCurrentBranch::
Junio C Hamanoe97d5772010-05-19 08:13:582395If set to true or "refuse", git-receive-pack will deny a ref update
Junio C Hamano4653c6f2008-11-26 22:50:202396to the currently checked out branch of a non-bare repository.
2397Such a push is potentially dangerous because it brings the HEAD
2398out of sync with the index and working tree. If set to "warn",
2399print a warning of such a push to stderr, but allow the push to
2400proceed. If set to false or "ignore", allow such pushes with no
Junio C Hamanoafb395b2010-03-17 22:16:152401message. Defaults to "refuse".
Junio C Hamano6df93d92014-12-22 22:48:092402+
2403Another option is "updateInstead" which will update the working
Junio C Hamano6bb32e62015-02-17 22:11:262404tree if pushing into the current branch. This option is
Junio C Hamano6df93d92014-12-22 22:48:092405intended for synchronizing working directories when one side is not easily
2406accessible via interactive ssh (e.g. a live web site, hence the requirement
2407that the working directory be clean). This mode also comes in handy when
2408developing inside a VM to test and fix code on different Operating Systems.
Junio C Hamano6bb32e62015-02-17 22:11:262409+
2410By default, "updateInstead" will refuse the push if the working tree or
2411the index have any difference from the HEAD, but the `push-to-checkout`
2412hook can be used to customize this. See linkgit:githooks[5].
Junio C Hamano4653c6f2008-11-26 22:50:202413
2414receive.denyNonFastForwards::
2415If set to true, git-receive-pack will deny a ref update which is
Junio C Hamano3f680f32009-11-16 02:10:542416not a fast-forward. Use this to prevent such an update via a push,
Junio C Hamano4653c6f2008-11-26 22:50:202417even if that push is forced. This configuration variable is
2418set when initializing a shared repository.
2419
Junio C Hamano322c6242015-03-23 21:32:462420receive.hideRefs::
Junio C Hamanob6aa12e2015-08-19 22:40:172421This variable is the same as `transfer.hideRefs`, but applies
2422only to `receive-pack` (and so affects pushes, but not fetches).
2423An attempt to update or delete a hidden ref by `git push` is
2424rejected.
Junio C Hamano80ad00d2013-02-18 00:19:032425
Junio C Hamano322c6242015-03-23 21:32:462426receive.updateServerInfo::
Junio C Hamano621e1232009-10-26 05:16:472427If set to true, git-receive-pack will run git-update-server-info
2428after receiving data from git-push and updating refs.
2429
Junio C Hamano322c6242015-03-23 21:32:462430receive.shallowUpdate::
Junio C Hamano61525f92014-01-17 22:46:492431If set to true, .git/shallow can be updated when new refs
2432require new shallow roots. Otherwise those refs are rejected.
2433
Junio C Hamano322c6242015-03-23 21:32:462434remote.pushDefault::
Junio C Hamano63b6fdb2013-04-07 23:37:132435The remote to push to by default. Overrides
2436`branch.<name>.remote` for all branches, and is overridden by
Junio C Hamano322c6242015-03-23 21:32:462437`branch.<name>.pushRemote` for specific branches.
Junio C Hamano63b6fdb2013-04-07 23:37:132438
Junio C Hamano249572f2006-10-24 05:44:082439remote.<name>.url::
Junio C Hamano35738e82008-01-07 07:55:462440The URL of a remote repository. See linkgit:git-fetch[1] or
2441linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:082442
Junio C Hamano0e88f3e2009-06-21 08:03:252443remote.<name>.pushurl::
2444The push URL of a remote repository. See linkgit:git-push[1].
2445
Junio C Hamano58256872007-12-04 08:31:132446remote.<name>.proxy::
2447For remotes that require curl (http, https and ftp), the URL to
2448the proxy to use for that remote. Set to the empty string to
2449disable proxying for that remote.
2450
Junio C Hamanoffe10ca2016-02-04 00:44:232451remote.<name>.proxyAuthMethod::
2452For remotes that require curl (http, https and ftp), the method to use for
2453authenticating against the proxy in use (probably set in
2454`remote.<name>.proxy`). See `http.proxyAuthMethod`.
2455
Junio C Hamano249572f2006-10-24 05:44:082456remote.<name>.fetch::
Junio C Hamano35738e82008-01-07 07:55:462457The default set of "refspec" for linkgit:git-fetch[1]. See
2458linkgit:git-fetch[1].
Junio C Hamano249572f2006-10-24 05:44:082459
2460remote.<name>.push::
Junio C Hamano35738e82008-01-07 07:55:462461The default set of "refspec" for linkgit:git-push[1]. See
2462linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:082463
Junio C Hamano47d68a52008-05-06 06:35:402464remote.<name>.mirror::
2465If true, pushing to this remote will automatically behave
Junio C Hamanob76a6862012-05-02 22:02:462466as if the `--mirror` option was given on the command line.
Junio C Hamano47d68a52008-05-06 06:35:402467
Junio C Hamano118d2772007-02-21 20:24:102468remote.<name>.skipDefaultUpdate::
2469If true, this remote will be skipped by default when updating
Junio C Hamano9df0c662009-11-23 11:09:272470using linkgit:git-fetch[1] or the `update` subcommand of
2471linkgit:git-remote[1].
2472
2473remote.<name>.skipFetchAll::
2474If true, this remote will be skipped by default when updating
2475using linkgit:git-fetch[1] or the `update` subcommand of
2476linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:102477
Junio C Hamano4ad294b2007-01-20 02:22:502478remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:482479The default program to execute on the remote side when pushing. See
Junio C Hamano1dbca522015-05-22 20:48:552480option --receive-pack of linkgit:git-push[1].
Junio C Hamano4ad294b2007-01-20 02:22:502481
Junio C Hamano54ea8d32007-01-25 07:59:482482remote.<name>.uploadpack::
2483The default program to execute on the remote side when fetching. See
Junio C Hamano1dbca522015-05-22 20:48:552484option --upload-pack of linkgit:git-fetch-pack[1].
Junio C Hamano54ea8d32007-01-25 07:59:482485
Junio C Hamano322c6242015-03-23 21:32:462486remote.<name>.tagOpt::
Junio C Hamano1dbca522015-05-22 20:48:552487Setting this value to --no-tags disables automatic tag following when
2488fetching from remote <name>. Setting it to --tags will fetch every
Junio C Hamanocc7636a2010-05-21 14:57:532489tag from remote <name>, even if they are not reachable from remote
Junio C Hamano075ae872010-09-01 18:43:072490branch heads. Passing these flags directly to linkgit:git-fetch[1] can
Junio C Hamano1dbca522015-05-22 20:48:552491override this setting. See options --tags and --no-tags of
Junio C Hamano075ae872010-09-01 18:43:072492linkgit:git-fetch[1].
Junio C Hamano17dde0e2007-02-26 09:50:212493
Junio C Hamano096dde22009-12-26 23:14:112494remote.<name>.vcs::
Junio C Hamano076ffcc2013-02-06 05:13:212495Setting this to a value <vcs> will cause Git to interact with
Junio C Hamano096dde22009-12-26 23:14:112496the remote with the git-remote-<vcs> helper.
2497
Junio C Hamano8eac2682013-09-09 22:35:202498remote.<name>.prune::
2499When set to true, fetching from this remote by default will also
Junio C Hamano4c8f2d92013-12-13 00:55:422500remove any remote-tracking references that no longer exist on the
2501remote (as if the `--prune` option was given on the command line).
Junio C Hamano8eac2682013-09-09 22:35:202502Overrides `fetch.prune` settings, if any.
2503
Junio C Hamano118d2772007-02-21 20:24:102504remotes.<group>::
2505The list of remotes which are fetched by "git remote update
Junio C Hamano35738e82008-01-07 07:55:462506<group>". See linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:102507
Junio C Hamano322c6242015-03-23 21:32:462508repack.useDeltaBaseOffset::
Junio C Hamanofce7c7e2008-07-02 03:06:382509By default, linkgit:git-repack[1] creates packs that use
2510delta-base offset. If you need to share your repository with
Junio C Hamano076ffcc2013-02-06 05:13:212511Git older than version 1.4.4, either directly or via a dumb
Junio C Hamanofce7c7e2008-07-02 03:06:382512protocol such as http, then you need to set this option to
Junio C Hamano076ffcc2013-02-06 05:13:212513"false" and repack. Access from old Git versions over the
Junio C Hamanofce7c7e2008-07-02 03:06:382514native protocol are unaffected by this option.
Junio C Hamano77b7e902006-10-23 07:18:502515
Junio C Hamano3b0cdc22014-03-18 22:06:162516repack.packKeptObjects::
2517If set to true, makes `git repack` act as if
2518`--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2519details. Defaults to `false` normally, but `true` if a bitmap
2520index is being written (either via `--write-bitmap-index` or
Junio C Hamano38d02532014-06-26 21:48:502521`repack.writeBitmaps`).
2522
2523repack.writeBitmaps::
2524When true, git will write a bitmap index when packing all
2525objects to disk (e.g., when `git repack -a` is run). This
2526index can speed up the "counting objects" phase of subsequent
2527packs created for clones and fetches, at the cost of some disk
2528space and extra time spent on the initial repack. Defaults to
2529false.
Junio C Hamano3b0cdc22014-03-18 22:06:162530
Junio C Hamano322c6242015-03-23 21:32:462531rerere.autoUpdate::
Junio C Hamano4653c6f2008-11-26 22:50:202532When set to true, `git-rerere` updates the index with the
2533resulting contents after it cleanly resolves conflicts using
2534previously recorded resolution. Defaults to false.
2535
2536rerere.enabled::
2537Activate recording of resolved conflicts, so that identical
Junio C Hamano4fd24422012-01-06 21:52:432538conflict hunks can be resolved automatically, should they be
2539encountered again. By default, linkgit:git-rerere[1] is
2540enabled if there is an `rr-cache` directory under the
Junio C Hamano864ba892012-01-13 17:42:052541`$GIT_DIR`, e.g. if "rerere" was previously used in the
2542repository.
Junio C Hamano4653c6f2008-11-26 22:50:202543
Junio C Hamano1bbd0f42009-07-23 06:20:292544sendemail.identity::
2545A configuration identity. When given, causes values in the
2546'sendemail.<identity>' subsection to take precedence over
2547values in the 'sendemail' section. The default identity is
2548the value of 'sendemail.identity'.
2549
Junio C Hamano322c6242015-03-23 21:32:462550sendemail.smtpEncryption::
Junio C Hamano1bbd0f42009-07-23 06:20:292551See linkgit:git-send-email[1] for description. Note that this
2552setting is not subject to the 'identity' mechanism.
2553
Junio C Hamanobe087982015-02-22 21:29:392554sendemail.smtpssl (deprecated)::
Junio C Hamano322c6242015-03-23 21:32:462555Deprecated alias for 'sendemail.smtpEncryption = ssl'.
Junio C Hamano1bbd0f42009-07-23 06:20:292556
Junio C Hamano58f587a2013-07-22 19:20:592557sendemail.smtpsslcertpath::
2558Path to ca-certificates (either a directory or a single file).
2559Set it to an empty string to disable certificate verification.
2560
Junio C Hamano1bbd0f42009-07-23 06:20:292561sendemail.<identity>.*::
2562Identity-specific versions of the 'sendemail.*' parameters
2563found below, taking precedence over those when the this
2564identity is selected, through command-line or
2565'sendemail.identity'.
2566
Junio C Hamano322c6242015-03-23 21:32:462567sendemail.aliasesFile::
2568sendemail.aliasFileType::
Junio C Hamanoea3b7522013-04-18 19:37:532569sendemail.annotate::
Junio C Hamano1bbd0f42009-07-23 06:20:292570sendemail.bcc::
2571sendemail.cc::
Junio C Hamano322c6242015-03-23 21:32:462572sendemail.ccCmd::
2573sendemail.chainReplyTo::
Junio C Hamano1bbd0f42009-07-23 06:20:292574sendemail.confirm::
Junio C Hamano322c6242015-03-23 21:32:462575sendemail.envelopeSender::
Junio C Hamano1bbd0f42009-07-23 06:20:292576sendemail.from::
Junio C Hamano322c6242015-03-23 21:32:462577sendemail.multiEdit::
Junio C Hamano1bbd0f42009-07-23 06:20:292578sendemail.signedoffbycc::
Junio C Hamano322c6242015-03-23 21:32:462579sendemail.smtpPass::
Junio C Hamano1bbd0f42009-07-23 06:20:292580sendemail.suppresscc::
Junio C Hamano322c6242015-03-23 21:32:462581sendemail.suppressFrom::
Junio C Hamano1bbd0f42009-07-23 06:20:292582sendemail.to::
Junio C Hamano322c6242015-03-23 21:32:462583sendemail.smtpDomain::
2584sendemail.smtpServer::
2585sendemail.smtpServerPort::
2586sendemail.smtpServerOption::
2587sendemail.smtpUser::
Junio C Hamano1bbd0f42009-07-23 06:20:292588sendemail.thread::
Junio C Hamano322c6242015-03-23 21:32:462589sendemail.transferEncoding::
Junio C Hamano1bbd0f42009-07-23 06:20:292590sendemail.validate::
Junio C Hamanoc9394b22015-01-07 22:45:482591sendemail.xmailer::
Junio C Hamano1bbd0f42009-07-23 06:20:292592See linkgit:git-send-email[1] for description.
2593
Junio C Hamanobe087982015-02-22 21:29:392594sendemail.signedoffcc (deprecated)::
Junio C Hamano1bbd0f42009-07-23 06:20:292595Deprecated alias for 'sendemail.signedoffbycc'.
2596
Junio C Hamano07824ce2006-04-25 07:36:542597showbranch.default::
Junio C Hamano35738e82008-01-07 07:55:462598The default set of branches for linkgit:git-show-branch[1].
2599See linkgit:git-show-branch[1].
Junio C Hamano07824ce2006-04-25 07:36:542600
Junio C Hamano942b35e2007-12-09 10:19:332601status.relativePaths::
Junio C Hamano35738e82008-01-07 07:55:462602By default, linkgit:git-status[1] shows paths relative to the
Junio C Hamano942b35e2007-12-09 10:19:332603current directory. Setting this variable to `false` shows paths
Junio C Hamano076ffcc2013-02-06 05:13:212604relative to the repository root (this was the default for Git
Junio C Hamano942b35e2007-12-09 10:19:332605prior to v1.5.4).
2606
Junio C Hamano58655592013-07-11 20:52:332607status.short::
2608Set to true to enable --short by default in linkgit:git-status[1].
2609The option --no-short takes precedence over this variable.
2610
2611status.branch::
2612Set to true to enable --branch by default in linkgit:git-status[1].
2613The option --no-branch takes precedence over this variable.
2614
Junio C Hamano79f4c7c2013-09-20 21:03:372615status.displayCommentPrefix::
2616If set to true, linkgit:git-status[1] will insert a comment
2617prefix before each output line (starting with
2618`core.commentChar`, i.e. `#` by default). This was the
2619behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2620Defaults to false.
2621
Junio C Hamano4224f992008-06-23 07:14:082622status.showUntrackedFiles::
2623By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2624files which are not currently tracked by Git. Directories which
2625contain only untracked files, are shown with the directory name
2626only. Showing untracked files means that Git needs to lstat() all
Junio C Hamano2efd5e42014-11-10 22:38:522627the files in the whole repository, which might be slow on some
Junio C Hamano4224f992008-06-23 07:14:082628systems. So, this variable controls how the commands displays
2629the untracked files. Possible values are:
2630+
2631--
Junio C Hamano7f9fa862010-10-19 23:51:142632* `no` - Show no untracked files.
2633* `normal` - Show untracked files and directories.
2634* `all` - Show also individual files in untracked directories.
Junio C Hamano4224f992008-06-23 07:14:082635--
2636+
2637If this variable is not specified, it defaults to 'normal'.
2638This variable can be overridden with the -u|--untracked-files option
2639of linkgit:git-status[1] and linkgit:git-commit[1].
2640
Junio C Hamano322c6242015-03-23 21:32:462641status.submoduleSummary::
Junio C Hamanob671fb52010-06-01 05:06:142642Defaults to false.
2643If this is set to a non zero number or true (identical to -1 or an
2644unlimited number), the submodule summary will be enabled and a
2645summary of commits for modified submodules will be shown (see
Junio C Hamano369e3402013-10-15 18:40:252646--summary-limit option of linkgit:git-submodule[1]). Please note
2647that the summary output command will be suppressed for all
2648submodules when `diff.ignoreSubmodules` is set to 'all' or only
Junio C Hamanoc8c398a2014-06-16 21:14:052649for those submodules where `submodule.<name>.ignore=all`. The only
2650exception to that rule is that status and commit will show staged
2651submodule changes. To
Junio C Hamano369e3402013-10-15 18:40:252652also view the summary for ignored submodules you can either use
Junio C Hamanoe1aeb5e2014-06-06 19:16:292653the --ignore-submodules=dirty command-line option or the 'git
Junio C Hamano369e3402013-10-15 18:40:252654submodule summary' command, which shows a similar output but does
2655not honor these settings.
Junio C Hamanob671fb52010-06-01 05:06:142656
Junio C Hamano1eb56092015-10-05 20:39:532657stash.showPatch::
2658If this is set to true, the `git stash show` command without an
2659option will show the stash in patch form. Defaults to false.
2660See description of 'show' command in linkgit:git-stash[1].
2661
2662stash.showStat::
2663If this is set to true, the `git stash show` command without an
2664option will show diffstat of the stash. Defaults to true.
2665See description of 'show' command in linkgit:git-stash[1].
2666
Junio C Hamano78e3a782010-07-15 22:24:452667submodule.<name>.path::
2668submodule.<name>.url::
Junio C Hamano6bf68cf2015-03-06 23:46:292669The path within this project and URL for a submodule. These
2670variables are initially populated by 'git submodule init'. See
2671linkgit:git-submodule[1] and linkgit:gitmodules[5] for
2672details.
2673
Junio C Hamano78e3a782010-07-15 22:24:452674submodule.<name>.update::
Junio C Hamano6bf68cf2015-03-06 23:46:292675The default update procedure for a submodule. This variable
2676is populated by `git submodule init` from the
2677linkgit:gitmodules[5] file. See description of 'update'
2678command in linkgit:git-submodule[1].
Junio C Hamano78e3a782010-07-15 22:24:452679
Junio C Hamanoabad6da2013-01-06 09:06:322680submodule.<name>.branch::
2681The remote branch name for a submodule, used by `git submodule
2682update --remote`. Set this option to override the value found in
2683the `.gitmodules` file. See linkgit:git-submodule[1] and
2684linkgit:gitmodules[5] for details.
2685
Junio C Hamano0d75e872010-12-17 06:57:262686submodule.<name>.fetchRecurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:102687This option can be used to control recursive fetching of this
Junio C Hamano7165bf72011-01-04 22:06:182688submodule. It can be overridden by using the --[no-]recurse-submodules
Junio C Hamanoe1aeb5e2014-06-06 19:16:292689command-line option to "git fetch" and "git pull".
Junio C Hamano0d75e872010-12-17 06:57:262690This setting will override that from in the linkgit:gitmodules[5]
2691file.
2692
Junio C Hamano619596a2010-08-18 22:15:352693submodule.<name>.ignore::
2694Defines under what circumstances "git status" and the diff family show
2695a submodule as modified. When set to "all", it will never be considered
Junio C Hamanoc8c398a2014-06-16 21:14:052696modified (but it will nonetheless show up in the output of status and
2697commit when it has been staged), "dirty" will ignore all changes
2698to the submodules work tree and
Junio C Hamano619596a2010-08-18 22:15:352699takes only differences between the HEAD of the submodule and the commit
2700recorded in the superproject into account. "untracked" will additionally
2701let submodules with modified tracked files in their work tree show up.
2702Using "none" (the default when this option is not set) also shows
2703submodules that have untracked files in their work tree as changed.
2704This setting overrides any setting made in .gitmodules for this submodule,
Junio C Hamanode9745c2010-08-23 17:10:182705both settings can be overridden on the command line by using the
Junio C Hamano369e3402013-10-15 18:40:252706"--ignore-submodules" option. The 'git submodule' commands are not
2707affected by this setting.
Junio C Hamano619596a2010-08-18 22:15:352708
Junio C Hamano7b43d412014-07-23 23:09:442709tag.sort::
2710This variable controls the sort ordering of tags when displayed by
2711linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2712value of this variable will be used as the default.
2713
Junio C Hamano75cc4c92006-07-24 08:25:032714tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:092715This variable can be used to restrict the permission bits of
2716tar archive entries. The default is 0002, which turns off the
2717world write bit. The special value "user" indicates that the
2718archiving user's umask will be used instead. See umask(2) and
Junio C Hamano35738e82008-01-07 07:55:462719linkgit:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:032720
Junio C Hamano8fb66e52011-10-05 20:59:512721transfer.fsckObjects::
2722When `fetch.fsckObjects` or `receive.fsckObjects` are
2723not set, the value of this variable is used instead.
2724Defaults to false.
2725
Junio C Hamano322c6242015-03-23 21:32:462726transfer.hideRefs::
Junio C Hamanob6aa12e2015-08-19 22:40:172727String(s) `receive-pack` and `upload-pack` use to decide which
2728refs to omit from their initial advertisements. Use more than
2729one definition to specify multiple prefix strings. A ref that is
2730under the hierarchies listed in the value of this variable is
2731excluded, and is hidden when responding to `git push` or `git
2732fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
2733program-specific versions of this config.
2734+
2735You may also include a `!` in front of the ref name to negate the entry,
2736explicitly exposing it, even if an earlier entry marked it as hidden.
2737If you have multiple hideRefs values, later entries override earlier ones
2738(and entries in more-specific config files override less-specific ones).
Junio C Hamano713eded2015-12-03 00:24:022739+
2740If a namespace is in use, the namespace prefix is stripped from each
2741reference before it is matched against `transfer.hiderefs` patterns.
2742For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
2743the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
2744is omitted from the advertisements but `refs/heads/master` and
2745`refs/namespaces/bar/refs/heads/master` are still advertised as so-called
2746"have" lines. In order to match refs before stripping, add a `^` in front of
2747the ref name. If you combine `!` and `^`, `!` must be specified first.
Junio C Hamano80ad00d2013-02-18 00:19:032748
Junio C Hamano4653c6f2008-11-26 22:50:202749transfer.unpackLimit::
2750When `fetch.unpackLimit` or `receive.unpackLimit` are
2751not set, the value of this variable is used instead.
2752The default value is 100.
2753
Junio C Hamano81703b22014-03-14 22:00:272754uploadarchive.allowUnreachable::
2755If true, allow clients to use `git archive --remote` to request
2756any tree, whether reachable from the ref tips or not. See the
2757discussion in the `SECURITY` section of
2758linkgit:git-upload-archive[1] for more details. Defaults to
2759`false`.
2760
Junio C Hamano322c6242015-03-23 21:32:462761uploadpack.hideRefs::
Junio C Hamanob6aa12e2015-08-19 22:40:172762This variable is the same as `transfer.hideRefs`, but applies
2763only to `upload-pack` (and so affects only fetches, not pushes).
2764An attempt to fetch a hidden ref by `git fetch` will fail. See
2765also `uploadpack.allowTipSHA1InWant`.
Junio C Hamano5e7f1312013-03-21 22:49:012766
Junio C Hamano85f1fde2015-06-01 20:37:322767uploadpack.allowTipSHA1InWant::
Junio C Hamano322c6242015-03-23 21:32:462768When `uploadpack.hideRefs` is in effect, allow `upload-pack`
Junio C Hamano5e7f1312013-03-21 22:49:012769to accept a fetch request that asks for an object at the tip
2770of a hidden ref (by default, such a request is rejected).
Junio C Hamano322c6242015-03-23 21:32:462771see also `uploadpack.hideRefs`.
Junio C Hamano80ad00d2013-02-18 00:19:032772
Junio C Hamano85f1fde2015-06-01 20:37:322773uploadpack.allowReachableSHA1InWant::
2774Allow `upload-pack` to accept a fetch request that asks for an
2775object that is reachable from any ref tip. However, note that
2776calculating object reachability is computationally expensive.
2777Defaults to `false`.
2778
Junio C Hamano322c6242015-03-23 21:32:462779uploadpack.keepAlive::
Junio C Hamano79f4c7c2013-09-20 21:03:372780When `upload-pack` has started `pack-objects`, there may be a
2781quiet period while `pack-objects` prepares the pack. Normally
2782it would output progress information, but if `--quiet` was used
2783for the fetch, `pack-objects` will output nothing at all until
2784the pack data begins. Some clients and networks may consider
2785the server to be hung and give up. Setting this option instructs
2786`upload-pack` to send an empty keepalive packet every
Junio C Hamano322c6242015-03-23 21:32:462787`uploadpack.keepAlive` seconds. Setting this option to 0
Junio C Hamano79f4c7c2013-09-20 21:03:372788disables keepalive packets entirely. The default is 5 seconds.
2789
Junio C Hamano24bc09a2008-02-28 00:27:442790url.<base>.insteadOf::
2791Any URL that starts with this value will be rewritten to
2792start, instead, with <base>. In cases where some site serves a
2793large number of repositories, and serves them with multiple
2794access methods, and some users need to use different access
2795methods, this feature allows people to specify any of the
Junio C Hamano076ffcc2013-02-06 05:13:212796equivalent URLs and have Git automatically rewrite the URL to
Junio C Hamano24bc09a2008-02-28 00:27:442797the best alternative for the particular user, even for a
2798never-before-seen repository on the site. When more than one
2799insteadOf strings match a given URL, the longest match is used.
2800
Junio C Hamano7df6dcf2009-09-13 09:51:172801url.<base>.pushInsteadOf::
2802Any URL that starts with this value will not be pushed to;
2803instead, it will be rewritten to start with <base>, and the
2804resulting URL will be pushed to. In cases where some site serves
2805a large number of repositories, and serves them with multiple
2806access methods, some of which do not allow push, this feature
Junio C Hamano076ffcc2013-02-06 05:13:212807allows people to specify a pull-only URL and have Git
Junio C Hamano7df6dcf2009-09-13 09:51:172808automatically use an appropriate URL to push, even for a
2809never-before-seen repository on the site. When more than one
2810pushInsteadOf strings match a given URL, the longest match is
Junio C Hamano076ffcc2013-02-06 05:13:212811used. If a remote has an explicit pushurl, Git will ignore this
Junio C Hamano7df6dcf2009-09-13 09:51:172812setting for that remote.
2813
Junio C Hamano07824ce2006-04-25 07:36:542814user.email::
2815Your email address to be recorded in any newly created commits.
Junio C Hamano469d60e2007-04-29 18:30:342816Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Junio C Hamano35738e82008-01-07 07:55:462817'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:542818
2819user.name::
2820Your full name to be recorded in any newly created commits.
Junio C Hamano341071d2006-06-04 07:24:482821Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Junio C Hamano35738e82008-01-07 07:55:462822environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:542823
Junio C Hamano322c6242015-03-23 21:32:462824user.signingKey::
Junio C Hamano369e3402013-10-15 18:40:252825If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2826key you want it to automatically when creating a signed tag or
2827commit, you can override the default selection with this variable.
2828This option is passed unchanged to gpg's --local-user parameter,
2829so you may specify a key using any method that gpg supports.
Junio C Hamanoa890c4f2007-01-28 10:29:212830
Junio C Hamano07622622015-03-20 21:47:262831versionsort.prereleaseSuffix::
2832When version sort is used in linkgit:git-tag[1], prerelease
2833tags (e.g. "1.0-rc1") may appear after the main release
2834"1.0". By specifying the suffix "-rc" in this variable,
2835"1.0-rc1" will appear before "1.0".
2836+
2837This variable can be specified multiple times, once per suffix. The
2838order of suffixes in the config file determines the sorting order
2839(e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX
2840is sorted before 1.0-rcXX). The sorting order between different
2841suffixes is undefined if they are in multiple config files.
2842
Junio C Hamano4e272312008-01-08 09:13:212843web.browser::
2844Specify a web browser that may be used by some commands.
2845Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2846may use it.