blob: f6278a5ae6a1f554ddb8b9861d9067181b928bb5 [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
Junio C Hamano6b6144f2017-05-29 06:20:1582The `include` and `includeIf` sections allow you to include config
83directives from another source. These sections behave identically to
84each other with the exception that `includeIf` sections may be ignored
85if their condition does not evaluate to true; see "Conditional includes"
86below.
Junio C Hamano198b1f12016-05-17 22:27:2487
Junio C Hamano6b6144f2017-05-29 06:20:1588You can include a config file from another by setting the special
89`include.path` (or `includeIf.*.path`) variable to the name of the file
90to be included. The variable takes a pathname as its value, and is
91subject to tilde expansion. These variables can be given multiple times.
92
93The contents of the included file are inserted immediately, as if they
94had been found at the location of the include directive. If the value of the
95variable is a relative path, the path is considered to
Junio C Hamanocb06ef92017-03-21 22:40:1496be relative to the configuration file in which the include directive
97was found. See below for examples.
Junio C Hamano198b1f12016-05-17 22:27:2498
Junio C Hamanocb06ef92017-03-21 22:40:1499Conditional includes
100~~~~~~~~~~~~~~~~~~~~
101
102You can include a config file from another conditionally by setting a
103`includeIf.<condition>.path` variable to the name of the file to be
Junio C Hamano6b6144f2017-05-29 06:20:15104included.
Junio C Hamanocb06ef92017-03-21 22:40:14105
106The condition starts with a keyword followed by a colon and some data
107whose format and meaning depends on the keyword. Supported keywords
108are:
109
110`gitdir`::
111
112The data that follows the keyword `gitdir:` is used as a glob
113pattern. If the location of the .git directory matches the
114pattern, the include condition is met.
115+
116The .git location may be auto-discovered, or come from `$GIT_DIR`
117environment variable. If the repository is auto discovered via a .git
118file (e.g. from submodules, or a linked worktree), the .git location
119would be the final location where the .git directory is, not where the
120.git file is.
121+
122The pattern can contain standard globbing wildcards and two additional
123ones, `**/` and `/**`, that can match multiple path components. Please
124refer to linkgit:gitignore[5] for details. For convenience:
125
126 * If the pattern starts with `~/`, `~` will be substituted with the
127 content of the environment variable `HOME`.
128
129 * If the pattern starts with `./`, it is replaced with the directory
130 containing the current config file.
131
132 * If the pattern does not start with either `~/`, `./` or `/`, `**/`
133 will be automatically prepended. For example, the pattern `foo/bar`
134 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`.
135
136 * If the pattern ends with `/`, `**` will be automatically added. For
137 example, the pattern `foo/` becomes `foo/**`. In other words, it
138 matches "foo" and everything inside, recursively.
139
140`gitdir/i`::
141This is the same as `gitdir` except that matching is done
142case-insensitively (e.g. on case-insensitive file sytems)
143
144A few more notes on matching via `gitdir` and `gitdir/i`:
145
146 * Symlinks in `$GIT_DIR` are not resolved before matching.
147
Junio C Hamanod88ba732017-05-30 04:14:20148 * Both the symlink & realpath versions of paths will be matched
149 outside of `$GIT_DIR`. E.g. if ~/git is a symlink to
150 /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git`
151 will match.
152+
153This was not the case in the initial release of this feature in
154v2.13.0, which only matched the realpath version. Configuration that
155wants to be compatible with the initial release of this feature needs
156to either specify only the realpath version, or both versions.
157
Junio C Hamanocb06ef92017-03-21 22:40:14158 * Note that "../" is not special and will match literally, which is
159 unlikely what you want.
Junio C Hamanoe0238c22012-02-23 22:45:50160
Junio C Hamano07824ce2006-04-25 07:36:54161Example
162~~~~~~~
163
164# Core variables
165[core]
166; Don't trust file modes
167filemode = false
168
169# Our diff algorithm
170[diff]
Junio C Hamano85c71572008-07-28 00:03:31171external = /usr/local/bin/diff-wrapper
Junio C Hamano07824ce2006-04-25 07:36:54172renames = true
173
Junio C Hamano52401ef2006-12-19 00:54:38174[branch "devel"]
175remote = origin
176merge = refs/heads/devel
177
Junio C Hamanobee172f2007-01-23 08:44:18178# Proxy settings
179[core]
Junio C Hamanoc71a8732007-08-04 00:27:26180gitProxy="ssh" for "kernel.org"
Junio C Hamanobee172f2007-01-23 08:44:18181gitProxy=default-proxy ; for the rest
Junio C Hamano52401ef2006-12-19 00:54:38182
Junio C Hamanoe0238c22012-02-23 22:45:50183[include]
184path = /path/to/foo.inc ; include by absolute path
Junio C Hamano6b6144f2017-05-29 06:20:15185path = foo.inc ; find "foo.inc" relative to the current file
186path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
Junio C Hamanoe0238c22012-02-23 22:45:50187
Junio C Hamanocb06ef92017-03-21 22:40:14188; include if $GIT_DIR is /path/to/foo/.git
189[includeIf "gitdir:/path/to/foo/.git"]
190path = /path/to/foo.inc
191
192; include for all repositories inside /path/to/group
193[includeIf "gitdir:/path/to/group/"]
194path = /path/to/foo.inc
195
196; include for all repositories inside $HOME/to/group
197[includeIf "gitdir:~/to/group/"]
198path = /path/to/foo.inc
Junio C Hamano07622622015-03-20 21:47:26199
Junio C Hamano6b6144f2017-05-29 06:20:15200; relative paths are always relative to the including
201; file (if the condition is true); their location is not
202; affected by the condition
203[includeIf "gitdir:/path/to/group/"]
204path = foo.inc
205
Junio C Hamano07622622015-03-20 21:47:26206Values
207~~~~~~
208
209Values of many variables are treated as a simple string, but there
210are variables that take values of specific types and there are rules
211as to how to spell them.
212
213boolean::
214
215 When a variable is said to take a boolean value, many
216 synonyms are accepted for 'true' and 'false'; these are all
217 case-insensitive.
218
219 true;; Boolean true can be spelled as `yes`, `on`, `true`,
220or `1`. Also, a variable defined without `= <value>`
221is taken as true.
222
223 false;; Boolean false can be spelled as `no`, `off`,
224`false`, or `0`.
225+
Junio C Hamano92d80372016-07-13 22:00:05226When converting value to the canonical form using `--bool` type
Junio C Hamano07622622015-03-20 21:47:26227specifier; 'git config' will ensure that the output is "true" or
228"false" (spelled in lowercase).
229
230integer::
231 The value for many variables that specify various sizes can
232 be suffixed with `k`, `M`,... to mean "scale the number by
233 1024", "by 1024x1024", etc.
234
235color::
Junio C Hamano48931e22016-07-11 20:08:47236 The value for a variable that takes a color is a list of
237 colors (at most two, one for foreground and one for background)
238 and attributes (as many as you want), separated by spaces.
Junio C Hamano07622622015-03-20 21:47:26239+
Junio C Hamano48931e22016-07-11 20:08:47240The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
241`blue`, `magenta`, `cyan` and `white`. The first color given is the
242foreground; the second is the background.
Junio C Hamano07622622015-03-20 21:47:26243+
Junio C Hamano48931e22016-07-11 20:08:47244Colors may also be given as numbers between 0 and 255; these use ANSI
245256-color mode (but note that not all terminals may support this). If
246your terminal supports it, you may also specify 24-bit RGB values as
247hex, like `#ff0ab3`.
248+
249The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
250`italic`, and `strike` (for crossed-out or "strikethrough" letters).
251The position of any attributes with respect to the colors
252(before, after, or in between), doesn't matter. Specific attributes may
253be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
254`no-ul`, etc).
255+
Junio C Hamanob86c8032017-02-02 21:50:19256An empty color string produces no color effect at all. This can be used
257to avoid coloring specific elements without disabling color entirely.
258+
Junio C Hamano48931e22016-07-11 20:08:47259For git's pre-defined color slots, the attributes are meant to be reset
260at the beginning of each item in the colored output. So setting
261`color.decorate.branch` to `black` will paint that branch name in a
262plain `black`, even if the previous thing on the same output line (e.g.
263opening parenthesis before the list of branch names in `log --decorate`
264output) is set to be painted with `bold` or some other attribute.
265However, custom log formats may do more complicated and layered
266coloring, and the negated forms may be useful there.
Junio C Hamano07622622015-03-20 21:47:26267
Junio C Hamano198b1f12016-05-17 22:27:24268pathname::
269A variable that takes a pathname value can be given a
270string that begins with "`~/`" or "`~user/`", and the usual
271tilde expansion happens to such a string: `~/`
272is expanded to the value of `$HOME`, and `~user/` to the
273specified user's home directory.
274
Junio C Hamano07622622015-03-20 21:47:26275
Junio C Hamano07824ce2006-04-25 07:36:54276Variables
277~~~~~~~~~
278
279Note that this list is non-comprehensive and not necessarily complete.
Junio C Hamanof1d14802006-06-08 00:48:17280For command-specific variables, you will find a more detailed description
Junio C Hamano52b6ba32014-04-01 00:26:48281in the appropriate manual page.
282
283Other git-related tools may and do use their own variables. When
284inventing new variables for use in your own tool, make sure their
285names do not conflict with those that are used by Git itself and
286other popular tools, and describe them in your documentation.
287
Junio C Hamano07824ce2006-04-25 07:36:54288
Junio C Hamano7df6dcf2009-09-13 09:51:17289advice.*::
Junio C Hamano0df92712011-12-21 22:30:44290These variables control various optional help messages designed to
291aid new users. All 'advice.*' variables default to 'true', and you
292can tell Git that you do not need help by setting these to 'false':
Junio C Hamano7df6dcf2009-09-13 09:51:17293+
294--
Junio C Hamanoabad6da2013-01-06 09:06:32295pushUpdateRejected::
Junio C Hamano0c1b64e2012-04-20 23:50:49296Set this variable to 'false' if you want to disable
Junio C Hamano1d669b82014-03-11 21:36:00297'pushNonFFCurrent',
Junio C Hamano3f2ed6f2013-02-04 19:24:09298'pushNonFFMatching', 'pushAlreadyExists',
299'pushFetchFirst', and 'pushNeedsForce'
Junio C Hamanoabad6da2013-01-06 09:06:32300simultaneously.
Junio C Hamano0c1b64e2012-04-20 23:50:49301pushNonFFCurrent::
302Advice shown when linkgit:git-push[1] fails due to a
303non-fast-forward update to the current branch.
Junio C Hamano0c1b64e2012-04-20 23:50:49304pushNonFFMatching::
305Advice shown when you ran linkgit:git-push[1] and pushed
306'matching refs' explicitly (i.e. you used ':', or
307specified a refspec that isn't your current branch) and
308it resulted in a non-fast-forward error.
Junio C Hamanoabad6da2013-01-06 09:06:32309pushAlreadyExists::
310Shown when linkgit:git-push[1] rejects an update that
311does not qualify for fast-forwarding (e.g., a tag.)
Junio C Hamano3f2ed6f2013-02-04 19:24:09312pushFetchFirst::
313Shown when linkgit:git-push[1] rejects an update that
314tries to overwrite a remote ref that points at an
315object we do not have.
316pushNeedsForce::
317Shown when linkgit:git-push[1] rejects an update that
318tries to overwrite a remote ref that points at an
Junio C Hamanoe6f28d02013-09-17 21:34:00319object that is not a commit-ish, or make the remote
320ref point at an object that is not a commit-ish.
Junio C Hamano7df6dcf2009-09-13 09:51:17321statusHints::
Junio C Hamano644936c2012-06-28 23:05:14322Show directions on how to proceed from the current
Junio C Hamano917cd4f2012-12-04 23:41:10323state in the output of linkgit:git-status[1], in
Junio C Hamano644936c2012-06-28 23:05:14324the template shown when writing commit messages in
Junio C Hamano917cd4f2012-12-04 23:41:10325linkgit:git-commit[1], and in the help message shown
326by linkgit:git-checkout[1] when switching branch.
Junio C Hamano5e7f1312013-03-21 22:49:01327statusUoption::
328Advise to consider using the `-u` option to linkgit:git-status[1]
329when the command takes more than 2 seconds to enumerate untracked
330files.
Junio C Hamano5706e0b2009-11-24 10:54:16331commitBeforeMerge::
332Advice shown when linkgit:git-merge[1] refuses to
Junio C Hamano619596a2010-08-18 22:15:35333merge to avoid overwriting local changes.
Junio C Hamanoa9701f02010-01-21 00:42:16334resolveConflict::
Junio C Hamano5dab5a92013-02-25 18:51:24335Advice shown by various commands when conflicts
Junio C Hamanoa9701f02010-01-21 00:42:16336prevent the operation from being performed.
Junio C Hamanoa9701f02010-01-21 00:42:16337implicitIdentity::
338Advice on how to set your identity configuration when
339your information is guessed from the system username and
Junio C Hamano0df92712011-12-21 22:30:44340domain name.
Junio C Hamano74a198f2010-02-22 00:13:31341detachedHead::
Junio C Hamano0df92712011-12-21 22:30:44342Advice shown when you used linkgit:git-checkout[1] to
Junio C Hamano74a198f2010-02-22 00:13:31343move to the detach HEAD state, to instruct how to create
Junio C Hamano0df92712011-12-21 22:30:44344a local branch after the fact.
Junio C Hamanobb300642012-07-22 21:09:14345amWorkDir::
346Advice that shows the location of the patch file when
347linkgit:git-am[1] fails to apply it.
Junio C Hamano8ab94942013-06-24 21:55:30348rmHints::
349In case of failure in the output of linkgit:git-rm[1],
350show directions on how to proceed from the current state.
Junio C Hamano7df6dcf2009-09-13 09:51:17351--
352
Junio C Hamano07824ce2006-04-25 07:36:54353core.fileMode::
Junio C Hamanod2c28482014-10-24 22:28:25354Tells Git if the executable bit of files in the working tree
355is to be honored.
Junio C Hamano9df0c662009-11-23 11:09:27356+
Junio C Hamanod2c28482014-10-24 22:28:25357Some filesystems lose the executable bit when a file that is
Junio C Hamano6b6144f2017-05-29 06:20:15358marked as executable is checked out, or checks out a
Junio C Hamanod2c28482014-10-24 22:28:25359non-executable file with executable bit on.
360linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
361to see if it handles the executable bit correctly
362and this variable is automatically set as necessary.
363+
364A repository, however, may be on a filesystem that handles
365the filemode correctly, and this variable is set to 'true'
366when created, but later may be made accessible from another
367environment that loses the filemode (e.g. exporting ext4 via
368CIFS mount, visiting a Cygwin created repository with
369Git for Windows or Eclipse).
370In such a case it may be necessary to set this variable to 'false'.
371See linkgit:git-update-index[1].
372+
373The default is true (when core.filemode is not specified in the config file).
Junio C Hamano07824ce2006-04-25 07:36:54374
Junio C Hamano198b1f12016-05-17 22:27:24375core.hideDotFiles::
376(Windows-only) If true, mark newly-created directories and files whose
377name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
378directory is hidden, but no other files starting with a dot. The
379default mode is 'dotGitOnly'.
380
Junio C Hamano322c6242015-03-23 21:32:46381core.ignoreCase::
Junio C Hamano9df0c662009-11-23 11:09:27382If true, this option enables various workarounds to enable
Junio C Hamano076ffcc2013-02-06 05:13:21383Git to work better on filesystems that are not case sensitive,
Junio C Hamano9df0c662009-11-23 11:09:27384like FAT. For example, if a directory listing finds
Junio C Hamano076ffcc2013-02-06 05:13:21385"makefile" when Git expects "Makefile", Git will assume
Junio C Hamano9df0c662009-11-23 11:09:27386it is really the same file, and continue to remember it as
387"Makefile".
388+
389The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
Junio C Hamano322c6242015-03-23 21:32:46390will probe and set core.ignoreCase true if appropriate when the repository
Junio C Hamano9df0c662009-11-23 11:09:27391is created.
392
Junio C Hamano322c6242015-03-23 21:32:46393core.precomposeUnicode::
Junio C Hamano076ffcc2013-02-06 05:13:21394This option is only used by Mac OS implementation of Git.
Junio C Hamano322c6242015-03-23 21:32:46395When core.precomposeUnicode=true, Git reverts the unicode decomposition
Junio C Hamanob61a7772012-07-13 23:34:48396of filenames done by Mac OS. This is useful when sharing a repository
397between Mac OS and Linux or Windows.
Junio C Hamano076ffcc2013-02-06 05:13:21398(Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
399When false, file names are handled fully transparent by Git,
400which is backward compatible with older versions of Git.
Junio C Hamanob61a7772012-07-13 23:34:48401
Junio C Hamano30758bd2014-12-18 20:44:14402core.protectHFS::
403If set to true, do not allow checkout of paths that would
404be considered equivalent to `.git` on an HFS+ filesystem.
405Defaults to `true` on Mac OS, and `false` elsewhere.
406
407core.protectNTFS::
408If set to true, do not allow checkout of paths that would
409cause problems with the NTFS filesystem, e.g. conflict with
4108.3 "short" names.
411Defaults to `true` on Windows, and `false` elsewhere.
412
Junio C Hamano90ccff32008-07-29 08:17:24413core.trustctime::
414If false, the ctime differences between the index and the
Junio C Hamano8fb66e52011-10-05 20:59:51415working tree are ignored; useful when the inode change time
Junio C Hamano90ccff32008-07-29 08:17:24416is regularly modified by something outside Git (file system
417crawlers and some backup systems).
418See linkgit:git-update-index[1]. True by default.
419
Junio C Hamano3d4a66d2017-03-17 21:07:26420core.splitIndex::
421If true, the split-index feature of the index will be used.
422See linkgit:git-update-index[1]. False by default.
423
Junio C Hamano9099a7c2016-02-10 23:42:05424core.untrackedCache::
425Determines what to do about the untracked cache feature of the
426index. It will be kept, if this variable is unset or set to
427`keep`. It will automatically be added if set to `true`. And
428it will automatically be removed, if set to `false`. Before
429setting it to `true`, you should check that mtime is working
430properly on your system.
431See linkgit:git-update-index[1]. `keep` by default.
432
Junio C Hamano322c6242015-03-23 21:32:46433core.checkStat::
Junio C Hamano4cfed0c2013-01-30 17:58:54434Determines which stat fields to match between the index
435and work tree. The user can set this to 'default' or
436'minimal'. Default (or explicitly 'default'), is to check
437all fields, including the sub-second part of mtime and ctime.
438
Junio C Hamano322c6242015-03-23 21:32:46439core.quotePath::
Junio C Hamano0f6f3bf2017-03-13 07:01:53440Commands that output paths (e.g. 'ls-files', 'diff'), will
441quote "unusual" characters in the pathname by enclosing the
442pathname in double-quotes and escaping those characters with
443backslashes in the same way C escapes control characters (e.g.
444`\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
445values larger than 0x80 (e.g. octal `\302\265` for "micro" in
446UTF-8). If this variable is set to false, bytes higher than
4470x80 are not considered "unusual" any more. Double-quotes,
448backslash and control characters are always escaped regardless
449of the setting of this variable. A simple space character is
450not considered "unusual". Many commands can output pathnames
451completely verbatim using the `-z` option. The default value
452is true.
Junio C Hamanod526ba92007-07-02 00:17:42453
Junio C Hamanobb88cf42010-06-21 15:23:55454core.eol::
455Sets the line ending type to use in the working directory for
Junio C Hamanof2a3a752016-05-23 22:54:39456files that have the `text` property set when core.autocrlf is false.
457Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
458native line ending. The default value is `native`. See
Junio C Hamanobb88cf42010-06-21 15:23:55459linkgit:gitattributes[5] for more information on end-of-line
460conversion.
Junio C Hamanod9e0e5d2007-04-14 16:22:04461
Junio C Hamano26e590a2008-02-17 03:53:51462core.safecrlf::
Junio C Hamano076ffcc2013-02-06 05:13:21463If true, makes Git check if converting `CRLF` is reversible when
Junio C Hamanobb88cf42010-06-21 15:23:55464end-of-line conversion is active. Git will verify if a command
Junio C Hamano26e590a2008-02-17 03:53:51465modifies a file in the work tree either directly or indirectly.
466For example, committing a file followed by checking out the
467same file should yield the original file in the work tree. If
468this is not the case for the current setting of
Junio C Hamano076ffcc2013-02-06 05:13:21469`core.autocrlf`, Git will reject the file. The variable can
470be set to "warn", in which case Git will only warn about an
Junio C Hamano26e590a2008-02-17 03:53:51471irreversible conversion but continue the operation.
472+
473CRLF conversion bears a slight chance of corrupting data.
Junio C Hamano076ffcc2013-02-06 05:13:21474When it is enabled, Git will convert CRLF to LF during commit and LF to
Junio C Hamano26e590a2008-02-17 03:53:51475CRLF during checkout. A file that contains a mixture of LF and
Junio C Hamano076ffcc2013-02-06 05:13:21476CRLF before the commit cannot be recreated by Git. For text
Junio C Hamano26e590a2008-02-17 03:53:51477files this is the right thing to do: it corrects line endings
478such that we have only LF line endings in the repository.
479But for binary files that are accidentally classified as text the
480conversion can corrupt data.
481+
482If you recognize such corruption early you can easily fix it by
483setting the conversion type explicitly in .gitattributes. Right
484after committing you still have the original file in your work
485tree and this file is not yet corrupted. You can explicitly tell
Junio C Hamano076ffcc2013-02-06 05:13:21486Git that this file is binary and Git will handle the file
Junio C Hamano26e590a2008-02-17 03:53:51487appropriately.
488+
489Unfortunately, the desired effect of cleaning up text files with
490mixed line endings and the undesired effect of corrupting binary
491files cannot be distinguished. In both cases CRLFs are removed
492in an irreversible way. For text files this is the right thing
493to do because CRLFs are line endings, while for binary files
494converting CRLFs corrupts data.
495+
496Note, this safety check does not mean that a checkout will generate a
497file identical to the original file for a different setting of
Junio C Hamanobb88cf42010-06-21 15:23:55498`core.eol` and `core.autocrlf`, but only for the current one. For
499example, a text file with `LF` would be accepted with `core.eol=lf`
500and could later be checked out with `core.eol=crlf`, in which case the
Junio C Hamano26e590a2008-02-17 03:53:51501resulting file would contain `CRLF`, although the original file
502contained `LF`. However, in both work trees the line endings would be
503consistent, that is either all `LF` or all `CRLF`, but never mixed. A
504file with mixed line endings would be reported by the `core.safecrlf`
505mechanism.
506
Junio C Hamanobb88cf42010-06-21 15:23:55507core.autocrlf::
Junio C Hamanoeed15af2016-07-25 22:49:42508Setting this variable to "true" is the same as setting
509the `text` attribute to "auto" on all files and core.eol to "crlf".
510Set to true if you want to have `CRLF` line endings in your
511working directory and the repository has LF line endings.
512This variable can be set to 'input',
Junio C Hamanobb88cf42010-06-21 15:23:55513in which case no output conversion is performed.
514
Junio C Hamanoaa83a7d2007-03-05 02:37:29515core.symlinks::
516If false, symbolic links are checked out as small plain files that
Junio C Hamano35738e82008-01-07 07:55:46517contain the link text. linkgit:git-update-index[1] and
518linkgit:git-add[1] will not change the recorded type to regular
Junio C Hamanoaa83a7d2007-03-05 02:37:29519file. Useful on filesystems like FAT that do not support
Junio C Hamano9df0c662009-11-23 11:09:27520symbolic links.
521+
522The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
523will probe and set core.symlinks false if appropriate when the repository
524is created.
Junio C Hamanoaa83a7d2007-03-05 02:37:29525
Junio C Hamano07824ce2006-04-25 07:36:54526core.gitProxy::
527A "proxy command" to execute (as 'command host port') instead
528of establishing direct connection to the remote server when
Junio C Hamano076ffcc2013-02-06 05:13:21529using the Git protocol for fetching. If the variable value is
Junio C Hamano07824ce2006-04-25 07:36:54530in the "COMMAND for DOMAIN" format, the command is applied only
531on hostnames ending with the specified domain string. This variable
532may be set multiple times and is matched in the given order;
533the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17534+
Junio C Hamano042f2142016-06-27 18:05:05535Can be overridden by the `GIT_PROXY_COMMAND` environment variable
Junio C Hamanof1d14802006-06-08 00:48:17536(which always applies universally, without the special "for"
537handling).
Junio C Hamanoea82cff2009-03-18 01:54:48538+
539The special string `none` can be used as the proxy command to
540specify that no proxy be used for a given domain pattern.
541This is useful for excluding servers inside a firewall from
542proxy use, while defaulting to a common proxy for external domains.
Junio C Hamano07824ce2006-04-25 07:36:54543
Junio C Hamano1a1b8472016-07-19 21:37:13544core.sshCommand::
545If this variable is set, `git fetch` and `git push` will
546use the specified command instead of `ssh` when they need to
547connect to a remote system. The command is in the same form as
548the `GIT_SSH_COMMAND` environment variable and is overridden
549when the environment variable is set.
550
Junio C Hamano07824ce2006-04-25 07:36:54551core.ignoreStat::
Junio C Hamanoe8acc8e2015-01-14 22:01:34552If true, Git will avoid using lstat() calls to detect if files have
553changed by setting the "assume-unchanged" bit for those tracked files
554which it has updated identically in both the index and working tree.
555+
556When files are modified outside of Git, the user will need to stage
557the modified files explicitly (e.g. see 'Examples' section in
558linkgit:git-update-index[1]).
559Git will not normally detect changes to those files.
560+
561This is useful on systems where lstat() calls are very slow, such as
562CIFS/Microsoft Windows.
563+
564False by default.
Junio C Hamano07824ce2006-04-25 07:36:54565
Junio C Hamano88a3a072006-05-04 08:01:43566core.preferSymlinkRefs::
567Instead of the default "symref" format for HEAD
568and other symbolic reference files, use symbolic links.
569This is sometimes needed to work with old scripts that
570expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54571
Junio C Hamano1025e752007-02-23 07:21:26572core.bare::
573If true this repository is assumed to be 'bare' and has no
574working directory associated with it. If this is the case a
575number of commands that require a working directory will be
Junio C Hamano35738e82008-01-07 07:55:46576disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Junio C Hamano1025e752007-02-23 07:21:26577+
Junio C Hamano35738e82008-01-07 07:55:46578This setting is automatically guessed by linkgit:git-clone[1] or
579linkgit:git-init[1] when the repository was created. By default a
Junio C Hamano1025e752007-02-23 07:21:26580repository that ends in "/.git" is assumed to be not bare (bare =
581false), while all other repositories are assumed to be bare (bare
582= true).
583
Junio C Hamanod526ba92007-07-02 00:17:42584core.worktree::
Junio C Hamano80d58462011-01-24 22:52:52585Set the path to the root of the working tree.
Junio C Hamano042f2142016-06-27 18:05:05586If `GIT_COMMON_DIR` environment variable is set, core.worktree
Junio C Hamano4cc4a842015-05-11 22:41:02587is ignored and not used for determining the root of working tree.
Junio C Hamano042f2142016-06-27 18:05:05588This can be overridden by the `GIT_WORK_TREE` environment
Junio C Hamano92d80372016-07-13 22:00:05589variable and the `--work-tree` command-line option.
Junio C Hamano5cd15182011-04-05 00:21:10590The value can be an absolute path or relative to the path to
Junio C Hamano80d58462011-01-24 22:52:52591the .git directory, which is either specified by --git-dir
592or GIT_DIR, or automatically discovered.
593If --git-dir or GIT_DIR is specified but none of
Junio C Hamano7d575a52008-04-30 08:45:27594--work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamano80d58462011-01-24 22:52:52595the current working directory is regarded as the top level
Junio C Hamano3609b332010-12-29 01:34:52596of your working tree.
Junio C Hamano80d58462011-01-24 22:52:52597+
598Note that this variable is honored even when set in a configuration
599file in a ".git" subdirectory of a directory and its value differs
600from the latter directory (e.g. "/path/to/.git/config" has
601core.worktree set to "/different/path"), which is most likely a
Junio C Hamano076ffcc2013-02-06 05:13:21602misconfiguration. Running Git commands in the "/path/to" directory will
Junio C Hamano80d58462011-01-24 22:52:52603still use "/different/path" as the root of the work tree and can cause
604confusion unless you know what you are doing (e.g. you are creating a
605read-only snapshot of the same index to a location different from the
606repository's usual working tree).
Junio C Hamanod526ba92007-07-02 00:17:42607
Junio C Hamano341071d2006-06-04 07:24:48608core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49609Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamano198b1f12016-05-17 22:27:24610"`$GIT_DIR/logs/<ref>`", by appending the new and old
Junio C Hamanoe3f080d2013-04-22 02:27:13611SHA-1, the date/time and the reason of the update, but
Junio C Hamanoa2ec14f2006-11-02 00:22:48612only when the file exists. If this configuration
Junio C Hamanoa8e42612017-02-03 21:44:07613variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
Junio C Hamano15567bc2011-07-23 00:51:59614file is automatically created for branch heads (i.e. under
Junio C Hamanoa8e42612017-02-03 21:44:07615`refs/heads/`), remote refs (i.e. under `refs/remotes/`),
616note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
617If it is set to `always`, then a missing reflog is automatically
618created for any ref under `refs/`.
Junio C Hamano1caaf472006-12-31 08:29:35619+
620This information can be used to determine what commit
621was the tip of a branch "2 days ago".
622+
623This value is true by default in a repository that has
624a working directory associated with it, and false by
625default in a bare repository.
Junio C Hamano341071d2006-06-04 07:24:48626
Junio C Hamano07824ce2006-04-25 07:36:54627core.repositoryFormatVersion::
628Internal variable identifying the repository format and layout
629version.
630
631core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42632When 'group' (or 'true'), the repository is made shareable between
633several users in a group (making sure all the files and objects are
634group-writable). When 'all' (or 'world' or 'everybody'), the
635repository will be readable by all users, additionally to being
Junio C Hamano076ffcc2013-02-06 05:13:21636group-shareable. When 'umask' (or 'false'), Git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37637reported by umask(2). When '0xxx', where '0xxx' is an octal number,
638files in the repository will have this mode value. '0xxx' will override
Junio C Hamano83eded12009-04-20 08:18:00639user's umask value (whereas the other options will only override
640requested parts of the user's umask value). Examples: '0660' will make
641the repo read/write-able for the owner and group, but inaccessible to
642others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Junio C Hamano2f102bb2008-04-26 02:23:37643repository that is group-readable but not group-writable.
644See linkgit:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54645
646core.warnAmbiguousRefs::
Junio C Hamano076ffcc2013-02-06 05:13:21647If true, Git will warn you if the ref name you passed it is ambiguous
Junio C Hamano947ab822013-03-19 23:07:29648and might match multiple refs in the repository. True by default.
Junio C Hamano07824ce2006-04-25 07:36:54649
Junio C Hamano7ec15722006-07-07 02:03:59650core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09651An integer -1..9, indicating a default compression level.
652-1 is the zlib default. 0 means no compression,
653and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42654If set, this provides a default to other compression variables,
Junio C Hamano042f2142016-06-27 18:05:05655such as `core.looseCompression` and `pack.compression`.
Junio C Hamanoa126a3b2006-07-04 04:55:26656
Junio C Hamano322c6242015-03-23 21:32:46657core.looseCompression::
Junio C Hamanof2ce2972007-05-20 19:12:09658An integer -1..9, indicating the compression level for objects that
659are not in a pack file. -1 is the zlib default. 0 means no
660compression, and 1..9 are various speed/size tradeoffs, 9 being
661slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42662not set, defaults to 1 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49663
Junio C Hamanofc4d38c2007-01-08 06:53:32664core.packedGitWindowSize::
665Number of bytes of a pack file to map into memory in a
666single mapping operation. Larger window sizes may allow
667your system to process a smaller number of large pack files
668more quickly. Smaller window sizes will negatively affect
669performance due to increased calls to the operating system's
670memory manager, but may improve performance when accessing
671a large number of large pack files.
672+
673Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
674MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
675be reasonable for all users/operating systems. You probably do
676not need to adjust this value.
677+
678Common unit suffixes of 'k', 'm', or 'g' are supported.
679
680core.packedGitLimit::
681Maximum number of bytes to map simultaneously into memory
682from pack files. If Git needs to access more than this many
683bytes at once to complete an operation it will unmap existing
684regions to reclaim virtual address space within the process.
685+
686Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
687This should be reasonable for all users/operating systems, except on
688the largest projects. You probably do not need to adjust this value.
689+
690Common unit suffixes of 'k', 'm', or 'g' are supported.
691
Junio C Hamanob8c51282007-03-19 10:43:30692core.deltaBaseCacheLimit::
693Maximum number of bytes to reserve for caching base objects
Junio C Hamano619596a2010-08-18 22:15:35694that may be referenced by multiple deltified objects. By storing the
Junio C Hamanob8c51282007-03-19 10:43:30695entire decompressed base objects in a cache Git is able
696to avoid unpacking and decompressing frequently used base
697objects multiple times.
698+
Junio C Hamanoe1aeb5e2014-06-06 19:16:29699Default is 96 MiB on all platforms. This should be reasonable
Junio C Hamanob8c51282007-03-19 10:43:30700for all users/operating systems, except on the largest projects.
701You probably do not need to adjust this value.
702+
703Common unit suffixes of 'k', 'm', or 'g' are supported.
704
Junio C Hamano5c246f22010-02-03 07:34:53705core.bigFileThreshold::
706Files larger than this size are stored deflated, without
707attempting delta compression. Storing large files without
708delta compression avoids excessive memory usage, at the
Junio C Hamano8e61f1f2014-09-11 21:53:45709slight expense of increased disk usage. Additionally files
710larger than this size are always treated as binary.
Junio C Hamano5c246f22010-02-03 07:34:53711+
712Default is 512 MiB on all platforms. This should be reasonable
713for most projects as source code and other text files can still
714be delta compressed, but larger binary media files won't be.
715+
716Common unit suffixes of 'k', 'm', or 'g' are supported.
Junio C Hamano5c246f22010-02-03 07:34:53717
Junio C Hamano322c6242015-03-23 21:32:46718core.excludesFile::
Junio C Hamano198b1f12016-05-17 22:27:24719Specifies the pathname to the file that contains patterns to
720describe paths that are not meant to be tracked, in addition
721to '.gitignore' (per-directory) and '.git/info/exclude'.
722Defaults to `$XDG_CONFIG_HOME/git/ignore`.
723If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
Junio C Hamano8edb4c72012-07-09 20:33:55724is used instead. See linkgit:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37725
Junio C Hamano322c6242015-03-23 21:32:46726core.askPass::
Junio C Hamano3fd7b262010-09-08 22:44:20727Some commands (e.g. svn and http interfaces) that interactively
728ask for a password can be told to use an external program given
Junio C Hamano042f2142016-06-27 18:05:05729via the value of this variable. Can be overridden by the `GIT_ASKPASS`
Junio C Hamano3fd7b262010-09-08 22:44:20730environment variable. If not set, fall back to the value of the
Junio C Hamano042f2142016-06-27 18:05:05731`SSH_ASKPASS` environment variable or, failing that, a simple password
Junio C Hamano3fd7b262010-09-08 22:44:20732prompt. The external program shall be given a suitable prompt as
Junio C Hamanoe1aeb5e2014-06-06 19:16:29733command-line argument and write the password on its STDOUT.
Junio C Hamano3fd7b262010-09-08 22:44:20734
Junio C Hamano322c6242015-03-23 21:32:46735core.attributesFile::
Junio C Hamano3b4609d2010-09-30 00:04:34736In addition to '.gitattributes' (per-directory) and
Junio C Hamano076ffcc2013-02-06 05:13:21737'.git/info/attributes', Git looks into this file for attributes
Junio C Hamano3b4609d2010-09-30 00:04:34738(see linkgit:gitattributes[5]). Path expansions are made the same
Junio C Hamano322c6242015-03-23 21:32:46739way as for `core.excludesFile`. Its default value is
Junio C Hamano198b1f12016-05-17 22:27:24740`$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
741set or empty, `$HOME/.config/git/attributes` is used instead.
742
743core.hooksPath::
744By default Git will look for your hooks in the
745'$GIT_DIR/hooks' directory. Set this to different path,
746e.g. '/etc/git/hooks', and Git will try to find your hooks in
747that directory, e.g. '/etc/git/hooks/pre-receive' instead of
748in '$GIT_DIR/hooks/pre-receive'.
749+
750The path can be either absolute or relative. A relative path is
751taken as relative to the directory where the hooks are run (see
752the "DESCRIPTION" section of linkgit:githooks[5]).
753+
754This configuration variable is useful in cases where you'd like to
755centrally configure your Git hooks instead of configuring them on a
756per-repository basis, or as a more flexible and centralized
757alternative to having an `init.templateDir` where you've changed
758default hooks.
Junio C Hamano3b4609d2010-09-30 00:04:34759
Junio C Hamanof6002a92007-07-20 10:28:22760core.editor::
Junio C Hamano7ab74c42017-03-27 18:23:59761Commands such as `commit` and `tag` that let you edit
762messages by launching an editor use the value of this
Junio C Hamanof6002a92007-07-20 10:28:22763variable when it is set, and the environment variable
Junio C Hamano3b70d3c2009-11-21 17:37:37764`GIT_EDITOR` is not set. See linkgit:git-var[1].
Junio C Hamanof6002a92007-07-20 10:28:22765
Junio C Hamano322c6242015-03-23 21:32:46766core.commentChar::
Junio C Hamano7ab74c42017-03-27 18:23:59767Commands such as `commit` and `tag` that let you edit
Junio C Hamano3f2ed6f2013-02-04 19:24:09768messages consider a line that begins with this character
769commented, and removes them after the editor returns
770(default '#').
Junio C Hamanoe1aeb5e2014-06-06 19:16:29771+
772If set to "auto", `git-commit` would select a character that is not
773the beginning character of any line in existing commit messages.
Junio C Hamano3f2ed6f2013-02-04 19:24:09774
Junio C Hamano1dbca522015-05-22 20:48:55775core.packedRefsTimeout::
776The length of time, in milliseconds, to retry when trying to
777lock the `packed-refs` file. Value 0 means not to retry at
778all; -1 means to try indefinitely. Default is 1000 (i.e.,
779retry for 1 second).
780
Junio C Hamano6231f822011-10-24 05:18:52781sequence.editor::
Junio C Hamano778a3412013-03-28 23:24:30782Text editor used by `git rebase -i` for editing the rebase instruction file.
Junio C Hamano6231f822011-10-24 05:18:52783The value is meant to be interpreted by the shell when it is used.
784It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
785When not configured the default commit message editor is used instead.
786
Junio C Hamano28d8ede2007-07-05 05:51:38787core.pager::
Junio C Hamano0e0e0d22013-09-12 23:25:03788Text viewer for use by Git commands (e.g., 'less'). The value
789is meant to be interpreted by the shell. The order of preference
790is the `$GIT_PAGER` environment variable, then `core.pager`
791configuration, then `$PAGER`, and then the default chosen at
792compile time (usually 'less').
793+
Junio C Hamanoe1aeb5e2014-06-06 19:16:29794When the `LESS` environment variable is unset, Git sets it to `FRX`
Junio C Hamano0e0e0d22013-09-12 23:25:03795(if `LESS` environment variable is set, Git does not change it at
796all). If you want to selectively override Git's default setting
Junio C Hamanoe1aeb5e2014-06-06 19:16:29797for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
Junio C Hamano0e0e0d22013-09-12 23:25:03798be passed to the shell by Git, which will translate the final
Junio C Hamanoe1aeb5e2014-06-06 19:16:29799command to `LESS=FRX less -S`. The environment does not set the
800`S` option but the command line does, instructing less to truncate
801long lines. Similarly, setting `core.pager` to `less -+F` will
802deactivate the `F` option specified by the environment from the
803command-line, deactivating the "quit if one screen" behavior of
804`less`. One can specifically activate some flags for particular
805commands: for example, setting `pager.blame` to `less -S` enables
806line truncation only for `git blame`.
Junio C Hamanobc8d4782014-01-13 23:35:50807+
808Likewise, when the `LV` environment variable is unset, Git sets it
809to `-c`. You can override this setting by exporting `LV` with
810another value or setting `core.pager` to `lv +c`.
Junio C Hamano28d8ede2007-07-05 05:51:38811
Junio C Hamano942b35e2007-12-09 10:19:33812core.whitespace::
813A comma separated list of common whitespace problems to
Junio C Hamano1aa40d22010-01-21 17:46:43814notice. 'git diff' will use `color.diff.whitespace` to
815highlight them, and 'git apply --whitespace=error' will
Junio C Hamano3db8b412008-07-26 06:45:59816consider them as errors. You can prefix `-` to disable
817any of them (e.g. `-trailing-space`):
Junio C Hamano942b35e2007-12-09 10:19:33818+
Junio C Hamanob71a22d2009-10-17 08:23:47819* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano942b35e2007-12-09 10:19:33820 as an error (enabled by default).
821* `space-before-tab` treats a space character that appears immediately
822 before a tab character in the initial indent part of the line as an
823 error (enabled by default).
Junio C Hamano281fd392012-09-17 23:57:41824* `indent-with-non-tab` treats a line that is indented with space
825 characters instead of the equivalent tabs as an error (not enabled by
826 default).
Junio C Hamanocb39aea2010-05-09 07:24:48827* `tab-in-indent` treats a tab character in the initial indent part of
828 the line as an error (not enabled by default).
Junio C Hamanob71a22d2009-10-17 08:23:47829* `blank-at-eof` treats blank lines added at the end of file as an error
830 (enabled by default).
831* `trailing-space` is a short-hand to cover both `blank-at-eol` and
832 `blank-at-eof`.
Junio C Hamano601f3e52008-02-25 08:40:42833* `cr-at-eol` treats a carriage-return at the end of line as
834 part of the line terminator, i.e. with it, `trailing-space`
835 does not trigger if the character before such a carriage-return
836 is not a whitespace (not enabled by default).
Junio C Hamanoeef01fe2010-12-13 08:31:58837* `tabwidth=<n>` tells how many character positions a tab occupies; this
Junio C Hamano076ffcc2013-02-06 05:13:21838 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
Junio C Hamanoeef01fe2010-12-13 08:31:58839 errors. The default tab width is 8. Allowed values are 1 to 63.
Junio C Hamano942b35e2007-12-09 10:19:33840
Junio C Hamano322c6242015-03-23 21:32:46841core.fsyncObjectFiles::
Junio C Hamano9eb57532008-06-26 06:33:46842This boolean will enable 'fsync()' when writing object files.
843+
844This is a total waste of time and effort on a filesystem that orders
845data writes properly, but can be useful for filesystems that do not use
846journalling (traditional UNIX filesystems) or that only journal metadata
847and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
848
Junio C Hamano322c6242015-03-23 21:32:46849core.preloadIndex::
Junio C Hamano610d1762008-11-28 06:27:13850Enable parallel index preload for operations like 'git diff'
851+
852This can speed up operations like 'git diff' and 'git status' especially
853on filesystems like NFS that have weak caching semantics and thus
Junio C Hamanoc8c398a2014-06-16 21:14:05854relatively high IO latencies. When enabled, Git will do the
Junio C Hamano610d1762008-11-28 06:27:13855index comparison to the filesystem data in parallel, allowing
Junio C Hamanoc8c398a2014-06-16 21:14:05856overlapping IO's. Defaults to true.
Junio C Hamano610d1762008-11-28 06:27:13857
Junio C Hamanoa9499de2009-04-30 03:38:48858core.createObject::
859You can set this to 'link', in which case a hardlink followed by
860a delete of the source are used to make sure that object creation
861will not overwrite existing objects.
862+
863On some file system/operating system combinations, this is unreliable.
864Set this config setting to 'rename' there; However, This will remove the
865check that makes sure that existing object files will not get overwritten.
Junio C Hamanoe91ea772009-04-26 01:41:41866
Junio C Hamano3b70d3c2009-11-21 17:37:37867core.notesRef::
868When showing commit messages, also show notes which are stored in
Junio C Hamanoa574a092010-06-13 19:57:10869the given ref. The ref must be fully qualified. If the given
870ref does not exist, it is not an error but means that no
871notes should be printed.
Junio C Hamano3b70d3c2009-11-21 17:37:37872+
Junio C Hamanoa574a092010-06-13 19:57:10873This setting defaults to "refs/notes/commits", and it can be overridden by
Junio C Hamano042f2142016-06-27 18:05:05874the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
Junio C Hamano3b70d3c2009-11-21 17:37:37875
Junio C Hamano3c8d6702010-01-13 23:09:03876core.sparseCheckout::
877Enable "sparse checkout" feature. See section "Sparse checkout" in
878linkgit:git-read-tree[1] for more information.
879
Junio C Hamano6371b0e2011-03-23 23:36:21880core.abbrev::
Junio C Hamano56ace3d2017-01-10 23:43:41881Set the length object names are abbreviated to. If
882unspecified or set to "auto", an appropriate value is
883computed based on the approximate number of packed objects
884in your repository, which hopefully is enough for
885abbreviated object names to stay unique for some time.
Junio C Hamanoe0e20df2017-06-04 02:10:21886The minimum length is 4.
Junio C Hamano6371b0e2011-03-23 23:36:21887
Junio C Hamano60186642010-12-02 14:18:26888add.ignoreErrors::
Junio C Hamanobe087982015-02-22 21:29:39889add.ignore-errors (deprecated)::
Junio C Hamano1aa40d22010-01-21 17:46:43890Tells 'git add' to continue adding files when some files cannot be
Junio C Hamano92d80372016-07-13 22:00:05891added due to indexing errors. Equivalent to the `--ignore-errors`
Junio C Hamanobe087982015-02-22 21:29:39892option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
893as it does not follow the usual naming convention for configuration
894variables.
Junio C Hamano3d141512009-06-01 01:22:40895
Junio C Hamano33db4372006-06-07 19:51:45896alias.*::
Junio C Hamano35738e82008-01-07 07:55:46897Command aliases for the linkgit:git[1] command wrapper - e.g.
Junio C Hamano33db4372006-06-07 19:51:45898after defining "alias.last = cat-file commit HEAD", the invocation
899"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17900confusion and troubles with script usage, aliases that
Junio C Hamano076ffcc2013-02-06 05:13:21901hide existing Git commands are ignored. Arguments are split by
Junio C Hamanof1d14802006-06-08 00:48:17902spaces, the usual shell quoting and escaping is supported.
Junio C Hamano2efd5e42014-11-10 22:38:52903A quote pair or a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39904+
905If the alias expansion is prefixed with an exclamation point,
906it will be treated as a shell command. For example, defining
907"alias.new = !gitk --all --not ORIG_HEAD", the invocation
908"git new" is equivalent to running the shell command
Junio C Hamano48bc1ce2009-07-09 16:49:19909"gitk --all --not ORIG_HEAD". Note that shell commands will be
910executed from the top-level directory of a repository, which may
911not necessarily be the current directory.
Junio C Hamano042f2142016-06-27 18:05:05912`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
Junio C Hamano5f2627d2011-05-06 20:23:48913from the original current directory. See linkgit:git-rev-parse[1].
Junio C Hamano9cb74f22007-02-12 04:15:05914
Junio C Hamanocaa712a2010-03-11 01:17:35915am.keepcr::
916If true, git-am will call git-mailsplit for patches in mbox format
Junio C Hamano92d80372016-07-13 22:00:05917with parameter `--keep-cr`. In this case git-mailsplit will
Junio C Hamano619596a2010-08-18 22:15:35918not remove `\r` from lines ending with `\r\n`. Can be overridden
Junio C Hamano92d80372016-07-13 22:00:05919by giving `--no-keep-cr` from the command line.
Junio C Hamanocaa712a2010-03-11 01:17:35920See linkgit:git-am[1], linkgit:git-mailsplit[1].
921
Junio C Hamano9c512872015-08-12 21:59:25922am.threeWay::
923By default, `git am` will fail if the patch does not apply cleanly. When
924set to true, this setting tells `git am` to fall back on 3-way merge if
925the patch records the identity of blobs it is supposed to apply to and
926we have those blobs available locally (equivalent to giving the `--3way`
927option from the command line). Defaults to `false`.
928See linkgit:git-am[1].
929
Junio C Hamano322c6242015-03-23 21:32:46930apply.ignoreWhitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43931When set to 'change', tells 'git apply' to ignore changes in
Junio C Hamano92d80372016-07-13 22:00:05932whitespace, in the same way as the `--ignore-space-change`
Junio C Hamanofe24db02009-08-22 05:10:47933option.
Junio C Hamano1aa40d22010-01-21 17:46:43934When set to one of: no, none, never, false tells 'git apply' to
Junio C Hamanofe24db02009-08-22 05:10:47935respect all whitespace differences.
936See linkgit:git-apply[1].
937
Junio C Hamano07824ce2006-04-25 07:36:54938apply.whitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43939Tells 'git apply' how to handle whitespaces, in the same way
Junio C Hamano92d80372016-07-13 22:00:05940as the `--whitespace` option. See linkgit:git-apply[1].
Junio C Hamano07824ce2006-04-25 07:36:54941
Junio C Hamano322c6242015-03-23 21:32:46942branch.autoSetupMerge::
Junio C Hamano1aa40d22010-01-21 17:46:43943Tells 'git branch' and 'git checkout' to set up new branches
Junio C Hamano24bc09a2008-02-28 00:27:44944so that linkgit:git-pull[1] will appropriately merge from the
945starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32946this behavior can be chosen per-branch using the `--track`
Junio C Hamano24bc09a2008-02-28 00:27:44947and `--no-track` options. The valid settings are: `false` -- no
948automatic setup is done; `true` -- automatic setup is done when the
Junio C Hamano97bcb482010-11-25 03:16:07949starting point is a remote-tracking branch; `always` --
950automatic setup is done when the starting point is either a
951local branch or remote-tracking
Junio C Hamano24bc09a2008-02-28 00:27:44952branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32953
Junio C Hamano322c6242015-03-23 21:32:46954branch.autoSetupRebase::
Junio C Hamano1aa40d22010-01-21 17:46:43955When a new branch is created with 'git branch' or 'git checkout'
Junio C Hamano076ffcc2013-02-06 05:13:21956that tracks another branch, this variable tells Git to set
Junio C Hamano869bb802008-05-12 00:29:47957up pull to rebase instead of merge (see "branch.<name>.rebase").
958When `never`, rebase is never automatically set to true.
959When `local`, rebase is set to true for tracked branches of
960other local branches.
961When `remote`, rebase is set to true for tracked branches of
Junio C Hamano97bcb482010-11-25 03:16:07962remote-tracking branches.
Junio C Hamano869bb802008-05-12 00:29:47963When `always`, rebase will be set to true for all tracking
964branches.
Junio C Hamano322c6242015-03-23 21:32:46965See "branch.autoSetupMerge" for details on how to set up a
Junio C Hamano869bb802008-05-12 00:29:47966branch to track another branch.
967This option defaults to never.
968
Junio C Hamano47c1e3c2006-09-25 04:45:55969branch.<name>.remote::
Junio C Hamano63b6fdb2013-04-07 23:37:13970When on branch <name>, it tells 'git fetch' and 'git push'
971which remote to fetch from/push to. The remote to push to
Junio C Hamano322c6242015-03-23 21:32:46972may be overridden with `remote.pushDefault` (for all branches).
Junio C Hamano63b6fdb2013-04-07 23:37:13973The remote to push to, for the current branch, may be further
Junio C Hamano322c6242015-03-23 21:32:46974overridden by `branch.<name>.pushRemote`. If no remote is
Junio C Hamano63b6fdb2013-04-07 23:37:13975configured, or if you are not on any branch, it defaults to
Junio C Hamano322c6242015-03-23 21:32:46976`origin` for fetching and `remote.pushDefault` for pushing.
Junio C Hamano238ce9c2013-10-23 21:56:38977Additionally, `.` (a period) is the current local repository
978(a dot-repository), see `branch.<name>.merge`'s final note below.
Junio C Hamano63b6fdb2013-04-07 23:37:13979
Junio C Hamano322c6242015-03-23 21:32:46980branch.<name>.pushRemote::
Junio C Hamano63b6fdb2013-04-07 23:37:13981When on branch <name>, it overrides `branch.<name>.remote` for
Junio C Hamano322c6242015-03-23 21:32:46982pushing. It also overrides `remote.pushDefault` for pushing
Junio C Hamano63b6fdb2013-04-07 23:37:13983from branch <name>. When you pull from one place (e.g. your
984upstream) and push to another place (e.g. your own publishing
Junio C Hamano322c6242015-03-23 21:32:46985repository), you would want to set `remote.pushDefault` to
Junio C Hamano63b6fdb2013-04-07 23:37:13986specify the remote to push to for all branches, and use this
987option to override it for a specific branch.
Junio C Hamano47c1e3c2006-09-25 04:45:55988
989branch.<name>.merge::
Junio C Hamano0706c802009-03-30 22:34:19990Defines, together with branch.<name>.remote, the upstream branch
Junio C Hamanob02377c2011-04-28 22:26:02991for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
Junio C Hamano1aa40d22010-01-21 17:46:43992branch to merge and can also affect 'git push' (see push.default).
993When in branch <name>, it tells 'git fetch' the default
Junio C Hamanoc2b47092007-10-25 06:50:31994refspec to be marked for merging in FETCH_HEAD. The value is
995handled like the remote part of a refspec, and must match a
996ref which is fetched from the remote given by
997"branch.<name>.remote".
Junio C Hamano1aa40d22010-01-21 17:46:43998The merge information is used by 'git pull' (which at first calls
999'git fetch') to lookup the default branch for merging. Without
1000this option, 'git pull' defaults to merge the first refspec fetched.
Junio C Hamano96010b22006-12-09 21:15:461001Specify multiple values to get an octopus merge.
Junio C Hamano1aa40d22010-01-21 17:46:431002If you wish to setup 'git pull' so that it merges into <name> from
Junio C Hamano6e149c02007-03-16 10:21:071003another branch in the local repository, you can point
Junio C Hamano238ce9c2013-10-23 21:56:381004branch.<name>.merge to the desired branch, and use the relative path
1005setting `.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:551006
Junio C Hamano322c6242015-03-23 21:32:461007branch.<name>.mergeOptions::
Junio C Hamano1b50ce92007-10-03 12:05:531008Sets default options for merging into branch <name>. The syntax and
Junio C Hamanoc0e55e72009-10-10 00:56:291009supported options are the same as those of linkgit:git-merge[1], but
Junio C Hamano1b50ce92007-10-03 12:05:531010option values containing whitespace characters are currently not
1011supported.
1012
Junio C Hamano0c999702007-12-03 09:57:551013branch.<name>.rebase::
1014When true, rebase the branch <name> on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:081015instead of merging the default branch from the default remote when
Junio C Hamano515ab1d2011-12-09 23:41:201016"git pull" is run. See "pull.rebase" for doing this in a non
1017branch-specific manner.
1018+
Junio C Hamano7db630e2015-09-17 20:26:221019When preserve, also pass `--preserve-merges` along to 'git rebase'
1020so that locally committed merge commits will not be flattened
1021by running 'git pull'.
Junio C Hamanocf4a1742013-09-11 22:57:501022+
Junio C Hamano289d7e82016-01-27 00:20:381023When the value is `interactive`, the rebase is run in interactive mode.
1024+
Junio C Hamano515ab1d2011-12-09 23:41:201025*NOTE*: this is a possibly dangerous operation; do *not* use
1026it unless you understand the implications (see linkgit:git-rebase[1]
1027for details).
Junio C Hamano0c999702007-12-03 09:57:551028
Junio C Hamano46247182013-01-09 20:50:281029branch.<name>.description::
1030Branch description, can be edited with
1031`git branch --edit-description`. Branch description is
1032automatically added in the format-patch cover letter or
1033request-pull summary.
1034
Junio C Hamano8760ea62008-03-14 08:58:451035browser.<tool>.cmd::
1036Specify the command to invoke the specified browser. The
1037specified command is evaluated in shell with the URLs passed
Junio C Hamano360e3a12011-07-13 23:51:561038as arguments. (See linkgit:git-web{litdd}browse[1].)
Junio C Hamano8760ea62008-03-14 08:58:451039
Junio C Hamanoe35a6fc2008-01-29 09:46:271040browser.<tool>.path::
1041Override the path for the given tool that may be used to
Junio C Hamano92d80372016-07-13 22:00:051042browse HTML help (see `-w` option in linkgit:git-help[1]) or a
Junio C Hamanoe35a6fc2008-01-29 09:46:271043working repository in gitweb (see linkgit:git-instaweb[1]).
1044
Junio C Hamano47b9acd2007-04-24 07:34:341045clean.requireForce::
Junio C Hamanoe6f28d02013-09-17 21:34:001046A boolean to make git-clean do nothing unless given -f,
1047-i or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:341048
Junio C Hamanoeb692952007-01-03 22:02:121049color.branch::
1050A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:461051linkgit:git-branch[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:211052`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoad70bf02016-09-26 23:44:271053only when the output is to a terminal. If unset, then the
1054value of `color.ui` is used (`auto` by default).
Junio C Hamanoeb692952007-01-03 22:02:121055
1056color.branch.<slot>::
1057Use customized color for branch coloration. `<slot>` is one of
1058`current` (the current branch), `local` (a local branch),
Junio C Hamano76927822013-04-19 21:26:571059`remote` (a remote-tracking branch in refs/remotes/),
1060`upstream` (upstream tracking branch), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:221061refs).
Junio C Hamanoeb692952007-01-03 22:02:121062
Junio C Hamano3f403b02006-12-13 10:14:131063color.diff::
Junio C Hamano5f2627d2011-05-06 20:23:481064Whether to use ANSI escape sequences to add color to patches.
1065If this is set to `always`, linkgit:git-diff[1],
1066linkgit:git-log[1], and linkgit:git-show[1] will use color
1067for all patches. If it is set to `true` or `auto`, those
1068commands will only use color when output is to the terminal.
Junio C Hamanoad70bf02016-09-26 23:44:271069If unset, then the value of `color.ui` is used (`auto` by
1070default).
Junio C Hamano5f2627d2011-05-06 20:23:481071+
Junio C Hamanod75148a2014-04-08 19:48:381072This does not affect linkgit:git-format-patch[1] or the
Junio C Hamano5f2627d2011-05-06 20:23:481073'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1074command line with the `--color[=<when>]` option.
Junio C Hamano9ae1a062006-07-10 08:12:341075
Junio C Hamano3f403b02006-12-13 10:14:131076color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:221077Use customized color for diff colorization. `<slot>` specifies
1078which part of the patch to use the specified color, and is one
Junio C Hamano8c5d5942015-06-11 19:37:481079of `context` (context text - `plain` is a historical synonym),
1080`meta` (metainformation), `frag`
Junio C Hamano2bd8a742009-12-01 21:16:591081(hunk header), 'func' (function in hunk header), `old` (removed lines),
1082`new` (added lines), `commit` (commit headers), or `whitespace`
Junio C Hamano07622622015-03-20 21:47:261083(highlighting whitespace errors).
Junio C Hamano9ae1a062006-07-10 08:12:341084
Junio C Hamano7d449522010-07-01 00:08:511085color.decorate.<slot>::
1086Use customized color for 'git log --decorate' output. `<slot>` is one
1087of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
Junio C Hamano97bcb482010-11-25 03:16:071088branches, remote-tracking branches, tags, stash and HEAD, respectively.
Junio C Hamano7d449522010-07-01 00:08:511089
Junio C Hamanod257cff2009-03-18 05:27:161090color.grep::
1091When set to `always`, always highlight matches. When `false` (or
1092`never`), never. When set to `true` or `auto`, use color only
Junio C Hamanoad70bf02016-09-26 23:44:271093when the output is written to the terminal. If unset, then the
1094value of `color.ui` is used (`auto` by default).
Junio C Hamanod257cff2009-03-18 05:27:161095
Junio C Hamano0299d922010-03-20 20:59:311096color.grep.<slot>::
1097Use customized color for grep colorization. `<slot>` specifies which
1098part of the line to use the specified color, and is one of
1099+
1100--
1101`context`;;
1102non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1103`filename`;;
1104filename prefix (when not using `-h`)
1105`function`;;
1106function name lines (when using `-p`)
1107`linenumber`;;
1108line number prefix (when using `-n`)
1109`match`;;
Junio C Hamanoc14e6ad2014-10-31 20:25:531110matching text (same as setting `matchContext` and `matchSelected`)
1111`matchContext`;;
1112matching text in context lines
1113`matchSelected`;;
1114matching text in selected lines
Junio C Hamano0299d922010-03-20 20:59:311115`selected`;;
1116non-matching text in selected lines
1117`separator`;;
1118separators between fields on a line (`:`, `-`, and `=`)
1119and between hunks (`--`)
1120--
Junio C Hamanod257cff2009-03-18 05:27:161121
Junio C Hamano00b8b632007-12-07 09:50:491122color.interactive::
Junio C Hamano35738e82008-01-07 07:55:461123When set to `always`, always use colors for interactive prompts
Junio C Hamano58f587a2013-07-22 19:20:591124and displays (such as those used by "git-add --interactive" and
1125"git-clean --interactive"). When false (or `never`), never.
1126When set to `true` or `auto`, use colors only when the output is
Junio C Hamanoad70bf02016-09-26 23:44:271127to the terminal. If unset, then the value of `color.ui` is
1128used (`auto` by default).
Junio C Hamano00b8b632007-12-07 09:50:491129
1130color.interactive.<slot>::
Junio C Hamano58f587a2013-07-22 19:20:591131Use customized color for 'git add --interactive' and 'git clean
1132--interactive' output. `<slot>` may be `prompt`, `header`, `help`
1133or `error`, for four distinct types of normal output from
Junio C Hamano07622622015-03-20 21:47:261134interactive commands.
Junio C Hamano00b8b632007-12-07 09:50:491135
Junio C Hamanoe7935c42006-12-13 21:32:171136color.pager::
1137A boolean to enable/disable colored output when the pager is in
1138use (default is true).
1139
Junio C Hamano322c6242015-03-23 21:32:461140color.showBranch::
Junio C Hamano52ba2952009-05-18 17:43:021141A boolean to enable/disable color in the output of
1142linkgit:git-show-branch[1]. May be set to `always`,
1143`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoad70bf02016-09-26 23:44:271144only when the output is to a terminal. If unset, then the
1145value of `color.ui` is used (`auto` by default).
Junio C Hamano52ba2952009-05-18 17:43:021146
Junio C Hamanoe7935c42006-12-13 21:32:171147color.status::
1148A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:461149linkgit:git-status[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:211150`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoad70bf02016-09-26 23:44:271151only when the output is to a terminal. If unset, then the
1152value of `color.ui` is used (`auto` by default).
Junio C Hamanoe7935c42006-12-13 21:32:171153
1154color.status.<slot>::
1155Use customized color for status colorization. `<slot>` is
1156one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:041157`added` or `updated` (files which are added but not committed),
1158`changed` (files which are changed but not added in the index),
Junio C Hamano076ffcc2013-02-06 05:13:211159`untracked` (files which are not tracked by Git),
Junio C Hamano5992a252015-03-17 23:39:301160`branch` (the current branch),
Junio C Hamanob713ff12008-05-24 01:12:301161`nobranch` (the color the 'no branch' warning is shown in, defaulting
Junio C Hamanod5176902017-05-16 04:30:561162to red),
1163`localBranch` or `remoteBranch` (the local and remote branch names,
1164respectively, when branch and tracking information is displayed in the
1165status short-format), or
Junio C Hamano5992a252015-03-17 23:39:301166`unmerged` (files which have unmerged changes).
Junio C Hamanoe7935c42006-12-13 21:32:171167
Junio C Hamano83d46a22008-02-21 02:29:421168color.ui::
Junio C Hamano5f2627d2011-05-06 20:23:481169This variable determines the default value for variables such
1170as `color.diff` and `color.grep` that control the use of color
1171per command family. Its scope will expand as more commands learn
1172configuration to set a default for the `--color` option. Set it
Junio C Hamanofa1d3492013-06-20 23:39:431173to `false` or `never` if you prefer Git commands not to use
1174color unless enabled explicitly with some other configuration
1175or the `--color` option. Set it to `always` if you want all
1176output not intended for machine consumption to use color, to
1177`true` or `auto` (this is the default since Git 1.8.4) if you
1178want such output to use color when written to the terminal.
Junio C Hamano83d46a22008-02-21 02:29:421179
Junio C Hamano22700fb2012-05-03 23:07:251180column.ui::
1181Specify whether supported commands should output in columns.
1182This variable consists of a list of tokens separated by spaces
1183or commas:
1184+
Junio C Hamanoa1952302013-07-01 21:31:181185These options control when the feature should be enabled
1186(defaults to 'never'):
1187+
Junio C Hamano22700fb2012-05-03 23:07:251188--
1189`always`;;
1190always show in columns
1191`never`;;
1192never show in columns
1193`auto`;;
1194show in columns if the output is to the terminal
Junio C Hamanoa1952302013-07-01 21:31:181195--
1196+
1197These options control layout (defaults to 'column'). Setting any
1198of these implies 'always' if none of 'always', 'never', or 'auto' are
1199specified.
1200+
1201--
Junio C Hamano22700fb2012-05-03 23:07:251202`column`;;
Junio C Hamanoa1952302013-07-01 21:31:181203fill columns before rows
Junio C Hamano22700fb2012-05-03 23:07:251204`row`;;
1205fill rows before columns
1206`plain`;;
1207show in one column
Junio C Hamanoa1952302013-07-01 21:31:181208--
1209+
1210Finally, these options can be combined with a layout option (defaults
1211to 'nodense'):
1212+
1213--
Junio C Hamano22700fb2012-05-03 23:07:251214`dense`;;
1215make unequal size columns to utilize more space
1216`nodense`;;
1217make equal size columns
1218--
Junio C Hamano22700fb2012-05-03 23:07:251219
1220column.branch::
1221Specify whether to output branch listing in `git branch` in columns.
1222See `column.ui` for details.
1223
Junio C Hamano58f587a2013-07-22 19:20:591224column.clean::
1225Specify the layout when list items in `git clean -i`, which always
1226shows files and directories in columns. See `column.ui` for details.
1227
Junio C Hamano22700fb2012-05-03 23:07:251228column.status::
1229Specify whether to output untracked files in `git status` in columns.
1230See `column.ui` for details.
1231
1232column.tag::
1233Specify whether to output tag listing in `git tag` in columns.
1234See `column.ui` for details.
1235
Junio C Hamanoce836cc2013-01-21 02:01:531236commit.cleanup::
1237This setting overrides the default of the `--cleanup` option in
1238`git commit`. See linkgit:git-commit[1] for details. Changing the
1239default can be useful when you always want to keep lines that begin
1240with comment character `#` in your log message, in which case you
1241would do `git config commit.cleanup whitespace` (note that you will
1242have to remove the help lines that begin with `#` in the commit log
1243template yourself, if you do this).
1244
Junio C Hamano322c6242015-03-23 21:32:461245commit.gpgSign::
Junio C Hamano5b3533d2014-02-27 23:07:151246
1247A boolean to specify whether all commits should be GPG signed.
1248Use of this option when doing operations such as rebase can
1249result in a large number of commits being signed. It may be
1250convenient to use an agent to avoid typing your GPG passphrase
1251several times.
1252
Junio C Hamanod0d892c2010-01-24 20:06:291253commit.status::
Junio C Hamano6ce6b6c2010-01-18 01:25:501254A boolean to enable/disable inclusion of status information in the
1255commit message template when using an editor to prepare the commit
1256message. Defaults to true.
1257
Junio C Hamano4653c6f2008-11-26 22:50:201258commit.template::
Junio C Hamano198b1f12016-05-17 22:27:241259Specify the pathname of a file to use as the template for
1260new commit messages.
Junio C Hamano4653c6f2008-11-26 22:50:201261
Junio C Hamanof2a3a752016-05-23 22:54:391262commit.verbose::
1263A boolean or int to specify the level of verbose with `git commit`.
1264See linkgit:git-commit[1].
1265
Junio C Hamano0df92712011-12-21 22:30:441266credential.helper::
1267Specify an external helper to be called when a username or
1268password credential is needed; the helper may consult external
Junio C Hamano4ba4a782016-04-03 19:11:321269storage to avoid prompting the user for the credentials. Note
1270that multiple helpers may be defined. See linkgit:gitcredentials[7]
1271for details.
Junio C Hamano0df92712011-12-21 22:30:441272
1273credential.useHttpPath::
1274When acquiring credentials, consider the "path" component of an http
1275or https URL to be important. Defaults to false. See
1276linkgit:gitcredentials[7] for more information.
1277
1278credential.username::
1279If no username is set for a network authentication, use this username
1280by default. See credential.<context>.* below, and
1281linkgit:gitcredentials[7].
1282
1283credential.<url>.*::
1284Any of the credential.* options above can be applied selectively to
1285some credentials. For example "credential.https://example.com.username"
1286would set the default username only for https connections to
1287example.com. See linkgit:gitcredentials[7] for details on how URLs are
1288matched.
1289
Junio C Hamanoabb8a052015-12-04 22:43:111290credentialCache.ignoreSIGHUP::
1291Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1292
Junio C Hamano209ebe82011-04-27 21:09:591293include::diff-config.txt[]
Junio C Hamano3bd66e92009-04-18 06:17:561294
1295difftool.<tool>.path::
1296Override the path for the given tool. This is useful in case
1297your tool is not in the PATH.
1298
1299difftool.<tool>.cmd::
1300Specify the command to invoke the specified diff tool.
1301The specified command is evaluated in shell with the following
1302variables available: 'LOCAL' is set to the name of the temporary
1303file containing the contents of the diff pre-image and 'REMOTE'
1304is set to the name of the temporary file containing the contents
1305of the diff post-image.
1306
1307difftool.prompt::
1308Prompt before each invocation of the diff tool.
1309
Junio C Hamanofedb1b42016-06-20 21:23:401310fastimport.unpackLimit::
1311If the number of objects imported by linkgit:git-fast-import[1]
1312is below this limit, then the objects will be unpacked into
1313loose object files. However if the number of imported objects
1314equals or exceeds this limit then the pack will be stored as a
1315pack. Storing the pack from a fast-import can make the import
1316operation complete faster, especially on slow filesystems. If
1317not set, the value of `transfer.unpackLimit` is used instead.
1318
Junio C Hamano0d75e872010-12-17 06:57:261319fetch.recurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:101320This option can be either set to a boolean value or to 'on-demand'.
1321Setting it to a boolean changes the behavior of fetch and pull to
1322unconditionally recurse into submodules when set to true or to not
1323recurse at all when set to false. When set to 'on-demand' (the default
1324value), fetch and pull will only recurse into a populated submodule
1325when its superproject retrieves a commit that updates the submodule's
1326reference.
Junio C Hamano0d75e872010-12-17 06:57:261327
Junio C Hamano8fb66e52011-10-05 20:59:511328fetch.fsckObjects::
1329If it is set to true, git-fetch-pack will check all fetched
1330objects. It will abort in the case of a malformed object or a
1331broken link. The result of an abort are only dangling objects.
1332Defaults to false. If not set, the value of `transfer.fsckObjects`
1333is used instead.
1334
Junio C Hamano54ea8d32007-01-25 07:59:481335fetch.unpackLimit::
Junio C Hamano076ffcc2013-02-06 05:13:211336If the number of objects fetched over the Git native
Junio C Hamano54ea8d32007-01-25 07:59:481337transfer is below this
1338limit, then the objects will be unpacked into loose object
1339files. However if the number of received objects equals or
1340exceeds this limit then the received pack will be stored as
1341a pack, after adding any missing delta bases. Storing the
1342pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:171343especially on slow filesystems. If not set, the value of
1344`transfer.unpackLimit` is used instead.
Junio C Hamano54ea8d32007-01-25 07:59:481345
Junio C Hamano8eac2682013-09-09 22:35:201346fetch.prune::
1347If true, fetch will automatically behave as if the `--prune`
1348option was given on the command line. See also `remote.<name>.prune`.
1349
Junio C Hamano1a1b8472016-07-19 21:37:131350fetch.output::
1351Control how ref update status is printed. Valid values are
1352`full` and `compact`. Default value is `full`. See section
1353OUTPUT in linkgit:git-fetch[1] for detail.
1354
Junio C Hamanof4581102009-04-25 08:29:591355format.attach::
1356Enable multipart/mixed attachments as the default for
1357'format-patch'. The value can also be a double quoted string
1358which will enable attachments as the default and set the
1359value as the boundary. See the --attach option in
1360linkgit:git-format-patch[1].
1361
Junio C Hamanoaf182942016-08-10 20:46:261362format.from::
1363Provides the default value for the `--from` option to format-patch.
1364Accepts a boolean value, or a name and email address. If false,
1365format-patch defaults to `--no-from`, using commit authors directly in
1366the "From:" field of patch mails. If true, format-patch defaults to
1367`--from`, using your committer identity in the "From:" field of patch
1368mails and including a "From:" field in the body of the patch mail if
1369different. If set to a non-boolean value, format-patch uses that
1370value instead of your committer identity. Defaults to false.
1371
Junio C Hamano8c5802d2007-11-15 00:13:361372format.numbered::
Junio C Hamano7d06a8a2008-10-20 05:42:331373A boolean which can enable or disable sequence numbers in patch
1374subjects. It defaults to "auto" which enables it only if there
1375is more than one patch. It can be enabled or disabled for all
1376messages by setting it to "true" or "false". See --numbered
1377option in linkgit:git-format-patch[1].
Junio C Hamano8c5802d2007-11-15 00:13:361378
Junio C Hamano07824ce2006-04-25 07:36:541379format.headers::
1380Additional email headers to include in a patch to be submitted
Junio C Hamano35738e82008-01-07 07:55:461381by mail. See linkgit:git-format-patch[1].
Junio C Hamano07824ce2006-04-25 07:36:541382
Junio C Hamano70664a02010-07-13 22:48:051383format.to::
Junio C Hamanof4581102009-04-25 08:29:591384format.cc::
Junio C Hamano70664a02010-07-13 22:48:051385Additional recipients to include in a patch to be submitted
1386by mail. See the --to and --cc options in
1387linkgit:git-format-patch[1].
Junio C Hamanof4581102009-04-25 08:29:591388
Junio C Hamano322c6242015-03-23 21:32:461389format.subjectPrefix::
Junio C Hamanof4581102009-04-25 08:29:591390The default for format-patch is to output files with the '[PATCH]'
1391subject prefix. Use this variable to change that prefix.
1392
Junio C Hamano89a57342010-06-22 23:22:551393format.signature::
1394The default for format-patch is to output a signature containing
Junio C Hamano076ffcc2013-02-06 05:13:211395the Git version number. Use this variable to change that default.
Junio C Hamano89a57342010-06-22 23:22:551396Set this variable to the empty string ("") to suppress
1397signature generation.
1398
Junio C Hamano322c6242015-03-23 21:32:461399format.signatureFile::
Junio C Hamanoc8c398a2014-06-16 21:14:051400Works just like format.signature except the contents of the
1401file specified by this variable will be used as the signature.
1402
Junio C Hamanod4c8e112007-03-04 10:32:381403format.suffix::
1404The default for format-patch is to output files with the suffix
1405`.patch`. Use this variable to change that suffix (make sure to
1406include the dot if you want it).
1407
Junio C Hamano86bcccc2008-03-08 09:33:551408format.pretty::
1409The default pretty format for log/show/whatchanged command,
1410See linkgit:git-log[1], linkgit:git-show[1],
1411linkgit:git-whatchanged[1].
1412
Junio C Hamanoea6a7642009-03-11 23:56:191413format.thread::
Junio C Hamano1aa40d22010-01-21 17:46:431414The default threading style for 'git format-patch'. Can be
Junio C Hamanob141a922010-01-10 19:55:141415a boolean value, or `shallow` or `deep`. `shallow` threading
1416makes every mail a reply to the head of the series,
Junio C Hamanoea6a7642009-03-11 23:56:191417where the head is chosen from the cover letter, the
Junio C Hamanob76a6862012-05-02 22:02:461418`--in-reply-to`, and the first patch mail, in this order.
Junio C Hamanof4581102009-04-25 08:29:591419`deep` threading makes every mail a reply to the previous one.
Junio C Hamanoea6a7642009-03-11 23:56:191420A true boolean value is the same as `shallow`, and a false
1421value disables threading.
1422
Junio C Hamano322c6242015-03-23 21:32:461423format.signOff::
Junio C Hamano804a9742013-04-28 23:10:311424A boolean value which lets you enable the `-s/--signoff` option of
1425format-patch by default. *Note:* Adding the Signed-off-by: line to a
1426patch should be a conscious act and means that you certify you have
1427the rights to submit this work under the same open source license.
1428Please see the 'SubmittingPatches' document for further discussion.
Junio C Hamano5f9a6f02009-04-06 08:26:561429
Junio C Hamanoea3b7522013-04-18 19:37:531430format.coverLetter::
1431A boolean that controls whether to generate a cover-letter when
1432format-patch is invoked, but in addition can be set to "auto", to
1433generate a cover-letter only when there's more than one patch.
1434
Junio C Hamano289d7e82016-01-27 00:20:381435format.outputDirectory::
1436Set a custom directory to store the resulting files instead of the
1437current working directory.
1438
Junio C Hamanof2a3a752016-05-23 22:54:391439format.useAutoBase::
1440A boolean value which lets you enable the `--base=auto` option of
1441format-patch by default.
1442
Junio C Hamano209ebe82011-04-27 21:09:591443filter.<driver>.clean::
1444The command which is used to convert the content of a worktree
1445file to a blob upon checkin. See linkgit:gitattributes[5] for
1446details.
1447
1448filter.<driver>.smudge::
1449The command which is used to convert the content of a blob
1450object to a worktree file upon checkout. See
1451linkgit:gitattributes[5] for details.
1452
Junio C Hamanod7ed4042015-08-03 19:43:001453fsck.<msg-id>::
1454Allows overriding the message type (error, warn or ignore) of a
1455specific message ID such as `missingEmail`.
1456+
1457For convenience, fsck prefixes the error/warning with the message ID,
1458e.g. "missingEmail: invalid author/committer line - missing email" means
1459that setting `fsck.missingEmail = ignore` will hide that issue.
1460+
1461This feature is intended to support working with legacy repositories
1462which cannot be repaired without disruptive changes.
1463
1464fsck.skipList::
1465The path to a sorted list of object names (i.e. one SHA-1 per
1466line) that are known to be broken in a non-fatal way and should
1467be ignored. This feature is useful when an established project
1468should be accepted despite early commits containing errors that
1469can be safely ignored such as invalid committer email addresses.
1470Note: corrupt objects cannot be skipped with this setting.
1471
Junio C Hamano624dd4c2014-04-03 21:56:301472gc.aggressiveDepth::
1473The depth parameter used in the delta compression
1474algorithm used by 'git gc --aggressive'. This defaults
Junio C Hamano53800482016-09-21 23:26:431475to 50.
Junio C Hamano624dd4c2014-04-03 21:56:301476
Junio C Hamanof2ce2972007-05-20 19:12:091477gc.aggressiveWindow::
1478The window size parameter used in the delta compression
Junio C Hamano1aa40d22010-01-21 17:46:431479algorithm used by 'git gc --aggressive'. This defaults
Junio C Hamanob04bb3f2010-04-14 14:07:361480to 250.
Junio C Hamanof2ce2972007-05-20 19:12:091481
Junio C Hamano1b50ce92007-10-03 12:05:531482gc.auto::
1483When there are approximately more than this many loose
1484objects in the repository, `git gc --auto` will pack them.
1485Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:171486light-weight garbage collection from time to time. The
1487default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531488
Junio C Hamano322c6242015-03-23 21:32:461489gc.autoPackLimit::
Junio C Hamano1b50ce92007-10-03 12:05:531490When there are more than this many packs that are not
1491marked with `*.keep` file in the repository, `git gc
Junio C Hamanoe77b0152008-01-12 06:44:171492--auto` consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:371493default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531494
Junio C Hamano322c6242015-03-23 21:32:461495gc.autoDetach::
Junio C Hamanofb5ffde2014-11-04 22:38:561496Make `git gc --auto` return immediately and run in background
Junio C Hamano08ef8c22014-03-10 14:53:441497if the system supports it. Default is true.
1498
Junio C Hamanocbe0eb22017-02-27 23:37:491499gc.logExpiry::
1500If the file gc.log exists, then `git gc --auto` won't run
1501unless that file is more than 'gc.logExpiry' old. Default is
1502"1.day". See `gc.pruneExpire` for more ways to specify its
1503value.
1504
Junio C Hamano322c6242015-03-23 21:32:461505gc.packRefs::
Junio C Hamanob141a922010-01-10 19:55:141506Running `git pack-refs` in a repository renders it
1507unclonable by Git versions prior to 1.5.1.2 over dumb
1508transports such as HTTP. This variable determines whether
Junio C Hamanocdd1c332010-12-20 10:08:001509'git gc' runs `git pack-refs`. This can be set to `notbare`
Junio C Hamanob141a922010-01-10 19:55:141510to enable it within all non-bare repos or it can be set to a
1511boolean value. The default is `true`.
Junio C Hamano9d52e572007-02-13 23:48:201512
Junio C Hamano322c6242015-03-23 21:32:461513gc.pruneExpire::
Junio C Hamano1aa40d22010-01-21 17:46:431514When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
Junio C Hamanoa3148f52009-01-14 08:49:571515Override the grace period with this config variable. The value
Junio C Hamano9c512872015-08-12 21:59:251516"now" may be used to disable this grace period and always prune
1517unreachable objects immediately, or "never" may be used to
Junio C Hamano56ace3d2017-01-10 23:43:411518suppress pruning. This feature helps prevent corruption when
1519'git gc' runs concurrently with another process writing to the
1520repository; see the "NOTES" section of linkgit:git-gc[1].
Junio C Hamano09a926d2008-03-13 07:55:291521
Junio C Hamano9c512872015-08-12 21:59:251522gc.worktreePruneExpire::
1523When 'git gc' is run, it calls
1524'git worktree prune --expire 3.months.ago'.
1525This config variable can be used to set a different grace
1526period. The value "now" may be used to disable the grace
Junio C Hamano198b1f12016-05-17 22:27:241527period and prune `$GIT_DIR/worktrees` immediately, or "never"
Junio C Hamano9c512872015-08-12 21:59:251528may be used to suppress pruning.
Junio C Hamano4cc4a842015-05-11 22:41:021529
Junio C Hamano322c6242015-03-23 21:32:461530gc.reflogExpire::
1531gc.<pattern>.reflogExpire::
Junio C Hamano1aa40d22010-01-21 17:46:431532'git reflog expire' removes reflog entries older than
Junio C Hamano9c512872015-08-12 21:59:251533this time; defaults to 90 days. The value "now" expires all
1534entries immediately, and "never" suppresses expiration
1535altogether. With "<pattern>" (e.g.
Junio C Hamanocc7636a2010-05-21 14:57:531536"refs/stash") in the middle the setting applies only to
1537the refs that match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551538
Junio C Hamano322c6242015-03-23 21:32:461539gc.reflogExpireUnreachable::
Junio C Hamanoa1746be2015-08-26 23:07:071540gc.<pattern>.reflogExpireUnreachable::
Junio C Hamano1aa40d22010-01-21 17:46:431541'git reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:551542this time and are not reachable from the current tip;
Junio C Hamano9c512872015-08-12 21:59:251543defaults to 30 days. The value "now" expires all entries
1544immediately, and "never" suppresses expiration altogether.
1545With "<pattern>" (e.g. "refs/stash")
Junio C Hamanocc7636a2010-05-21 14:57:531546in the middle, the setting applies only to the refs that
1547match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551548
Junio C Hamano322c6242015-03-23 21:32:461549gc.rerereResolved::
Junio C Hamano74640642006-12-27 10:59:551550Records of conflicted merge you resolved earlier are
Junio C Hamano1aa40d22010-01-21 17:46:431551kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461552The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551553
Junio C Hamano322c6242015-03-23 21:32:461554gc.rerereUnresolved::
Junio C Hamano74640642006-12-27 10:59:551555Records of conflicted merge you have not resolved are
Junio C Hamano1aa40d22010-01-21 17:46:431556kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461557The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551558
Junio C Hamano322c6242015-03-23 21:32:461559gitcvs.commitMsgAnnotation::
Junio C Hamanoa3148f52009-01-14 08:49:571560Append this string to each commit message. Set to empty string
1561to disable this feature. Defaults to "via git-CVS emulator".
1562
Junio C Hamano07824ce2006-04-25 07:36:541563gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:271564Whether the CVS server interface is enabled for this repository.
Junio C Hamano35738e82008-01-07 07:55:461565See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541566
Junio C Hamano322c6242015-03-23 21:32:461567gitcvs.logFile::
Junio C Hamanoa6387422007-08-25 03:54:271568Path to a log file where the CVS server interface well... logs
Junio C Hamano35738e82008-01-07 07:55:461569various stuff. See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541570
Junio C Hamano17bd2272008-09-01 06:11:171571gitcvs.usecrlfattr::
Junio C Hamanobb88cf42010-06-21 15:23:551572If true, the server will look up the end-of-line conversion
Junio C Hamano92d80372016-07-13 22:00:051573attributes for files to determine the `-k` modes to use. If
Junio C Hamano076ffcc2013-02-06 05:13:211574the attributes force Git to treat a file as text,
Junio C Hamano92d80372016-07-13 22:00:051575the `-k` mode will be left blank so CVS clients will
Junio C Hamanobb88cf42010-06-21 15:23:551576treat it as text. If they suppress text conversion, the file
Junio C Hamanocb1c44f2008-08-06 06:19:331577will be set with '-kb' mode, which suppresses any newline munging
Junio C Hamanobb88cf42010-06-21 15:23:551578the client might otherwise do. If the attributes do not allow
Junio C Hamano042f2142016-06-27 18:05:051579the file type to be determined, then `gitcvs.allBinary` is
Junio C Hamanobb88cf42010-06-21 15:23:551580used. See linkgit:gitattributes[5].
Junio C Hamanodfccbb02008-05-26 01:16:141581
Junio C Hamano322c6242015-03-23 21:32:461582gitcvs.allBinary::
Junio C Hamano042f2142016-06-27 18:05:051583This is used if `gitcvs.usecrlfattr` does not resolve
Junio C Hamanodfccbb02008-05-26 01:16:141584the correct '-kb' mode to use. If true, all
1585unresolved files are sent to the client in
1586mode '-kb'. This causes the client to treat them
1587as binary files, which suppresses any newline munging it
1588otherwise might do. Alternatively, if it is set to "guess",
1589then the contents of the file are examined to decide if
Junio C Hamano042f2142016-06-27 18:05:051590it is binary, similar to `core.autocrlf`.
Junio C Hamanoa2ad99e2007-04-18 09:57:041591
Junio C Hamano322c6242015-03-23 21:32:461592gitcvs.dbName::
Junio C Hamanoa2ad99e2007-04-18 09:57:041593Database used by git-cvsserver to cache revision information
Junio C Hamano076ffcc2013-02-06 05:13:211594derived from the Git repository. The exact meaning depends on the
Junio C Hamanoa2ad99e2007-04-18 09:57:041595used database driver, for SQLite (which is the default driver) this
1596is a filename. Supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461597linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Junio C Hamanoa2ad99e2007-04-18 09:57:041598Default: '%Ggitcvs.%m.sqlite'
1599
Junio C Hamano322c6242015-03-23 21:32:461600gitcvs.dbDriver::
Junio C Hamanoa2ad99e2007-04-18 09:57:041601Used Perl DBI driver. You can specify any available driver
Junio C Hamano804a9742013-04-28 23:10:311602for this here, but it might not work. git-cvsserver is tested
Junio C Hamanoa2ad99e2007-04-18 09:57:041603with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1604reported *not* to work with 'DBD::mysql'. Experimental feature.
1605May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamano35738e82008-01-07 07:55:461606See linkgit:git-cvsserver[1].
Junio C Hamanod9e0e5d2007-04-14 16:22:041607
Junio C Hamano322c6242015-03-23 21:32:461608gitcvs.dbUser, gitcvs.dbPass::
Junio C Hamano042f2142016-06-27 18:05:051609Database user and password. Only useful if setting `gitcvs.dbDriver`,
Junio C Hamanoa2ad99e2007-04-18 09:57:041610since SQLite has no concept of database users and/or passwords.
Junio C Hamano322c6242015-03-23 21:32:461611'gitcvs.dbUser' supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461612linkgit:git-cvsserver[1] for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:041613
Junio C Hamanoa74efce2008-04-02 08:39:081614gitcvs.dbTableNamePrefix::
1615Database table name prefix. Prepended to the names of any
1616database tables used, allowing a single database to be used
1617for several repositories. Supports variable substitution (see
1618linkgit:git-cvsserver[1] for details). Any non-alphabetic
1619characters will be replaced with underscores.
1620
Junio C Hamano042f2142016-06-27 18:05:051621All gitcvs variables except for `gitcvs.usecrlfattr` and
1622`gitcvs.allBinary` can also be specified as
Junio C Hamanodfccbb02008-05-26 01:16:141623'gitcvs.<access_method>.<varname>' (where 'access_method'
Junio C Hamanoa6387422007-08-25 03:54:271624is one of "ext" and "pserver") to make them apply only for the given
1625access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:041626
Junio C Hamano11821ed2011-10-19 18:42:091627gitweb.category::
1628gitweb.description::
1629gitweb.owner::
1630gitweb.url::
1631See linkgit:gitweb[1] for description.
1632
1633gitweb.avatar::
1634gitweb.blame::
1635gitweb.grep::
1636gitweb.highlight::
1637gitweb.patches::
1638gitweb.pickaxe::
1639gitweb.remote_heads::
Junio C Hamano322c6242015-03-23 21:32:461640gitweb.showSizes::
Junio C Hamano11821ed2011-10-19 18:42:091641gitweb.snapshot::
1642See linkgit:gitweb.conf[5] for description.
1643
Junio C Hamanoa03ac862011-04-02 04:32:291644grep.lineNumber::
Junio C Hamano92d80372016-07-13 22:00:051645If set to true, enable `-n` option by default.
Junio C Hamanoa03ac862011-04-02 04:32:291646
Junio C Hamanoa00504d2012-08-27 21:11:231647grep.patternType::
1648Set the default matching behavior. Using a value of 'basic', 'extended',
Junio C Hamano92d80372016-07-13 22:00:051649'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1650`--fixed-strings`, or `--perl-regexp` option accordingly, while the
Junio C Hamanoa00504d2012-08-27 21:11:231651value 'default' will return to the default matching behavior.
1652
Junio C Hamanoa03ac862011-04-02 04:32:291653grep.extendedRegexp::
Junio C Hamano92d80372016-07-13 22:00:051654If set to true, enable `--extended-regexp` option by default. This
Junio C Hamano042f2142016-06-27 18:05:051655option is ignored when the `grep.patternType` option is set to a value
Junio C Hamanoa00504d2012-08-27 21:11:231656other than 'default'.
Junio C Hamanoa03ac862011-04-02 04:32:291657
Junio C Hamanoa7da1ba2016-01-13 00:19:451658grep.threads::
1659Number of grep worker threads to use.
1660See `grep.threads` in linkgit:git-grep[1] for more information.
1661
Junio C Hamano4e6ba272016-01-20 23:23:191662grep.fallbackToNoIndex::
1663If set to true, fall back to git grep --no-index if git grep
1664is executed outside of a git repository. Defaults to false.
1665
Junio C Hamano4fd24422012-01-06 21:52:431666gpg.program::
Junio C Hamano198b1f12016-05-17 22:27:241667Use this custom program instead of "`gpg`" found on `$PATH` when
Junio C Hamano4fd24422012-01-06 21:52:431668making or verifying a PGP signature. The program must support the
Junio C Hamanoe1aeb5e2014-06-06 19:16:291669same command-line interface as GPG, namely, to verify a detached
Junio C Hamano198b1f12016-05-17 22:27:241670signature, "`gpg --verify $file - <$signature`" is run, and the
Junio C Hamano4fd24422012-01-06 21:52:431671program is expected to signal a good signature by exiting with
Junio C Hamanofb5ffde2014-11-04 22:38:561672code 0, and to generate an ASCII-armored detached signature, the
Junio C Hamano198b1f12016-05-17 22:27:241673standard input of "`gpg -bsau $key`" is fed with the contents to be
Junio C Hamano4fd24422012-01-06 21:52:431674signed, and the program is expected to send the result to its
1675standard output.
1676
Junio C Hamano322c6242015-03-23 21:32:461677gui.commitMsgWidth::
Junio C Hamano6d76d612008-05-09 05:46:081678Defines how wide the commit message window is in the
1679linkgit:git-gui[1]. "75" is the default.
1680
Junio C Hamano322c6242015-03-23 21:32:461681gui.diffContext::
Junio C Hamano6d76d612008-05-09 05:46:081682Specifies how many context lines should be used in calls to diff
1683made by the linkgit:git-gui[1]. The default is "5".
1684
Junio C Hamano322c6242015-03-23 21:32:461685gui.displayUntracked::
Junio C Hamano198b1f12016-05-17 22:27:241686Determines if linkgit:git-gui[1] shows untracked files
Junio C Hamano796c55f2014-05-02 21:45:151687in the file list. The default is "true".
1688
Junio C Hamanod3452a02008-11-15 08:07:551689gui.encoding::
1690Specifies the default encoding to use for displaying of
1691file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1692It can be overridden by setting the 'encoding' attribute
1693for relevant files (see linkgit:gitattributes[5]).
1694If this option is not set, the tools default to the
1695locale encoding.
1696
Junio C Hamano322c6242015-03-23 21:32:461697gui.matchTrackingBranch::
Junio C Hamano6d76d612008-05-09 05:46:081698Determines if new branches created with linkgit:git-gui[1] should
1699default to tracking remote branches with matching names or
1700not. Default: "false".
1701
Junio C Hamano322c6242015-03-23 21:32:461702gui.newBranchTemplate::
Junio C Hamano6d76d612008-05-09 05:46:081703Is used as suggested name when creating new branches using the
1704linkgit:git-gui[1].
1705
Junio C Hamano322c6242015-03-23 21:32:461706gui.pruneDuringFetch::
Junio C Hamano97bcb482010-11-25 03:16:071707"true" if linkgit:git-gui[1] should prune remote-tracking branches when
Junio C Hamano6d76d612008-05-09 05:46:081708performing a fetch. The default value is "false".
1709
1710gui.trustmtime::
1711Determines if linkgit:git-gui[1] should trust the file modification
1712timestamp or not. By default the timestamps are not trusted.
1713
Junio C Hamano322c6242015-03-23 21:32:461714gui.spellingDictionary::
Junio C Hamano6d76d612008-05-09 05:46:081715Specifies the dictionary used for spell checking commit messages in
1716the linkgit:git-gui[1]. When set to "none" spell checking is turned
1717off.
1718
Junio C Hamano322c6242015-03-23 21:32:461719gui.fastCopyBlame::
Junio C Hamano1aa40d22010-01-21 17:46:431720If true, 'git gui blame' uses `-C` instead of `-C -C` for original
Junio C Hamanod3452a02008-11-15 08:07:551721location detection. It makes blame significantly faster on huge
1722repositories at the expense of less thorough copy detection.
1723
Junio C Hamano322c6242015-03-23 21:32:461724gui.copyBlameThreshold::
Junio C Hamano610d1762008-11-28 06:27:131725Specifies the threshold to use in 'git gui blame' original location
Junio C Hamanod3452a02008-11-15 08:07:551726detection, measured in alphanumeric characters. See the
1727linkgit:git-blame[1] manual for more information on copy detection.
1728
1729gui.blamehistoryctx::
1730Specifies the radius of history context in days to show in
1731linkgit:gitk[1] for the selected commit, when the `Show History
1732Context` menu item is invoked from 'git gui blame'. If this
1733variable is set to zero, the whole history is shown.
1734
Junio C Hamano92d312a2008-12-15 07:22:201735guitool.<name>.cmd::
1736Specifies the shell command line to execute when the corresponding item
1737of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1738mandatory for every tool. The command is executed from the root of
1739the working directory, and in the environment it receives the name of
Junio C Hamano042f2142016-06-27 18:05:051740the tool as `GIT_GUITOOL`, the name of the currently selected file as
Junio C Hamano92d312a2008-12-15 07:22:201741'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1742the head is detached, 'CUR_BRANCH' is empty).
1743
Junio C Hamano322c6242015-03-23 21:32:461744guitool.<name>.needsFile::
Junio C Hamano92d312a2008-12-15 07:22:201745Run the tool only if a diff is selected in the GUI. It guarantees
1746that 'FILENAME' is not empty.
1747
Junio C Hamano322c6242015-03-23 21:32:461748guitool.<name>.noConsole::
Junio C Hamano92d312a2008-12-15 07:22:201749Run the command silently, without creating a window to display its
1750output.
1751
Junio C Hamano322c6242015-03-23 21:32:461752guitool.<name>.noRescan::
Junio C Hamano92d312a2008-12-15 07:22:201753Don't rescan the working directory for changes after the tool
1754finishes execution.
1755
1756guitool.<name>.confirm::
1757Show a confirmation dialog before actually running the tool.
1758
Junio C Hamano322c6242015-03-23 21:32:461759guitool.<name>.argPrompt::
Junio C Hamano92d312a2008-12-15 07:22:201760Request a string argument from the user, and pass it to the tool
Junio C Hamano042f2142016-06-27 18:05:051761through the `ARGS` environment variable. Since requesting an
Junio C Hamano92d312a2008-12-15 07:22:201762argument implies confirmation, the 'confirm' option has no effect
1763if this is enabled. If the option is set to 'true', 'yes', or '1',
1764the dialog uses a built-in generic prompt; otherwise the exact
1765value of the variable is used.
1766
Junio C Hamano322c6242015-03-23 21:32:461767guitool.<name>.revPrompt::
Junio C Hamano92d312a2008-12-15 07:22:201768Request a single valid revision from the user, and set the
Junio C Hamano042f2142016-06-27 18:05:051769`REVISION` environment variable. In other aspects this option
Junio C Hamano322c6242015-03-23 21:32:461770is similar to 'argPrompt', and can be used together with it.
Junio C Hamano92d312a2008-12-15 07:22:201771
Junio C Hamano322c6242015-03-23 21:32:461772guitool.<name>.revUnmerged::
1773Show only unmerged branches in the 'revPrompt' subdialog.
Junio C Hamano92d312a2008-12-15 07:22:201774This is useful for tools similar to merge or rebase, but not
1775for things like checkout or reset.
1776
1777guitool.<name>.title::
1778Specifies the title to use for the prompt dialog. The default
1779is the tool name.
1780
1781guitool.<name>.prompt::
1782Specifies the general prompt string to display at the top of
Junio C Hamano322c6242015-03-23 21:32:461783the dialog, before subsections for 'argPrompt' and 'revPrompt'.
Junio C Hamano92d312a2008-12-15 07:22:201784The default value includes the actual command.
1785
Junio C Hamano4e272312008-01-08 09:13:211786help.browser::
1787Specify the browser that will be used to display help in the
1788'web' format. See linkgit:git-help[1].
1789
1790help.format::
1791Override the default help format used by linkgit:git-help[1].
1792Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1793the default. 'web' and 'html' are the same.
1794
Junio C Hamano322c6242015-03-23 21:32:461795help.autoCorrect::
Junio C Hamanof24b8062008-09-09 01:34:391796Automatically correct and execute mistyped commands after
1797waiting for the given number of deciseconds (0.1 sec). If more
1798than one command can be deduced from the entered text, nothing
1799will be executed. If the value of this option is negative,
1800the corrected command will be executed immediately. If the
1801value is 0 - the command will be just shown but not executed.
1802This is the default.
1803
Junio C Hamano322c6242015-03-23 21:32:461804help.htmlPath::
Junio C Hamano5dd5fae2013-01-18 21:06:491805Specify the path where the HTML documentation resides. File system paths
1806and URLs are supported. HTML pages will be prefixed with this path when
1807help is displayed in the 'web' format. This defaults to the documentation
1808path of your Git installation.
1809
Junio C Hamano58256872007-12-04 08:31:131810http.proxy::
Junio C Hamano3dd93922012-03-05 07:49:111811Override the HTTP proxy, normally configured using the 'http_proxy',
Junio C Hamanoffe10ca2016-02-04 00:44:231812'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1813addition to the syntax understood by curl, it is possible to specify a
1814proxy string with a user name but no password, in which case git will
1815attempt to acquire one in the same way it does for other credentials. See
1816linkgit:gitcredentials[7] for more information. The syntax thus is
1817'[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1818on a per-remote basis; see remote.<name>.proxy
1819
1820http.proxyAuthMethod::
1821Set the method with which to authenticate against the HTTP proxy. This
1822only takes effect if the configured proxy string contains a user name part
1823(i.e. is of the form 'user@host' or 'user@host:port'). This can be
1824overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
Junio C Hamano042f2142016-06-27 18:05:051825Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
Junio C Hamanoffe10ca2016-02-04 00:44:231826variable. Possible values are:
1827+
1828--
1829* `anyauth` - Automatically pick a suitable authentication method. It is
1830 assumed that the proxy answers an unauthenticated request with a 407
1831 status code and one or more Proxy-authenticate headers with supported
1832 authentication methods. This is the default.
1833* `basic` - HTTP Basic authentication
1834* `digest` - HTTP Digest authentication; this prevents the password from being
1835 transmitted to the proxy in clear text
1836* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1837 of `curl(1)`)
1838* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1839--
Junio C Hamano58256872007-12-04 08:31:131840
Junio C Hamano3fcdd072016-02-24 23:41:081841http.emptyAuth::
1842Attempt authentication without seeking a username or password. This
1843can be used to attempt GSS-Negotiate authentication without specifying
1844a username in the URL, as libcurl normally requires a username for
1845authentication.
1846
Junio C Hamano34afdb22016-10-06 22:16:391847http.delegation::
1848Control GSSAPI credential delegation. The delegation is disabled
1849by default in libcurl since version 7.21.7. Set parameter to tell
1850the server what it is allowed to delegate when it comes to user
1851credentials. Used with GSS/kerberos. Possible values are:
1852+
1853--
1854* `none` - Don't allow any delegation.
1855* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
1856 Kerberos service ticket, which is a matter of realm policy.
1857* `always` - Unconditionally allow the server to delegate.
1858--
1859
1860
Junio C Hamanoccdabca2016-05-06 22:27:091861http.extraHeader::
1862Pass an additional HTTP header when communicating with a server. If
1863more than one such entry exists, all of them are added as extra
1864headers. To allow overriding the settings inherited from the system
1865config, an empty value will reset the extra headers to the empty list.
1866
Junio C Hamano322c6242015-03-23 21:32:461867http.cookieFile::
Junio C Hamano198b1f12016-05-17 22:27:241868The pathname of a file containing previously stored cookie lines,
1869which should be used
Junio C Hamano076ffcc2013-02-06 05:13:211870in the Git http session, if they match the server. The file format
Junio C Hamano4c4b0122011-06-30 01:19:321871of the file to read cookies from should be plain HTTP headers or
Junio C Hamano198b1f12016-05-17 22:27:241872the Netscape/Mozilla cookie file format (see `curl(1)`).
1873NOTE that the file specified with http.cookieFile is used only as
Junio C Hamano8eac2682013-09-09 22:35:201874input unless http.saveCookies is set.
1875
Junio C Hamano322c6242015-03-23 21:32:461876http.saveCookies::
Junio C Hamano8eac2682013-09-09 22:35:201877If set, store cookies received during requests to the file specified by
Junio C Hamano322c6242015-03-23 21:32:461878http.cookieFile. Has no effect if http.cookieFile is unset.
Junio C Hamano4c4b0122011-06-30 01:19:321879
Junio C Hamanoa1746be2015-08-26 23:07:071880http.sslVersion::
1881The SSL version to use when negotiating an SSL connection, if you
1882want to force the default. The available and default version
1883depend on whether libcurl was built against NSS or OpenSSL and the
1884particular configuration of the crypto library in use. Internally
1885this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1886documentation for more details on the format of this option and
1887for the ssl version supported. Actually the possible values of
1888this option are:
1889
1890- sslv2
1891- sslv3
1892- tlsv1
1893- tlsv1.0
1894- tlsv1.1
1895- tlsv1.2
1896
1897+
Junio C Hamano042f2142016-06-27 18:05:051898Can be overridden by the `GIT_SSL_VERSION` environment variable.
Junio C Hamanoa1746be2015-08-26 23:07:071899To force git to use libcurl's default ssl version and ignore any
Junio C Hamano042f2142016-06-27 18:05:051900explicit http.sslversion option, set `GIT_SSL_VERSION` to the
Junio C Hamanoa1746be2015-08-26 23:07:071901empty string.
1902
Junio C Hamano1dbca522015-05-22 20:48:551903http.sslCipherList::
1904 A list of SSL ciphers to use when negotiating an SSL connection.
1905 The available ciphers depend on whether libcurl was built against
1906 NSS or OpenSSL and the particular configuration of the crypto
1907 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1908 option; see the libcurl documentation for more details on the format
1909 of this list.
1910+
Junio C Hamano042f2142016-06-27 18:05:051911Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
Junio C Hamano1dbca522015-05-22 20:48:551912To force git to use libcurl's default cipher list and ignore any
Junio C Hamano042f2142016-06-27 18:05:051913explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
Junio C Hamano1dbca522015-05-22 20:48:551914empty string.
1915
Junio C Hamano07824ce2006-04-25 07:36:541916http.sslVerify::
1917Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano042f2142016-06-27 18:05:051918over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment
Junio C Hamano07824ce2006-04-25 07:36:541919variable.
1920
1921http.sslCert::
1922File containing the SSL certificate when fetching or pushing
Junio C Hamano042f2142016-06-27 18:05:051923over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
Junio C Hamano07824ce2006-04-25 07:36:541924variable.
1925
1926http.sslKey::
1927File containing the SSL private key when fetching or pushing
Junio C Hamano042f2142016-06-27 18:05:051928over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
Junio C Hamano07824ce2006-04-25 07:36:541929variable.
1930
Junio C Hamano48bc1ce2009-07-09 16:49:191931http.sslCertPasswordProtected::
Junio C Hamano076ffcc2013-02-06 05:13:211932Enable Git's password prompt for the SSL certificate. Otherwise
Junio C Hamano48bc1ce2009-07-09 16:49:191933OpenSSL will prompt the user, possibly many times, if the
1934certificate or private key is encrypted. Can be overridden by the
Junio C Hamano042f2142016-06-27 18:05:051935`GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
Junio C Hamano48bc1ce2009-07-09 16:49:191936
Junio C Hamano07824ce2006-04-25 07:36:541937http.sslCAInfo::
1938File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:481939fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano042f2142016-06-27 18:05:051940`GIT_SSL_CAINFO` environment variable.
Junio C Hamano07824ce2006-04-25 07:36:541941
1942http.sslCAPath::
1943Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:451944with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano042f2142016-06-27 18:05:051945by the `GIT_SSL_CAPATH` environment variable.
Junio C Hamano07824ce2006-04-25 07:36:541946
Junio C Hamano3fcdd072016-02-24 23:41:081947http.pinnedpubkey::
1948Public key of the https service. It may either be the filename of
1949a PEM or DER encoded public key file or a string starting with
1950'sha256//' followed by the base64 encoded sha256 hash of the
1951public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
1952exit with an error if this option is set but not supported by
1953cURL.
1954
Junio C Hamano76927822013-04-19 21:26:571955http.sslTry::
1956Attempt to use AUTH SSL/TLS and encrypted data transfers
1957when connecting via regular FTP protocol. This might be needed
1958if the FTP server requires it for security reasons or you wish
1959to connect securely whenever remote FTP server supports it.
1960Default is false since it might trigger certificate verification
1961errors on misconfigured servers.
1962
Junio C Hamano07824ce2006-04-25 07:36:541963http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:481964How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano042f2142016-06-27 18:05:051965by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
Junio C Hamano07824ce2006-04-25 07:36:541966
Junio C Hamanob141a922010-01-10 19:55:141967http.minSessions::
1968The number of curl sessions (counted across slots) to be kept across
1969requests. They will not be ended with curl_easy_cleanup() until
1970http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1971value will be capped at 1. Defaults to 1.
1972
Junio C Hamano3b70d3c2009-11-21 17:37:371973http.postBuffer::
1974Maximum size in bytes of the buffer used by smart HTTP
1975transports when POSTing data to the remote system.
1976For requests larger than this buffer size, HTTP/1.1 and
1977Transfer-Encoding: chunked is used to avoid creating a
1978massive pack file locally. Default is 1 MiB, which is
1979sufficient for most requests.
1980
Junio C Hamano07824ce2006-04-25 07:36:541981http.lowSpeedLimit, http.lowSpeedTime::
1982If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1983for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano042f2142016-06-27 18:05:051984Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
1985`GIT_HTTP_LOW_SPEED_TIME` environment variables.
Junio C Hamano07824ce2006-04-25 07:36:541986
Junio C Hamanof1dcdfe2006-09-29 08:10:511987http.noEPSV::
1988A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:041989This can helpful with some "poor" ftp servers which don't
Junio C Hamano042f2142016-06-27 18:05:051990support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
Junio C Hamanof1dcdfe2006-09-29 08:10:511991environment variable. Default is false (curl will use EPSV).
1992
Junio C Hamano322c6242015-03-23 21:32:461993http.userAgent::
Junio C Hamano53ba6d02010-08-22 07:25:121994The HTTP USER_AGENT string presented to an HTTP server. The default
Junio C Hamano076ffcc2013-02-06 05:13:211995value represents the version of the client Git such as git/1.7.1.
Junio C Hamano53ba6d02010-08-22 07:25:121996This option allows you to override this value to a more common value
1997such as Mozilla/4.0. This may be necessary, for instance, if
1998connecting through a firewall that restricts HTTP connections to a set
1999of common USER_AGENT strings (but not including those like git/1.7.1).
Junio C Hamano042f2142016-06-27 18:05:052000Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
Junio C Hamano53ba6d02010-08-22 07:25:122001
Junio C Hamano52b1cfb2016-12-20 00:18:362002http.followRedirects::
2003Whether git should follow HTTP redirects. If set to `true`, git
2004will transparently follow any redirect issued by a server it
2005encounters. If set to `false`, git will treat all redirects as
2006errors. If set to `initial`, git will follow redirects only for
2007the initial request to a remote, but not for subsequent
2008follow-up HTTP requests. Since git uses the redirected URL as
2009the base for the follow-up requests, this is generally
2010sufficient. The default is `initial`.
2011
Junio C Hamano8eac2682013-09-09 22:35:202012http.<url>.*::
Junio C Hamanofb5ffde2014-11-04 22:38:562013Any of the http.* options above can be applied selectively to some URLs.
Junio C Hamano8eac2682013-09-09 22:35:202014For a config key to match a URL, each element of the config key is
2015compared to that of the URL, in the following order:
2016+
2017--
2018. Scheme (e.g., `https` in `https://example.com/`). This field
2019 must match exactly between the config key and the URL.
2020
2021. Host/domain name (e.g., `example.com` in `https://example.com/`).
Junio C Hamanocbe0eb22017-02-27 23:37:492022 This field must match between the config key and the URL. It is
2023 possible to specify a `*` as part of the host name to match all subdomains
2024 at this level. `https://*.example.com/` for example would match
2025 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
Junio C Hamano8eac2682013-09-09 22:35:202026
2027. Port number (e.g., `8080` in `http://example.com:8080/`).
2028 This field must match exactly between the config key and the URL.
2029 Omitted port numbers are automatically converted to the correct
2030 default for the scheme before matching.
2031
2032. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2033 path field of the config key must match the path field of the URL
2034 either exactly or as a prefix of slash-delimited path elements. This means
2035 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2036 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2037 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2038 key with just path `foo/`).
2039
2040. User name (e.g., `user` in `https://user@example.com/repo.git`). If
2041 the config key has a user name it must match the user name in the
2042 URL exactly. If the config key does not have a user name, that
2043 config key will match a URL with any user name (including none),
2044 but at a lower precedence than a config key with a user name.
2045--
2046+
2047The list above is ordered by decreasing precedence; a URL that matches
2048a config key's path is preferred to one that matches its user name. For example,
2049if the URL is `https://user@example.com/foo/bar` a config key match of
2050`https://example.com/foo` will be preferred over a config key match of
2051`https://user@example.com`.
2052+
2053All URLs are normalized before attempting any matching (the password part,
2054if embedded in the URL, is always ignored for matching purposes) so that
Junio C Hamanofb5ffde2014-11-04 22:38:562055equivalent URLs that are simply spelled differently will match properly.
2056Environment variable settings always override any matches. The URLs that are
Junio C Hamano8eac2682013-09-09 22:35:202057matched against are those given directly to Git commands. This means any URLs
2058visited as a result of a redirection do not participate in matching.
2059
Junio C Hamanocbe0eb22017-02-27 23:37:492060ssh.variant::
2061Depending on the value of the environment variables `GIT_SSH` or
2062`GIT_SSH_COMMAND`, or the config setting `core.sshCommand`, Git
2063auto-detects whether to adjust its command-line parameters for use
2064with plink or tortoiseplink, as opposed to the default (OpenSSH).
2065+
2066The config variable `ssh.variant` can be set to override this auto-detection;
2067valid values are `ssh`, `plink`, `putty` or `tortoiseplink`. Any other value
2068will be treated as normal ssh. This setting can be overridden via the
2069environment variable `GIT_SSH_VARIANT`.
2070
Junio C Hamano07824ce2006-04-25 07:36:542071i18n.commitEncoding::
Junio C Hamano076ffcc2013-02-06 05:13:212072Character encoding the commit messages are stored in; Git itself
Junio C Hamano07824ce2006-04-25 07:36:542073does not care per se, but this information is necessary e.g. when
2074importing commits from emails or in the gitk graphical history
2075browser (and possibly at other places in the future or in other
Junio C Hamano35738e82008-01-07 07:55:462076porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Junio C Hamano07824ce2006-04-25 07:36:542077
Junio C Hamano51f92e22006-12-29 05:18:282078i18n.logOutputEncoding::
2079Character encoding the commit messages are converted to when
Junio C Hamano1aa40d22010-01-21 17:46:432080running 'git log' and friends.
Junio C Hamano51f92e22006-12-29 05:18:282081
Junio C Hamano4653c6f2008-11-26 22:50:202082imap::
2083The configuration variables in the 'imap' section are described
2084in linkgit:git-imap-send[1].
2085
Junio C Hamano81703b22014-03-14 22:00:272086index.version::
2087Specify the version with which new index files should be
2088initialized. This does not affect existing repositories.
2089
Junio C Hamano322c6242015-03-23 21:32:462090init.templateDir::
Junio C Hamanocaa712a2010-03-11 01:17:352091Specify the directory from which templates will be copied.
2092(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2093
Junio C Hamano4e272312008-01-08 09:13:212094instaweb.browser::
2095Specify the program that will be used to browse your working
2096repository in gitweb. See linkgit:git-instaweb[1].
2097
2098instaweb.httpd::
2099The HTTP daemon command-line to start gitweb on your working
2100repository. See linkgit:git-instaweb[1].
2101
2102instaweb.local::
2103If true the web server started by linkgit:git-instaweb[1] will
2104be bound to the local IP (127.0.0.1).
2105
Junio C Hamano322c6242015-03-23 21:32:462106instaweb.modulePath::
Junio C Hamano619596a2010-08-18 22:15:352107The default module path for linkgit:git-instaweb[1] to use
2108instead of /usr/lib/apache2/modules. Only used if httpd
2109is Apache.
Junio C Hamano4e272312008-01-08 09:13:212110
2111instaweb.port::
2112The port number to bind the gitweb httpd to. See
2113linkgit:git-instaweb[1].
2114
Junio C Hamano322c6242015-03-23 21:32:462115interactive.singleKey::
Junio C Hamano27a128b2009-08-13 01:23:002116In interactive commands, allow the user to provide one-letter
Junio C Hamanoe5bf6c12009-02-07 21:43:102117input with a single key (i.e., without hitting enter).
Junio C Hamanob76a6862012-05-02 22:02:462118Currently this is used by the `--patch` mode of
Junio C Hamano3d050d62011-05-17 06:43:342119linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2120linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2121setting is silently ignored if portable keystroke input
Junio C Hamano81703b22014-03-14 22:00:272122is not available; requires the Perl module Term::ReadKey.
Junio C Hamanoe5bf6c12009-02-07 21:43:102123
Junio C Hamano4ba4a782016-04-03 19:11:322124interactive.diffFilter::
2125When an interactive command (such as `git add --patch`) shows
2126a colorized diff, git will pipe the diff through the shell
2127command defined by this configuration variable. The command may
2128mark up the diff further for human consumption, provided that it
2129retains a one-to-one correspondence with the lines in the
2130original diff. Defaults to disabled (no filtering).
2131
Junio C Hamanof93530e2011-05-25 23:59:592132log.abbrevCommit::
2133If true, makes linkgit:git-log[1], linkgit:git-show[1], and
Junio C Hamanob76a6862012-05-02 22:02:462134linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2135override this option with `--no-abbrev-commit`.
Junio C Hamanof93530e2011-05-25 23:59:592136
Junio C Hamanob713ff12008-05-24 01:12:302137log.date::
Junio C Hamano2db3e752010-09-03 21:33:062138Set the default date-time mode for the 'log' command.
2139Setting a value for log.date is similar to using 'git log''s
Junio C Hamano1eb56092015-10-05 20:39:532140`--date` option. See linkgit:git-log[1] for details.
Junio C Hamanob713ff12008-05-24 01:12:302141
Junio C Hamanocb39aea2010-05-09 07:24:482142log.decorate::
2143Print out the ref names of any commits that are shown by the log
2144command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2145'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2146specified, the full ref name (including prefix) will be printed.
Junio C Hamano37cf4082016-05-30 01:22:142147If 'auto' is specified, then if the output is going to a terminal,
2148the ref names are shown as if 'short' were given, otherwise no ref
Junio C Hamano92d80372016-07-13 22:00:052149names are shown. This is the same as the `--decorate` option
Junio C Hamano37cf4082016-05-30 01:22:142150of the `git log`.
Junio C Hamanocb39aea2010-05-09 07:24:482151
Junio C Hamanob0a1e832015-10-15 23:08:312152log.follow::
2153If `true`, `git log` will act as if the `--follow` option was used when
2154a single <path> is given. This has the same limitations as `--follow`,
2155i.e. it cannot be used to follow multiple files and does not work well
2156on non-linear history.
2157
Junio C Hamanob86c8032017-02-02 21:50:192158log.graphColors::
2159A list of colors, separated by commas, that can be used to draw
2160history lines in `git log --graph`.
2161
Junio C Hamano322c6242015-03-23 21:32:462162log.showRoot::
Junio C Hamanofe9acab2006-11-24 12:10:552163If true, the initial commit will be shown as a big creation event.
2164This is equivalent to a diff against an empty tree.
Junio C Hamano35738e82008-01-07 07:55:462165Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Junio C Hamanofe9acab2006-11-24 12:10:552166normally hide the root commit will now show it. True by default.
2167
Junio C Hamano6b6144f2017-05-29 06:20:152168log.showSignature::
2169If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2170linkgit:git-whatchanged[1] assume `--show-signature`.
2171
Junio C Hamanoce836cc2013-01-21 02:01:532172log.mailmap::
2173If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2174linkgit:git-whatchanged[1] assume `--use-mailmap`.
2175
Junio C Hamano7f1bc9d2015-03-05 22:38:262176mailinfo.scissors::
2177If true, makes linkgit:git-mailinfo[1] (and therefore
2178linkgit:git-am[1]) act by default as if the --scissors option
2179was provided on the command-line. When active, this features
2180removes everything from the message body before a scissors
2181line (i.e. consisting mainly of ">8", "8<" and "-").
2182
Junio C Hamano8bc410e2009-02-15 10:38:192183mailmap.file::
2184The location of an augmenting mailmap file. The default
2185mailmap, located in the root of the repository, is loaded
2186first, then the mailmap file pointed to by this variable.
2187The location of the mailmap file may be in a repository
2188subdirectory, or somewhere outside of the repository itself.
2189See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2190
Junio C Hamanoabad6da2013-01-06 09:06:322191mailmap.blob::
2192Like `mailmap.file`, but consider the value as a reference to a
2193blob in the repository. If both `mailmap.file` and
2194`mailmap.blob` are given, both are parsed, with entries from
2195`mailmap.file` taking precedence. In a bare repository, this
2196defaults to `HEAD:.mailmap`. In a non-bare repository, it
2197defaults to empty.
2198
Junio C Hamano8b588d52008-03-15 09:48:372199man.viewer::
2200Specify the programs that may be used to display help in the
2201'man' format. See linkgit:git-help[1].
2202
Junio C Hamano6d76d612008-05-09 05:46:082203man.<tool>.cmd::
2204Specify the command to invoke the specified man viewer. The
2205specified command is evaluated in shell with the man page
2206passed as argument. (See linkgit:git-help[1].)
Junio C Hamano103ad7f2007-03-14 11:19:262207
Junio C Hamano6d76d612008-05-09 05:46:082208man.<tool>.path::
2209Override the path for the given tool that may be used to
2210display help in the 'man' format. See linkgit:git-help[1].
Junio C Hamanoe90436a2007-04-22 07:22:132211
Junio C Hamano4653c6f2008-11-26 22:50:202212include::merge-config.txt[]
Junio C Hamanoa476efa2008-10-10 15:31:422213
Junio C Hamano1fbbbc12007-12-18 07:01:272214mergetool.<tool>.path::
2215Override the path for the given tool. This is useful in case
2216your tool is not in the PATH.
2217
Junio C Hamano86bcccc2008-03-08 09:33:552218mergetool.<tool>.cmd::
2219Specify the command to invoke the specified merge tool. The
2220specified command is evaluated in shell with the following
2221variables available: 'BASE' is the name of a temporary file
2222containing the common base of the files to be merged, if available;
2223'LOCAL' is the name of a temporary file containing the contents of
2224the file on the current branch; 'REMOTE' is the name of a temporary
2225file containing the contents of the file from the branch being
2226merged; 'MERGED' contains the name of the file to which the merge
2227tool should write the results of a successful merge.
2228
2229mergetool.<tool>.trustExitCode::
2230For a custom merge command, specify whether the exit code of
2231the merge command can be used to determine whether the merge was
2232successful. If this is not set to true then the merge target file
2233timestamp is checked and the merge assumed to have been successful
2234if the file has been updated, otherwise the user is prompted to
2235indicate the success of the merge.
2236
Junio C Hamanoe478e402014-10-21 22:14:452237mergetool.meld.hasOutput::
2238Older versions of `meld` do not support the `--output` option.
2239Git will attempt to detect whether `meld` supports `--output`
2240by inspecting the output of `meld --help`. Configuring
2241`mergetool.meld.hasOutput` will make Git skip these checks and
2242use the configured value instead. Setting `mergetool.meld.hasOutput`
2243to `true` tells Git to unconditionally use the `--output` option,
2244and `false` avoids using `--output`.
2245
Junio C Hamano86bcccc2008-03-08 09:33:552246mergetool.keepBackup::
2247After performing a merge, the original file with conflict markers
2248can be saved as a file with a `.orig` extension. If this variable
2249is set to `false` then this file is not preserved. Defaults to
2250`true` (i.e. keep the backup files).
2251
Junio C Hamano10b7a342009-01-01 22:05:172252mergetool.keepTemporaries::
Junio C Hamano076ffcc2013-02-06 05:13:212253When invoking a custom merge tool, Git uses a set of temporary
Junio C Hamano10b7a342009-01-01 22:05:172254files to pass to the tool. If the tool returns an error and this
2255variable is set to `true`, then these temporary files will be
2256preserved, otherwise they will be removed after the tool has
2257exited. Defaults to `false`.
2258
Junio C Hamanoe478e402014-10-21 22:14:452259mergetool.writeToTemp::
2260Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2261conflicting files in the worktree by default. Git will attempt
2262to use a temporary directory for these files when set `true`.
2263Defaults to `false`.
2264
Junio C Hamano10b7a342009-01-01 22:05:172265mergetool.prompt::
2266Prompt before each invocation of the merge resolution program.
2267
Junio C Hamano3891e252015-08-31 23:06:132268notes.mergeStrategy::
2269Which merge strategy to choose by default when resolving notes
2270conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2271`cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2272section of linkgit:git-notes[1] for more information on each strategy.
2273
2274notes.<name>.mergeStrategy::
2275Which merge strategy to choose when doing a notes merge into
2276refs/notes/<name>. This overrides the more general
2277"notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2278linkgit:git-notes[1] for more information on the available strategies.
2279
Junio C Hamano31667362010-03-25 00:38:532280notes.displayRef::
2281The (fully qualified) refname from which to show notes when
2282showing commit messages. The value of this variable can be set
2283to a glob, in which case notes from all matching refs will be
2284shown. You may also specify this configuration variable
2285several times. A warning will be issued for refs that do not
2286exist, but a glob that does not match any refs is silently
2287ignored.
2288+
2289This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2290environment variable, which must be a colon separated list of refs or
2291globs.
2292+
2293The effective value of "core.notesRef" (possibly overridden by
2294GIT_NOTES_REF) is also implicitly added to the list of refs to be
2295displayed.
2296
2297notes.rewrite.<command>::
2298When rewriting commits with <command> (currently `amend` or
Junio C Hamano076ffcc2013-02-06 05:13:212299`rebase`) and this variable is set to `true`, Git
Junio C Hamano31667362010-03-25 00:38:532300automatically copies your notes from the original to the
2301rewritten commit. Defaults to `true`, but see
2302"notes.rewriteRef" below.
Junio C Hamano31667362010-03-25 00:38:532303
2304notes.rewriteMode::
2305When copying notes during a rewrite (see the
2306"notes.rewrite.<command>" option), determines what to do if
2307the target commit already has a note. Must be one of
Junio C Hamano3891e252015-08-31 23:06:132308`overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2309Defaults to `concatenate`.
Junio C Hamano31667362010-03-25 00:38:532310+
2311This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2312environment variable.
2313
2314notes.rewriteRef::
2315When copying notes during a rewrite, specifies the (fully
2316qualified) ref whose notes should be copied. The ref may be a
2317glob, in which case notes in all matching refs will be copied.
2318You may also specify this configuration several times.
2319+
2320Does not have a default value; you must configure this variable to
Junio C Hamano8fb66e52011-10-05 20:59:512321enable note rewriting. Set it to `refs/notes/commits` to enable
2322rewriting for the default commit notes.
Junio C Hamano2b3ee5d2010-05-08 05:41:182323+
2324This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2325environment variable, which must be a colon separated list of refs or
2326globs.
Junio C Hamano31667362010-03-25 00:38:532327
Junio C Hamano75cc4c92006-07-24 08:25:032328pack.window::
Junio C Hamano35738e82008-01-07 07:55:462329The size of the window used by linkgit:git-pack-objects[1] when no
Junio C Hamano75cc4c92006-07-24 08:25:032330window size is given on the command line. Defaults to 10.
2331
Junio C Hamano91d44c52007-05-09 07:16:072332pack.depth::
Junio C Hamano35738e82008-01-07 07:55:462333The maximum delta depth used by linkgit:git-pack-objects[1] when no
Junio C Hamano91d44c52007-05-09 07:16:072334maximum depth is given on the command line. Defaults to 50.
2335
Junio C Hamano235d53f2007-07-13 00:25:152336pack.windowMemory::
Junio C Hamano2a4bcbc2014-10-29 20:07:392337The maximum size of memory that is consumed by each thread
2338in linkgit:git-pack-objects[1] for pack window memory when
2339no limit is given on the command line. The value can be
2340suffixed with "k", "m", or "g". When left unconfigured (or
2341set explicitly to 0), there will be no limit.
Junio C Hamano235d53f2007-07-13 00:25:152342
Junio C Hamanof2ce2972007-05-20 19:12:092343pack.compression::
2344An integer -1..9, indicating the compression level for objects
2345in a pack file. -1 is the zlib default. 0 means no
2346compression, and 1..9 are various speed/size tradeoffs, 9 being
2347slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:422348not set, defaults to -1, the zlib default, which is "a default
2349compromise between speed and compression (currently equivalent
2350to level 6)."
Junio C Hamano657fd8a2010-10-07 00:01:242351+
2352Note that changing the compression level will not automatically recompress
2353all existing objects. You can force recompression by passing the -F option
2354to linkgit:git-repack[1].
Junio C Hamanof2ce2972007-05-20 19:12:092355
Junio C Hamano679d22d2007-06-02 21:13:442356pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:272357The maximum memory in bytes used for caching deltas in
Junio C Hamano9f883862009-08-11 06:23:522358linkgit:git-pack-objects[1] before writing them out to a pack.
2359This cache is used to speed up the writing object phase by not
2360having to recompute the final delta result once the best match
2361for all objects is found. Repacking large repositories on machines
2362which are tight with memory might be badly impacted by this though,
2363especially if this cache pushes the system into swapping.
2364A value of 0 means no limit. The smallest size of 1 byte may be
2365used to virtually disable this cache. Defaults to 256 MiB.
Junio C Hamano679d22d2007-06-02 21:13:442366
2367pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:142368The maximum size of a delta, that is cached in
Junio C Hamano9f883862009-08-11 06:23:522369linkgit:git-pack-objects[1]. This cache is used to speed up the
2370writing object phase by not having to recompute the final delta
2371result once the best match for all objects is found. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:442372
Junio C Hamano58155b42007-09-15 07:46:142373pack.threads::
2374Specifies the number of threads to spawn when searching for best
Junio C Hamano35738e82008-01-07 07:55:462375delta matches. This requires that linkgit:git-pack-objects[1]
Junio C Hamano58155b42007-09-15 07:46:142376be compiled with pthreads otherwise this option is ignored with a
2377warning. This is meant to reduce packing time on multiprocessor
2378machines. The required amount of memory for the delta search window
2379is however multiplied by the number of threads.
Junio C Hamano076ffcc2013-02-06 05:13:212380Specifying 0 will cause Git to auto-detect the number of CPU's
Junio C Hamano24bc09a2008-02-28 00:27:442381and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:142382
Junio C Hamanod814b6d2007-11-04 11:13:492383pack.indexVersion::
2384Specify the default pack index version. Valid values are 1 for
2385legacy pack index used by Git versions prior to 1.5.2, and 2 for
2386the new pack index with capabilities for packs larger than 4 GB
2387as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:382388packs. Version 2 is the default. Note that version 2 is enforced
2389and this config option ignored whenever the corresponding pack is
2390larger than 2 GB.
2391+
Junio C Hamano076ffcc2013-02-06 05:13:212392If you have an old Git that does not understand the version 2 `*.idx` file,
Junio C Hamanof85ef632016-02-17 22:31:062393cloning or fetching over a non native protocol (e.g. "http")
Junio C Hamanob76a6862012-05-02 22:02:462394that will copy both `*.pack` file and corresponding `*.idx` file from the
Junio C Hamanofce7c7e2008-07-02 03:06:382395other side may give you a repository that cannot be accessed with your
Junio C Hamano076ffcc2013-02-06 05:13:212396older version of Git. If the `*.pack` file is smaller than 2 GB, however,
Junio C Hamanofce7c7e2008-07-02 03:06:382397you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
Junio C Hamanob76a6862012-05-02 22:02:462398the `*.idx` file.
Junio C Hamanod814b6d2007-11-04 11:13:492399
Junio C Hamano09a926d2008-03-13 07:55:292400pack.packSizeLimit::
Junio C Hamano4d979582010-02-04 06:27:292401The maximum size of a pack. This setting only affects
2402packing to a file when repacking, i.e. the git:// protocol
Junio C Hamanob76a6862012-05-02 22:02:462403is unaffected. It can be overridden by the `--max-pack-size`
Junio C Hamano74fd0fc2016-05-10 21:23:562404option of linkgit:git-repack[1]. Reaching this limit results
2405in the creation of multiple packfiles; which in turn prevents
2406bitmaps from being created.
2407The minimum size allowed is limited to 1 MiB.
2408The default is unlimited.
Junio C Hamano4d979582010-02-04 06:27:292409Common unit suffixes of 'k', 'm', or 'g' are
2410supported.
Junio C Hamano49dccaf2008-02-10 10:48:012411
Junio C Hamano5b3533d2014-02-27 23:07:152412pack.useBitmaps::
2413When true, git will use pack bitmaps (if available) when packing
2414to stdout (e.g., during the server side of a fetch). Defaults to
2415true. You should not generally need to turn this off unless
2416you are debugging pack bitmaps.
2417
Junio C Hamano322c6242015-03-23 21:32:462418pack.writeBitmaps (deprecated)::
Junio C Hamano38d02532014-06-26 21:48:502419This is a deprecated synonym for `repack.writeBitmaps`.
Junio C Hamano5b3533d2014-02-27 23:07:152420
2421pack.writeBitmapHashCache::
2422When true, git will include a "hash cache" section in the bitmap
2423index (if one is written). This cache can be used to feed git's
2424delta heuristics, potentially leading to better deltas between
2425bitmapped and non-bitmapped objects (e.g., when serving a fetch
2426between an older, bitmapped pack and objects that have been
2427pushed since the last gc). The downside is that it consumes 4
2428bytes per object of disk space, and that JGit's bitmap
2429implementation does not understand it, causing it to complain if
2430Git and JGit are used on the same repository. Defaults to false.
2431
Junio C Hamano9e96a1a2008-08-16 10:23:182432pager.<cmd>::
Junio C Hamano788eeba2010-12-08 22:50:432433If the value is boolean, turns on or off pagination of the
Junio C Hamano076ffcc2013-02-06 05:13:212434output of a particular Git subcommand when writing to a tty.
Junio C Hamano788eeba2010-12-08 22:50:432435Otherwise, turns on pagination for the subcommand using the
Junio C Hamanob76a6862012-05-02 22:02:462436pager specified by the value of `pager.<cmd>`. If `--paginate`
2437or `--no-pager` is specified on the command line, it takes
Junio C Hamano788eeba2010-12-08 22:50:432438precedence over this option. To disable pagination for all
2439commands, set `core.pager` or `GIT_PAGER` to `cat`.
Junio C Hamano9e96a1a2008-08-16 10:23:182440
Junio C Hamanoa574a092010-06-13 19:57:102441pretty.<name>::
2442Alias for a --pretty= format string, as specified in
2443linkgit:git-log[1]. Any aliases defined here can be used just
2444as the built-in pretty formats could. For example,
Junio C Hamanob76a6862012-05-02 22:02:462445running `git config pretty.changelog "format:* %H %s"`
Junio C Hamanoa574a092010-06-13 19:57:102446would cause the invocation `git log --pretty=changelog`
Junio C Hamanob76a6862012-05-02 22:02:462447to be equivalent to running `git log "--pretty=format:* %H %s"`.
Junio C Hamanoa574a092010-06-13 19:57:102448Note that an alias with the same name as a built-in format
2449will be silently ignored.
2450
Junio C Hamano9e35abf2016-12-27 22:37:272451protocol.allow::
2452If set, provide a user defined default policy for all protocols which
2453don't explicitly have a policy (`protocol.<name>.allow`). By default,
2454if unset, known-safe protocols (http, https, git, ssh, file) have a
2455default policy of `always`, known-dangerous protocols (ext) have a
2456default policy of `never`, and all other protocols have a default
2457policy of `user`. Supported policies:
2458+
2459--
2460
2461* `always` - protocol is always able to be used.
2462
2463* `never` - protocol is never able to be used.
2464
2465* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2466 either unset or has a value of 1. This policy should be used when you want a
2467 protocol to be directly usable by the user but don't want it used by commands which
2468 execute clone/fetch/push commands without user input, e.g. recursive
2469 submodule initialization.
2470
2471--
2472
2473protocol.<name>.allow::
2474Set a policy to be used by protocol `<name>` with clone/fetch/push
2475commands. See `protocol.allow` above for the available policies.
2476+
2477The protocol names currently used by git are:
2478+
2479--
2480 - `file`: any local file-based path (including `file://` URLs,
2481 or local paths)
2482
2483 - `git`: the anonymous git protocol over a direct TCP
2484 connection (or proxy, if configured)
2485
2486 - `ssh`: git over ssh (including `host:path` syntax,
2487 `ssh://`, etc).
2488
2489 - `http`: git over http, both "smart http" and "dumb http".
2490 Note that this does _not_ include `https`; if you want to configure
2491 both, you must do so individually.
2492
2493 - any external helpers are named by their protocol (e.g., use
2494 `hg` to allow the `git-remote-hg` helper)
2495--
2496
Junio C Hamano5b3533d2014-02-27 23:07:152497pull.ff::
2498By default, Git does not create an extra merge commit when merging
2499a commit that is a descendant of the current commit. Instead, the
2500tip of the current branch is fast-forwarded. When set to `false`,
2501this variable tells Git to create an extra merge commit in such
2502a case (equivalent to giving the `--no-ff` option from the command
2503line). When set to `only`, only such fast-forward merges are
2504allowed (equivalent to giving the `--ff-only` option from the
Junio C Hamanoc4e2a202015-05-26 21:38:472505command line). This setting overrides `merge.ff` when pulling.
Junio C Hamano5b3533d2014-02-27 23:07:152506
Junio C Hamano515ab1d2011-12-09 23:41:202507pull.rebase::
2508When true, rebase branches on top of the fetched branch, instead
2509of merging the default branch from the default remote when "git
2510pull" is run. See "branch.<name>.rebase" for setting this on a
2511per-branch basis.
2512+
Junio C Hamano7db630e2015-09-17 20:26:222513When preserve, also pass `--preserve-merges` along to 'git rebase'
2514so that locally committed merge commits will not be flattened
2515by running 'git pull'.
Junio C Hamanocf4a1742013-09-11 22:57:502516+
Junio C Hamano289d7e82016-01-27 00:20:382517When the value is `interactive`, the rebase is run in interactive mode.
2518+
Junio C Hamano515ab1d2011-12-09 23:41:202519*NOTE*: this is a possibly dangerous operation; do *not* use
2520it unless you understand the implications (see linkgit:git-rebase[1]
2521for details).
2522
Junio C Hamano07824ce2006-04-25 07:36:542523pull.octopus::
2524The default merge strategy to use when pulling multiple branches
2525at once.
2526
2527pull.twohead::
2528The default merge strategy to use when pulling a single branch.
2529
Junio C Hamano1de75722009-03-26 08:39:382530push.default::
Junio C Hamano58655592013-07-11 20:52:332531Defines the action `git push` should take if no refspec is
2532explicitly given. Different values are well-suited for
2533specific workflows; for instance, in a purely central workflow
2534(i.e. the fetch source is equal to the push destination),
2535`upstream` is probably what you want. Possible values are:
Junio C Hamano1de75722009-03-26 08:39:382536+
Junio C Hamanobcaa8bc2012-07-03 22:17:202537--
Junio C Hamano58655592013-07-11 20:52:332538
2539* `nothing` - do not push anything (error out) unless a refspec is
2540 explicitly given. This is primarily meant for people who want to
2541 avoid mistakes by always being explicit.
2542
2543* `current` - push the current branch to update a branch with the same
2544 name on the receiving end. Works in both central and non-central
2545 workflows.
2546
2547* `upstream` - push the current branch back to the branch whose
2548 changes are usually integrated into the current branch (which is
2549 called `@{upstream}`). This mode only makes sense if you are
2550 pushing to the same repository you would normally pull from
2551 (i.e. central workflow).
2552
Junio C Hamanocb06ef92017-03-21 22:40:142553* `tracking` - This is a deprecated synonym for `upstream`.
2554
Junio C Hamano58655592013-07-11 20:52:332555* `simple` - in centralized workflow, work like `upstream` with an
2556 added safety to refuse to push if the upstream branch's name is
2557 different from the local one.
Junio C Hamanobcaa8bc2012-07-03 22:17:202558+
Junio C Hamano58655592013-07-11 20:52:332559When pushing to a remote that is different from the remote you normally
2560pull from, work as `current`. This is the safest option and is suited
2561for beginners.
2562+
Junio C Hamano1d669b82014-03-11 21:36:002563This mode has become the default in Git 2.0.
Junio C Hamano58655592013-07-11 20:52:332564
2565* `matching` - push all branches having the same name on both ends.
2566 This makes the repository you are pushing to remember the set of
2567 branches that will be pushed out (e.g. if you always push 'maint'
2568 and 'master' there and no other branches, the repository you push
2569 to will have these two branches, and your local 'maint' and
2570 'master' will be pushed there).
2571+
2572To use this mode effectively, you have to make sure _all_ the
2573branches you would push out are ready to be pushed out before
2574running 'git push', as the whole point of this mode is to allow you
2575to push all of the branches in one go. If you usually finish work
2576on only one branch and push out the result, while other branches are
2577unfinished, this mode is not for you. Also this mode is not
2578suitable for pushing into a shared central repository, as other
2579people may add new branches there, or update the tip of existing
2580branches outside your control.
2581+
Junio C Hamano1d669b82014-03-11 21:36:002582This used to be the default, but not since Git 2.0 (`simple` is the
2583new default).
Junio C Hamano58655592013-07-11 20:52:332584
2585--
Junio C Hamano1de75722009-03-26 08:39:382586
Junio C Hamano322c6242015-03-23 21:32:462587push.followTags::
Junio C Hamano92d80372016-07-13 22:00:052588If set to true enable `--follow-tags` option by default. You
Junio C Hamano322c6242015-03-23 21:32:462589may override this configuration at time of push by specifying
Junio C Hamano92d80372016-07-13 22:00:052590`--no-follow-tags`.
Junio C Hamano322c6242015-03-23 21:32:462591
Junio C Hamano3891e252015-08-31 23:06:132592push.gpgSign::
2593May be set to a boolean value, or the string 'if-asked'. A true
Junio C Hamano92d80372016-07-13 22:00:052594value causes all pushes to be GPG signed, as if `--signed` is
Junio C Hamano3891e252015-08-31 23:06:132595passed to linkgit:git-push[1]. The string 'if-asked' causes
2596pushes to be signed if the server supports it, as if
Junio C Hamano92d80372016-07-13 22:00:052597`--signed=if-asked` is passed to 'git push'. A false value may
Junio C Hamano3891e252015-08-31 23:06:132598override a value from a lower-priority config file. An explicit
2599command-line flag always overrides this config option.
Junio C Hamano322c6242015-03-23 21:32:462600
Junio C Hamano409a33a2015-12-22 23:45:232601push.recurseSubmodules::
2602Make sure all submodule commits used by the revisions to be pushed
2603are available on a remote-tracking branch. If the value is 'check'
2604then Git will verify that all submodule commits that changed in the
2605revisions to be pushed are available on at least one remote of the
2606submodule. If any commits are missing, the push will be aborted and
2607exit with non-zero status. If the value is 'on-demand' then all
2608submodules that changed in the revisions to be pushed will be
2609pushed. If on-demand was not able to push all necessary revisions
2610it will also be aborted and exit with non-zero status. If the value
2611is 'no' then default behavior of ignoring submodules when pushing
2612is retained. You may override this configuration at time of push by
2613specifying '--recurse-submodules=check|on-demand|no'.
2614
Junio C Hamanoea6a7642009-03-11 23:56:192615rebase.stat::
2616Whether to show a diffstat of what changed upstream since the last
2617rebase. False by default.
2618
Junio C Hamano322c6242015-03-23 21:32:462619rebase.autoSquash::
Junio C Hamano92d80372016-07-13 22:00:052620If set to true enable `--autosquash` option by default.
Junio C Hamano075ae872010-09-01 18:43:072621
Junio C Hamano322c6242015-03-23 21:32:462622rebase.autoStash::
Junio C Hamanof1f5a7b2013-06-11 22:23:522623When set to true, automatically create a temporary stash
2624before the operation begins, and apply it after the operation
2625ends. This means that you can run rebase on a dirty worktree.
2626However, use with care: the final stash application after a
2627successful rebase might result in non-trivial conflicts.
2628Defaults to false.
2629
Junio C Hamanod7ed4042015-08-03 19:43:002630rebase.missingCommitsCheck::
2631If set to "warn", git rebase -i will print a warning if some
2632commits are removed (e.g. a line was deleted), however the
2633rebase will still proceed. If set to "error", it will print
2634the previous warning and stop the rebase, 'git rebase
2635--edit-todo' can then be used to correct the error. If set to
2636"ignore", no checking is done.
2637To drop a commit without warning or error, use the `drop`
2638command in the todo-list.
2639Defaults to "ignore".
2640
Junio C Hamanof2f28b12016-10-31 21:41:582641rebase.instructionFormat::
Junio C Hamanod7ed4042015-08-03 19:43:002642A format string, as specified in linkgit:git-log[1], to be used for
2643the instruction list during an interactive rebase. The format will automatically
2644have the long commit hash prepended to the format.
2645
Junio C Hamano322c6242015-03-23 21:32:462646receive.advertiseAtomic::
Junio C Hamano6bb32e62015-02-17 22:11:262647By default, git-receive-pack will advertise the atomic push
Junio C Hamanoe48a1132016-08-03 22:40:212648capability to its clients. If you don't want to advertise this
2649capability, set this variable to false.
2650
2651receive.advertisePushOptions::
Junio C Hamanod3ab1ad2017-05-23 06:52:182652When set to true, git-receive-pack will advertise the push options
2653capability to its clients. False by default.
Junio C Hamano6bb32e62015-02-17 22:11:262654
Junio C Hamano621e1232009-10-26 05:16:472655receive.autogc::
2656By default, git-receive-pack will run "git-gc --auto" after
2657receiving data from git-push and updating refs. You can stop
2658it by setting this variable to false.
2659
Junio C Hamano322c6242015-03-23 21:32:462660receive.certNonceSeed::
Junio C Hamano9236fea2014-10-14 22:28:092661By setting this variable to a string, `git receive-pack`
2662will accept a `git push --signed` and verifies it by using
2663a "nonce" protected by HMAC using this string as a secret
2664key.
2665
Junio C Hamano322c6242015-03-23 21:32:462666receive.certNonceSlop::
Junio C Hamano9236fea2014-10-14 22:28:092667When a `git push --signed` sent a push certificate with a
2668"nonce" that was issued by a receive-pack serving the same
2669repository within this many seconds, export the "nonce"
2670found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2671hooks (instead of what the receive-pack asked the sending
2672side to include). This may allow writing checks in
2673`pre-receive` and `post-receive` a bit easier. Instead of
2674checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2675that records by how many seconds the nonce is stale to
2676decide if they want to accept the certificate, they only
2677can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2678
Junio C Hamano4653c6f2008-11-26 22:50:202679receive.fsckObjects::
2680If it is set to true, git-receive-pack will check all received
2681objects. It will abort in the case of a malformed object or a
2682broken link. The result of an abort are only dangling objects.
Junio C Hamano8fb66e52011-10-05 20:59:512683Defaults to false. If not set, the value of `transfer.fsckObjects`
2684is used instead.
Junio C Hamano4653c6f2008-11-26 22:50:202685
Junio C Hamanod7ed4042015-08-03 19:43:002686receive.fsck.<msg-id>::
2687When `receive.fsckObjects` is set to true, errors can be switched
2688to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2689setting where the `<msg-id>` is the fsck message ID and the value
2690is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2691the error/warning with the message ID, e.g. "missingEmail: invalid
2692author/committer line - missing email" means that setting
2693`receive.fsck.missingEmail = ignore` will hide that issue.
2694+
2695This feature is intended to support working with legacy repositories
2696which would not pass pushing when `receive.fsckObjects = true`, allowing
2697the host to accept repositories with certain known issues but still catch
2698other issues.
2699
2700receive.fsck.skipList::
2701The path to a sorted list of object names (i.e. one SHA-1 per
2702line) that are known to be broken in a non-fatal way and should
2703be ignored. This feature is useful when an established project
2704should be accepted despite early commits containing errors that
2705can be safely ignored such as invalid committer email addresses.
2706Note: corrupt objects cannot be skipped with this setting.
2707
Junio C Hamanoe48a1132016-08-03 22:40:212708receive.keepAlive::
2709After receiving the pack from the client, `receive-pack` may
2710produce no output (if `--quiet` was specified) while processing
2711the pack, causing some networks to drop the TCP connection.
2712With this option set, if `receive-pack` does not transmit
2713any data in this phase for `receive.keepAlive` seconds, it will
2714send a short keepalive packet. The default is 5 seconds; set
2715to 0 to disable keepalives entirely.
2716
Junio C Hamano4653c6f2008-11-26 22:50:202717receive.unpackLimit::
2718If the number of objects received in a push is below this
2719limit then the objects will be unpacked into loose object
2720files. However if the number of received objects equals or
2721exceeds this limit then the received pack will be stored as
2722a pack, after adding any missing delta bases. Storing the
2723pack from a push can make the push operation complete faster,
2724especially on slow filesystems. If not set, the value of
2725`transfer.unpackLimit` is used instead.
2726
Junio C Hamanocd451662016-09-13 00:54:092727receive.maxInputSize::
2728If the size of the incoming pack stream is larger than this
2729limit, then git-receive-pack will error out, instead of
2730accepting the pack file. If not set or set to 0, then the size
2731is unlimited.
2732
Junio C Hamano4653c6f2008-11-26 22:50:202733receive.denyDeletes::
2734If set to true, git-receive-pack will deny a ref update that deletes
2735the ref. Use this to prevent such a ref deletion via a push.
2736
Junio C Hamanob4448a82010-07-26 09:02:322737receive.denyDeleteCurrent::
2738If set to true, git-receive-pack will deny a ref update that
2739deletes the currently checked out branch of a non-bare repository.
2740
Junio C Hamano4653c6f2008-11-26 22:50:202741receive.denyCurrentBranch::
Junio C Hamanoe97d5772010-05-19 08:13:582742If set to true or "refuse", git-receive-pack will deny a ref update
Junio C Hamano4653c6f2008-11-26 22:50:202743to the currently checked out branch of a non-bare repository.
2744Such a push is potentially dangerous because it brings the HEAD
2745out of sync with the index and working tree. If set to "warn",
2746print a warning of such a push to stderr, but allow the push to
2747proceed. If set to false or "ignore", allow such pushes with no
Junio C Hamanoafb395b2010-03-17 22:16:152748message. Defaults to "refuse".
Junio C Hamano6df93d92014-12-22 22:48:092749+
2750Another option is "updateInstead" which will update the working
Junio C Hamano6bb32e62015-02-17 22:11:262751tree if pushing into the current branch. This option is
Junio C Hamano6df93d92014-12-22 22:48:092752intended for synchronizing working directories when one side is not easily
2753accessible via interactive ssh (e.g. a live web site, hence the requirement
2754that the working directory be clean). This mode also comes in handy when
2755developing inside a VM to test and fix code on different Operating Systems.
Junio C Hamano6bb32e62015-02-17 22:11:262756+
2757By default, "updateInstead" will refuse the push if the working tree or
2758the index have any difference from the HEAD, but the `push-to-checkout`
2759hook can be used to customize this. See linkgit:githooks[5].
Junio C Hamano4653c6f2008-11-26 22:50:202760
2761receive.denyNonFastForwards::
2762If set to true, git-receive-pack will deny a ref update which is
Junio C Hamano3f680f32009-11-16 02:10:542763not a fast-forward. Use this to prevent such an update via a push,
Junio C Hamano4653c6f2008-11-26 22:50:202764even if that push is forced. This configuration variable is
2765set when initializing a shared repository.
2766
Junio C Hamano322c6242015-03-23 21:32:462767receive.hideRefs::
Junio C Hamanob6aa12e2015-08-19 22:40:172768This variable is the same as `transfer.hideRefs`, but applies
2769only to `receive-pack` (and so affects pushes, but not fetches).
2770An attempt to update or delete a hidden ref by `git push` is
2771rejected.
Junio C Hamano80ad00d2013-02-18 00:19:032772
Junio C Hamano322c6242015-03-23 21:32:462773receive.updateServerInfo::
Junio C Hamano621e1232009-10-26 05:16:472774If set to true, git-receive-pack will run git-update-server-info
2775after receiving data from git-push and updating refs.
2776
Junio C Hamano322c6242015-03-23 21:32:462777receive.shallowUpdate::
Junio C Hamano61525f92014-01-17 22:46:492778If set to true, .git/shallow can be updated when new refs
2779require new shallow roots. Otherwise those refs are rejected.
2780
Junio C Hamano322c6242015-03-23 21:32:462781remote.pushDefault::
Junio C Hamano63b6fdb2013-04-07 23:37:132782The remote to push to by default. Overrides
2783`branch.<name>.remote` for all branches, and is overridden by
Junio C Hamano322c6242015-03-23 21:32:462784`branch.<name>.pushRemote` for specific branches.
Junio C Hamano63b6fdb2013-04-07 23:37:132785
Junio C Hamano249572f2006-10-24 05:44:082786remote.<name>.url::
Junio C Hamano35738e82008-01-07 07:55:462787The URL of a remote repository. See linkgit:git-fetch[1] or
2788linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:082789
Junio C Hamano0e88f3e2009-06-21 08:03:252790remote.<name>.pushurl::
2791The push URL of a remote repository. See linkgit:git-push[1].
2792
Junio C Hamano58256872007-12-04 08:31:132793remote.<name>.proxy::
2794For remotes that require curl (http, https and ftp), the URL to
2795the proxy to use for that remote. Set to the empty string to
2796disable proxying for that remote.
2797
Junio C Hamanoffe10ca2016-02-04 00:44:232798remote.<name>.proxyAuthMethod::
2799For remotes that require curl (http, https and ftp), the method to use for
2800authenticating against the proxy in use (probably set in
2801`remote.<name>.proxy`). See `http.proxyAuthMethod`.
2802
Junio C Hamano249572f2006-10-24 05:44:082803remote.<name>.fetch::
Junio C Hamano35738e82008-01-07 07:55:462804The default set of "refspec" for linkgit:git-fetch[1]. See
2805linkgit:git-fetch[1].
Junio C Hamano249572f2006-10-24 05:44:082806
2807remote.<name>.push::
Junio C Hamano35738e82008-01-07 07:55:462808The default set of "refspec" for linkgit:git-push[1]. See
2809linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:082810
Junio C Hamano47d68a52008-05-06 06:35:402811remote.<name>.mirror::
2812If true, pushing to this remote will automatically behave
Junio C Hamanob76a6862012-05-02 22:02:462813as if the `--mirror` option was given on the command line.
Junio C Hamano47d68a52008-05-06 06:35:402814
Junio C Hamano118d2772007-02-21 20:24:102815remote.<name>.skipDefaultUpdate::
2816If true, this remote will be skipped by default when updating
Junio C Hamano9df0c662009-11-23 11:09:272817using linkgit:git-fetch[1] or the `update` subcommand of
2818linkgit:git-remote[1].
2819
2820remote.<name>.skipFetchAll::
2821If true, this remote will be skipped by default when updating
2822using linkgit:git-fetch[1] or the `update` subcommand of
2823linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:102824
Junio C Hamano4ad294b2007-01-20 02:22:502825remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:482826The default program to execute on the remote side when pushing. See
Junio C Hamano1dbca522015-05-22 20:48:552827option --receive-pack of linkgit:git-push[1].
Junio C Hamano4ad294b2007-01-20 02:22:502828
Junio C Hamano54ea8d32007-01-25 07:59:482829remote.<name>.uploadpack::
2830The default program to execute on the remote side when fetching. See
Junio C Hamano1dbca522015-05-22 20:48:552831option --upload-pack of linkgit:git-fetch-pack[1].
Junio C Hamano54ea8d32007-01-25 07:59:482832
Junio C Hamano322c6242015-03-23 21:32:462833remote.<name>.tagOpt::
Junio C Hamano1dbca522015-05-22 20:48:552834Setting this value to --no-tags disables automatic tag following when
2835fetching from remote <name>. Setting it to --tags will fetch every
Junio C Hamanocc7636a2010-05-21 14:57:532836tag from remote <name>, even if they are not reachable from remote
Junio C Hamano075ae872010-09-01 18:43:072837branch heads. Passing these flags directly to linkgit:git-fetch[1] can
Junio C Hamano1dbca522015-05-22 20:48:552838override this setting. See options --tags and --no-tags of
Junio C Hamano075ae872010-09-01 18:43:072839linkgit:git-fetch[1].
Junio C Hamano17dde0e2007-02-26 09:50:212840
Junio C Hamano096dde22009-12-26 23:14:112841remote.<name>.vcs::
Junio C Hamano076ffcc2013-02-06 05:13:212842Setting this to a value <vcs> will cause Git to interact with
Junio C Hamano096dde22009-12-26 23:14:112843the remote with the git-remote-<vcs> helper.
2844
Junio C Hamano8eac2682013-09-09 22:35:202845remote.<name>.prune::
2846When set to true, fetching from this remote by default will also
Junio C Hamano4c8f2d92013-12-13 00:55:422847remove any remote-tracking references that no longer exist on the
2848remote (as if the `--prune` option was given on the command line).
Junio C Hamano8eac2682013-09-09 22:35:202849Overrides `fetch.prune` settings, if any.
2850
Junio C Hamano118d2772007-02-21 20:24:102851remotes.<group>::
2852The list of remotes which are fetched by "git remote update
Junio C Hamano35738e82008-01-07 07:55:462853<group>". See linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:102854
Junio C Hamano322c6242015-03-23 21:32:462855repack.useDeltaBaseOffset::
Junio C Hamanofce7c7e2008-07-02 03:06:382856By default, linkgit:git-repack[1] creates packs that use
2857delta-base offset. If you need to share your repository with
Junio C Hamano076ffcc2013-02-06 05:13:212858Git older than version 1.4.4, either directly or via a dumb
Junio C Hamanofce7c7e2008-07-02 03:06:382859protocol such as http, then you need to set this option to
Junio C Hamano076ffcc2013-02-06 05:13:212860"false" and repack. Access from old Git versions over the
Junio C Hamanofce7c7e2008-07-02 03:06:382861native protocol are unaffected by this option.
Junio C Hamano77b7e902006-10-23 07:18:502862
Junio C Hamano3b0cdc22014-03-18 22:06:162863repack.packKeptObjects::
2864If set to true, makes `git repack` act as if
2865`--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2866details. Defaults to `false` normally, but `true` if a bitmap
2867index is being written (either via `--write-bitmap-index` or
Junio C Hamano38d02532014-06-26 21:48:502868`repack.writeBitmaps`).
2869
2870repack.writeBitmaps::
2871When true, git will write a bitmap index when packing all
2872objects to disk (e.g., when `git repack -a` is run). This
2873index can speed up the "counting objects" phase of subsequent
2874packs created for clones and fetches, at the cost of some disk
Junio C Hamano74fd0fc2016-05-10 21:23:562875space and extra time spent on the initial repack. This has
2876no effect if multiple packfiles are created.
2877Defaults to false.
Junio C Hamano3b0cdc22014-03-18 22:06:162878
Junio C Hamano322c6242015-03-23 21:32:462879rerere.autoUpdate::
Junio C Hamano4653c6f2008-11-26 22:50:202880When set to true, `git-rerere` updates the index with the
2881resulting contents after it cleanly resolves conflicts using
2882previously recorded resolution. Defaults to false.
2883
2884rerere.enabled::
2885Activate recording of resolved conflicts, so that identical
Junio C Hamano4fd24422012-01-06 21:52:432886conflict hunks can be resolved automatically, should they be
2887encountered again. By default, linkgit:git-rerere[1] is
2888enabled if there is an `rr-cache` directory under the
Junio C Hamano864ba892012-01-13 17:42:052889`$GIT_DIR`, e.g. if "rerere" was previously used in the
2890repository.
Junio C Hamano4653c6f2008-11-26 22:50:202891
Junio C Hamano1bbd0f42009-07-23 06:20:292892sendemail.identity::
2893A configuration identity. When given, causes values in the
2894'sendemail.<identity>' subsection to take precedence over
2895values in the 'sendemail' section. The default identity is
Junio C Hamano042f2142016-06-27 18:05:052896the value of `sendemail.identity`.
Junio C Hamano1bbd0f42009-07-23 06:20:292897
Junio C Hamano322c6242015-03-23 21:32:462898sendemail.smtpEncryption::
Junio C Hamano1bbd0f42009-07-23 06:20:292899See linkgit:git-send-email[1] for description. Note that this
2900setting is not subject to the 'identity' mechanism.
2901
Junio C Hamanobe087982015-02-22 21:29:392902sendemail.smtpssl (deprecated)::
Junio C Hamano322c6242015-03-23 21:32:462903Deprecated alias for 'sendemail.smtpEncryption = ssl'.
Junio C Hamano1bbd0f42009-07-23 06:20:292904
Junio C Hamano58f587a2013-07-22 19:20:592905sendemail.smtpsslcertpath::
2906Path to ca-certificates (either a directory or a single file).
2907Set it to an empty string to disable certificate verification.
2908
Junio C Hamano1bbd0f42009-07-23 06:20:292909sendemail.<identity>.*::
2910Identity-specific versions of the 'sendemail.*' parameters
2911found below, taking precedence over those when the this
2912identity is selected, through command-line or
Junio C Hamano042f2142016-06-27 18:05:052913`sendemail.identity`.
Junio C Hamano1bbd0f42009-07-23 06:20:292914
Junio C Hamano322c6242015-03-23 21:32:462915sendemail.aliasesFile::
2916sendemail.aliasFileType::
Junio C Hamanoea3b7522013-04-18 19:37:532917sendemail.annotate::
Junio C Hamano1bbd0f42009-07-23 06:20:292918sendemail.bcc::
2919sendemail.cc::
Junio C Hamano322c6242015-03-23 21:32:462920sendemail.ccCmd::
2921sendemail.chainReplyTo::
Junio C Hamano1bbd0f42009-07-23 06:20:292922sendemail.confirm::
Junio C Hamano322c6242015-03-23 21:32:462923sendemail.envelopeSender::
Junio C Hamano1bbd0f42009-07-23 06:20:292924sendemail.from::
Junio C Hamano322c6242015-03-23 21:32:462925sendemail.multiEdit::
Junio C Hamano1bbd0f42009-07-23 06:20:292926sendemail.signedoffbycc::
Junio C Hamano322c6242015-03-23 21:32:462927sendemail.smtpPass::
Junio C Hamano1bbd0f42009-07-23 06:20:292928sendemail.suppresscc::
Junio C Hamano322c6242015-03-23 21:32:462929sendemail.suppressFrom::
Junio C Hamano1bbd0f42009-07-23 06:20:292930sendemail.to::
Junio C Hamano322c6242015-03-23 21:32:462931sendemail.smtpDomain::
2932sendemail.smtpServer::
2933sendemail.smtpServerPort::
2934sendemail.smtpServerOption::
2935sendemail.smtpUser::
Junio C Hamano1bbd0f42009-07-23 06:20:292936sendemail.thread::
Junio C Hamano322c6242015-03-23 21:32:462937sendemail.transferEncoding::
Junio C Hamano1bbd0f42009-07-23 06:20:292938sendemail.validate::
Junio C Hamanoc9394b22015-01-07 22:45:482939sendemail.xmailer::
Junio C Hamano1bbd0f42009-07-23 06:20:292940See linkgit:git-send-email[1] for description.
2941
Junio C Hamanobe087982015-02-22 21:29:392942sendemail.signedoffcc (deprecated)::
Junio C Hamano042f2142016-06-27 18:05:052943Deprecated alias for `sendemail.signedoffbycc`.
Junio C Hamano1bbd0f42009-07-23 06:20:292944
Junio C Hamano07824ce2006-04-25 07:36:542945showbranch.default::
Junio C Hamano35738e82008-01-07 07:55:462946The default set of branches for linkgit:git-show-branch[1].
2947See linkgit:git-show-branch[1].
Junio C Hamano07824ce2006-04-25 07:36:542948
Junio C Hamano3d4a66d2017-03-17 21:07:262949splitIndex.maxPercentChange::
2950When the split index feature is used, this specifies the
2951percent of entries the split index can contain compared to the
2952total number of entries in both the split index and the shared
2953index before a new shared index is written.
2954The value should be between 0 and 100. If the value is 0 then
2955a new shared index is always written, if it is 100 a new
2956shared index is never written.
2957By default the value is 20, so a new shared index is written
2958if the number of entries in the split index would be greater
2959than 20 percent of the total number of entries.
2960See linkgit:git-update-index[1].
2961
2962splitIndex.sharedIndexExpire::
2963When the split index feature is used, shared index files that
2964were not modified since the time this variable specifies will
2965be removed when a new shared index file is created. The value
2966"now" expires all entries immediately, and "never" suppresses
2967expiration altogether.
2968The default value is "2.weeks.ago".
2969Note that a shared index file is considered modified (for the
2970purpose of expiration) each time a new split-index file is
2971either created based on it or read from it.
2972See linkgit:git-update-index[1].
2973
Junio C Hamano942b35e2007-12-09 10:19:332974status.relativePaths::
Junio C Hamano35738e82008-01-07 07:55:462975By default, linkgit:git-status[1] shows paths relative to the
Junio C Hamano942b35e2007-12-09 10:19:332976current directory. Setting this variable to `false` shows paths
Junio C Hamano076ffcc2013-02-06 05:13:212977relative to the repository root (this was the default for Git
Junio C Hamano942b35e2007-12-09 10:19:332978prior to v1.5.4).
2979
Junio C Hamano58655592013-07-11 20:52:332980status.short::
2981Set to true to enable --short by default in linkgit:git-status[1].
2982The option --no-short takes precedence over this variable.
2983
2984status.branch::
2985Set to true to enable --branch by default in linkgit:git-status[1].
2986The option --no-branch takes precedence over this variable.
2987
Junio C Hamano79f4c7c2013-09-20 21:03:372988status.displayCommentPrefix::
2989If set to true, linkgit:git-status[1] will insert a comment
2990prefix before each output line (starting with
2991`core.commentChar`, i.e. `#` by default). This was the
2992behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2993Defaults to false.
2994
Junio C Hamano4224f992008-06-23 07:14:082995status.showUntrackedFiles::
2996By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2997files which are not currently tracked by Git. Directories which
2998contain only untracked files, are shown with the directory name
2999only. Showing untracked files means that Git needs to lstat() all
Junio C Hamano2efd5e42014-11-10 22:38:523000the files in the whole repository, which might be slow on some
Junio C Hamano4224f992008-06-23 07:14:083001systems. So, this variable controls how the commands displays
3002the untracked files. Possible values are:
3003+
3004--
Junio C Hamano7f9fa862010-10-19 23:51:143005* `no` - Show no untracked files.
3006* `normal` - Show untracked files and directories.
3007* `all` - Show also individual files in untracked directories.
Junio C Hamano4224f992008-06-23 07:14:083008--
3009+
3010If this variable is not specified, it defaults to 'normal'.
3011This variable can be overridden with the -u|--untracked-files option
3012of linkgit:git-status[1] and linkgit:git-commit[1].
3013
Junio C Hamano322c6242015-03-23 21:32:463014status.submoduleSummary::
Junio C Hamanob671fb52010-06-01 05:06:143015Defaults to false.
3016If this is set to a non zero number or true (identical to -1 or an
3017unlimited number), the submodule summary will be enabled and a
3018summary of commits for modified submodules will be shown (see
Junio C Hamano369e3402013-10-15 18:40:253019--summary-limit option of linkgit:git-submodule[1]). Please note
3020that the summary output command will be suppressed for all
3021submodules when `diff.ignoreSubmodules` is set to 'all' or only
Junio C Hamanoc8c398a2014-06-16 21:14:053022for those submodules where `submodule.<name>.ignore=all`. The only
3023exception to that rule is that status and commit will show staged
3024submodule changes. To
Junio C Hamano369e3402013-10-15 18:40:253025also view the summary for ignored submodules you can either use
Junio C Hamanoe1aeb5e2014-06-06 19:16:293026the --ignore-submodules=dirty command-line option or the 'git
Junio C Hamano369e3402013-10-15 18:40:253027submodule summary' command, which shows a similar output but does
3028not honor these settings.
Junio C Hamanob671fb52010-06-01 05:06:143029
Junio C Hamano1eb56092015-10-05 20:39:533030stash.showPatch::
3031If this is set to true, the `git stash show` command without an
3032option will show the stash in patch form. Defaults to false.
3033See description of 'show' command in linkgit:git-stash[1].
3034
3035stash.showStat::
3036If this is set to true, the `git stash show` command without an
3037option will show diffstat of the stash. Defaults to true.
3038See description of 'show' command in linkgit:git-stash[1].
3039
Junio C Hamano78e3a782010-07-15 22:24:453040submodule.<name>.url::
Junio C Hamanoc0859f72016-10-17 22:22:573041The URL for a submodule. This variable is copied from the .gitmodules
3042file to the git config via 'git submodule init'. The user can change
3043the configured URL before obtaining the submodule via 'git submodule
Junio C Hamanodc8d0c32017-03-30 23:00:213044update'. If neither submodule.<name>.active or submodule.active are
3045set, the presence of this variable is used as a fallback to indicate
3046whether the submodule is of interest to git commands.
Junio C Hamanoc0859f72016-10-17 22:22:573047See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
Junio C Hamano6bf68cf2015-03-06 23:46:293048
Junio C Hamano78e3a782010-07-15 22:24:453049submodule.<name>.update::
Junio C Hamano6bf68cf2015-03-06 23:46:293050The default update procedure for a submodule. This variable
3051is populated by `git submodule init` from the
3052linkgit:gitmodules[5] file. See description of 'update'
3053command in linkgit:git-submodule[1].
Junio C Hamano78e3a782010-07-15 22:24:453054
Junio C Hamanoabad6da2013-01-06 09:06:323055submodule.<name>.branch::
3056The remote branch name for a submodule, used by `git submodule
3057update --remote`. Set this option to override the value found in
3058the `.gitmodules` file. See linkgit:git-submodule[1] and
3059linkgit:gitmodules[5] for details.
3060
Junio C Hamano0d75e872010-12-17 06:57:263061submodule.<name>.fetchRecurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:103062This option can be used to control recursive fetching of this
Junio C Hamano7165bf72011-01-04 22:06:183063submodule. It can be overridden by using the --[no-]recurse-submodules
Junio C Hamanoe1aeb5e2014-06-06 19:16:293064command-line option to "git fetch" and "git pull".
Junio C Hamano0d75e872010-12-17 06:57:263065This setting will override that from in the linkgit:gitmodules[5]
3066file.
3067
Junio C Hamano619596a2010-08-18 22:15:353068submodule.<name>.ignore::
3069Defines under what circumstances "git status" and the diff family show
3070a submodule as modified. When set to "all", it will never be considered
Junio C Hamanoc8c398a2014-06-16 21:14:053071modified (but it will nonetheless show up in the output of status and
3072commit when it has been staged), "dirty" will ignore all changes
3073to the submodules work tree and
Junio C Hamano619596a2010-08-18 22:15:353074takes only differences between the HEAD of the submodule and the commit
3075recorded in the superproject into account. "untracked" will additionally
3076let submodules with modified tracked files in their work tree show up.
3077Using "none" (the default when this option is not set) also shows
3078submodules that have untracked files in their work tree as changed.
3079This setting overrides any setting made in .gitmodules for this submodule,
Junio C Hamanode9745c2010-08-23 17:10:183080both settings can be overridden on the command line by using the
Junio C Hamano369e3402013-10-15 18:40:253081"--ignore-submodules" option. The 'git submodule' commands are not
3082affected by this setting.
Junio C Hamano619596a2010-08-18 22:15:353083
Junio C Hamanodc8d0c32017-03-30 23:00:213084submodule.<name>.active::
3085Boolean value indicating if the submodule is of interest to git
3086commands. This config option takes precedence over the
3087submodule.active config option.
3088
3089submodule.active::
3090A repeated field which contains a pathspec used to match against a
3091submodule's path to determine if the submodule is of interest to git
3092commands.
3093
Junio C Hamano3a31ce52017-06-13 21:15:553094submodule.recurse::
3095Specifies if commands recurse into submodules by default. This
3096applies to all commands that have a `--recurse-submodules` option.
3097Defaults to false.
3098
Junio C Hamanobec5da42016-04-06 22:58:213099submodule.fetchJobs::
3100Specifies how many submodules are fetched/cloned at the same time.
3101A positive integer allows up to that number of submodules fetched
3102in parallel. A value of 0 will give some reasonable default.
3103If unset, it defaults to 1.
3104
Junio C Hamanocd451662016-09-13 00:54:093105submodule.alternateLocation::
3106Specifies how the submodules obtain alternates when submodules are
3107cloned. Possible values are `no`, `superproject`.
3108By default `no` is assumed, which doesn't add references. When the
3109value is set to `superproject` the submodule to be cloned computes
3110its alternates location relative to the superprojects alternate.
3111
Junio C Hamanoce01de82017-02-16 22:59:123112submodule.alternateErrorStrategy::
Junio C Hamanocd451662016-09-13 00:54:093113Specifies how to treat errors with the alternates for a submodule
3114as computed via `submodule.alternateLocation`. Possible values are
3115`ignore`, `info`, `die`. Default is `die`.
3116
Junio C Hamanobec5da42016-04-06 22:58:213117tag.forceSignAnnotated::
3118A boolean to specify whether annotated tags created should be GPG signed.
3119If `--annotate` is specified on the command line, it takes
3120precedence over this option.
3121
Junio C Hamano7b43d412014-07-23 23:09:443122tag.sort::
3123This variable controls the sort ordering of tags when displayed by
3124linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3125value of this variable will be used as the default.
3126
Junio C Hamano75cc4c92006-07-24 08:25:033127tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:093128This variable can be used to restrict the permission bits of
3129tar archive entries. The default is 0002, which turns off the
3130world write bit. The special value "user" indicates that the
3131archiving user's umask will be used instead. See umask(2) and
Junio C Hamano35738e82008-01-07 07:55:463132linkgit:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:033133
Junio C Hamano8fb66e52011-10-05 20:59:513134transfer.fsckObjects::
3135When `fetch.fsckObjects` or `receive.fsckObjects` are
3136not set, the value of this variable is used instead.
3137Defaults to false.
3138
Junio C Hamano322c6242015-03-23 21:32:463139transfer.hideRefs::
Junio C Hamanob6aa12e2015-08-19 22:40:173140String(s) `receive-pack` and `upload-pack` use to decide which
3141refs to omit from their initial advertisements. Use more than
3142one definition to specify multiple prefix strings. A ref that is
3143under the hierarchies listed in the value of this variable is
3144excluded, and is hidden when responding to `git push` or `git
3145fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
3146program-specific versions of this config.
3147+
3148You may also include a `!` in front of the ref name to negate the entry,
3149explicitly exposing it, even if an earlier entry marked it as hidden.
3150If you have multiple hideRefs values, later entries override earlier ones
3151(and entries in more-specific config files override less-specific ones).
Junio C Hamano713eded2015-12-03 00:24:023152+
3153If a namespace is in use, the namespace prefix is stripped from each
3154reference before it is matched against `transfer.hiderefs` patterns.
3155For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3156the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3157is omitted from the advertisements but `refs/heads/master` and
3158`refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3159"have" lines. In order to match refs before stripping, add a `^` in front of
3160the ref name. If you combine `!` and `^`, `!` must be specified first.
Junio C Hamano56ace3d2017-01-10 23:43:413161+
3162Even if you hide refs, a client may still be able to steal the target
3163objects via the techniques described in the "SECURITY" section of the
3164linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3165separate repository.
Junio C Hamano80ad00d2013-02-18 00:19:033166
Junio C Hamano4653c6f2008-11-26 22:50:203167transfer.unpackLimit::
3168When `fetch.unpackLimit` or `receive.unpackLimit` are
3169not set, the value of this variable is used instead.
3170The default value is 100.
3171
Junio C Hamano81703b22014-03-14 22:00:273172uploadarchive.allowUnreachable::
3173If true, allow clients to use `git archive --remote` to request
3174any tree, whether reachable from the ref tips or not. See the
Junio C Hamano56ace3d2017-01-10 23:43:413175discussion in the "SECURITY" section of
Junio C Hamano81703b22014-03-14 22:00:273176linkgit:git-upload-archive[1] for more details. Defaults to
3177`false`.
3178
Junio C Hamano322c6242015-03-23 21:32:463179uploadpack.hideRefs::
Junio C Hamanob6aa12e2015-08-19 22:40:173180This variable is the same as `transfer.hideRefs`, but applies
3181only to `upload-pack` (and so affects only fetches, not pushes).
3182An attempt to fetch a hidden ref by `git fetch` will fail. See
3183also `uploadpack.allowTipSHA1InWant`.
Junio C Hamano5e7f1312013-03-21 22:49:013184
Junio C Hamano85f1fde2015-06-01 20:37:323185uploadpack.allowTipSHA1InWant::
Junio C Hamano322c6242015-03-23 21:32:463186When `uploadpack.hideRefs` is in effect, allow `upload-pack`
Junio C Hamano5e7f1312013-03-21 22:49:013187to accept a fetch request that asks for an object at the tip
3188of a hidden ref (by default, such a request is rejected).
Junio C Hamano56ace3d2017-01-10 23:43:413189See also `uploadpack.hideRefs`. Even if this is false, a client
3190may be able to steal objects via the techniques described in the
3191"SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3192best to keep private data in a separate repository.
Junio C Hamano80ad00d2013-02-18 00:19:033193
Junio C Hamano85f1fde2015-06-01 20:37:323194uploadpack.allowReachableSHA1InWant::
3195Allow `upload-pack` to accept a fetch request that asks for an
3196object that is reachable from any ref tip. However, note that
3197calculating object reachability is computationally expensive.
Junio C Hamano56ace3d2017-01-10 23:43:413198Defaults to `false`. Even if this is false, a client may be able
3199to steal objects via the techniques described in the "SECURITY"
3200section of the linkgit:gitnamespaces[7] man page; it's best to
3201keep private data in a separate repository.
3202
3203uploadpack.allowAnySHA1InWant::
3204Allow `upload-pack` to accept a fetch request that asks for any
3205object at all.
Junio C Hamano85f1fde2015-06-01 20:37:323206Defaults to `false`.
3207
Junio C Hamano322c6242015-03-23 21:32:463208uploadpack.keepAlive::
Junio C Hamano79f4c7c2013-09-20 21:03:373209When `upload-pack` has started `pack-objects`, there may be a
3210quiet period while `pack-objects` prepares the pack. Normally
3211it would output progress information, but if `--quiet` was used
3212for the fetch, `pack-objects` will output nothing at all until
3213the pack data begins. Some clients and networks may consider
3214the server to be hung and give up. Setting this option instructs
3215`upload-pack` to send an empty keepalive packet every
Junio C Hamano322c6242015-03-23 21:32:463216`uploadpack.keepAlive` seconds. Setting this option to 0
Junio C Hamano79f4c7c2013-09-20 21:03:373217disables keepalive packets entirely. The default is 5 seconds.
3218
Junio C Hamanoc6c919b2016-07-06 21:34:153219uploadpack.packObjectsHook::
3220If this option is set, when `upload-pack` would run
3221`git pack-objects` to create a packfile for a client, it will
3222run this shell command instead. The `pack-objects` command and
3223arguments it _would_ have run (including the `git pack-objects`
3224at the beginning) are appended to the shell command. The stdin
3225and stdout of the hook are treated as if `pack-objects` itself
3226was run. I.e., `upload-pack` will feed input intended for
3227`pack-objects` to the hook, and expects a completed packfile on
3228stdout.
3229+
3230Note that this configuration variable is ignored if it is seen in the
3231repository-level config (this is a safety measure against fetching from
3232untrusted repositories).
3233
Junio C Hamano24bc09a2008-02-28 00:27:443234url.<base>.insteadOf::
3235Any URL that starts with this value will be rewritten to
3236start, instead, with <base>. In cases where some site serves a
3237large number of repositories, and serves them with multiple
3238access methods, and some users need to use different access
3239methods, this feature allows people to specify any of the
Junio C Hamano076ffcc2013-02-06 05:13:213240equivalent URLs and have Git automatically rewrite the URL to
Junio C Hamano24bc09a2008-02-28 00:27:443241the best alternative for the particular user, even for a
3242never-before-seen repository on the site. When more than one
3243insteadOf strings match a given URL, the longest match is used.
Junio C Hamanoe0e20df2017-06-04 02:10:213244+
3245Note that any protocol restrictions will be applied to the rewritten
3246URL. If the rewrite changes the URL to use a custom protocol or remote
3247helper, you may need to adjust the `protocol.*.allow` config to permit
3248the request. In particular, protocols you expect to use for submodules
3249must be set to `always` rather than the default of `user`. See the
3250description of `protocol.allow` above.
Junio C Hamano24bc09a2008-02-28 00:27:443251
Junio C Hamano7df6dcf2009-09-13 09:51:173252url.<base>.pushInsteadOf::
3253Any URL that starts with this value will not be pushed to;
3254instead, it will be rewritten to start with <base>, and the
3255resulting URL will be pushed to. In cases where some site serves
3256a large number of repositories, and serves them with multiple
3257access methods, some of which do not allow push, this feature
Junio C Hamano076ffcc2013-02-06 05:13:213258allows people to specify a pull-only URL and have Git
Junio C Hamano7df6dcf2009-09-13 09:51:173259automatically use an appropriate URL to push, even for a
3260never-before-seen repository on the site. When more than one
3261pushInsteadOf strings match a given URL, the longest match is
Junio C Hamano076ffcc2013-02-06 05:13:213262used. If a remote has an explicit pushurl, Git will ignore this
Junio C Hamano7df6dcf2009-09-13 09:51:173263setting for that remote.
3264
Junio C Hamano07824ce2006-04-25 07:36:543265user.email::
3266Your email address to be recorded in any newly created commits.
Junio C Hamano042f2142016-06-27 18:05:053267Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3268`EMAIL` environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:543269
3270user.name::
3271Your full name to be recorded in any newly created commits.
Junio C Hamano042f2142016-06-27 18:05:053272Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
Junio C Hamano35738e82008-01-07 07:55:463273environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:543274
Junio C Hamanof85ef632016-02-17 22:31:063275user.useConfigOnly::
Junio C Hamano042f2142016-06-27 18:05:053276Instruct Git to avoid trying to guess defaults for `user.email`
3277and `user.name`, and instead retrieve the values only from the
Junio C Hamanof85ef632016-02-17 22:31:063278configuration. For example, if you have multiple email addresses
3279and would like to use a different one for each repository, then
3280with this configuration option set to `true` in the global config
3281along with a name, Git will prompt you to set up an email before
3282making new commits in a newly cloned repository.
3283Defaults to `false`.
3284
Junio C Hamano322c6242015-03-23 21:32:463285user.signingKey::
Junio C Hamano369e3402013-10-15 18:40:253286If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3287key you want it to automatically when creating a signed tag or
3288commit, you can override the default selection with this variable.
3289This option is passed unchanged to gpg's --local-user parameter,
3290so you may specify a key using any method that gpg supports.
Junio C Hamanoa890c4f2007-01-28 10:29:213291
Junio C Hamanobcd98f42017-01-24 00:12:163292versionsort.prereleaseSuffix (deprecated)::
3293Deprecated alias for `versionsort.suffix`. Ignored if
3294`versionsort.suffix` is set.
3295
3296versionsort.suffix::
3297Even when version sort is used in linkgit:git-tag[1], tagnames
3298with the same base version but different suffixes are still sorted
3299lexicographically, resulting e.g. in prerelease tags appearing
3300after the main release (e.g. "1.0-rc1" after "1.0"). This
3301variable can be specified to determine the sorting order of tags
3302with different suffixes.
Junio C Hamano07622622015-03-20 21:47:263303+
Junio C Hamanobcd98f42017-01-24 00:12:163304By specifying a single suffix in this variable, any tagname containing
3305that suffix will appear before the corresponding main release. E.g. if
3306the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3307"1.0". If specified multiple times, once per suffix, then the order of
3308suffixes in the configuration will determine the sorting order of tagnames
3309with those suffixes. E.g. if "-pre" appears before "-rc" in the
3310configuration, then all "1.0-preX" tags will be listed before any
3311"1.0-rcX" tags. The placement of the main release tag relative to tags
3312with various suffixes can be determined by specifying the empty suffix
3313among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3314"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3315are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3316"v4.8-bfsX".
3317+
3318If more than one suffixes match the same tagname, then that tagname will
3319be sorted according to the suffix which starts at the earliest position in
3320the tagname. If more than one different matching suffixes start at
3321that earliest position, then that tagname will be sorted according to the
3322longest of those suffixes.
3323The sorting order between different suffixes is undefined if they are
3324in multiple config files.
Junio C Hamano07622622015-03-20 21:47:263325
Junio C Hamano4e272312008-01-08 09:13:213326web.browser::
3327Specify a web browser that may be used by some commands.
3328Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3329may use it.