blob: 04a1e2f37e938f004c899d3fb6c59d282c2071ce [file] [log] [blame]
Petr Baudis1ab661d2006-04-25 00:59:33 +02001CONFIGURATION FILE
2------------------
3
Thomas Ackermann2de9b712013-01-21 20:17:53 +01004The Git configuration file contains a number of variables that affect
5the Git commands' behavior. The `.git/config` file in each repository
Stephen Boyd66e35fc2009-04-23 02:38:02 -07006is used to store the configuration for that repository, and
7`$HOME/.gitconfig` is used to store a per-user configuration as
Stephen Boyd773002a2009-04-23 02:38:00 -07008fallback values for the `.git/config` file. The file `/etc/gitconfig`
Stephen Boyd66e35fc2009-04-23 02:38:02 -07009can be used to store a system-wide default configuration.
Junio C Hamano5ea56212007-01-16 22:45:35 -080010
Thomas Ackermann2de9b712013-01-21 20:17:53 +010011The configuration variables are used by both the Git plumbing
Stephen Boydb7ee2262009-04-23 02:38:01 -070012and the porcelains. The variables are divided into sections, wherein
13the fully qualified variable name of the variable itself is the last
Petr Baudis1ab661d2006-04-25 00:59:33 +020014dot-separated segment and the section name is everything before the last
Libor Pechaceke0a4aae2012-03-01 11:59:45 +010015dot. The variable names are case-insensitive, allow only alphanumeric
16characters and `-`, and must start with an alphabetic character. Some
17variables may appear multiple times.
Petr Baudis1ab661d2006-04-25 00:59:33 +020018
Jakub Narebskie136f332007-01-22 16:25:47 +010019Syntax
20~~~~~~
21
Petr Baudis1ab661d2006-04-25 00:59:33 +020022The syntax is fairly flexible and permissive; whitespaces are mostly
Jakub Narebskie136f332007-01-22 16:25:47 +010023ignored. The '#' and ';' characters begin comments to the end of line,
24blank lines are ignored.
25
26The file consists of sections and variables. A section begins with
27the name of the section in square brackets and continues until the next
28section begins. Section names are not case sensitive. Only alphanumeric
Chris Johnsendcb11262009-03-15 06:30:52 -050029characters, `-` and `.` are allowed in section names. Each variable
Stephen Boyd773002a2009-04-23 02:38:00 -070030must belong to some section, which means that there must be a section
31header before the first setting of a variable.
Jakub Narebskie136f332007-01-22 16:25:47 +010032
33Sections can be further divided into subsections. To begin a subsection
34put its name in double quotes, separated by space from the section name,
Stephen Boyd773002a2009-04-23 02:38:00 -070035in the section header, like in the example below:
Jakub Narebskie136f332007-01-22 16:25:47 +010036
37--------
38 [section "subsection"]
39
40--------
41
Stephen Boydb7ee2262009-04-23 02:38:01 -070042Subsection names are case sensitive and can contain any characters except
43newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
44respectively). Section headers cannot span multiple
Jakub Narebskie136f332007-01-22 16:25:47 +010045lines. Variables may belong directly to a section or to a given subsection.
46You can have `[section]` if you have `[section "subsection"]`, but you
47don't need to.
48
Carlos Martín Nietof7376322011-10-12 17:52:06 +020049There is also a deprecated `[section.subsection]` syntax. With this
50syntax, the subsection name is converted to lower-case and is also
51compared case sensitively. These subsection names follow the same
52restrictions as section names.
Jakub Narebskie136f332007-01-22 16:25:47 +010053
Nanako Shiraishi2ceb6392009-07-25 09:28:50 +090054All the other lines (and the remainder of the line after the section
55header) are recognized as setting variables, in the form
Jakub Narebskie136f332007-01-22 16:25:47 +010056'name = value'. If there is no equal sign on the line, the entire line
57is taken as 'name' and the variable is recognized as boolean "true".
Libor Pechaceke0a4aae2012-03-01 11:59:45 +010058The variable names are case-insensitive, allow only alphanumeric characters
59and `-`, and must start with an alphabetic character. There can be more
60than one value for a given variable; we say then that the variable is
61multivalued.
Jakub Narebskie136f332007-01-22 16:25:47 +010062
63Leading and trailing whitespace in a variable value is discarded.
64Internal whitespace within a variable value is retained verbatim.
65
66The values following the equals sign in variable assign are all either
67a string, an integer, or a boolean. Boolean values may be given as yes/no,
Carlos Martín Nieto18b19e42011-03-30 12:22:32 +0200681/0, true/false or on/off. Case is not significant in boolean values, when
Jakub Narebskie136f332007-01-22 16:25:47 +010069converting value to the canonical form using '--bool' type specifier;
Thomas Rast0b444cd2010-01-10 00:33:00 +010070'git config' will ensure that the output is "true" or "false".
Jakub Narebskie136f332007-01-22 16:25:47 +010071
72String values may be entirely or partially enclosed in double quotes.
Stephen Boyd773002a2009-04-23 02:38:00 -070073You need to enclose variable values in double quotes if you want to
74preserve leading or trailing whitespace, or if the variable value contains
75comment characters (i.e. it contains '#' or ';').
76Double quote `"` and backslash `\` characters in variable values must
Chris Johnsendcb11262009-03-15 06:30:52 -050077be escaped: use `\"` for `"` and `\\` for `\`.
Jakub Narebskie136f332007-01-22 16:25:47 +010078
Chris Johnsendcb11262009-03-15 06:30:52 -050079The following escape sequences (beside `\"` and `\\`) are recognized:
80`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
Justin Lebara58088a2014-03-31 15:11:44 -070081and `\b` for backspace (BS). Other char escape sequences (including octal
82escape sequences) are invalid.
Jakub Narebskie136f332007-01-22 16:25:47 +010083
Stephen Boyd773002a2009-04-23 02:38:00 -070084Variable values ending in a `\` are continued on the next line in the
Jakub Narebskie136f332007-01-22 16:25:47 +010085customary UNIX fashion.
86
Stephen Boyd773002a2009-04-23 02:38:00 -070087Some variables may require a special value format.
Petr Baudis1ab661d2006-04-25 00:59:33 +020088
Jeff King9b25a0b2012-02-06 04:54:04 -050089Includes
90~~~~~~~~
91
92You can include one config file from another by setting the special
93`include.path` variable to the name of the file to be included. The
94included file is expanded immediately, as if its contents had been
95found at the location of the include directive. If the value of the
96`include.path` variable is a relative path, the path is considered to be
97relative to the configuration file in which the include directive was
Jeff King9a7b0bc2012-05-02 19:43:52 -040098found. The value of `include.path` is subject to tilde expansion: `~/`
99is expanded to the value of `$HOME`, and `~user/` to the specified
Jeff King4c0a89f2012-04-25 08:00:36 -0400100user's home directory. See below for examples.
Jeff King9b25a0b2012-02-06 04:54:04 -0500101
Petr Baudis1ab661d2006-04-25 00:59:33 +0200102Example
103~~~~~~~
104
105 # Core variables
106 [core]
107 ; Don't trust file modes
108 filemode = false
109
110 # Our diff algorithm
111 [diff]
Anders Melchiorsen6bb9e512008-07-27 13:12:15 +0200112 external = /usr/local/bin/diff-wrapper
Petr Baudis1ab661d2006-04-25 00:59:33 +0200113 renames = true
114
Aneesh Kumar K.V910c00c2006-12-07 12:06:55 +0530115 [branch "devel"]
116 remote = origin
117 merge = refs/heads/devel
118
Jakub Narebskie136f332007-01-22 16:25:47 +0100119 # Proxy settings
120 [core]
David Symonds29093c22007-08-03 08:45:56 +1000121 gitProxy="ssh" for "kernel.org"
Jakub Narebskie136f332007-01-22 16:25:47 +0100122 gitProxy=default-proxy ; for the rest
Aneesh Kumar K.V910c00c2006-12-07 12:06:55 +0530123
Jeff King9b25a0b2012-02-06 04:54:04 -0500124 [include]
125 path = /path/to/foo.inc ; include by absolute path
126 path = foo ; expand "foo" relative to the current file
Jeff King4c0a89f2012-04-25 08:00:36 -0400127 path = ~/foo ; expand "foo" in your $HOME directory
Jeff King9b25a0b2012-02-06 04:54:04 -0500128
Petr Baudis1ab661d2006-04-25 00:59:33 +0200129Variables
130~~~~~~~~~
131
132Note that this list is non-comprehensive and not necessarily complete.
Francis Dalyb8936cf2006-06-08 00:15:05 +0100133For command-specific variables, you will find a more detailed description
Chris Angelico93728b22014-03-21 15:07:08 +1100134in the appropriate manual page.
135
136Other git-related tools may and do use their own variables. When
137inventing new variables for use in your own tool, make sure their
138names do not conflict with those that are used by Git itself and
139other popular tools, and describe them in your documentation.
140
Petr Baudis1ab661d2006-04-25 00:59:33 +0200141
Jeff King75194432009-09-09 07:38:58 -0400142advice.*::
Junio C Hamano26e94af2011-12-18 21:35:01 -0800143 These variables control various optional help messages designed to
144 aid new users. All 'advice.*' variables default to 'true', and you
145 can tell Git that you do not need help by setting these to 'false':
Jeff King75194432009-09-09 07:38:58 -0400146+
147--
Chris Rorvick11845642012-12-02 21:27:50 -0600148 pushUpdateRejected::
Christopher Tiwaldf25950f2012-03-20 00:31:33 -0400149 Set this variable to 'false' if you want to disable
Junio C Hamano009055f2014-03-07 15:13:15 -0800150 'pushNonFFCurrent',
Junio C Hamano75e5c0d2013-01-23 13:55:30 -0800151 'pushNonFFMatching', 'pushAlreadyExists',
152 'pushFetchFirst', and 'pushNeedsForce'
Chris Rorvickb4505682012-12-02 21:27:51 -0600153 simultaneously.
Christopher Tiwaldf25950f2012-03-20 00:31:33 -0400154 pushNonFFCurrent::
155 Advice shown when linkgit:git-push[1] fails due to a
156 non-fast-forward update to the current branch.
Christopher Tiwaldf25950f2012-03-20 00:31:33 -0400157 pushNonFFMatching::
158 Advice shown when you ran linkgit:git-push[1] and pushed
159 'matching refs' explicitly (i.e. you used ':', or
160 specified a refspec that isn't your current branch) and
161 it resulted in a non-fast-forward error.
Chris Rorvickb4505682012-12-02 21:27:51 -0600162 pushAlreadyExists::
163 Shown when linkgit:git-push[1] rejects an update that
164 does not qualify for fast-forwarding (e.g., a tag.)
Junio C Hamano75e5c0d2013-01-23 13:55:30 -0800165 pushFetchFirst::
166 Shown when linkgit:git-push[1] rejects an update that
167 tries to overwrite a remote ref that points at an
168 object we do not have.
169 pushNeedsForce::
170 Shown when linkgit:git-push[1] rejects an update that
171 tries to overwrite a remote ref that points at an
Richard Hansena8a54062013-09-04 15:04:31 -0400172 object that is not a commit-ish, or make the remote
173 ref point at an object that is not a commit-ish.
Jeff Kingedf563f2009-09-09 07:43:03 -0400174 statusHints::
Lucien Kong83c750a2012-06-05 22:21:24 +0200175 Show directions on how to proceed from the current
Matthieu Moy552755a2012-12-04 10:15:03 +0100176 state in the output of linkgit:git-status[1], in
Lucien Kong83c750a2012-06-05 22:21:24 +0200177 the template shown when writing commit messages in
Matthieu Moy552755a2012-12-04 10:15:03 +0100178 linkgit:git-commit[1], and in the help message shown
179 by linkgit:git-checkout[1] when switching branch.
Nguyễn Thái Ngọc Duy6a38ef22013-03-13 19:59:16 +0700180 statusUoption::
181 Advise to consider using the `-u` option to linkgit:git-status[1]
182 when the command takes more than 2 seconds to enumerate untracked
183 files.
Matthieu Moy4c371f92009-11-22 23:26:17 +0100184 commitBeforeMerge::
185 Advice shown when linkgit:git-merge[1] refuses to
Ville Skyttä6b677a22010-07-20 00:17:17 +0300186 merge to avoid overwriting local changes.
Matthieu Moyd38a30d2010-01-12 10:54:44 +0100187 resolveConflict::
Greg Price4f021b32013-02-25 00:27:20 -0500188 Advice shown by various commands when conflicts
Matthieu Moyd38a30d2010-01-12 10:54:44 +0100189 prevent the operation from being performed.
Jeff Kingb706fcf2010-01-13 15:17:08 -0500190 implicitIdentity::
191 Advice on how to set your identity configuration when
192 your information is guessed from the system username and
Junio C Hamano26e94af2011-12-18 21:35:01 -0800193 domain name.
Junio C Hamano13be3e32010-01-29 22:03:24 -0800194 detachedHead::
Junio C Hamano26e94af2011-12-18 21:35:01 -0800195 Advice shown when you used linkgit:git-checkout[1] to
Junio C Hamano13be3e32010-01-29 22:03:24 -0800196 move to the detach HEAD state, to instruct how to create
Junio C Hamano26e94af2011-12-18 21:35:01 -0800197 a local branch after the fact.
Paul Gortmaker14bf2d52012-07-13 11:51:30 -0400198 amWorkDir::
199 Advice that shows the location of the patch file when
200 linkgit:git-am[1] fails to apply it.
Mathieu Lienard--Mayor7e309442013-06-12 10:06:44 +0200201 rmHints::
202 In case of failure in the output of linkgit:git-rm[1],
203 show directions on how to proceed from the current state.
Jeff King75194432009-09-09 07:38:58 -0400204--
205
Petr Baudis1ab661d2006-04-25 00:59:33 +0200206core.fileMode::
207 If false, the executable bit differences between the index and
Carlos Martín Nietof7d650c2011-09-20 22:25:57 +0200208 the working tree are ignored; useful on broken filesystems like FAT.
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700209 See linkgit:git-update-index[1].
210+
211The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
212will probe and set core.fileMode false if appropriate when the
213repository is created.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200214
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700215core.ignorecase::
216 If true, this option enables various workarounds to enable
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100217 Git to work better on filesystems that are not case sensitive,
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700218 like FAT. For example, if a directory listing finds
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100219 "makefile" when Git expects "Makefile", Git will assume
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700220 it is really the same file, and continue to remember it as
221 "Makefile".
222+
223The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
224will probe and set core.ignorecase true if appropriate when the repository
225is created.
226
Torsten Bögershausen76759c72012-07-08 15:50:25 +0200227core.precomposeunicode::
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100228 This option is only used by Mac OS implementation of Git.
229 When core.precomposeunicode=true, Git reverts the unicode decomposition
Torsten Bögershausen76759c72012-07-08 15:50:25 +0200230 of filenames done by Mac OS. This is useful when sharing a repository
231 between Mac OS and Linux or Windows.
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100232 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
233 When false, file names are handled fully transparent by Git,
234 which is backward compatible with older versions of Git.
Torsten Bögershausen76759c72012-07-08 15:50:25 +0200235
Alex Riesen1ce47902008-07-28 08:31:28 +0200236core.trustctime::
237 If false, the ctime differences between the index and the
Carlos Martín Nietof7d650c2011-09-20 22:25:57 +0200238 working tree are ignored; useful when the inode change time
Alex Riesen1ce47902008-07-28 08:31:28 +0200239 is regularly modified by something outside Git (file system
240 crawlers and some backup systems).
241 See linkgit:git-update-index[1]. True by default.
242
Robin Rosenbergc08e4d52013-01-22 08:49:22 +0100243core.checkstat::
244 Determines which stat fields to match between the index
245 and work tree. The user can set this to 'default' or
246 'minimal'. Default (or explicitly 'default'), is to check
247 all fields, including the sub-second part of mtime and ctime.
248
Junio C Hamano9378c162007-06-24 15:11:24 -0700249core.quotepath::
Jonathan Nieder5833d732008-07-03 00:59:09 -0500250 The commands that output paths (e.g. 'ls-files',
251 'diff'), when not given the `-z` option, will quote
Junio C Hamano9378c162007-06-24 15:11:24 -0700252 "unusual" characters in the pathname by enclosing the
253 pathname in a double-quote pair and with backslashes the
254 same way strings in C source code are quoted. If this
255 variable is set to false, the bytes higher than 0x80 are
256 not quoted but output as verbatim. Note that double
257 quote, backslash and control characters are always
258 quoted without `-z` regardless of the setting of this
259 variable.
260
Eyvind Bernhardsen942e7742010-06-04 21:29:08 +0200261core.eol::
262 Sets the line ending type to use in the working directory for
263 files that have the `text` property set. Alternatives are
264 'lf', 'crlf' and 'native', which uses the platform's native
265 line ending. The default value is `native`. See
266 linkgit:gitattributes[5] for more information on end-of-line
267 conversion.
Frank Lichtenheld5cb71f82007-04-13 18:02:31 +0200268
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100269core.safecrlf::
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100270 If true, makes Git check if converting `CRLF` is reversible when
Eyvind Bernhardsenfd6cce92010-05-19 22:43:10 +0200271 end-of-line conversion is active. Git will verify if a command
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100272 modifies a file in the work tree either directly or indirectly.
273 For example, committing a file followed by checking out the
274 same file should yield the original file in the work tree. If
275 this is not the case for the current setting of
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100276 `core.autocrlf`, Git will reject the file. The variable can
277 be set to "warn", in which case Git will only warn about an
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100278 irreversible conversion but continue the operation.
279+
280CRLF conversion bears a slight chance of corrupting data.
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100281When it is enabled, Git will convert CRLF to LF during commit and LF to
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100282CRLF during checkout. A file that contains a mixture of LF and
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100283CRLF before the commit cannot be recreated by Git. For text
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100284files this is the right thing to do: it corrects line endings
285such that we have only LF line endings in the repository.
286But for binary files that are accidentally classified as text the
287conversion can corrupt data.
288+
289If you recognize such corruption early you can easily fix it by
290setting the conversion type explicitly in .gitattributes. Right
291after committing you still have the original file in your work
292tree and this file is not yet corrupted. You can explicitly tell
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100293Git that this file is binary and Git will handle the file
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100294appropriately.
295+
296Unfortunately, the desired effect of cleaning up text files with
297mixed line endings and the undesired effect of corrupting binary
298files cannot be distinguished. In both cases CRLFs are removed
299in an irreversible way. For text files this is the right thing
300to do because CRLFs are line endings, while for binary files
301converting CRLFs corrupts data.
302+
303Note, this safety check does not mean that a checkout will generate a
304file identical to the original file for a different setting of
Eyvind Bernhardsen942e7742010-06-04 21:29:08 +0200305`core.eol` and `core.autocrlf`, but only for the current one. For
306example, a text file with `LF` would be accepted with `core.eol=lf`
307and could later be checked out with `core.eol=crlf`, in which case the
Steffen Prohaska21e5ad52008-02-06 12:25:58 +0100308resulting file would contain `CRLF`, although the original file
309contained `LF`. However, in both work trees the line endings would be
310consistent, that is either all `LF` or all `CRLF`, but never mixed. A
311file with mixed line endings would be reported by the `core.safecrlf`
312mechanism.
313
Eyvind Bernhardsen942e7742010-06-04 21:29:08 +0200314core.autocrlf::
315 Setting this variable to "true" is almost the same as setting
316 the `text` attribute to "auto" on all files except that text
317 files are not guaranteed to be normalized: files that contain
318 `CRLF` in the repository will not be touched. Use this
319 setting if you want to have `CRLF` line endings in your
320 working directory even though the repository does not have
321 normalized line endings. This variable can be set to 'input',
322 in which case no output conversion is performed.
323
Johannes Sixt78a8d642007-03-02 22:11:30 +0100324core.symlinks::
325 If false, symbolic links are checked out as small plain files that
Dan McGee5162e692007-12-29 00:20:38 -0600326 contain the link text. linkgit:git-update-index[1] and
327 linkgit:git-add[1] will not change the recorded type to regular
Johannes Sixt78a8d642007-03-02 22:11:30 +0100328 file. Useful on filesystems like FAT that do not support
Matthew Ogilvie7b357242009-11-22 19:07:30 -0700329 symbolic links.
330+
331The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
332will probe and set core.symlinks false if appropriate when the repository
333is created.
Johannes Sixt78a8d642007-03-02 22:11:30 +0100334
Petr Baudis1ab661d2006-04-25 00:59:33 +0200335core.gitProxy::
336 A "proxy command" to execute (as 'command host port') instead
337 of establishing direct connection to the remote server when
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100338 using the Git protocol for fetching. If the variable value is
Petr Baudis1ab661d2006-04-25 00:59:33 +0200339 in the "COMMAND for DOMAIN" format, the command is applied only
340 on hostnames ending with the specified domain string. This variable
341 may be set multiple times and is matched in the given order;
342 the first match wins.
Francis Dalyb8936cf2006-06-08 00:15:05 +0100343+
344Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
345(which always applies universally, without the special "for"
346handling).
Emil Sit642d0842009-03-17 13:31:42 -0400347+
348The special string `none` can be used as the proxy command to
349specify that no proxy be used for a given domain pattern.
350This is useful for excluding servers inside a firewall from
351proxy use, while defaulting to a common proxy for external domains.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200352
353core.ignoreStat::
Marius Storm-Olsenb7f685a2008-05-30 13:14:24 +0200354 If true, commands which modify both the working tree and the index
355 will mark the updated paths with the "assume unchanged" bit in the
356 index. These marked files are then assumed to stay unchanged in the
Carlos Martín Nietof7d650c2011-09-20 22:25:57 +0200357 working tree, until you mark them otherwise manually - Git will not
Marius Storm-Olsenb7f685a2008-05-30 13:14:24 +0200358 detect the file changes by lstat() calls. This is useful on systems
359 where those are very slow, such as Microsoft Windows.
360 See linkgit:git-update-index[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +0200361 False by default.
362
Junio C Hamano9f0bb902006-05-02 00:40:24 -0700363core.preferSymlinkRefs::
364 Instead of the default "symref" format for HEAD
365 and other symbolic reference files, use symbolic links.
366 This is sometimes needed to work with old scripts that
367 expect HEAD to be a symbolic link.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200368
Shawn O. Pearcee4a15f42007-02-21 17:59:08 -0500369core.bare::
370 If true this repository is assumed to be 'bare' and has no
371 working directory associated with it. If this is the case a
372 number of commands that require a working directory will be
Dan McGee5162e692007-12-29 00:20:38 -0600373 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Shawn O. Pearcee4a15f42007-02-21 17:59:08 -0500374+
Dan McGee5162e692007-12-29 00:20:38 -0600375This setting is automatically guessed by linkgit:git-clone[1] or
376linkgit:git-init[1] when the repository was created. By default a
Shawn O. Pearcee4a15f42007-02-21 17:59:08 -0500377repository that ends in "/.git" is assumed to be not bare (bare =
378false), while all other repositories are assumed to be bare (bare
379= true).
380
Matthias Lederhofer892c41b2007-06-06 09:10:42 +0200381core.worktree::
Junio C Hamanoea472c12011-01-23 15:49:41 -0800382 Set the path to the root of the working tree.
Ralf Wildenhues06ada152007-10-09 23:00:03 +0200383 This can be overridden by the GIT_WORK_TREE environment
Jason St. John06ab60c2014-05-21 14:52:26 -0400384 variable and the '--work-tree' command-line option.
SZEDER Gábord424a472011-04-04 16:59:25 +0200385 The value can be an absolute path or relative to the path to
Junio C Hamanoea472c12011-01-23 15:49:41 -0800386 the .git directory, which is either specified by --git-dir
387 or GIT_DIR, or automatically discovered.
388 If --git-dir or GIT_DIR is specified but none of
Liu Yubao302cc112008-04-29 04:09:20 +0800389 --work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamanoea472c12011-01-23 15:49:41 -0800390 the current working directory is regarded as the top level
Nguyễn Thái Ngọc Duy98acf752010-11-26 22:32:42 +0700391 of your working tree.
Junio C Hamanoea472c12011-01-23 15:49:41 -0800392+
393Note that this variable is honored even when set in a configuration
394file in a ".git" subdirectory of a directory and its value differs
395from the latter directory (e.g. "/path/to/.git/config" has
396core.worktree set to "/different/path"), which is most likely a
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100397misconfiguration. Running Git commands in the "/path/to" directory will
Junio C Hamanoea472c12011-01-23 15:49:41 -0800398still use "/different/path" as the root of the work tree and can cause
399confusion unless you know what you are doing (e.g. you are creating a
400read-only snapshot of the same index to a location different from the
401repository's usual working tree).
Matthias Lederhofer892c41b2007-06-06 09:10:42 +0200402
Shawn Pearce6de08ae2006-05-17 05:55:40 -0400403core.logAllRefUpdates::
Lukas Sandström14cd5602007-08-19 23:38:57 +0200404 Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamano4057deb2006-10-08 01:35:18 -0700405 "$GIT_DIR/logs/<ref>", by appending the new and old
Thomas Ackermannd5fa1f12013-04-15 19:49:04 +0200406 SHA-1, the date/time and the reason of the update, but
Junio C Hamano4057deb2006-10-08 01:35:18 -0700407 only when the file exists. If this configuration
408 variable is set to true, missing "$GIT_DIR/logs/<ref>"
Bert Wesargcd8e3712011-07-11 11:14:18 +0200409 file is automatically created for branch heads (i.e. under
410 refs/heads/), remote refs (i.e. under refs/remotes/),
411 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
Junio C Hamanoa862f972006-12-30 22:39:24 -0800412+
413This information can be used to determine what commit
414was the tip of a branch "2 days ago".
415+
416This value is true by default in a repository that has
417a working directory associated with it, and false by
418default in a bare repository.
Shawn Pearce6de08ae2006-05-17 05:55:40 -0400419
Petr Baudis1ab661d2006-04-25 00:59:33 +0200420core.repositoryFormatVersion::
421 Internal variable identifying the repository format and layout
422 version.
423
424core.sharedRepository::
Jonas Fonsecad5dc6a72006-08-09 02:26:23 +0200425 When 'group' (or 'true'), the repository is made shareable between
426 several users in a group (making sure all the files and objects are
427 group-writable). When 'all' (or 'world' or 'everybody'), the
428 repository will be readable by all users, additionally to being
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100429 group-shareable. When 'umask' (or 'false'), Git will use permissions
Heikki Orsila06cbe852008-04-16 11:34:24 +0300430 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
431 files in the repository will have this mode value. '0xxx' will override
Johan Herland098082f2009-04-14 15:15:42 +0200432 user's umask value (whereas the other options will only override
433 requested parts of the user's umask value). Examples: '0660' will make
434 the repo read/write-able for the owner and group, but inaccessible to
435 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Heikki Orsila06cbe852008-04-16 11:34:24 +0300436 repository that is group-readable but not group-writable.
437 See linkgit:git-init[1]. False by default.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200438
439core.warnAmbiguousRefs::
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100440 If true, Git will warn you if the ref name you passed it is ambiguous
Greg Price48dfe962013-02-25 00:34:14 -0500441 and might match multiple refs in the repository. True by default.
Petr Baudis1ab661d2006-04-25 00:59:33 +0200442
Joachim Berdal Haga3d3e95a2006-07-06 22:35:54 +0200443core.compression::
Dana How960ccca2007-05-09 13:56:50 -0700444 An integer -1..9, indicating a default compression level.
445 -1 is the zlib default. 0 means no compression,
446 and 1..9 are various speed/size tradeoffs, 9 being slowest.
Brian Downingdec92302007-11-19 10:58:51 -0600447 If set, this provides a default to other compression variables,
448 such as 'core.loosecompression' and 'pack.compression'.
Dana How960ccca2007-05-09 13:56:50 -0700449
450core.loosecompression::
Joachim B Haga12f6c302006-07-03 22:11:47 +0200451 An integer -1..9, indicating the compression level for objects that
Dana How960ccca2007-05-09 13:56:50 -0700452 are not in a pack file. -1 is the zlib default. 0 means no
Joachim B Haga12f6c302006-07-03 22:11:47 +0200453 compression, and 1..9 are various speed/size tradeoffs, 9 being
Dana How960ccca2007-05-09 13:56:50 -0700454 slowest. If not set, defaults to core.compression. If that is
Brian Downingde1b2462007-11-19 10:58:50 -0600455 not set, defaults to 1 (best speed).
Joachim B Haga12f6c302006-07-03 22:11:47 +0200456
Shawn O. Pearce60bb8b12006-12-23 02:34:28 -0500457core.packedGitWindowSize::
458 Number of bytes of a pack file to map into memory in a
459 single mapping operation. Larger window sizes may allow
460 your system to process a smaller number of large pack files
461 more quickly. Smaller window sizes will negatively affect
Shawn O. Pearceeb922422006-12-30 22:13:43 -0500462 performance due to increased calls to the operating system's
Shawn O. Pearce60bb8b12006-12-23 02:34:28 -0500463 memory manager, but may improve performance when accessing
Shawn O. Pearce22bac0e2007-01-04 22:28:08 -0500464 a large number of large pack files.
465+
466Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
467MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
468be reasonable for all users/operating systems. You probably do
469not need to adjust this value.
Shawn O. Pearceeb922422006-12-30 22:13:43 -0500470+
471Common unit suffixes of 'k', 'm', or 'g' are supported.
Shawn O. Pearce60bb8b12006-12-23 02:34:28 -0500472
Shawn O. Pearce77ccc5b2006-12-23 02:33:35 -0500473core.packedGitLimit::
474 Maximum number of bytes to map simultaneously into memory
475 from pack files. If Git needs to access more than this many
476 bytes at once to complete an operation it will unmap existing
477 regions to reclaim virtual address space within the process.
Shawn O. Pearce22bac0e2007-01-04 22:28:08 -0500478+
479Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
480This should be reasonable for all users/operating systems, except on
481the largest projects. You probably do not need to adjust this value.
Shawn O. Pearceeb922422006-12-30 22:13:43 -0500482+
483Common unit suffixes of 'k', 'm', or 'g' are supported.
Shawn O. Pearce77ccc5b2006-12-23 02:33:35 -0500484
Shawn O. Pearce18bdec12007-03-19 01:14:37 -0400485core.deltaBaseCacheLimit::
486 Maximum number of bytes to reserve for caching base objects
Ville Skyttä6b677a22010-07-20 00:17:17 +0300487 that may be referenced by multiple deltified objects. By storing the
Shawn O. Pearce18bdec12007-03-19 01:14:37 -0400488 entire decompressed base objects in a cache Git is able
489 to avoid unpacking and decompressing frequently used base
490 objects multiple times.
491+
David Kastrup4874f542014-05-04 19:13:57 +0200492Default is 96 MiB on all platforms. This should be reasonable
Shawn O. Pearce18bdec12007-03-19 01:14:37 -0400493for all users/operating systems, except on the largest projects.
494You probably do not need to adjust this value.
495+
496Common unit suffixes of 'k', 'm', or 'g' are supported.
497
Shawn O. Pearce5eef8282010-02-01 09:27:35 -0800498core.bigFileThreshold::
499 Files larger than this size are stored deflated, without
500 attempting delta compression. Storing large files without
501 delta compression avoids excessive memory usage, at the
Nguyễn Thái Ngọc Duy6bf3b812014-08-16 10:08:05 +0700502 slight expense of increased disk usage. Additionally files
503 larger than this size are always treated as binary.
Shawn O. Pearce5eef8282010-02-01 09:27:35 -0800504+
505Default is 512 MiB on all platforms. This should be reasonable
506for most projects as source code and other text files can still
507be delta compressed, but larger binary media files won't be.
508+
509Common unit suffixes of 'k', 'm', or 'g' are supported.
Shawn O. Pearce5eef8282010-02-01 09:27:35 -0800510
Michael Hendrickse8964a52007-07-02 10:48:34 -0600511core.excludesfile::
Johannes Schindelin0ba956d2007-05-22 01:12:17 +0100512 In addition to '.gitignore' (per-directory) and
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100513 '.git/info/exclude', Git looks into this file for patterns
Jeff King6cf378f2012-04-26 04:51:57 -0400514 of files which are not meant to be tracked. "`~/`" is expanded
515 to the value of `$HOME` and "`~user/`" to the specified user's
Huynh Khoi Nguyen Nguyendc796872012-06-22 11:03:24 +0200516 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
517 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
518 is used instead. See linkgit:gitignore[5].
Johannes Schindelin0ba956d2007-05-22 01:12:17 +0100519
Anselm Kruisd3e7da82010-08-30 15:38:38 +0200520core.askpass::
521 Some commands (e.g. svn and http interfaces) that interactively
522 ask for a password can be told to use an external program given
Knut Franke453842c2010-08-30 15:40:29 +0200523 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
524 environment variable. If not set, fall back to the value of the
525 'SSH_ASKPASS' environment variable or, failing that, a simple password
526 prompt. The external program shall be given a suitable prompt as
Jason St. John06ab60c2014-05-21 14:52:26 -0400527 command-line argument and write the password on its STDOUT.
Anselm Kruisd3e7da82010-08-30 15:38:38 +0200528
Petr Onderka6df42ab2010-09-01 00:42:43 +0200529core.attributesfile::
530 In addition to '.gitattributes' (per-directory) and
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100531 '.git/info/attributes', Git looks into this file for attributes
Petr Onderka6df42ab2010-09-01 00:42:43 +0200532 (see linkgit:gitattributes[5]). Path expansions are made the same
Huynh Khoi Nguyen Nguyen684e40f2012-06-22 11:03:25 +0200533 way as for `core.excludesfile`. Its default value is
534 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
535 set or empty, $HOME/.config/git/attributes is used instead.
Petr Onderka6df42ab2010-09-01 00:42:43 +0200536
Adam Robenef0c2ab2007-07-19 22:09:35 -0700537core.editor::
538 Commands such as `commit` and `tag` that lets you edit
Brian Hetro02783072007-08-23 20:44:13 -0400539 messages by launching an editor uses the value of this
Adam Robenef0c2ab2007-07-19 22:09:35 -0700540 variable when it is set, and the environment variable
Jonathan Niederb4479f02009-10-30 20:42:34 -0500541 `GIT_EDITOR` is not set. See linkgit:git-var[1].
Adam Robenef0c2ab2007-07-19 22:09:35 -0700542
Junio C Hamanoeff80a92013-01-16 20:18:48 +0100543core.commentchar::
544 Commands such as `commit` and `tag` that lets you edit
545 messages consider a line that begins with this character
546 commented, and removes them after the editor returns
547 (default '#').
Nguyễn Thái Ngọc Duy84c9dc22014-05-17 08:52:23 +0700548+
549If set to "auto", `git-commit` would select a character that is not
550the beginning character of any line in existing commit messages.
Junio C Hamanoeff80a92013-01-16 20:18:48 +0100551
Peter Oberndorfer821881d2011-10-17 22:26:23 +0200552sequence.editor::
Matthias Krüger3322ad42013-03-27 23:53:50 +0100553 Text editor used by `git rebase -i` for editing the rebase instruction file.
Peter Oberndorfer821881d2011-10-17 22:26:23 +0200554 The value is meant to be interpreted by the shell when it is used.
555 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
556 When not configured the default commit message editor is used instead.
557
Brian Gernhardt54adf372007-07-03 14:18:11 -0400558core.pager::
Junio C Hamano97d01f22013-08-28 13:26:12 -0700559 Text viewer for use by Git commands (e.g., 'less'). The value
560 is meant to be interpreted by the shell. The order of preference
561 is the `$GIT_PAGER` environment variable, then `core.pager`
562 configuration, then `$PAGER`, and then the default chosen at
563 compile time (usually 'less').
564+
Matthieu Moyb3275832014-04-30 09:35:25 +0200565When the `LESS` environment variable is unset, Git sets it to `FRX`
Junio C Hamano97d01f22013-08-28 13:26:12 -0700566(if `LESS` environment variable is set, Git does not change it at
567all). If you want to selectively override Git's default setting
Matthieu Moyb3275832014-04-30 09:35:25 +0200568for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
Junio C Hamano97d01f22013-08-28 13:26:12 -0700569be passed to the shell by Git, which will translate the final
Matthieu Moyb3275832014-04-30 09:35:25 +0200570command to `LESS=FRX less -S`. The environment does not set the
571`S` option but the command line does, instructing less to truncate
572long lines. Similarly, setting `core.pager` to `less -+F` will
573deactivate the `F` option specified by the environment from the
574command-line, deactivating the "quit if one screen" behavior of
575`less`. One can specifically activate some flags for particular
576commands: for example, setting `pager.blame` to `less -S` enables
577line truncation only for `git blame`.
Jonathan Niedere54c1f22014-01-06 18:14:05 -0800578+
579Likewise, when the `LV` environment variable is unset, Git sets it
580to `-c`. You can override this setting by exporting `LV` with
581another value or setting `core.pager` to `lv +c`.
Brian Gernhardt54adf372007-07-03 14:18:11 -0400582
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800583core.whitespace::
584 A comma separated list of common whitespace problems to
Thomas Rast0b444cd2010-01-10 00:33:00 +0100585 notice. 'git diff' will use `color.diff.whitespace` to
586 highlight them, and 'git apply --whitespace=error' will
Junio C Hamanoc921cc92008-07-25 00:34:47 -0700587 consider them as errors. You can prefix `-` to disable
588 any of them (e.g. `-trailing-space`):
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800589+
Junio C Hamanoaeb84b02009-09-05 22:21:17 -0700590* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800591 as an error (enabled by default).
592* `space-before-tab` treats a space character that appears immediately
593 before a tab character in the initial indent part of the line as an
594 error (enabled by default).
Wesley J. Landaker2ce4fee2012-09-17 08:22:15 -0600595* `indent-with-non-tab` treats a line that is indented with space
596 characters instead of the equivalent tabs as an error (not enabled by
597 default).
Chris Webb3e3ec2a2010-04-03 00:37:08 +0100598* `tab-in-indent` treats a tab character in the initial indent part of
599 the line as an error (not enabled by default).
Junio C Hamano77b15bb2009-09-03 16:02:32 -0700600* `blank-at-eof` treats blank lines added at the end of file as an error
601 (enabled by default).
Junio C Hamanoaeb84b02009-09-05 22:21:17 -0700602* `trailing-space` is a short-hand to cover both `blank-at-eol` and
603 `blank-at-eof`.
Junio C Hamanob2979ff2008-01-15 00:59:05 -0800604* `cr-at-eol` treats a carriage-return at the end of line as
605 part of the line terminator, i.e. with it, `trailing-space`
606 does not trigger if the character before such a carriage-return
607 is not a whitespace (not enabled by default).
Johannes Sixtf4b05a42010-11-30 09:29:11 +0100608* `tabwidth=<n>` tells how many character positions a tab occupies; this
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100609 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
Johannes Sixtf4b05a42010-11-30 09:29:11 +0100610 errors. The default tab width is 8. Allowed values are 1 to 63.
Junio C Hamano91af7ae2007-11-24 11:57:41 -0800611
Linus Torvaldsaafe9fb2008-06-18 15:18:44 -0700612core.fsyncobjectfiles::
613 This boolean will enable 'fsync()' when writing object files.
614+
615This is a total waste of time and effort on a filesystem that orders
616data writes properly, but can be useful for filesystems that do not use
617journalling (traditional UNIX filesystems) or that only journal metadata
618and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
619
Linus Torvalds671c9b72008-11-13 16:36:30 -0800620core.preloadindex::
621 Enable parallel index preload for operations like 'git diff'
622+
623This can speed up operations like 'git diff' and 'git status' especially
624on filesystems like NFS that have weak caching semantics and thus
Steve Hoelzer299e2982014-06-02 11:43:00 -0500625relatively high IO latencies. When enabled, Git will do the
Linus Torvalds671c9b72008-11-13 16:36:30 -0800626index comparison to the filesystem data in parallel, allowing
Steve Hoelzer299e2982014-06-02 11:43:00 -0500627overlapping IO's. Defaults to true.
Linus Torvalds671c9b72008-11-13 16:36:30 -0800628
Johannes Schindelin348df162009-04-28 00:32:25 +0200629core.createObject::
630 You can set this to 'link', in which case a hardlink followed by
631 a delete of the source are used to make sure that object creation
632 will not overwrite existing objects.
633+
634On some file system/operating system combinations, this is unreliable.
635Set this config setting to 'rename' there; However, This will remove the
636check that makes sure that existing object files will not get overwritten.
Johannes Schindelinbe66a6c2009-04-25 11:57:14 +0200637
Johannes Schindelina97a7462009-10-09 12:21:57 +0200638core.notesRef::
639 When showing commit messages, also show notes which are stored in
Jonathan Nieder9eb3f812010-05-08 22:19:35 -0500640 the given ref. The ref must be fully qualified. If the given
641 ref does not exist, it is not an error but means that no
642 notes should be printed.
Johannes Schindelina97a7462009-10-09 12:21:57 +0200643+
Jonathan Nieder9eb3f812010-05-08 22:19:35 -0500644This setting defaults to "refs/notes/commits", and it can be overridden by
645the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
Johannes Schindelina97a7462009-10-09 12:21:57 +0200646
Nguyễn Thái Ngọc Duy08aefc92009-08-20 20:47:08 +0700647core.sparseCheckout::
648 Enable "sparse checkout" feature. See section "Sparse checkout" in
649 linkgit:git-read-tree[1] for more information.
650
Junio C Hamanoa71f09f2011-03-20 22:26:24 -0700651core.abbrev::
Linus Torvaldsdce96482010-10-28 11:28:04 -0700652 Set the length object names are abbreviated to. If unspecified,
653 many commands abbreviate to 7 hexdigits, which may not be enough
654 for abbreviated object names to stay unique for sufficiently long
655 time.
656
Stephen Boyd13bd2132009-05-30 22:08:02 -0700657add.ignore-errors::
Jonathan Nieder6b3020a2010-12-01 12:36:15 -0600658add.ignoreErrors::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100659 Tells 'git add' to continue adding files when some files cannot be
Stephen Boyd13bd2132009-05-30 22:08:02 -0700660 added due to indexing errors. Equivalent to the '--ignore-errors'
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100661 option of linkgit:git-add[1]. Older versions of Git accept only
Jonathan Nieder6b3020a2010-12-01 12:36:15 -0600662 `add.ignore-errors`, which does not follow the usual naming
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100663 convention for configuration variables. Newer versions of Git
Jonathan Nieder6b3020a2010-12-01 12:36:15 -0600664 honor `add.ignoreErrors` as well.
Stephen Boyd13bd2132009-05-30 22:08:02 -0700665
Petr Baudis4514ad42006-06-07 20:43:50 +0200666alias.*::
Dan McGee5162e692007-12-29 00:20:38 -0600667 Command aliases for the linkgit:git[1] command wrapper - e.g.
Petr Baudis4514ad42006-06-07 20:43:50 +0200668 after defining "alias.last = cat-file commit HEAD", the invocation
669 "git last" is equivalent to "git cat-file commit HEAD". To avoid
Petr Baudis99b41c82006-06-07 17:25:21 -0700670 confusion and troubles with script usage, aliases that
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100671 hide existing Git commands are ignored. Arguments are split by
Petr Baudis99b41c82006-06-07 17:25:21 -0700672 spaces, the usual shell quoting and escaping is supported.
673 quote pair and a backslash can be used to quote them.
Junio C Hamanof368f5a2007-09-01 04:01:54 -0700674+
675If the alias expansion is prefixed with an exclamation point,
676it will be treated as a shell command. For example, defining
677"alias.new = !gitk --all --not ORIG_HEAD", the invocation
678"git new" is equivalent to running the shell command
Sitaram Chamarty595b8db2009-07-01 21:30:31 +0530679"gitk --all --not ORIG_HEAD". Note that shell commands will be
680executed from the top-level directory of a repository, which may
681not necessarily be the current directory.
Michael J Gruber7cf16a12011-04-27 10:36:27 +0200682'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
683from the original current directory. See linkgit:git-rev-parse[1].
Theodore Ts'odfd42a32007-02-10 19:33:58 -0500684
Stefan-W. Hahne80d4cb2010-02-27 15:20:27 +0100685am.keepcr::
686 If true, git-am will call git-mailsplit for patches in mbox format
687 with parameter '--keep-cr'. In this case git-mailsplit will
Ville Skyttä6b677a22010-07-20 00:17:17 +0300688 not remove `\r` from lines ending with `\r\n`. Can be overridden
Stefan-W. Hahne80d4cb2010-02-27 15:20:27 +0100689 by giving '--no-keep-cr' from the command line.
690 See linkgit:git-am[1], linkgit:git-mailsplit[1].
691
Giuseppe Bilotta86c91f92009-08-04 13:16:49 +0200692apply.ignorewhitespace::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100693 When set to 'change', tells 'git apply' to ignore changes in
Giuseppe Bilotta86c91f92009-08-04 13:16:49 +0200694 whitespace, in the same way as the '--ignore-space-change'
695 option.
Thomas Rast0b444cd2010-01-10 00:33:00 +0100696 When set to one of: no, none, never, false tells 'git apply' to
Giuseppe Bilotta86c91f92009-08-04 13:16:49 +0200697 respect all whitespace differences.
698 See linkgit:git-apply[1].
699
Petr Baudis1ab661d2006-04-25 00:59:33 +0200700apply.whitespace::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100701 Tells 'git apply' how to handle whitespaces, in the same way
Dan McGee5162e692007-12-29 00:20:38 -0600702 as the '--whitespace' option. See linkgit:git-apply[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +0200703
Paolo Bonzini99023872007-05-23 07:07:54 +0200704branch.autosetupmerge::
Junio C Hamanoadd09512010-01-20 20:28:49 -0800705 Tells 'git branch' and 'git checkout' to set up new branches
Jay Soffian572fc812008-02-19 11:24:38 -0500706 so that linkgit:git-pull[1] will appropriately merge from the
707 starting point branch. Note that even if this option is not set,
Paolo Bonzini99023872007-05-23 07:07:54 +0200708 this behavior can be chosen per-branch using the `--track`
Jay Soffian572fc812008-02-19 11:24:38 -0500709 and `--no-track` options. The valid settings are: `false` -- no
710 automatic setup is done; `true` -- automatic setup is done when the
Matthieu Moy29b9a662010-11-02 16:31:24 +0100711 starting point is a remote-tracking branch; `always` --
712 automatic setup is done when the starting point is either a
713 local branch or remote-tracking
Jay Soffian572fc812008-02-19 11:24:38 -0500714 branch. This option defaults to true.
Paolo Bonzini99023872007-05-23 07:07:54 +0200715
Dustin Sallingsc998ae92008-05-10 15:36:29 -0700716branch.autosetuprebase::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100717 When a new branch is created with 'git branch' or 'git checkout'
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100718 that tracks another branch, this variable tells Git to set
Dustin Sallingsc998ae92008-05-10 15:36:29 -0700719 up pull to rebase instead of merge (see "branch.<name>.rebase").
720 When `never`, rebase is never automatically set to true.
721 When `local`, rebase is set to true for tracked branches of
722 other local branches.
723 When `remote`, rebase is set to true for tracked branches of
Matthieu Moy29b9a662010-11-02 16:31:24 +0100724 remote-tracking branches.
Dustin Sallingsc998ae92008-05-10 15:36:29 -0700725 When `always`, rebase will be set to true for all tracking
726 branches.
727 See "branch.autosetupmerge" for details on how to set up a
728 branch to track another branch.
729 This option defaults to never.
730
Santi Béjar648ad182006-09-23 12:05:43 +0200731branch.<name>.remote::
Ramkumar Ramachandra224c2172013-04-02 13:10:33 +0530732 When on branch <name>, it tells 'git fetch' and 'git push'
733 which remote to fetch from/push to. The remote to push to
734 may be overridden with `remote.pushdefault` (for all branches).
Ramkumar Ramachandra9f765ce2013-04-02 13:10:34 +0530735 The remote to push to, for the current branch, may be further
736 overridden by `branch.<name>.pushremote`. If no remote is
737 configured, or if you are not on any branch, it defaults to
738 `origin` for fetching and `remote.pushdefault` for pushing.
Philip Oakleyb85ecea2013-09-13 22:23:16 +0100739 Additionally, `.` (a period) is the current local repository
740 (a dot-repository), see `branch.<name>.merge`'s final note below.
Ramkumar Ramachandra9f765ce2013-04-02 13:10:34 +0530741
742branch.<name>.pushremote::
743 When on branch <name>, it overrides `branch.<name>.remote` for
744 pushing. It also overrides `remote.pushdefault` for pushing
745 from branch <name>. When you pull from one place (e.g. your
746 upstream) and push to another place (e.g. your own publishing
747 repository), you would want to set `remote.pushdefault` to
748 specify the remote to push to for all branches, and use this
749 option to override it for a specific branch.
Santi Béjar648ad182006-09-23 12:05:43 +0200750
Santi Béjar53728062006-09-23 22:53:04 +0200751branch.<name>.merge::
Santi Béjar76d3cc52009-03-30 12:11:40 +0200752 Defines, together with branch.<name>.remote, the upstream branch
Martin von Zweigbergk15a147e2011-02-09 20:54:02 -0500753 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
Thomas Rast0b444cd2010-01-10 00:33:00 +0100754 branch to merge and can also affect 'git push' (see push.default).
755 When in branch <name>, it tells 'git fetch' the default
Daniel Barkalowb888d612007-09-10 23:03:25 -0400756 refspec to be marked for merging in FETCH_HEAD. The value is
757 handled like the remote part of a refspec, and must match a
758 ref which is fetched from the remote given by
759 "branch.<name>.remote".
Thomas Rast0b444cd2010-01-10 00:33:00 +0100760 The merge information is used by 'git pull' (which at first calls
761 'git fetch') to lookup the default branch for merging. Without
762 this option, 'git pull' defaults to merge the first refspec fetched.
Josef Weidendorfer62b339a2006-12-09 02:28:26 +0100763 Specify multiple values to get an octopus merge.
Thomas Rast0b444cd2010-01-10 00:33:00 +0100764 If you wish to setup 'git pull' so that it merges into <name> from
Paolo Bonzini9debc322007-03-15 09:23:20 +0100765 another branch in the local repository, you can point
Philip Oakleyb85ecea2013-09-13 22:23:16 +0100766 branch.<name>.merge to the desired branch, and use the relative path
767 setting `.` (a period) for branch.<name>.remote.
Santi Béjar53728062006-09-23 22:53:04 +0200768
Lars Hjemliaec7b362007-09-24 00:51:43 +0200769branch.<name>.mergeoptions::
770 Sets default options for merging into branch <name>. The syntax and
Jonathan Nieder25dcc0d2009-10-09 13:51:14 -0500771 supported options are the same as those of linkgit:git-merge[1], but
Lars Hjemliaec7b362007-09-24 00:51:43 +0200772 option values containing whitespace characters are currently not
773 supported.
774
Johannes Schindelincd67e4d2007-11-28 13:11:07 +0000775branch.<name>.rebase::
776 When true, rebase the branch <name> on top of the fetched branch,
Dustin Sallings15ddb6f2008-05-08 11:28:07 -0700777 instead of merging the default branch from the default remote when
Ævar Arnfjörð Bjarmason6b37dff2011-11-06 10:50:10 +0100778 "git pull" is run. See "pull.rebase" for doing this in a non
779 branch-specific manner.
780+
Stephen Haberman66713ef2013-08-12 22:43:42 -0500781 When preserve, also pass `--preserve-merges` along to 'git rebase'
782 so that locally committed merge commits will not be flattened
783 by running 'git pull'.
784+
Ævar Arnfjörð Bjarmason6b37dff2011-11-06 10:50:10 +0100785*NOTE*: this is a possibly dangerous operation; do *not* use
786it unless you understand the implications (see linkgit:git-rebase[1]
787for details).
Johannes Schindelincd67e4d2007-11-28 13:11:07 +0000788
Nguyễn Thái Ngọc Duya5ba2cb2013-01-01 16:30:53 +0700789branch.<name>.description::
790 Branch description, can be edited with
791 `git branch --edit-description`. Branch description is
792 automatically added in the format-patch cover letter or
793 request-pull summary.
794
Christian Couder1658c612008-03-14 05:56:53 +0100795browser.<tool>.cmd::
796 Specify the command to invoke the specified browser. The
797 specified command is evaluated in shell with the URLs passed
Jonathan Nieder565e1352011-06-29 00:35:10 -0500798 as arguments. (See linkgit:git-web{litdd}browse[1].)
Christian Couder1658c612008-03-14 05:56:53 +0100799
Christian Couder584627b2008-01-29 07:08:22 +0100800browser.<tool>.path::
801 Override the path for the given tool that may be used to
Christian Couderab989ad2008-01-29 07:08:44 +0100802 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
803 working repository in gitweb (see linkgit:git-instaweb[1]).
Christian Couder584627b2008-01-29 07:08:22 +0100804
Josh Triplett21225912007-04-23 17:18:16 -0700805clean.requireForce::
Jiang Xinf85f7942013-08-28 09:28:32 +0800806 A boolean to make git-clean do nothing unless given -f,
807 -i or -n. Defaults to true.
Josh Triplett21225912007-04-23 17:18:16 -0700808
Brian Gernhardtf3673982007-01-03 10:36:29 -0500809color.branch::
810 A boolean to enable/disable color in the output of
Dan McGee5162e692007-12-29 00:20:38 -0600811 linkgit:git-branch[1]. May be set to `always`,
Junio C Hamanocec99d82007-12-05 17:05:17 -0800812 `false` (or `never`) or `auto` (or `true`), in which case colors are used
Brian Gernhardtf3673982007-01-03 10:36:29 -0500813 only when the output is to a terminal. Defaults to false.
814
815color.branch.<slot>::
816 Use customized color for branch coloration. `<slot>` is one of
817 `current` (the current branch), `local` (a local branch),
Felipe Contrerasdbda21f2013-04-14 21:37:49 -0500818 `remote` (a remote-tracking branch in refs/remotes/),
819 `upstream` (upstream tracking branch), `plain` (other
Mark Wooding4f193f22007-01-28 15:17:36 +0000820 refs).
821+
822The value for these configuration variables is a list of colors (at most
823two) and attributes (at most one), separated by spaces. The colors
824accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
825`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
826`blink` and `reverse`. The first color given is the foreground; the
827second is the background. The position of the attribute, if any,
828doesn't matter.
Brian Gernhardtf3673982007-01-03 10:36:29 -0500829
Andy Parkinsa159ca02006-12-13 09:13:28 +0000830color.diff::
Michael J Gruber6999c542011-04-27 09:38:27 +0200831 Whether to use ANSI escape sequences to add color to patches.
832 If this is set to `always`, linkgit:git-diff[1],
833 linkgit:git-log[1], and linkgit:git-show[1] will use color
834 for all patches. If it is set to `true` or `auto`, those
835 commands will only use color when output is to the terminal.
836 Defaults to false.
837+
Justin Lebara58088a2014-03-31 15:11:44 -0700838This does not affect linkgit:git-format-patch[1] or the
Michael J Gruber6999c542011-04-27 09:38:27 +0200839'git-diff-{asterisk}' plumbing commands. Can be overridden on the
840command line with the `--color[=<when>]` option.
Junio C Hamanob5376642006-07-07 05:28:05 -0700841
Andy Parkinsa159ca02006-12-13 09:13:28 +0000842color.diff.<slot>::
Mark Wooding4f193f22007-01-28 15:17:36 +0000843 Use customized color for diff colorization. `<slot>` specifies
844 which part of the patch to use the specified color, and is one
845 of `plain` (context text), `meta` (metainformation), `frag`
Bert Wesarg89cb73a2009-11-27 07:55:18 +0100846 (hunk header), 'func' (function in hunk header), `old` (removed lines),
847 `new` (added lines), `commit` (commit headers), or `whitespace`
848 (highlighting whitespace errors). The values of these variables may be
849 specified as in color.branch.<slot>.
Junio C Hamanob5376642006-07-07 05:28:05 -0700850
Nazri Ramliy5e11bee2010-06-24 08:21:16 +0800851color.decorate.<slot>::
852 Use customized color for 'git log --decorate' output. `<slot>` is one
853 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
Matthieu Moy0e615b22010-11-02 16:31:20 +0100854 branches, remote-tracking branches, tags, stash and HEAD, respectively.
Nazri Ramliy5e11bee2010-06-24 08:21:16 +0800855
René Scharfe7e8f59d2009-03-07 13:32:32 +0100856color.grep::
857 When set to `always`, always highlight matches. When `false` (or
858 `never`), never. When set to `true` or `auto`, use color only
859 when the output is written to the terminal. Defaults to `false`.
860
Mark Lodato55f638b2010-03-07 11:52:46 -0500861color.grep.<slot>::
862 Use customized color for grep colorization. `<slot>` specifies which
863 part of the line to use the specified color, and is one of
864+
865--
Mark Lodato00588bb2010-03-07 11:52:47 -0500866`context`;;
867 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
Mark Lodato55f638b2010-03-07 11:52:46 -0500868`filename`;;
869 filename prefix (when not using `-h`)
Mark Lodato00588bb2010-03-07 11:52:47 -0500870`function`;;
871 function name lines (when using `-p`)
Mark Lodato55f638b2010-03-07 11:52:46 -0500872`linenumber`;;
873 line number prefix (when using `-n`)
874`match`;;
875 matching text
Mark Lodato00588bb2010-03-07 11:52:47 -0500876`selected`;;
877 non-matching text in selected lines
Mark Lodato55f638b2010-03-07 11:52:46 -0500878`separator`;;
879 separators between fields on a line (`:`, `-`, and `=`)
880 and between hunks (`--`)
881--
882+
883The values of these variables may be specified as in color.branch.<slot>.
René Scharfe7e8f59d2009-03-07 13:32:32 +0100884
Junio C Hamanob4c61ed2007-12-05 00:50:23 -0800885color.interactive::
Jeff King47ee06f2008-01-05 04:57:44 -0500886 When set to `always`, always use colors for interactive prompts
Jiang Xin7a9b0b82013-06-25 23:53:50 +0800887 and displays (such as those used by "git-add --interactive" and
888 "git-clean --interactive"). When false (or `never`), never.
889 When set to `true` or `auto`, use colors only when the output is
890 to the terminal. Defaults to false.
Junio C Hamanob4c61ed2007-12-05 00:50:23 -0800891
892color.interactive.<slot>::
Jiang Xin7a9b0b82013-06-25 23:53:50 +0800893 Use customized color for 'git add --interactive' and 'git clean
894 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
895 or `error`, for four distinct types of normal output from
896 interactive commands. The values of these variables may be
897 specified as in color.branch.<slot>.
Junio C Hamanob4c61ed2007-12-05 00:50:23 -0800898
Junio C Hamano1d770432006-12-13 12:11:03 -0800899color.pager::
900 A boolean to enable/disable colored output when the pager is in
901 use (default is true).
902
Markus Heidelbergab07ba22009-04-22 23:41:25 +0200903color.showbranch::
904 A boolean to enable/disable color in the output of
905 linkgit:git-show-branch[1]. May be set to `always`,
906 `false` (or `never`) or `auto` (or `true`), in which case colors are used
907 only when the output is to a terminal. Defaults to false.
908
Junio C Hamano1d770432006-12-13 12:11:03 -0800909color.status::
910 A boolean to enable/disable color in the output of
Dan McGee5162e692007-12-29 00:20:38 -0600911 linkgit:git-status[1]. May be set to `always`,
Junio C Hamanocec99d82007-12-05 17:05:17 -0800912 `false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamano1d770432006-12-13 12:11:03 -0800913 only when the output is to a terminal. Defaults to false.
914
915color.status.<slot>::
916 Use customized color for status colorization. `<slot>` is
917 one of `header` (the header text of the status message),
Shawn O. Pearce82dca842006-12-15 21:53:13 -0500918 `added` or `updated` (files which are added but not committed),
919 `changed` (files which are changed but not added in the index),
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100920 `untracked` (files which are not tracked by Git),
Aleksi Aalto1d282322010-11-18 01:40:05 +0200921 `branch` (the current branch), or
Chris Parsons950ce2e2008-05-22 08:50:02 -0400922 `nobranch` (the color the 'no branch' warning is shown in, defaulting
923 to red). The values of these variables may be specified as in
924 color.branch.<slot>.
Junio C Hamano1d770432006-12-13 12:11:03 -0800925
Matthias Kestenholz6b2f2d92008-02-18 08:26:03 +0100926color.ui::
Michael J Gruber6999c542011-04-27 09:38:27 +0200927 This variable determines the default value for variables such
928 as `color.diff` and `color.grep` that control the use of color
929 per command family. Its scope will expand as more commands learn
930 configuration to set a default for the `--color` option. Set it
Matthieu Moy4c7f1812013-06-10 16:26:09 +0200931 to `false` or `never` if you prefer Git commands not to use
932 color unless enabled explicitly with some other configuration
933 or the `--color` option. Set it to `always` if you want all
934 output not intended for machine consumption to use color, to
935 `true` or `auto` (this is the default since Git 1.8.4) if you
936 want such output to use color when written to the terminal.
Matthias Kestenholz6b2f2d92008-02-18 08:26:03 +0100937
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700938column.ui::
939 Specify whether supported commands should output in columns.
940 This variable consists of a list of tokens separated by spaces
941 or commas:
942+
Ramkumar Ramachandra5e62cc12013-06-25 21:24:36 +0530943These options control when the feature should be enabled
944(defaults to 'never'):
945+
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700946--
947`always`;;
948 always show in columns
949`never`;;
950 never show in columns
951`auto`;;
952 show in columns if the output is to the terminal
Ramkumar Ramachandra5e62cc12013-06-25 21:24:36 +0530953--
954+
955These options control layout (defaults to 'column'). Setting any
956of these implies 'always' if none of 'always', 'never', or 'auto' are
957specified.
958+
959--
Nguyễn Thái Ngọc Duy077539d2012-04-13 17:54:35 +0700960`column`;;
Ramkumar Ramachandra5e62cc12013-06-25 21:24:36 +0530961 fill columns before rows
Nguyễn Thái Ngọc Duy077539d2012-04-13 17:54:35 +0700962`row`;;
963 fill rows before columns
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700964`plain`;;
965 show in one column
Ramkumar Ramachandra5e62cc12013-06-25 21:24:36 +0530966--
967+
968Finally, these options can be combined with a layout option (defaults
969to 'nodense'):
970+
971--
Nguyễn Thái Ngọc Duy3f8eccb2012-04-13 17:54:36 +0700972`dense`;;
973 make unequal size columns to utilize more space
974`nodense`;;
975 make equal size columns
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700976--
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700977
Nguyễn Thái Ngọc Duyebe31ef2012-04-13 17:54:38 +0700978column.branch::
979 Specify whether to output branch listing in `git branch` in columns.
980 See `column.ui` for details.
981
Jiang Xin1b8fd462013-06-25 23:53:49 +0800982column.clean::
983 Specify the layout when list items in `git clean -i`, which always
984 shows files and directories in columns. See `column.ui` for details.
985
Nguyễn Thái Ngọc Duy323d0532012-04-13 17:54:39 +0700986column.status::
987 Specify whether to output untracked files in `git status` in columns.
988 See `column.ui` for details.
989
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +0700990column.tag::
991 Specify whether to output tag listing in `git tag` in columns.
992 See `column.ui` for details.
993
Ralf Thielow51fb3a32013-01-10 18:45:59 +0100994commit.cleanup::
995 This setting overrides the default of the `--cleanup` option in
996 `git commit`. See linkgit:git-commit[1] for details. Changing the
997 default can be useful when you always want to keep lines that begin
998 with comment character `#` in your log message, in which case you
999 would do `git config commit.cleanup whitespace` (note that you will
1000 have to remove the help lines that begin with `#` in the commit log
1001 template yourself, if you do this).
1002
Nicolas Vigierd95bfb12013-11-05 00:14:41 +01001003commit.gpgsign::
1004
1005 A boolean to specify whether all commits should be GPG signed.
1006 Use of this option when doing operations such as rebase can
1007 result in a large number of commits being signed. It may be
1008 convenient to use an agent to avoid typing your GPG passphrase
1009 several times.
1010
Thomas Rast88955ed2010-01-23 23:13:17 +01001011commit.status::
James P. Howard, IIbed575e2009-12-07 17:45:27 -05001012 A boolean to enable/disable inclusion of status information in the
1013 commit message template when using an editor to prepare the commit
1014 message. Defaults to true.
1015
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001016commit.template::
1017 Specify a file to use as the template for new commit messages.
Jeff King6cf378f2012-04-26 04:51:57 -04001018 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
Matthieu Moydf2a79f2009-11-19 16:21:15 +01001019 specified user's home directory.
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001020
Jeff Kinga6fc9fd2011-12-10 05:31:38 -05001021credential.helper::
1022 Specify an external helper to be called when a username or
1023 password credential is needed; the helper may consult external
1024 storage to avoid prompting the user for the credentials. See
1025 linkgit:gitcredentials[7] for details.
1026
1027credential.useHttpPath::
1028 When acquiring credentials, consider the "path" component of an http
1029 or https URL to be important. Defaults to false. See
1030 linkgit:gitcredentials[7] for more information.
1031
1032credential.username::
1033 If no username is set for a network authentication, use this username
1034 by default. See credential.<context>.* below, and
1035 linkgit:gitcredentials[7].
1036
1037credential.<url>.*::
1038 Any of the credential.* options above can be applied selectively to
1039 some credentials. For example "credential.https://example.com.username"
1040 would set the default username only for https connections to
1041 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1042 matched.
1043
Ramkumar Ramachandra19299a82011-04-07 00:16:49 +05301044include::diff-config.txt[]
David Aguilarafcbc8e2009-04-07 01:21:20 -07001045
1046difftool.<tool>.path::
1047 Override the path for the given tool. This is useful in case
1048 your tool is not in the PATH.
1049
1050difftool.<tool>.cmd::
1051 Specify the command to invoke the specified diff tool.
1052 The specified command is evaluated in shell with the following
1053 variables available: 'LOCAL' is set to the name of the temporary
1054 file containing the contents of the diff pre-image and 'REMOTE'
1055 is set to the name of the temporary file containing the contents
1056 of the diff post-image.
1057
David Aguilara9043922009-04-07 01:21:22 -07001058difftool.prompt::
1059 Prompt before each invocation of the diff tool.
1060
Jens Lehmannbe254a02010-11-11 00:55:02 +01001061fetch.recurseSubmodules::
Jens Lehmann1fb25502011-03-06 23:11:48 +01001062 This option can be either set to a boolean value or to 'on-demand'.
1063 Setting it to a boolean changes the behavior of fetch and pull to
1064 unconditionally recurse into submodules when set to true or to not
1065 recurse at all when set to false. When set to 'on-demand' (the default
1066 value), fetch and pull will only recurse into a populated submodule
1067 when its superproject retrieves a commit that updates the submodule's
1068 reference.
Jens Lehmannbe254a02010-11-11 00:55:02 +01001069
Junio C Hamano5e838ea2011-09-04 12:26:14 -07001070fetch.fsckObjects::
1071 If it is set to true, git-fetch-pack will check all fetched
1072 objects. It will abort in the case of a malformed object or a
1073 broken link. The result of an abort are only dangling objects.
Junio C Hamanodab76d32011-09-04 12:37:45 -07001074 Defaults to false. If not set, the value of `transfer.fsckObjects`
1075 is used instead.
Junio C Hamano5e838ea2011-09-04 12:26:14 -07001076
Junio C Hamanoaf7cf262007-01-24 16:47:24 -08001077fetch.unpackLimit::
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001078 If the number of objects fetched over the Git native
Junio C Hamanoaf7cf262007-01-24 16:47:24 -08001079 transfer is below this
1080 limit, then the objects will be unpacked into loose object
1081 files. However if the number of received objects equals or
1082 exceeds this limit then the received pack will be stored as
1083 a pack, after adding any missing delta bases. Storing the
1084 pack from a push can make the push operation complete faster,
Michele Ballabio80cd9cf2008-01-11 22:11:13 +01001085 especially on slow filesystems. If not set, the value of
1086 `transfer.unpackLimit` is used instead.
Junio C Hamanoaf7cf262007-01-24 16:47:24 -08001087
Michael Schubert737c5a92013-07-13 11:36:24 +02001088fetch.prune::
1089 If true, fetch will automatically behave as if the `--prune`
1090 option was given on the command line. See also `remote.<name>.prune`.
1091
Stephen Boyd48d34482009-04-23 02:37:56 -07001092format.attach::
1093 Enable multipart/mixed attachments as the default for
1094 'format-patch'. The value can also be a double quoted string
1095 which will enable attachments as the default and set the
1096 value as the boundary. See the --attach option in
1097 linkgit:git-format-patch[1].
1098
Brian Gernhardt49604a42007-11-03 23:38:24 -04001099format.numbered::
Brian Gernhardta567fdc2008-10-02 16:55:39 -04001100 A boolean which can enable or disable sequence numbers in patch
1101 subjects. It defaults to "auto" which enables it only if there
1102 is more than one patch. It can be enabled or disabled for all
1103 messages by setting it to "true" or "false". See --numbered
1104 option in linkgit:git-format-patch[1].
Brian Gernhardt49604a42007-11-03 23:38:24 -04001105
Petr Baudis1ab661d2006-04-25 00:59:33 +02001106format.headers::
1107 Additional email headers to include in a patch to be submitted
Dan McGee5162e692007-12-29 00:20:38 -06001108 by mail. See linkgit:git-format-patch[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02001109
Miklos Vajna312a30e2010-07-12 20:58:38 +02001110format.to::
Stephen Boyd48d34482009-04-23 02:37:56 -07001111format.cc::
Miklos Vajna312a30e2010-07-12 20:58:38 +02001112 Additional recipients to include in a patch to be submitted
1113 by mail. See the --to and --cc options in
1114 linkgit:git-format-patch[1].
Stephen Boyd48d34482009-04-23 02:37:56 -07001115
1116format.subjectprefix::
1117 The default for format-patch is to output files with the '[PATCH]'
1118 subject prefix. Use this variable to change that prefix.
1119
Stephen Boyd6622d9c2010-06-15 22:59:25 -07001120format.signature::
1121 The default for format-patch is to output a signature containing
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001122 the Git version number. Use this variable to change that default.
Stephen Boyd6622d9c2010-06-15 22:59:25 -07001123 Set this variable to the empty string ("") to suppress
1124 signature generation.
1125
Jeremiah Mahler70226502014-05-23 21:08:14 -07001126format.signaturefile::
1127 Works just like format.signature except the contents of the
1128 file specified by this variable will be used as the signature.
1129
Johannes Schindelin78cb59c2007-03-04 00:17:23 +01001130format.suffix::
1131 The default for format-patch is to output files with the suffix
1132 `.patch`. Use this variable to change that suffix (make sure to
1133 include the dot if you want it).
1134
Denis Cheng94c22a52008-03-02 17:05:53 +08001135format.pretty::
1136 The default pretty format for log/show/whatchanged command,
1137 See linkgit:git-log[1], linkgit:git-show[1],
1138 linkgit:git-whatchanged[1].
1139
Thomas Rast30984ed2009-02-19 22:26:33 +01001140format.thread::
Thomas Rast0b444cd2010-01-10 00:33:00 +01001141 The default threading style for 'git format-patch'. Can be
Jonathan Nieder578b62b2010-01-09 21:01:21 -06001142 a boolean value, or `shallow` or `deep`. `shallow` threading
1143 makes every mail a reply to the head of the series,
Thomas Rast30984ed2009-02-19 22:26:33 +01001144 where the head is chosen from the cover letter, the
Jeff King6cf378f2012-04-26 04:51:57 -04001145 `--in-reply-to`, and the first patch mail, in this order.
Stephen Boydfd1ff302009-04-23 02:37:57 -07001146 `deep` threading makes every mail a reply to the previous one.
Thomas Rast30984ed2009-02-19 22:26:33 +01001147 A true boolean value is the same as `shallow`, and a false
1148 value disables threading.
1149
Heiko Voigt1d1876e2009-04-01 19:51:54 +02001150format.signoff::
Felipe Contreras240ae2b2013-04-27 17:00:07 -05001151 A boolean value which lets you enable the `-s/--signoff` option of
1152 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1153 patch should be a conscious act and means that you certify you have
1154 the rights to submit this work under the same open source license.
1155 Please see the 'SubmittingPatches' document for further discussion.
Heiko Voigt1d1876e2009-04-01 19:51:54 +02001156
Felipe Contreras2a4c2602013-04-07 12:46:23 -05001157format.coverLetter::
1158 A boolean that controls whether to generate a cover-letter when
1159 format-patch is invoked, but in addition can be set to "auto", to
1160 generate a cover-letter only when there's more than one patch.
1161
Ramkumar Ramachandra26488f52011-04-07 00:16:48 +05301162filter.<driver>.clean::
1163 The command which is used to convert the content of a worktree
1164 file to a blob upon checkin. See linkgit:gitattributes[5] for
1165 details.
1166
1167filter.<driver>.smudge::
1168 The command which is used to convert the content of a blob
1169 object to a worktree file upon checkout. See
1170 linkgit:gitattributes[5] for details.
1171
Nguyễn Thái Ngọc Duy125f8142014-03-16 20:35:03 +07001172gc.aggressiveDepth::
1173 The depth parameter used in the delta compression
1174 algorithm used by 'git gc --aggressive'. This defaults
1175 to 250.
1176
Theodore Tso0d7566a2007-05-09 15:48:39 -04001177gc.aggressiveWindow::
1178 The window size parameter used in the delta compression
Thomas Rast0b444cd2010-01-10 00:33:00 +01001179 algorithm used by 'git gc --aggressive'. This defaults
Jay Soffianf78683f2010-04-13 12:52:55 -04001180 to 250.
Theodore Tso0d7566a2007-05-09 15:48:39 -04001181
Junio C Hamanoe9831e82007-09-17 00:39:52 -07001182gc.auto::
1183 When there are approximately more than this many loose
1184 objects in the repository, `git gc --auto` will pack them.
1185 Some Porcelain commands use this command to perform a
Michele Ballabio80cd9cf2008-01-11 22:11:13 +01001186 light-weight garbage collection from time to time. The
1187 default value is 6700. Setting this to 0 disables it.
Junio C Hamanoe9831e82007-09-17 00:39:52 -07001188
Junio C Hamano17815502007-09-17 00:55:13 -07001189gc.autopacklimit::
1190 When there are more than this many packs that are not
1191 marked with `*.keep` file in the repository, `git gc
Michele Ballabio80cd9cf2008-01-11 22:11:13 +01001192 --auto` consolidates them into one larger pack. The
Junio C Hamano97063972008-03-23 00:04:48 -07001193 default value is 50. Setting this to 0 disables it.
Junio C Hamano17815502007-09-17 00:55:13 -07001194
Nguyễn Thái Ngọc Duy9f673f92014-02-08 14:08:52 +07001195gc.autodetach::
1196 Make `git gc --auto` return immediately andrun in background
1197 if the system supports it. Default is true.
1198
Johannes Schindelinc2120e52007-02-13 14:01:42 +01001199gc.packrefs::
Jonathan Niederefc266e2010-01-09 20:59:41 -06001200 Running `git pack-refs` in a repository renders it
1201 unclonable by Git versions prior to 1.5.1.2 over dumb
1202 transports such as HTTP. This variable determines whether
Jiang Xin4be0c352010-12-16 15:16:49 +08001203 'git gc' runs `git pack-refs`. This can be set to `notbare`
Jonathan Niederefc266e2010-01-09 20:59:41 -06001204 to enable it within all non-bare repos or it can be set to a
1205 boolean value. The default is `true`.
Johannes Schindelinc2120e52007-02-13 14:01:42 +01001206
Johannes Schindelin25ee9732008-03-12 21:55:47 +01001207gc.pruneexpire::
Thomas Rast0b444cd2010-01-10 00:33:00 +01001208 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
Nicolas Pitre8e8daf32008-12-30 14:45:11 -05001209 Override the grace period with this config variable. The value
1210 "now" may be used to disable this grace period and always prune
1211 unreachable objects immediately.
Johannes Schindelin25ee9732008-03-12 21:55:47 +01001212
Junio C Hamano4aec56d2006-12-27 01:47:57 -08001213gc.reflogexpire::
Junio C Hamanoeb523a82010-04-14 13:12:34 -07001214gc.<pattern>.reflogexpire::
Thomas Rast0b444cd2010-01-10 00:33:00 +01001215 'git reflog expire' removes reflog entries older than
Junio C Hamanoeb523a82010-04-14 13:12:34 -07001216 this time; defaults to 90 days. With "<pattern>" (e.g.
1217 "refs/stash") in the middle the setting applies only to
1218 the refs that match the <pattern>.
Junio C Hamano4aec56d2006-12-27 01:47:57 -08001219
1220gc.reflogexpireunreachable::
Junio C Hamanoeb523a82010-04-14 13:12:34 -07001221gc.<ref>.reflogexpireunreachable::
Thomas Rast0b444cd2010-01-10 00:33:00 +01001222 'git reflog expire' removes reflog entries older than
Junio C Hamano4aec56d2006-12-27 01:47:57 -08001223 this time and are not reachable from the current tip;
Junio C Hamanoeb523a82010-04-14 13:12:34 -07001224 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1225 in the middle, the setting applies only to the refs that
1226 match the <pattern>.
Junio C Hamano4aec56d2006-12-27 01:47:57 -08001227
Junio C Hamano48c32422006-12-27 01:24:05 -08001228gc.rerereresolved::
1229 Records of conflicted merge you resolved earlier are
Thomas Rast0b444cd2010-01-10 00:33:00 +01001230 kept for this many days when 'git rerere gc' is run.
Dan McGee5162e692007-12-29 00:20:38 -06001231 The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano48c32422006-12-27 01:24:05 -08001232
1233gc.rerereunresolved::
1234 Records of conflicted merge you have not resolved are
Thomas Rast0b444cd2010-01-10 00:33:00 +01001235 kept for this many days when 'git rerere gc' is run.
Dan McGee5162e692007-12-29 00:20:38 -06001236 The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano48c32422006-12-27 01:24:05 -08001237
Fabian Emmes280514e2009-01-02 16:40:13 +01001238gitcvs.commitmsgannotation::
1239 Append this string to each commit message. Set to empty string
1240 to disable this feature. Defaults to "via git-CVS emulator".
1241
Petr Baudis1ab661d2006-04-25 00:59:33 +02001242gitcvs.enabled::
Brian Hetrodb218722007-08-23 20:40:08 -04001243 Whether the CVS server interface is enabled for this repository.
Dan McGee5162e692007-12-29 00:20:38 -06001244 See linkgit:git-cvsserver[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02001245
1246gitcvs.logfile::
Brian Hetrodb218722007-08-23 20:40:08 -04001247 Path to a log file where the CVS server interface well... logs
Dan McGee5162e692007-12-29 00:20:38 -06001248 various stuff. See linkgit:git-cvsserver[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02001249
Teemu Likonen1707adb2008-08-29 10:29:42 +03001250gitcvs.usecrlfattr::
Eyvind Bernhardsen5ec3e672010-05-19 22:43:11 +02001251 If true, the server will look up the end-of-line conversion
1252 attributes for files to determine the '-k' modes to use. If
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001253 the attributes force Git to treat a file as text,
Ville Skyttä6b677a22010-07-20 00:17:17 +03001254 the '-k' mode will be left blank so CVS clients will
Eyvind Bernhardsen5ec3e672010-05-19 22:43:11 +02001255 treat it as text. If they suppress text conversion, the file
Mike Ralphson1168d402008-08-05 17:12:05 +01001256 will be set with '-kb' mode, which suppresses any newline munging
Eyvind Bernhardsen5ec3e672010-05-19 22:43:11 +02001257 the client might otherwise do. If the attributes do not allow
1258 the file type to be determined, then 'gitcvs.allbinary' is
1259 used. See linkgit:gitattributes[5].
Matthew Ogilvie8a06a632008-05-14 22:35:47 -06001260
Frank Lichtenheldeabb0bf2007-04-13 18:02:30 +02001261gitcvs.allbinary::
Matthew Ogilvie90948a42008-05-14 22:35:48 -06001262 This is used if 'gitcvs.usecrlfattr' does not resolve
1263 the correct '-kb' mode to use. If true, all
1264 unresolved files are sent to the client in
1265 mode '-kb'. This causes the client to treat them
1266 as binary files, which suppresses any newline munging it
1267 otherwise might do. Alternatively, if it is set to "guess",
1268 then the contents of the file are examined to decide if
1269 it is binary, similar to 'core.autocrlf'.
Junio C Hamanoabbf5942007-04-17 22:17:46 -07001270
Frank Lichtenheld04752862007-04-13 18:13:42 +02001271gitcvs.dbname::
1272 Database used by git-cvsserver to cache revision information
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001273 derived from the Git repository. The exact meaning depends on the
Frank Lichtenheld04752862007-04-13 18:13:42 +02001274 used database driver, for SQLite (which is the default driver) this
1275 is a filename. Supports variable substitution (see
Dan McGee5162e692007-12-29 00:20:38 -06001276 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Frank Lichtenheld04752862007-04-13 18:13:42 +02001277 Default: '%Ggitcvs.%m.sqlite'
1278
1279gitcvs.dbdriver::
1280 Used Perl DBI driver. You can specify any available driver
Felipe Contreras240ae2b2013-04-27 17:00:07 -05001281 for this here, but it might not work. git-cvsserver is tested
Frank Lichtenheld04752862007-04-13 18:13:42 +02001282 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1283 reported *not* to work with 'DBD::mysql'. Experimental feature.
1284 May not contain double colons (`:`). Default: 'SQLite'.
Dan McGee5162e692007-12-29 00:20:38 -06001285 See linkgit:git-cvsserver[1].
Frank Lichtenheldeabb0bf2007-04-13 18:02:30 +02001286
Frank Lichtenheld04752862007-04-13 18:13:42 +02001287gitcvs.dbuser, gitcvs.dbpass::
1288 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1289 since SQLite has no concept of database users and/or passwords.
1290 'gitcvs.dbuser' supports variable substitution (see
Dan McGee5162e692007-12-29 00:20:38 -06001291 linkgit:git-cvsserver[1] for details).
Frank Lichtenheld04752862007-04-13 18:13:42 +02001292
Josh Elsasser6aeeffd2008-03-27 14:02:14 -07001293gitcvs.dbTableNamePrefix::
1294 Database table name prefix. Prepended to the names of any
1295 database tables used, allowing a single database to be used
1296 for several repositories. Supports variable substitution (see
1297 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1298 characters will be replaced with underscores.
1299
Matthew Ogilvie8a06a632008-05-14 22:35:47 -06001300All gitcvs variables except for 'gitcvs.usecrlfattr' and
1301'gitcvs.allbinary' can also be specified as
1302'gitcvs.<access_method>.<varname>' (where 'access_method'
Brian Hetro02783072007-08-23 20:44:13 -04001303is one of "ext" and "pserver") to make them apply only for the given
1304access method.
Frank Lichtenheld04752862007-04-13 18:13:42 +02001305
Jakub Narebskicd823232011-10-16 13:07:34 +02001306gitweb.category::
1307gitweb.description::
1308gitweb.owner::
1309gitweb.url::
1310 See linkgit:gitweb[1] for description.
1311
1312gitweb.avatar::
1313gitweb.blame::
1314gitweb.grep::
1315gitweb.highlight::
1316gitweb.patches::
1317gitweb.pickaxe::
1318gitweb.remote_heads::
1319gitweb.showsizes::
1320gitweb.snapshot::
1321 See linkgit:gitweb.conf[5] for description.
1322
Joe Rattermanb22520a2011-03-30 14:31:05 -05001323grep.lineNumber::
1324 If set to true, enable '-n' option by default.
1325
J Smith84befcd2012-08-03 10:53:50 -04001326grep.patternType::
1327 Set the default matching behavior. Using a value of 'basic', 'extended',
1328 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1329 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1330 value 'default' will return to the default matching behavior.
1331
Joe Rattermanb22520a2011-03-30 14:31:05 -05001332grep.extendedRegexp::
J Smith84befcd2012-08-03 10:53:50 -04001333 If set to true, enable '--extended-regexp' option by default. This
1334 option is ignored when the 'grep.patternType' option is set to a value
1335 other than 'default'.
Joe Rattermanb22520a2011-03-30 14:31:05 -05001336
Junio C Hamano0c5e70f2011-11-29 12:29:48 -08001337gpg.program::
1338 Use this custom program instead of "gpg" found on $PATH when
1339 making or verifying a PGP signature. The program must support the
Jason St. John06ab60c2014-05-21 14:52:26 -04001340 same command-line interface as GPG, namely, to verify a detached
Junio C Hamano0c5e70f2011-11-29 12:29:48 -08001341 signature, "gpg --verify $file - <$signature" is run, and the
1342 program is expected to signal a good signature by exiting with
1343 code 0, and to generate an ascii-armored detached signature, the
1344 standard input of "gpg -bsau $key" is fed with the contents to be
1345 signed, and the program is expected to send the result to its
1346 standard output.
1347
Gustaf Hendebyd84ae0d2008-05-08 10:55:02 +02001348gui.commitmsgwidth::
1349 Defines how wide the commit message window is in the
1350 linkgit:git-gui[1]. "75" is the default.
1351
1352gui.diffcontext::
1353 Specifies how many context lines should be used in calls to diff
1354 made by the linkgit:git-gui[1]. The default is "5".
1355
Max Kirillovec9fa622014-04-20 00:47:14 +03001356gui.displayuntracked::
1357 Determines if linkgit::git-gui[1] shows untracked files
1358 in the file list. The default is "true".
1359
Alexander Gavrilova2df1fb2008-11-13 20:28:49 +03001360gui.encoding::
1361 Specifies the default encoding to use for displaying of
1362 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1363 It can be overridden by setting the 'encoding' attribute
1364 for relevant files (see linkgit:gitattributes[5]).
1365 If this option is not set, the tools default to the
1366 locale encoding.
1367
Gustaf Hendebyd84ae0d2008-05-08 10:55:02 +02001368gui.matchtrackingbranch::
1369 Determines if new branches created with linkgit:git-gui[1] should
1370 default to tracking remote branches with matching names or
1371 not. Default: "false".
1372
1373gui.newbranchtemplate::
1374 Is used as suggested name when creating new branches using the
1375 linkgit:git-gui[1].
1376
1377gui.pruneduringfetch::
Matthieu Moy8b3f3f82010-11-02 16:31:23 +01001378 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
Gustaf Hendebyd84ae0d2008-05-08 10:55:02 +02001379 performing a fetch. The default value is "false".
1380
1381gui.trustmtime::
1382 Determines if linkgit:git-gui[1] should trust the file modification
1383 timestamp or not. By default the timestamps are not trusted.
1384
1385gui.spellingdictionary::
1386 Specifies the dictionary used for spell checking commit messages in
1387 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1388 off.
1389
Alexander Gavrilova2df1fb2008-11-13 20:28:49 +03001390gui.fastcopyblame::
Thomas Rastca768282010-01-07 17:49:12 +01001391 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
Alexander Gavrilova2df1fb2008-11-13 20:28:49 +03001392 location detection. It makes blame significantly faster on huge
1393 repositories at the expense of less thorough copy detection.
1394
1395gui.copyblamethreshold::
Ralf Wildenhues76bac892008-11-27 08:32:01 +01001396 Specifies the threshold to use in 'git gui blame' original location
Alexander Gavrilova2df1fb2008-11-13 20:28:49 +03001397 detection, measured in alphanumeric characters. See the
1398 linkgit:git-blame[1] manual for more information on copy detection.
1399
1400gui.blamehistoryctx::
1401 Specifies the radius of history context in days to show in
1402 linkgit:gitk[1] for the selected commit, when the `Show History
1403 Context` menu item is invoked from 'git gui blame'. If this
1404 variable is set to zero, the whole history is shown.
1405
Alexander Gavrilov390c3482008-12-14 22:44:32 +03001406guitool.<name>.cmd::
1407 Specifies the shell command line to execute when the corresponding item
1408 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1409 mandatory for every tool. The command is executed from the root of
1410 the working directory, and in the environment it receives the name of
1411 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1412 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1413 the head is detached, 'CUR_BRANCH' is empty).
1414
1415guitool.<name>.needsfile::
1416 Run the tool only if a diff is selected in the GUI. It guarantees
1417 that 'FILENAME' is not empty.
1418
1419guitool.<name>.noconsole::
1420 Run the command silently, without creating a window to display its
1421 output.
1422
1423guitool.<name>.norescan::
1424 Don't rescan the working directory for changes after the tool
1425 finishes execution.
1426
1427guitool.<name>.confirm::
1428 Show a confirmation dialog before actually running the tool.
1429
1430guitool.<name>.argprompt::
1431 Request a string argument from the user, and pass it to the tool
1432 through the 'ARGS' environment variable. Since requesting an
1433 argument implies confirmation, the 'confirm' option has no effect
1434 if this is enabled. If the option is set to 'true', 'yes', or '1',
1435 the dialog uses a built-in generic prompt; otherwise the exact
1436 value of the variable is used.
1437
1438guitool.<name>.revprompt::
1439 Request a single valid revision from the user, and set the
1440 'REVISION' environment variable. In other aspects this option
1441 is similar to 'argprompt', and can be used together with it.
1442
1443guitool.<name>.revunmerged::
1444 Show only unmerged branches in the 'revprompt' subdialog.
1445 This is useful for tools similar to merge or rebase, but not
1446 for things like checkout or reset.
1447
1448guitool.<name>.title::
1449 Specifies the title to use for the prompt dialog. The default
1450 is the tool name.
1451
1452guitool.<name>.prompt::
1453 Specifies the general prompt string to display at the top of
1454 the dialog, before subsections for 'argprompt' and 'revprompt'.
1455 The default value includes the actual command.
1456
Christian Couder983a9ee2008-01-08 04:55:14 +01001457help.browser::
1458 Specify the browser that will be used to display help in the
1459 'web' format. See linkgit:git-help[1].
1460
1461help.format::
1462 Override the default help format used by linkgit:git-help[1].
1463 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1464 the default. 'web' and 'html' are the same.
1465
Alex Riesenf0e90712008-08-31 15:54:58 +02001466help.autocorrect::
1467 Automatically correct and execute mistyped commands after
1468 waiting for the given number of deciseconds (0.1 sec). If more
1469 than one command can be deduced from the entered text, nothing
1470 will be executed. If the value of this option is negative,
1471 the corrected command will be executed immediately. If the
1472 value is 0 - the command will be just shown but not executed.
1473 This is the default.
1474
Sebastian Staudtb1f809d2013-01-15 21:56:21 +01001475help.htmlpath::
1476 Specify the path where the HTML documentation resides. File system paths
1477 and URLs are supported. HTML pages will be prefixed with this path when
1478 help is displayed in the 'web' format. This defaults to the documentation
1479 path of your Git installation.
1480
Sam Vilain9c5665a2007-11-23 13:07:00 +13001481http.proxy::
Clemens Buchacherb2c8c6d2012-03-04 17:50:43 +01001482 Override the HTTP proxy, normally configured using the 'http_proxy',
1483 'https_proxy', and 'all_proxy' environment variables (see
1484 `curl(1)`). This can be overridden on a per-remote basis; see
1485 remote.<name>.proxy
Sam Vilain9c5665a2007-11-23 13:07:00 +13001486
Duncan Brownbcfb95d2011-06-02 16:31:25 -04001487http.cookiefile::
1488 File containing previously stored cookie lines which should be used
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001489 in the Git http session, if they match the server. The file format
Duncan Brownbcfb95d2011-06-02 16:31:25 -04001490 of the file to read cookies from should be plain HTTP headers or
1491 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1492 NOTE that the file specified with http.cookiefile is only used as
Dave Borowitz912b2ac2013-07-23 15:40:17 -07001493 input unless http.saveCookies is set.
1494
1495http.savecookies::
1496 If set, store cookies received during requests to the file specified by
1497 http.cookiefile. Has no effect if http.cookiefile is unset.
Duncan Brownbcfb95d2011-06-02 16:31:25 -04001498
Petr Baudis1ab661d2006-04-25 00:59:33 +02001499http.sslVerify::
1500 Whether to verify the SSL certificate when fetching or pushing
Francis Daly37425062006-06-07 13:56:45 +01001501 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Petr Baudis1ab661d2006-04-25 00:59:33 +02001502 variable.
1503
1504http.sslCert::
1505 File containing the SSL certificate when fetching or pushing
Francis Daly37425062006-06-07 13:56:45 +01001506 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Petr Baudis1ab661d2006-04-25 00:59:33 +02001507 variable.
1508
1509http.sslKey::
1510 File containing the SSL private key when fetching or pushing
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001511 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Petr Baudis1ab661d2006-04-25 00:59:33 +02001512 variable.
1513
Mark Lodato754ae192009-05-27 23:16:03 -04001514http.sslCertPasswordProtected::
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001515 Enable Git's password prompt for the SSL certificate. Otherwise
Mark Lodato754ae192009-05-27 23:16:03 -04001516 OpenSSL will prompt the user, possibly many times, if the
1517 certificate or private key is encrypted. Can be overridden by the
1518 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1519
Petr Baudis1ab661d2006-04-25 00:59:33 +02001520http.sslCAInfo::
1521 File containing the certificates to verify the peer with when
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001522 fetching or pushing over HTTPS. Can be overridden by the
Petr Baudis1ab661d2006-04-25 00:59:33 +02001523 'GIT_SSL_CAINFO' environment variable.
1524
1525http.sslCAPath::
1526 Path containing files with the CA certificates to verify the peer
Francis Daly37425062006-06-07 13:56:45 +01001527 with when fetching or pushing over HTTPS. Can be overridden
Petr Baudis1ab661d2006-04-25 00:59:33 +02001528 by the 'GIT_SSL_CAPATH' environment variable.
1529
Modestas Vainius4bc444e2013-04-07 22:10:39 +03001530http.sslTry::
1531 Attempt to use AUTH SSL/TLS and encrypted data transfers
1532 when connecting via regular FTP protocol. This might be needed
1533 if the FTP server requires it for security reasons or you wish
1534 to connect securely whenever remote FTP server supports it.
1535 Default is false since it might trigger certificate verification
1536 errors on misconfigured servers.
1537
Petr Baudis1ab661d2006-04-25 00:59:33 +02001538http.maxRequests::
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001539 How many HTTP requests to launch in parallel. Can be overridden
Petr Baudis1ab661d2006-04-25 00:59:33 +02001540 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1541
Tay Ray Chuanad75ebe2009-11-27 23:42:26 +08001542http.minSessions::
1543 The number of curl sessions (counted across slots) to be kept across
1544 requests. They will not be ended with curl_easy_cleanup() until
1545 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1546 value will be capped at 1. Defaults to 1.
1547
Shawn O. Pearcede1a2fd2009-10-30 17:47:41 -07001548http.postBuffer::
1549 Maximum size in bytes of the buffer used by smart HTTP
1550 transports when POSTing data to the remote system.
1551 For requests larger than this buffer size, HTTP/1.1 and
1552 Transfer-Encoding: chunked is used to avoid creating a
1553 massive pack file locally. Default is 1 MiB, which is
1554 sufficient for most requests.
1555
Petr Baudis1ab661d2006-04-25 00:59:33 +02001556http.lowSpeedLimit, http.lowSpeedTime::
1557 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1558 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04001559 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Petr Baudis1ab661d2006-04-25 00:59:33 +02001560 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1561
Sasha Khapyorsky3ea099d2006-09-29 03:10:44 +03001562http.noEPSV::
1563 A boolean which disables using of EPSV ftp command by curl.
Frank Lichtenheldbefc9c42007-04-13 18:02:33 +02001564 This can helpful with some "poor" ftp servers which don't
Sasha Khapyorsky3ea099d2006-09-29 03:10:44 +03001565 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1566 environment variable. Default is false (curl will use EPSV).
1567
Spencer E. Olsonb1d10582010-08-11 14:40:38 -06001568http.useragent::
1569 The HTTP USER_AGENT string presented to an HTTP server. The default
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001570 value represents the version of the client Git such as git/1.7.1.
Spencer E. Olsonb1d10582010-08-11 14:40:38 -06001571 This option allows you to override this value to a more common value
1572 such as Mozilla/4.0. This may be necessary, for instance, if
1573 connecting through a firewall that restricts HTTP connections to a set
1574 of common USER_AGENT strings (but not including those like git/1.7.1).
1575 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1576
Kyle J. McKay6a569932013-08-05 13:20:36 -07001577http.<url>.*::
1578 Any of the http.* options above can be applied selectively to some urls.
1579 For a config key to match a URL, each element of the config key is
1580 compared to that of the URL, in the following order:
1581+
1582--
1583. Scheme (e.g., `https` in `https://example.com/`). This field
1584 must match exactly between the config key and the URL.
1585
1586. Host/domain name (e.g., `example.com` in `https://example.com/`).
1587 This field must match exactly between the config key and the URL.
1588
1589. Port number (e.g., `8080` in `http://example.com:8080/`).
1590 This field must match exactly between the config key and the URL.
1591 Omitted port numbers are automatically converted to the correct
1592 default for the scheme before matching.
1593
1594. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1595 path field of the config key must match the path field of the URL
1596 either exactly or as a prefix of slash-delimited path elements. This means
1597 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1598 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1599 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1600 key with just path `foo/`).
1601
1602. User name (e.g., `user` in `https://user@example.com/repo.git`). If
1603 the config key has a user name it must match the user name in the
1604 URL exactly. If the config key does not have a user name, that
1605 config key will match a URL with any user name (including none),
1606 but at a lower precedence than a config key with a user name.
1607--
1608+
1609The list above is ordered by decreasing precedence; a URL that matches
1610a config key's path is preferred to one that matches its user name. For example,
1611if the URL is `https://user@example.com/foo/bar` a config key match of
1612`https://example.com/foo` will be preferred over a config key match of
1613`https://user@example.com`.
1614+
1615All URLs are normalized before attempting any matching (the password part,
1616if embedded in the URL, is always ignored for matching purposes) so that
1617equivalent urls that are simply spelled differently will match properly.
1618Environment variable settings always override any matches. The urls that are
1619matched against are those given directly to Git commands. This means any URLs
1620visited as a result of a redirection do not participate in matching.
1621
Petr Baudis1ab661d2006-04-25 00:59:33 +02001622i18n.commitEncoding::
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001623 Character encoding the commit messages are stored in; Git itself
Petr Baudis1ab661d2006-04-25 00:59:33 +02001624 does not care per se, but this information is necessary e.g. when
1625 importing commits from emails or in the gitk graphical history
1626 browser (and possibly at other places in the future or in other
Dan McGee5162e692007-12-29 00:20:38 -06001627 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Petr Baudis1ab661d2006-04-25 00:59:33 +02001628
Junio C Hamanod2c11a32006-12-27 16:41:33 -08001629i18n.logOutputEncoding::
1630 Character encoding the commit messages are converted to when
Thomas Rast0b444cd2010-01-10 00:33:00 +01001631 running 'git log' and friends.
Junio C Hamanod2c11a32006-12-27 16:41:33 -08001632
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001633imap::
1634 The configuration variables in the 'imap' section are described
1635 in linkgit:git-imap-send[1].
1636
Thomas Gummerer3c09d682014-02-23 21:49:59 +01001637index.version::
1638 Specify the version with which new index files should be
1639 initialized. This does not affect existing repositories.
1640
Steven Draked8a84882010-02-17 12:44:46 +13001641init.templatedir::
1642 Specify the directory from which templates will be copied.
1643 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1644
Christian Couder983a9ee2008-01-08 04:55:14 +01001645instaweb.browser::
1646 Specify the program that will be used to browse your working
1647 repository in gitweb. See linkgit:git-instaweb[1].
1648
1649instaweb.httpd::
1650 The HTTP daemon command-line to start gitweb on your working
1651 repository. See linkgit:git-instaweb[1].
1652
1653instaweb.local::
1654 If true the web server started by linkgit:git-instaweb[1] will
1655 be bound to the local IP (127.0.0.1).
1656
1657instaweb.modulepath::
Ville Skyttä6b677a22010-07-20 00:17:17 +03001658 The default module path for linkgit:git-instaweb[1] to use
1659 instead of /usr/lib/apache2/modules. Only used if httpd
1660 is Apache.
Christian Couder983a9ee2008-01-08 04:55:14 +01001661
1662instaweb.port::
1663 The port number to bind the gitweb httpd to. See
1664 linkgit:git-instaweb[1].
1665
Thomas Rastca6ac7f2009-02-05 09:28:26 +01001666interactive.singlekey::
Ori Avtalion57f6ec02009-08-07 17:24:21 +03001667 In interactive commands, allow the user to provide one-letter
Thomas Rastca6ac7f2009-02-05 09:28:26 +01001668 input with a single key (i.e., without hitting enter).
Jeff King6cf378f2012-04-26 04:51:57 -04001669 Currently this is used by the `--patch` mode of
Conrad Irwine6b57a82011-05-07 10:59:04 -07001670 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1671 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1672 setting is silently ignored if portable keystroke input
Simon Ruderich8358f1a2014-03-03 22:15:50 +01001673 is not available; requires the Perl module Term::ReadKey.
Thomas Rastca6ac7f2009-02-05 09:28:26 +01001674
Jay Soffian0c476952011-05-18 13:56:04 -04001675log.abbrevCommit::
1676 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
Jeff King6cf378f2012-04-26 04:51:57 -04001677 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1678 override this option with `--no-abbrev-commit`.
Jay Soffian0c476952011-05-18 13:56:04 -04001679
Heikki Orsiladd0ffd52008-05-22 18:24:07 +03001680log.date::
Jonathan Niedere8607952010-08-20 05:20:36 -05001681 Set the default date-time mode for the 'log' command.
1682 Setting a value for log.date is similar to using 'git log''s
Jeff King6cf378f2012-04-26 04:51:57 -04001683 `--date` option. Possible values are `relative`, `local`,
Jonathan Niedere8607952010-08-20 05:20:36 -05001684 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1685 for details.
Heikki Orsiladd0ffd52008-05-22 18:24:07 +03001686
Steven Drakeeb734452010-02-17 12:39:52 +13001687log.decorate::
1688 Print out the ref names of any commits that are shown by the log
1689 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1690 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1691 specified, the full ref name (including prefix) will be printed.
1692 This is the same as the log commands '--decorate' option.
1693
Peter Baumann0f03ca92006-11-23 10:36:33 +01001694log.showroot::
1695 If true, the initial commit will be shown as a big creation event.
1696 This is equivalent to a diff against an empty tree.
Dan McGee5162e692007-12-29 00:20:38 -06001697 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Peter Baumann0f03ca92006-11-23 10:36:33 +01001698 normally hide the root commit will now show it. True by default.
1699
Antoine Pelissee6bb5f72013-01-05 22:26:46 +01001700log.mailmap::
1701 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1702 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1703
Marius Storm-Olsend551a482009-02-08 15:34:27 +01001704mailmap.file::
1705 The location of an augmenting mailmap file. The default
1706 mailmap, located in the root of the repository, is loaded
1707 first, then the mailmap file pointed to by this variable.
1708 The location of the mailmap file may be in a repository
1709 subdirectory, or somewhere outside of the repository itself.
1710 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1711
Jeff King08610902012-12-12 06:04:04 -05001712mailmap.blob::
1713 Like `mailmap.file`, but consider the value as a reference to a
Jeff King8c473ce2012-12-13 08:04:47 -05001714 blob in the repository. If both `mailmap.file` and
1715 `mailmap.blob` are given, both are parsed, with entries from
1716 `mailmap.file` taking precedence. In a bare repository, this
1717 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1718 defaults to empty.
Jeff King08610902012-12-12 06:04:04 -05001719
Christian Couderb5578f32008-03-07 08:46:55 +01001720man.viewer::
Christian Couderb8322ea2008-03-13 06:48:46 +01001721 Specify the programs that may be used to display help in the
Christian Couderb5578f32008-03-07 08:46:55 +01001722 'man' format. See linkgit:git-help[1].
1723
Christian Couder0bb64002008-04-25 08:25:35 +02001724man.<tool>.cmd::
1725 Specify the command to invoke the specified man viewer. The
1726 specified command is evaluated in shell with the man page
1727 passed as argument. (See linkgit:git-help[1].)
1728
Christian Couder7e8114c2008-04-25 08:24:41 +02001729man.<tool>.path::
1730 Override the path for the given tool that may be used to
1731 display help in the 'man' format. See linkgit:git-help[1].
1732
Matt McCutchenb0f34c32008-11-26 03:26:50 -05001733include::merge-config.txt[]
Junio C Hamanob5412482008-08-29 10:49:56 -07001734
Johannes Schindelin77680ca2007-12-17 12:21:22 +00001735mergetool.<tool>.path::
1736 Override the path for the given tool. This is useful in case
1737 your tool is not in the PATH.
1738
Charles Bailey964473a2008-02-21 23:31:12 +00001739mergetool.<tool>.cmd::
1740 Specify the command to invoke the specified merge tool. The
1741 specified command is evaluated in shell with the following
1742 variables available: 'BASE' is the name of a temporary file
1743 containing the common base of the files to be merged, if available;
1744 'LOCAL' is the name of a temporary file containing the contents of
1745 the file on the current branch; 'REMOTE' is the name of a temporary
1746 file containing the contents of the file from the branch being
1747 merged; 'MERGED' contains the name of the file to which the merge
1748 tool should write the results of a successful merge.
1749
1750mergetool.<tool>.trustExitCode::
1751 For a custom merge command, specify whether the exit code of
1752 the merge command can be used to determine whether the merge was
1753 successful. If this is not set to true then the merge target file
1754 timestamp is checked and the merge assumed to have been successful
1755 if the file has been updated, otherwise the user is prompted to
1756 indicate the success of the merge.
1757
Charles Bailey44c36d12008-02-21 23:30:02 +00001758mergetool.keepBackup::
1759 After performing a merge, the original file with conflict markers
1760 can be saved as a file with a `.orig` extension. If this variable
1761 is set to `false` then this file is not preserved. Defaults to
1762 `true` (i.e. keep the backup files).
1763
Charles Bailey162eba82008-12-12 21:48:41 +00001764mergetool.keepTemporaries::
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001765 When invoking a custom merge tool, Git uses a set of temporary
Charles Bailey162eba82008-12-12 21:48:41 +00001766 files to pass to the tool. If the tool returns an error and this
1767 variable is set to `true`, then these temporary files will be
1768 preserved, otherwise they will be removed after the tool has
1769 exited. Defaults to `false`.
1770
Charles Bailey682b4512008-11-13 12:41:14 +00001771mergetool.prompt::
1772 Prompt before each invocation of the merge resolution program.
1773
Thomas Rast894a9d32010-03-12 18:04:26 +01001774notes.displayRef::
1775 The (fully qualified) refname from which to show notes when
1776 showing commit messages. The value of this variable can be set
1777 to a glob, in which case notes from all matching refs will be
1778 shown. You may also specify this configuration variable
1779 several times. A warning will be issued for refs that do not
1780 exist, but a glob that does not match any refs is silently
1781 ignored.
1782+
1783This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1784environment variable, which must be a colon separated list of refs or
1785globs.
1786+
1787The effective value of "core.notesRef" (possibly overridden by
1788GIT_NOTES_REF) is also implicitly added to the list of refs to be
1789displayed.
1790
Thomas Rast6956f852010-03-12 18:04:32 +01001791notes.rewrite.<command>::
1792 When rewriting commits with <command> (currently `amend` or
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001793 `rebase`) and this variable is set to `true`, Git
Thomas Rast6956f852010-03-12 18:04:32 +01001794 automatically copies your notes from the original to the
1795 rewritten commit. Defaults to `true`, but see
1796 "notes.rewriteRef" below.
Thomas Rast6956f852010-03-12 18:04:32 +01001797
1798notes.rewriteMode::
1799 When copying notes during a rewrite (see the
1800 "notes.rewrite.<command>" option), determines what to do if
1801 the target commit already has a note. Must be one of
1802 `overwrite`, `concatenate`, or `ignore`. Defaults to
1803 `concatenate`.
1804+
1805This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1806environment variable.
1807
1808notes.rewriteRef::
1809 When copying notes during a rewrite, specifies the (fully
1810 qualified) ref whose notes should be copied. The ref may be a
1811 glob, in which case notes in all matching refs will be copied.
1812 You may also specify this configuration several times.
1813+
1814Does not have a default value; you must configure this variable to
Thomas Rast2b4aa892011-09-13 09:32:42 +02001815enable note rewriting. Set it to `refs/notes/commits` to enable
1816rewriting for the default commit notes.
Leif Arne Storsetcfb88e92010-05-05 16:16:25 +02001817+
1818This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1819environment variable, which must be a colon separated list of refs or
1820globs.
Thomas Rast6956f852010-03-12 18:04:32 +01001821
Jeff King4812a932006-07-23 01:50:30 -04001822pack.window::
Dan McGee5162e692007-12-29 00:20:38 -06001823 The size of the window used by linkgit:git-pack-objects[1] when no
Jeff King4812a932006-07-23 01:50:30 -04001824 window size is given on the command line. Defaults to 10.
1825
Theodore Ts'o842aaf92007-05-08 09:28:26 -04001826pack.depth::
Dan McGee5162e692007-12-29 00:20:38 -06001827 The maximum delta depth used by linkgit:git-pack-objects[1] when no
Theodore Ts'o618e6132007-05-08 09:28:26 -04001828 maximum depth is given on the command line. Defaults to 50.
Theodore Ts'o842aaf92007-05-08 09:28:26 -04001829
Brian Downinge93b15c2007-07-12 07:55:52 -05001830pack.windowMemory::
Dan McGee5162e692007-12-29 00:20:38 -06001831 The window memory size limit used by linkgit:git-pack-objects[1]
Brian Downinge93b15c2007-07-12 07:55:52 -05001832 when no limit is given on the command line. The value can be
1833 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1834 limit.
1835
Dana How960ccca2007-05-09 13:56:50 -07001836pack.compression::
1837 An integer -1..9, indicating the compression level for objects
1838 in a pack file. -1 is the zlib default. 0 means no
1839 compression, and 1..9 are various speed/size tradeoffs, 9 being
1840 slowest. If not set, defaults to core.compression. If that is
Brian Downingdec92302007-11-19 10:58:51 -06001841 not set, defaults to -1, the zlib default, which is "a default
1842 compromise between speed and compression (currently equivalent
1843 to level 6)."
Jan Krüger89d71f72010-09-27 14:21:58 +02001844+
1845Note that changing the compression level will not automatically recompress
1846all existing objects. You can force recompression by passing the -F option
1847to linkgit:git-repack[1].
Dana How960ccca2007-05-09 13:56:50 -07001848
Martin Koegler074b2ee2007-05-28 23:20:58 +02001849pack.deltaCacheSize::
Brian Hetro02783072007-08-23 20:44:13 -04001850 The maximum memory in bytes used for caching deltas in
Nicolas Pitre5749b0b2009-08-05 16:55:07 -04001851 linkgit:git-pack-objects[1] before writing them out to a pack.
1852 This cache is used to speed up the writing object phase by not
1853 having to recompute the final delta result once the best match
1854 for all objects is found. Repacking large repositories on machines
1855 which are tight with memory might be badly impacted by this though,
1856 especially if this cache pushes the system into swapping.
1857 A value of 0 means no limit. The smallest size of 1 byte may be
1858 used to virtually disable this cache. Defaults to 256 MiB.
Martin Koegler074b2ee2007-05-28 23:20:58 +02001859
Martin Koeglere3dfddb2007-05-28 23:20:59 +02001860pack.deltaCacheLimit::
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001861 The maximum size of a delta, that is cached in
Nicolas Pitre5749b0b2009-08-05 16:55:07 -04001862 linkgit:git-pack-objects[1]. This cache is used to speed up the
1863 writing object phase by not having to recompute the final delta
1864 result once the best match for all objects is found. Defaults to 1000.
Martin Koeglere3dfddb2007-05-28 23:20:59 +02001865
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001866pack.threads::
1867 Specifies the number of threads to spawn when searching for best
Dan McGee5162e692007-12-29 00:20:38 -06001868 delta matches. This requires that linkgit:git-pack-objects[1]
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001869 be compiled with pthreads otherwise this option is ignored with a
1870 warning. This is meant to reduce packing time on multiprocessor
1871 machines. The required amount of memory for the delta search window
1872 is however multiplied by the number of threads.
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001873 Specifying 0 will cause Git to auto-detect the number of CPU's
Andreas Ericsson833e3df2008-02-22 20:11:56 -06001874 and set the number of threads accordingly.
Nicolas Pitre693b86f2007-09-10 11:51:34 -04001875
Nicolas Pitre4d00bda2007-11-01 23:26:04 -04001876pack.indexVersion::
1877 Specify the default pack index version. Valid values are 1 for
1878 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1879 the new pack index with capabilities for packs larger than 4 GB
1880 as well as proper protection against the repacking of corrupted
Nicolas Pitrec0a5e2d2008-06-25 00:25:53 -04001881 packs. Version 2 is the default. Note that version 2 is enforced
1882 and this config option ignored whenever the corresponding pack is
1883 larger than 2 GB.
1884+
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001885If you have an old Git that does not understand the version 2 `*.idx` file,
Nicolas Pitrec0a5e2d2008-06-25 00:25:53 -04001886cloning or fetching over a non native protocol (e.g. "http" and "rsync")
Jeff King6cf378f2012-04-26 04:51:57 -04001887that will copy both `*.pack` file and corresponding `*.idx` file from the
Nicolas Pitrec0a5e2d2008-06-25 00:25:53 -04001888other side may give you a repository that cannot be accessed with your
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001889older version of Git. If the `*.pack` file is smaller than 2 GB, however,
Nicolas Pitrec0a5e2d2008-06-25 00:25:53 -04001890you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
Jeff King6cf378f2012-04-26 04:51:57 -04001891the `*.idx` file.
Nicolas Pitre4d00bda2007-11-01 23:26:04 -04001892
Junio C Hamanodbdbfec2008-03-12 23:11:15 -07001893pack.packSizeLimit::
Nicolas Pitre07cf0f22010-02-03 22:48:28 -05001894 The maximum size of a pack. This setting only affects
1895 packing to a file when repacking, i.e. the git:// protocol
Jeff King6cf378f2012-04-26 04:51:57 -04001896 is unaffected. It can be overridden by the `--max-pack-size`
Nicolas Pitre07cf0f22010-02-03 22:48:28 -05001897 option of linkgit:git-repack[1]. The minimum size allowed is
1898 limited to 1 MiB. The default is unlimited.
1899 Common unit suffixes of 'k', 'm', or 'g' are
1900 supported.
Johannes Schindelin2b84b5a2008-02-05 14:25:04 +00001901
Vicent Marti6b8fda22013-12-21 09:00:09 -05001902pack.useBitmaps::
1903 When true, git will use pack bitmaps (if available) when packing
1904 to stdout (e.g., during the server side of a fetch). Defaults to
1905 true. You should not generally need to turn this off unless
1906 you are debugging pack bitmaps.
1907
Vicent Marti7cc8f972013-12-21 09:00:16 -05001908pack.writebitmaps::
Jeff King71d76cb2014-06-10 16:20:30 -04001909 This is a deprecated synonym for `repack.writeBitmaps`.
Vicent Marti7cc8f972013-12-21 09:00:16 -05001910
Vicent Martiae4f07f2013-12-21 09:00:45 -05001911pack.writeBitmapHashCache::
1912 When true, git will include a "hash cache" section in the bitmap
1913 index (if one is written). This cache can be used to feed git's
1914 delta heuristics, potentially leading to better deltas between
1915 bitmapped and non-bitmapped objects (e.g., when serving a fetch
1916 between an older, bitmapped pack and objects that have been
1917 pushed since the last gc). The downside is that it consumes 4
1918 bytes per object of disk space, and that JGit's bitmap
1919 implementation does not understand it, causing it to complain if
1920 Git and JGit are used on the same repository. Defaults to false.
1921
Miklos Vajna4370c2d2008-08-16 04:14:33 +02001922pager.<cmd>::
Jeff King9bad7232010-11-17 12:04:12 -05001923 If the value is boolean, turns on or off pagination of the
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001924 output of a particular Git subcommand when writing to a tty.
Jeff King9bad7232010-11-17 12:04:12 -05001925 Otherwise, turns on pagination for the subcommand using the
Jeff King6cf378f2012-04-26 04:51:57 -04001926 pager specified by the value of `pager.<cmd>`. If `--paginate`
1927 or `--no-pager` is specified on the command line, it takes
Jeff King9bad7232010-11-17 12:04:12 -05001928 precedence over this option. To disable pagination for all
1929 commands, set `core.pager` or `GIT_PAGER` to `cat`.
Miklos Vajna4370c2d2008-08-16 04:14:33 +02001930
Will Palmer80281842010-05-02 12:00:44 +01001931pretty.<name>::
1932 Alias for a --pretty= format string, as specified in
1933 linkgit:git-log[1]. Any aliases defined here can be used just
1934 as the built-in pretty formats could. For example,
Jeff King6cf378f2012-04-26 04:51:57 -04001935 running `git config pretty.changelog "format:* %H %s"`
Will Palmer80281842010-05-02 12:00:44 +01001936 would cause the invocation `git log --pretty=changelog`
Jeff King6cf378f2012-04-26 04:51:57 -04001937 to be equivalent to running `git log "--pretty=format:* %H %s"`.
Will Palmer80281842010-05-02 12:00:44 +01001938 Note that an alias with the same name as a built-in format
1939 will be silently ignored.
1940
David Aguilarb814da82014-01-15 15:18:38 -08001941pull.ff::
1942 By default, Git does not create an extra merge commit when merging
1943 a commit that is a descendant of the current commit. Instead, the
1944 tip of the current branch is fast-forwarded. When set to `false`,
1945 this variable tells Git to create an extra merge commit in such
1946 a case (equivalent to giving the `--no-ff` option from the command
1947 line). When set to `only`, only such fast-forward merges are
1948 allowed (equivalent to giving the `--ff-only` option from the
1949 command line).
1950
Ævar Arnfjörð Bjarmason6b37dff2011-11-06 10:50:10 +01001951pull.rebase::
1952 When true, rebase branches on top of the fetched branch, instead
1953 of merging the default branch from the default remote when "git
1954 pull" is run. See "branch.<name>.rebase" for setting this on a
1955 per-branch basis.
1956+
Stephen Haberman66713ef2013-08-12 22:43:42 -05001957 When preserve, also pass `--preserve-merges` along to 'git rebase'
1958 so that locally committed merge commits will not be flattened
1959 by running 'git pull'.
1960+
Ævar Arnfjörð Bjarmason6b37dff2011-11-06 10:50:10 +01001961*NOTE*: this is a possibly dangerous operation; do *not* use
1962it unless you understand the implications (see linkgit:git-rebase[1]
1963for details).
1964
Petr Baudis1ab661d2006-04-25 00:59:33 +02001965pull.octopus::
1966 The default merge strategy to use when pulling multiple branches
1967 at once.
1968
1969pull.twohead::
1970 The default merge strategy to use when pulling a single branch.
1971
Finn Arne Gangstad52153742009-03-16 16:42:51 +01001972push.default::
Ramkumar Ramachandra87a70e42013-06-19 16:41:40 +05301973 Defines the action `git push` should take if no refspec is
1974 explicitly given. Different values are well-suited for
1975 specific workflows; for instance, in a purely central workflow
1976 (i.e. the fetch source is equal to the push destination),
1977 `upstream` is probably what you want. Possible values are:
Finn Arne Gangstad52153742009-03-16 16:42:51 +01001978+
Andreas Schwabb1290512012-06-23 15:18:00 +02001979--
Ramkumar Ramachandra87a70e42013-06-19 16:41:40 +05301980
1981* `nothing` - do not push anything (error out) unless a refspec is
1982 explicitly given. This is primarily meant for people who want to
1983 avoid mistakes by always being explicit.
1984
1985* `current` - push the current branch to update a branch with the same
1986 name on the receiving end. Works in both central and non-central
1987 workflows.
1988
1989* `upstream` - push the current branch back to the branch whose
1990 changes are usually integrated into the current branch (which is
1991 called `@{upstream}`). This mode only makes sense if you are
1992 pushing to the same repository you would normally pull from
1993 (i.e. central workflow).
1994
Ramkumar Ramachandraed2b1822013-06-19 16:41:41 +05301995* `simple` - in centralized workflow, work like `upstream` with an
1996 added safety to refuse to push if the upstream branch's name is
1997 different from the local one.
Andreas Schwabb1290512012-06-23 15:18:00 +02001998+
Ramkumar Ramachandraed2b1822013-06-19 16:41:41 +05301999When pushing to a remote that is different from the remote you normally
2000pull from, work as `current`. This is the safest option and is suited
2001for beginners.
Andreas Schwabb1290512012-06-23 15:18:00 +02002002+
Junio C Hamano009055f2014-03-07 15:13:15 -08002003This mode has become the default in Git 2.0.
Ramkumar Ramachandra87a70e42013-06-19 16:41:40 +05302004
2005* `matching` - push all branches having the same name on both ends.
2006 This makes the repository you are pushing to remember the set of
2007 branches that will be pushed out (e.g. if you always push 'maint'
2008 and 'master' there and no other branches, the repository you push
2009 to will have these two branches, and your local 'maint' and
2010 'master' will be pushed there).
2011+
2012To use this mode effectively, you have to make sure _all_ the
2013branches you would push out are ready to be pushed out before
2014running 'git push', as the whole point of this mode is to allow you
2015to push all of the branches in one go. If you usually finish work
2016on only one branch and push out the result, while other branches are
2017unfinished, this mode is not for you. Also this mode is not
2018suitable for pushing into a shared central repository, as other
2019people may add new branches there, or update the tip of existing
2020branches outside your control.
2021+
Junio C Hamano009055f2014-03-07 15:13:15 -08002022This used to be the default, but not since Git 2.0 (`simple` is the
2023new default).
Ramkumar Ramachandra87a70e42013-06-19 16:41:40 +05302024
2025--
Finn Arne Gangstad52153742009-03-16 16:42:51 +01002026
Tor Arne Vestbøa9c38212009-03-01 23:11:38 +01002027rebase.stat::
2028 Whether to show a diffstat of what changed upstream since the last
2029 rebase. False by default.
2030
Heiko Voigtdd1e5b32010-07-14 13:59:57 +02002031rebase.autosquash::
2032 If set to true enable '--autosquash' option by default.
2033
Ramkumar Ramachandra58794772013-05-12 17:26:41 +05302034rebase.autostash::
2035 When set to true, automatically create a temporary stash
2036 before the operation begins, and apply it after the operation
2037 ends. This means that you can run rebase on a dirty worktree.
2038 However, use with care: the final stash application after a
2039 successful rebase might result in non-trivial conflicts.
2040 Defaults to false.
2041
Junio C Hamano77e3efb2009-10-20 14:56:40 -07002042receive.autogc::
2043 By default, git-receive-pack will run "git-gc --auto" after
2044 receiving data from git-push and updating refs. You can stop
2045 it by setting this variable to false.
2046
Junio C Hamanob89363e2014-08-21 16:45:30 -07002047receive.certnonceseed::
2048 By setting this variable to a string, `git receive-pack`
2049 will accept a `git push --signed` and verifies it by using
2050 a "nonce" protected by HMAC using this string as a secret
2051 key.
2052
Junio C Hamano57323732014-09-05 10:46:04 -07002053receive.certnonceslop::
2054 When a `git push --signed` sent a push certificate with a
2055 "nonce" that was issued by a receive-pack serving the same
2056 repository within this many seconds, export the "nonce"
2057 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2058 hooks (instead of what the receive-pack asked the sending
2059 side to include). This may allow writing checks in
2060 `pre-receive` and `post-receive` a bit easier. Instead of
2061 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2062 that records by how many seconds the nonce is stale to
2063 decide if they want to accept the certificate, they only
2064 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2065
Matt McCutchenb0f34c32008-11-26 03:26:50 -05002066receive.fsckObjects::
2067 If it is set to true, git-receive-pack will check all received
2068 objects. It will abort in the case of a malformed object or a
2069 broken link. The result of an abort are only dangling objects.
Junio C Hamanodab76d32011-09-04 12:37:45 -07002070 Defaults to false. If not set, the value of `transfer.fsckObjects`
2071 is used instead.
Matt McCutchenb0f34c32008-11-26 03:26:50 -05002072
2073receive.unpackLimit::
2074 If the number of objects received in a push is below this
2075 limit then the objects will be unpacked into loose object
2076 files. However if the number of received objects equals or
2077 exceeds this limit then the received pack will be stored as
2078 a pack, after adding any missing delta bases. Storing the
2079 pack from a push can make the push operation complete faster,
2080 especially on slow filesystems. If not set, the value of
2081 `transfer.unpackLimit` is used instead.
2082
Junio C Hamano42fc11c2008-11-26 11:11:18 -08002083receive.denyDeletes::
2084 If set to true, git-receive-pack will deny a ref update that deletes
2085 the ref. Use this to prevent such a ref deletion via a push.
2086
Thomas Rast662c83f2010-07-24 18:07:53 +02002087receive.denyDeleteCurrent::
2088 If set to true, git-receive-pack will deny a ref update that
2089 deletes the currently checked out branch of a non-bare repository.
2090
Junio C Hamano42fc11c2008-11-26 11:11:18 -08002091receive.denyCurrentBranch::
Michael J Gruberf3838ce2010-05-13 14:51:38 +02002092 If set to true or "refuse", git-receive-pack will deny a ref update
Junio C Hamano42fc11c2008-11-26 11:11:18 -08002093 to the currently checked out branch of a non-bare repository.
2094 Such a push is potentially dangerous because it brings the HEAD
2095 out of sync with the index and working tree. If set to "warn",
2096 print a warning of such a push to stderr, but allow the push to
2097 proceed. If set to false or "ignore", allow such pushes with no
Thomas Rast7d182f52010-03-17 12:14:57 +01002098 message. Defaults to "refuse".
Junio C Hamano42fc11c2008-11-26 11:11:18 -08002099
Matt McCutchenb0f34c32008-11-26 03:26:50 -05002100receive.denyNonFastForwards::
2101 If set to true, git-receive-pack will deny a ref update which is
Felipe Contrerasa75d7b52009-10-24 11:31:32 +03002102 not a fast-forward. Use this to prevent such an update via a push,
Matt McCutchenb0f34c32008-11-26 03:26:50 -05002103 even if that push is forced. This configuration variable is
2104 set when initializing a shared repository.
2105
Junio C Hamanodaebaa72013-01-18 16:08:30 -08002106receive.hiderefs::
2107 String(s) `receive-pack` uses to decide which refs to omit
2108 from its initial advertisement. Use more than one
2109 definitions to specify multiple prefix strings. A ref that
2110 are under the hierarchies listed on the value of this
2111 variable is excluded, and is hidden when responding to `git
2112 push`, and an attempt to update or delete a hidden ref by
2113 `git push` is rejected.
2114
Junio C Hamano77e3efb2009-10-20 14:56:40 -07002115receive.updateserverinfo::
2116 If set to true, git-receive-pack will run git-update-server-info
2117 after receiving data from git-push and updating refs.
2118
Nguyễn Thái Ngọc Duy0a1bc122013-12-05 20:02:47 +07002119receive.shallowupdate::
2120 If set to true, .git/shallow can be updated when new refs
2121 require new shallow roots. Otherwise those refs are rejected.
2122
Ramkumar Ramachandra224c2172013-04-02 13:10:33 +05302123remote.pushdefault::
2124 The remote to push to by default. Overrides
Ramkumar Ramachandra9f765ce2013-04-02 13:10:34 +05302125 `branch.<name>.remote` for all branches, and is overridden by
2126 `branch.<name>.pushremote` for specific branches.
Ramkumar Ramachandra224c2172013-04-02 13:10:33 +05302127
Santi Béjar0cc6d342006-10-23 18:42:14 +02002128remote.<name>.url::
Dan McGee5162e692007-12-29 00:20:38 -06002129 The URL of a remote repository. See linkgit:git-fetch[1] or
2130 linkgit:git-push[1].
Santi Béjar0cc6d342006-10-23 18:42:14 +02002131
Michael J Gruber20346232009-06-09 18:01:34 +02002132remote.<name>.pushurl::
2133 The push URL of a remote repository. See linkgit:git-push[1].
2134
Sam Vilain14c98212007-12-04 10:48:54 +13002135remote.<name>.proxy::
2136 For remotes that require curl (http, https and ftp), the URL to
2137 the proxy to use for that remote. Set to the empty string to
2138 disable proxying for that remote.
2139
Santi Béjar0cc6d342006-10-23 18:42:14 +02002140remote.<name>.fetch::
Dan McGee5162e692007-12-29 00:20:38 -06002141 The default set of "refspec" for linkgit:git-fetch[1]. See
2142 linkgit:git-fetch[1].
Santi Béjar0cc6d342006-10-23 18:42:14 +02002143
2144remote.<name>.push::
Dan McGee5162e692007-12-29 00:20:38 -06002145 The default set of "refspec" for linkgit:git-push[1]. See
2146 linkgit:git-push[1].
Santi Béjar0cc6d342006-10-23 18:42:14 +02002147
Paolo Bonzini84bb2df2008-04-17 13:17:20 +02002148remote.<name>.mirror::
2149 If true, pushing to this remote will automatically behave
Jeff King6cf378f2012-04-26 04:51:57 -04002150 as if the `--mirror` option was given on the command line.
Paolo Bonzini84bb2df2008-04-17 13:17:20 +02002151
Theodore Ts'o19182782007-02-20 15:13:43 -05002152remote.<name>.skipDefaultUpdate::
2153 If true, this remote will be skipped by default when updating
Björn Gustavsson7cc91a22009-11-09 21:11:06 +01002154 using linkgit:git-fetch[1] or the `update` subcommand of
2155 linkgit:git-remote[1].
2156
2157remote.<name>.skipFetchAll::
2158 If true, this remote will be skipped by default when updating
2159 using linkgit:git-fetch[1] or the `update` subcommand of
2160 linkgit:git-remote[1].
Theodore Ts'o19182782007-02-20 15:13:43 -05002161
Uwe Kleine-König060aafc2007-01-19 13:46:16 +01002162remote.<name>.receivepack::
Uwe Kleine-König5dee29a2007-01-25 05:45:39 +01002163 The default program to execute on the remote side when pushing. See
Uwe Kleine-König79f43f32008-03-06 21:28:07 +01002164 option \--receive-pack of linkgit:git-push[1].
Uwe Kleine-König060aafc2007-01-19 13:46:16 +01002165
Uwe Kleine-König5dee29a2007-01-25 05:45:39 +01002166remote.<name>.uploadpack::
2167 The default program to execute on the remote side when fetching. See
Uwe Kleine-König79f43f32008-03-06 21:28:07 +01002168 option \--upload-pack of linkgit:git-fetch-pack[1].
Uwe Kleine-König5dee29a2007-01-25 05:45:39 +01002169
Aneesh Kumar K.V047f6362007-02-24 21:02:56 +05302170remote.<name>.tagopt::
Uwe Kleine-König79f43f32008-03-06 21:28:07 +01002171 Setting this value to \--no-tags disables automatic tag following when
Samuel Tardieu944163a2010-04-20 01:31:25 +02002172 fetching from remote <name>. Setting it to \--tags will fetch every
2173 tag from remote <name>, even if they are not reachable from remote
Daniel Johnsoned368542010-08-11 18:57:20 -04002174 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2175 override this setting. See options \--tags and \--no-tags of
2176 linkgit:git-fetch[1].
Aneesh Kumar K.V047f6362007-02-24 21:02:56 +05302177
Daniel Barkalowc578f512009-11-18 02:42:25 +01002178remote.<name>.vcs::
Thomas Ackermann2de9b712013-01-21 20:17:53 +01002179 Setting this to a value <vcs> will cause Git to interact with
Daniel Barkalowc578f512009-11-18 02:42:25 +01002180 the remote with the git-remote-<vcs> helper.
2181
Michael Schubert737c5a92013-07-13 11:36:24 +02002182remote.<name>.prune::
2183 When set to true, fetching from this remote by default will also
Michael Haggerty0838bf42013-10-30 06:33:00 +01002184 remove any remote-tracking references that no longer exist on the
2185 remote (as if the `--prune` option was given on the command line).
Michael Schubert737c5a92013-07-13 11:36:24 +02002186 Overrides `fetch.prune` settings, if any.
2187
Theodore Ts'o19182782007-02-20 15:13:43 -05002188remotes.<group>::
2189 The list of remotes which are fetched by "git remote update
Dan McGee5162e692007-12-29 00:20:38 -06002190 <group>". See linkgit:git-remote[1].
Theodore Ts'o19182782007-02-20 15:13:43 -05002191
Junio C Hamanob6945f52006-10-13 21:28:58 -07002192repack.usedeltabaseoffset::
Nicolas Pitre22c79ea2008-06-25 00:24:53 -04002193 By default, linkgit:git-repack[1] creates packs that use
2194 delta-base offset. If you need to share your repository with
Thomas Ackermann2de9b712013-01-21 20:17:53 +01002195 Git older than version 1.4.4, either directly or via a dumb
Nicolas Pitre22c79ea2008-06-25 00:24:53 -04002196 protocol such as http, then you need to set this option to
Thomas Ackermann2de9b712013-01-21 20:17:53 +01002197 "false" and repack. Access from old Git versions over the
Nicolas Pitre22c79ea2008-06-25 00:24:53 -04002198 native protocol are unaffected by this option.
Junio C Hamanob6945f52006-10-13 21:28:58 -07002199
Jeff Kingee34a2b2014-03-03 15:04:20 -05002200repack.packKeptObjects::
2201 If set to true, makes `git repack` act as if
2202 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2203 details. Defaults to `false` normally, but `true` if a bitmap
2204 index is being written (either via `--write-bitmap-index` or
Jeff King71d76cb2014-06-10 16:20:30 -04002205 `repack.writeBitmaps`).
2206
2207repack.writeBitmaps::
2208 When true, git will write a bitmap index when packing all
2209 objects to disk (e.g., when `git repack -a` is run). This
2210 index can speed up the "counting objects" phase of subsequent
2211 packs created for clones and fetches, at the cost of some disk
2212 space and extra time spent on the initial repack. Defaults to
2213 false.
Jeff Kingee34a2b2014-03-03 15:04:20 -05002214
Matt McCutchenb0f34c32008-11-26 03:26:50 -05002215rerere.autoupdate::
2216 When set to true, `git-rerere` updates the index with the
2217 resulting contents after it cleanly resolves conflicts using
2218 previously recorded resolution. Defaults to false.
2219
2220rerere.enabled::
2221 Activate recording of resolved conflicts, so that identical
Thomas Rast07b88a02012-01-06 14:08:02 +01002222 conflict hunks can be resolved automatically, should they be
2223 encountered again. By default, linkgit:git-rerere[1] is
2224 enabled if there is an `rr-cache` directory under the
Junio C Hamanob6fb7fe2012-01-10 15:57:27 +01002225 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2226 repository.
Matt McCutchenb0f34c32008-11-26 03:26:50 -05002227
Yann Dirson65180c62009-07-22 23:39:30 +02002228sendemail.identity::
2229 A configuration identity. When given, causes values in the
2230 'sendemail.<identity>' subsection to take precedence over
2231 values in the 'sendemail' section. The default identity is
2232 the value of 'sendemail.identity'.
2233
2234sendemail.smtpencryption::
2235 See linkgit:git-send-email[1] for description. Note that this
2236 setting is not subject to the 'identity' mechanism.
2237
2238sendemail.smtpssl::
2239 Deprecated alias for 'sendemail.smtpencryption = ssl'.
2240
Ramkumar Ramachandra35035bb2013-07-18 09:53:11 -07002241sendemail.smtpsslcertpath::
2242 Path to ca-certificates (either a directory or a single file).
2243 Set it to an empty string to disable certificate verification.
2244
Yann Dirson65180c62009-07-22 23:39:30 +02002245sendemail.<identity>.*::
2246 Identity-specific versions of the 'sendemail.*' parameters
2247 found below, taking precedence over those when the this
2248 identity is selected, through command-line or
2249 'sendemail.identity'.
2250
2251sendemail.aliasesfile::
2252sendemail.aliasfiletype::
Felipe Contreras402596a2013-04-07 01:10:27 -06002253sendemail.annotate::
Yann Dirson65180c62009-07-22 23:39:30 +02002254sendemail.bcc::
2255sendemail.cc::
2256sendemail.cccmd::
2257sendemail.chainreplyto::
2258sendemail.confirm::
2259sendemail.envelopesender::
2260sendemail.from::
2261sendemail.multiedit::
2262sendemail.signedoffbycc::
2263sendemail.smtppass::
2264sendemail.suppresscc::
2265sendemail.suppressfrom::
2266sendemail.to::
Brian Gernhardt69cf7bf2010-04-10 10:53:56 -04002267sendemail.smtpdomain::
Yann Dirson65180c62009-07-22 23:39:30 +02002268sendemail.smtpserver::
2269sendemail.smtpserverport::
Pascal Obry052fbea2010-09-06 20:12:11 +02002270sendemail.smtpserveroption::
Yann Dirson65180c62009-07-22 23:39:30 +02002271sendemail.smtpuser::
2272sendemail.thread::
2273sendemail.validate::
2274 See linkgit:git-send-email[1] for description.
2275
2276sendemail.signedoffcc::
2277 Deprecated alias for 'sendemail.signedoffbycc'.
2278
Petr Baudis1ab661d2006-04-25 00:59:33 +02002279showbranch.default::
Dan McGee5162e692007-12-29 00:20:38 -06002280 The default set of branches for linkgit:git-show-branch[1].
2281 See linkgit:git-show-branch[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02002282
Jeff King46f721c2007-12-07 16:26:07 -05002283status.relativePaths::
Dan McGee5162e692007-12-29 00:20:38 -06002284 By default, linkgit:git-status[1] shows paths relative to the
Jeff King46f721c2007-12-07 16:26:07 -05002285 current directory. Setting this variable to `false` shows paths
Thomas Ackermann2de9b712013-01-21 20:17:53 +01002286 relative to the repository root (this was the default for Git
Jeff King46f721c2007-12-07 16:26:07 -05002287 prior to v1.5.4).
2288
Jorge Juan Garcia Garcia4fb51662013-06-11 15:34:04 +02002289status.short::
2290 Set to true to enable --short by default in linkgit:git-status[1].
2291 The option --no-short takes precedence over this variable.
2292
Jorge Juan Garcia Garciaec85d072013-06-11 15:34:05 +02002293status.branch::
2294 Set to true to enable --branch by default in linkgit:git-status[1].
2295 The option --no-branch takes precedence over this variable.
2296
Matthieu Moy2556b992013-09-06 19:43:07 +02002297status.displayCommentPrefix::
2298 If set to true, linkgit:git-status[1] will insert a comment
2299 prefix before each output line (starting with
2300 `core.commentChar`, i.e. `#` by default). This was the
2301 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2302 Defaults to false.
2303
Marius Storm-Olsend6293d12008-06-05 14:47:50 +02002304status.showUntrackedFiles::
2305 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2306 files which are not currently tracked by Git. Directories which
2307 contain only untracked files, are shown with the directory name
2308 only. Showing untracked files means that Git needs to lstat() all
2309 all the files in the whole repository, which might be slow on some
2310 systems. So, this variable controls how the commands displays
2311 the untracked files. Possible values are:
2312+
2313--
Cliff Frey9373bdc2010-10-17 20:10:45 -07002314* `no` - Show no untracked files.
2315* `normal` - Show untracked files and directories.
2316* `all` - Show also individual files in untracked directories.
Marius Storm-Olsend6293d12008-06-05 14:47:50 +02002317--
2318+
2319If this variable is not specified, it defaults to 'normal'.
2320This variable can be overridden with the -u|--untracked-files option
2321of linkgit:git-status[1] and linkgit:git-commit[1].
2322
Michael J Gruber4b2343f2010-05-20 17:55:42 +02002323status.submodulesummary::
2324 Defaults to false.
2325 If this is set to a non zero number or true (identical to -1 or an
2326 unlimited number), the submodule summary will be enabled and a
2327 summary of commits for modified submodules will be shown (see
Jens Lehmannbb58b692013-09-11 21:07:15 +02002328 --summary-limit option of linkgit:git-submodule[1]). Please note
2329 that the summary output command will be suppressed for all
2330 submodules when `diff.ignoreSubmodules` is set to 'all' or only
Jens Lehmann1d2f3932014-04-05 18:59:03 +02002331 for those submodules where `submodule.<name>.ignore=all`. The only
2332 exception to that rule is that status and commit will show staged
2333 submodule changes. To
Jens Lehmannbb58b692013-09-11 21:07:15 +02002334 also view the summary for ignored submodules you can either use
Jason St. John06ab60c2014-05-21 14:52:26 -04002335 the --ignore-submodules=dirty command-line option or the 'git
Jens Lehmannbb58b692013-09-11 21:07:15 +02002336 submodule summary' command, which shows a similar output but does
2337 not honor these settings.
Michael J Gruber4b2343f2010-05-20 17:55:42 +02002338
Jonathan Nieder0ad0a612010-07-15 02:51:19 -05002339submodule.<name>.path::
2340submodule.<name>.url::
2341submodule.<name>.update::
2342 The path within this project, URL, and the updating strategy
2343 for a submodule. These variables are initially populated
2344 by 'git submodule init'; edit them to override the
2345 URL and other values found in the `.gitmodules` file. See
2346 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2347
W. Trevor King06b1abb2012-12-19 11:03:32 -05002348submodule.<name>.branch::
2349 The remote branch name for a submodule, used by `git submodule
2350 update --remote`. Set this option to override the value found in
2351 the `.gitmodules` file. See linkgit:git-submodule[1] and
2352 linkgit:gitmodules[5] for details.
2353
Jens Lehmannc1a3c362010-11-11 00:55:41 +01002354submodule.<name>.fetchRecurseSubmodules::
Jens Lehmannbf42b382011-03-06 23:12:19 +01002355 This option can be used to control recursive fetching of this
Ralf Wildenhues469bfc92011-01-03 20:03:34 +01002356 submodule. It can be overridden by using the --[no-]recurse-submodules
Jason St. John06ab60c2014-05-21 14:52:26 -04002357 command-line option to "git fetch" and "git pull".
Jens Lehmannc1a3c362010-11-11 00:55:41 +01002358 This setting will override that from in the linkgit:gitmodules[5]
2359 file.
2360
Jens Lehmannaee9c7d2010-08-06 00:39:25 +02002361submodule.<name>.ignore::
2362 Defines under what circumstances "git status" and the diff family show
2363 a submodule as modified. When set to "all", it will never be considered
Jens Lehmann1d2f3932014-04-05 18:59:03 +02002364 modified (but it will nonetheless show up in the output of status and
2365 commit when it has been staged), "dirty" will ignore all changes
2366 to the submodules work tree and
Jens Lehmannaee9c7d2010-08-06 00:39:25 +02002367 takes only differences between the HEAD of the submodule and the commit
2368 recorded in the superproject into account. "untracked" will additionally
2369 let submodules with modified tracked files in their work tree show up.
2370 Using "none" (the default when this option is not set) also shows
2371 submodules that have untracked files in their work tree as changed.
Jens Lehmann302ad7a2010-08-06 00:40:48 +02002372 This setting overrides any setting made in .gitmodules for this submodule,
Ralf Wildenhues3776ea92010-08-22 13:12:12 +02002373 both settings can be overridden on the command line by using the
Jens Lehmannbb58b692013-09-11 21:07:15 +02002374 "--ignore-submodules" option. The 'git submodule' commands are not
2375 affected by this setting.
Jens Lehmannaee9c7d2010-08-06 00:39:25 +02002376
Jacob Kellerb1507942014-07-16 14:48:02 -07002377tag.sort::
2378 This variable controls the sort ordering of tags when displayed by
2379 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2380 value of this variable will be used as the default.
2381
Willy Tarreauce1a79b2006-07-20 11:30:44 +02002382tar.umask::
René Scharfe687157c2007-08-21 20:01:16 +02002383 This variable can be used to restrict the permission bits of
2384 tar archive entries. The default is 0002, which turns off the
2385 world write bit. The special value "user" indicates that the
2386 archiving user's umask will be used instead. See umask(2) and
Dan McGee5162e692007-12-29 00:20:38 -06002387 linkgit:git-archive[1].
Willy Tarreauce1a79b2006-07-20 11:30:44 +02002388
Junio C Hamanodab76d32011-09-04 12:37:45 -07002389transfer.fsckObjects::
2390 When `fetch.fsckObjects` or `receive.fsckObjects` are
2391 not set, the value of this variable is used instead.
2392 Defaults to false.
2393
Junio C Hamanodaebaa72013-01-18 16:08:30 -08002394transfer.hiderefs::
2395 This variable can be used to set both `receive.hiderefs`
2396 and `uploadpack.hiderefs` at the same time to the same
2397 values. See entries for these other variables.
2398
Matt McCutchenb0f34c32008-11-26 03:26:50 -05002399transfer.unpackLimit::
2400 When `fetch.unpackLimit` or `receive.unpackLimit` are
2401 not set, the value of this variable is used instead.
2402 The default value is 100.
2403
Scott J. Goldman7671b632014-02-28 05:04:19 -05002404uploadarchive.allowUnreachable::
2405 If true, allow clients to use `git archive --remote` to request
2406 any tree, whether reachable from the ref tips or not. See the
2407 discussion in the `SECURITY` section of
2408 linkgit:git-upload-archive[1] for more details. Defaults to
2409 `false`.
2410
Junio C Hamanodaebaa72013-01-18 16:08:30 -08002411uploadpack.hiderefs::
2412 String(s) `upload-pack` uses to decide which refs to omit
2413 from its initial advertisement. Use more than one
2414 definitions to specify multiple prefix strings. A ref that
2415 are under the hierarchies listed on the value of this
2416 variable is excluded, and is hidden from `git ls-remote`,
2417 `git fetch`, etc. An attempt to fetch a hidden ref by `git
Junio C Hamano390eb362013-01-28 21:49:57 -08002418 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2419
2420uploadpack.allowtipsha1inwant::
2421 When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2422 to accept a fetch request that asks for an object at the tip
2423 of a hidden ref (by default, such a request is rejected).
2424 see also `uploadpack.hiderefs`.
Junio C Hamanodaebaa72013-01-18 16:08:30 -08002425
Jeff King05e95152013-09-08 05:01:31 -04002426uploadpack.keepalive::
2427 When `upload-pack` has started `pack-objects`, there may be a
2428 quiet period while `pack-objects` prepares the pack. Normally
2429 it would output progress information, but if `--quiet` was used
2430 for the fetch, `pack-objects` will output nothing at all until
2431 the pack data begins. Some clients and networks may consider
2432 the server to be hung and give up. Setting this option instructs
2433 `upload-pack` to send an empty keepalive packet every
2434 `uploadpack.keepalive` seconds. Setting this option to 0
Jeff King115dedd2013-09-08 05:02:06 -04002435 disables keepalive packets entirely. The default is 5 seconds.
Jeff King05e95152013-09-08 05:01:31 -04002436
Daniel Barkalow55029ae2008-02-20 13:43:53 -05002437url.<base>.insteadOf::
2438 Any URL that starts with this value will be rewritten to
2439 start, instead, with <base>. In cases where some site serves a
2440 large number of repositories, and serves them with multiple
2441 access methods, and some users need to use different access
2442 methods, this feature allows people to specify any of the
Thomas Ackermann2de9b712013-01-21 20:17:53 +01002443 equivalent URLs and have Git automatically rewrite the URL to
Daniel Barkalow55029ae2008-02-20 13:43:53 -05002444 the best alternative for the particular user, even for a
Junio C Hamano844112c2008-02-24 22:25:04 -08002445 never-before-seen repository on the site. When more than one
2446 insteadOf strings match a given URL, the longest match is used.
Daniel Barkalow55029ae2008-02-20 13:43:53 -05002447
Josh Triplett1c2eafb2009-09-07 01:56:33 -07002448url.<base>.pushInsteadOf::
2449 Any URL that starts with this value will not be pushed to;
2450 instead, it will be rewritten to start with <base>, and the
2451 resulting URL will be pushed to. In cases where some site serves
2452 a large number of repositories, and serves them with multiple
2453 access methods, some of which do not allow push, this feature
Thomas Ackermann2de9b712013-01-21 20:17:53 +01002454 allows people to specify a pull-only URL and have Git
Josh Triplett1c2eafb2009-09-07 01:56:33 -07002455 automatically use an appropriate URL to push, even for a
2456 never-before-seen repository on the site. When more than one
2457 pushInsteadOf strings match a given URL, the longest match is
Thomas Ackermann2de9b712013-01-21 20:17:53 +01002458 used. If a remote has an explicit pushurl, Git will ignore this
Josh Triplett1c2eafb2009-09-07 01:56:33 -07002459 setting for that remote.
2460
Petr Baudis1ab661d2006-04-25 00:59:33 +02002461user.email::
2462 Your email address to be recorded in any newly created commits.
Josh Triplett28a94f82007-04-28 18:40:28 -07002463 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Dan McGee5162e692007-12-29 00:20:38 -06002464 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02002465
2466user.name::
2467 Your full name to be recorded in any newly created commits.
Horst H. von Brandabda1ef2006-06-03 16:27:26 -04002468 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Dan McGee5162e692007-12-29 00:20:38 -06002469 environment variables. See linkgit:git-commit-tree[1].
Petr Baudis1ab661d2006-04-25 00:59:33 +02002470
Andy Parkinsd67778e2007-01-26 14:13:46 +00002471user.signingkey::
Nicolas Vigierf0551692013-10-14 19:04:36 +02002472 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2473 key you want it to automatically when creating a signed tag or
2474 commit, you can override the default selection with this variable.
2475 This option is passed unchanged to gpg's --local-user parameter,
2476 so you may specify a key using any method that gpg supports.
Andy Parkinsd67778e2007-01-26 14:13:46 +00002477
Christian Couder983a9ee2008-01-08 04:55:14 +01002478web.browser::
2479 Specify a web browser that may be used by some commands.
2480 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2481 may use it.