blob: 2e5ceaf71974b1e5404de79103648da1829eaf42 [file] [log] [blame]
Junio C Hamano07824ce2006-04-25 07:36:541CONFIGURATION FILE
2------------------
3
Junio C Hamano076ffcc2013-02-06 05:13:214The Git configuration file contains a number of variables that affect
5the Git commands' behavior. The `.git/config` file in each repository
Junio C Hamanof4581102009-04-25 08:29:596is used to store the configuration for that repository, and
7`$HOME/.gitconfig` is used to store a per-user configuration as
8fallback values for the `.git/config` file. The file `/etc/gitconfig`
9can be used to store a system-wide default configuration.
Junio C Hamano8f76dc62007-01-17 07:24:2510
Junio C Hamano076ffcc2013-02-06 05:13:2111The configuration variables are used by both the Git plumbing
Junio C Hamanof4581102009-04-25 08:29:5912and the porcelains. The variables are divided into sections, wherein
13the fully qualified variable name of the variable itself is the last
Junio C Hamano07824ce2006-04-25 07:36:5414dot-separated segment and the section name is everything before the last
Junio C Hamano81d540a2012-03-02 19:52:4715dot. The variable names are case-insensitive, allow only alphanumeric
16characters and `-`, and must start with an alphabetic character. Some
Junio C Hamano07622622015-03-20 21:47:2617variables may appear multiple times; we say then that the variable is
18multivalued.
Junio C Hamano07824ce2006-04-25 07:36:5419
Junio C Hamanobee172f2007-01-23 08:44:1820Syntax
21~~~~~~
22
Junio C Hamano07824ce2006-04-25 07:36:5423The syntax is fairly flexible and permissive; whitespaces are mostly
Junio C Hamanobee172f2007-01-23 08:44:1824ignored. The '#' and ';' characters begin comments to the end of line,
25blank lines are ignored.
26
27The file consists of sections and variables. A section begins with
28the name of the section in square brackets and continues until the next
Junio C Hamano07622622015-03-20 21:47:2629section begins. Section names are case-insensitive. Only alphanumeric
Junio C Hamanoea82cff2009-03-18 01:54:4830characters, `-` and `.` are allowed in section names. Each variable
Junio C Hamanof4581102009-04-25 08:29:5931must belong to some section, which means that there must be a section
32header before the first setting of a variable.
Junio C Hamanobee172f2007-01-23 08:44:1833
34Sections can be further divided into subsections. To begin a subsection
35put its name in double quotes, separated by space from the section name,
Junio C Hamanof4581102009-04-25 08:29:5936in the section header, like in the example below:
Junio C Hamanobee172f2007-01-23 08:44:1837
38--------
39[section "subsection"]
40
41--------
42
Junio C Hamanof4581102009-04-25 08:29:5943Subsection names are case sensitive and can contain any characters except
Junio C Hamano07622622015-03-20 21:47:2644newline (doublequote `"` and backslash can be included by escaping them
45as `\"` and `\\`, respectively). Section headers cannot span multiple
Junio C Hamanobee172f2007-01-23 08:44:1846lines. Variables may belong directly to a section or to a given subsection.
47You can have `[section]` if you have `[section "subsection"]`, but you
48don't need to.
49
Junio C Hamano6231f822011-10-24 05:18:5250There is also a deprecated `[section.subsection]` syntax. With this
51syntax, the subsection name is converted to lower-case and is also
52compared case sensitively. These subsection names follow the same
53restrictions as section names.
Junio C Hamanobee172f2007-01-23 08:44:1854
Junio C Hamanoaa2cd762009-07-26 08:14:0155All the other lines (and the remainder of the line after the section
56header) are recognized as setting variables, in the form
Junio C Hamano07622622015-03-20 21:47:2657'name = value' (or just 'name', which is a short-hand to say that
58the variable is the boolean "true").
Junio C Hamano81d540a2012-03-02 19:52:4759The variable names are case-insensitive, allow only alphanumeric characters
Junio C Hamano07622622015-03-20 21:47:2660and `-`, and must start with an alphabetic character.
Junio C Hamanobee172f2007-01-23 08:44:1861
Junio C Hamano07622622015-03-20 21:47:2662A line that defines a value can be continued to the next line by
63ending it with a `\`; the backquote and the end-of-line are
64stripped. Leading whitespaces after 'name =', the remainder of the
65line after the first comment character '#' or ';', and trailing
66whitespaces of the line are discarded unless they are enclosed in
67double quotes. Internal whitespaces within the value are retained
68verbatim.
Junio C Hamanobee172f2007-01-23 08:44:1869
Junio C Hamano07622622015-03-20 21:47:2670Inside double quotes, double quote `"` and backslash `\` characters
71must be escaped: use `\"` for `"` and `\\` for `\`.
Junio C Hamanobee172f2007-01-23 08:44:1872
Junio C Hamanoea82cff2009-03-18 01:54:4873The following escape sequences (beside `\"` and `\\`) are recognized:
74`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
Junio C Hamanod75148a2014-04-08 19:48:3875and `\b` for backspace (BS). Other char escape sequences (including octal
76escape sequences) are invalid.
Junio C Hamanobee172f2007-01-23 08:44:1877
Junio C Hamano07824ce2006-04-25 07:36:5478
Junio C Hamanoe0238c22012-02-23 22:45:5079Includes
80~~~~~~~~
81
82You can include one config file from another by setting the special
83`include.path` variable to the name of the file to be included. The
84included file is expanded immediately, as if its contents had been
85found at the location of the include directive. If the value of the
86`include.path` variable is a relative path, the path is considered to be
87relative to the configuration file in which the include directive was
Junio C Hamano22700fb2012-05-03 23:07:2588found. The value of `include.path` is subject to tilde expansion: `~/`
89is expanded to the value of `$HOME`, and `~user/` to the specified
Junio C Hamano4d61c4a2012-04-30 01:10:2290user's home directory. See below for examples.
Junio C Hamanoe0238c22012-02-23 22:45:5091
Junio C Hamano07824ce2006-04-25 07:36:5492Example
93~~~~~~~
94
95# Core variables
96[core]
97; Don't trust file modes
98filemode = false
99
100# Our diff algorithm
101[diff]
Junio C Hamano85c71572008-07-28 00:03:31102external = /usr/local/bin/diff-wrapper
Junio C Hamano07824ce2006-04-25 07:36:54103renames = true
104
Junio C Hamano52401ef2006-12-19 00:54:38105[branch "devel"]
106remote = origin
107merge = refs/heads/devel
108
Junio C Hamanobee172f2007-01-23 08:44:18109# Proxy settings
110[core]
Junio C Hamanoc71a8732007-08-04 00:27:26111gitProxy="ssh" for "kernel.org"
Junio C Hamanobee172f2007-01-23 08:44:18112gitProxy=default-proxy ; for the rest
Junio C Hamano52401ef2006-12-19 00:54:38113
Junio C Hamanoe0238c22012-02-23 22:45:50114[include]
115path = /path/to/foo.inc ; include by absolute path
116path = foo ; expand "foo" relative to the current file
Junio C Hamano4d61c4a2012-04-30 01:10:22117path = ~/foo ; expand "foo" in your $HOME directory
Junio C Hamanoe0238c22012-02-23 22:45:50118
Junio C Hamano07622622015-03-20 21:47:26119
120Values
121~~~~~~
122
123Values of many variables are treated as a simple string, but there
124are variables that take values of specific types and there are rules
125as to how to spell them.
126
127boolean::
128
129 When a variable is said to take a boolean value, many
130 synonyms are accepted for 'true' and 'false'; these are all
131 case-insensitive.
132
133 true;; Boolean true can be spelled as `yes`, `on`, `true`,
134or `1`. Also, a variable defined without `= <value>`
135is taken as true.
136
137 false;; Boolean false can be spelled as `no`, `off`,
138`false`, or `0`.
139+
140When converting value to the canonical form using '--bool' type
141specifier; 'git config' will ensure that the output is "true" or
142"false" (spelled in lowercase).
143
144integer::
145 The value for many variables that specify various sizes can
146 be suffixed with `k`, `M`,... to mean "scale the number by
147 1024", "by 1024x1024", etc.
148
149color::
150 The value for a variables that takes a color is a list of
151 colors (at most two) and attributes (at most one), separated
152 by spaces. The colors accepted are `normal`, `black`,
153 `red`, `green`, `yellow`, `blue`, `magenta`, `cyan` and
154 `white`; the attributes are `bold`, `dim`, `ul`, `blink` and
155 `reverse`. The first color given is the foreground; the
156 second is the background. The position of the attribute, if
157 any, doesn't matter. Attributes may be turned off specifically
158 by prefixing them with `no` (e.g., `noreverse`, `noul`, etc).
159+
160Colors (foreground and background) may also be given as numbers between
1610 and 255; these use ANSI 256-color mode (but note that not all
162terminals may support this). If your terminal supports it, you may also
163specify 24-bit RGB values as hex, like `#ff0ab3`.
164+
165The attributes are meant to be reset at the beginning of each item
166in the colored output, so setting color.decorate.branch to `black`
167will paint that branch name in a plain `black`, even if the previous
168thing on the same output line (e.g. opening parenthesis before the
169list of branch names in `log --decorate` output) is set to be
170painted with `bold` or some other attribute.
171
172
Junio C Hamano07824ce2006-04-25 07:36:54173Variables
174~~~~~~~~~
175
176Note that this list is non-comprehensive and not necessarily complete.
Junio C Hamanof1d14802006-06-08 00:48:17177For command-specific variables, you will find a more detailed description
Junio C Hamano52b6ba32014-04-01 00:26:48178in the appropriate manual page.
179
180Other git-related tools may and do use their own variables. When
181inventing new variables for use in your own tool, make sure their
182names do not conflict with those that are used by Git itself and
183other popular tools, and describe them in your documentation.
184
Junio C Hamano07824ce2006-04-25 07:36:54185
Junio C Hamano7df6dcf2009-09-13 09:51:17186advice.*::
Junio C Hamano0df92712011-12-21 22:30:44187These variables control various optional help messages designed to
188aid new users. All 'advice.*' variables default to 'true', and you
189can tell Git that you do not need help by setting these to 'false':
Junio C Hamano7df6dcf2009-09-13 09:51:17190+
191--
Junio C Hamanoabad6da2013-01-06 09:06:32192pushUpdateRejected::
Junio C Hamano0c1b64e2012-04-20 23:50:49193Set this variable to 'false' if you want to disable
Junio C Hamano1d669b82014-03-11 21:36:00194'pushNonFFCurrent',
Junio C Hamano3f2ed6f2013-02-04 19:24:09195'pushNonFFMatching', 'pushAlreadyExists',
196'pushFetchFirst', and 'pushNeedsForce'
Junio C Hamanoabad6da2013-01-06 09:06:32197simultaneously.
Junio C Hamano0c1b64e2012-04-20 23:50:49198pushNonFFCurrent::
199Advice shown when linkgit:git-push[1] fails due to a
200non-fast-forward update to the current branch.
Junio C Hamano0c1b64e2012-04-20 23:50:49201pushNonFFMatching::
202Advice shown when you ran linkgit:git-push[1] and pushed
203'matching refs' explicitly (i.e. you used ':', or
204specified a refspec that isn't your current branch) and
205it resulted in a non-fast-forward error.
Junio C Hamanoabad6da2013-01-06 09:06:32206pushAlreadyExists::
207Shown when linkgit:git-push[1] rejects an update that
208does not qualify for fast-forwarding (e.g., a tag.)
Junio C Hamano3f2ed6f2013-02-04 19:24:09209pushFetchFirst::
210Shown when linkgit:git-push[1] rejects an update that
211tries to overwrite a remote ref that points at an
212object we do not have.
213pushNeedsForce::
214Shown when linkgit:git-push[1] rejects an update that
215tries to overwrite a remote ref that points at an
Junio C Hamanoe6f28d02013-09-17 21:34:00216object that is not a commit-ish, or make the remote
217ref point at an object that is not a commit-ish.
Junio C Hamano7df6dcf2009-09-13 09:51:17218statusHints::
Junio C Hamano644936c2012-06-28 23:05:14219Show directions on how to proceed from the current
Junio C Hamano917cd4f2012-12-04 23:41:10220state in the output of linkgit:git-status[1], in
Junio C Hamano644936c2012-06-28 23:05:14221the template shown when writing commit messages in
Junio C Hamano917cd4f2012-12-04 23:41:10222linkgit:git-commit[1], and in the help message shown
223by linkgit:git-checkout[1] when switching branch.
Junio C Hamano5e7f1312013-03-21 22:49:01224statusUoption::
225Advise to consider using the `-u` option to linkgit:git-status[1]
226when the command takes more than 2 seconds to enumerate untracked
227files.
Junio C Hamano5706e0b2009-11-24 10:54:16228commitBeforeMerge::
229Advice shown when linkgit:git-merge[1] refuses to
Junio C Hamano619596a2010-08-18 22:15:35230merge to avoid overwriting local changes.
Junio C Hamanoa9701f02010-01-21 00:42:16231resolveConflict::
Junio C Hamano5dab5a92013-02-25 18:51:24232Advice shown by various commands when conflicts
Junio C Hamanoa9701f02010-01-21 00:42:16233prevent the operation from being performed.
Junio C Hamanoa9701f02010-01-21 00:42:16234implicitIdentity::
235Advice on how to set your identity configuration when
236your information is guessed from the system username and
Junio C Hamano0df92712011-12-21 22:30:44237domain name.
Junio C Hamano74a198f2010-02-22 00:13:31238detachedHead::
Junio C Hamano0df92712011-12-21 22:30:44239Advice shown when you used linkgit:git-checkout[1] to
Junio C Hamano74a198f2010-02-22 00:13:31240move to the detach HEAD state, to instruct how to create
Junio C Hamano0df92712011-12-21 22:30:44241a local branch after the fact.
Junio C Hamanobb300642012-07-22 21:09:14242amWorkDir::
243Advice that shows the location of the patch file when
244linkgit:git-am[1] fails to apply it.
Junio C Hamano8ab94942013-06-24 21:55:30245rmHints::
246In case of failure in the output of linkgit:git-rm[1],
247show directions on how to proceed from the current state.
Junio C Hamano7df6dcf2009-09-13 09:51:17248--
249
Junio C Hamano07824ce2006-04-25 07:36:54250core.fileMode::
Junio C Hamanod2c28482014-10-24 22:28:25251Tells Git if the executable bit of files in the working tree
252is to be honored.
Junio C Hamano9df0c662009-11-23 11:09:27253+
Junio C Hamanod2c28482014-10-24 22:28:25254Some filesystems lose the executable bit when a file that is
255marked as executable is checked out, or checks out an
256non-executable file with executable bit on.
257linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
258to see if it handles the executable bit correctly
259and this variable is automatically set as necessary.
260+
261A repository, however, may be on a filesystem that handles
262the filemode correctly, and this variable is set to 'true'
263when created, but later may be made accessible from another
264environment that loses the filemode (e.g. exporting ext4 via
265CIFS mount, visiting a Cygwin created repository with
266Git for Windows or Eclipse).
267In such a case it may be necessary to set this variable to 'false'.
268See linkgit:git-update-index[1].
269+
270The default is true (when core.filemode is not specified in the config file).
Junio C Hamano07824ce2006-04-25 07:36:54271
Junio C Hamano322c6242015-03-23 21:32:46272core.ignoreCase::
Junio C Hamano9df0c662009-11-23 11:09:27273If true, this option enables various workarounds to enable
Junio C Hamano076ffcc2013-02-06 05:13:21274Git to work better on filesystems that are not case sensitive,
Junio C Hamano9df0c662009-11-23 11:09:27275like FAT. For example, if a directory listing finds
Junio C Hamano076ffcc2013-02-06 05:13:21276"makefile" when Git expects "Makefile", Git will assume
Junio C Hamano9df0c662009-11-23 11:09:27277it is really the same file, and continue to remember it as
278"Makefile".
279+
280The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
Junio C Hamano322c6242015-03-23 21:32:46281will probe and set core.ignoreCase true if appropriate when the repository
Junio C Hamano9df0c662009-11-23 11:09:27282is created.
283
Junio C Hamano322c6242015-03-23 21:32:46284core.precomposeUnicode::
Junio C Hamano076ffcc2013-02-06 05:13:21285This option is only used by Mac OS implementation of Git.
Junio C Hamano322c6242015-03-23 21:32:46286When core.precomposeUnicode=true, Git reverts the unicode decomposition
Junio C Hamanob61a7772012-07-13 23:34:48287of filenames done by Mac OS. This is useful when sharing a repository
288between Mac OS and Linux or Windows.
Junio C Hamano076ffcc2013-02-06 05:13:21289(Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
290When false, file names are handled fully transparent by Git,
291which is backward compatible with older versions of Git.
Junio C Hamanob61a7772012-07-13 23:34:48292
Junio C Hamano30758bd2014-12-18 20:44:14293core.protectHFS::
294If set to true, do not allow checkout of paths that would
295be considered equivalent to `.git` on an HFS+ filesystem.
296Defaults to `true` on Mac OS, and `false` elsewhere.
297
298core.protectNTFS::
299If set to true, do not allow checkout of paths that would
300cause problems with the NTFS filesystem, e.g. conflict with
3018.3 "short" names.
302Defaults to `true` on Windows, and `false` elsewhere.
303
Junio C Hamano90ccff32008-07-29 08:17:24304core.trustctime::
305If false, the ctime differences between the index and the
Junio C Hamano8fb66e52011-10-05 20:59:51306working tree are ignored; useful when the inode change time
Junio C Hamano90ccff32008-07-29 08:17:24307is regularly modified by something outside Git (file system
308crawlers and some backup systems).
309See linkgit:git-update-index[1]. True by default.
310
Junio C Hamano322c6242015-03-23 21:32:46311core.checkStat::
Junio C Hamano4cfed0c2013-01-30 17:58:54312Determines which stat fields to match between the index
313and work tree. The user can set this to 'default' or
314'minimal'. Default (or explicitly 'default'), is to check
315all fields, including the sub-second part of mtime and ctime.
316
Junio C Hamano322c6242015-03-23 21:32:46317core.quotePath::
Junio C Hamanoba4b9282008-07-06 05:20:31318The commands that output paths (e.g. 'ls-files',
319'diff'), when not given the `-z` option, will quote
Junio C Hamanod526ba92007-07-02 00:17:42320"unusual" characters in the pathname by enclosing the
321pathname in a double-quote pair and with backslashes the
322same way strings in C source code are quoted. If this
323variable is set to false, the bytes higher than 0x80 are
324not quoted but output as verbatim. Note that double
325quote, backslash and control characters are always
326quoted without `-z` regardless of the setting of this
327variable.
328
Junio C Hamanobb88cf42010-06-21 15:23:55329core.eol::
330Sets the line ending type to use in the working directory for
331files that have the `text` property set. Alternatives are
332'lf', 'crlf' and 'native', which uses the platform's native
333line ending. The default value is `native`. See
334linkgit:gitattributes[5] for more information on end-of-line
335conversion.
Junio C Hamanod9e0e5d2007-04-14 16:22:04336
Junio C Hamano26e590a2008-02-17 03:53:51337core.safecrlf::
Junio C Hamano076ffcc2013-02-06 05:13:21338If true, makes Git check if converting `CRLF` is reversible when
Junio C Hamanobb88cf42010-06-21 15:23:55339end-of-line conversion is active. Git will verify if a command
Junio C Hamano26e590a2008-02-17 03:53:51340modifies a file in the work tree either directly or indirectly.
341For example, committing a file followed by checking out the
342same file should yield the original file in the work tree. If
343this is not the case for the current setting of
Junio C Hamano076ffcc2013-02-06 05:13:21344`core.autocrlf`, Git will reject the file. The variable can
345be set to "warn", in which case Git will only warn about an
Junio C Hamano26e590a2008-02-17 03:53:51346irreversible conversion but continue the operation.
347+
348CRLF conversion bears a slight chance of corrupting data.
Junio C Hamano076ffcc2013-02-06 05:13:21349When it is enabled, Git will convert CRLF to LF during commit and LF to
Junio C Hamano26e590a2008-02-17 03:53:51350CRLF during checkout. A file that contains a mixture of LF and
Junio C Hamano076ffcc2013-02-06 05:13:21351CRLF before the commit cannot be recreated by Git. For text
Junio C Hamano26e590a2008-02-17 03:53:51352files this is the right thing to do: it corrects line endings
353such that we have only LF line endings in the repository.
354But for binary files that are accidentally classified as text the
355conversion can corrupt data.
356+
357If you recognize such corruption early you can easily fix it by
358setting the conversion type explicitly in .gitattributes. Right
359after committing you still have the original file in your work
360tree and this file is not yet corrupted. You can explicitly tell
Junio C Hamano076ffcc2013-02-06 05:13:21361Git that this file is binary and Git will handle the file
Junio C Hamano26e590a2008-02-17 03:53:51362appropriately.
363+
364Unfortunately, the desired effect of cleaning up text files with
365mixed line endings and the undesired effect of corrupting binary
366files cannot be distinguished. In both cases CRLFs are removed
367in an irreversible way. For text files this is the right thing
368to do because CRLFs are line endings, while for binary files
369converting CRLFs corrupts data.
370+
371Note, this safety check does not mean that a checkout will generate a
372file identical to the original file for a different setting of
Junio C Hamanobb88cf42010-06-21 15:23:55373`core.eol` and `core.autocrlf`, but only for the current one. For
374example, a text file with `LF` would be accepted with `core.eol=lf`
375and could later be checked out with `core.eol=crlf`, in which case the
Junio C Hamano26e590a2008-02-17 03:53:51376resulting file would contain `CRLF`, although the original file
377contained `LF`. However, in both work trees the line endings would be
378consistent, that is either all `LF` or all `CRLF`, but never mixed. A
379file with mixed line endings would be reported by the `core.safecrlf`
380mechanism.
381
Junio C Hamanobb88cf42010-06-21 15:23:55382core.autocrlf::
383Setting this variable to "true" is almost the same as setting
384the `text` attribute to "auto" on all files except that text
385files are not guaranteed to be normalized: files that contain
386`CRLF` in the repository will not be touched. Use this
387setting if you want to have `CRLF` line endings in your
388working directory even though the repository does not have
389normalized line endings. This variable can be set to 'input',
390in which case no output conversion is performed.
391
Junio C Hamanoaa83a7d2007-03-05 02:37:29392core.symlinks::
393If false, symbolic links are checked out as small plain files that
Junio C Hamano35738e82008-01-07 07:55:46394contain the link text. linkgit:git-update-index[1] and
395linkgit:git-add[1] will not change the recorded type to regular
Junio C Hamanoaa83a7d2007-03-05 02:37:29396file. Useful on filesystems like FAT that do not support
Junio C Hamano9df0c662009-11-23 11:09:27397symbolic links.
398+
399The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
400will probe and set core.symlinks false if appropriate when the repository
401is created.
Junio C Hamanoaa83a7d2007-03-05 02:37:29402
Junio C Hamano07824ce2006-04-25 07:36:54403core.gitProxy::
404A "proxy command" to execute (as 'command host port') instead
405of establishing direct connection to the remote server when
Junio C Hamano076ffcc2013-02-06 05:13:21406using the Git protocol for fetching. If the variable value is
Junio C Hamano07824ce2006-04-25 07:36:54407in the "COMMAND for DOMAIN" format, the command is applied only
408on hostnames ending with the specified domain string. This variable
409may be set multiple times and is matched in the given order;
410the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17411+
412Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
413(which always applies universally, without the special "for"
414handling).
Junio C Hamanoea82cff2009-03-18 01:54:48415+
416The special string `none` can be used as the proxy command to
417specify that no proxy be used for a given domain pattern.
418This is useful for excluding servers inside a firewall from
419proxy use, while defaulting to a common proxy for external domains.
Junio C Hamano07824ce2006-04-25 07:36:54420
421core.ignoreStat::
Junio C Hamanoe8acc8e2015-01-14 22:01:34422If true, Git will avoid using lstat() calls to detect if files have
423changed by setting the "assume-unchanged" bit for those tracked files
424which it has updated identically in both the index and working tree.
425+
426When files are modified outside of Git, the user will need to stage
427the modified files explicitly (e.g. see 'Examples' section in
428linkgit:git-update-index[1]).
429Git will not normally detect changes to those files.
430+
431This is useful on systems where lstat() calls are very slow, such as
432CIFS/Microsoft Windows.
433+
434False by default.
Junio C Hamano07824ce2006-04-25 07:36:54435
Junio C Hamano88a3a072006-05-04 08:01:43436core.preferSymlinkRefs::
437Instead of the default "symref" format for HEAD
438and other symbolic reference files, use symbolic links.
439This is sometimes needed to work with old scripts that
440expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54441
Junio C Hamano1025e752007-02-23 07:21:26442core.bare::
443If true this repository is assumed to be 'bare' and has no
444working directory associated with it. If this is the case a
445number of commands that require a working directory will be
Junio C Hamano35738e82008-01-07 07:55:46446disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Junio C Hamano1025e752007-02-23 07:21:26447+
Junio C Hamano35738e82008-01-07 07:55:46448This setting is automatically guessed by linkgit:git-clone[1] or
449linkgit:git-init[1] when the repository was created. By default a
Junio C Hamano1025e752007-02-23 07:21:26450repository that ends in "/.git" is assumed to be not bare (bare =
451false), while all other repositories are assumed to be bare (bare
452= true).
453
Junio C Hamanod526ba92007-07-02 00:17:42454core.worktree::
Junio C Hamano80d58462011-01-24 22:52:52455Set the path to the root of the working tree.
Junio C Hamano764a6672007-10-23 01:23:31456This can be overridden by the GIT_WORK_TREE environment
Junio C Hamanoe1aeb5e2014-06-06 19:16:29457variable and the '--work-tree' command-line option.
Junio C Hamano5cd15182011-04-05 00:21:10458The value can be an absolute path or relative to the path to
Junio C Hamano80d58462011-01-24 22:52:52459the .git directory, which is either specified by --git-dir
460or GIT_DIR, or automatically discovered.
461If --git-dir or GIT_DIR is specified but none of
Junio C Hamano7d575a52008-04-30 08:45:27462--work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamano80d58462011-01-24 22:52:52463the current working directory is regarded as the top level
Junio C Hamano3609b332010-12-29 01:34:52464of your working tree.
Junio C Hamano80d58462011-01-24 22:52:52465+
466Note that this variable is honored even when set in a configuration
467file in a ".git" subdirectory of a directory and its value differs
468from the latter directory (e.g. "/path/to/.git/config" has
469core.worktree set to "/different/path"), which is most likely a
Junio C Hamano076ffcc2013-02-06 05:13:21470misconfiguration. Running Git commands in the "/path/to" directory will
Junio C Hamano80d58462011-01-24 22:52:52471still use "/different/path" as the root of the work tree and can cause
472confusion unless you know what you are doing (e.g. you are creating a
473read-only snapshot of the same index to a location different from the
474repository's usual working tree).
Junio C Hamanod526ba92007-07-02 00:17:42475
Junio C Hamano341071d2006-06-04 07:24:48476core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49477Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamanoa2ec14f2006-11-02 00:22:48478"$GIT_DIR/logs/<ref>", by appending the new and old
Junio C Hamanoe3f080d2013-04-22 02:27:13479SHA-1, the date/time and the reason of the update, but
Junio C Hamanoa2ec14f2006-11-02 00:22:48480only when the file exists. If this configuration
481variable is set to true, missing "$GIT_DIR/logs/<ref>"
Junio C Hamano15567bc2011-07-23 00:51:59482file is automatically created for branch heads (i.e. under
483refs/heads/), remote refs (i.e. under refs/remotes/),
484note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
Junio C Hamano1caaf472006-12-31 08:29:35485+
486This information can be used to determine what commit
487was the tip of a branch "2 days ago".
488+
489This value is true by default in a repository that has
490a working directory associated with it, and false by
491default in a bare repository.
Junio C Hamano341071d2006-06-04 07:24:48492
Junio C Hamano07824ce2006-04-25 07:36:54493core.repositoryFormatVersion::
494Internal variable identifying the repository format and layout
495version.
496
497core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42498When 'group' (or 'true'), the repository is made shareable between
499several users in a group (making sure all the files and objects are
500group-writable). When 'all' (or 'world' or 'everybody'), the
501repository will be readable by all users, additionally to being
Junio C Hamano076ffcc2013-02-06 05:13:21502group-shareable. When 'umask' (or 'false'), Git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37503reported by umask(2). When '0xxx', where '0xxx' is an octal number,
504files in the repository will have this mode value. '0xxx' will override
Junio C Hamano83eded12009-04-20 08:18:00505user's umask value (whereas the other options will only override
506requested parts of the user's umask value). Examples: '0660' will make
507the repo read/write-able for the owner and group, but inaccessible to
508others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Junio C Hamano2f102bb2008-04-26 02:23:37509repository that is group-readable but not group-writable.
510See linkgit:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54511
512core.warnAmbiguousRefs::
Junio C Hamano076ffcc2013-02-06 05:13:21513If true, Git will warn you if the ref name you passed it is ambiguous
Junio C Hamano947ab822013-03-19 23:07:29514and might match multiple refs in the repository. True by default.
Junio C Hamano07824ce2006-04-25 07:36:54515
Junio C Hamano7ec15722006-07-07 02:03:59516core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09517An integer -1..9, indicating a default compression level.
518-1 is the zlib default. 0 means no compression,
519and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42520If set, this provides a default to other compression variables,
Junio C Hamano322c6242015-03-23 21:32:46521such as 'core.looseCompression' and 'pack.compression'.
Junio C Hamanoa126a3b2006-07-04 04:55:26522
Junio C Hamano322c6242015-03-23 21:32:46523core.looseCompression::
Junio C Hamanof2ce2972007-05-20 19:12:09524An integer -1..9, indicating the compression level for objects that
525are not in a pack file. -1 is the zlib default. 0 means no
526compression, and 1..9 are various speed/size tradeoffs, 9 being
527slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42528not set, defaults to 1 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49529
Junio C Hamanofc4d38c2007-01-08 06:53:32530core.packedGitWindowSize::
531Number of bytes of a pack file to map into memory in a
532single mapping operation. Larger window sizes may allow
533your system to process a smaller number of large pack files
534more quickly. Smaller window sizes will negatively affect
535performance due to increased calls to the operating system's
536memory manager, but may improve performance when accessing
537a large number of large pack files.
538+
539Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
540MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
541be reasonable for all users/operating systems. You probably do
542not need to adjust this value.
543+
544Common unit suffixes of 'k', 'm', or 'g' are supported.
545
546core.packedGitLimit::
547Maximum number of bytes to map simultaneously into memory
548from pack files. If Git needs to access more than this many
549bytes at once to complete an operation it will unmap existing
550regions to reclaim virtual address space within the process.
551+
552Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
553This should be reasonable for all users/operating systems, except on
554the largest projects. You probably do not need to adjust this value.
555+
556Common unit suffixes of 'k', 'm', or 'g' are supported.
557
Junio C Hamanob8c51282007-03-19 10:43:30558core.deltaBaseCacheLimit::
559Maximum number of bytes to reserve for caching base objects
Junio C Hamano619596a2010-08-18 22:15:35560that may be referenced by multiple deltified objects. By storing the
Junio C Hamanob8c51282007-03-19 10:43:30561entire decompressed base objects in a cache Git is able
562to avoid unpacking and decompressing frequently used base
563objects multiple times.
564+
Junio C Hamanoe1aeb5e2014-06-06 19:16:29565Default is 96 MiB on all platforms. This should be reasonable
Junio C Hamanob8c51282007-03-19 10:43:30566for all users/operating systems, except on the largest projects.
567You probably do not need to adjust this value.
568+
569Common unit suffixes of 'k', 'm', or 'g' are supported.
570
Junio C Hamano5c246f22010-02-03 07:34:53571core.bigFileThreshold::
572Files larger than this size are stored deflated, without
573attempting delta compression. Storing large files without
574delta compression avoids excessive memory usage, at the
Junio C Hamano8e61f1f2014-09-11 21:53:45575slight expense of increased disk usage. Additionally files
576larger than this size are always treated as binary.
Junio C Hamano5c246f22010-02-03 07:34:53577+
578Default is 512 MiB on all platforms. This should be reasonable
579for most projects as source code and other text files can still
580be delta compressed, but larger binary media files won't be.
581+
582Common unit suffixes of 'k', 'm', or 'g' are supported.
Junio C Hamano5c246f22010-02-03 07:34:53583
Junio C Hamano322c6242015-03-23 21:32:46584core.excludesFile::
Junio C Hamano5e284b42007-05-22 07:23:37585In addition to '.gitignore' (per-directory) and
Junio C Hamano076ffcc2013-02-06 05:13:21586'.git/info/exclude', Git looks into this file for patterns
Junio C Hamanob76a6862012-05-02 22:02:46587of files which are not meant to be tracked. "`~/`" is expanded
588to the value of `$HOME` and "`~user/`" to the specified user's
Junio C Hamano8edb4c72012-07-09 20:33:55589home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
590If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
591is used instead. See linkgit:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37592
Junio C Hamano322c6242015-03-23 21:32:46593core.askPass::
Junio C Hamano3fd7b262010-09-08 22:44:20594Some commands (e.g. svn and http interfaces) that interactively
595ask for a password can be told to use an external program given
596via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
597environment variable. If not set, fall back to the value of the
598'SSH_ASKPASS' environment variable or, failing that, a simple password
599prompt. The external program shall be given a suitable prompt as
Junio C Hamanoe1aeb5e2014-06-06 19:16:29600command-line argument and write the password on its STDOUT.
Junio C Hamano3fd7b262010-09-08 22:44:20601
Junio C Hamano322c6242015-03-23 21:32:46602core.attributesFile::
Junio C Hamano3b4609d2010-09-30 00:04:34603In addition to '.gitattributes' (per-directory) and
Junio C Hamano076ffcc2013-02-06 05:13:21604'.git/info/attributes', Git looks into this file for attributes
Junio C Hamano3b4609d2010-09-30 00:04:34605(see linkgit:gitattributes[5]). Path expansions are made the same
Junio C Hamano322c6242015-03-23 21:32:46606way as for `core.excludesFile`. Its default value is
Junio C Hamano8edb4c72012-07-09 20:33:55607$XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
608set or empty, $HOME/.config/git/attributes is used instead.
Junio C Hamano3b4609d2010-09-30 00:04:34609
Junio C Hamanof6002a92007-07-20 10:28:22610core.editor::
611Commands such as `commit` and `tag` that lets you edit
Junio C Hamanoa6387422007-08-25 03:54:27612messages by launching an editor uses the value of this
Junio C Hamanof6002a92007-07-20 10:28:22613variable when it is set, and the environment variable
Junio C Hamano3b70d3c2009-11-21 17:37:37614`GIT_EDITOR` is not set. See linkgit:git-var[1].
Junio C Hamanof6002a92007-07-20 10:28:22615
Junio C Hamano322c6242015-03-23 21:32:46616core.commentChar::
Junio C Hamano3f2ed6f2013-02-04 19:24:09617Commands such as `commit` and `tag` that lets you edit
618messages consider a line that begins with this character
619commented, and removes them after the editor returns
620(default '#').
Junio C Hamanoe1aeb5e2014-06-06 19:16:29621+
622If set to "auto", `git-commit` would select a character that is not
623the beginning character of any line in existing commit messages.
Junio C Hamano3f2ed6f2013-02-04 19:24:09624
Junio C Hamano6231f822011-10-24 05:18:52625sequence.editor::
Junio C Hamano778a3412013-03-28 23:24:30626Text editor used by `git rebase -i` for editing the rebase instruction file.
Junio C Hamano6231f822011-10-24 05:18:52627The value is meant to be interpreted by the shell when it is used.
628It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
629When not configured the default commit message editor is used instead.
630
Junio C Hamano28d8ede2007-07-05 05:51:38631core.pager::
Junio C Hamano0e0e0d22013-09-12 23:25:03632Text viewer for use by Git commands (e.g., 'less'). The value
633is meant to be interpreted by the shell. The order of preference
634is the `$GIT_PAGER` environment variable, then `core.pager`
635configuration, then `$PAGER`, and then the default chosen at
636compile time (usually 'less').
637+
Junio C Hamanoe1aeb5e2014-06-06 19:16:29638When the `LESS` environment variable is unset, Git sets it to `FRX`
Junio C Hamano0e0e0d22013-09-12 23:25:03639(if `LESS` environment variable is set, Git does not change it at
640all). If you want to selectively override Git's default setting
Junio C Hamanoe1aeb5e2014-06-06 19:16:29641for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
Junio C Hamano0e0e0d22013-09-12 23:25:03642be passed to the shell by Git, which will translate the final
Junio C Hamanoe1aeb5e2014-06-06 19:16:29643command to `LESS=FRX less -S`. The environment does not set the
644`S` option but the command line does, instructing less to truncate
645long lines. Similarly, setting `core.pager` to `less -+F` will
646deactivate the `F` option specified by the environment from the
647command-line, deactivating the "quit if one screen" behavior of
648`less`. One can specifically activate some flags for particular
649commands: for example, setting `pager.blame` to `less -S` enables
650line truncation only for `git blame`.
Junio C Hamanobc8d4782014-01-13 23:35:50651+
652Likewise, when the `LV` environment variable is unset, Git sets it
653to `-c`. You can override this setting by exporting `LV` with
654another value or setting `core.pager` to `lv +c`.
Junio C Hamano28d8ede2007-07-05 05:51:38655
Junio C Hamano942b35e2007-12-09 10:19:33656core.whitespace::
657A comma separated list of common whitespace problems to
Junio C Hamano1aa40d22010-01-21 17:46:43658notice. 'git diff' will use `color.diff.whitespace` to
659highlight them, and 'git apply --whitespace=error' will
Junio C Hamano3db8b412008-07-26 06:45:59660consider them as errors. You can prefix `-` to disable
661any of them (e.g. `-trailing-space`):
Junio C Hamano942b35e2007-12-09 10:19:33662+
Junio C Hamanob71a22d2009-10-17 08:23:47663* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano942b35e2007-12-09 10:19:33664 as an error (enabled by default).
665* `space-before-tab` treats a space character that appears immediately
666 before a tab character in the initial indent part of the line as an
667 error (enabled by default).
Junio C Hamano281fd392012-09-17 23:57:41668* `indent-with-non-tab` treats a line that is indented with space
669 characters instead of the equivalent tabs as an error (not enabled by
670 default).
Junio C Hamanocb39aea2010-05-09 07:24:48671* `tab-in-indent` treats a tab character in the initial indent part of
672 the line as an error (not enabled by default).
Junio C Hamanob71a22d2009-10-17 08:23:47673* `blank-at-eof` treats blank lines added at the end of file as an error
674 (enabled by default).
675* `trailing-space` is a short-hand to cover both `blank-at-eol` and
676 `blank-at-eof`.
Junio C Hamano601f3e52008-02-25 08:40:42677* `cr-at-eol` treats a carriage-return at the end of line as
678 part of the line terminator, i.e. with it, `trailing-space`
679 does not trigger if the character before such a carriage-return
680 is not a whitespace (not enabled by default).
Junio C Hamanoeef01fe2010-12-13 08:31:58681* `tabwidth=<n>` tells how many character positions a tab occupies; this
Junio C Hamano076ffcc2013-02-06 05:13:21682 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
Junio C Hamanoeef01fe2010-12-13 08:31:58683 errors. The default tab width is 8. Allowed values are 1 to 63.
Junio C Hamano942b35e2007-12-09 10:19:33684
Junio C Hamano322c6242015-03-23 21:32:46685core.fsyncObjectFiles::
Junio C Hamano9eb57532008-06-26 06:33:46686This boolean will enable 'fsync()' when writing object files.
687+
688This is a total waste of time and effort on a filesystem that orders
689data writes properly, but can be useful for filesystems that do not use
690journalling (traditional UNIX filesystems) or that only journal metadata
691and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
692
Junio C Hamano322c6242015-03-23 21:32:46693core.preloadIndex::
Junio C Hamano610d1762008-11-28 06:27:13694Enable parallel index preload for operations like 'git diff'
695+
696This can speed up operations like 'git diff' and 'git status' especially
697on filesystems like NFS that have weak caching semantics and thus
Junio C Hamanoc8c398a2014-06-16 21:14:05698relatively high IO latencies. When enabled, Git will do the
Junio C Hamano610d1762008-11-28 06:27:13699index comparison to the filesystem data in parallel, allowing
Junio C Hamanoc8c398a2014-06-16 21:14:05700overlapping IO's. Defaults to true.
Junio C Hamano610d1762008-11-28 06:27:13701
Junio C Hamanoa9499de2009-04-30 03:38:48702core.createObject::
703You can set this to 'link', in which case a hardlink followed by
704a delete of the source are used to make sure that object creation
705will not overwrite existing objects.
706+
707On some file system/operating system combinations, this is unreliable.
708Set this config setting to 'rename' there; However, This will remove the
709check that makes sure that existing object files will not get overwritten.
Junio C Hamanoe91ea772009-04-26 01:41:41710
Junio C Hamano3b70d3c2009-11-21 17:37:37711core.notesRef::
712When showing commit messages, also show notes which are stored in
Junio C Hamanoa574a092010-06-13 19:57:10713the given ref. The ref must be fully qualified. If the given
714ref does not exist, it is not an error but means that no
715notes should be printed.
Junio C Hamano3b70d3c2009-11-21 17:37:37716+
Junio C Hamanoa574a092010-06-13 19:57:10717This setting defaults to "refs/notes/commits", and it can be overridden by
718the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
Junio C Hamano3b70d3c2009-11-21 17:37:37719
Junio C Hamano3c8d6702010-01-13 23:09:03720core.sparseCheckout::
721Enable "sparse checkout" feature. See section "Sparse checkout" in
722linkgit:git-read-tree[1] for more information.
723
Junio C Hamano6371b0e2011-03-23 23:36:21724core.abbrev::
725Set the length object names are abbreviated to. If unspecified,
726many commands abbreviate to 7 hexdigits, which may not be enough
727for abbreviated object names to stay unique for sufficiently long
728time.
729
Junio C Hamano60186642010-12-02 14:18:26730add.ignoreErrors::
Junio C Hamanobe087982015-02-22 21:29:39731add.ignore-errors (deprecated)::
Junio C Hamano1aa40d22010-01-21 17:46:43732Tells 'git add' to continue adding files when some files cannot be
Junio C Hamano3d141512009-06-01 01:22:40733added due to indexing errors. Equivalent to the '--ignore-errors'
Junio C Hamanobe087982015-02-22 21:29:39734option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
735as it does not follow the usual naming convention for configuration
736variables.
Junio C Hamano3d141512009-06-01 01:22:40737
Junio C Hamano33db4372006-06-07 19:51:45738alias.*::
Junio C Hamano35738e82008-01-07 07:55:46739Command aliases for the linkgit:git[1] command wrapper - e.g.
Junio C Hamano33db4372006-06-07 19:51:45740after defining "alias.last = cat-file commit HEAD", the invocation
741"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17742confusion and troubles with script usage, aliases that
Junio C Hamano076ffcc2013-02-06 05:13:21743hide existing Git commands are ignored. Arguments are split by
Junio C Hamanof1d14802006-06-08 00:48:17744spaces, the usual shell quoting and escaping is supported.
Junio C Hamano2efd5e42014-11-10 22:38:52745A quote pair or a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39746+
747If the alias expansion is prefixed with an exclamation point,
748it will be treated as a shell command. For example, defining
749"alias.new = !gitk --all --not ORIG_HEAD", the invocation
750"git new" is equivalent to running the shell command
Junio C Hamano48bc1ce2009-07-09 16:49:19751"gitk --all --not ORIG_HEAD". Note that shell commands will be
752executed from the top-level directory of a repository, which may
753not necessarily be the current directory.
Junio C Hamano5f2627d2011-05-06 20:23:48754'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
755from the original current directory. See linkgit:git-rev-parse[1].
Junio C Hamano9cb74f22007-02-12 04:15:05756
Junio C Hamanocaa712a2010-03-11 01:17:35757am.keepcr::
758If true, git-am will call git-mailsplit for patches in mbox format
759with parameter '--keep-cr'. In this case git-mailsplit will
Junio C Hamano619596a2010-08-18 22:15:35760not remove `\r` from lines ending with `\r\n`. Can be overridden
Junio C Hamanocaa712a2010-03-11 01:17:35761by giving '--no-keep-cr' from the command line.
762See linkgit:git-am[1], linkgit:git-mailsplit[1].
763
Junio C Hamano322c6242015-03-23 21:32:46764apply.ignoreWhitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43765When set to 'change', tells 'git apply' to ignore changes in
Junio C Hamanofe24db02009-08-22 05:10:47766whitespace, in the same way as the '--ignore-space-change'
767option.
Junio C Hamano1aa40d22010-01-21 17:46:43768When set to one of: no, none, never, false tells 'git apply' to
Junio C Hamanofe24db02009-08-22 05:10:47769respect all whitespace differences.
770See linkgit:git-apply[1].
771
Junio C Hamano07824ce2006-04-25 07:36:54772apply.whitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43773Tells 'git apply' how to handle whitespaces, in the same way
Junio C Hamano35738e82008-01-07 07:55:46774as the '--whitespace' option. See linkgit:git-apply[1].
Junio C Hamano07824ce2006-04-25 07:36:54775
Junio C Hamano322c6242015-03-23 21:32:46776branch.autoSetupMerge::
Junio C Hamano1aa40d22010-01-21 17:46:43777Tells 'git branch' and 'git checkout' to set up new branches
Junio C Hamano24bc09a2008-02-28 00:27:44778so that linkgit:git-pull[1] will appropriately merge from the
779starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32780this behavior can be chosen per-branch using the `--track`
Junio C Hamano24bc09a2008-02-28 00:27:44781and `--no-track` options. The valid settings are: `false` -- no
782automatic setup is done; `true` -- automatic setup is done when the
Junio C Hamano97bcb482010-11-25 03:16:07783starting point is a remote-tracking branch; `always` --
784automatic setup is done when the starting point is either a
785local branch or remote-tracking
Junio C Hamano24bc09a2008-02-28 00:27:44786branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32787
Junio C Hamano322c6242015-03-23 21:32:46788branch.autoSetupRebase::
Junio C Hamano1aa40d22010-01-21 17:46:43789When a new branch is created with 'git branch' or 'git checkout'
Junio C Hamano076ffcc2013-02-06 05:13:21790that tracks another branch, this variable tells Git to set
Junio C Hamano869bb802008-05-12 00:29:47791up pull to rebase instead of merge (see "branch.<name>.rebase").
792When `never`, rebase is never automatically set to true.
793When `local`, rebase is set to true for tracked branches of
794other local branches.
795When `remote`, rebase is set to true for tracked branches of
Junio C Hamano97bcb482010-11-25 03:16:07796remote-tracking branches.
Junio C Hamano869bb802008-05-12 00:29:47797When `always`, rebase will be set to true for all tracking
798branches.
Junio C Hamano322c6242015-03-23 21:32:46799See "branch.autoSetupMerge" for details on how to set up a
Junio C Hamano869bb802008-05-12 00:29:47800branch to track another branch.
801This option defaults to never.
802
Junio C Hamano47c1e3c2006-09-25 04:45:55803branch.<name>.remote::
Junio C Hamano63b6fdb2013-04-07 23:37:13804When on branch <name>, it tells 'git fetch' and 'git push'
805which remote to fetch from/push to. The remote to push to
Junio C Hamano322c6242015-03-23 21:32:46806may be overridden with `remote.pushDefault` (for all branches).
Junio C Hamano63b6fdb2013-04-07 23:37:13807The remote to push to, for the current branch, may be further
Junio C Hamano322c6242015-03-23 21:32:46808overridden by `branch.<name>.pushRemote`. If no remote is
Junio C Hamano63b6fdb2013-04-07 23:37:13809configured, or if you are not on any branch, it defaults to
Junio C Hamano322c6242015-03-23 21:32:46810`origin` for fetching and `remote.pushDefault` for pushing.
Junio C Hamano238ce9c2013-10-23 21:56:38811Additionally, `.` (a period) is the current local repository
812(a dot-repository), see `branch.<name>.merge`'s final note below.
Junio C Hamano63b6fdb2013-04-07 23:37:13813
Junio C Hamano322c6242015-03-23 21:32:46814branch.<name>.pushRemote::
Junio C Hamano63b6fdb2013-04-07 23:37:13815When on branch <name>, it overrides `branch.<name>.remote` for
Junio C Hamano322c6242015-03-23 21:32:46816pushing. It also overrides `remote.pushDefault` for pushing
Junio C Hamano63b6fdb2013-04-07 23:37:13817from branch <name>. When you pull from one place (e.g. your
818upstream) and push to another place (e.g. your own publishing
Junio C Hamano322c6242015-03-23 21:32:46819repository), you would want to set `remote.pushDefault` to
Junio C Hamano63b6fdb2013-04-07 23:37:13820specify the remote to push to for all branches, and use this
821option to override it for a specific branch.
Junio C Hamano47c1e3c2006-09-25 04:45:55822
823branch.<name>.merge::
Junio C Hamano0706c802009-03-30 22:34:19824Defines, together with branch.<name>.remote, the upstream branch
Junio C Hamanob02377c2011-04-28 22:26:02825for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
Junio C Hamano1aa40d22010-01-21 17:46:43826branch to merge and can also affect 'git push' (see push.default).
827When in branch <name>, it tells 'git fetch' the default
Junio C Hamanoc2b47092007-10-25 06:50:31828refspec to be marked for merging in FETCH_HEAD. The value is
829handled like the remote part of a refspec, and must match a
830ref which is fetched from the remote given by
831"branch.<name>.remote".
Junio C Hamano1aa40d22010-01-21 17:46:43832The merge information is used by 'git pull' (which at first calls
833'git fetch') to lookup the default branch for merging. Without
834this option, 'git pull' defaults to merge the first refspec fetched.
Junio C Hamano96010b22006-12-09 21:15:46835Specify multiple values to get an octopus merge.
Junio C Hamano1aa40d22010-01-21 17:46:43836If you wish to setup 'git pull' so that it merges into <name> from
Junio C Hamano6e149c02007-03-16 10:21:07837another branch in the local repository, you can point
Junio C Hamano238ce9c2013-10-23 21:56:38838branch.<name>.merge to the desired branch, and use the relative path
839setting `.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:55840
Junio C Hamano322c6242015-03-23 21:32:46841branch.<name>.mergeOptions::
Junio C Hamano1b50ce92007-10-03 12:05:53842Sets default options for merging into branch <name>. The syntax and
Junio C Hamanoc0e55e72009-10-10 00:56:29843supported options are the same as those of linkgit:git-merge[1], but
Junio C Hamano1b50ce92007-10-03 12:05:53844option values containing whitespace characters are currently not
845supported.
846
Junio C Hamano0c999702007-12-03 09:57:55847branch.<name>.rebase::
848When true, rebase the branch <name> on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:08849instead of merging the default branch from the default remote when
Junio C Hamano515ab1d2011-12-09 23:41:20850"git pull" is run. See "pull.rebase" for doing this in a non
851branch-specific manner.
852+
Junio C Hamanocf4a1742013-09-11 22:57:50853When preserve, also pass `--preserve-merges` along to 'git rebase'
854so that locally committed merge commits will not be flattened
855by running 'git pull'.
856+
Junio C Hamano515ab1d2011-12-09 23:41:20857*NOTE*: this is a possibly dangerous operation; do *not* use
858it unless you understand the implications (see linkgit:git-rebase[1]
859for details).
Junio C Hamano0c999702007-12-03 09:57:55860
Junio C Hamano46247182013-01-09 20:50:28861branch.<name>.description::
862Branch description, can be edited with
863`git branch --edit-description`. Branch description is
864automatically added in the format-patch cover letter or
865request-pull summary.
866
Junio C Hamano8760ea62008-03-14 08:58:45867browser.<tool>.cmd::
868Specify the command to invoke the specified browser. The
869specified command is evaluated in shell with the URLs passed
Junio C Hamano360e3a12011-07-13 23:51:56870as arguments. (See linkgit:git-web{litdd}browse[1].)
Junio C Hamano8760ea62008-03-14 08:58:45871
Junio C Hamanoe35a6fc2008-01-29 09:46:27872browser.<tool>.path::
873Override the path for the given tool that may be used to
874browse HTML help (see '-w' option in linkgit:git-help[1]) or a
875working repository in gitweb (see linkgit:git-instaweb[1]).
876
Junio C Hamano47b9acd2007-04-24 07:34:34877clean.requireForce::
Junio C Hamanoe6f28d02013-09-17 21:34:00878A boolean to make git-clean do nothing unless given -f,
879-i or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:34880
Junio C Hamanoeb692952007-01-03 22:02:12881color.branch::
882A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46883linkgit:git-branch[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21884`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoeb692952007-01-03 22:02:12885only when the output is to a terminal. Defaults to false.
886
887color.branch.<slot>::
888Use customized color for branch coloration. `<slot>` is one of
889`current` (the current branch), `local` (a local branch),
Junio C Hamano76927822013-04-19 21:26:57890`remote` (a remote-tracking branch in refs/remotes/),
891`upstream` (upstream tracking branch), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:22892refs).
Junio C Hamanoeb692952007-01-03 22:02:12893
Junio C Hamano3f403b02006-12-13 10:14:13894color.diff::
Junio C Hamano5f2627d2011-05-06 20:23:48895Whether to use ANSI escape sequences to add color to patches.
896If this is set to `always`, linkgit:git-diff[1],
897linkgit:git-log[1], and linkgit:git-show[1] will use color
898for all patches. If it is set to `true` or `auto`, those
899commands will only use color when output is to the terminal.
900Defaults to false.
901+
Junio C Hamanod75148a2014-04-08 19:48:38902This does not affect linkgit:git-format-patch[1] or the
Junio C Hamano5f2627d2011-05-06 20:23:48903'git-diff-{asterisk}' plumbing commands. Can be overridden on the
904command line with the `--color[=<when>]` option.
Junio C Hamano9ae1a062006-07-10 08:12:34905
Junio C Hamano3f403b02006-12-13 10:14:13906color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:22907Use customized color for diff colorization. `<slot>` specifies
908which part of the patch to use the specified color, and is one
909of `plain` (context text), `meta` (metainformation), `frag`
Junio C Hamano2bd8a742009-12-01 21:16:59910(hunk header), 'func' (function in hunk header), `old` (removed lines),
911`new` (added lines), `commit` (commit headers), or `whitespace`
Junio C Hamano07622622015-03-20 21:47:26912(highlighting whitespace errors).
Junio C Hamano9ae1a062006-07-10 08:12:34913
Junio C Hamano7d449522010-07-01 00:08:51914color.decorate.<slot>::
915Use customized color for 'git log --decorate' output. `<slot>` is one
916of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
Junio C Hamano97bcb482010-11-25 03:16:07917branches, remote-tracking branches, tags, stash and HEAD, respectively.
Junio C Hamano7d449522010-07-01 00:08:51918
Junio C Hamanod257cff2009-03-18 05:27:16919color.grep::
920When set to `always`, always highlight matches. When `false` (or
921`never`), never. When set to `true` or `auto`, use color only
922when the output is written to the terminal. Defaults to `false`.
923
Junio C Hamano0299d922010-03-20 20:59:31924color.grep.<slot>::
925Use customized color for grep colorization. `<slot>` specifies which
926part of the line to use the specified color, and is one of
927+
928--
929`context`;;
930non-matching text in context lines (when using `-A`, `-B`, or `-C`)
931`filename`;;
932filename prefix (when not using `-h`)
933`function`;;
934function name lines (when using `-p`)
935`linenumber`;;
936line number prefix (when using `-n`)
937`match`;;
Junio C Hamanoc14e6ad2014-10-31 20:25:53938matching text (same as setting `matchContext` and `matchSelected`)
939`matchContext`;;
940matching text in context lines
941`matchSelected`;;
942matching text in selected lines
Junio C Hamano0299d922010-03-20 20:59:31943`selected`;;
944non-matching text in selected lines
945`separator`;;
946separators between fields on a line (`:`, `-`, and `=`)
947and between hunks (`--`)
948--
Junio C Hamanod257cff2009-03-18 05:27:16949
Junio C Hamano00b8b632007-12-07 09:50:49950color.interactive::
Junio C Hamano35738e82008-01-07 07:55:46951When set to `always`, always use colors for interactive prompts
Junio C Hamano58f587a2013-07-22 19:20:59952and displays (such as those used by "git-add --interactive" and
953"git-clean --interactive"). When false (or `never`), never.
954When set to `true` or `auto`, use colors only when the output is
955to the terminal. Defaults to false.
Junio C Hamano00b8b632007-12-07 09:50:49956
957color.interactive.<slot>::
Junio C Hamano58f587a2013-07-22 19:20:59958Use customized color for 'git add --interactive' and 'git clean
959--interactive' output. `<slot>` may be `prompt`, `header`, `help`
960or `error`, for four distinct types of normal output from
Junio C Hamano07622622015-03-20 21:47:26961interactive commands.
Junio C Hamano00b8b632007-12-07 09:50:49962
Junio C Hamanoe7935c42006-12-13 21:32:17963color.pager::
964A boolean to enable/disable colored output when the pager is in
965use (default is true).
966
Junio C Hamano322c6242015-03-23 21:32:46967color.showBranch::
Junio C Hamano52ba2952009-05-18 17:43:02968A boolean to enable/disable color in the output of
969linkgit:git-show-branch[1]. May be set to `always`,
970`false` (or `never`) or `auto` (or `true`), in which case colors are used
971only when the output is to a terminal. Defaults to false.
972
Junio C Hamanoe7935c42006-12-13 21:32:17973color.status::
974A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46975linkgit:git-status[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21976`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoe7935c42006-12-13 21:32:17977only when the output is to a terminal. Defaults to false.
978
979color.status.<slot>::
980Use customized color for status colorization. `<slot>` is
981one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:04982`added` or `updated` (files which are added but not committed),
983`changed` (files which are changed but not added in the index),
Junio C Hamano076ffcc2013-02-06 05:13:21984`untracked` (files which are not tracked by Git),
Junio C Hamano5992a252015-03-17 23:39:30985`branch` (the current branch),
Junio C Hamanob713ff12008-05-24 01:12:30986`nobranch` (the color the 'no branch' warning is shown in, defaulting
Junio C Hamano5992a252015-03-17 23:39:30987to red), or
988`unmerged` (files which have unmerged changes).
Junio C Hamanoe7935c42006-12-13 21:32:17989
Junio C Hamano83d46a22008-02-21 02:29:42990color.ui::
Junio C Hamano5f2627d2011-05-06 20:23:48991This variable determines the default value for variables such
992as `color.diff` and `color.grep` that control the use of color
993per command family. Its scope will expand as more commands learn
994configuration to set a default for the `--color` option. Set it
Junio C Hamanofa1d3492013-06-20 23:39:43995to `false` or `never` if you prefer Git commands not to use
996color unless enabled explicitly with some other configuration
997or the `--color` option. Set it to `always` if you want all
998output not intended for machine consumption to use color, to
999`true` or `auto` (this is the default since Git 1.8.4) if you
1000want such output to use color when written to the terminal.
Junio C Hamano83d46a22008-02-21 02:29:421001
Junio C Hamano22700fb2012-05-03 23:07:251002column.ui::
1003Specify whether supported commands should output in columns.
1004This variable consists of a list of tokens separated by spaces
1005or commas:
1006+
Junio C Hamanoa1952302013-07-01 21:31:181007These options control when the feature should be enabled
1008(defaults to 'never'):
1009+
Junio C Hamano22700fb2012-05-03 23:07:251010--
1011`always`;;
1012always show in columns
1013`never`;;
1014never show in columns
1015`auto`;;
1016show in columns if the output is to the terminal
Junio C Hamanoa1952302013-07-01 21:31:181017--
1018+
1019These options control layout (defaults to 'column'). Setting any
1020of these implies 'always' if none of 'always', 'never', or 'auto' are
1021specified.
1022+
1023--
Junio C Hamano22700fb2012-05-03 23:07:251024`column`;;
Junio C Hamanoa1952302013-07-01 21:31:181025fill columns before rows
Junio C Hamano22700fb2012-05-03 23:07:251026`row`;;
1027fill rows before columns
1028`plain`;;
1029show in one column
Junio C Hamanoa1952302013-07-01 21:31:181030--
1031+
1032Finally, these options can be combined with a layout option (defaults
1033to 'nodense'):
1034+
1035--
Junio C Hamano22700fb2012-05-03 23:07:251036`dense`;;
1037make unequal size columns to utilize more space
1038`nodense`;;
1039make equal size columns
1040--
Junio C Hamano22700fb2012-05-03 23:07:251041
1042column.branch::
1043Specify whether to output branch listing in `git branch` in columns.
1044See `column.ui` for details.
1045
Junio C Hamano58f587a2013-07-22 19:20:591046column.clean::
1047Specify the layout when list items in `git clean -i`, which always
1048shows files and directories in columns. See `column.ui` for details.
1049
Junio C Hamano22700fb2012-05-03 23:07:251050column.status::
1051Specify whether to output untracked files in `git status` in columns.
1052See `column.ui` for details.
1053
1054column.tag::
1055Specify whether to output tag listing in `git tag` in columns.
1056See `column.ui` for details.
1057
Junio C Hamanoce836cc2013-01-21 02:01:531058commit.cleanup::
1059This setting overrides the default of the `--cleanup` option in
1060`git commit`. See linkgit:git-commit[1] for details. Changing the
1061default can be useful when you always want to keep lines that begin
1062with comment character `#` in your log message, in which case you
1063would do `git config commit.cleanup whitespace` (note that you will
1064have to remove the help lines that begin with `#` in the commit log
1065template yourself, if you do this).
1066
Junio C Hamano322c6242015-03-23 21:32:461067commit.gpgSign::
Junio C Hamano5b3533d2014-02-27 23:07:151068
1069A boolean to specify whether all commits should be GPG signed.
1070Use of this option when doing operations such as rebase can
1071result in a large number of commits being signed. It may be
1072convenient to use an agent to avoid typing your GPG passphrase
1073several times.
1074
Junio C Hamanod0d892c2010-01-24 20:06:291075commit.status::
Junio C Hamano6ce6b6c2010-01-18 01:25:501076A boolean to enable/disable inclusion of status information in the
1077commit message template when using an editor to prepare the commit
1078message. Defaults to true.
1079
Junio C Hamano4653c6f2008-11-26 22:50:201080commit.template::
1081Specify a file to use as the template for new commit messages.
Junio C Hamanob76a6862012-05-02 22:02:461082"`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
Junio C Hamanobf984de2009-11-23 06:11:191083specified user's home directory.
Junio C Hamano4653c6f2008-11-26 22:50:201084
Junio C Hamano0df92712011-12-21 22:30:441085credential.helper::
1086Specify an external helper to be called when a username or
1087password credential is needed; the helper may consult external
1088storage to avoid prompting the user for the credentials. See
1089linkgit:gitcredentials[7] for details.
1090
1091credential.useHttpPath::
1092When acquiring credentials, consider the "path" component of an http
1093or https URL to be important. Defaults to false. See
1094linkgit:gitcredentials[7] for more information.
1095
1096credential.username::
1097If no username is set for a network authentication, use this username
1098by default. See credential.<context>.* below, and
1099linkgit:gitcredentials[7].
1100
1101credential.<url>.*::
1102Any of the credential.* options above can be applied selectively to
1103some credentials. For example "credential.https://example.com.username"
1104would set the default username only for https connections to
1105example.com. See linkgit:gitcredentials[7] for details on how URLs are
1106matched.
1107
Junio C Hamano209ebe82011-04-27 21:09:591108include::diff-config.txt[]
Junio C Hamano3bd66e92009-04-18 06:17:561109
1110difftool.<tool>.path::
1111Override the path for the given tool. This is useful in case
1112your tool is not in the PATH.
1113
1114difftool.<tool>.cmd::
1115Specify the command to invoke the specified diff tool.
1116The specified command is evaluated in shell with the following
1117variables available: 'LOCAL' is set to the name of the temporary
1118file containing the contents of the diff pre-image and 'REMOTE'
1119is set to the name of the temporary file containing the contents
1120of the diff post-image.
1121
1122difftool.prompt::
1123Prompt before each invocation of the diff tool.
1124
Junio C Hamano0d75e872010-12-17 06:57:261125fetch.recurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:101126This option can be either set to a boolean value or to 'on-demand'.
1127Setting it to a boolean changes the behavior of fetch and pull to
1128unconditionally recurse into submodules when set to true or to not
1129recurse at all when set to false. When set to 'on-demand' (the default
1130value), fetch and pull will only recurse into a populated submodule
1131when its superproject retrieves a commit that updates the submodule's
1132reference.
Junio C Hamano0d75e872010-12-17 06:57:261133
Junio C Hamano8fb66e52011-10-05 20:59:511134fetch.fsckObjects::
1135If it is set to true, git-fetch-pack will check all fetched
1136objects. It will abort in the case of a malformed object or a
1137broken link. The result of an abort are only dangling objects.
1138Defaults to false. If not set, the value of `transfer.fsckObjects`
1139is used instead.
1140
Junio C Hamano54ea8d32007-01-25 07:59:481141fetch.unpackLimit::
Junio C Hamano076ffcc2013-02-06 05:13:211142If the number of objects fetched over the Git native
Junio C Hamano54ea8d32007-01-25 07:59:481143transfer is below this
1144limit, then the objects will be unpacked into loose object
1145files. However if the number of received objects equals or
1146exceeds this limit then the received pack will be stored as
1147a pack, after adding any missing delta bases. Storing the
1148pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:171149especially on slow filesystems. If not set, the value of
1150`transfer.unpackLimit` is used instead.
Junio C Hamano54ea8d32007-01-25 07:59:481151
Junio C Hamano8eac2682013-09-09 22:35:201152fetch.prune::
1153If true, fetch will automatically behave as if the `--prune`
1154option was given on the command line. See also `remote.<name>.prune`.
1155
Junio C Hamanof4581102009-04-25 08:29:591156format.attach::
1157Enable multipart/mixed attachments as the default for
1158'format-patch'. The value can also be a double quoted string
1159which will enable attachments as the default and set the
1160value as the boundary. See the --attach option in
1161linkgit:git-format-patch[1].
1162
Junio C Hamano8c5802d2007-11-15 00:13:361163format.numbered::
Junio C Hamano7d06a8a2008-10-20 05:42:331164A boolean which can enable or disable sequence numbers in patch
1165subjects. It defaults to "auto" which enables it only if there
1166is more than one patch. It can be enabled or disabled for all
1167messages by setting it to "true" or "false". See --numbered
1168option in linkgit:git-format-patch[1].
Junio C Hamano8c5802d2007-11-15 00:13:361169
Junio C Hamano07824ce2006-04-25 07:36:541170format.headers::
1171Additional email headers to include in a patch to be submitted
Junio C Hamano35738e82008-01-07 07:55:461172by mail. See linkgit:git-format-patch[1].
Junio C Hamano07824ce2006-04-25 07:36:541173
Junio C Hamano70664a02010-07-13 22:48:051174format.to::
Junio C Hamanof4581102009-04-25 08:29:591175format.cc::
Junio C Hamano70664a02010-07-13 22:48:051176Additional recipients to include in a patch to be submitted
1177by mail. See the --to and --cc options in
1178linkgit:git-format-patch[1].
Junio C Hamanof4581102009-04-25 08:29:591179
Junio C Hamano322c6242015-03-23 21:32:461180format.subjectPrefix::
Junio C Hamanof4581102009-04-25 08:29:591181The default for format-patch is to output files with the '[PATCH]'
1182subject prefix. Use this variable to change that prefix.
1183
Junio C Hamano89a57342010-06-22 23:22:551184format.signature::
1185The default for format-patch is to output a signature containing
Junio C Hamano076ffcc2013-02-06 05:13:211186the Git version number. Use this variable to change that default.
Junio C Hamano89a57342010-06-22 23:22:551187Set this variable to the empty string ("") to suppress
1188signature generation.
1189
Junio C Hamano322c6242015-03-23 21:32:461190format.signatureFile::
Junio C Hamanoc8c398a2014-06-16 21:14:051191Works just like format.signature except the contents of the
1192file specified by this variable will be used as the signature.
1193
Junio C Hamanod4c8e112007-03-04 10:32:381194format.suffix::
1195The default for format-patch is to output files with the suffix
1196`.patch`. Use this variable to change that suffix (make sure to
1197include the dot if you want it).
1198
Junio C Hamano86bcccc2008-03-08 09:33:551199format.pretty::
1200The default pretty format for log/show/whatchanged command,
1201See linkgit:git-log[1], linkgit:git-show[1],
1202linkgit:git-whatchanged[1].
1203
Junio C Hamanoea6a7642009-03-11 23:56:191204format.thread::
Junio C Hamano1aa40d22010-01-21 17:46:431205The default threading style for 'git format-patch'. Can be
Junio C Hamanob141a922010-01-10 19:55:141206a boolean value, or `shallow` or `deep`. `shallow` threading
1207makes every mail a reply to the head of the series,
Junio C Hamanoea6a7642009-03-11 23:56:191208where the head is chosen from the cover letter, the
Junio C Hamanob76a6862012-05-02 22:02:461209`--in-reply-to`, and the first patch mail, in this order.
Junio C Hamanof4581102009-04-25 08:29:591210`deep` threading makes every mail a reply to the previous one.
Junio C Hamanoea6a7642009-03-11 23:56:191211A true boolean value is the same as `shallow`, and a false
1212value disables threading.
1213
Junio C Hamano322c6242015-03-23 21:32:461214format.signOff::
Junio C Hamano804a9742013-04-28 23:10:311215A boolean value which lets you enable the `-s/--signoff` option of
1216format-patch by default. *Note:* Adding the Signed-off-by: line to a
1217patch should be a conscious act and means that you certify you have
1218the rights to submit this work under the same open source license.
1219Please see the 'SubmittingPatches' document for further discussion.
Junio C Hamano5f9a6f02009-04-06 08:26:561220
Junio C Hamanoea3b7522013-04-18 19:37:531221format.coverLetter::
1222A boolean that controls whether to generate a cover-letter when
1223format-patch is invoked, but in addition can be set to "auto", to
1224generate a cover-letter only when there's more than one patch.
1225
Junio C Hamano209ebe82011-04-27 21:09:591226filter.<driver>.clean::
1227The command which is used to convert the content of a worktree
1228file to a blob upon checkin. See linkgit:gitattributes[5] for
1229details.
1230
1231filter.<driver>.smudge::
1232The command which is used to convert the content of a blob
1233object to a worktree file upon checkout. See
1234linkgit:gitattributes[5] for details.
1235
Junio C Hamano624dd4c2014-04-03 21:56:301236gc.aggressiveDepth::
1237The depth parameter used in the delta compression
1238algorithm used by 'git gc --aggressive'. This defaults
1239to 250.
1240
Junio C Hamanof2ce2972007-05-20 19:12:091241gc.aggressiveWindow::
1242The window size parameter used in the delta compression
Junio C Hamano1aa40d22010-01-21 17:46:431243algorithm used by 'git gc --aggressive'. This defaults
Junio C Hamanob04bb3f2010-04-14 14:07:361244to 250.
Junio C Hamanof2ce2972007-05-20 19:12:091245
Junio C Hamano1b50ce92007-10-03 12:05:531246gc.auto::
1247When there are approximately more than this many loose
1248objects in the repository, `git gc --auto` will pack them.
1249Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:171250light-weight garbage collection from time to time. The
1251default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531252
Junio C Hamano322c6242015-03-23 21:32:461253gc.autoPackLimit::
Junio C Hamano1b50ce92007-10-03 12:05:531254When there are more than this many packs that are not
1255marked with `*.keep` file in the repository, `git gc
Junio C Hamanoe77b0152008-01-12 06:44:171256--auto` consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:371257default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531258
Junio C Hamano322c6242015-03-23 21:32:461259gc.autoDetach::
Junio C Hamanofb5ffde2014-11-04 22:38:561260Make `git gc --auto` return immediately and run in background
Junio C Hamano08ef8c22014-03-10 14:53:441261if the system supports it. Default is true.
1262
Junio C Hamano322c6242015-03-23 21:32:461263gc.packRefs::
Junio C Hamanob141a922010-01-10 19:55:141264Running `git pack-refs` in a repository renders it
1265unclonable by Git versions prior to 1.5.1.2 over dumb
1266transports such as HTTP. This variable determines whether
Junio C Hamanocdd1c332010-12-20 10:08:001267'git gc' runs `git pack-refs`. This can be set to `notbare`
Junio C Hamanob141a922010-01-10 19:55:141268to enable it within all non-bare repos or it can be set to a
1269boolean value. The default is `true`.
Junio C Hamano9d52e572007-02-13 23:48:201270
Junio C Hamano322c6242015-03-23 21:32:461271gc.pruneExpire::
Junio C Hamano1aa40d22010-01-21 17:46:431272When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
Junio C Hamanoa3148f52009-01-14 08:49:571273Override the grace period with this config variable. The value
1274"now" may be used to disable this grace period and always prune
1275unreachable objects immediately.
Junio C Hamano09a926d2008-03-13 07:55:291276
Junio C Hamano322c6242015-03-23 21:32:461277gc.reflogExpire::
1278gc.<pattern>.reflogExpire::
Junio C Hamano1aa40d22010-01-21 17:46:431279'git reflog expire' removes reflog entries older than
Junio C Hamanocc7636a2010-05-21 14:57:531280this time; defaults to 90 days. With "<pattern>" (e.g.
1281"refs/stash") in the middle the setting applies only to
1282the refs that match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551283
Junio C Hamano322c6242015-03-23 21:32:461284gc.reflogExpireUnreachable::
1285gc.<ref>.reflogExpireUnreachable::
Junio C Hamano1aa40d22010-01-21 17:46:431286'git reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:551287this time and are not reachable from the current tip;
Junio C Hamanocc7636a2010-05-21 14:57:531288defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1289in the middle, the setting applies only to the refs that
1290match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551291
Junio C Hamano322c6242015-03-23 21:32:461292gc.rerereResolved::
Junio C Hamano74640642006-12-27 10:59:551293Records of conflicted merge you resolved earlier are
Junio C Hamano1aa40d22010-01-21 17:46:431294kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461295The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551296
Junio C Hamano322c6242015-03-23 21:32:461297gc.rerereUnresolved::
Junio C Hamano74640642006-12-27 10:59:551298Records of conflicted merge you have not resolved are
Junio C Hamano1aa40d22010-01-21 17:46:431299kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461300The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551301
Junio C Hamano322c6242015-03-23 21:32:461302gitcvs.commitMsgAnnotation::
Junio C Hamanoa3148f52009-01-14 08:49:571303Append this string to each commit message. Set to empty string
1304to disable this feature. Defaults to "via git-CVS emulator".
1305
Junio C Hamano07824ce2006-04-25 07:36:541306gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:271307Whether the CVS server interface is enabled for this repository.
Junio C Hamano35738e82008-01-07 07:55:461308See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541309
Junio C Hamano322c6242015-03-23 21:32:461310gitcvs.logFile::
Junio C Hamanoa6387422007-08-25 03:54:271311Path to a log file where the CVS server interface well... logs
Junio C Hamano35738e82008-01-07 07:55:461312various stuff. See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541313
Junio C Hamano17bd2272008-09-01 06:11:171314gitcvs.usecrlfattr::
Junio C Hamanobb88cf42010-06-21 15:23:551315If true, the server will look up the end-of-line conversion
1316attributes for files to determine the '-k' modes to use. If
Junio C Hamano076ffcc2013-02-06 05:13:211317the attributes force Git to treat a file as text,
Junio C Hamano619596a2010-08-18 22:15:351318the '-k' mode will be left blank so CVS clients will
Junio C Hamanobb88cf42010-06-21 15:23:551319treat it as text. If they suppress text conversion, the file
Junio C Hamanocb1c44f2008-08-06 06:19:331320will be set with '-kb' mode, which suppresses any newline munging
Junio C Hamanobb88cf42010-06-21 15:23:551321the client might otherwise do. If the attributes do not allow
Junio C Hamano322c6242015-03-23 21:32:461322the file type to be determined, then 'gitcvs.allBinary' is
Junio C Hamanobb88cf42010-06-21 15:23:551323used. See linkgit:gitattributes[5].
Junio C Hamanodfccbb02008-05-26 01:16:141324
Junio C Hamano322c6242015-03-23 21:32:461325gitcvs.allBinary::
Junio C Hamanodfccbb02008-05-26 01:16:141326This is used if 'gitcvs.usecrlfattr' does not resolve
1327the correct '-kb' mode to use. If true, all
1328unresolved files are sent to the client in
1329mode '-kb'. This causes the client to treat them
1330as binary files, which suppresses any newline munging it
1331otherwise might do. Alternatively, if it is set to "guess",
1332then the contents of the file are examined to decide if
1333it is binary, similar to 'core.autocrlf'.
Junio C Hamanoa2ad99e2007-04-18 09:57:041334
Junio C Hamano322c6242015-03-23 21:32:461335gitcvs.dbName::
Junio C Hamanoa2ad99e2007-04-18 09:57:041336Database used by git-cvsserver to cache revision information
Junio C Hamano076ffcc2013-02-06 05:13:211337derived from the Git repository. The exact meaning depends on the
Junio C Hamanoa2ad99e2007-04-18 09:57:041338used database driver, for SQLite (which is the default driver) this
1339is a filename. Supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461340linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Junio C Hamanoa2ad99e2007-04-18 09:57:041341Default: '%Ggitcvs.%m.sqlite'
1342
Junio C Hamano322c6242015-03-23 21:32:461343gitcvs.dbDriver::
Junio C Hamanoa2ad99e2007-04-18 09:57:041344Used Perl DBI driver. You can specify any available driver
Junio C Hamano804a9742013-04-28 23:10:311345for this here, but it might not work. git-cvsserver is tested
Junio C Hamanoa2ad99e2007-04-18 09:57:041346with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1347reported *not* to work with 'DBD::mysql'. Experimental feature.
1348May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamano35738e82008-01-07 07:55:461349See linkgit:git-cvsserver[1].
Junio C Hamanod9e0e5d2007-04-14 16:22:041350
Junio C Hamano322c6242015-03-23 21:32:461351gitcvs.dbUser, gitcvs.dbPass::
1352Database user and password. Only useful if setting 'gitcvs.dbDriver',
Junio C Hamanoa2ad99e2007-04-18 09:57:041353since SQLite has no concept of database users and/or passwords.
Junio C Hamano322c6242015-03-23 21:32:461354'gitcvs.dbUser' supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461355linkgit:git-cvsserver[1] for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:041356
Junio C Hamanoa74efce2008-04-02 08:39:081357gitcvs.dbTableNamePrefix::
1358Database table name prefix. Prepended to the names of any
1359database tables used, allowing a single database to be used
1360for several repositories. Supports variable substitution (see
1361linkgit:git-cvsserver[1] for details). Any non-alphabetic
1362characters will be replaced with underscores.
1363
Junio C Hamanodfccbb02008-05-26 01:16:141364All gitcvs variables except for 'gitcvs.usecrlfattr' and
Junio C Hamano322c6242015-03-23 21:32:461365'gitcvs.allBinary' can also be specified as
Junio C Hamanodfccbb02008-05-26 01:16:141366'gitcvs.<access_method>.<varname>' (where 'access_method'
Junio C Hamanoa6387422007-08-25 03:54:271367is one of "ext" and "pserver") to make them apply only for the given
1368access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:041369
Junio C Hamano11821ed2011-10-19 18:42:091370gitweb.category::
1371gitweb.description::
1372gitweb.owner::
1373gitweb.url::
1374See linkgit:gitweb[1] for description.
1375
1376gitweb.avatar::
1377gitweb.blame::
1378gitweb.grep::
1379gitweb.highlight::
1380gitweb.patches::
1381gitweb.pickaxe::
1382gitweb.remote_heads::
Junio C Hamano322c6242015-03-23 21:32:461383gitweb.showSizes::
Junio C Hamano11821ed2011-10-19 18:42:091384gitweb.snapshot::
1385See linkgit:gitweb.conf[5] for description.
1386
Junio C Hamanoa03ac862011-04-02 04:32:291387grep.lineNumber::
1388If set to true, enable '-n' option by default.
1389
Junio C Hamanoa00504d2012-08-27 21:11:231390grep.patternType::
1391Set the default matching behavior. Using a value of 'basic', 'extended',
1392'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1393'--fixed-strings', or '--perl-regexp' option accordingly, while the
1394value 'default' will return to the default matching behavior.
1395
Junio C Hamanoa03ac862011-04-02 04:32:291396grep.extendedRegexp::
Junio C Hamanoa00504d2012-08-27 21:11:231397If set to true, enable '--extended-regexp' option by default. This
1398option is ignored when the 'grep.patternType' option is set to a value
1399other than 'default'.
Junio C Hamanoa03ac862011-04-02 04:32:291400
Junio C Hamano4fd24422012-01-06 21:52:431401gpg.program::
1402Use this custom program instead of "gpg" found on $PATH when
1403making or verifying a PGP signature. The program must support the
Junio C Hamanoe1aeb5e2014-06-06 19:16:291404same command-line interface as GPG, namely, to verify a detached
Junio C Hamano4fd24422012-01-06 21:52:431405signature, "gpg --verify $file - <$signature" is run, and the
1406program is expected to signal a good signature by exiting with
Junio C Hamanofb5ffde2014-11-04 22:38:561407code 0, and to generate an ASCII-armored detached signature, the
Junio C Hamano4fd24422012-01-06 21:52:431408standard input of "gpg -bsau $key" is fed with the contents to be
1409signed, and the program is expected to send the result to its
1410standard output.
1411
Junio C Hamano322c6242015-03-23 21:32:461412gui.commitMsgWidth::
Junio C Hamano6d76d612008-05-09 05:46:081413Defines how wide the commit message window is in the
1414linkgit:git-gui[1]. "75" is the default.
1415
Junio C Hamano322c6242015-03-23 21:32:461416gui.diffContext::
Junio C Hamano6d76d612008-05-09 05:46:081417Specifies how many context lines should be used in calls to diff
1418made by the linkgit:git-gui[1]. The default is "5".
1419
Junio C Hamano322c6242015-03-23 21:32:461420gui.displayUntracked::
Junio C Hamano796c55f2014-05-02 21:45:151421Determines if linkgit::git-gui[1] shows untracked files
1422in the file list. The default is "true".
1423
Junio C Hamanod3452a02008-11-15 08:07:551424gui.encoding::
1425Specifies the default encoding to use for displaying of
1426file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1427It can be overridden by setting the 'encoding' attribute
1428for relevant files (see linkgit:gitattributes[5]).
1429If this option is not set, the tools default to the
1430locale encoding.
1431
Junio C Hamano322c6242015-03-23 21:32:461432gui.matchTrackingBranch::
Junio C Hamano6d76d612008-05-09 05:46:081433Determines if new branches created with linkgit:git-gui[1] should
1434default to tracking remote branches with matching names or
1435not. Default: "false".
1436
Junio C Hamano322c6242015-03-23 21:32:461437gui.newBranchTemplate::
Junio C Hamano6d76d612008-05-09 05:46:081438Is used as suggested name when creating new branches using the
1439linkgit:git-gui[1].
1440
Junio C Hamano322c6242015-03-23 21:32:461441gui.pruneDuringFetch::
Junio C Hamano97bcb482010-11-25 03:16:071442"true" if linkgit:git-gui[1] should prune remote-tracking branches when
Junio C Hamano6d76d612008-05-09 05:46:081443performing a fetch. The default value is "false".
1444
1445gui.trustmtime::
1446Determines if linkgit:git-gui[1] should trust the file modification
1447timestamp or not. By default the timestamps are not trusted.
1448
Junio C Hamano322c6242015-03-23 21:32:461449gui.spellingDictionary::
Junio C Hamano6d76d612008-05-09 05:46:081450Specifies the dictionary used for spell checking commit messages in
1451the linkgit:git-gui[1]. When set to "none" spell checking is turned
1452off.
1453
Junio C Hamano322c6242015-03-23 21:32:461454gui.fastCopyBlame::
Junio C Hamano1aa40d22010-01-21 17:46:431455If true, 'git gui blame' uses `-C` instead of `-C -C` for original
Junio C Hamanod3452a02008-11-15 08:07:551456location detection. It makes blame significantly faster on huge
1457repositories at the expense of less thorough copy detection.
1458
Junio C Hamano322c6242015-03-23 21:32:461459gui.copyBlameThreshold::
Junio C Hamano610d1762008-11-28 06:27:131460Specifies the threshold to use in 'git gui blame' original location
Junio C Hamanod3452a02008-11-15 08:07:551461detection, measured in alphanumeric characters. See the
1462linkgit:git-blame[1] manual for more information on copy detection.
1463
1464gui.blamehistoryctx::
1465Specifies the radius of history context in days to show in
1466linkgit:gitk[1] for the selected commit, when the `Show History
1467Context` menu item is invoked from 'git gui blame'. If this
1468variable is set to zero, the whole history is shown.
1469
Junio C Hamano92d312a2008-12-15 07:22:201470guitool.<name>.cmd::
1471Specifies the shell command line to execute when the corresponding item
1472of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1473mandatory for every tool. The command is executed from the root of
1474the working directory, and in the environment it receives the name of
1475the tool as 'GIT_GUITOOL', the name of the currently selected file as
1476'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1477the head is detached, 'CUR_BRANCH' is empty).
1478
Junio C Hamano322c6242015-03-23 21:32:461479guitool.<name>.needsFile::
Junio C Hamano92d312a2008-12-15 07:22:201480Run the tool only if a diff is selected in the GUI. It guarantees
1481that 'FILENAME' is not empty.
1482
Junio C Hamano322c6242015-03-23 21:32:461483guitool.<name>.noConsole::
Junio C Hamano92d312a2008-12-15 07:22:201484Run the command silently, without creating a window to display its
1485output.
1486
Junio C Hamano322c6242015-03-23 21:32:461487guitool.<name>.noRescan::
Junio C Hamano92d312a2008-12-15 07:22:201488Don't rescan the working directory for changes after the tool
1489finishes execution.
1490
1491guitool.<name>.confirm::
1492Show a confirmation dialog before actually running the tool.
1493
Junio C Hamano322c6242015-03-23 21:32:461494guitool.<name>.argPrompt::
Junio C Hamano92d312a2008-12-15 07:22:201495Request a string argument from the user, and pass it to the tool
1496through the 'ARGS' environment variable. Since requesting an
1497argument implies confirmation, the 'confirm' option has no effect
1498if this is enabled. If the option is set to 'true', 'yes', or '1',
1499the dialog uses a built-in generic prompt; otherwise the exact
1500value of the variable is used.
1501
Junio C Hamano322c6242015-03-23 21:32:461502guitool.<name>.revPrompt::
Junio C Hamano92d312a2008-12-15 07:22:201503Request a single valid revision from the user, and set the
1504'REVISION' environment variable. In other aspects this option
Junio C Hamano322c6242015-03-23 21:32:461505is similar to 'argPrompt', and can be used together with it.
Junio C Hamano92d312a2008-12-15 07:22:201506
Junio C Hamano322c6242015-03-23 21:32:461507guitool.<name>.revUnmerged::
1508Show only unmerged branches in the 'revPrompt' subdialog.
Junio C Hamano92d312a2008-12-15 07:22:201509This is useful for tools similar to merge or rebase, but not
1510for things like checkout or reset.
1511
1512guitool.<name>.title::
1513Specifies the title to use for the prompt dialog. The default
1514is the tool name.
1515
1516guitool.<name>.prompt::
1517Specifies the general prompt string to display at the top of
Junio C Hamano322c6242015-03-23 21:32:461518the dialog, before subsections for 'argPrompt' and 'revPrompt'.
Junio C Hamano92d312a2008-12-15 07:22:201519The default value includes the actual command.
1520
Junio C Hamano4e272312008-01-08 09:13:211521help.browser::
1522Specify the browser that will be used to display help in the
1523'web' format. See linkgit:git-help[1].
1524
1525help.format::
1526Override the default help format used by linkgit:git-help[1].
1527Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1528the default. 'web' and 'html' are the same.
1529
Junio C Hamano322c6242015-03-23 21:32:461530help.autoCorrect::
Junio C Hamanof24b8062008-09-09 01:34:391531Automatically correct and execute mistyped commands after
1532waiting for the given number of deciseconds (0.1 sec). If more
1533than one command can be deduced from the entered text, nothing
1534will be executed. If the value of this option is negative,
1535the corrected command will be executed immediately. If the
1536value is 0 - the command will be just shown but not executed.
1537This is the default.
1538
Junio C Hamano322c6242015-03-23 21:32:461539help.htmlPath::
Junio C Hamano5dd5fae2013-01-18 21:06:491540Specify the path where the HTML documentation resides. File system paths
1541and URLs are supported. HTML pages will be prefixed with this path when
1542help is displayed in the 'web' format. This defaults to the documentation
1543path of your Git installation.
1544
Junio C Hamano58256872007-12-04 08:31:131545http.proxy::
Junio C Hamano3dd93922012-03-05 07:49:111546Override the HTTP proxy, normally configured using the 'http_proxy',
1547'https_proxy', and 'all_proxy' environment variables (see
1548`curl(1)`). This can be overridden on a per-remote basis; see
1549remote.<name>.proxy
Junio C Hamano58256872007-12-04 08:31:131550
Junio C Hamano322c6242015-03-23 21:32:461551http.cookieFile::
Junio C Hamano4c4b0122011-06-30 01:19:321552File containing previously stored cookie lines which should be used
Junio C Hamano076ffcc2013-02-06 05:13:211553in the Git http session, if they match the server. The file format
Junio C Hamano4c4b0122011-06-30 01:19:321554of the file to read cookies from should be plain HTTP headers or
1555the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
Junio C Hamano322c6242015-03-23 21:32:461556NOTE that the file specified with http.cookieFile is only used as
Junio C Hamano8eac2682013-09-09 22:35:201557input unless http.saveCookies is set.
1558
Junio C Hamano322c6242015-03-23 21:32:461559http.saveCookies::
Junio C Hamano8eac2682013-09-09 22:35:201560If set, store cookies received during requests to the file specified by
Junio C Hamano322c6242015-03-23 21:32:461561http.cookieFile. Has no effect if http.cookieFile is unset.
Junio C Hamano4c4b0122011-06-30 01:19:321562
Junio C Hamano07824ce2006-04-25 07:36:541563http.sslVerify::
1564Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451565over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Junio C Hamano07824ce2006-04-25 07:36:541566variable.
1567
1568http.sslCert::
1569File containing the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451570over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Junio C Hamano07824ce2006-04-25 07:36:541571variable.
1572
1573http.sslKey::
1574File containing the SSL private key when fetching or pushing
Junio C Hamano341071d2006-06-04 07:24:481575over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Junio C Hamano07824ce2006-04-25 07:36:541576variable.
1577
Junio C Hamano48bc1ce2009-07-09 16:49:191578http.sslCertPasswordProtected::
Junio C Hamano076ffcc2013-02-06 05:13:211579Enable Git's password prompt for the SSL certificate. Otherwise
Junio C Hamano48bc1ce2009-07-09 16:49:191580OpenSSL will prompt the user, possibly many times, if the
1581certificate or private key is encrypted. Can be overridden by the
1582'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1583
Junio C Hamano07824ce2006-04-25 07:36:541584http.sslCAInfo::
1585File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:481586fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano07824ce2006-04-25 07:36:541587'GIT_SSL_CAINFO' environment variable.
1588
1589http.sslCAPath::
1590Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:451591with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541592by the 'GIT_SSL_CAPATH' environment variable.
1593
Junio C Hamano76927822013-04-19 21:26:571594http.sslTry::
1595Attempt to use AUTH SSL/TLS and encrypted data transfers
1596when connecting via regular FTP protocol. This might be needed
1597if the FTP server requires it for security reasons or you wish
1598to connect securely whenever remote FTP server supports it.
1599Default is false since it might trigger certificate verification
1600errors on misconfigured servers.
1601
Junio C Hamano07824ce2006-04-25 07:36:541602http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:481603How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541604by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1605
Junio C Hamanob141a922010-01-10 19:55:141606http.minSessions::
1607The number of curl sessions (counted across slots) to be kept across
1608requests. They will not be ended with curl_easy_cleanup() until
1609http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1610value will be capped at 1. Defaults to 1.
1611
Junio C Hamano3b70d3c2009-11-21 17:37:371612http.postBuffer::
1613Maximum size in bytes of the buffer used by smart HTTP
1614transports when POSTing data to the remote system.
1615For requests larger than this buffer size, HTTP/1.1 and
1616Transfer-Encoding: chunked is used to avoid creating a
1617massive pack file locally. Default is 1 MiB, which is
1618sufficient for most requests.
1619
Junio C Hamano07824ce2006-04-25 07:36:541620http.lowSpeedLimit, http.lowSpeedTime::
1621If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1622for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano341071d2006-06-04 07:24:481623Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Junio C Hamano07824ce2006-04-25 07:36:541624'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1625
Junio C Hamanof1dcdfe2006-09-29 08:10:511626http.noEPSV::
1627A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:041628This can helpful with some "poor" ftp servers which don't
Junio C Hamanof1dcdfe2006-09-29 08:10:511629support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1630environment variable. Default is false (curl will use EPSV).
1631
Junio C Hamano322c6242015-03-23 21:32:461632http.userAgent::
Junio C Hamano53ba6d02010-08-22 07:25:121633The HTTP USER_AGENT string presented to an HTTP server. The default
Junio C Hamano076ffcc2013-02-06 05:13:211634value represents the version of the client Git such as git/1.7.1.
Junio C Hamano53ba6d02010-08-22 07:25:121635This option allows you to override this value to a more common value
1636such as Mozilla/4.0. This may be necessary, for instance, if
1637connecting through a firewall that restricts HTTP connections to a set
1638of common USER_AGENT strings (but not including those like git/1.7.1).
1639Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1640
Junio C Hamano8eac2682013-09-09 22:35:201641http.<url>.*::
Junio C Hamanofb5ffde2014-11-04 22:38:561642Any of the http.* options above can be applied selectively to some URLs.
Junio C Hamano8eac2682013-09-09 22:35:201643For a config key to match a URL, each element of the config key is
1644compared to that of the URL, in the following order:
1645+
1646--
1647. Scheme (e.g., `https` in `https://example.com/`). This field
1648 must match exactly between the config key and the URL.
1649
1650. Host/domain name (e.g., `example.com` in `https://example.com/`).
1651 This field must match exactly between the config key and the URL.
1652
1653. Port number (e.g., `8080` in `http://example.com:8080/`).
1654 This field must match exactly between the config key and the URL.
1655 Omitted port numbers are automatically converted to the correct
1656 default for the scheme before matching.
1657
1658. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1659 path field of the config key must match the path field of the URL
1660 either exactly or as a prefix of slash-delimited path elements. This means
1661 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1662 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1663 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1664 key with just path `foo/`).
1665
1666. User name (e.g., `user` in `https://user@example.com/repo.git`). If
1667 the config key has a user name it must match the user name in the
1668 URL exactly. If the config key does not have a user name, that
1669 config key will match a URL with any user name (including none),
1670 but at a lower precedence than a config key with a user name.
1671--
1672+
1673The list above is ordered by decreasing precedence; a URL that matches
1674a config key's path is preferred to one that matches its user name. For example,
1675if the URL is `https://user@example.com/foo/bar` a config key match of
1676`https://example.com/foo` will be preferred over a config key match of
1677`https://user@example.com`.
1678+
1679All URLs are normalized before attempting any matching (the password part,
1680if embedded in the URL, is always ignored for matching purposes) so that
Junio C Hamanofb5ffde2014-11-04 22:38:561681equivalent URLs that are simply spelled differently will match properly.
1682Environment variable settings always override any matches. The URLs that are
Junio C Hamano8eac2682013-09-09 22:35:201683matched against are those given directly to Git commands. This means any URLs
1684visited as a result of a redirection do not participate in matching.
1685
Junio C Hamano07824ce2006-04-25 07:36:541686i18n.commitEncoding::
Junio C Hamano076ffcc2013-02-06 05:13:211687Character encoding the commit messages are stored in; Git itself
Junio C Hamano07824ce2006-04-25 07:36:541688does not care per se, but this information is necessary e.g. when
1689importing commits from emails or in the gitk graphical history
1690browser (and possibly at other places in the future or in other
Junio C Hamano35738e82008-01-07 07:55:461691porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Junio C Hamano07824ce2006-04-25 07:36:541692
Junio C Hamano51f92e22006-12-29 05:18:281693i18n.logOutputEncoding::
1694Character encoding the commit messages are converted to when
Junio C Hamano1aa40d22010-01-21 17:46:431695running 'git log' and friends.
Junio C Hamano51f92e22006-12-29 05:18:281696
Junio C Hamano4653c6f2008-11-26 22:50:201697imap::
1698The configuration variables in the 'imap' section are described
1699in linkgit:git-imap-send[1].
1700
Junio C Hamano81703b22014-03-14 22:00:271701index.version::
1702Specify the version with which new index files should be
1703initialized. This does not affect existing repositories.
1704
Junio C Hamano322c6242015-03-23 21:32:461705init.templateDir::
Junio C Hamanocaa712a2010-03-11 01:17:351706Specify the directory from which templates will be copied.
1707(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1708
Junio C Hamano4e272312008-01-08 09:13:211709instaweb.browser::
1710Specify the program that will be used to browse your working
1711repository in gitweb. See linkgit:git-instaweb[1].
1712
1713instaweb.httpd::
1714The HTTP daemon command-line to start gitweb on your working
1715repository. See linkgit:git-instaweb[1].
1716
1717instaweb.local::
1718If true the web server started by linkgit:git-instaweb[1] will
1719be bound to the local IP (127.0.0.1).
1720
Junio C Hamano322c6242015-03-23 21:32:461721instaweb.modulePath::
Junio C Hamano619596a2010-08-18 22:15:351722The default module path for linkgit:git-instaweb[1] to use
1723instead of /usr/lib/apache2/modules. Only used if httpd
1724is Apache.
Junio C Hamano4e272312008-01-08 09:13:211725
1726instaweb.port::
1727The port number to bind the gitweb httpd to. See
1728linkgit:git-instaweb[1].
1729
Junio C Hamano322c6242015-03-23 21:32:461730interactive.singleKey::
Junio C Hamano27a128b2009-08-13 01:23:001731In interactive commands, allow the user to provide one-letter
Junio C Hamanoe5bf6c12009-02-07 21:43:101732input with a single key (i.e., without hitting enter).
Junio C Hamanob76a6862012-05-02 22:02:461733Currently this is used by the `--patch` mode of
Junio C Hamano3d050d62011-05-17 06:43:341734linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1735linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1736setting is silently ignored if portable keystroke input
Junio C Hamano81703b22014-03-14 22:00:271737is not available; requires the Perl module Term::ReadKey.
Junio C Hamanoe5bf6c12009-02-07 21:43:101738
Junio C Hamanof93530e2011-05-25 23:59:591739log.abbrevCommit::
1740If true, makes linkgit:git-log[1], linkgit:git-show[1], and
Junio C Hamanob76a6862012-05-02 22:02:461741linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1742override this option with `--no-abbrev-commit`.
Junio C Hamanof93530e2011-05-25 23:59:591743
Junio C Hamanob713ff12008-05-24 01:12:301744log.date::
Junio C Hamano2db3e752010-09-03 21:33:061745Set the default date-time mode for the 'log' command.
1746Setting a value for log.date is similar to using 'git log''s
Junio C Hamanob76a6862012-05-02 22:02:461747`--date` option. Possible values are `relative`, `local`,
Junio C Hamano2db3e752010-09-03 21:33:061748`default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1749for details.
Junio C Hamanob713ff12008-05-24 01:12:301750
Junio C Hamanocb39aea2010-05-09 07:24:481751log.decorate::
1752Print out the ref names of any commits that are shown by the log
1753command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1754'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1755specified, the full ref name (including prefix) will be printed.
1756This is the same as the log commands '--decorate' option.
1757
Junio C Hamano322c6242015-03-23 21:32:461758log.showRoot::
Junio C Hamanofe9acab2006-11-24 12:10:551759If true, the initial commit will be shown as a big creation event.
1760This is equivalent to a diff against an empty tree.
Junio C Hamano35738e82008-01-07 07:55:461761Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Junio C Hamanofe9acab2006-11-24 12:10:551762normally hide the root commit will now show it. True by default.
1763
Junio C Hamanoce836cc2013-01-21 02:01:531764log.mailmap::
1765If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1766linkgit:git-whatchanged[1] assume `--use-mailmap`.
1767
Junio C Hamano7f1bc9d2015-03-05 22:38:261768mailinfo.scissors::
1769If true, makes linkgit:git-mailinfo[1] (and therefore
1770linkgit:git-am[1]) act by default as if the --scissors option
1771was provided on the command-line. When active, this features
1772removes everything from the message body before a scissors
1773line (i.e. consisting mainly of ">8", "8<" and "-").
1774
Junio C Hamano8bc410e2009-02-15 10:38:191775mailmap.file::
1776The location of an augmenting mailmap file. The default
1777mailmap, located in the root of the repository, is loaded
1778first, then the mailmap file pointed to by this variable.
1779The location of the mailmap file may be in a repository
1780subdirectory, or somewhere outside of the repository itself.
1781See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1782
Junio C Hamanoabad6da2013-01-06 09:06:321783mailmap.blob::
1784Like `mailmap.file`, but consider the value as a reference to a
1785blob in the repository. If both `mailmap.file` and
1786`mailmap.blob` are given, both are parsed, with entries from
1787`mailmap.file` taking precedence. In a bare repository, this
1788defaults to `HEAD:.mailmap`. In a non-bare repository, it
1789defaults to empty.
1790
Junio C Hamano8b588d52008-03-15 09:48:371791man.viewer::
1792Specify the programs that may be used to display help in the
1793'man' format. See linkgit:git-help[1].
1794
Junio C Hamano6d76d612008-05-09 05:46:081795man.<tool>.cmd::
1796Specify the command to invoke the specified man viewer. The
1797specified command is evaluated in shell with the man page
1798passed as argument. (See linkgit:git-help[1].)
Junio C Hamano103ad7f2007-03-14 11:19:261799
Junio C Hamano6d76d612008-05-09 05:46:081800man.<tool>.path::
1801Override the path for the given tool that may be used to
1802display help in the 'man' format. See linkgit:git-help[1].
Junio C Hamanoe90436a2007-04-22 07:22:131803
Junio C Hamano4653c6f2008-11-26 22:50:201804include::merge-config.txt[]
Junio C Hamanoa476efa2008-10-10 15:31:421805
Junio C Hamano1fbbbc12007-12-18 07:01:271806mergetool.<tool>.path::
1807Override the path for the given tool. This is useful in case
1808your tool is not in the PATH.
1809
Junio C Hamano86bcccc2008-03-08 09:33:551810mergetool.<tool>.cmd::
1811Specify the command to invoke the specified merge tool. The
1812specified command is evaluated in shell with the following
1813variables available: 'BASE' is the name of a temporary file
1814containing the common base of the files to be merged, if available;
1815'LOCAL' is the name of a temporary file containing the contents of
1816the file on the current branch; 'REMOTE' is the name of a temporary
1817file containing the contents of the file from the branch being
1818merged; 'MERGED' contains the name of the file to which the merge
1819tool should write the results of a successful merge.
1820
1821mergetool.<tool>.trustExitCode::
1822For a custom merge command, specify whether the exit code of
1823the merge command can be used to determine whether the merge was
1824successful. If this is not set to true then the merge target file
1825timestamp is checked and the merge assumed to have been successful
1826if the file has been updated, otherwise the user is prompted to
1827indicate the success of the merge.
1828
Junio C Hamanoe478e402014-10-21 22:14:451829mergetool.meld.hasOutput::
1830Older versions of `meld` do not support the `--output` option.
1831Git will attempt to detect whether `meld` supports `--output`
1832by inspecting the output of `meld --help`. Configuring
1833`mergetool.meld.hasOutput` will make Git skip these checks and
1834use the configured value instead. Setting `mergetool.meld.hasOutput`
1835to `true` tells Git to unconditionally use the `--output` option,
1836and `false` avoids using `--output`.
1837
Junio C Hamano86bcccc2008-03-08 09:33:551838mergetool.keepBackup::
1839After performing a merge, the original file with conflict markers
1840can be saved as a file with a `.orig` extension. If this variable
1841is set to `false` then this file is not preserved. Defaults to
1842`true` (i.e. keep the backup files).
1843
Junio C Hamano10b7a342009-01-01 22:05:171844mergetool.keepTemporaries::
Junio C Hamano076ffcc2013-02-06 05:13:211845When invoking a custom merge tool, Git uses a set of temporary
Junio C Hamano10b7a342009-01-01 22:05:171846files to pass to the tool. If the tool returns an error and this
1847variable is set to `true`, then these temporary files will be
1848preserved, otherwise they will be removed after the tool has
1849exited. Defaults to `false`.
1850
Junio C Hamanoe478e402014-10-21 22:14:451851mergetool.writeToTemp::
1852Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
1853conflicting files in the worktree by default. Git will attempt
1854to use a temporary directory for these files when set `true`.
1855Defaults to `false`.
1856
Junio C Hamano10b7a342009-01-01 22:05:171857mergetool.prompt::
1858Prompt before each invocation of the merge resolution program.
1859
Junio C Hamano31667362010-03-25 00:38:531860notes.displayRef::
1861The (fully qualified) refname from which to show notes when
1862showing commit messages. The value of this variable can be set
1863to a glob, in which case notes from all matching refs will be
1864shown. You may also specify this configuration variable
1865several times. A warning will be issued for refs that do not
1866exist, but a glob that does not match any refs is silently
1867ignored.
1868+
1869This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1870environment variable, which must be a colon separated list of refs or
1871globs.
1872+
1873The effective value of "core.notesRef" (possibly overridden by
1874GIT_NOTES_REF) is also implicitly added to the list of refs to be
1875displayed.
1876
1877notes.rewrite.<command>::
1878When rewriting commits with <command> (currently `amend` or
Junio C Hamano076ffcc2013-02-06 05:13:211879`rebase`) and this variable is set to `true`, Git
Junio C Hamano31667362010-03-25 00:38:531880automatically copies your notes from the original to the
1881rewritten commit. Defaults to `true`, but see
1882"notes.rewriteRef" below.
Junio C Hamano31667362010-03-25 00:38:531883
1884notes.rewriteMode::
1885When copying notes during a rewrite (see the
1886"notes.rewrite.<command>" option), determines what to do if
1887the target commit already has a note. Must be one of
1888`overwrite`, `concatenate`, or `ignore`. Defaults to
1889`concatenate`.
1890+
1891This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1892environment variable.
1893
1894notes.rewriteRef::
1895When copying notes during a rewrite, specifies the (fully
1896qualified) ref whose notes should be copied. The ref may be a
1897glob, in which case notes in all matching refs will be copied.
1898You may also specify this configuration several times.
1899+
1900Does not have a default value; you must configure this variable to
Junio C Hamano8fb66e52011-10-05 20:59:511901enable note rewriting. Set it to `refs/notes/commits` to enable
1902rewriting for the default commit notes.
Junio C Hamano2b3ee5d2010-05-08 05:41:181903+
1904This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1905environment variable, which must be a colon separated list of refs or
1906globs.
Junio C Hamano31667362010-03-25 00:38:531907
Junio C Hamano75cc4c92006-07-24 08:25:031908pack.window::
Junio C Hamano35738e82008-01-07 07:55:461909The size of the window used by linkgit:git-pack-objects[1] when no
Junio C Hamano75cc4c92006-07-24 08:25:031910window size is given on the command line. Defaults to 10.
1911
Junio C Hamano91d44c52007-05-09 07:16:071912pack.depth::
Junio C Hamano35738e82008-01-07 07:55:461913The maximum delta depth used by linkgit:git-pack-objects[1] when no
Junio C Hamano91d44c52007-05-09 07:16:071914maximum depth is given on the command line. Defaults to 50.
1915
Junio C Hamano235d53f2007-07-13 00:25:151916pack.windowMemory::
Junio C Hamano2a4bcbc2014-10-29 20:07:391917The maximum size of memory that is consumed by each thread
1918in linkgit:git-pack-objects[1] for pack window memory when
1919no limit is given on the command line. The value can be
1920suffixed with "k", "m", or "g". When left unconfigured (or
1921set explicitly to 0), there will be no limit.
Junio C Hamano235d53f2007-07-13 00:25:151922
Junio C Hamanof2ce2972007-05-20 19:12:091923pack.compression::
1924An integer -1..9, indicating the compression level for objects
1925in a pack file. -1 is the zlib default. 0 means no
1926compression, and 1..9 are various speed/size tradeoffs, 9 being
1927slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:421928not set, defaults to -1, the zlib default, which is "a default
1929compromise between speed and compression (currently equivalent
1930to level 6)."
Junio C Hamano657fd8a2010-10-07 00:01:241931+
1932Note that changing the compression level will not automatically recompress
1933all existing objects. You can force recompression by passing the -F option
1934to linkgit:git-repack[1].
Junio C Hamanof2ce2972007-05-20 19:12:091935
Junio C Hamano679d22d2007-06-02 21:13:441936pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:271937The maximum memory in bytes used for caching deltas in
Junio C Hamano9f883862009-08-11 06:23:521938linkgit:git-pack-objects[1] before writing them out to a pack.
1939This cache is used to speed up the writing object phase by not
1940having to recompute the final delta result once the best match
1941for all objects is found. Repacking large repositories on machines
1942which are tight with memory might be badly impacted by this though,
1943especially if this cache pushes the system into swapping.
1944A value of 0 means no limit. The smallest size of 1 byte may be
1945used to virtually disable this cache. Defaults to 256 MiB.
Junio C Hamano679d22d2007-06-02 21:13:441946
1947pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:141948The maximum size of a delta, that is cached in
Junio C Hamano9f883862009-08-11 06:23:521949linkgit:git-pack-objects[1]. This cache is used to speed up the
1950writing object phase by not having to recompute the final delta
1951result once the best match for all objects is found. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:441952
Junio C Hamano58155b42007-09-15 07:46:141953pack.threads::
1954Specifies the number of threads to spawn when searching for best
Junio C Hamano35738e82008-01-07 07:55:461955delta matches. This requires that linkgit:git-pack-objects[1]
Junio C Hamano58155b42007-09-15 07:46:141956be compiled with pthreads otherwise this option is ignored with a
1957warning. This is meant to reduce packing time on multiprocessor
1958machines. The required amount of memory for the delta search window
1959is however multiplied by the number of threads.
Junio C Hamano076ffcc2013-02-06 05:13:211960Specifying 0 will cause Git to auto-detect the number of CPU's
Junio C Hamano24bc09a2008-02-28 00:27:441961and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:141962
Junio C Hamanod814b6d2007-11-04 11:13:491963pack.indexVersion::
1964Specify the default pack index version. Valid values are 1 for
1965legacy pack index used by Git versions prior to 1.5.2, and 2 for
1966the new pack index with capabilities for packs larger than 4 GB
1967as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:381968packs. Version 2 is the default. Note that version 2 is enforced
1969and this config option ignored whenever the corresponding pack is
1970larger than 2 GB.
1971+
Junio C Hamano076ffcc2013-02-06 05:13:211972If you have an old Git that does not understand the version 2 `*.idx` file,
Junio C Hamanofce7c7e2008-07-02 03:06:381973cloning or fetching over a non native protocol (e.g. "http" and "rsync")
Junio C Hamanob76a6862012-05-02 22:02:461974that will copy both `*.pack` file and corresponding `*.idx` file from the
Junio C Hamanofce7c7e2008-07-02 03:06:381975other side may give you a repository that cannot be accessed with your
Junio C Hamano076ffcc2013-02-06 05:13:211976older version of Git. If the `*.pack` file is smaller than 2 GB, however,
Junio C Hamanofce7c7e2008-07-02 03:06:381977you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
Junio C Hamanob76a6862012-05-02 22:02:461978the `*.idx` file.
Junio C Hamanod814b6d2007-11-04 11:13:491979
Junio C Hamano09a926d2008-03-13 07:55:291980pack.packSizeLimit::
Junio C Hamano4d979582010-02-04 06:27:291981The maximum size of a pack. This setting only affects
1982packing to a file when repacking, i.e. the git:// protocol
Junio C Hamanob76a6862012-05-02 22:02:461983is unaffected. It can be overridden by the `--max-pack-size`
Junio C Hamano4d979582010-02-04 06:27:291984option of linkgit:git-repack[1]. The minimum size allowed is
1985limited to 1 MiB. The default is unlimited.
1986Common unit suffixes of 'k', 'm', or 'g' are
1987supported.
Junio C Hamano49dccaf2008-02-10 10:48:011988
Junio C Hamano5b3533d2014-02-27 23:07:151989pack.useBitmaps::
1990When true, git will use pack bitmaps (if available) when packing
1991to stdout (e.g., during the server side of a fetch). Defaults to
1992true. You should not generally need to turn this off unless
1993you are debugging pack bitmaps.
1994
Junio C Hamano322c6242015-03-23 21:32:461995pack.writeBitmaps (deprecated)::
Junio C Hamano38d02532014-06-26 21:48:501996This is a deprecated synonym for `repack.writeBitmaps`.
Junio C Hamano5b3533d2014-02-27 23:07:151997
1998pack.writeBitmapHashCache::
1999When true, git will include a "hash cache" section in the bitmap
2000index (if one is written). This cache can be used to feed git's
2001delta heuristics, potentially leading to better deltas between
2002bitmapped and non-bitmapped objects (e.g., when serving a fetch
2003between an older, bitmapped pack and objects that have been
2004pushed since the last gc). The downside is that it consumes 4
2005bytes per object of disk space, and that JGit's bitmap
2006implementation does not understand it, causing it to complain if
2007Git and JGit are used on the same repository. Defaults to false.
2008
Junio C Hamano9e96a1a2008-08-16 10:23:182009pager.<cmd>::
Junio C Hamano788eeba2010-12-08 22:50:432010If the value is boolean, turns on or off pagination of the
Junio C Hamano076ffcc2013-02-06 05:13:212011output of a particular Git subcommand when writing to a tty.
Junio C Hamano788eeba2010-12-08 22:50:432012Otherwise, turns on pagination for the subcommand using the
Junio C Hamanob76a6862012-05-02 22:02:462013pager specified by the value of `pager.<cmd>`. If `--paginate`
2014or `--no-pager` is specified on the command line, it takes
Junio C Hamano788eeba2010-12-08 22:50:432015precedence over this option. To disable pagination for all
2016commands, set `core.pager` or `GIT_PAGER` to `cat`.
Junio C Hamano9e96a1a2008-08-16 10:23:182017
Junio C Hamanoa574a092010-06-13 19:57:102018pretty.<name>::
2019Alias for a --pretty= format string, as specified in
2020linkgit:git-log[1]. Any aliases defined here can be used just
2021as the built-in pretty formats could. For example,
Junio C Hamanob76a6862012-05-02 22:02:462022running `git config pretty.changelog "format:* %H %s"`
Junio C Hamanoa574a092010-06-13 19:57:102023would cause the invocation `git log --pretty=changelog`
Junio C Hamanob76a6862012-05-02 22:02:462024to be equivalent to running `git log "--pretty=format:* %H %s"`.
Junio C Hamanoa574a092010-06-13 19:57:102025Note that an alias with the same name as a built-in format
2026will be silently ignored.
2027
Junio C Hamano5b3533d2014-02-27 23:07:152028pull.ff::
2029By default, Git does not create an extra merge commit when merging
2030a commit that is a descendant of the current commit. Instead, the
2031tip of the current branch is fast-forwarded. When set to `false`,
2032this variable tells Git to create an extra merge commit in such
2033a case (equivalent to giving the `--no-ff` option from the command
2034line). When set to `only`, only such fast-forward merges are
2035allowed (equivalent to giving the `--ff-only` option from the
2036command line).
2037
Junio C Hamano515ab1d2011-12-09 23:41:202038pull.rebase::
2039When true, rebase branches on top of the fetched branch, instead
2040of merging the default branch from the default remote when "git
2041pull" is run. See "branch.<name>.rebase" for setting this on a
2042per-branch basis.
2043+
Junio C Hamanocf4a1742013-09-11 22:57:502044When preserve, also pass `--preserve-merges` along to 'git rebase'
2045so that locally committed merge commits will not be flattened
2046by running 'git pull'.
2047+
Junio C Hamano515ab1d2011-12-09 23:41:202048*NOTE*: this is a possibly dangerous operation; do *not* use
2049it unless you understand the implications (see linkgit:git-rebase[1]
2050for details).
2051
Junio C Hamano07824ce2006-04-25 07:36:542052pull.octopus::
2053The default merge strategy to use when pulling multiple branches
2054at once.
2055
2056pull.twohead::
2057The default merge strategy to use when pulling a single branch.
2058
Junio C Hamano1de75722009-03-26 08:39:382059push.default::
Junio C Hamano58655592013-07-11 20:52:332060Defines the action `git push` should take if no refspec is
2061explicitly given. Different values are well-suited for
2062specific workflows; for instance, in a purely central workflow
2063(i.e. the fetch source is equal to the push destination),
2064`upstream` is probably what you want. Possible values are:
Junio C Hamano1de75722009-03-26 08:39:382065+
Junio C Hamanobcaa8bc2012-07-03 22:17:202066--
Junio C Hamano58655592013-07-11 20:52:332067
2068* `nothing` - do not push anything (error out) unless a refspec is
2069 explicitly given. This is primarily meant for people who want to
2070 avoid mistakes by always being explicit.
2071
2072* `current` - push the current branch to update a branch with the same
2073 name on the receiving end. Works in both central and non-central
2074 workflows.
2075
2076* `upstream` - push the current branch back to the branch whose
2077 changes are usually integrated into the current branch (which is
2078 called `@{upstream}`). This mode only makes sense if you are
2079 pushing to the same repository you would normally pull from
2080 (i.e. central workflow).
2081
2082* `simple` - in centralized workflow, work like `upstream` with an
2083 added safety to refuse to push if the upstream branch's name is
2084 different from the local one.
Junio C Hamanobcaa8bc2012-07-03 22:17:202085+
Junio C Hamano58655592013-07-11 20:52:332086When pushing to a remote that is different from the remote you normally
2087pull from, work as `current`. This is the safest option and is suited
2088for beginners.
2089+
Junio C Hamano1d669b82014-03-11 21:36:002090This mode has become the default in Git 2.0.
Junio C Hamano58655592013-07-11 20:52:332091
2092* `matching` - push all branches having the same name on both ends.
2093 This makes the repository you are pushing to remember the set of
2094 branches that will be pushed out (e.g. if you always push 'maint'
2095 and 'master' there and no other branches, the repository you push
2096 to will have these two branches, and your local 'maint' and
2097 'master' will be pushed there).
2098+
2099To use this mode effectively, you have to make sure _all_ the
2100branches you would push out are ready to be pushed out before
2101running 'git push', as the whole point of this mode is to allow you
2102to push all of the branches in one go. If you usually finish work
2103on only one branch and push out the result, while other branches are
2104unfinished, this mode is not for you. Also this mode is not
2105suitable for pushing into a shared central repository, as other
2106people may add new branches there, or update the tip of existing
2107branches outside your control.
2108+
Junio C Hamano1d669b82014-03-11 21:36:002109This used to be the default, but not since Git 2.0 (`simple` is the
2110new default).
Junio C Hamano58655592013-07-11 20:52:332111
2112--
Junio C Hamano1de75722009-03-26 08:39:382113
Junio C Hamano322c6242015-03-23 21:32:462114push.followTags::
2115If set to true enable '--follow-tags' option by default. You
2116may override this configuration at time of push by specifying
2117'--no-follow-tags'.
2118
2119
Junio C Hamanoea6a7642009-03-11 23:56:192120rebase.stat::
2121Whether to show a diffstat of what changed upstream since the last
2122rebase. False by default.
2123
Junio C Hamano322c6242015-03-23 21:32:462124rebase.autoSquash::
Junio C Hamano075ae872010-09-01 18:43:072125If set to true enable '--autosquash' option by default.
2126
Junio C Hamano322c6242015-03-23 21:32:462127rebase.autoStash::
Junio C Hamanof1f5a7b2013-06-11 22:23:522128When set to true, automatically create a temporary stash
2129before the operation begins, and apply it after the operation
2130ends. This means that you can run rebase on a dirty worktree.
2131However, use with care: the final stash application after a
2132successful rebase might result in non-trivial conflicts.
2133Defaults to false.
2134
Junio C Hamano322c6242015-03-23 21:32:462135receive.advertiseAtomic::
Junio C Hamano6bb32e62015-02-17 22:11:262136By default, git-receive-pack will advertise the atomic push
2137capability to its clients. If you don't want to this capability
2138to be advertised, set this variable to false.
2139
Junio C Hamano621e1232009-10-26 05:16:472140receive.autogc::
2141By default, git-receive-pack will run "git-gc --auto" after
2142receiving data from git-push and updating refs. You can stop
2143it by setting this variable to false.
2144
Junio C Hamano322c6242015-03-23 21:32:462145receive.certNonceSeed::
Junio C Hamano9236fea2014-10-14 22:28:092146By setting this variable to a string, `git receive-pack`
2147will accept a `git push --signed` and verifies it by using
2148a "nonce" protected by HMAC using this string as a secret
2149key.
2150
Junio C Hamano322c6242015-03-23 21:32:462151receive.certNonceSlop::
Junio C Hamano9236fea2014-10-14 22:28:092152When a `git push --signed` sent a push certificate with a
2153"nonce" that was issued by a receive-pack serving the same
2154repository within this many seconds, export the "nonce"
2155found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2156hooks (instead of what the receive-pack asked the sending
2157side to include). This may allow writing checks in
2158`pre-receive` and `post-receive` a bit easier. Instead of
2159checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2160that records by how many seconds the nonce is stale to
2161decide if they want to accept the certificate, they only
2162can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2163
Junio C Hamano4653c6f2008-11-26 22:50:202164receive.fsckObjects::
2165If it is set to true, git-receive-pack will check all received
2166objects. It will abort in the case of a malformed object or a
2167broken link. The result of an abort are only dangling objects.
Junio C Hamano8fb66e52011-10-05 20:59:512168Defaults to false. If not set, the value of `transfer.fsckObjects`
2169is used instead.
Junio C Hamano4653c6f2008-11-26 22:50:202170
2171receive.unpackLimit::
2172If the number of objects received in a push is below this
2173limit then the objects will be unpacked into loose object
2174files. However if the number of received objects equals or
2175exceeds this limit then the received pack will be stored as
2176a pack, after adding any missing delta bases. Storing the
2177pack from a push can make the push operation complete faster,
2178especially on slow filesystems. If not set, the value of
2179`transfer.unpackLimit` is used instead.
2180
2181receive.denyDeletes::
2182If set to true, git-receive-pack will deny a ref update that deletes
2183the ref. Use this to prevent such a ref deletion via a push.
2184
Junio C Hamanob4448a82010-07-26 09:02:322185receive.denyDeleteCurrent::
2186If set to true, git-receive-pack will deny a ref update that
2187deletes the currently checked out branch of a non-bare repository.
2188
Junio C Hamano4653c6f2008-11-26 22:50:202189receive.denyCurrentBranch::
Junio C Hamanoe97d5772010-05-19 08:13:582190If set to true or "refuse", git-receive-pack will deny a ref update
Junio C Hamano4653c6f2008-11-26 22:50:202191to the currently checked out branch of a non-bare repository.
2192Such a push is potentially dangerous because it brings the HEAD
2193out of sync with the index and working tree. If set to "warn",
2194print a warning of such a push to stderr, but allow the push to
2195proceed. If set to false or "ignore", allow such pushes with no
Junio C Hamanoafb395b2010-03-17 22:16:152196message. Defaults to "refuse".
Junio C Hamano6df93d92014-12-22 22:48:092197+
2198Another option is "updateInstead" which will update the working
Junio C Hamano6bb32e62015-02-17 22:11:262199tree if pushing into the current branch. This option is
Junio C Hamano6df93d92014-12-22 22:48:092200intended for synchronizing working directories when one side is not easily
2201accessible via interactive ssh (e.g. a live web site, hence the requirement
2202that the working directory be clean). This mode also comes in handy when
2203developing inside a VM to test and fix code on different Operating Systems.
Junio C Hamano6bb32e62015-02-17 22:11:262204+
2205By default, "updateInstead" will refuse the push if the working tree or
2206the index have any difference from the HEAD, but the `push-to-checkout`
2207hook can be used to customize this. See linkgit:githooks[5].
Junio C Hamano4653c6f2008-11-26 22:50:202208
2209receive.denyNonFastForwards::
2210If set to true, git-receive-pack will deny a ref update which is
Junio C Hamano3f680f32009-11-16 02:10:542211not a fast-forward. Use this to prevent such an update via a push,
Junio C Hamano4653c6f2008-11-26 22:50:202212even if that push is forced. This configuration variable is
2213set when initializing a shared repository.
2214
Junio C Hamano322c6242015-03-23 21:32:462215receive.hideRefs::
Junio C Hamano80ad00d2013-02-18 00:19:032216String(s) `receive-pack` uses to decide which refs to omit
2217from its initial advertisement. Use more than one
2218definitions to specify multiple prefix strings. A ref that
2219are under the hierarchies listed on the value of this
2220variable is excluded, and is hidden when responding to `git
2221push`, and an attempt to update or delete a hidden ref by
2222`git push` is rejected.
2223
Junio C Hamano322c6242015-03-23 21:32:462224receive.updateServerInfo::
Junio C Hamano621e1232009-10-26 05:16:472225If set to true, git-receive-pack will run git-update-server-info
2226after receiving data from git-push and updating refs.
2227
Junio C Hamano322c6242015-03-23 21:32:462228receive.shallowUpdate::
Junio C Hamano61525f92014-01-17 22:46:492229If set to true, .git/shallow can be updated when new refs
2230require new shallow roots. Otherwise those refs are rejected.
2231
Junio C Hamano322c6242015-03-23 21:32:462232remote.pushDefault::
Junio C Hamano63b6fdb2013-04-07 23:37:132233The remote to push to by default. Overrides
2234`branch.<name>.remote` for all branches, and is overridden by
Junio C Hamano322c6242015-03-23 21:32:462235`branch.<name>.pushRemote` for specific branches.
Junio C Hamano63b6fdb2013-04-07 23:37:132236
Junio C Hamano249572f2006-10-24 05:44:082237remote.<name>.url::
Junio C Hamano35738e82008-01-07 07:55:462238The URL of a remote repository. See linkgit:git-fetch[1] or
2239linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:082240
Junio C Hamano0e88f3e2009-06-21 08:03:252241remote.<name>.pushurl::
2242The push URL of a remote repository. See linkgit:git-push[1].
2243
Junio C Hamano58256872007-12-04 08:31:132244remote.<name>.proxy::
2245For remotes that require curl (http, https and ftp), the URL to
2246the proxy to use for that remote. Set to the empty string to
2247disable proxying for that remote.
2248
Junio C Hamano249572f2006-10-24 05:44:082249remote.<name>.fetch::
Junio C Hamano35738e82008-01-07 07:55:462250The default set of "refspec" for linkgit:git-fetch[1]. See
2251linkgit:git-fetch[1].
Junio C Hamano249572f2006-10-24 05:44:082252
2253remote.<name>.push::
Junio C Hamano35738e82008-01-07 07:55:462254The default set of "refspec" for linkgit:git-push[1]. See
2255linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:082256
Junio C Hamano47d68a52008-05-06 06:35:402257remote.<name>.mirror::
2258If true, pushing to this remote will automatically behave
Junio C Hamanob76a6862012-05-02 22:02:462259as if the `--mirror` option was given on the command line.
Junio C Hamano47d68a52008-05-06 06:35:402260
Junio C Hamano118d2772007-02-21 20:24:102261remote.<name>.skipDefaultUpdate::
2262If true, this remote will be skipped by default when updating
Junio C Hamano9df0c662009-11-23 11:09:272263using linkgit:git-fetch[1] or the `update` subcommand of
2264linkgit:git-remote[1].
2265
2266remote.<name>.skipFetchAll::
2267If true, this remote will be skipped by default when updating
2268using linkgit:git-fetch[1] or the `update` subcommand of
2269linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:102270
Junio C Hamano4ad294b2007-01-20 02:22:502271remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:482272The default program to execute on the remote side when pushing. See
Junio C Hamano86bcccc2008-03-08 09:33:552273option \--receive-pack of linkgit:git-push[1].
Junio C Hamano4ad294b2007-01-20 02:22:502274
Junio C Hamano54ea8d32007-01-25 07:59:482275remote.<name>.uploadpack::
2276The default program to execute on the remote side when fetching. See
Junio C Hamano86bcccc2008-03-08 09:33:552277option \--upload-pack of linkgit:git-fetch-pack[1].
Junio C Hamano54ea8d32007-01-25 07:59:482278
Junio C Hamano322c6242015-03-23 21:32:462279remote.<name>.tagOpt::
Junio C Hamano86bcccc2008-03-08 09:33:552280Setting this value to \--no-tags disables automatic tag following when
Junio C Hamanocc7636a2010-05-21 14:57:532281fetching from remote <name>. Setting it to \--tags will fetch every
2282tag from remote <name>, even if they are not reachable from remote
Junio C Hamano075ae872010-09-01 18:43:072283branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2284override this setting. See options \--tags and \--no-tags of
2285linkgit:git-fetch[1].
Junio C Hamano17dde0e2007-02-26 09:50:212286
Junio C Hamano096dde22009-12-26 23:14:112287remote.<name>.vcs::
Junio C Hamano076ffcc2013-02-06 05:13:212288Setting this to a value <vcs> will cause Git to interact with
Junio C Hamano096dde22009-12-26 23:14:112289the remote with the git-remote-<vcs> helper.
2290
Junio C Hamano8eac2682013-09-09 22:35:202291remote.<name>.prune::
2292When set to true, fetching from this remote by default will also
Junio C Hamano4c8f2d92013-12-13 00:55:422293remove any remote-tracking references that no longer exist on the
2294remote (as if the `--prune` option was given on the command line).
Junio C Hamano8eac2682013-09-09 22:35:202295Overrides `fetch.prune` settings, if any.
2296
Junio C Hamano118d2772007-02-21 20:24:102297remotes.<group>::
2298The list of remotes which are fetched by "git remote update
Junio C Hamano35738e82008-01-07 07:55:462299<group>". See linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:102300
Junio C Hamano322c6242015-03-23 21:32:462301repack.useDeltaBaseOffset::
Junio C Hamanofce7c7e2008-07-02 03:06:382302By default, linkgit:git-repack[1] creates packs that use
2303delta-base offset. If you need to share your repository with
Junio C Hamano076ffcc2013-02-06 05:13:212304Git older than version 1.4.4, either directly or via a dumb
Junio C Hamanofce7c7e2008-07-02 03:06:382305protocol such as http, then you need to set this option to
Junio C Hamano076ffcc2013-02-06 05:13:212306"false" and repack. Access from old Git versions over the
Junio C Hamanofce7c7e2008-07-02 03:06:382307native protocol are unaffected by this option.
Junio C Hamano77b7e902006-10-23 07:18:502308
Junio C Hamano3b0cdc22014-03-18 22:06:162309repack.packKeptObjects::
2310If set to true, makes `git repack` act as if
2311`--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2312details. Defaults to `false` normally, but `true` if a bitmap
2313index is being written (either via `--write-bitmap-index` or
Junio C Hamano38d02532014-06-26 21:48:502314`repack.writeBitmaps`).
2315
2316repack.writeBitmaps::
2317When true, git will write a bitmap index when packing all
2318objects to disk (e.g., when `git repack -a` is run). This
2319index can speed up the "counting objects" phase of subsequent
2320packs created for clones and fetches, at the cost of some disk
2321space and extra time spent on the initial repack. Defaults to
2322false.
Junio C Hamano3b0cdc22014-03-18 22:06:162323
Junio C Hamano322c6242015-03-23 21:32:462324rerere.autoUpdate::
Junio C Hamano4653c6f2008-11-26 22:50:202325When set to true, `git-rerere` updates the index with the
2326resulting contents after it cleanly resolves conflicts using
2327previously recorded resolution. Defaults to false.
2328
2329rerere.enabled::
2330Activate recording of resolved conflicts, so that identical
Junio C Hamano4fd24422012-01-06 21:52:432331conflict hunks can be resolved automatically, should they be
2332encountered again. By default, linkgit:git-rerere[1] is
2333enabled if there is an `rr-cache` directory under the
Junio C Hamano864ba892012-01-13 17:42:052334`$GIT_DIR`, e.g. if "rerere" was previously used in the
2335repository.
Junio C Hamano4653c6f2008-11-26 22:50:202336
Junio C Hamano1bbd0f42009-07-23 06:20:292337sendemail.identity::
2338A configuration identity. When given, causes values in the
2339'sendemail.<identity>' subsection to take precedence over
2340values in the 'sendemail' section. The default identity is
2341the value of 'sendemail.identity'.
2342
Junio C Hamano322c6242015-03-23 21:32:462343sendemail.smtpEncryption::
Junio C Hamano1bbd0f42009-07-23 06:20:292344See linkgit:git-send-email[1] for description. Note that this
2345setting is not subject to the 'identity' mechanism.
2346
Junio C Hamanobe087982015-02-22 21:29:392347sendemail.smtpssl (deprecated)::
Junio C Hamano322c6242015-03-23 21:32:462348Deprecated alias for 'sendemail.smtpEncryption = ssl'.
Junio C Hamano1bbd0f42009-07-23 06:20:292349
Junio C Hamano58f587a2013-07-22 19:20:592350sendemail.smtpsslcertpath::
2351Path to ca-certificates (either a directory or a single file).
2352Set it to an empty string to disable certificate verification.
2353
Junio C Hamano1bbd0f42009-07-23 06:20:292354sendemail.<identity>.*::
2355Identity-specific versions of the 'sendemail.*' parameters
2356found below, taking precedence over those when the this
2357identity is selected, through command-line or
2358'sendemail.identity'.
2359
Junio C Hamano322c6242015-03-23 21:32:462360sendemail.aliasesFile::
2361sendemail.aliasFileType::
Junio C Hamanoea3b7522013-04-18 19:37:532362sendemail.annotate::
Junio C Hamano1bbd0f42009-07-23 06:20:292363sendemail.bcc::
2364sendemail.cc::
Junio C Hamano322c6242015-03-23 21:32:462365sendemail.ccCmd::
2366sendemail.chainReplyTo::
Junio C Hamano1bbd0f42009-07-23 06:20:292367sendemail.confirm::
Junio C Hamano322c6242015-03-23 21:32:462368sendemail.envelopeSender::
Junio C Hamano1bbd0f42009-07-23 06:20:292369sendemail.from::
Junio C Hamano322c6242015-03-23 21:32:462370sendemail.multiEdit::
Junio C Hamano1bbd0f42009-07-23 06:20:292371sendemail.signedoffbycc::
Junio C Hamano322c6242015-03-23 21:32:462372sendemail.smtpPass::
Junio C Hamano1bbd0f42009-07-23 06:20:292373sendemail.suppresscc::
Junio C Hamano322c6242015-03-23 21:32:462374sendemail.suppressFrom::
Junio C Hamano1bbd0f42009-07-23 06:20:292375sendemail.to::
Junio C Hamano322c6242015-03-23 21:32:462376sendemail.smtpDomain::
2377sendemail.smtpServer::
2378sendemail.smtpServerPort::
2379sendemail.smtpServerOption::
2380sendemail.smtpUser::
Junio C Hamano1bbd0f42009-07-23 06:20:292381sendemail.thread::
Junio C Hamano322c6242015-03-23 21:32:462382sendemail.transferEncoding::
Junio C Hamano1bbd0f42009-07-23 06:20:292383sendemail.validate::
Junio C Hamanoc9394b22015-01-07 22:45:482384sendemail.xmailer::
Junio C Hamano1bbd0f42009-07-23 06:20:292385See linkgit:git-send-email[1] for description.
2386
Junio C Hamanobe087982015-02-22 21:29:392387sendemail.signedoffcc (deprecated)::
Junio C Hamano1bbd0f42009-07-23 06:20:292388Deprecated alias for 'sendemail.signedoffbycc'.
2389
Junio C Hamano07824ce2006-04-25 07:36:542390showbranch.default::
Junio C Hamano35738e82008-01-07 07:55:462391The default set of branches for linkgit:git-show-branch[1].
2392See linkgit:git-show-branch[1].
Junio C Hamano07824ce2006-04-25 07:36:542393
Junio C Hamano942b35e2007-12-09 10:19:332394status.relativePaths::
Junio C Hamano35738e82008-01-07 07:55:462395By default, linkgit:git-status[1] shows paths relative to the
Junio C Hamano942b35e2007-12-09 10:19:332396current directory. Setting this variable to `false` shows paths
Junio C Hamano076ffcc2013-02-06 05:13:212397relative to the repository root (this was the default for Git
Junio C Hamano942b35e2007-12-09 10:19:332398prior to v1.5.4).
2399
Junio C Hamano58655592013-07-11 20:52:332400status.short::
2401Set to true to enable --short by default in linkgit:git-status[1].
2402The option --no-short takes precedence over this variable.
2403
2404status.branch::
2405Set to true to enable --branch by default in linkgit:git-status[1].
2406The option --no-branch takes precedence over this variable.
2407
Junio C Hamano79f4c7c2013-09-20 21:03:372408status.displayCommentPrefix::
2409If set to true, linkgit:git-status[1] will insert a comment
2410prefix before each output line (starting with
2411`core.commentChar`, i.e. `#` by default). This was the
2412behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2413Defaults to false.
2414
Junio C Hamano4224f992008-06-23 07:14:082415status.showUntrackedFiles::
2416By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2417files which are not currently tracked by Git. Directories which
2418contain only untracked files, are shown with the directory name
2419only. Showing untracked files means that Git needs to lstat() all
Junio C Hamano2efd5e42014-11-10 22:38:522420the files in the whole repository, which might be slow on some
Junio C Hamano4224f992008-06-23 07:14:082421systems. So, this variable controls how the commands displays
2422the untracked files. Possible values are:
2423+
2424--
Junio C Hamano7f9fa862010-10-19 23:51:142425* `no` - Show no untracked files.
2426* `normal` - Show untracked files and directories.
2427* `all` - Show also individual files in untracked directories.
Junio C Hamano4224f992008-06-23 07:14:082428--
2429+
2430If this variable is not specified, it defaults to 'normal'.
2431This variable can be overridden with the -u|--untracked-files option
2432of linkgit:git-status[1] and linkgit:git-commit[1].
2433
Junio C Hamano322c6242015-03-23 21:32:462434status.submoduleSummary::
Junio C Hamanob671fb52010-06-01 05:06:142435Defaults to false.
2436If this is set to a non zero number or true (identical to -1 or an
2437unlimited number), the submodule summary will be enabled and a
2438summary of commits for modified submodules will be shown (see
Junio C Hamano369e3402013-10-15 18:40:252439--summary-limit option of linkgit:git-submodule[1]). Please note
2440that the summary output command will be suppressed for all
2441submodules when `diff.ignoreSubmodules` is set to 'all' or only
Junio C Hamanoc8c398a2014-06-16 21:14:052442for those submodules where `submodule.<name>.ignore=all`. The only
2443exception to that rule is that status and commit will show staged
2444submodule changes. To
Junio C Hamano369e3402013-10-15 18:40:252445also view the summary for ignored submodules you can either use
Junio C Hamanoe1aeb5e2014-06-06 19:16:292446the --ignore-submodules=dirty command-line option or the 'git
Junio C Hamano369e3402013-10-15 18:40:252447submodule summary' command, which shows a similar output but does
2448not honor these settings.
Junio C Hamanob671fb52010-06-01 05:06:142449
Junio C Hamano78e3a782010-07-15 22:24:452450submodule.<name>.path::
2451submodule.<name>.url::
Junio C Hamano6bf68cf2015-03-06 23:46:292452The path within this project and URL for a submodule. These
2453variables are initially populated by 'git submodule init'. See
2454linkgit:git-submodule[1] and linkgit:gitmodules[5] for
2455details.
2456
Junio C Hamano78e3a782010-07-15 22:24:452457submodule.<name>.update::
Junio C Hamano6bf68cf2015-03-06 23:46:292458The default update procedure for a submodule. This variable
2459is populated by `git submodule init` from the
2460linkgit:gitmodules[5] file. See description of 'update'
2461command in linkgit:git-submodule[1].
Junio C Hamano78e3a782010-07-15 22:24:452462
Junio C Hamanoabad6da2013-01-06 09:06:322463submodule.<name>.branch::
2464The remote branch name for a submodule, used by `git submodule
2465update --remote`. Set this option to override the value found in
2466the `.gitmodules` file. See linkgit:git-submodule[1] and
2467linkgit:gitmodules[5] for details.
2468
Junio C Hamano0d75e872010-12-17 06:57:262469submodule.<name>.fetchRecurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:102470This option can be used to control recursive fetching of this
Junio C Hamano7165bf72011-01-04 22:06:182471submodule. It can be overridden by using the --[no-]recurse-submodules
Junio C Hamanoe1aeb5e2014-06-06 19:16:292472command-line option to "git fetch" and "git pull".
Junio C Hamano0d75e872010-12-17 06:57:262473This setting will override that from in the linkgit:gitmodules[5]
2474file.
2475
Junio C Hamano619596a2010-08-18 22:15:352476submodule.<name>.ignore::
2477Defines under what circumstances "git status" and the diff family show
2478a submodule as modified. When set to "all", it will never be considered
Junio C Hamanoc8c398a2014-06-16 21:14:052479modified (but it will nonetheless show up in the output of status and
2480commit when it has been staged), "dirty" will ignore all changes
2481to the submodules work tree and
Junio C Hamano619596a2010-08-18 22:15:352482takes only differences between the HEAD of the submodule and the commit
2483recorded in the superproject into account. "untracked" will additionally
2484let submodules with modified tracked files in their work tree show up.
2485Using "none" (the default when this option is not set) also shows
2486submodules that have untracked files in their work tree as changed.
2487This setting overrides any setting made in .gitmodules for this submodule,
Junio C Hamanode9745c2010-08-23 17:10:182488both settings can be overridden on the command line by using the
Junio C Hamano369e3402013-10-15 18:40:252489"--ignore-submodules" option. The 'git submodule' commands are not
2490affected by this setting.
Junio C Hamano619596a2010-08-18 22:15:352491
Junio C Hamano7b43d412014-07-23 23:09:442492tag.sort::
2493This variable controls the sort ordering of tags when displayed by
2494linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2495value of this variable will be used as the default.
2496
Junio C Hamano75cc4c92006-07-24 08:25:032497tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:092498This variable can be used to restrict the permission bits of
2499tar archive entries. The default is 0002, which turns off the
2500world write bit. The special value "user" indicates that the
2501archiving user's umask will be used instead. See umask(2) and
Junio C Hamano35738e82008-01-07 07:55:462502linkgit:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:032503
Junio C Hamano8fb66e52011-10-05 20:59:512504transfer.fsckObjects::
2505When `fetch.fsckObjects` or `receive.fsckObjects` are
2506not set, the value of this variable is used instead.
2507Defaults to false.
2508
Junio C Hamano322c6242015-03-23 21:32:462509transfer.hideRefs::
2510This variable can be used to set both `receive.hideRefs`
2511and `uploadpack.hideRefs` at the same time to the same
Junio C Hamano80ad00d2013-02-18 00:19:032512values. See entries for these other variables.
2513
Junio C Hamano4653c6f2008-11-26 22:50:202514transfer.unpackLimit::
2515When `fetch.unpackLimit` or `receive.unpackLimit` are
2516not set, the value of this variable is used instead.
2517The default value is 100.
2518
Junio C Hamano81703b22014-03-14 22:00:272519uploadarchive.allowUnreachable::
2520If true, allow clients to use `git archive --remote` to request
2521any tree, whether reachable from the ref tips or not. See the
2522discussion in the `SECURITY` section of
2523linkgit:git-upload-archive[1] for more details. Defaults to
2524`false`.
2525
Junio C Hamano322c6242015-03-23 21:32:462526uploadpack.hideRefs::
Junio C Hamano80ad00d2013-02-18 00:19:032527String(s) `upload-pack` uses to decide which refs to omit
2528from its initial advertisement. Use more than one
2529definitions to specify multiple prefix strings. A ref that
2530are under the hierarchies listed on the value of this
2531variable is excluded, and is hidden from `git ls-remote`,
2532`git fetch`, etc. An attempt to fetch a hidden ref by `git
Junio C Hamano5e7f1312013-03-21 22:49:012533fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2534
2535uploadpack.allowtipsha1inwant::
Junio C Hamano322c6242015-03-23 21:32:462536When `uploadpack.hideRefs` is in effect, allow `upload-pack`
Junio C Hamano5e7f1312013-03-21 22:49:012537to accept a fetch request that asks for an object at the tip
2538of a hidden ref (by default, such a request is rejected).
Junio C Hamano322c6242015-03-23 21:32:462539see also `uploadpack.hideRefs`.
Junio C Hamano80ad00d2013-02-18 00:19:032540
Junio C Hamano322c6242015-03-23 21:32:462541uploadpack.keepAlive::
Junio C Hamano79f4c7c2013-09-20 21:03:372542When `upload-pack` has started `pack-objects`, there may be a
2543quiet period while `pack-objects` prepares the pack. Normally
2544it would output progress information, but if `--quiet` was used
2545for the fetch, `pack-objects` will output nothing at all until
2546the pack data begins. Some clients and networks may consider
2547the server to be hung and give up. Setting this option instructs
2548`upload-pack` to send an empty keepalive packet every
Junio C Hamano322c6242015-03-23 21:32:462549`uploadpack.keepAlive` seconds. Setting this option to 0
Junio C Hamano79f4c7c2013-09-20 21:03:372550disables keepalive packets entirely. The default is 5 seconds.
2551
Junio C Hamano24bc09a2008-02-28 00:27:442552url.<base>.insteadOf::
2553Any URL that starts with this value will be rewritten to
2554start, instead, with <base>. In cases where some site serves a
2555large number of repositories, and serves them with multiple
2556access methods, and some users need to use different access
2557methods, this feature allows people to specify any of the
Junio C Hamano076ffcc2013-02-06 05:13:212558equivalent URLs and have Git automatically rewrite the URL to
Junio C Hamano24bc09a2008-02-28 00:27:442559the best alternative for the particular user, even for a
2560never-before-seen repository on the site. When more than one
2561insteadOf strings match a given URL, the longest match is used.
2562
Junio C Hamano7df6dcf2009-09-13 09:51:172563url.<base>.pushInsteadOf::
2564Any URL that starts with this value will not be pushed to;
2565instead, it will be rewritten to start with <base>, and the
2566resulting URL will be pushed to. In cases where some site serves
2567a large number of repositories, and serves them with multiple
2568access methods, some of which do not allow push, this feature
Junio C Hamano076ffcc2013-02-06 05:13:212569allows people to specify a pull-only URL and have Git
Junio C Hamano7df6dcf2009-09-13 09:51:172570automatically use an appropriate URL to push, even for a
2571never-before-seen repository on the site. When more than one
2572pushInsteadOf strings match a given URL, the longest match is
Junio C Hamano076ffcc2013-02-06 05:13:212573used. If a remote has an explicit pushurl, Git will ignore this
Junio C Hamano7df6dcf2009-09-13 09:51:172574setting for that remote.
2575
Junio C Hamano07824ce2006-04-25 07:36:542576user.email::
2577Your email address to be recorded in any newly created commits.
Junio C Hamano469d60e2007-04-29 18:30:342578Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Junio C Hamano35738e82008-01-07 07:55:462579'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:542580
2581user.name::
2582Your full name to be recorded in any newly created commits.
Junio C Hamano341071d2006-06-04 07:24:482583Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Junio C Hamano35738e82008-01-07 07:55:462584environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:542585
Junio C Hamano322c6242015-03-23 21:32:462586user.signingKey::
Junio C Hamano369e3402013-10-15 18:40:252587If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2588key you want it to automatically when creating a signed tag or
2589commit, you can override the default selection with this variable.
2590This option is passed unchanged to gpg's --local-user parameter,
2591so you may specify a key using any method that gpg supports.
Junio C Hamanoa890c4f2007-01-28 10:29:212592
Junio C Hamano07622622015-03-20 21:47:262593versionsort.prereleaseSuffix::
2594When version sort is used in linkgit:git-tag[1], prerelease
2595tags (e.g. "1.0-rc1") may appear after the main release
2596"1.0". By specifying the suffix "-rc" in this variable,
2597"1.0-rc1" will appear before "1.0".
2598+
2599This variable can be specified multiple times, once per suffix. The
2600order of suffixes in the config file determines the sorting order
2601(e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX
2602is sorted before 1.0-rcXX). The sorting order between different
2603suffixes is undefined if they are in multiple config files.
2604
Junio C Hamano4e272312008-01-08 09:13:212605web.browser::
2606Specify a web browser that may be used by some commands.
2607Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2608may use it.