blob: c1598ee7039fca0439a18b31f186052bbb40bbce [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
Junio C Hamanoa4ff7292017-08-23 21:56:43219true;; Boolean true literals are `yes`, `on`, `true`,
220and `1`. Also, a variable defined without `= <value>`
Junio C Hamano07622622015-03-20 21:47:26221is taken as true.
222
Junio C Hamanoa4ff7292017-08-23 21:56:43223false;; Boolean false literals are `no`, `off`, `false`,
224`0` and the empty string.
Junio C Hamano07622622015-03-20 21:47:26225+
Junio C Hamano92d80372016-07-13 22:00:05226When converting value to the canonical form using `--bool` type
Junio C Hamanoa4ff7292017-08-23 21:56:43227specifier, 'git config' will ensure that the output is "true" or
Junio C Hamano07622622015-03-20 21:47:26228"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 Hamano535c65c2017-06-24 22:51:58351addEmbeddedRepo::
352Advice on what to do when you've accidentally added one
353git repo inside of another.
Junio C Hamano3a9c0342017-11-10 06:01:12354ignoredHook::
355Advice shown if an hook is ignored because the hook is not
356set as executable.
Junio C Hamano7df6dcf2009-09-13 09:51:17357--
358
Junio C Hamano07824ce2006-04-25 07:36:54359core.fileMode::
Junio C Hamanod2c28482014-10-24 22:28:25360Tells Git if the executable bit of files in the working tree
361is to be honored.
Junio C Hamano9df0c662009-11-23 11:09:27362+
Junio C Hamanod2c28482014-10-24 22:28:25363Some filesystems lose the executable bit when a file that is
Junio C Hamano6b6144f2017-05-29 06:20:15364marked as executable is checked out, or checks out a
Junio C Hamanod2c28482014-10-24 22:28:25365non-executable file with executable bit on.
366linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
367to see if it handles the executable bit correctly
368and this variable is automatically set as necessary.
369+
370A repository, however, may be on a filesystem that handles
371the filemode correctly, and this variable is set to 'true'
372when created, but later may be made accessible from another
373environment that loses the filemode (e.g. exporting ext4 via
374CIFS mount, visiting a Cygwin created repository with
375Git for Windows or Eclipse).
376In such a case it may be necessary to set this variable to 'false'.
377See linkgit:git-update-index[1].
378+
379The default is true (when core.filemode is not specified in the config file).
Junio C Hamano07824ce2006-04-25 07:36:54380
Junio C Hamano198b1f12016-05-17 22:27:24381core.hideDotFiles::
382(Windows-only) If true, mark newly-created directories and files whose
383name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
384directory is hidden, but no other files starting with a dot. The
385default mode is 'dotGitOnly'.
386
Junio C Hamano322c6242015-03-23 21:32:46387core.ignoreCase::
Junio C Hamano9df0c662009-11-23 11:09:27388If true, this option enables various workarounds to enable
Junio C Hamano076ffcc2013-02-06 05:13:21389Git to work better on filesystems that are not case sensitive,
Junio C Hamano9df0c662009-11-23 11:09:27390like FAT. For example, if a directory listing finds
Junio C Hamano076ffcc2013-02-06 05:13:21391"makefile" when Git expects "Makefile", Git will assume
Junio C Hamano9df0c662009-11-23 11:09:27392it is really the same file, and continue to remember it as
393"Makefile".
394+
395The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
Junio C Hamano322c6242015-03-23 21:32:46396will probe and set core.ignoreCase true if appropriate when the repository
Junio C Hamano9df0c662009-11-23 11:09:27397is created.
398
Junio C Hamano322c6242015-03-23 21:32:46399core.precomposeUnicode::
Junio C Hamano076ffcc2013-02-06 05:13:21400This option is only used by Mac OS implementation of Git.
Junio C Hamano322c6242015-03-23 21:32:46401When core.precomposeUnicode=true, Git reverts the unicode decomposition
Junio C Hamanob61a7772012-07-13 23:34:48402of filenames done by Mac OS. This is useful when sharing a repository
403between Mac OS and Linux or Windows.
Junio C Hamano076ffcc2013-02-06 05:13:21404(Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
405When false, file names are handled fully transparent by Git,
406which is backward compatible with older versions of Git.
Junio C Hamanob61a7772012-07-13 23:34:48407
Junio C Hamano30758bd2014-12-18 20:44:14408core.protectHFS::
409If set to true, do not allow checkout of paths that would
410be considered equivalent to `.git` on an HFS+ filesystem.
411Defaults to `true` on Mac OS, and `false` elsewhere.
412
413core.protectNTFS::
414If set to true, do not allow checkout of paths that would
415cause problems with the NTFS filesystem, e.g. conflict with
4168.3 "short" names.
417Defaults to `true` on Windows, and `false` elsewhere.
418
Junio C Hamanod7105602017-11-21 05:32:50419core.fsmonitor::
420If set, the value of this variable is used as a command which
421will identify all files that may have changed since the
422requested date/time. This information is used to speed up git by
423avoiding unnecessary processing of files that have not changed.
424See the "fsmonitor-watchman" section of linkgit:githooks[5].
425
Junio C Hamano90ccff32008-07-29 08:17:24426core.trustctime::
427If false, the ctime differences between the index and the
Junio C Hamano8fb66e52011-10-05 20:59:51428working tree are ignored; useful when the inode change time
Junio C Hamano90ccff32008-07-29 08:17:24429is regularly modified by something outside Git (file system
430crawlers and some backup systems).
431See linkgit:git-update-index[1]. True by default.
432
Junio C Hamano3d4a66d2017-03-17 21:07:26433core.splitIndex::
434If true, the split-index feature of the index will be used.
435See linkgit:git-update-index[1]. False by default.
436
Junio C Hamano9099a7c2016-02-10 23:42:05437core.untrackedCache::
438Determines what to do about the untracked cache feature of the
439index. It will be kept, if this variable is unset or set to
440`keep`. It will automatically be added if set to `true`. And
441it will automatically be removed, if set to `false`. Before
442setting it to `true`, you should check that mtime is working
443properly on your system.
444See linkgit:git-update-index[1]. `keep` by default.
445
Junio C Hamano322c6242015-03-23 21:32:46446core.checkStat::
Junio C Hamano4cfed0c2013-01-30 17:58:54447Determines which stat fields to match between the index
448and work tree. The user can set this to 'default' or
449'minimal'. Default (or explicitly 'default'), is to check
450all fields, including the sub-second part of mtime and ctime.
451
Junio C Hamano322c6242015-03-23 21:32:46452core.quotePath::
Junio C Hamano0f6f3bf2017-03-13 07:01:53453Commands that output paths (e.g. 'ls-files', 'diff'), will
454quote "unusual" characters in the pathname by enclosing the
455pathname in double-quotes and escaping those characters with
456backslashes in the same way C escapes control characters (e.g.
457`\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
458values larger than 0x80 (e.g. octal `\302\265` for "micro" in
459UTF-8). If this variable is set to false, bytes higher than
4600x80 are not considered "unusual" any more. Double-quotes,
461backslash and control characters are always escaped regardless
462of the setting of this variable. A simple space character is
463not considered "unusual". Many commands can output pathnames
464completely verbatim using the `-z` option. The default value
465is true.
Junio C Hamanod526ba92007-07-02 00:17:42466
Junio C Hamanobb88cf42010-06-21 15:23:55467core.eol::
468Sets the line ending type to use in the working directory for
Junio C Hamanof2a3a752016-05-23 22:54:39469files that have the `text` property set when core.autocrlf is false.
470Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
471native line ending. The default value is `native`. See
Junio C Hamanobb88cf42010-06-21 15:23:55472linkgit:gitattributes[5] for more information on end-of-line
473conversion.
Junio C Hamanod9e0e5d2007-04-14 16:22:04474
Junio C Hamano26e590a2008-02-17 03:53:51475core.safecrlf::
Junio C Hamano076ffcc2013-02-06 05:13:21476If true, makes Git check if converting `CRLF` is reversible when
Junio C Hamanobb88cf42010-06-21 15:23:55477end-of-line conversion is active. Git will verify if a command
Junio C Hamano26e590a2008-02-17 03:53:51478modifies a file in the work tree either directly or indirectly.
479For example, committing a file followed by checking out the
480same file should yield the original file in the work tree. If
481this is not the case for the current setting of
Junio C Hamano076ffcc2013-02-06 05:13:21482`core.autocrlf`, Git will reject the file. The variable can
483be set to "warn", in which case Git will only warn about an
Junio C Hamano26e590a2008-02-17 03:53:51484irreversible conversion but continue the operation.
485+
486CRLF conversion bears a slight chance of corrupting data.
Junio C Hamano076ffcc2013-02-06 05:13:21487When it is enabled, Git will convert CRLF to LF during commit and LF to
Junio C Hamano26e590a2008-02-17 03:53:51488CRLF during checkout. A file that contains a mixture of LF and
Junio C Hamano076ffcc2013-02-06 05:13:21489CRLF before the commit cannot be recreated by Git. For text
Junio C Hamano26e590a2008-02-17 03:53:51490files this is the right thing to do: it corrects line endings
491such that we have only LF line endings in the repository.
492But for binary files that are accidentally classified as text the
493conversion can corrupt data.
494+
495If you recognize such corruption early you can easily fix it by
496setting the conversion type explicitly in .gitattributes. Right
497after committing you still have the original file in your work
498tree and this file is not yet corrupted. You can explicitly tell
Junio C Hamano076ffcc2013-02-06 05:13:21499Git that this file is binary and Git will handle the file
Junio C Hamano26e590a2008-02-17 03:53:51500appropriately.
501+
502Unfortunately, the desired effect of cleaning up text files with
503mixed line endings and the undesired effect of corrupting binary
504files cannot be distinguished. In both cases CRLFs are removed
505in an irreversible way. For text files this is the right thing
506to do because CRLFs are line endings, while for binary files
507converting CRLFs corrupts data.
508+
509Note, this safety check does not mean that a checkout will generate a
510file identical to the original file for a different setting of
Junio C Hamanobb88cf42010-06-21 15:23:55511`core.eol` and `core.autocrlf`, but only for the current one. For
512example, a text file with `LF` would be accepted with `core.eol=lf`
513and could later be checked out with `core.eol=crlf`, in which case the
Junio C Hamano26e590a2008-02-17 03:53:51514resulting file would contain `CRLF`, although the original file
515contained `LF`. However, in both work trees the line endings would be
516consistent, that is either all `LF` or all `CRLF`, but never mixed. A
517file with mixed line endings would be reported by the `core.safecrlf`
518mechanism.
519
Junio C Hamanobb88cf42010-06-21 15:23:55520core.autocrlf::
Junio C Hamanoeed15af2016-07-25 22:49:42521Setting this variable to "true" is the same as setting
522the `text` attribute to "auto" on all files and core.eol to "crlf".
523Set to true if you want to have `CRLF` line endings in your
524working directory and the repository has LF line endings.
525This variable can be set to 'input',
Junio C Hamanobb88cf42010-06-21 15:23:55526in which case no output conversion is performed.
527
Junio C Hamanoaa83a7d2007-03-05 02:37:29528core.symlinks::
529If false, symbolic links are checked out as small plain files that
Junio C Hamano35738e82008-01-07 07:55:46530contain the link text. linkgit:git-update-index[1] and
531linkgit:git-add[1] will not change the recorded type to regular
Junio C Hamanoaa83a7d2007-03-05 02:37:29532file. Useful on filesystems like FAT that do not support
Junio C Hamano9df0c662009-11-23 11:09:27533symbolic links.
534+
535The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
536will probe and set core.symlinks false if appropriate when the repository
537is created.
Junio C Hamanoaa83a7d2007-03-05 02:37:29538
Junio C Hamano07824ce2006-04-25 07:36:54539core.gitProxy::
540A "proxy command" to execute (as 'command host port') instead
541of establishing direct connection to the remote server when
Junio C Hamano076ffcc2013-02-06 05:13:21542using the Git protocol for fetching. If the variable value is
Junio C Hamano07824ce2006-04-25 07:36:54543in the "COMMAND for DOMAIN" format, the command is applied only
544on hostnames ending with the specified domain string. This variable
545may be set multiple times and is matched in the given order;
546the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17547+
Junio C Hamano042f2142016-06-27 18:05:05548Can be overridden by the `GIT_PROXY_COMMAND` environment variable
Junio C Hamanof1d14802006-06-08 00:48:17549(which always applies universally, without the special "for"
550handling).
Junio C Hamanoea82cff2009-03-18 01:54:48551+
552The special string `none` can be used as the proxy command to
553specify that no proxy be used for a given domain pattern.
554This is useful for excluding servers inside a firewall from
555proxy use, while defaulting to a common proxy for external domains.
Junio C Hamano07824ce2006-04-25 07:36:54556
Junio C Hamano1a1b8472016-07-19 21:37:13557core.sshCommand::
558If this variable is set, `git fetch` and `git push` will
559use the specified command instead of `ssh` when they need to
560connect to a remote system. The command is in the same form as
561the `GIT_SSH_COMMAND` environment variable and is overridden
562when the environment variable is set.
563
Junio C Hamano07824ce2006-04-25 07:36:54564core.ignoreStat::
Junio C Hamanoe8acc8e2015-01-14 22:01:34565If true, Git will avoid using lstat() calls to detect if files have
566changed by setting the "assume-unchanged" bit for those tracked files
567which it has updated identically in both the index and working tree.
568+
569When files are modified outside of Git, the user will need to stage
570the modified files explicitly (e.g. see 'Examples' section in
571linkgit:git-update-index[1]).
572Git will not normally detect changes to those files.
573+
574This is useful on systems where lstat() calls are very slow, such as
575CIFS/Microsoft Windows.
576+
577False by default.
Junio C Hamano07824ce2006-04-25 07:36:54578
Junio C Hamano88a3a072006-05-04 08:01:43579core.preferSymlinkRefs::
580Instead of the default "symref" format for HEAD
581and other symbolic reference files, use symbolic links.
582This is sometimes needed to work with old scripts that
583expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54584
Junio C Hamano1025e752007-02-23 07:21:26585core.bare::
586If true this repository is assumed to be 'bare' and has no
587working directory associated with it. If this is the case a
588number of commands that require a working directory will be
Junio C Hamano35738e82008-01-07 07:55:46589disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Junio C Hamano1025e752007-02-23 07:21:26590+
Junio C Hamano35738e82008-01-07 07:55:46591This setting is automatically guessed by linkgit:git-clone[1] or
592linkgit:git-init[1] when the repository was created. By default a
Junio C Hamano1025e752007-02-23 07:21:26593repository that ends in "/.git" is assumed to be not bare (bare =
594false), while all other repositories are assumed to be bare (bare
595= true).
596
Junio C Hamanod526ba92007-07-02 00:17:42597core.worktree::
Junio C Hamano80d58462011-01-24 22:52:52598Set the path to the root of the working tree.
Junio C Hamano042f2142016-06-27 18:05:05599If `GIT_COMMON_DIR` environment variable is set, core.worktree
Junio C Hamano4cc4a842015-05-11 22:41:02600is ignored and not used for determining the root of working tree.
Junio C Hamano042f2142016-06-27 18:05:05601This can be overridden by the `GIT_WORK_TREE` environment
Junio C Hamano92d80372016-07-13 22:00:05602variable and the `--work-tree` command-line option.
Junio C Hamano5cd15182011-04-05 00:21:10603The value can be an absolute path or relative to the path to
Junio C Hamano80d58462011-01-24 22:52:52604the .git directory, which is either specified by --git-dir
605or GIT_DIR, or automatically discovered.
606If --git-dir or GIT_DIR is specified but none of
Junio C Hamano7d575a52008-04-30 08:45:27607--work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamano80d58462011-01-24 22:52:52608the current working directory is regarded as the top level
Junio C Hamano3609b332010-12-29 01:34:52609of your working tree.
Junio C Hamano80d58462011-01-24 22:52:52610+
611Note that this variable is honored even when set in a configuration
612file in a ".git" subdirectory of a directory and its value differs
613from the latter directory (e.g. "/path/to/.git/config" has
614core.worktree set to "/different/path"), which is most likely a
Junio C Hamano076ffcc2013-02-06 05:13:21615misconfiguration. Running Git commands in the "/path/to" directory will
Junio C Hamano80d58462011-01-24 22:52:52616still use "/different/path" as the root of the work tree and can cause
617confusion unless you know what you are doing (e.g. you are creating a
618read-only snapshot of the same index to a location different from the
619repository's usual working tree).
Junio C Hamanod526ba92007-07-02 00:17:42620
Junio C Hamano341071d2006-06-04 07:24:48621core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49622Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamano198b1f12016-05-17 22:27:24623"`$GIT_DIR/logs/<ref>`", by appending the new and old
Junio C Hamanoe3f080d2013-04-22 02:27:13624SHA-1, the date/time and the reason of the update, but
Junio C Hamanoa2ec14f2006-11-02 00:22:48625only when the file exists. If this configuration
Junio C Hamanoa8e42612017-02-03 21:44:07626variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
Junio C Hamano15567bc2011-07-23 00:51:59627file is automatically created for branch heads (i.e. under
Junio C Hamanoa8e42612017-02-03 21:44:07628`refs/heads/`), remote refs (i.e. under `refs/remotes/`),
629note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
630If it is set to `always`, then a missing reflog is automatically
631created for any ref under `refs/`.
Junio C Hamano1caaf472006-12-31 08:29:35632+
633This information can be used to determine what commit
634was the tip of a branch "2 days ago".
635+
636This value is true by default in a repository that has
637a working directory associated with it, and false by
638default in a bare repository.
Junio C Hamano341071d2006-06-04 07:24:48639
Junio C Hamano07824ce2006-04-25 07:36:54640core.repositoryFormatVersion::
641Internal variable identifying the repository format and layout
642version.
643
644core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42645When 'group' (or 'true'), the repository is made shareable between
646several users in a group (making sure all the files and objects are
647group-writable). When 'all' (or 'world' or 'everybody'), the
648repository will be readable by all users, additionally to being
Junio C Hamano076ffcc2013-02-06 05:13:21649group-shareable. When 'umask' (or 'false'), Git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37650reported by umask(2). When '0xxx', where '0xxx' is an octal number,
651files in the repository will have this mode value. '0xxx' will override
Junio C Hamano83eded12009-04-20 08:18:00652user's umask value (whereas the other options will only override
653requested parts of the user's umask value). Examples: '0660' will make
654the repo read/write-able for the owner and group, but inaccessible to
655others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Junio C Hamano2f102bb2008-04-26 02:23:37656repository that is group-readable but not group-writable.
657See linkgit:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54658
659core.warnAmbiguousRefs::
Junio C Hamano076ffcc2013-02-06 05:13:21660If true, Git will warn you if the ref name you passed it is ambiguous
Junio C Hamano947ab822013-03-19 23:07:29661and might match multiple refs in the repository. True by default.
Junio C Hamano07824ce2006-04-25 07:36:54662
Junio C Hamano7ec15722006-07-07 02:03:59663core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09664An integer -1..9, indicating a default compression level.
665-1 is the zlib default. 0 means no compression,
666and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42667If set, this provides a default to other compression variables,
Junio C Hamano042f2142016-06-27 18:05:05668such as `core.looseCompression` and `pack.compression`.
Junio C Hamanoa126a3b2006-07-04 04:55:26669
Junio C Hamano322c6242015-03-23 21:32:46670core.looseCompression::
Junio C Hamanof2ce2972007-05-20 19:12:09671An integer -1..9, indicating the compression level for objects that
672are not in a pack file. -1 is the zlib default. 0 means no
673compression, and 1..9 are various speed/size tradeoffs, 9 being
674slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42675not set, defaults to 1 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49676
Junio C Hamanofc4d38c2007-01-08 06:53:32677core.packedGitWindowSize::
678Number of bytes of a pack file to map into memory in a
679single mapping operation. Larger window sizes may allow
680your system to process a smaller number of large pack files
681more quickly. Smaller window sizes will negatively affect
682performance due to increased calls to the operating system's
683memory manager, but may improve performance when accessing
684a large number of large pack files.
685+
686Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
687MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
688be reasonable for all users/operating systems. You probably do
689not need to adjust this value.
690+
691Common unit suffixes of 'k', 'm', or 'g' are supported.
692
693core.packedGitLimit::
694Maximum number of bytes to map simultaneously into memory
695from pack files. If Git needs to access more than this many
696bytes at once to complete an operation it will unmap existing
697regions to reclaim virtual address space within the process.
698+
Junio C Hamano967cda72017-06-30 21:49:53699Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
700unlimited) on 64 bit platforms.
Junio C Hamanofc4d38c2007-01-08 06:53:32701This should be reasonable for all users/operating systems, except on
702the largest projects. You probably do not need to adjust this value.
703+
704Common unit suffixes of 'k', 'm', or 'g' are supported.
705
Junio C Hamanob8c51282007-03-19 10:43:30706core.deltaBaseCacheLimit::
707Maximum number of bytes to reserve for caching base objects
Junio C Hamano619596a2010-08-18 22:15:35708that may be referenced by multiple deltified objects. By storing the
Junio C Hamanob8c51282007-03-19 10:43:30709entire decompressed base objects in a cache Git is able
710to avoid unpacking and decompressing frequently used base
711objects multiple times.
712+
Junio C Hamanoe1aeb5e2014-06-06 19:16:29713Default is 96 MiB on all platforms. This should be reasonable
Junio C Hamanob8c51282007-03-19 10:43:30714for all users/operating systems, except on the largest projects.
715You probably do not need to adjust this value.
716+
717Common unit suffixes of 'k', 'm', or 'g' are supported.
718
Junio C Hamano5c246f22010-02-03 07:34:53719core.bigFileThreshold::
720Files larger than this size are stored deflated, without
721attempting delta compression. Storing large files without
722delta compression avoids excessive memory usage, at the
Junio C Hamano8e61f1f2014-09-11 21:53:45723slight expense of increased disk usage. Additionally files
724larger than this size are always treated as binary.
Junio C Hamano5c246f22010-02-03 07:34:53725+
726Default is 512 MiB on all platforms. This should be reasonable
727for most projects as source code and other text files can still
728be delta compressed, but larger binary media files won't be.
729+
730Common unit suffixes of 'k', 'm', or 'g' are supported.
Junio C Hamano5c246f22010-02-03 07:34:53731
Junio C Hamano322c6242015-03-23 21:32:46732core.excludesFile::
Junio C Hamano198b1f12016-05-17 22:27:24733Specifies the pathname to the file that contains patterns to
734describe paths that are not meant to be tracked, in addition
735to '.gitignore' (per-directory) and '.git/info/exclude'.
736Defaults to `$XDG_CONFIG_HOME/git/ignore`.
737If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
Junio C Hamano8edb4c72012-07-09 20:33:55738is used instead. See linkgit:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37739
Junio C Hamano322c6242015-03-23 21:32:46740core.askPass::
Junio C Hamano3fd7b262010-09-08 22:44:20741Some commands (e.g. svn and http interfaces) that interactively
742ask for a password can be told to use an external program given
Junio C Hamano042f2142016-06-27 18:05:05743via the value of this variable. Can be overridden by the `GIT_ASKPASS`
Junio C Hamano3fd7b262010-09-08 22:44:20744environment variable. If not set, fall back to the value of the
Junio C Hamano042f2142016-06-27 18:05:05745`SSH_ASKPASS` environment variable or, failing that, a simple password
Junio C Hamano3fd7b262010-09-08 22:44:20746prompt. The external program shall be given a suitable prompt as
Junio C Hamanoe1aeb5e2014-06-06 19:16:29747command-line argument and write the password on its STDOUT.
Junio C Hamano3fd7b262010-09-08 22:44:20748
Junio C Hamano322c6242015-03-23 21:32:46749core.attributesFile::
Junio C Hamano3b4609d2010-09-30 00:04:34750In addition to '.gitattributes' (per-directory) and
Junio C Hamano076ffcc2013-02-06 05:13:21751'.git/info/attributes', Git looks into this file for attributes
Junio C Hamano3b4609d2010-09-30 00:04:34752(see linkgit:gitattributes[5]). Path expansions are made the same
Junio C Hamano322c6242015-03-23 21:32:46753way as for `core.excludesFile`. Its default value is
Junio C Hamano198b1f12016-05-17 22:27:24754`$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
755set or empty, `$HOME/.config/git/attributes` is used instead.
756
757core.hooksPath::
758By default Git will look for your hooks in the
759'$GIT_DIR/hooks' directory. Set this to different path,
760e.g. '/etc/git/hooks', and Git will try to find your hooks in
761that directory, e.g. '/etc/git/hooks/pre-receive' instead of
762in '$GIT_DIR/hooks/pre-receive'.
763+
764The path can be either absolute or relative. A relative path is
765taken as relative to the directory where the hooks are run (see
766the "DESCRIPTION" section of linkgit:githooks[5]).
767+
768This configuration variable is useful in cases where you'd like to
769centrally configure your Git hooks instead of configuring them on a
770per-repository basis, or as a more flexible and centralized
771alternative to having an `init.templateDir` where you've changed
772default hooks.
Junio C Hamano3b4609d2010-09-30 00:04:34773
Junio C Hamanof6002a92007-07-20 10:28:22774core.editor::
Junio C Hamano7ab74c42017-03-27 18:23:59775Commands such as `commit` and `tag` that let you edit
776messages by launching an editor use the value of this
Junio C Hamanof6002a92007-07-20 10:28:22777variable when it is set, and the environment variable
Junio C Hamano3b70d3c2009-11-21 17:37:37778`GIT_EDITOR` is not set. See linkgit:git-var[1].
Junio C Hamanof6002a92007-07-20 10:28:22779
Junio C Hamano322c6242015-03-23 21:32:46780core.commentChar::
Junio C Hamano7ab74c42017-03-27 18:23:59781Commands such as `commit` and `tag` that let you edit
Junio C Hamano3f2ed6f2013-02-04 19:24:09782messages consider a line that begins with this character
783commented, and removes them after the editor returns
784(default '#').
Junio C Hamanoe1aeb5e2014-06-06 19:16:29785+
786If set to "auto", `git-commit` would select a character that is not
787the beginning character of any line in existing commit messages.
Junio C Hamano3f2ed6f2013-02-04 19:24:09788
Junio C Hamanofb1fdf12017-08-27 06:14:59789core.filesRefLockTimeout::
790The length of time, in milliseconds, to retry when trying to
791lock an individual reference. Value 0 means not to retry at
792all; -1 means to try indefinitely. Default is 100 (i.e.,
793retry for 100ms).
794
Junio C Hamano1dbca522015-05-22 20:48:55795core.packedRefsTimeout::
796The length of time, in milliseconds, to retry when trying to
797lock the `packed-refs` file. Value 0 means not to retry at
798all; -1 means to try indefinitely. Default is 1000 (i.e.,
799retry for 1 second).
800
Junio C Hamano6231f822011-10-24 05:18:52801sequence.editor::
Junio C Hamano778a3412013-03-28 23:24:30802Text editor used by `git rebase -i` for editing the rebase instruction file.
Junio C Hamano6231f822011-10-24 05:18:52803The value is meant to be interpreted by the shell when it is used.
804It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
805When not configured the default commit message editor is used instead.
806
Junio C Hamano28d8ede2007-07-05 05:51:38807core.pager::
Junio C Hamano0e0e0d22013-09-12 23:25:03808Text viewer for use by Git commands (e.g., 'less'). The value
809is meant to be interpreted by the shell. The order of preference
810is the `$GIT_PAGER` environment variable, then `core.pager`
811configuration, then `$PAGER`, and then the default chosen at
812compile time (usually 'less').
813+
Junio C Hamanoe1aeb5e2014-06-06 19:16:29814When the `LESS` environment variable is unset, Git sets it to `FRX`
Junio C Hamano0e0e0d22013-09-12 23:25:03815(if `LESS` environment variable is set, Git does not change it at
816all). If you want to selectively override Git's default setting
Junio C Hamanoe1aeb5e2014-06-06 19:16:29817for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
Junio C Hamano0e0e0d22013-09-12 23:25:03818be passed to the shell by Git, which will translate the final
Junio C Hamanoe1aeb5e2014-06-06 19:16:29819command to `LESS=FRX less -S`. The environment does not set the
820`S` option but the command line does, instructing less to truncate
821long lines. Similarly, setting `core.pager` to `less -+F` will
822deactivate the `F` option specified by the environment from the
823command-line, deactivating the "quit if one screen" behavior of
824`less`. One can specifically activate some flags for particular
825commands: for example, setting `pager.blame` to `less -S` enables
826line truncation only for `git blame`.
Junio C Hamanobc8d4782014-01-13 23:35:50827+
828Likewise, when the `LV` environment variable is unset, Git sets it
829to `-c`. You can override this setting by exporting `LV` with
830another value or setting `core.pager` to `lv +c`.
Junio C Hamano28d8ede2007-07-05 05:51:38831
Junio C Hamano942b35e2007-12-09 10:19:33832core.whitespace::
833A comma separated list of common whitespace problems to
Junio C Hamano1aa40d22010-01-21 17:46:43834notice. 'git diff' will use `color.diff.whitespace` to
835highlight them, and 'git apply --whitespace=error' will
Junio C Hamano3db8b412008-07-26 06:45:59836consider them as errors. You can prefix `-` to disable
837any of them (e.g. `-trailing-space`):
Junio C Hamano942b35e2007-12-09 10:19:33838+
Junio C Hamanob71a22d2009-10-17 08:23:47839* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano942b35e2007-12-09 10:19:33840 as an error (enabled by default).
841* `space-before-tab` treats a space character that appears immediately
842 before a tab character in the initial indent part of the line as an
843 error (enabled by default).
Junio C Hamano281fd392012-09-17 23:57:41844* `indent-with-non-tab` treats a line that is indented with space
845 characters instead of the equivalent tabs as an error (not enabled by
846 default).
Junio C Hamanocb39aea2010-05-09 07:24:48847* `tab-in-indent` treats a tab character in the initial indent part of
848 the line as an error (not enabled by default).
Junio C Hamanob71a22d2009-10-17 08:23:47849* `blank-at-eof` treats blank lines added at the end of file as an error
850 (enabled by default).
851* `trailing-space` is a short-hand to cover both `blank-at-eol` and
852 `blank-at-eof`.
Junio C Hamano601f3e52008-02-25 08:40:42853* `cr-at-eol` treats a carriage-return at the end of line as
854 part of the line terminator, i.e. with it, `trailing-space`
855 does not trigger if the character before such a carriage-return
856 is not a whitespace (not enabled by default).
Junio C Hamanoeef01fe2010-12-13 08:31:58857* `tabwidth=<n>` tells how many character positions a tab occupies; this
Junio C Hamano076ffcc2013-02-06 05:13:21858 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
Junio C Hamanoeef01fe2010-12-13 08:31:58859 errors. The default tab width is 8. Allowed values are 1 to 63.
Junio C Hamano942b35e2007-12-09 10:19:33860
Junio C Hamano322c6242015-03-23 21:32:46861core.fsyncObjectFiles::
Junio C Hamano9eb57532008-06-26 06:33:46862This boolean will enable 'fsync()' when writing object files.
863+
864This is a total waste of time and effort on a filesystem that orders
865data writes properly, but can be useful for filesystems that do not use
866journalling (traditional UNIX filesystems) or that only journal metadata
867and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
868
Junio C Hamano322c6242015-03-23 21:32:46869core.preloadIndex::
Junio C Hamano610d1762008-11-28 06:27:13870Enable parallel index preload for operations like 'git diff'
871+
872This can speed up operations like 'git diff' and 'git status' especially
873on filesystems like NFS that have weak caching semantics and thus
Junio C Hamanoc8c398a2014-06-16 21:14:05874relatively high IO latencies. When enabled, Git will do the
Junio C Hamano610d1762008-11-28 06:27:13875index comparison to the filesystem data in parallel, allowing
Junio C Hamanoc8c398a2014-06-16 21:14:05876overlapping IO's. Defaults to true.
Junio C Hamano610d1762008-11-28 06:27:13877
Junio C Hamanoa9499de2009-04-30 03:38:48878core.createObject::
879You can set this to 'link', in which case a hardlink followed by
880a delete of the source are used to make sure that object creation
881will not overwrite existing objects.
882+
883On some file system/operating system combinations, this is unreliable.
884Set this config setting to 'rename' there; However, This will remove the
885check that makes sure that existing object files will not get overwritten.
Junio C Hamanoe91ea772009-04-26 01:41:41886
Junio C Hamano3b70d3c2009-11-21 17:37:37887core.notesRef::
888When showing commit messages, also show notes which are stored in
Junio C Hamanoa574a092010-06-13 19:57:10889the given ref. The ref must be fully qualified. If the given
890ref does not exist, it is not an error but means that no
891notes should be printed.
Junio C Hamano3b70d3c2009-11-21 17:37:37892+
Junio C Hamanoa574a092010-06-13 19:57:10893This setting defaults to "refs/notes/commits", and it can be overridden by
Junio C Hamano042f2142016-06-27 18:05:05894the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
Junio C Hamano3b70d3c2009-11-21 17:37:37895
Junio C Hamano3c8d6702010-01-13 23:09:03896core.sparseCheckout::
897Enable "sparse checkout" feature. See section "Sparse checkout" in
898linkgit:git-read-tree[1] for more information.
899
Junio C Hamano6371b0e2011-03-23 23:36:21900core.abbrev::
Junio C Hamano56ace3d2017-01-10 23:43:41901Set the length object names are abbreviated to. If
902unspecified or set to "auto", an appropriate value is
903computed based on the approximate number of packed objects
904in your repository, which hopefully is enough for
905abbreviated object names to stay unique for some time.
Junio C Hamanoe0e20df2017-06-04 02:10:21906The minimum length is 4.
Junio C Hamano6371b0e2011-03-23 23:36:21907
Junio C Hamano60186642010-12-02 14:18:26908add.ignoreErrors::
Junio C Hamanobe087982015-02-22 21:29:39909add.ignore-errors (deprecated)::
Junio C Hamano1aa40d22010-01-21 17:46:43910Tells 'git add' to continue adding files when some files cannot be
Junio C Hamano92d80372016-07-13 22:00:05911added due to indexing errors. Equivalent to the `--ignore-errors`
Junio C Hamanobe087982015-02-22 21:29:39912option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
913as it does not follow the usual naming convention for configuration
914variables.
Junio C Hamano3d141512009-06-01 01:22:40915
Junio C Hamano33db4372006-06-07 19:51:45916alias.*::
Junio C Hamano35738e82008-01-07 07:55:46917Command aliases for the linkgit:git[1] command wrapper - e.g.
Junio C Hamano33db4372006-06-07 19:51:45918after defining "alias.last = cat-file commit HEAD", the invocation
919"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17920confusion and troubles with script usage, aliases that
Junio C Hamano076ffcc2013-02-06 05:13:21921hide existing Git commands are ignored. Arguments are split by
Junio C Hamanof1d14802006-06-08 00:48:17922spaces, the usual shell quoting and escaping is supported.
Junio C Hamano2efd5e42014-11-10 22:38:52923A quote pair or a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39924+
925If the alias expansion is prefixed with an exclamation point,
926it will be treated as a shell command. For example, defining
927"alias.new = !gitk --all --not ORIG_HEAD", the invocation
928"git new" is equivalent to running the shell command
Junio C Hamano48bc1ce2009-07-09 16:49:19929"gitk --all --not ORIG_HEAD". Note that shell commands will be
930executed from the top-level directory of a repository, which may
931not necessarily be the current directory.
Junio C Hamano042f2142016-06-27 18:05:05932`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
Junio C Hamano5f2627d2011-05-06 20:23:48933from the original current directory. See linkgit:git-rev-parse[1].
Junio C Hamano9cb74f22007-02-12 04:15:05934
Junio C Hamanocaa712a2010-03-11 01:17:35935am.keepcr::
936If true, git-am will call git-mailsplit for patches in mbox format
Junio C Hamano92d80372016-07-13 22:00:05937with parameter `--keep-cr`. In this case git-mailsplit will
Junio C Hamano619596a2010-08-18 22:15:35938not remove `\r` from lines ending with `\r\n`. Can be overridden
Junio C Hamano92d80372016-07-13 22:00:05939by giving `--no-keep-cr` from the command line.
Junio C Hamanocaa712a2010-03-11 01:17:35940See linkgit:git-am[1], linkgit:git-mailsplit[1].
941
Junio C Hamano9c512872015-08-12 21:59:25942am.threeWay::
943By default, `git am` will fail if the patch does not apply cleanly. When
944set to true, this setting tells `git am` to fall back on 3-way merge if
945the patch records the identity of blobs it is supposed to apply to and
946we have those blobs available locally (equivalent to giving the `--3way`
947option from the command line). Defaults to `false`.
948See linkgit:git-am[1].
949
Junio C Hamano322c6242015-03-23 21:32:46950apply.ignoreWhitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43951When set to 'change', tells 'git apply' to ignore changes in
Junio C Hamano92d80372016-07-13 22:00:05952whitespace, in the same way as the `--ignore-space-change`
Junio C Hamanofe24db02009-08-22 05:10:47953option.
Junio C Hamano1aa40d22010-01-21 17:46:43954When set to one of: no, none, never, false tells 'git apply' to
Junio C Hamanofe24db02009-08-22 05:10:47955respect all whitespace differences.
956See linkgit:git-apply[1].
957
Junio C Hamano07824ce2006-04-25 07:36:54958apply.whitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43959Tells 'git apply' how to handle whitespaces, in the same way
Junio C Hamano92d80372016-07-13 22:00:05960as the `--whitespace` option. See linkgit:git-apply[1].
Junio C Hamano07824ce2006-04-25 07:36:54961
Junio C Hamano3a9c0342017-11-10 06:01:12962blame.showRoot::
963Do not treat root commits as boundaries in linkgit:git-blame[1].
964This option defaults to false.
965
966blame.blankBoundary::
967Show blank commit object name for boundary commits in
968linkgit:git-blame[1]. This option defaults to false.
969
970blame.showEmail::
971Show the author email instead of author name in linkgit:git-blame[1].
972This option defaults to false.
973
974blame.date::
975Specifies the format used to output dates in linkgit:git-blame[1].
976If unset the iso format is used. For supported values,
977see the discussion of the `--date` option at linkgit:git-log[1].
978
Junio C Hamano322c6242015-03-23 21:32:46979branch.autoSetupMerge::
Junio C Hamano1aa40d22010-01-21 17:46:43980Tells 'git branch' and 'git checkout' to set up new branches
Junio C Hamano24bc09a2008-02-28 00:27:44981so that linkgit:git-pull[1] will appropriately merge from the
982starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32983this behavior can be chosen per-branch using the `--track`
Junio C Hamano24bc09a2008-02-28 00:27:44984and `--no-track` options. The valid settings are: `false` -- no
985automatic setup is done; `true` -- automatic setup is done when the
Junio C Hamano97bcb482010-11-25 03:16:07986starting point is a remote-tracking branch; `always` --
987automatic setup is done when the starting point is either a
988local branch or remote-tracking
Junio C Hamano24bc09a2008-02-28 00:27:44989branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32990
Junio C Hamano322c6242015-03-23 21:32:46991branch.autoSetupRebase::
Junio C Hamano1aa40d22010-01-21 17:46:43992When a new branch is created with 'git branch' or 'git checkout'
Junio C Hamano076ffcc2013-02-06 05:13:21993that tracks another branch, this variable tells Git to set
Junio C Hamano869bb802008-05-12 00:29:47994up pull to rebase instead of merge (see "branch.<name>.rebase").
995When `never`, rebase is never automatically set to true.
996When `local`, rebase is set to true for tracked branches of
997other local branches.
998When `remote`, rebase is set to true for tracked branches of
Junio C Hamano97bcb482010-11-25 03:16:07999remote-tracking branches.
Junio C Hamano869bb802008-05-12 00:29:471000When `always`, rebase will be set to true for all tracking
1001branches.
Junio C Hamano322c6242015-03-23 21:32:461002See "branch.autoSetupMerge" for details on how to set up a
Junio C Hamano869bb802008-05-12 00:29:471003branch to track another branch.
1004This option defaults to never.
1005
Junio C Hamano47c1e3c2006-09-25 04:45:551006branch.<name>.remote::
Junio C Hamano63b6fdb2013-04-07 23:37:131007When on branch <name>, it tells 'git fetch' and 'git push'
1008which remote to fetch from/push to. The remote to push to
Junio C Hamano322c6242015-03-23 21:32:461009may be overridden with `remote.pushDefault` (for all branches).
Junio C Hamano63b6fdb2013-04-07 23:37:131010The remote to push to, for the current branch, may be further
Junio C Hamano322c6242015-03-23 21:32:461011overridden by `branch.<name>.pushRemote`. If no remote is
Junio C Hamano63b6fdb2013-04-07 23:37:131012configured, or if you are not on any branch, it defaults to
Junio C Hamano322c6242015-03-23 21:32:461013`origin` for fetching and `remote.pushDefault` for pushing.
Junio C Hamano238ce9c2013-10-23 21:56:381014Additionally, `.` (a period) is the current local repository
1015(a dot-repository), see `branch.<name>.merge`'s final note below.
Junio C Hamano63b6fdb2013-04-07 23:37:131016
Junio C Hamano322c6242015-03-23 21:32:461017branch.<name>.pushRemote::
Junio C Hamano63b6fdb2013-04-07 23:37:131018When on branch <name>, it overrides `branch.<name>.remote` for
Junio C Hamano322c6242015-03-23 21:32:461019pushing. It also overrides `remote.pushDefault` for pushing
Junio C Hamano63b6fdb2013-04-07 23:37:131020from branch <name>. When you pull from one place (e.g. your
1021upstream) and push to another place (e.g. your own publishing
Junio C Hamano322c6242015-03-23 21:32:461022repository), you would want to set `remote.pushDefault` to
Junio C Hamano63b6fdb2013-04-07 23:37:131023specify the remote to push to for all branches, and use this
1024option to override it for a specific branch.
Junio C Hamano47c1e3c2006-09-25 04:45:551025
1026branch.<name>.merge::
Junio C Hamano0706c802009-03-30 22:34:191027Defines, together with branch.<name>.remote, the upstream branch
Junio C Hamanob02377c2011-04-28 22:26:021028for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
Junio C Hamano1aa40d22010-01-21 17:46:431029branch to merge and can also affect 'git push' (see push.default).
1030When in branch <name>, it tells 'git fetch' the default
Junio C Hamanoc2b47092007-10-25 06:50:311031refspec to be marked for merging in FETCH_HEAD. The value is
1032handled like the remote part of a refspec, and must match a
1033ref which is fetched from the remote given by
1034"branch.<name>.remote".
Junio C Hamano1aa40d22010-01-21 17:46:431035The merge information is used by 'git pull' (which at first calls
1036'git fetch') to lookup the default branch for merging. Without
1037this option, 'git pull' defaults to merge the first refspec fetched.
Junio C Hamano96010b22006-12-09 21:15:461038Specify multiple values to get an octopus merge.
Junio C Hamano1aa40d22010-01-21 17:46:431039If you wish to setup 'git pull' so that it merges into <name> from
Junio C Hamano6e149c02007-03-16 10:21:071040another branch in the local repository, you can point
Junio C Hamano238ce9c2013-10-23 21:56:381041branch.<name>.merge to the desired branch, and use the relative path
1042setting `.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:551043
Junio C Hamano322c6242015-03-23 21:32:461044branch.<name>.mergeOptions::
Junio C Hamano1b50ce92007-10-03 12:05:531045Sets default options for merging into branch <name>. The syntax and
Junio C Hamanoc0e55e72009-10-10 00:56:291046supported options are the same as those of linkgit:git-merge[1], but
Junio C Hamano1b50ce92007-10-03 12:05:531047option values containing whitespace characters are currently not
1048supported.
1049
Junio C Hamano0c999702007-12-03 09:57:551050branch.<name>.rebase::
1051When true, rebase the branch <name> on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:081052instead of merging the default branch from the default remote when
Junio C Hamano515ab1d2011-12-09 23:41:201053"git pull" is run. See "pull.rebase" for doing this in a non
1054branch-specific manner.
1055+
Junio C Hamano7db630e2015-09-17 20:26:221056When preserve, also pass `--preserve-merges` along to 'git rebase'
1057so that locally committed merge commits will not be flattened
1058by running 'git pull'.
Junio C Hamanocf4a1742013-09-11 22:57:501059+
Junio C Hamano289d7e82016-01-27 00:20:381060When the value is `interactive`, the rebase is run in interactive mode.
1061+
Junio C Hamano515ab1d2011-12-09 23:41:201062*NOTE*: this is a possibly dangerous operation; do *not* use
1063it unless you understand the implications (see linkgit:git-rebase[1]
1064for details).
Junio C Hamano0c999702007-12-03 09:57:551065
Junio C Hamano46247182013-01-09 20:50:281066branch.<name>.description::
1067Branch description, can be edited with
1068`git branch --edit-description`. Branch description is
1069automatically added in the format-patch cover letter or
1070request-pull summary.
1071
Junio C Hamano8760ea62008-03-14 08:58:451072browser.<tool>.cmd::
1073Specify the command to invoke the specified browser. The
1074specified command is evaluated in shell with the URLs passed
Junio C Hamano360e3a12011-07-13 23:51:561075as arguments. (See linkgit:git-web{litdd}browse[1].)
Junio C Hamano8760ea62008-03-14 08:58:451076
Junio C Hamanoe35a6fc2008-01-29 09:46:271077browser.<tool>.path::
1078Override the path for the given tool that may be used to
Junio C Hamano92d80372016-07-13 22:00:051079browse HTML help (see `-w` option in linkgit:git-help[1]) or a
Junio C Hamanoe35a6fc2008-01-29 09:46:271080working repository in gitweb (see linkgit:git-instaweb[1]).
1081
Junio C Hamano47b9acd2007-04-24 07:34:341082clean.requireForce::
Junio C Hamanoe6f28d02013-09-17 21:34:001083A boolean to make git-clean do nothing unless given -f,
1084-i or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:341085
Junio C Hamanoeb692952007-01-03 22:02:121086color.branch::
1087A boolean to enable/disable color in the output of
Junio C Hamano5d4238d2017-10-18 03:01:151088linkgit:git-branch[1]. May be set to `always`,
1089`false` (or `never`) or `auto` (or `true`), in which case colors are used
1090only when the output is to a terminal. If unset, then the
1091value of `color.ui` is used (`auto` by default).
Junio C Hamanoeb692952007-01-03 22:02:121092
1093color.branch.<slot>::
1094Use customized color for branch coloration. `<slot>` is one of
1095`current` (the current branch), `local` (a local branch),
Junio C Hamano76927822013-04-19 21:26:571096`remote` (a remote-tracking branch in refs/remotes/),
1097`upstream` (upstream tracking branch), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:221098refs).
Junio C Hamanoeb692952007-01-03 22:02:121099
Junio C Hamano3f403b02006-12-13 10:14:131100color.diff::
Junio C Hamano5f2627d2011-05-06 20:23:481101Whether to use ANSI escape sequences to add color to patches.
Junio C Hamano5d4238d2017-10-18 03:01:151102If this is set to `always`, linkgit:git-diff[1],
Junio C Hamano5f2627d2011-05-06 20:23:481103linkgit:git-log[1], and linkgit:git-show[1] will use color
Junio C Hamano5d4238d2017-10-18 03:01:151104for all patches. If it is set to `true` or `auto`, those
1105commands will only use color when output is to the terminal.
1106If unset, then the value of `color.ui` is used (`auto` by
1107default).
Junio C Hamano5f2627d2011-05-06 20:23:481108+
Junio C Hamanod75148a2014-04-08 19:48:381109This does not affect linkgit:git-format-patch[1] or the
Junio C Hamano5f2627d2011-05-06 20:23:481110'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1111command line with the `--color[=<when>]` option.
Junio C Hamano9ae1a062006-07-10 08:12:341112
Junio C Hamanofb1fdf12017-08-27 06:14:591113diff.colorMoved::
1114If set to either a valid `<mode>` or a true value, moved lines
1115in a diff are colored differently, for details of valid modes
1116see '--color-moved' in linkgit:git-diff[1]. If simply set to
1117true the default color mode will be used. When set to false,
1118moved lines are not colored.
1119
Junio C Hamano3f403b02006-12-13 10:14:131120color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:221121Use customized color for diff colorization. `<slot>` specifies
1122which part of the patch to use the specified color, and is one
Junio C Hamano8c5d5942015-06-11 19:37:481123of `context` (context text - `plain` is a historical synonym),
1124`meta` (metainformation), `frag`
Junio C Hamano2bd8a742009-12-01 21:16:591125(hunk header), 'func' (function in hunk header), `old` (removed lines),
Junio C Hamanofb1fdf12017-08-27 06:14:591126`new` (added lines), `commit` (commit headers), `whitespace`
1127(highlighting whitespace errors), `oldMoved` (deleted lines),
1128`newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1129`oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1130and `newMovedAlternativeDimmed` (See the '<mode>'
1131setting of '--color-moved' in linkgit:git-diff[1] for details).
Junio C Hamano9ae1a062006-07-10 08:12:341132
Junio C Hamano7d449522010-07-01 00:08:511133color.decorate.<slot>::
1134Use customized color for 'git log --decorate' output. `<slot>` is one
1135of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
Junio C Hamano97bcb482010-11-25 03:16:071136branches, remote-tracking branches, tags, stash and HEAD, respectively.
Junio C Hamano7d449522010-07-01 00:08:511137
Junio C Hamanod257cff2009-03-18 05:27:161138color.grep::
1139When set to `always`, always highlight matches. When `false` (or
1140`never`), never. When set to `true` or `auto`, use color only
Junio C Hamanoad70bf02016-09-26 23:44:271141when the output is written to the terminal. If unset, then the
1142value of `color.ui` is used (`auto` by default).
Junio C Hamanod257cff2009-03-18 05:27:161143
Junio C Hamano0299d922010-03-20 20:59:311144color.grep.<slot>::
1145Use customized color for grep colorization. `<slot>` specifies which
1146part of the line to use the specified color, and is one of
1147+
1148--
1149`context`;;
1150non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1151`filename`;;
1152filename prefix (when not using `-h`)
1153`function`;;
1154function name lines (when using `-p`)
1155`linenumber`;;
1156line number prefix (when using `-n`)
1157`match`;;
Junio C Hamanoc14e6ad2014-10-31 20:25:531158matching text (same as setting `matchContext` and `matchSelected`)
1159`matchContext`;;
1160matching text in context lines
1161`matchSelected`;;
1162matching text in selected lines
Junio C Hamano0299d922010-03-20 20:59:311163`selected`;;
1164non-matching text in selected lines
1165`separator`;;
1166separators between fields on a line (`:`, `-`, and `=`)
1167and between hunks (`--`)
1168--
Junio C Hamanod257cff2009-03-18 05:27:161169
Junio C Hamano00b8b632007-12-07 09:50:491170color.interactive::
Junio C Hamano5d4238d2017-10-18 03:01:151171When set to `always`, always use colors for interactive prompts
Junio C Hamano58f587a2013-07-22 19:20:591172and displays (such as those used by "git-add --interactive" and
Junio C Hamano5d4238d2017-10-18 03:01:151173"git-clean --interactive"). When false (or `never`), never.
1174When set to `true` or `auto`, use colors only when the output is
1175to the terminal. If unset, then the value of `color.ui` is
1176used (`auto` by default).
Junio C Hamano00b8b632007-12-07 09:50:491177
1178color.interactive.<slot>::
Junio C Hamano58f587a2013-07-22 19:20:591179Use customized color for 'git add --interactive' and 'git clean
1180--interactive' output. `<slot>` may be `prompt`, `header`, `help`
1181or `error`, for four distinct types of normal output from
Junio C Hamano07622622015-03-20 21:47:261182interactive commands.
Junio C Hamano00b8b632007-12-07 09:50:491183
Junio C Hamanoe7935c42006-12-13 21:32:171184color.pager::
1185A boolean to enable/disable colored output when the pager is in
1186use (default is true).
1187
Junio C Hamano322c6242015-03-23 21:32:461188color.showBranch::
Junio C Hamano52ba2952009-05-18 17:43:021189A boolean to enable/disable color in the output of
1190linkgit:git-show-branch[1]. May be set to `always`,
1191`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoad70bf02016-09-26 23:44:271192only when the output is to a terminal. If unset, then the
1193value of `color.ui` is used (`auto` by default).
Junio C Hamano52ba2952009-05-18 17:43:021194
Junio C Hamanoe7935c42006-12-13 21:32:171195color.status::
1196A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:461197linkgit:git-status[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:211198`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoad70bf02016-09-26 23:44:271199only when the output is to a terminal. If unset, then the
1200value of `color.ui` is used (`auto` by default).
Junio C Hamanoe7935c42006-12-13 21:32:171201
1202color.status.<slot>::
1203Use customized color for status colorization. `<slot>` is
1204one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:041205`added` or `updated` (files which are added but not committed),
1206`changed` (files which are changed but not added in the index),
Junio C Hamano076ffcc2013-02-06 05:13:211207`untracked` (files which are not tracked by Git),
Junio C Hamano5992a252015-03-17 23:39:301208`branch` (the current branch),
Junio C Hamanob713ff12008-05-24 01:12:301209`nobranch` (the color the 'no branch' warning is shown in, defaulting
Junio C Hamanod5176902017-05-16 04:30:561210to red),
1211`localBranch` or `remoteBranch` (the local and remote branch names,
1212respectively, when branch and tracking information is displayed in the
1213status short-format), or
Junio C Hamano5992a252015-03-17 23:39:301214`unmerged` (files which have unmerged changes).
Junio C Hamanoe7935c42006-12-13 21:32:171215
Junio C Hamano83d46a22008-02-21 02:29:421216color.ui::
Junio C Hamano5f2627d2011-05-06 20:23:481217This variable determines the default value for variables such
1218as `color.diff` and `color.grep` that control the use of color
1219per command family. Its scope will expand as more commands learn
1220configuration to set a default for the `--color` option. Set it
Junio C Hamanofa1d3492013-06-20 23:39:431221to `false` or `never` if you prefer Git commands not to use
1222color unless enabled explicitly with some other configuration
Junio C Hamano5d4238d2017-10-18 03:01:151223or the `--color` option. Set it to `always` if you want all
1224output not intended for machine consumption to use color, to
1225`true` or `auto` (this is the default since Git 1.8.4) if you
1226want such output to use color when written to the terminal.
Junio C Hamano83d46a22008-02-21 02:29:421227
Junio C Hamano22700fb2012-05-03 23:07:251228column.ui::
1229Specify whether supported commands should output in columns.
1230This variable consists of a list of tokens separated by spaces
1231or commas:
1232+
Junio C Hamanoa1952302013-07-01 21:31:181233These options control when the feature should be enabled
1234(defaults to 'never'):
1235+
Junio C Hamano22700fb2012-05-03 23:07:251236--
1237`always`;;
1238always show in columns
1239`never`;;
1240never show in columns
1241`auto`;;
1242show in columns if the output is to the terminal
Junio C Hamanoa1952302013-07-01 21:31:181243--
1244+
1245These options control layout (defaults to 'column'). Setting any
1246of these implies 'always' if none of 'always', 'never', or 'auto' are
1247specified.
1248+
1249--
Junio C Hamano22700fb2012-05-03 23:07:251250`column`;;
Junio C Hamanoa1952302013-07-01 21:31:181251fill columns before rows
Junio C Hamano22700fb2012-05-03 23:07:251252`row`;;
1253fill rows before columns
1254`plain`;;
1255show in one column
Junio C Hamanoa1952302013-07-01 21:31:181256--
1257+
1258Finally, these options can be combined with a layout option (defaults
1259to 'nodense'):
1260+
1261--
Junio C Hamano22700fb2012-05-03 23:07:251262`dense`;;
1263make unequal size columns to utilize more space
1264`nodense`;;
1265make equal size columns
1266--
Junio C Hamano22700fb2012-05-03 23:07:251267
1268column.branch::
1269Specify whether to output branch listing in `git branch` in columns.
1270See `column.ui` for details.
1271
Junio C Hamano58f587a2013-07-22 19:20:591272column.clean::
1273Specify the layout when list items in `git clean -i`, which always
1274shows files and directories in columns. See `column.ui` for details.
1275
Junio C Hamano22700fb2012-05-03 23:07:251276column.status::
1277Specify whether to output untracked files in `git status` in columns.
1278See `column.ui` for details.
1279
1280column.tag::
1281Specify whether to output tag listing in `git tag` in columns.
1282See `column.ui` for details.
1283
Junio C Hamanoce836cc2013-01-21 02:01:531284commit.cleanup::
1285This setting overrides the default of the `--cleanup` option in
1286`git commit`. See linkgit:git-commit[1] for details. Changing the
1287default can be useful when you always want to keep lines that begin
1288with comment character `#` in your log message, in which case you
1289would do `git config commit.cleanup whitespace` (note that you will
1290have to remove the help lines that begin with `#` in the commit log
1291template yourself, if you do this).
1292
Junio C Hamano322c6242015-03-23 21:32:461293commit.gpgSign::
Junio C Hamano5b3533d2014-02-27 23:07:151294
1295A boolean to specify whether all commits should be GPG signed.
1296Use of this option when doing operations such as rebase can
1297result in a large number of commits being signed. It may be
1298convenient to use an agent to avoid typing your GPG passphrase
1299several times.
1300
Junio C Hamanod0d892c2010-01-24 20:06:291301commit.status::
Junio C Hamano6ce6b6c2010-01-18 01:25:501302A boolean to enable/disable inclusion of status information in the
1303commit message template when using an editor to prepare the commit
1304message. Defaults to true.
1305
Junio C Hamano4653c6f2008-11-26 22:50:201306commit.template::
Junio C Hamano198b1f12016-05-17 22:27:241307Specify the pathname of a file to use as the template for
1308new commit messages.
Junio C Hamano4653c6f2008-11-26 22:50:201309
Junio C Hamanof2a3a752016-05-23 22:54:391310commit.verbose::
1311A boolean or int to specify the level of verbose with `git commit`.
1312See linkgit:git-commit[1].
1313
Junio C Hamano0df92712011-12-21 22:30:441314credential.helper::
1315Specify an external helper to be called when a username or
1316password credential is needed; the helper may consult external
Junio C Hamano4ba4a782016-04-03 19:11:321317storage to avoid prompting the user for the credentials. Note
1318that multiple helpers may be defined. See linkgit:gitcredentials[7]
1319for details.
Junio C Hamano0df92712011-12-21 22:30:441320
1321credential.useHttpPath::
1322When acquiring credentials, consider the "path" component of an http
1323or https URL to be important. Defaults to false. See
1324linkgit:gitcredentials[7] for more information.
1325
1326credential.username::
1327If no username is set for a network authentication, use this username
1328by default. See credential.<context>.* below, and
1329linkgit:gitcredentials[7].
1330
1331credential.<url>.*::
1332Any of the credential.* options above can be applied selectively to
1333some credentials. For example "credential.https://example.com.username"
1334would set the default username only for https connections to
1335example.com. See linkgit:gitcredentials[7] for details on how URLs are
1336matched.
1337
Junio C Hamanoabb8a052015-12-04 22:43:111338credentialCache.ignoreSIGHUP::
1339Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1340
Junio C Hamano209ebe82011-04-27 21:09:591341include::diff-config.txt[]
Junio C Hamano3bd66e92009-04-18 06:17:561342
1343difftool.<tool>.path::
1344Override the path for the given tool. This is useful in case
1345your tool is not in the PATH.
1346
1347difftool.<tool>.cmd::
1348Specify the command to invoke the specified diff tool.
1349The specified command is evaluated in shell with the following
1350variables available: 'LOCAL' is set to the name of the temporary
1351file containing the contents of the diff pre-image and 'REMOTE'
1352is set to the name of the temporary file containing the contents
1353of the diff post-image.
1354
1355difftool.prompt::
1356Prompt before each invocation of the diff tool.
1357
Junio C Hamanofedb1b42016-06-20 21:23:401358fastimport.unpackLimit::
1359If the number of objects imported by linkgit:git-fast-import[1]
1360is below this limit, then the objects will be unpacked into
1361loose object files. However if the number of imported objects
1362equals or exceeds this limit then the pack will be stored as a
1363pack. Storing the pack from a fast-import can make the import
1364operation complete faster, especially on slow filesystems. If
1365not set, the value of `transfer.unpackLimit` is used instead.
1366
Junio C Hamano0d75e872010-12-17 06:57:261367fetch.recurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:101368This option can be either set to a boolean value or to 'on-demand'.
1369Setting it to a boolean changes the behavior of fetch and pull to
1370unconditionally recurse into submodules when set to true or to not
1371recurse at all when set to false. When set to 'on-demand' (the default
1372value), fetch and pull will only recurse into a populated submodule
1373when its superproject retrieves a commit that updates the submodule's
1374reference.
Junio C Hamano0d75e872010-12-17 06:57:261375
Junio C Hamano8fb66e52011-10-05 20:59:511376fetch.fsckObjects::
1377If it is set to true, git-fetch-pack will check all fetched
1378objects. It will abort in the case of a malformed object or a
1379broken link. The result of an abort are only dangling objects.
1380Defaults to false. If not set, the value of `transfer.fsckObjects`
1381is used instead.
1382
Junio C Hamano54ea8d32007-01-25 07:59:481383fetch.unpackLimit::
Junio C Hamano076ffcc2013-02-06 05:13:211384If the number of objects fetched over the Git native
Junio C Hamano54ea8d32007-01-25 07:59:481385transfer is below this
1386limit, then the objects will be unpacked into loose object
1387files. However if the number of received objects equals or
1388exceeds this limit then the received pack will be stored as
1389a pack, after adding any missing delta bases. Storing the
1390pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:171391especially on slow filesystems. If not set, the value of
1392`transfer.unpackLimit` is used instead.
Junio C Hamano54ea8d32007-01-25 07:59:481393
Junio C Hamano8eac2682013-09-09 22:35:201394fetch.prune::
1395If true, fetch will automatically behave as if the `--prune`
1396option was given on the command line. See also `remote.<name>.prune`.
1397
Junio C Hamano1a1b8472016-07-19 21:37:131398fetch.output::
1399Control how ref update status is printed. Valid values are
1400`full` and `compact`. Default value is `full`. See section
1401OUTPUT in linkgit:git-fetch[1] for detail.
1402
Junio C Hamanof4581102009-04-25 08:29:591403format.attach::
1404Enable multipart/mixed attachments as the default for
1405'format-patch'. The value can also be a double quoted string
1406which will enable attachments as the default and set the
1407value as the boundary. See the --attach option in
1408linkgit:git-format-patch[1].
1409
Junio C Hamanoaf182942016-08-10 20:46:261410format.from::
1411Provides the default value for the `--from` option to format-patch.
1412Accepts a boolean value, or a name and email address. If false,
1413format-patch defaults to `--no-from`, using commit authors directly in
1414the "From:" field of patch mails. If true, format-patch defaults to
1415`--from`, using your committer identity in the "From:" field of patch
1416mails and including a "From:" field in the body of the patch mail if
1417different. If set to a non-boolean value, format-patch uses that
1418value instead of your committer identity. Defaults to false.
1419
Junio C Hamano8c5802d2007-11-15 00:13:361420format.numbered::
Junio C Hamano7d06a8a2008-10-20 05:42:331421A boolean which can enable or disable sequence numbers in patch
1422subjects. It defaults to "auto" which enables it only if there
1423is more than one patch. It can be enabled or disabled for all
1424messages by setting it to "true" or "false". See --numbered
1425option in linkgit:git-format-patch[1].
Junio C Hamano8c5802d2007-11-15 00:13:361426
Junio C Hamano07824ce2006-04-25 07:36:541427format.headers::
1428Additional email headers to include in a patch to be submitted
Junio C Hamano35738e82008-01-07 07:55:461429by mail. See linkgit:git-format-patch[1].
Junio C Hamano07824ce2006-04-25 07:36:541430
Junio C Hamano70664a02010-07-13 22:48:051431format.to::
Junio C Hamanof4581102009-04-25 08:29:591432format.cc::
Junio C Hamano70664a02010-07-13 22:48:051433Additional recipients to include in a patch to be submitted
1434by mail. See the --to and --cc options in
1435linkgit:git-format-patch[1].
Junio C Hamanof4581102009-04-25 08:29:591436
Junio C Hamano322c6242015-03-23 21:32:461437format.subjectPrefix::
Junio C Hamanof4581102009-04-25 08:29:591438The default for format-patch is to output files with the '[PATCH]'
1439subject prefix. Use this variable to change that prefix.
1440
Junio C Hamano89a57342010-06-22 23:22:551441format.signature::
1442The default for format-patch is to output a signature containing
Junio C Hamano076ffcc2013-02-06 05:13:211443the Git version number. Use this variable to change that default.
Junio C Hamano89a57342010-06-22 23:22:551444Set this variable to the empty string ("") to suppress
1445signature generation.
1446
Junio C Hamano322c6242015-03-23 21:32:461447format.signatureFile::
Junio C Hamanoc8c398a2014-06-16 21:14:051448Works just like format.signature except the contents of the
1449file specified by this variable will be used as the signature.
1450
Junio C Hamanod4c8e112007-03-04 10:32:381451format.suffix::
1452The default for format-patch is to output files with the suffix
1453`.patch`. Use this variable to change that suffix (make sure to
1454include the dot if you want it).
1455
Junio C Hamano86bcccc2008-03-08 09:33:551456format.pretty::
1457The default pretty format for log/show/whatchanged command,
1458See linkgit:git-log[1], linkgit:git-show[1],
1459linkgit:git-whatchanged[1].
1460
Junio C Hamanoea6a7642009-03-11 23:56:191461format.thread::
Junio C Hamano1aa40d22010-01-21 17:46:431462The default threading style for 'git format-patch'. Can be
Junio C Hamanob141a922010-01-10 19:55:141463a boolean value, or `shallow` or `deep`. `shallow` threading
1464makes every mail a reply to the head of the series,
Junio C Hamanoea6a7642009-03-11 23:56:191465where the head is chosen from the cover letter, the
Junio C Hamanob76a6862012-05-02 22:02:461466`--in-reply-to`, and the first patch mail, in this order.
Junio C Hamanof4581102009-04-25 08:29:591467`deep` threading makes every mail a reply to the previous one.
Junio C Hamanoea6a7642009-03-11 23:56:191468A true boolean value is the same as `shallow`, and a false
1469value disables threading.
1470
Junio C Hamano322c6242015-03-23 21:32:461471format.signOff::
Junio C Hamano804a9742013-04-28 23:10:311472A boolean value which lets you enable the `-s/--signoff` option of
1473format-patch by default. *Note:* Adding the Signed-off-by: line to a
1474patch should be a conscious act and means that you certify you have
1475the rights to submit this work under the same open source license.
1476Please see the 'SubmittingPatches' document for further discussion.
Junio C Hamano5f9a6f02009-04-06 08:26:561477
Junio C Hamanoea3b7522013-04-18 19:37:531478format.coverLetter::
1479A boolean that controls whether to generate a cover-letter when
1480format-patch is invoked, but in addition can be set to "auto", to
1481generate a cover-letter only when there's more than one patch.
1482
Junio C Hamano289d7e82016-01-27 00:20:381483format.outputDirectory::
1484Set a custom directory to store the resulting files instead of the
1485current working directory.
1486
Junio C Hamanof2a3a752016-05-23 22:54:391487format.useAutoBase::
1488A boolean value which lets you enable the `--base=auto` option of
1489format-patch by default.
1490
Junio C Hamano209ebe82011-04-27 21:09:591491filter.<driver>.clean::
1492The command which is used to convert the content of a worktree
1493file to a blob upon checkin. See linkgit:gitattributes[5] for
1494details.
1495
1496filter.<driver>.smudge::
1497The command which is used to convert the content of a blob
1498object to a worktree file upon checkout. See
1499linkgit:gitattributes[5] for details.
1500
Junio C Hamanod7ed4042015-08-03 19:43:001501fsck.<msg-id>::
1502Allows overriding the message type (error, warn or ignore) of a
1503specific message ID such as `missingEmail`.
1504+
1505For convenience, fsck prefixes the error/warning with the message ID,
1506e.g. "missingEmail: invalid author/committer line - missing email" means
1507that setting `fsck.missingEmail = ignore` will hide that issue.
1508+
1509This feature is intended to support working with legacy repositories
1510which cannot be repaired without disruptive changes.
1511
1512fsck.skipList::
1513The path to a sorted list of object names (i.e. one SHA-1 per
1514line) that are known to be broken in a non-fatal way and should
1515be ignored. This feature is useful when an established project
1516should be accepted despite early commits containing errors that
1517can be safely ignored such as invalid committer email addresses.
1518Note: corrupt objects cannot be skipped with this setting.
1519
Junio C Hamano624dd4c2014-04-03 21:56:301520gc.aggressiveDepth::
1521The depth parameter used in the delta compression
1522algorithm used by 'git gc --aggressive'. This defaults
Junio C Hamano53800482016-09-21 23:26:431523to 50.
Junio C Hamano624dd4c2014-04-03 21:56:301524
Junio C Hamanof2ce2972007-05-20 19:12:091525gc.aggressiveWindow::
1526The window size parameter used in the delta compression
Junio C Hamano1aa40d22010-01-21 17:46:431527algorithm used by 'git gc --aggressive'. This defaults
Junio C Hamanob04bb3f2010-04-14 14:07:361528to 250.
Junio C Hamanof2ce2972007-05-20 19:12:091529
Junio C Hamano1b50ce92007-10-03 12:05:531530gc.auto::
1531When there are approximately more than this many loose
1532objects in the repository, `git gc --auto` will pack them.
1533Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:171534light-weight garbage collection from time to time. The
1535default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531536
Junio C Hamano322c6242015-03-23 21:32:461537gc.autoPackLimit::
Junio C Hamano1b50ce92007-10-03 12:05:531538When there are more than this many packs that are not
1539marked with `*.keep` file in the repository, `git gc
Junio C Hamanoe77b0152008-01-12 06:44:171540--auto` consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:371541default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531542
Junio C Hamano322c6242015-03-23 21:32:461543gc.autoDetach::
Junio C Hamanofb5ffde2014-11-04 22:38:561544Make `git gc --auto` return immediately and run in background
Junio C Hamano08ef8c22014-03-10 14:53:441545if the system supports it. Default is true.
1546
Junio C Hamanocbe0eb22017-02-27 23:37:491547gc.logExpiry::
1548If the file gc.log exists, then `git gc --auto` won't run
1549unless that file is more than 'gc.logExpiry' old. Default is
1550"1.day". See `gc.pruneExpire` for more ways to specify its
1551value.
1552
Junio C Hamano322c6242015-03-23 21:32:461553gc.packRefs::
Junio C Hamanob141a922010-01-10 19:55:141554Running `git pack-refs` in a repository renders it
1555unclonable by Git versions prior to 1.5.1.2 over dumb
1556transports such as HTTP. This variable determines whether
Junio C Hamanocdd1c332010-12-20 10:08:001557'git gc' runs `git pack-refs`. This can be set to `notbare`
Junio C Hamanob141a922010-01-10 19:55:141558to enable it within all non-bare repos or it can be set to a
1559boolean value. The default is `true`.
Junio C Hamano9d52e572007-02-13 23:48:201560
Junio C Hamano322c6242015-03-23 21:32:461561gc.pruneExpire::
Junio C Hamano1aa40d22010-01-21 17:46:431562When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
Junio C Hamanoa3148f52009-01-14 08:49:571563Override the grace period with this config variable. The value
Junio C Hamano9c512872015-08-12 21:59:251564"now" may be used to disable this grace period and always prune
1565unreachable objects immediately, or "never" may be used to
Junio C Hamano56ace3d2017-01-10 23:43:411566suppress pruning. This feature helps prevent corruption when
1567'git gc' runs concurrently with another process writing to the
1568repository; see the "NOTES" section of linkgit:git-gc[1].
Junio C Hamano09a926d2008-03-13 07:55:291569
Junio C Hamano9c512872015-08-12 21:59:251570gc.worktreePruneExpire::
1571When 'git gc' is run, it calls
1572'git worktree prune --expire 3.months.ago'.
1573This config variable can be used to set a different grace
1574period. The value "now" may be used to disable the grace
Junio C Hamano198b1f12016-05-17 22:27:241575period and prune `$GIT_DIR/worktrees` immediately, or "never"
Junio C Hamano9c512872015-08-12 21:59:251576may be used to suppress pruning.
Junio C Hamano4cc4a842015-05-11 22:41:021577
Junio C Hamano322c6242015-03-23 21:32:461578gc.reflogExpire::
1579gc.<pattern>.reflogExpire::
Junio C Hamano1aa40d22010-01-21 17:46:431580'git reflog expire' removes reflog entries older than
Junio C Hamano9c512872015-08-12 21:59:251581this time; defaults to 90 days. The value "now" expires all
1582entries immediately, and "never" suppresses expiration
1583altogether. With "<pattern>" (e.g.
Junio C Hamanocc7636a2010-05-21 14:57:531584"refs/stash") in the middle the setting applies only to
1585the refs that match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551586
Junio C Hamano322c6242015-03-23 21:32:461587gc.reflogExpireUnreachable::
Junio C Hamanoa1746be2015-08-26 23:07:071588gc.<pattern>.reflogExpireUnreachable::
Junio C Hamano1aa40d22010-01-21 17:46:431589'git reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:551590this time and are not reachable from the current tip;
Junio C Hamano9c512872015-08-12 21:59:251591defaults to 30 days. The value "now" expires all entries
1592immediately, and "never" suppresses expiration altogether.
1593With "<pattern>" (e.g. "refs/stash")
Junio C Hamanocc7636a2010-05-21 14:57:531594in the middle, the setting applies only to the refs that
1595match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551596
Junio C Hamano322c6242015-03-23 21:32:461597gc.rerereResolved::
Junio C Hamano74640642006-12-27 10:59:551598Records of conflicted merge you resolved earlier are
Junio C Hamano1aa40d22010-01-21 17:46:431599kept for this many days when 'git rerere gc' is run.
Junio C Hamanofb1fdf12017-08-27 06:14:591600You can also use more human-readable "1.month.ago", etc.
Junio C Hamano35738e82008-01-07 07:55:461601The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551602
Junio C Hamano322c6242015-03-23 21:32:461603gc.rerereUnresolved::
Junio C Hamano74640642006-12-27 10:59:551604Records of conflicted merge you have not resolved are
Junio C Hamano1aa40d22010-01-21 17:46:431605kept for this many days when 'git rerere gc' is run.
Junio C Hamanofb1fdf12017-08-27 06:14:591606You can also use more human-readable "1.month.ago", etc.
Junio C Hamano35738e82008-01-07 07:55:461607The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551608
Junio C Hamano322c6242015-03-23 21:32:461609gitcvs.commitMsgAnnotation::
Junio C Hamanoa3148f52009-01-14 08:49:571610Append this string to each commit message. Set to empty string
1611to disable this feature. Defaults to "via git-CVS emulator".
1612
Junio C Hamano07824ce2006-04-25 07:36:541613gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:271614Whether the CVS server interface is enabled for this repository.
Junio C Hamano35738e82008-01-07 07:55:461615See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541616
Junio C Hamano322c6242015-03-23 21:32:461617gitcvs.logFile::
Junio C Hamanoa6387422007-08-25 03:54:271618Path to a log file where the CVS server interface well... logs
Junio C Hamano35738e82008-01-07 07:55:461619various stuff. See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541620
Junio C Hamano17bd2272008-09-01 06:11:171621gitcvs.usecrlfattr::
Junio C Hamanobb88cf42010-06-21 15:23:551622If true, the server will look up the end-of-line conversion
Junio C Hamano92d80372016-07-13 22:00:051623attributes for files to determine the `-k` modes to use. If
Junio C Hamano076ffcc2013-02-06 05:13:211624the attributes force Git to treat a file as text,
Junio C Hamano92d80372016-07-13 22:00:051625the `-k` mode will be left blank so CVS clients will
Junio C Hamanobb88cf42010-06-21 15:23:551626treat it as text. If they suppress text conversion, the file
Junio C Hamanocb1c44f2008-08-06 06:19:331627will be set with '-kb' mode, which suppresses any newline munging
Junio C Hamanobb88cf42010-06-21 15:23:551628the client might otherwise do. If the attributes do not allow
Junio C Hamano042f2142016-06-27 18:05:051629the file type to be determined, then `gitcvs.allBinary` is
Junio C Hamanobb88cf42010-06-21 15:23:551630used. See linkgit:gitattributes[5].
Junio C Hamanodfccbb02008-05-26 01:16:141631
Junio C Hamano322c6242015-03-23 21:32:461632gitcvs.allBinary::
Junio C Hamano042f2142016-06-27 18:05:051633This is used if `gitcvs.usecrlfattr` does not resolve
Junio C Hamanodfccbb02008-05-26 01:16:141634the correct '-kb' mode to use. If true, all
1635unresolved files are sent to the client in
1636mode '-kb'. This causes the client to treat them
1637as binary files, which suppresses any newline munging it
1638otherwise might do. Alternatively, if it is set to "guess",
1639then the contents of the file are examined to decide if
Junio C Hamano042f2142016-06-27 18:05:051640it is binary, similar to `core.autocrlf`.
Junio C Hamanoa2ad99e2007-04-18 09:57:041641
Junio C Hamano322c6242015-03-23 21:32:461642gitcvs.dbName::
Junio C Hamanoa2ad99e2007-04-18 09:57:041643Database used by git-cvsserver to cache revision information
Junio C Hamano076ffcc2013-02-06 05:13:211644derived from the Git repository. The exact meaning depends on the
Junio C Hamanoa2ad99e2007-04-18 09:57:041645used database driver, for SQLite (which is the default driver) this
1646is a filename. Supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461647linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Junio C Hamanoa2ad99e2007-04-18 09:57:041648Default: '%Ggitcvs.%m.sqlite'
1649
Junio C Hamano322c6242015-03-23 21:32:461650gitcvs.dbDriver::
Junio C Hamanoa2ad99e2007-04-18 09:57:041651Used Perl DBI driver. You can specify any available driver
Junio C Hamano804a9742013-04-28 23:10:311652for this here, but it might not work. git-cvsserver is tested
Junio C Hamanoa2ad99e2007-04-18 09:57:041653with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1654reported *not* to work with 'DBD::mysql'. Experimental feature.
1655May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamano35738e82008-01-07 07:55:461656See linkgit:git-cvsserver[1].
Junio C Hamanod9e0e5d2007-04-14 16:22:041657
Junio C Hamano322c6242015-03-23 21:32:461658gitcvs.dbUser, gitcvs.dbPass::
Junio C Hamano042f2142016-06-27 18:05:051659Database user and password. Only useful if setting `gitcvs.dbDriver`,
Junio C Hamanoa2ad99e2007-04-18 09:57:041660since SQLite has no concept of database users and/or passwords.
Junio C Hamano322c6242015-03-23 21:32:461661'gitcvs.dbUser' supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461662linkgit:git-cvsserver[1] for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:041663
Junio C Hamanoa74efce2008-04-02 08:39:081664gitcvs.dbTableNamePrefix::
1665Database table name prefix. Prepended to the names of any
1666database tables used, allowing a single database to be used
1667for several repositories. Supports variable substitution (see
1668linkgit:git-cvsserver[1] for details). Any non-alphabetic
1669characters will be replaced with underscores.
1670
Junio C Hamano042f2142016-06-27 18:05:051671All gitcvs variables except for `gitcvs.usecrlfattr` and
1672`gitcvs.allBinary` can also be specified as
Junio C Hamanodfccbb02008-05-26 01:16:141673'gitcvs.<access_method>.<varname>' (where 'access_method'
Junio C Hamanoa6387422007-08-25 03:54:271674is one of "ext" and "pserver") to make them apply only for the given
1675access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:041676
Junio C Hamano11821ed2011-10-19 18:42:091677gitweb.category::
1678gitweb.description::
1679gitweb.owner::
1680gitweb.url::
1681See linkgit:gitweb[1] for description.
1682
1683gitweb.avatar::
1684gitweb.blame::
1685gitweb.grep::
1686gitweb.highlight::
1687gitweb.patches::
1688gitweb.pickaxe::
1689gitweb.remote_heads::
Junio C Hamano322c6242015-03-23 21:32:461690gitweb.showSizes::
Junio C Hamano11821ed2011-10-19 18:42:091691gitweb.snapshot::
1692See linkgit:gitweb.conf[5] for description.
1693
Junio C Hamanoa03ac862011-04-02 04:32:291694grep.lineNumber::
Junio C Hamano92d80372016-07-13 22:00:051695If set to true, enable `-n` option by default.
Junio C Hamanoa03ac862011-04-02 04:32:291696
Junio C Hamanoa00504d2012-08-27 21:11:231697grep.patternType::
1698Set the default matching behavior. Using a value of 'basic', 'extended',
Junio C Hamano92d80372016-07-13 22:00:051699'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1700`--fixed-strings`, or `--perl-regexp` option accordingly, while the
Junio C Hamanoa00504d2012-08-27 21:11:231701value 'default' will return to the default matching behavior.
1702
Junio C Hamanoa03ac862011-04-02 04:32:291703grep.extendedRegexp::
Junio C Hamano92d80372016-07-13 22:00:051704If set to true, enable `--extended-regexp` option by default. This
Junio C Hamano042f2142016-06-27 18:05:051705option is ignored when the `grep.patternType` option is set to a value
Junio C Hamanoa00504d2012-08-27 21:11:231706other than 'default'.
Junio C Hamanoa03ac862011-04-02 04:32:291707
Junio C Hamanoa7da1ba2016-01-13 00:19:451708grep.threads::
1709Number of grep worker threads to use.
1710See `grep.threads` in linkgit:git-grep[1] for more information.
1711
Junio C Hamano4e6ba272016-01-20 23:23:191712grep.fallbackToNoIndex::
1713If set to true, fall back to git grep --no-index if git grep
1714is executed outside of a git repository. Defaults to false.
1715
Junio C Hamano4fd24422012-01-06 21:52:431716gpg.program::
Junio C Hamano198b1f12016-05-17 22:27:241717Use this custom program instead of "`gpg`" found on `$PATH` when
Junio C Hamano4fd24422012-01-06 21:52:431718making or verifying a PGP signature. The program must support the
Junio C Hamanoe1aeb5e2014-06-06 19:16:291719same command-line interface as GPG, namely, to verify a detached
Junio C Hamano198b1f12016-05-17 22:27:241720signature, "`gpg --verify $file - <$signature`" is run, and the
Junio C Hamano4fd24422012-01-06 21:52:431721program is expected to signal a good signature by exiting with
Junio C Hamanofb5ffde2014-11-04 22:38:561722code 0, and to generate an ASCII-armored detached signature, the
Junio C Hamano198b1f12016-05-17 22:27:241723standard input of "`gpg -bsau $key`" is fed with the contents to be
Junio C Hamano4fd24422012-01-06 21:52:431724signed, and the program is expected to send the result to its
1725standard output.
1726
Junio C Hamano322c6242015-03-23 21:32:461727gui.commitMsgWidth::
Junio C Hamano6d76d612008-05-09 05:46:081728Defines how wide the commit message window is in the
1729linkgit:git-gui[1]. "75" is the default.
1730
Junio C Hamano322c6242015-03-23 21:32:461731gui.diffContext::
Junio C Hamano6d76d612008-05-09 05:46:081732Specifies how many context lines should be used in calls to diff
1733made by the linkgit:git-gui[1]. The default is "5".
1734
Junio C Hamano322c6242015-03-23 21:32:461735gui.displayUntracked::
Junio C Hamano198b1f12016-05-17 22:27:241736Determines if linkgit:git-gui[1] shows untracked files
Junio C Hamano796c55f2014-05-02 21:45:151737in the file list. The default is "true".
1738
Junio C Hamanod3452a02008-11-15 08:07:551739gui.encoding::
1740Specifies the default encoding to use for displaying of
1741file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1742It can be overridden by setting the 'encoding' attribute
1743for relevant files (see linkgit:gitattributes[5]).
1744If this option is not set, the tools default to the
1745locale encoding.
1746
Junio C Hamano322c6242015-03-23 21:32:461747gui.matchTrackingBranch::
Junio C Hamano6d76d612008-05-09 05:46:081748Determines if new branches created with linkgit:git-gui[1] should
1749default to tracking remote branches with matching names or
1750not. Default: "false".
1751
Junio C Hamano322c6242015-03-23 21:32:461752gui.newBranchTemplate::
Junio C Hamano6d76d612008-05-09 05:46:081753Is used as suggested name when creating new branches using the
1754linkgit:git-gui[1].
1755
Junio C Hamano322c6242015-03-23 21:32:461756gui.pruneDuringFetch::
Junio C Hamano97bcb482010-11-25 03:16:071757"true" if linkgit:git-gui[1] should prune remote-tracking branches when
Junio C Hamano6d76d612008-05-09 05:46:081758performing a fetch. The default value is "false".
1759
1760gui.trustmtime::
1761Determines if linkgit:git-gui[1] should trust the file modification
1762timestamp or not. By default the timestamps are not trusted.
1763
Junio C Hamano322c6242015-03-23 21:32:461764gui.spellingDictionary::
Junio C Hamano6d76d612008-05-09 05:46:081765Specifies the dictionary used for spell checking commit messages in
1766the linkgit:git-gui[1]. When set to "none" spell checking is turned
1767off.
1768
Junio C Hamano322c6242015-03-23 21:32:461769gui.fastCopyBlame::
Junio C Hamano1aa40d22010-01-21 17:46:431770If true, 'git gui blame' uses `-C` instead of `-C -C` for original
Junio C Hamanod3452a02008-11-15 08:07:551771location detection. It makes blame significantly faster on huge
1772repositories at the expense of less thorough copy detection.
1773
Junio C Hamano322c6242015-03-23 21:32:461774gui.copyBlameThreshold::
Junio C Hamano610d1762008-11-28 06:27:131775Specifies the threshold to use in 'git gui blame' original location
Junio C Hamanod3452a02008-11-15 08:07:551776detection, measured in alphanumeric characters. See the
1777linkgit:git-blame[1] manual for more information on copy detection.
1778
1779gui.blamehistoryctx::
1780Specifies the radius of history context in days to show in
1781linkgit:gitk[1] for the selected commit, when the `Show History
1782Context` menu item is invoked from 'git gui blame'. If this
1783variable is set to zero, the whole history is shown.
1784
Junio C Hamano92d312a2008-12-15 07:22:201785guitool.<name>.cmd::
1786Specifies the shell command line to execute when the corresponding item
1787of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1788mandatory for every tool. The command is executed from the root of
1789the working directory, and in the environment it receives the name of
Junio C Hamano042f2142016-06-27 18:05:051790the tool as `GIT_GUITOOL`, the name of the currently selected file as
Junio C Hamano92d312a2008-12-15 07:22:201791'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1792the head is detached, 'CUR_BRANCH' is empty).
1793
Junio C Hamano322c6242015-03-23 21:32:461794guitool.<name>.needsFile::
Junio C Hamano92d312a2008-12-15 07:22:201795Run the tool only if a diff is selected in the GUI. It guarantees
1796that 'FILENAME' is not empty.
1797
Junio C Hamano322c6242015-03-23 21:32:461798guitool.<name>.noConsole::
Junio C Hamano92d312a2008-12-15 07:22:201799Run the command silently, without creating a window to display its
1800output.
1801
Junio C Hamano322c6242015-03-23 21:32:461802guitool.<name>.noRescan::
Junio C Hamano92d312a2008-12-15 07:22:201803Don't rescan the working directory for changes after the tool
1804finishes execution.
1805
1806guitool.<name>.confirm::
1807Show a confirmation dialog before actually running the tool.
1808
Junio C Hamano322c6242015-03-23 21:32:461809guitool.<name>.argPrompt::
Junio C Hamano92d312a2008-12-15 07:22:201810Request a string argument from the user, and pass it to the tool
Junio C Hamano042f2142016-06-27 18:05:051811through the `ARGS` environment variable. Since requesting an
Junio C Hamano92d312a2008-12-15 07:22:201812argument implies confirmation, the 'confirm' option has no effect
1813if this is enabled. If the option is set to 'true', 'yes', or '1',
1814the dialog uses a built-in generic prompt; otherwise the exact
1815value of the variable is used.
1816
Junio C Hamano322c6242015-03-23 21:32:461817guitool.<name>.revPrompt::
Junio C Hamano92d312a2008-12-15 07:22:201818Request a single valid revision from the user, and set the
Junio C Hamano042f2142016-06-27 18:05:051819`REVISION` environment variable. In other aspects this option
Junio C Hamano322c6242015-03-23 21:32:461820is similar to 'argPrompt', and can be used together with it.
Junio C Hamano92d312a2008-12-15 07:22:201821
Junio C Hamano322c6242015-03-23 21:32:461822guitool.<name>.revUnmerged::
1823Show only unmerged branches in the 'revPrompt' subdialog.
Junio C Hamano92d312a2008-12-15 07:22:201824This is useful for tools similar to merge or rebase, but not
1825for things like checkout or reset.
1826
1827guitool.<name>.title::
1828Specifies the title to use for the prompt dialog. The default
1829is the tool name.
1830
1831guitool.<name>.prompt::
1832Specifies the general prompt string to display at the top of
Junio C Hamano322c6242015-03-23 21:32:461833the dialog, before subsections for 'argPrompt' and 'revPrompt'.
Junio C Hamano92d312a2008-12-15 07:22:201834The default value includes the actual command.
1835
Junio C Hamano4e272312008-01-08 09:13:211836help.browser::
1837Specify the browser that will be used to display help in the
1838'web' format. See linkgit:git-help[1].
1839
1840help.format::
1841Override the default help format used by linkgit:git-help[1].
1842Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1843the default. 'web' and 'html' are the same.
1844
Junio C Hamano322c6242015-03-23 21:32:461845help.autoCorrect::
Junio C Hamanof24b8062008-09-09 01:34:391846Automatically correct and execute mistyped commands after
1847waiting for the given number of deciseconds (0.1 sec). If more
1848than one command can be deduced from the entered text, nothing
1849will be executed. If the value of this option is negative,
1850the corrected command will be executed immediately. If the
1851value is 0 - the command will be just shown but not executed.
1852This is the default.
1853
Junio C Hamano322c6242015-03-23 21:32:461854help.htmlPath::
Junio C Hamano5dd5fae2013-01-18 21:06:491855Specify the path where the HTML documentation resides. File system paths
1856and URLs are supported. HTML pages will be prefixed with this path when
1857help is displayed in the 'web' format. This defaults to the documentation
1858path of your Git installation.
1859
Junio C Hamano58256872007-12-04 08:31:131860http.proxy::
Junio C Hamano3dd93922012-03-05 07:49:111861Override the HTTP proxy, normally configured using the 'http_proxy',
Junio C Hamanoffe10ca2016-02-04 00:44:231862'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1863addition to the syntax understood by curl, it is possible to specify a
1864proxy string with a user name but no password, in which case git will
1865attempt to acquire one in the same way it does for other credentials. See
1866linkgit:gitcredentials[7] for more information. The syntax thus is
1867'[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1868on a per-remote basis; see remote.<name>.proxy
1869
1870http.proxyAuthMethod::
1871Set the method with which to authenticate against the HTTP proxy. This
1872only takes effect if the configured proxy string contains a user name part
1873(i.e. is of the form 'user@host' or 'user@host:port'). This can be
1874overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
Junio C Hamano042f2142016-06-27 18:05:051875Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
Junio C Hamanoffe10ca2016-02-04 00:44:231876variable. Possible values are:
1877+
1878--
1879* `anyauth` - Automatically pick a suitable authentication method. It is
1880 assumed that the proxy answers an unauthenticated request with a 407
1881 status code and one or more Proxy-authenticate headers with supported
1882 authentication methods. This is the default.
1883* `basic` - HTTP Basic authentication
1884* `digest` - HTTP Digest authentication; this prevents the password from being
1885 transmitted to the proxy in clear text
1886* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1887 of `curl(1)`)
1888* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1889--
Junio C Hamano58256872007-12-04 08:31:131890
Junio C Hamano3fcdd072016-02-24 23:41:081891http.emptyAuth::
1892Attempt authentication without seeking a username or password. This
1893can be used to attempt GSS-Negotiate authentication without specifying
1894a username in the URL, as libcurl normally requires a username for
1895authentication.
1896
Junio C Hamano34afdb22016-10-06 22:16:391897http.delegation::
1898Control GSSAPI credential delegation. The delegation is disabled
1899by default in libcurl since version 7.21.7. Set parameter to tell
1900the server what it is allowed to delegate when it comes to user
1901credentials. Used with GSS/kerberos. Possible values are:
1902+
1903--
1904* `none` - Don't allow any delegation.
1905* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
1906 Kerberos service ticket, which is a matter of realm policy.
1907* `always` - Unconditionally allow the server to delegate.
1908--
1909
1910
Junio C Hamanoccdabca2016-05-06 22:27:091911http.extraHeader::
1912Pass an additional HTTP header when communicating with a server. If
1913more than one such entry exists, all of them are added as extra
1914headers. To allow overriding the settings inherited from the system
1915config, an empty value will reset the extra headers to the empty list.
1916
Junio C Hamano322c6242015-03-23 21:32:461917http.cookieFile::
Junio C Hamano198b1f12016-05-17 22:27:241918The pathname of a file containing previously stored cookie lines,
1919which should be used
Junio C Hamano076ffcc2013-02-06 05:13:211920in the Git http session, if they match the server. The file format
Junio C Hamano4c4b0122011-06-30 01:19:321921of the file to read cookies from should be plain HTTP headers or
Junio C Hamano198b1f12016-05-17 22:27:241922the Netscape/Mozilla cookie file format (see `curl(1)`).
1923NOTE that the file specified with http.cookieFile is used only as
Junio C Hamano8eac2682013-09-09 22:35:201924input unless http.saveCookies is set.
1925
Junio C Hamano322c6242015-03-23 21:32:461926http.saveCookies::
Junio C Hamano8eac2682013-09-09 22:35:201927If set, store cookies received during requests to the file specified by
Junio C Hamano322c6242015-03-23 21:32:461928http.cookieFile. Has no effect if http.cookieFile is unset.
Junio C Hamano4c4b0122011-06-30 01:19:321929
Junio C Hamanoa1746be2015-08-26 23:07:071930http.sslVersion::
1931The SSL version to use when negotiating an SSL connection, if you
1932want to force the default. The available and default version
1933depend on whether libcurl was built against NSS or OpenSSL and the
1934particular configuration of the crypto library in use. Internally
1935this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1936documentation for more details on the format of this option and
1937for the ssl version supported. Actually the possible values of
1938this option are:
1939
1940- sslv2
1941- sslv3
1942- tlsv1
1943- tlsv1.0
1944- tlsv1.1
1945- tlsv1.2
1946
1947+
Junio C Hamano042f2142016-06-27 18:05:051948Can be overridden by the `GIT_SSL_VERSION` environment variable.
Junio C Hamanoa1746be2015-08-26 23:07:071949To force git to use libcurl's default ssl version and ignore any
Junio C Hamano042f2142016-06-27 18:05:051950explicit http.sslversion option, set `GIT_SSL_VERSION` to the
Junio C Hamanoa1746be2015-08-26 23:07:071951empty string.
1952
Junio C Hamano1dbca522015-05-22 20:48:551953http.sslCipherList::
1954 A list of SSL ciphers to use when negotiating an SSL connection.
1955 The available ciphers depend on whether libcurl was built against
1956 NSS or OpenSSL and the particular configuration of the crypto
1957 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1958 option; see the libcurl documentation for more details on the format
1959 of this list.
1960+
Junio C Hamano042f2142016-06-27 18:05:051961Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
Junio C Hamano1dbca522015-05-22 20:48:551962To force git to use libcurl's default cipher list and ignore any
Junio C Hamano042f2142016-06-27 18:05:051963explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
Junio C Hamano1dbca522015-05-22 20:48:551964empty string.
1965
Junio C Hamano07824ce2006-04-25 07:36:541966http.sslVerify::
1967Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano042f2142016-06-27 18:05:051968over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment
Junio C Hamano07824ce2006-04-25 07:36:541969variable.
1970
1971http.sslCert::
1972File containing the SSL certificate when fetching or pushing
Junio C Hamano042f2142016-06-27 18:05:051973over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
Junio C Hamano07824ce2006-04-25 07:36:541974variable.
1975
1976http.sslKey::
1977File containing the SSL private key when fetching or pushing
Junio C Hamano042f2142016-06-27 18:05:051978over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
Junio C Hamano07824ce2006-04-25 07:36:541979variable.
1980
Junio C Hamano48bc1ce2009-07-09 16:49:191981http.sslCertPasswordProtected::
Junio C Hamano076ffcc2013-02-06 05:13:211982Enable Git's password prompt for the SSL certificate. Otherwise
Junio C Hamano48bc1ce2009-07-09 16:49:191983OpenSSL will prompt the user, possibly many times, if the
1984certificate or private key is encrypted. Can be overridden by the
Junio C Hamano042f2142016-06-27 18:05:051985`GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
Junio C Hamano48bc1ce2009-07-09 16:49:191986
Junio C Hamano07824ce2006-04-25 07:36:541987http.sslCAInfo::
1988File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:481989fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano042f2142016-06-27 18:05:051990`GIT_SSL_CAINFO` environment variable.
Junio C Hamano07824ce2006-04-25 07:36:541991
1992http.sslCAPath::
1993Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:451994with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano042f2142016-06-27 18:05:051995by the `GIT_SSL_CAPATH` environment variable.
Junio C Hamano07824ce2006-04-25 07:36:541996
Junio C Hamano3fcdd072016-02-24 23:41:081997http.pinnedpubkey::
1998Public key of the https service. It may either be the filename of
1999a PEM or DER encoded public key file or a string starting with
2000'sha256//' followed by the base64 encoded sha256 hash of the
2001public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
2002exit with an error if this option is set but not supported by
2003cURL.
2004
Junio C Hamano76927822013-04-19 21:26:572005http.sslTry::
2006Attempt to use AUTH SSL/TLS and encrypted data transfers
2007when connecting via regular FTP protocol. This might be needed
2008if the FTP server requires it for security reasons or you wish
2009to connect securely whenever remote FTP server supports it.
2010Default is false since it might trigger certificate verification
2011errors on misconfigured servers.
2012
Junio C Hamano07824ce2006-04-25 07:36:542013http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:482014How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano042f2142016-06-27 18:05:052015by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
Junio C Hamano07824ce2006-04-25 07:36:542016
Junio C Hamanob141a922010-01-10 19:55:142017http.minSessions::
2018The number of curl sessions (counted across slots) to be kept across
2019requests. They will not be ended with curl_easy_cleanup() until
2020http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2021value will be capped at 1. Defaults to 1.
2022
Junio C Hamano3b70d3c2009-11-21 17:37:372023http.postBuffer::
2024Maximum size in bytes of the buffer used by smart HTTP
2025transports when POSTing data to the remote system.
2026For requests larger than this buffer size, HTTP/1.1 and
2027Transfer-Encoding: chunked is used to avoid creating a
2028massive pack file locally. Default is 1 MiB, which is
2029sufficient for most requests.
2030
Junio C Hamano07824ce2006-04-25 07:36:542031http.lowSpeedLimit, http.lowSpeedTime::
2032If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2033for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano042f2142016-06-27 18:05:052034Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2035`GIT_HTTP_LOW_SPEED_TIME` environment variables.
Junio C Hamano07824ce2006-04-25 07:36:542036
Junio C Hamanof1dcdfe2006-09-29 08:10:512037http.noEPSV::
2038A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:042039This can helpful with some "poor" ftp servers which don't
Junio C Hamano042f2142016-06-27 18:05:052040support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
Junio C Hamanof1dcdfe2006-09-29 08:10:512041environment variable. Default is false (curl will use EPSV).
2042
Junio C Hamano322c6242015-03-23 21:32:462043http.userAgent::
Junio C Hamano53ba6d02010-08-22 07:25:122044The HTTP USER_AGENT string presented to an HTTP server. The default
Junio C Hamano076ffcc2013-02-06 05:13:212045value represents the version of the client Git such as git/1.7.1.
Junio C Hamano53ba6d02010-08-22 07:25:122046This option allows you to override this value to a more common value
2047such as Mozilla/4.0. This may be necessary, for instance, if
2048connecting through a firewall that restricts HTTP connections to a set
2049of common USER_AGENT strings (but not including those like git/1.7.1).
Junio C Hamano042f2142016-06-27 18:05:052050Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
Junio C Hamano53ba6d02010-08-22 07:25:122051
Junio C Hamano52b1cfb2016-12-20 00:18:362052http.followRedirects::
2053Whether git should follow HTTP redirects. If set to `true`, git
2054will transparently follow any redirect issued by a server it
2055encounters. If set to `false`, git will treat all redirects as
2056errors. If set to `initial`, git will follow redirects only for
2057the initial request to a remote, but not for subsequent
2058follow-up HTTP requests. Since git uses the redirected URL as
2059the base for the follow-up requests, this is generally
2060sufficient. The default is `initial`.
2061
Junio C Hamano8eac2682013-09-09 22:35:202062http.<url>.*::
Junio C Hamanofb5ffde2014-11-04 22:38:562063Any of the http.* options above can be applied selectively to some URLs.
Junio C Hamano8eac2682013-09-09 22:35:202064For a config key to match a URL, each element of the config key is
2065compared to that of the URL, in the following order:
2066+
2067--
2068. Scheme (e.g., `https` in `https://example.com/`). This field
2069 must match exactly between the config key and the URL.
2070
2071. Host/domain name (e.g., `example.com` in `https://example.com/`).
Junio C Hamanocbe0eb22017-02-27 23:37:492072 This field must match between the config key and the URL. It is
2073 possible to specify a `*` as part of the host name to match all subdomains
2074 at this level. `https://*.example.com/` for example would match
2075 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
Junio C Hamano8eac2682013-09-09 22:35:202076
2077. Port number (e.g., `8080` in `http://example.com:8080/`).
2078 This field must match exactly between the config key and the URL.
2079 Omitted port numbers are automatically converted to the correct
2080 default for the scheme before matching.
2081
2082. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2083 path field of the config key must match the path field of the URL
2084 either exactly or as a prefix of slash-delimited path elements. This means
2085 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2086 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2087 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2088 key with just path `foo/`).
2089
2090. User name (e.g., `user` in `https://user@example.com/repo.git`). If
2091 the config key has a user name it must match the user name in the
2092 URL exactly. If the config key does not have a user name, that
2093 config key will match a URL with any user name (including none),
2094 but at a lower precedence than a config key with a user name.
2095--
2096+
2097The list above is ordered by decreasing precedence; a URL that matches
2098a config key's path is preferred to one that matches its user name. For example,
2099if the URL is `https://user@example.com/foo/bar` a config key match of
2100`https://example.com/foo` will be preferred over a config key match of
2101`https://user@example.com`.
2102+
2103All URLs are normalized before attempting any matching (the password part,
2104if embedded in the URL, is always ignored for matching purposes) so that
Junio C Hamanofb5ffde2014-11-04 22:38:562105equivalent URLs that are simply spelled differently will match properly.
2106Environment variable settings always override any matches. The URLs that are
Junio C Hamano8eac2682013-09-09 22:35:202107matched against are those given directly to Git commands. This means any URLs
2108visited as a result of a redirection do not participate in matching.
2109
Junio C Hamanocbe0eb22017-02-27 23:37:492110ssh.variant::
Junio C Hamano912712b2017-12-06 18:04:012111By default, Git determines the command line arguments to use
2112based on the basename of the configured SSH command (configured
2113using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2114the config setting `core.sshCommand`). If the basename is
2115unrecognized, Git will attempt to detect support of OpenSSH
2116options by first invoking the configured SSH command with the
2117`-G` (print configuration) option and will subsequently use
2118OpenSSH options (if that is successful) or no options besides
2119the host and remote command (if it fails).
Junio C Hamanocbe0eb22017-02-27 23:37:492120+
Junio C Hamano912712b2017-12-06 18:04:012121The config variable `ssh.variant` can be set to override this detection.
2122Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2123`tortoiseplink`, `simple` (no options except the host and remote command).
2124The default auto-detection can be explicitly requested using the value
2125`auto`. Any other value is treated as `ssh`. This setting can also be
2126overridden via the environment variable `GIT_SSH_VARIANT`.
2127+
2128The current command-line parameters used for each variant are as
2129follows:
2130+
2131--
2132
2133* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2134
2135* `simple` - [username@]host command
2136
2137* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2138
2139* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2140
2141--
2142+
2143Except for the `simple` variant, command-line parameters are likely to
2144change as git gains new features.
Junio C Hamanocbe0eb22017-02-27 23:37:492145
Junio C Hamano07824ce2006-04-25 07:36:542146i18n.commitEncoding::
Junio C Hamano076ffcc2013-02-06 05:13:212147Character encoding the commit messages are stored in; Git itself
Junio C Hamano07824ce2006-04-25 07:36:542148does not care per se, but this information is necessary e.g. when
2149importing commits from emails or in the gitk graphical history
2150browser (and possibly at other places in the future or in other
Junio C Hamano35738e82008-01-07 07:55:462151porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Junio C Hamano07824ce2006-04-25 07:36:542152
Junio C Hamano51f92e22006-12-29 05:18:282153i18n.logOutputEncoding::
2154Character encoding the commit messages are converted to when
Junio C Hamano1aa40d22010-01-21 17:46:432155running 'git log' and friends.
Junio C Hamano51f92e22006-12-29 05:18:282156
Junio C Hamano4653c6f2008-11-26 22:50:202157imap::
2158The configuration variables in the 'imap' section are described
2159in linkgit:git-imap-send[1].
2160
Junio C Hamano81703b22014-03-14 22:00:272161index.version::
2162Specify the version with which new index files should be
2163initialized. This does not affect existing repositories.
2164
Junio C Hamano322c6242015-03-23 21:32:462165init.templateDir::
Junio C Hamanocaa712a2010-03-11 01:17:352166Specify the directory from which templates will be copied.
2167(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2168
Junio C Hamano4e272312008-01-08 09:13:212169instaweb.browser::
2170Specify the program that will be used to browse your working
2171repository in gitweb. See linkgit:git-instaweb[1].
2172
2173instaweb.httpd::
2174The HTTP daemon command-line to start gitweb on your working
2175repository. See linkgit:git-instaweb[1].
2176
2177instaweb.local::
2178If true the web server started by linkgit:git-instaweb[1] will
2179be bound to the local IP (127.0.0.1).
2180
Junio C Hamano322c6242015-03-23 21:32:462181instaweb.modulePath::
Junio C Hamano619596a2010-08-18 22:15:352182The default module path for linkgit:git-instaweb[1] to use
2183instead of /usr/lib/apache2/modules. Only used if httpd
2184is Apache.
Junio C Hamano4e272312008-01-08 09:13:212185
2186instaweb.port::
2187The port number to bind the gitweb httpd to. See
2188linkgit:git-instaweb[1].
2189
Junio C Hamano322c6242015-03-23 21:32:462190interactive.singleKey::
Junio C Hamano27a128b2009-08-13 01:23:002191In interactive commands, allow the user to provide one-letter
Junio C Hamanoe5bf6c12009-02-07 21:43:102192input with a single key (i.e., without hitting enter).
Junio C Hamanob76a6862012-05-02 22:02:462193Currently this is used by the `--patch` mode of
Junio C Hamano3d050d62011-05-17 06:43:342194linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2195linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2196setting is silently ignored if portable keystroke input
Junio C Hamano81703b22014-03-14 22:00:272197is not available; requires the Perl module Term::ReadKey.
Junio C Hamanoe5bf6c12009-02-07 21:43:102198
Junio C Hamano4ba4a782016-04-03 19:11:322199interactive.diffFilter::
2200When an interactive command (such as `git add --patch`) shows
2201a colorized diff, git will pipe the diff through the shell
2202command defined by this configuration variable. The command may
2203mark up the diff further for human consumption, provided that it
2204retains a one-to-one correspondence with the lines in the
2205original diff. Defaults to disabled (no filtering).
2206
Junio C Hamanof93530e2011-05-25 23:59:592207log.abbrevCommit::
2208If true, makes linkgit:git-log[1], linkgit:git-show[1], and
Junio C Hamanob76a6862012-05-02 22:02:462209linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2210override this option with `--no-abbrev-commit`.
Junio C Hamanof93530e2011-05-25 23:59:592211
Junio C Hamanob713ff12008-05-24 01:12:302212log.date::
Junio C Hamano2db3e752010-09-03 21:33:062213Set the default date-time mode for the 'log' command.
2214Setting a value for log.date is similar to using 'git log''s
Junio C Hamano1eb56092015-10-05 20:39:532215`--date` option. See linkgit:git-log[1] for details.
Junio C Hamanob713ff12008-05-24 01:12:302216
Junio C Hamanocb39aea2010-05-09 07:24:482217log.decorate::
2218Print out the ref names of any commits that are shown by the log
2219command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2220'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2221specified, the full ref name (including prefix) will be printed.
Junio C Hamano37cf4082016-05-30 01:22:142222If 'auto' is specified, then if the output is going to a terminal,
2223the ref names are shown as if 'short' were given, otherwise no ref
Junio C Hamano92d80372016-07-13 22:00:052224names are shown. This is the same as the `--decorate` option
Junio C Hamano37cf4082016-05-30 01:22:142225of the `git log`.
Junio C Hamanocb39aea2010-05-09 07:24:482226
Junio C Hamanob0a1e832015-10-15 23:08:312227log.follow::
2228If `true`, `git log` will act as if the `--follow` option was used when
2229a single <path> is given. This has the same limitations as `--follow`,
2230i.e. it cannot be used to follow multiple files and does not work well
2231on non-linear history.
2232
Junio C Hamanob86c8032017-02-02 21:50:192233log.graphColors::
2234A list of colors, separated by commas, that can be used to draw
2235history lines in `git log --graph`.
2236
Junio C Hamano322c6242015-03-23 21:32:462237log.showRoot::
Junio C Hamanofe9acab2006-11-24 12:10:552238If true, the initial commit will be shown as a big creation event.
2239This is equivalent to a diff against an empty tree.
Junio C Hamano35738e82008-01-07 07:55:462240Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Junio C Hamanofe9acab2006-11-24 12:10:552241normally hide the root commit will now show it. True by default.
2242
Junio C Hamano6b6144f2017-05-29 06:20:152243log.showSignature::
2244If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2245linkgit:git-whatchanged[1] assume `--show-signature`.
2246
Junio C Hamanoce836cc2013-01-21 02:01:532247log.mailmap::
2248If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2249linkgit:git-whatchanged[1] assume `--use-mailmap`.
2250
Junio C Hamano7f1bc9d2015-03-05 22:38:262251mailinfo.scissors::
2252If true, makes linkgit:git-mailinfo[1] (and therefore
2253linkgit:git-am[1]) act by default as if the --scissors option
2254was provided on the command-line. When active, this features
2255removes everything from the message body before a scissors
2256line (i.e. consisting mainly of ">8", "8<" and "-").
2257
Junio C Hamano8bc410e2009-02-15 10:38:192258mailmap.file::
2259The location of an augmenting mailmap file. The default
2260mailmap, located in the root of the repository, is loaded
2261first, then the mailmap file pointed to by this variable.
2262The location of the mailmap file may be in a repository
2263subdirectory, or somewhere outside of the repository itself.
2264See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2265
Junio C Hamanoabad6da2013-01-06 09:06:322266mailmap.blob::
2267Like `mailmap.file`, but consider the value as a reference to a
2268blob in the repository. If both `mailmap.file` and
2269`mailmap.blob` are given, both are parsed, with entries from
2270`mailmap.file` taking precedence. In a bare repository, this
2271defaults to `HEAD:.mailmap`. In a non-bare repository, it
2272defaults to empty.
2273
Junio C Hamano8b588d52008-03-15 09:48:372274man.viewer::
2275Specify the programs that may be used to display help in the
2276'man' format. See linkgit:git-help[1].
2277
Junio C Hamano6d76d612008-05-09 05:46:082278man.<tool>.cmd::
2279Specify the command to invoke the specified man viewer. The
2280specified command is evaluated in shell with the man page
2281passed as argument. (See linkgit:git-help[1].)
Junio C Hamano103ad7f2007-03-14 11:19:262282
Junio C Hamano6d76d612008-05-09 05:46:082283man.<tool>.path::
2284Override the path for the given tool that may be used to
2285display help in the 'man' format. See linkgit:git-help[1].
Junio C Hamanoe90436a2007-04-22 07:22:132286
Junio C Hamano4653c6f2008-11-26 22:50:202287include::merge-config.txt[]
Junio C Hamanoa476efa2008-10-10 15:31:422288
Junio C Hamano1fbbbc12007-12-18 07:01:272289mergetool.<tool>.path::
2290Override the path for the given tool. This is useful in case
2291your tool is not in the PATH.
2292
Junio C Hamano86bcccc2008-03-08 09:33:552293mergetool.<tool>.cmd::
2294Specify the command to invoke the specified merge tool. The
2295specified command is evaluated in shell with the following
2296variables available: 'BASE' is the name of a temporary file
2297containing the common base of the files to be merged, if available;
2298'LOCAL' is the name of a temporary file containing the contents of
2299the file on the current branch; 'REMOTE' is the name of a temporary
2300file containing the contents of the file from the branch being
2301merged; 'MERGED' contains the name of the file to which the merge
2302tool should write the results of a successful merge.
2303
2304mergetool.<tool>.trustExitCode::
2305For a custom merge command, specify whether the exit code of
2306the merge command can be used to determine whether the merge was
2307successful. If this is not set to true then the merge target file
2308timestamp is checked and the merge assumed to have been successful
2309if the file has been updated, otherwise the user is prompted to
2310indicate the success of the merge.
2311
Junio C Hamanoe478e402014-10-21 22:14:452312mergetool.meld.hasOutput::
2313Older versions of `meld` do not support the `--output` option.
2314Git will attempt to detect whether `meld` supports `--output`
2315by inspecting the output of `meld --help`. Configuring
2316`mergetool.meld.hasOutput` will make Git skip these checks and
2317use the configured value instead. Setting `mergetool.meld.hasOutput`
2318to `true` tells Git to unconditionally use the `--output` option,
2319and `false` avoids using `--output`.
2320
Junio C Hamano86bcccc2008-03-08 09:33:552321mergetool.keepBackup::
2322After performing a merge, the original file with conflict markers
2323can be saved as a file with a `.orig` extension. If this variable
2324is set to `false` then this file is not preserved. Defaults to
2325`true` (i.e. keep the backup files).
2326
Junio C Hamano10b7a342009-01-01 22:05:172327mergetool.keepTemporaries::
Junio C Hamano076ffcc2013-02-06 05:13:212328When invoking a custom merge tool, Git uses a set of temporary
Junio C Hamano10b7a342009-01-01 22:05:172329files to pass to the tool. If the tool returns an error and this
2330variable is set to `true`, then these temporary files will be
2331preserved, otherwise they will be removed after the tool has
2332exited. Defaults to `false`.
2333
Junio C Hamanoe478e402014-10-21 22:14:452334mergetool.writeToTemp::
2335Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2336conflicting files in the worktree by default. Git will attempt
2337to use a temporary directory for these files when set `true`.
2338Defaults to `false`.
2339
Junio C Hamano10b7a342009-01-01 22:05:172340mergetool.prompt::
2341Prompt before each invocation of the merge resolution program.
2342
Junio C Hamano3891e252015-08-31 23:06:132343notes.mergeStrategy::
2344Which merge strategy to choose by default when resolving notes
2345conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2346`cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2347section of linkgit:git-notes[1] for more information on each strategy.
2348
2349notes.<name>.mergeStrategy::
2350Which merge strategy to choose when doing a notes merge into
2351refs/notes/<name>. This overrides the more general
2352"notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2353linkgit:git-notes[1] for more information on the available strategies.
2354
Junio C Hamano31667362010-03-25 00:38:532355notes.displayRef::
2356The (fully qualified) refname from which to show notes when
2357showing commit messages. The value of this variable can be set
2358to a glob, in which case notes from all matching refs will be
2359shown. You may also specify this configuration variable
2360several times. A warning will be issued for refs that do not
2361exist, but a glob that does not match any refs is silently
2362ignored.
2363+
2364This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2365environment variable, which must be a colon separated list of refs or
2366globs.
2367+
2368The effective value of "core.notesRef" (possibly overridden by
2369GIT_NOTES_REF) is also implicitly added to the list of refs to be
2370displayed.
2371
2372notes.rewrite.<command>::
2373When rewriting commits with <command> (currently `amend` or
Junio C Hamano076ffcc2013-02-06 05:13:212374`rebase`) and this variable is set to `true`, Git
Junio C Hamano31667362010-03-25 00:38:532375automatically copies your notes from the original to the
2376rewritten commit. Defaults to `true`, but see
2377"notes.rewriteRef" below.
Junio C Hamano31667362010-03-25 00:38:532378
2379notes.rewriteMode::
2380When copying notes during a rewrite (see the
2381"notes.rewrite.<command>" option), determines what to do if
2382the target commit already has a note. Must be one of
Junio C Hamano3891e252015-08-31 23:06:132383`overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2384Defaults to `concatenate`.
Junio C Hamano31667362010-03-25 00:38:532385+
2386This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2387environment variable.
2388
2389notes.rewriteRef::
2390When copying notes during a rewrite, specifies the (fully
2391qualified) ref whose notes should be copied. The ref may be a
2392glob, in which case notes in all matching refs will be copied.
2393You may also specify this configuration several times.
2394+
2395Does not have a default value; you must configure this variable to
Junio C Hamano8fb66e52011-10-05 20:59:512396enable note rewriting. Set it to `refs/notes/commits` to enable
2397rewriting for the default commit notes.
Junio C Hamano2b3ee5d2010-05-08 05:41:182398+
2399This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2400environment variable, which must be a colon separated list of refs or
2401globs.
Junio C Hamano31667362010-03-25 00:38:532402
Junio C Hamano75cc4c92006-07-24 08:25:032403pack.window::
Junio C Hamano35738e82008-01-07 07:55:462404The size of the window used by linkgit:git-pack-objects[1] when no
Junio C Hamano75cc4c92006-07-24 08:25:032405window size is given on the command line. Defaults to 10.
2406
Junio C Hamano91d44c52007-05-09 07:16:072407pack.depth::
Junio C Hamano35738e82008-01-07 07:55:462408The maximum delta depth used by linkgit:git-pack-objects[1] when no
Junio C Hamano91d44c52007-05-09 07:16:072409maximum depth is given on the command line. Defaults to 50.
2410
Junio C Hamano235d53f2007-07-13 00:25:152411pack.windowMemory::
Junio C Hamano2a4bcbc2014-10-29 20:07:392412The maximum size of memory that is consumed by each thread
2413in linkgit:git-pack-objects[1] for pack window memory when
2414no limit is given on the command line. The value can be
2415suffixed with "k", "m", or "g". When left unconfigured (or
2416set explicitly to 0), there will be no limit.
Junio C Hamano235d53f2007-07-13 00:25:152417
Junio C Hamanof2ce2972007-05-20 19:12:092418pack.compression::
2419An integer -1..9, indicating the compression level for objects
2420in a pack file. -1 is the zlib default. 0 means no
2421compression, and 1..9 are various speed/size tradeoffs, 9 being
2422slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:422423not set, defaults to -1, the zlib default, which is "a default
2424compromise between speed and compression (currently equivalent
2425to level 6)."
Junio C Hamano657fd8a2010-10-07 00:01:242426+
2427Note that changing the compression level will not automatically recompress
2428all existing objects. You can force recompression by passing the -F option
2429to linkgit:git-repack[1].
Junio C Hamanof2ce2972007-05-20 19:12:092430
Junio C Hamano679d22d2007-06-02 21:13:442431pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:272432The maximum memory in bytes used for caching deltas in
Junio C Hamano9f883862009-08-11 06:23:522433linkgit:git-pack-objects[1] before writing them out to a pack.
2434This cache is used to speed up the writing object phase by not
2435having to recompute the final delta result once the best match
2436for all objects is found. Repacking large repositories on machines
2437which are tight with memory might be badly impacted by this though,
2438especially if this cache pushes the system into swapping.
2439A value of 0 means no limit. The smallest size of 1 byte may be
2440used to virtually disable this cache. Defaults to 256 MiB.
Junio C Hamano679d22d2007-06-02 21:13:442441
2442pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:142443The maximum size of a delta, that is cached in
Junio C Hamano9f883862009-08-11 06:23:522444linkgit:git-pack-objects[1]. This cache is used to speed up the
2445writing object phase by not having to recompute the final delta
2446result once the best match for all objects is found. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:442447
Junio C Hamano58155b42007-09-15 07:46:142448pack.threads::
2449Specifies the number of threads to spawn when searching for best
Junio C Hamano35738e82008-01-07 07:55:462450delta matches. This requires that linkgit:git-pack-objects[1]
Junio C Hamano58155b42007-09-15 07:46:142451be compiled with pthreads otherwise this option is ignored with a
2452warning. This is meant to reduce packing time on multiprocessor
2453machines. The required amount of memory for the delta search window
2454is however multiplied by the number of threads.
Junio C Hamano076ffcc2013-02-06 05:13:212455Specifying 0 will cause Git to auto-detect the number of CPU's
Junio C Hamano24bc09a2008-02-28 00:27:442456and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:142457
Junio C Hamanod814b6d2007-11-04 11:13:492458pack.indexVersion::
2459Specify the default pack index version. Valid values are 1 for
2460legacy pack index used by Git versions prior to 1.5.2, and 2 for
2461the new pack index with capabilities for packs larger than 4 GB
2462as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:382463packs. Version 2 is the default. Note that version 2 is enforced
2464and this config option ignored whenever the corresponding pack is
2465larger than 2 GB.
2466+
Junio C Hamano076ffcc2013-02-06 05:13:212467If you have an old Git that does not understand the version 2 `*.idx` file,
Junio C Hamanof85ef632016-02-17 22:31:062468cloning or fetching over a non native protocol (e.g. "http")
Junio C Hamanob76a6862012-05-02 22:02:462469that will copy both `*.pack` file and corresponding `*.idx` file from the
Junio C Hamanofce7c7e2008-07-02 03:06:382470other side may give you a repository that cannot be accessed with your
Junio C Hamano076ffcc2013-02-06 05:13:212471older version of Git. If the `*.pack` file is smaller than 2 GB, however,
Junio C Hamanofce7c7e2008-07-02 03:06:382472you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
Junio C Hamanob76a6862012-05-02 22:02:462473the `*.idx` file.
Junio C Hamanod814b6d2007-11-04 11:13:492474
Junio C Hamano09a926d2008-03-13 07:55:292475pack.packSizeLimit::
Junio C Hamano4d979582010-02-04 06:27:292476The maximum size of a pack. This setting only affects
2477packing to a file when repacking, i.e. the git:// protocol
Junio C Hamanob76a6862012-05-02 22:02:462478is unaffected. It can be overridden by the `--max-pack-size`
Junio C Hamano74fd0fc2016-05-10 21:23:562479option of linkgit:git-repack[1]. Reaching this limit results
2480in the creation of multiple packfiles; which in turn prevents
2481bitmaps from being created.
2482The minimum size allowed is limited to 1 MiB.
2483The default is unlimited.
Junio C Hamano4d979582010-02-04 06:27:292484Common unit suffixes of 'k', 'm', or 'g' are
2485supported.
Junio C Hamano49dccaf2008-02-10 10:48:012486
Junio C Hamano5b3533d2014-02-27 23:07:152487pack.useBitmaps::
2488When true, git will use pack bitmaps (if available) when packing
2489to stdout (e.g., during the server side of a fetch). Defaults to
2490true. You should not generally need to turn this off unless
2491you are debugging pack bitmaps.
2492
Junio C Hamano322c6242015-03-23 21:32:462493pack.writeBitmaps (deprecated)::
Junio C Hamano38d02532014-06-26 21:48:502494This is a deprecated synonym for `repack.writeBitmaps`.
Junio C Hamano5b3533d2014-02-27 23:07:152495
2496pack.writeBitmapHashCache::
2497When true, git will include a "hash cache" section in the bitmap
2498index (if one is written). This cache can be used to feed git's
2499delta heuristics, potentially leading to better deltas between
2500bitmapped and non-bitmapped objects (e.g., when serving a fetch
2501between an older, bitmapped pack and objects that have been
2502pushed since the last gc). The downside is that it consumes 4
2503bytes per object of disk space, and that JGit's bitmap
2504implementation does not understand it, causing it to complain if
2505Git and JGit are used on the same repository. Defaults to false.
2506
Junio C Hamano9e96a1a2008-08-16 10:23:182507pager.<cmd>::
Junio C Hamano788eeba2010-12-08 22:50:432508If the value is boolean, turns on or off pagination of the
Junio C Hamano076ffcc2013-02-06 05:13:212509output of a particular Git subcommand when writing to a tty.
Junio C Hamano788eeba2010-12-08 22:50:432510Otherwise, turns on pagination for the subcommand using the
Junio C Hamanob76a6862012-05-02 22:02:462511pager specified by the value of `pager.<cmd>`. If `--paginate`
2512or `--no-pager` is specified on the command line, it takes
Junio C Hamano788eeba2010-12-08 22:50:432513precedence over this option. To disable pagination for all
2514commands, set `core.pager` or `GIT_PAGER` to `cat`.
Junio C Hamano9e96a1a2008-08-16 10:23:182515
Junio C Hamanoa574a092010-06-13 19:57:102516pretty.<name>::
2517Alias for a --pretty= format string, as specified in
2518linkgit:git-log[1]. Any aliases defined here can be used just
2519as the built-in pretty formats could. For example,
Junio C Hamanob76a6862012-05-02 22:02:462520running `git config pretty.changelog "format:* %H %s"`
Junio C Hamanoa574a092010-06-13 19:57:102521would cause the invocation `git log --pretty=changelog`
Junio C Hamanob76a6862012-05-02 22:02:462522to be equivalent to running `git log "--pretty=format:* %H %s"`.
Junio C Hamanoa574a092010-06-13 19:57:102523Note that an alias with the same name as a built-in format
2524will be silently ignored.
2525
Junio C Hamano9e35abf2016-12-27 22:37:272526protocol.allow::
2527If set, provide a user defined default policy for all protocols which
2528don't explicitly have a policy (`protocol.<name>.allow`). By default,
2529if unset, known-safe protocols (http, https, git, ssh, file) have a
2530default policy of `always`, known-dangerous protocols (ext) have a
2531default policy of `never`, and all other protocols have a default
2532policy of `user`. Supported policies:
2533+
2534--
2535
2536* `always` - protocol is always able to be used.
2537
2538* `never` - protocol is never able to be used.
2539
2540* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2541 either unset or has a value of 1. This policy should be used when you want a
2542 protocol to be directly usable by the user but don't want it used by commands which
2543 execute clone/fetch/push commands without user input, e.g. recursive
2544 submodule initialization.
2545
2546--
2547
2548protocol.<name>.allow::
2549Set a policy to be used by protocol `<name>` with clone/fetch/push
2550commands. See `protocol.allow` above for the available policies.
2551+
2552The protocol names currently used by git are:
2553+
2554--
2555 - `file`: any local file-based path (including `file://` URLs,
2556 or local paths)
2557
2558 - `git`: the anonymous git protocol over a direct TCP
2559 connection (or proxy, if configured)
2560
2561 - `ssh`: git over ssh (including `host:path` syntax,
2562 `ssh://`, etc).
2563
2564 - `http`: git over http, both "smart http" and "dumb http".
2565 Note that this does _not_ include `https`; if you want to configure
2566 both, you must do so individually.
2567
2568 - any external helpers are named by their protocol (e.g., use
2569 `hg` to allow the `git-remote-hg` helper)
2570--
2571
Junio C Hamano912712b2017-12-06 18:04:012572protocol.version::
2573Experimental. If set, clients will attempt to communicate with a
2574server using the specified protocol version. If unset, no
2575attempt will be made by the client to communicate using a
2576particular protocol version, this results in protocol version 0
2577being used.
2578Supported versions:
2579+
2580--
2581
2582* `0` - the original wire protocol.
2583
2584* `1` - the original wire protocol with the addition of a version string
2585 in the initial response from the server.
2586
2587--
2588
Junio C Hamano5b3533d2014-02-27 23:07:152589pull.ff::
2590By default, Git does not create an extra merge commit when merging
2591a commit that is a descendant of the current commit. Instead, the
2592tip of the current branch is fast-forwarded. When set to `false`,
2593this variable tells Git to create an extra merge commit in such
2594a case (equivalent to giving the `--no-ff` option from the command
2595line). When set to `only`, only such fast-forward merges are
2596allowed (equivalent to giving the `--ff-only` option from the
Junio C Hamanoc4e2a202015-05-26 21:38:472597command line). This setting overrides `merge.ff` when pulling.
Junio C Hamano5b3533d2014-02-27 23:07:152598
Junio C Hamano515ab1d2011-12-09 23:41:202599pull.rebase::
2600When true, rebase branches on top of the fetched branch, instead
2601of merging the default branch from the default remote when "git
2602pull" is run. See "branch.<name>.rebase" for setting this on a
2603per-branch basis.
2604+
Junio C Hamano7db630e2015-09-17 20:26:222605When preserve, also pass `--preserve-merges` along to 'git rebase'
2606so that locally committed merge commits will not be flattened
2607by running 'git pull'.
Junio C Hamanocf4a1742013-09-11 22:57:502608+
Junio C Hamano289d7e82016-01-27 00:20:382609When the value is `interactive`, the rebase is run in interactive mode.
2610+
Junio C Hamano515ab1d2011-12-09 23:41:202611*NOTE*: this is a possibly dangerous operation; do *not* use
2612it unless you understand the implications (see linkgit:git-rebase[1]
2613for details).
2614
Junio C Hamano07824ce2006-04-25 07:36:542615pull.octopus::
2616The default merge strategy to use when pulling multiple branches
2617at once.
2618
2619pull.twohead::
2620The default merge strategy to use when pulling a single branch.
2621
Junio C Hamano1de75722009-03-26 08:39:382622push.default::
Junio C Hamano58655592013-07-11 20:52:332623Defines the action `git push` should take if no refspec is
2624explicitly given. Different values are well-suited for
2625specific workflows; for instance, in a purely central workflow
2626(i.e. the fetch source is equal to the push destination),
2627`upstream` is probably what you want. Possible values are:
Junio C Hamano1de75722009-03-26 08:39:382628+
Junio C Hamanobcaa8bc2012-07-03 22:17:202629--
Junio C Hamano58655592013-07-11 20:52:332630
2631* `nothing` - do not push anything (error out) unless a refspec is
2632 explicitly given. This is primarily meant for people who want to
2633 avoid mistakes by always being explicit.
2634
2635* `current` - push the current branch to update a branch with the same
2636 name on the receiving end. Works in both central and non-central
2637 workflows.
2638
2639* `upstream` - push the current branch back to the branch whose
2640 changes are usually integrated into the current branch (which is
2641 called `@{upstream}`). This mode only makes sense if you are
2642 pushing to the same repository you would normally pull from
2643 (i.e. central workflow).
2644
Junio C Hamanocb06ef92017-03-21 22:40:142645* `tracking` - This is a deprecated synonym for `upstream`.
2646
Junio C Hamano58655592013-07-11 20:52:332647* `simple` - in centralized workflow, work like `upstream` with an
2648 added safety to refuse to push if the upstream branch's name is
2649 different from the local one.
Junio C Hamanobcaa8bc2012-07-03 22:17:202650+
Junio C Hamano58655592013-07-11 20:52:332651When pushing to a remote that is different from the remote you normally
2652pull from, work as `current`. This is the safest option and is suited
2653for beginners.
2654+
Junio C Hamano1d669b82014-03-11 21:36:002655This mode has become the default in Git 2.0.
Junio C Hamano58655592013-07-11 20:52:332656
2657* `matching` - push all branches having the same name on both ends.
2658 This makes the repository you are pushing to remember the set of
2659 branches that will be pushed out (e.g. if you always push 'maint'
2660 and 'master' there and no other branches, the repository you push
2661 to will have these two branches, and your local 'maint' and
2662 'master' will be pushed there).
2663+
2664To use this mode effectively, you have to make sure _all_ the
2665branches you would push out are ready to be pushed out before
2666running 'git push', as the whole point of this mode is to allow you
2667to push all of the branches in one go. If you usually finish work
2668on only one branch and push out the result, while other branches are
2669unfinished, this mode is not for you. Also this mode is not
2670suitable for pushing into a shared central repository, as other
2671people may add new branches there, or update the tip of existing
2672branches outside your control.
2673+
Junio C Hamano1d669b82014-03-11 21:36:002674This used to be the default, but not since Git 2.0 (`simple` is the
2675new default).
Junio C Hamano58655592013-07-11 20:52:332676
2677--
Junio C Hamano1de75722009-03-26 08:39:382678
Junio C Hamano322c6242015-03-23 21:32:462679push.followTags::
Junio C Hamano92d80372016-07-13 22:00:052680If set to true enable `--follow-tags` option by default. You
Junio C Hamano322c6242015-03-23 21:32:462681may override this configuration at time of push by specifying
Junio C Hamano92d80372016-07-13 22:00:052682`--no-follow-tags`.
Junio C Hamano322c6242015-03-23 21:32:462683
Junio C Hamano3891e252015-08-31 23:06:132684push.gpgSign::
2685May be set to a boolean value, or the string 'if-asked'. A true
Junio C Hamano92d80372016-07-13 22:00:052686value causes all pushes to be GPG signed, as if `--signed` is
Junio C Hamano3891e252015-08-31 23:06:132687passed to linkgit:git-push[1]. The string 'if-asked' causes
2688pushes to be signed if the server supports it, as if
Junio C Hamano92d80372016-07-13 22:00:052689`--signed=if-asked` is passed to 'git push'. A false value may
Junio C Hamano3891e252015-08-31 23:06:132690override a value from a lower-priority config file. An explicit
2691command-line flag always overrides this config option.
Junio C Hamano322c6242015-03-23 21:32:462692
Junio C Hamano3a9c0342017-11-10 06:01:122693push.pushOption::
2694When no `--push-option=<option>` argument is given from the
2695command line, `git push` behaves as if each <value> of
2696this variable is given as `--push-option=<value>`.
2697+
2698This is a multi-valued variable, and an empty value can be used in a
2699higher priority configuration file (e.g. `.git/config` in a
2700repository) to clear the values inherited from a lower priority
2701configuration files (e.g. `$HOME/.gitconfig`).
2702+
2703--
2704
2705Example:
2706
2707/etc/gitconfig
2708 push.pushoption = a
2709 push.pushoption = b
2710
2711~/.gitconfig
2712 push.pushoption = c
2713
2714repo/.git/config
2715 push.pushoption =
2716 push.pushoption = b
2717
2718This will result in only b (a and c are cleared).
2719
2720--
2721
Junio C Hamano409a33a2015-12-22 23:45:232722push.recurseSubmodules::
2723Make sure all submodule commits used by the revisions to be pushed
2724are available on a remote-tracking branch. If the value is 'check'
2725then Git will verify that all submodule commits that changed in the
2726revisions to be pushed are available on at least one remote of the
2727submodule. If any commits are missing, the push will be aborted and
2728exit with non-zero status. If the value is 'on-demand' then all
2729submodules that changed in the revisions to be pushed will be
2730pushed. If on-demand was not able to push all necessary revisions
2731it will also be aborted and exit with non-zero status. If the value
2732is 'no' then default behavior of ignoring submodules when pushing
2733is retained. You may override this configuration at time of push by
2734specifying '--recurse-submodules=check|on-demand|no'.
2735
Junio C Hamanoea6a7642009-03-11 23:56:192736rebase.stat::
2737Whether to show a diffstat of what changed upstream since the last
2738rebase. False by default.
2739
Junio C Hamano322c6242015-03-23 21:32:462740rebase.autoSquash::
Junio C Hamano92d80372016-07-13 22:00:052741If set to true enable `--autosquash` option by default.
Junio C Hamano075ae872010-09-01 18:43:072742
Junio C Hamano322c6242015-03-23 21:32:462743rebase.autoStash::
Junio C Hamano967cda72017-06-30 21:49:532744When set to true, automatically create a temporary stash entry
Junio C Hamanof1f5a7b2013-06-11 22:23:522745before the operation begins, and apply it after the operation
2746ends. This means that you can run rebase on a dirty worktree.
2747However, use with care: the final stash application after a
2748successful rebase might result in non-trivial conflicts.
2749Defaults to false.
2750
Junio C Hamanod7ed4042015-08-03 19:43:002751rebase.missingCommitsCheck::
2752If set to "warn", git rebase -i will print a warning if some
2753commits are removed (e.g. a line was deleted), however the
2754rebase will still proceed. If set to "error", it will print
2755the previous warning and stop the rebase, 'git rebase
2756--edit-todo' can then be used to correct the error. If set to
2757"ignore", no checking is done.
2758To drop a commit without warning or error, use the `drop`
2759command in the todo-list.
2760Defaults to "ignore".
2761
Junio C Hamanof2f28b12016-10-31 21:41:582762rebase.instructionFormat::
Junio C Hamanod7ed4042015-08-03 19:43:002763A format string, as specified in linkgit:git-log[1], to be used for
2764the instruction list during an interactive rebase. The format will automatically
2765have the long commit hash prepended to the format.
2766
Junio C Hamano322c6242015-03-23 21:32:462767receive.advertiseAtomic::
Junio C Hamano6bb32e62015-02-17 22:11:262768By default, git-receive-pack will advertise the atomic push
Junio C Hamanoe48a1132016-08-03 22:40:212769capability to its clients. If you don't want to advertise this
2770capability, set this variable to false.
2771
2772receive.advertisePushOptions::
Junio C Hamanod3ab1ad2017-05-23 06:52:182773When set to true, git-receive-pack will advertise the push options
2774capability to its clients. False by default.
Junio C Hamano6bb32e62015-02-17 22:11:262775
Junio C Hamano621e1232009-10-26 05:16:472776receive.autogc::
2777By default, git-receive-pack will run "git-gc --auto" after
2778receiving data from git-push and updating refs. You can stop
2779it by setting this variable to false.
2780
Junio C Hamano322c6242015-03-23 21:32:462781receive.certNonceSeed::
Junio C Hamano9236fea2014-10-14 22:28:092782By setting this variable to a string, `git receive-pack`
2783will accept a `git push --signed` and verifies it by using
2784a "nonce" protected by HMAC using this string as a secret
2785key.
2786
Junio C Hamano322c6242015-03-23 21:32:462787receive.certNonceSlop::
Junio C Hamano9236fea2014-10-14 22:28:092788When a `git push --signed` sent a push certificate with a
2789"nonce" that was issued by a receive-pack serving the same
2790repository within this many seconds, export the "nonce"
2791found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2792hooks (instead of what the receive-pack asked the sending
2793side to include). This may allow writing checks in
2794`pre-receive` and `post-receive` a bit easier. Instead of
2795checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2796that records by how many seconds the nonce is stale to
2797decide if they want to accept the certificate, they only
2798can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2799
Junio C Hamano4653c6f2008-11-26 22:50:202800receive.fsckObjects::
2801If it is set to true, git-receive-pack will check all received
2802objects. It will abort in the case of a malformed object or a
2803broken link. The result of an abort are only dangling objects.
Junio C Hamano8fb66e52011-10-05 20:59:512804Defaults to false. If not set, the value of `transfer.fsckObjects`
2805is used instead.
Junio C Hamano4653c6f2008-11-26 22:50:202806
Junio C Hamanod7ed4042015-08-03 19:43:002807receive.fsck.<msg-id>::
2808When `receive.fsckObjects` is set to true, errors can be switched
2809to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2810setting where the `<msg-id>` is the fsck message ID and the value
2811is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2812the error/warning with the message ID, e.g. "missingEmail: invalid
2813author/committer line - missing email" means that setting
2814`receive.fsck.missingEmail = ignore` will hide that issue.
2815+
2816This feature is intended to support working with legacy repositories
2817which would not pass pushing when `receive.fsckObjects = true`, allowing
2818the host to accept repositories with certain known issues but still catch
2819other issues.
2820
2821receive.fsck.skipList::
2822The path to a sorted list of object names (i.e. one SHA-1 per
2823line) that are known to be broken in a non-fatal way and should
2824be ignored. This feature is useful when an established project
2825should be accepted despite early commits containing errors that
2826can be safely ignored such as invalid committer email addresses.
2827Note: corrupt objects cannot be skipped with this setting.
2828
Junio C Hamanoe48a1132016-08-03 22:40:212829receive.keepAlive::
2830After receiving the pack from the client, `receive-pack` may
2831produce no output (if `--quiet` was specified) while processing
2832the pack, causing some networks to drop the TCP connection.
2833With this option set, if `receive-pack` does not transmit
2834any data in this phase for `receive.keepAlive` seconds, it will
2835send a short keepalive packet. The default is 5 seconds; set
2836to 0 to disable keepalives entirely.
2837
Junio C Hamano4653c6f2008-11-26 22:50:202838receive.unpackLimit::
2839If the number of objects received in a push is below this
2840limit then the objects will be unpacked into loose object
2841files. However if the number of received objects equals or
2842exceeds this limit then the received pack will be stored as
2843a pack, after adding any missing delta bases. Storing the
2844pack from a push can make the push operation complete faster,
2845especially on slow filesystems. If not set, the value of
2846`transfer.unpackLimit` is used instead.
2847
Junio C Hamanocd451662016-09-13 00:54:092848receive.maxInputSize::
2849If the size of the incoming pack stream is larger than this
2850limit, then git-receive-pack will error out, instead of
2851accepting the pack file. If not set or set to 0, then the size
2852is unlimited.
2853
Junio C Hamano4653c6f2008-11-26 22:50:202854receive.denyDeletes::
2855If set to true, git-receive-pack will deny a ref update that deletes
2856the ref. Use this to prevent such a ref deletion via a push.
2857
Junio C Hamanob4448a82010-07-26 09:02:322858receive.denyDeleteCurrent::
2859If set to true, git-receive-pack will deny a ref update that
2860deletes the currently checked out branch of a non-bare repository.
2861
Junio C Hamano4653c6f2008-11-26 22:50:202862receive.denyCurrentBranch::
Junio C Hamanoe97d5772010-05-19 08:13:582863If set to true or "refuse", git-receive-pack will deny a ref update
Junio C Hamano4653c6f2008-11-26 22:50:202864to the currently checked out branch of a non-bare repository.
2865Such a push is potentially dangerous because it brings the HEAD
2866out of sync with the index and working tree. If set to "warn",
2867print a warning of such a push to stderr, but allow the push to
2868proceed. If set to false or "ignore", allow such pushes with no
Junio C Hamanoafb395b2010-03-17 22:16:152869message. Defaults to "refuse".
Junio C Hamano6df93d92014-12-22 22:48:092870+
2871Another option is "updateInstead" which will update the working
Junio C Hamano6bb32e62015-02-17 22:11:262872tree if pushing into the current branch. This option is
Junio C Hamano6df93d92014-12-22 22:48:092873intended for synchronizing working directories when one side is not easily
2874accessible via interactive ssh (e.g. a live web site, hence the requirement
2875that the working directory be clean). This mode also comes in handy when
2876developing inside a VM to test and fix code on different Operating Systems.
Junio C Hamano6bb32e62015-02-17 22:11:262877+
2878By default, "updateInstead" will refuse the push if the working tree or
2879the index have any difference from the HEAD, but the `push-to-checkout`
2880hook can be used to customize this. See linkgit:githooks[5].
Junio C Hamano4653c6f2008-11-26 22:50:202881
2882receive.denyNonFastForwards::
2883If set to true, git-receive-pack will deny a ref update which is
Junio C Hamano3f680f32009-11-16 02:10:542884not a fast-forward. Use this to prevent such an update via a push,
Junio C Hamano4653c6f2008-11-26 22:50:202885even if that push is forced. This configuration variable is
2886set when initializing a shared repository.
2887
Junio C Hamano322c6242015-03-23 21:32:462888receive.hideRefs::
Junio C Hamanob6aa12e2015-08-19 22:40:172889This variable is the same as `transfer.hideRefs`, but applies
2890only to `receive-pack` (and so affects pushes, but not fetches).
2891An attempt to update or delete a hidden ref by `git push` is
2892rejected.
Junio C Hamano80ad00d2013-02-18 00:19:032893
Junio C Hamano322c6242015-03-23 21:32:462894receive.updateServerInfo::
Junio C Hamano621e1232009-10-26 05:16:472895If set to true, git-receive-pack will run git-update-server-info
2896after receiving data from git-push and updating refs.
2897
Junio C Hamano322c6242015-03-23 21:32:462898receive.shallowUpdate::
Junio C Hamano61525f92014-01-17 22:46:492899If set to true, .git/shallow can be updated when new refs
2900require new shallow roots. Otherwise those refs are rejected.
2901
Junio C Hamano322c6242015-03-23 21:32:462902remote.pushDefault::
Junio C Hamano63b6fdb2013-04-07 23:37:132903The remote to push to by default. Overrides
2904`branch.<name>.remote` for all branches, and is overridden by
Junio C Hamano322c6242015-03-23 21:32:462905`branch.<name>.pushRemote` for specific branches.
Junio C Hamano63b6fdb2013-04-07 23:37:132906
Junio C Hamano249572f2006-10-24 05:44:082907remote.<name>.url::
Junio C Hamano35738e82008-01-07 07:55:462908The URL of a remote repository. See linkgit:git-fetch[1] or
2909linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:082910
Junio C Hamano0e88f3e2009-06-21 08:03:252911remote.<name>.pushurl::
2912The push URL of a remote repository. See linkgit:git-push[1].
2913
Junio C Hamano58256872007-12-04 08:31:132914remote.<name>.proxy::
2915For remotes that require curl (http, https and ftp), the URL to
2916the proxy to use for that remote. Set to the empty string to
2917disable proxying for that remote.
2918
Junio C Hamanoffe10ca2016-02-04 00:44:232919remote.<name>.proxyAuthMethod::
2920For remotes that require curl (http, https and ftp), the method to use for
2921authenticating against the proxy in use (probably set in
2922`remote.<name>.proxy`). See `http.proxyAuthMethod`.
2923
Junio C Hamano249572f2006-10-24 05:44:082924remote.<name>.fetch::
Junio C Hamano35738e82008-01-07 07:55:462925The default set of "refspec" for linkgit:git-fetch[1]. See
2926linkgit:git-fetch[1].
Junio C Hamano249572f2006-10-24 05:44:082927
2928remote.<name>.push::
Junio C Hamano35738e82008-01-07 07:55:462929The default set of "refspec" for linkgit:git-push[1]. See
2930linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:082931
Junio C Hamano47d68a52008-05-06 06:35:402932remote.<name>.mirror::
2933If true, pushing to this remote will automatically behave
Junio C Hamanob76a6862012-05-02 22:02:462934as if the `--mirror` option was given on the command line.
Junio C Hamano47d68a52008-05-06 06:35:402935
Junio C Hamano118d2772007-02-21 20:24:102936remote.<name>.skipDefaultUpdate::
2937If true, this remote will be skipped by default when updating
Junio C Hamano9df0c662009-11-23 11:09:272938using linkgit:git-fetch[1] or the `update` subcommand of
2939linkgit:git-remote[1].
2940
2941remote.<name>.skipFetchAll::
2942If true, this remote will be skipped by default when updating
2943using linkgit:git-fetch[1] or the `update` subcommand of
2944linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:102945
Junio C Hamano4ad294b2007-01-20 02:22:502946remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:482947The default program to execute on the remote side when pushing. See
Junio C Hamano1dbca522015-05-22 20:48:552948option --receive-pack of linkgit:git-push[1].
Junio C Hamano4ad294b2007-01-20 02:22:502949
Junio C Hamano54ea8d32007-01-25 07:59:482950remote.<name>.uploadpack::
2951The default program to execute on the remote side when fetching. See
Junio C Hamano1dbca522015-05-22 20:48:552952option --upload-pack of linkgit:git-fetch-pack[1].
Junio C Hamano54ea8d32007-01-25 07:59:482953
Junio C Hamano322c6242015-03-23 21:32:462954remote.<name>.tagOpt::
Junio C Hamano1dbca522015-05-22 20:48:552955Setting this value to --no-tags disables automatic tag following when
2956fetching from remote <name>. Setting it to --tags will fetch every
Junio C Hamanocc7636a2010-05-21 14:57:532957tag from remote <name>, even if they are not reachable from remote
Junio C Hamano075ae872010-09-01 18:43:072958branch heads. Passing these flags directly to linkgit:git-fetch[1] can
Junio C Hamano1dbca522015-05-22 20:48:552959override this setting. See options --tags and --no-tags of
Junio C Hamano075ae872010-09-01 18:43:072960linkgit:git-fetch[1].
Junio C Hamano17dde0e2007-02-26 09:50:212961
Junio C Hamano096dde22009-12-26 23:14:112962remote.<name>.vcs::
Junio C Hamano076ffcc2013-02-06 05:13:212963Setting this to a value <vcs> will cause Git to interact with
Junio C Hamano096dde22009-12-26 23:14:112964the remote with the git-remote-<vcs> helper.
2965
Junio C Hamano8eac2682013-09-09 22:35:202966remote.<name>.prune::
2967When set to true, fetching from this remote by default will also
Junio C Hamano4c8f2d92013-12-13 00:55:422968remove any remote-tracking references that no longer exist on the
2969remote (as if the `--prune` option was given on the command line).
Junio C Hamano8eac2682013-09-09 22:35:202970Overrides `fetch.prune` settings, if any.
2971
Junio C Hamano118d2772007-02-21 20:24:102972remotes.<group>::
2973The list of remotes which are fetched by "git remote update
Junio C Hamano35738e82008-01-07 07:55:462974<group>". See linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:102975
Junio C Hamano322c6242015-03-23 21:32:462976repack.useDeltaBaseOffset::
Junio C Hamanofce7c7e2008-07-02 03:06:382977By default, linkgit:git-repack[1] creates packs that use
2978delta-base offset. If you need to share your repository with
Junio C Hamano076ffcc2013-02-06 05:13:212979Git older than version 1.4.4, either directly or via a dumb
Junio C Hamanofce7c7e2008-07-02 03:06:382980protocol such as http, then you need to set this option to
Junio C Hamano076ffcc2013-02-06 05:13:212981"false" and repack. Access from old Git versions over the
Junio C Hamanofce7c7e2008-07-02 03:06:382982native protocol are unaffected by this option.
Junio C Hamano77b7e902006-10-23 07:18:502983
Junio C Hamano3b0cdc22014-03-18 22:06:162984repack.packKeptObjects::
2985If set to true, makes `git repack` act as if
2986`--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2987details. Defaults to `false` normally, but `true` if a bitmap
2988index is being written (either via `--write-bitmap-index` or
Junio C Hamano38d02532014-06-26 21:48:502989`repack.writeBitmaps`).
2990
2991repack.writeBitmaps::
2992When true, git will write a bitmap index when packing all
2993objects to disk (e.g., when `git repack -a` is run). This
2994index can speed up the "counting objects" phase of subsequent
2995packs created for clones and fetches, at the cost of some disk
Junio C Hamano74fd0fc2016-05-10 21:23:562996space and extra time spent on the initial repack. This has
2997no effect if multiple packfiles are created.
2998Defaults to false.
Junio C Hamano3b0cdc22014-03-18 22:06:162999
Junio C Hamano322c6242015-03-23 21:32:463000rerere.autoUpdate::
Junio C Hamano4653c6f2008-11-26 22:50:203001When set to true, `git-rerere` updates the index with the
3002resulting contents after it cleanly resolves conflicts using
3003previously recorded resolution. Defaults to false.
3004
3005rerere.enabled::
3006Activate recording of resolved conflicts, so that identical
Junio C Hamano4fd24422012-01-06 21:52:433007conflict hunks can be resolved automatically, should they be
3008encountered again. By default, linkgit:git-rerere[1] is
3009enabled if there is an `rr-cache` directory under the
Junio C Hamano864ba892012-01-13 17:42:053010`$GIT_DIR`, e.g. if "rerere" was previously used in the
3011repository.
Junio C Hamano4653c6f2008-11-26 22:50:203012
Junio C Hamano1bbd0f42009-07-23 06:20:293013sendemail.identity::
3014A configuration identity. When given, causes values in the
3015'sendemail.<identity>' subsection to take precedence over
3016values in the 'sendemail' section. The default identity is
Junio C Hamano042f2142016-06-27 18:05:053017the value of `sendemail.identity`.
Junio C Hamano1bbd0f42009-07-23 06:20:293018
Junio C Hamano322c6242015-03-23 21:32:463019sendemail.smtpEncryption::
Junio C Hamano1bbd0f42009-07-23 06:20:293020See linkgit:git-send-email[1] for description. Note that this
3021setting is not subject to the 'identity' mechanism.
3022
Junio C Hamanobe087982015-02-22 21:29:393023sendemail.smtpssl (deprecated)::
Junio C Hamano322c6242015-03-23 21:32:463024Deprecated alias for 'sendemail.smtpEncryption = ssl'.
Junio C Hamano1bbd0f42009-07-23 06:20:293025
Junio C Hamano58f587a2013-07-22 19:20:593026sendemail.smtpsslcertpath::
3027Path to ca-certificates (either a directory or a single file).
3028Set it to an empty string to disable certificate verification.
3029
Junio C Hamano1bbd0f42009-07-23 06:20:293030sendemail.<identity>.*::
3031Identity-specific versions of the 'sendemail.*' parameters
Junio C Hamano7526f0a2017-08-24 18:09:353032found below, taking precedence over those when this
3033identity is selected, through either the command-line or
Junio C Hamano042f2142016-06-27 18:05:053034`sendemail.identity`.
Junio C Hamano1bbd0f42009-07-23 06:20:293035
Junio C Hamano322c6242015-03-23 21:32:463036sendemail.aliasesFile::
3037sendemail.aliasFileType::
Junio C Hamanoea3b7522013-04-18 19:37:533038sendemail.annotate::
Junio C Hamano1bbd0f42009-07-23 06:20:293039sendemail.bcc::
3040sendemail.cc::
Junio C Hamano322c6242015-03-23 21:32:463041sendemail.ccCmd::
3042sendemail.chainReplyTo::
Junio C Hamano1bbd0f42009-07-23 06:20:293043sendemail.confirm::
Junio C Hamano322c6242015-03-23 21:32:463044sendemail.envelopeSender::
Junio C Hamano1bbd0f42009-07-23 06:20:293045sendemail.from::
Junio C Hamano322c6242015-03-23 21:32:463046sendemail.multiEdit::
Junio C Hamano1bbd0f42009-07-23 06:20:293047sendemail.signedoffbycc::
Junio C Hamano322c6242015-03-23 21:32:463048sendemail.smtpPass::
Junio C Hamano1bbd0f42009-07-23 06:20:293049sendemail.suppresscc::
Junio C Hamano322c6242015-03-23 21:32:463050sendemail.suppressFrom::
Junio C Hamano1bbd0f42009-07-23 06:20:293051sendemail.to::
Junio C Hamano4886c772017-11-27 03:33:283052sendemail.tocmd::
Junio C Hamano322c6242015-03-23 21:32:463053sendemail.smtpDomain::
3054sendemail.smtpServer::
3055sendemail.smtpServerPort::
3056sendemail.smtpServerOption::
3057sendemail.smtpUser::
Junio C Hamano1bbd0f42009-07-23 06:20:293058sendemail.thread::
Junio C Hamano322c6242015-03-23 21:32:463059sendemail.transferEncoding::
Junio C Hamano1bbd0f42009-07-23 06:20:293060sendemail.validate::
Junio C Hamanoc9394b22015-01-07 22:45:483061sendemail.xmailer::
Junio C Hamano1bbd0f42009-07-23 06:20:293062See linkgit:git-send-email[1] for description.
3063
Junio C Hamanobe087982015-02-22 21:29:393064sendemail.signedoffcc (deprecated)::
Junio C Hamano042f2142016-06-27 18:05:053065Deprecated alias for `sendemail.signedoffbycc`.
Junio C Hamano1bbd0f42009-07-23 06:20:293066
Junio C Hamano08a3a232017-07-07 02:28:443067sendemail.smtpBatchSize::
3068Number of messages to be sent per connection, after that a relogin
3069will happen. If the value is 0 or undefined, send all messages in
3070one connection.
3071See also the `--batch-size` option of linkgit:git-send-email[1].
3072
3073sendemail.smtpReloginDelay::
3074Seconds wait before reconnecting to smtp server.
3075See also the `--relogin-delay` option of linkgit:git-send-email[1].
3076
Junio C Hamano07824ce2006-04-25 07:36:543077showbranch.default::
Junio C Hamano35738e82008-01-07 07:55:463078The default set of branches for linkgit:git-show-branch[1].
3079See linkgit:git-show-branch[1].
Junio C Hamano07824ce2006-04-25 07:36:543080
Junio C Hamano3d4a66d2017-03-17 21:07:263081splitIndex.maxPercentChange::
3082When the split index feature is used, this specifies the
3083percent of entries the split index can contain compared to the
3084total number of entries in both the split index and the shared
3085index before a new shared index is written.
3086The value should be between 0 and 100. If the value is 0 then
3087a new shared index is always written, if it is 100 a new
3088shared index is never written.
3089By default the value is 20, so a new shared index is written
3090if the number of entries in the split index would be greater
3091than 20 percent of the total number of entries.
3092See linkgit:git-update-index[1].
3093
3094splitIndex.sharedIndexExpire::
3095When the split index feature is used, shared index files that
3096were not modified since the time this variable specifies will
3097be removed when a new shared index file is created. The value
3098"now" expires all entries immediately, and "never" suppresses
3099expiration altogether.
3100The default value is "2.weeks.ago".
3101Note that a shared index file is considered modified (for the
3102purpose of expiration) each time a new split-index file is
3103either created based on it or read from it.
3104See linkgit:git-update-index[1].
3105
Junio C Hamano942b35e2007-12-09 10:19:333106status.relativePaths::
Junio C Hamano35738e82008-01-07 07:55:463107By default, linkgit:git-status[1] shows paths relative to the
Junio C Hamano942b35e2007-12-09 10:19:333108current directory. Setting this variable to `false` shows paths
Junio C Hamano076ffcc2013-02-06 05:13:213109relative to the repository root (this was the default for Git
Junio C Hamano942b35e2007-12-09 10:19:333110prior to v1.5.4).
3111
Junio C Hamano58655592013-07-11 20:52:333112status.short::
3113Set to true to enable --short by default in linkgit:git-status[1].
3114The option --no-short takes precedence over this variable.
3115
3116status.branch::
3117Set to true to enable --branch by default in linkgit:git-status[1].
3118The option --no-branch takes precedence over this variable.
3119
Junio C Hamano79f4c7c2013-09-20 21:03:373120status.displayCommentPrefix::
3121If set to true, linkgit:git-status[1] will insert a comment
3122prefix before each output line (starting with
3123`core.commentChar`, i.e. `#` by default). This was the
3124behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
3125Defaults to false.
3126
Junio C Hamano967cda72017-06-30 21:49:533127status.showStash::
3128If set to true, linkgit:git-status[1] will display the number of
3129entries currently stashed away.
3130Defaults to false.
3131
Junio C Hamano4224f992008-06-23 07:14:083132status.showUntrackedFiles::
3133By default, linkgit:git-status[1] and linkgit:git-commit[1] show
3134files which are not currently tracked by Git. Directories which
3135contain only untracked files, are shown with the directory name
3136only. Showing untracked files means that Git needs to lstat() all
Junio C Hamano2efd5e42014-11-10 22:38:523137the files in the whole repository, which might be slow on some
Junio C Hamano4224f992008-06-23 07:14:083138systems. So, this variable controls how the commands displays
3139the untracked files. Possible values are:
3140+
3141--
Junio C Hamano7f9fa862010-10-19 23:51:143142* `no` - Show no untracked files.
3143* `normal` - Show untracked files and directories.
3144* `all` - Show also individual files in untracked directories.
Junio C Hamano4224f992008-06-23 07:14:083145--
3146+
3147If this variable is not specified, it defaults to 'normal'.
3148This variable can be overridden with the -u|--untracked-files option
3149of linkgit:git-status[1] and linkgit:git-commit[1].
3150
Junio C Hamano322c6242015-03-23 21:32:463151status.submoduleSummary::
Junio C Hamanob671fb52010-06-01 05:06:143152Defaults to false.
3153If this is set to a non zero number or true (identical to -1 or an
3154unlimited number), the submodule summary will be enabled and a
3155summary of commits for modified submodules will be shown (see
Junio C Hamano369e3402013-10-15 18:40:253156--summary-limit option of linkgit:git-submodule[1]). Please note
3157that the summary output command will be suppressed for all
3158submodules when `diff.ignoreSubmodules` is set to 'all' or only
Junio C Hamanoc8c398a2014-06-16 21:14:053159for those submodules where `submodule.<name>.ignore=all`. The only
3160exception to that rule is that status and commit will show staged
3161submodule changes. To
Junio C Hamano369e3402013-10-15 18:40:253162also view the summary for ignored submodules you can either use
Junio C Hamanoe1aeb5e2014-06-06 19:16:293163the --ignore-submodules=dirty command-line option or the 'git
Junio C Hamano369e3402013-10-15 18:40:253164submodule summary' command, which shows a similar output but does
3165not honor these settings.
Junio C Hamanob671fb52010-06-01 05:06:143166
Junio C Hamano1eb56092015-10-05 20:39:533167stash.showPatch::
3168If this is set to true, the `git stash show` command without an
Junio C Hamano967cda72017-06-30 21:49:533169option will show the stash entry in patch form. Defaults to false.
Junio C Hamano1eb56092015-10-05 20:39:533170See description of 'show' command in linkgit:git-stash[1].
3171
3172stash.showStat::
3173If this is set to true, the `git stash show` command without an
Junio C Hamano967cda72017-06-30 21:49:533174option will show diffstat of the stash entry. Defaults to true.
Junio C Hamano1eb56092015-10-05 20:39:533175See description of 'show' command in linkgit:git-stash[1].
3176
Junio C Hamano78e3a782010-07-15 22:24:453177submodule.<name>.url::
Junio C Hamanoc0859f72016-10-17 22:22:573178The URL for a submodule. This variable is copied from the .gitmodules
3179file to the git config via 'git submodule init'. The user can change
3180the configured URL before obtaining the submodule via 'git submodule
Junio C Hamanodc8d0c32017-03-30 23:00:213181update'. If neither submodule.<name>.active or submodule.active are
3182set, the presence of this variable is used as a fallback to indicate
3183whether the submodule is of interest to git commands.
Junio C Hamanoc0859f72016-10-17 22:22:573184See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
Junio C Hamano6bf68cf2015-03-06 23:46:293185
Junio C Hamano78e3a782010-07-15 22:24:453186submodule.<name>.update::
Junio C Hamanoef75f372017-09-29 04:22:333187The method by which a submodule is updated by 'git submodule update',
3188which is the only affected command, others such as
3189'git checkout --recurse-submodules' are unaffected. It exists for
3190historical reasons, when 'git submodule' was the only command to
3191interact with submodules; settings like `submodule.active`
3192and `pull.rebase` are more specific. It is populated by
3193`git submodule init` from the linkgit:gitmodules[5] file.
3194See description of 'update' command in linkgit:git-submodule[1].
Junio C Hamano78e3a782010-07-15 22:24:453195
Junio C Hamanoabad6da2013-01-06 09:06:323196submodule.<name>.branch::
3197The remote branch name for a submodule, used by `git submodule
3198update --remote`. Set this option to override the value found in
3199the `.gitmodules` file. See linkgit:git-submodule[1] and
3200linkgit:gitmodules[5] for details.
3201
Junio C Hamano0d75e872010-12-17 06:57:263202submodule.<name>.fetchRecurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:103203This option can be used to control recursive fetching of this
Junio C Hamano7165bf72011-01-04 22:06:183204submodule. It can be overridden by using the --[no-]recurse-submodules
Junio C Hamanoe1aeb5e2014-06-06 19:16:293205command-line option to "git fetch" and "git pull".
Junio C Hamano0d75e872010-12-17 06:57:263206This setting will override that from in the linkgit:gitmodules[5]
3207file.
3208
Junio C Hamano619596a2010-08-18 22:15:353209submodule.<name>.ignore::
3210Defines under what circumstances "git status" and the diff family show
3211a submodule as modified. When set to "all", it will never be considered
Junio C Hamanoc8c398a2014-06-16 21:14:053212modified (but it will nonetheless show up in the output of status and
3213commit when it has been staged), "dirty" will ignore all changes
3214to the submodules work tree and
Junio C Hamano619596a2010-08-18 22:15:353215takes only differences between the HEAD of the submodule and the commit
3216recorded in the superproject into account. "untracked" will additionally
3217let submodules with modified tracked files in their work tree show up.
3218Using "none" (the default when this option is not set) also shows
3219submodules that have untracked files in their work tree as changed.
3220This setting overrides any setting made in .gitmodules for this submodule,
Junio C Hamanode9745c2010-08-23 17:10:183221both settings can be overridden on the command line by using the
Junio C Hamano369e3402013-10-15 18:40:253222"--ignore-submodules" option. The 'git submodule' commands are not
3223affected by this setting.
Junio C Hamano619596a2010-08-18 22:15:353224
Junio C Hamanodc8d0c32017-03-30 23:00:213225submodule.<name>.active::
3226Boolean value indicating if the submodule is of interest to git
3227commands. This config option takes precedence over the
3228submodule.active config option.
3229
3230submodule.active::
3231A repeated field which contains a pathspec used to match against a
3232submodule's path to determine if the submodule is of interest to git
3233commands.
3234
Junio C Hamano3a31ce52017-06-13 21:15:553235submodule.recurse::
3236Specifies if commands recurse into submodules by default. This
3237applies to all commands that have a `--recurse-submodules` option.
3238Defaults to false.
3239
Junio C Hamanobec5da42016-04-06 22:58:213240submodule.fetchJobs::
3241Specifies how many submodules are fetched/cloned at the same time.
3242A positive integer allows up to that number of submodules fetched
3243in parallel. A value of 0 will give some reasonable default.
3244If unset, it defaults to 1.
3245
Junio C Hamanocd451662016-09-13 00:54:093246submodule.alternateLocation::
3247Specifies how the submodules obtain alternates when submodules are
3248cloned. Possible values are `no`, `superproject`.
3249By default `no` is assumed, which doesn't add references. When the
3250value is set to `superproject` the submodule to be cloned computes
3251its alternates location relative to the superprojects alternate.
3252
Junio C Hamanoce01de82017-02-16 22:59:123253submodule.alternateErrorStrategy::
Junio C Hamanocd451662016-09-13 00:54:093254Specifies how to treat errors with the alternates for a submodule
3255as computed via `submodule.alternateLocation`. Possible values are
3256`ignore`, `info`, `die`. Default is `die`.
3257
Junio C Hamanobec5da42016-04-06 22:58:213258tag.forceSignAnnotated::
3259A boolean to specify whether annotated tags created should be GPG signed.
3260If `--annotate` is specified on the command line, it takes
3261precedence over this option.
3262
Junio C Hamano7b43d412014-07-23 23:09:443263tag.sort::
3264This variable controls the sort ordering of tags when displayed by
3265linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3266value of this variable will be used as the default.
3267
Junio C Hamano75cc4c92006-07-24 08:25:033268tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:093269This variable can be used to restrict the permission bits of
3270tar archive entries. The default is 0002, which turns off the
3271world write bit. The special value "user" indicates that the
3272archiving user's umask will be used instead. See umask(2) and
Junio C Hamano35738e82008-01-07 07:55:463273linkgit:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:033274
Junio C Hamano8fb66e52011-10-05 20:59:513275transfer.fsckObjects::
3276When `fetch.fsckObjects` or `receive.fsckObjects` are
3277not set, the value of this variable is used instead.
3278Defaults to false.
3279
Junio C Hamano322c6242015-03-23 21:32:463280transfer.hideRefs::
Junio C Hamanob6aa12e2015-08-19 22:40:173281String(s) `receive-pack` and `upload-pack` use to decide which
3282refs to omit from their initial advertisements. Use more than
3283one definition to specify multiple prefix strings. A ref that is
3284under the hierarchies listed in the value of this variable is
3285excluded, and is hidden when responding to `git push` or `git
3286fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
3287program-specific versions of this config.
3288+
3289You may also include a `!` in front of the ref name to negate the entry,
3290explicitly exposing it, even if an earlier entry marked it as hidden.
3291If you have multiple hideRefs values, later entries override earlier ones
3292(and entries in more-specific config files override less-specific ones).
Junio C Hamano713eded2015-12-03 00:24:023293+
3294If a namespace is in use, the namespace prefix is stripped from each
3295reference before it is matched against `transfer.hiderefs` patterns.
3296For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3297the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3298is omitted from the advertisements but `refs/heads/master` and
3299`refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3300"have" lines. In order to match refs before stripping, add a `^` in front of
3301the ref name. If you combine `!` and `^`, `!` must be specified first.
Junio C Hamano56ace3d2017-01-10 23:43:413302+
3303Even if you hide refs, a client may still be able to steal the target
3304objects via the techniques described in the "SECURITY" section of the
3305linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3306separate repository.
Junio C Hamano80ad00d2013-02-18 00:19:033307
Junio C Hamano4653c6f2008-11-26 22:50:203308transfer.unpackLimit::
3309When `fetch.unpackLimit` or `receive.unpackLimit` are
3310not set, the value of this variable is used instead.
3311The default value is 100.
3312
Junio C Hamano81703b22014-03-14 22:00:273313uploadarchive.allowUnreachable::
3314If true, allow clients to use `git archive --remote` to request
3315any tree, whether reachable from the ref tips or not. See the
Junio C Hamano56ace3d2017-01-10 23:43:413316discussion in the "SECURITY" section of
Junio C Hamano81703b22014-03-14 22:00:273317linkgit:git-upload-archive[1] for more details. Defaults to
3318`false`.
3319
Junio C Hamano322c6242015-03-23 21:32:463320uploadpack.hideRefs::
Junio C Hamanob6aa12e2015-08-19 22:40:173321This variable is the same as `transfer.hideRefs`, but applies
3322only to `upload-pack` (and so affects only fetches, not pushes).
3323An attempt to fetch a hidden ref by `git fetch` will fail. See
3324also `uploadpack.allowTipSHA1InWant`.
Junio C Hamano5e7f1312013-03-21 22:49:013325
Junio C Hamano85f1fde2015-06-01 20:37:323326uploadpack.allowTipSHA1InWant::
Junio C Hamano322c6242015-03-23 21:32:463327When `uploadpack.hideRefs` is in effect, allow `upload-pack`
Junio C Hamano5e7f1312013-03-21 22:49:013328to accept a fetch request that asks for an object at the tip
3329of a hidden ref (by default, such a request is rejected).
Junio C Hamano56ace3d2017-01-10 23:43:413330See also `uploadpack.hideRefs`. Even if this is false, a client
3331may be able to steal objects via the techniques described in the
3332"SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3333best to keep private data in a separate repository.
Junio C Hamano80ad00d2013-02-18 00:19:033334
Junio C Hamano85f1fde2015-06-01 20:37:323335uploadpack.allowReachableSHA1InWant::
3336Allow `upload-pack` to accept a fetch request that asks for an
3337object that is reachable from any ref tip. However, note that
3338calculating object reachability is computationally expensive.
Junio C Hamano56ace3d2017-01-10 23:43:413339Defaults to `false`. Even if this is false, a client may be able
3340to steal objects via the techniques described in the "SECURITY"
3341section of the linkgit:gitnamespaces[7] man page; it's best to
3342keep private data in a separate repository.
3343
3344uploadpack.allowAnySHA1InWant::
3345Allow `upload-pack` to accept a fetch request that asks for any
3346object at all.
Junio C Hamano85f1fde2015-06-01 20:37:323347Defaults to `false`.
3348
Junio C Hamano322c6242015-03-23 21:32:463349uploadpack.keepAlive::
Junio C Hamano79f4c7c2013-09-20 21:03:373350When `upload-pack` has started `pack-objects`, there may be a
3351quiet period while `pack-objects` prepares the pack. Normally
3352it would output progress information, but if `--quiet` was used
3353for the fetch, `pack-objects` will output nothing at all until
3354the pack data begins. Some clients and networks may consider
3355the server to be hung and give up. Setting this option instructs
3356`upload-pack` to send an empty keepalive packet every
Junio C Hamano322c6242015-03-23 21:32:463357`uploadpack.keepAlive` seconds. Setting this option to 0
Junio C Hamano79f4c7c2013-09-20 21:03:373358disables keepalive packets entirely. The default is 5 seconds.
3359
Junio C Hamanoc6c919b2016-07-06 21:34:153360uploadpack.packObjectsHook::
3361If this option is set, when `upload-pack` would run
3362`git pack-objects` to create a packfile for a client, it will
3363run this shell command instead. The `pack-objects` command and
3364arguments it _would_ have run (including the `git pack-objects`
3365at the beginning) are appended to the shell command. The stdin
3366and stdout of the hook are treated as if `pack-objects` itself
3367was run. I.e., `upload-pack` will feed input intended for
3368`pack-objects` to the hook, and expects a completed packfile on
3369stdout.
3370+
3371Note that this configuration variable is ignored if it is seen in the
3372repository-level config (this is a safety measure against fetching from
3373untrusted repositories).
3374
Junio C Hamano24bc09a2008-02-28 00:27:443375url.<base>.insteadOf::
3376Any URL that starts with this value will be rewritten to
3377start, instead, with <base>. In cases where some site serves a
3378large number of repositories, and serves them with multiple
3379access methods, and some users need to use different access
3380methods, this feature allows people to specify any of the
Junio C Hamano076ffcc2013-02-06 05:13:213381equivalent URLs and have Git automatically rewrite the URL to
Junio C Hamano24bc09a2008-02-28 00:27:443382the best alternative for the particular user, even for a
3383never-before-seen repository on the site. When more than one
3384insteadOf strings match a given URL, the longest match is used.
Junio C Hamanoe0e20df2017-06-04 02:10:213385+
3386Note that any protocol restrictions will be applied to the rewritten
3387URL. If the rewrite changes the URL to use a custom protocol or remote
3388helper, you may need to adjust the `protocol.*.allow` config to permit
3389the request. In particular, protocols you expect to use for submodules
3390must be set to `always` rather than the default of `user`. See the
3391description of `protocol.allow` above.
Junio C Hamano24bc09a2008-02-28 00:27:443392
Junio C Hamano7df6dcf2009-09-13 09:51:173393url.<base>.pushInsteadOf::
3394Any URL that starts with this value will not be pushed to;
3395instead, it will be rewritten to start with <base>, and the
3396resulting URL will be pushed to. In cases where some site serves
3397a large number of repositories, and serves them with multiple
3398access methods, some of which do not allow push, this feature
Junio C Hamano076ffcc2013-02-06 05:13:213399allows people to specify a pull-only URL and have Git
Junio C Hamano7df6dcf2009-09-13 09:51:173400automatically use an appropriate URL to push, even for a
3401never-before-seen repository on the site. When more than one
3402pushInsteadOf strings match a given URL, the longest match is
Junio C Hamano076ffcc2013-02-06 05:13:213403used. If a remote has an explicit pushurl, Git will ignore this
Junio C Hamano7df6dcf2009-09-13 09:51:173404setting for that remote.
3405
Junio C Hamano07824ce2006-04-25 07:36:543406user.email::
3407Your email address to be recorded in any newly created commits.
Junio C Hamano042f2142016-06-27 18:05:053408Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3409`EMAIL` environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:543410
3411user.name::
3412Your full name to be recorded in any newly created commits.
Junio C Hamano042f2142016-06-27 18:05:053413Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
Junio C Hamano35738e82008-01-07 07:55:463414environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:543415
Junio C Hamanof85ef632016-02-17 22:31:063416user.useConfigOnly::
Junio C Hamano042f2142016-06-27 18:05:053417Instruct Git to avoid trying to guess defaults for `user.email`
3418and `user.name`, and instead retrieve the values only from the
Junio C Hamanof85ef632016-02-17 22:31:063419configuration. For example, if you have multiple email addresses
3420and would like to use a different one for each repository, then
3421with this configuration option set to `true` in the global config
3422along with a name, Git will prompt you to set up an email before
3423making new commits in a newly cloned repository.
3424Defaults to `false`.
3425
Junio C Hamano322c6242015-03-23 21:32:463426user.signingKey::
Junio C Hamano369e3402013-10-15 18:40:253427If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3428key you want it to automatically when creating a signed tag or
3429commit, you can override the default selection with this variable.
3430This option is passed unchanged to gpg's --local-user parameter,
3431so you may specify a key using any method that gpg supports.
Junio C Hamanoa890c4f2007-01-28 10:29:213432
Junio C Hamanobcd98f42017-01-24 00:12:163433versionsort.prereleaseSuffix (deprecated)::
3434Deprecated alias for `versionsort.suffix`. Ignored if
3435`versionsort.suffix` is set.
3436
3437versionsort.suffix::
3438Even when version sort is used in linkgit:git-tag[1], tagnames
3439with the same base version but different suffixes are still sorted
3440lexicographically, resulting e.g. in prerelease tags appearing
3441after the main release (e.g. "1.0-rc1" after "1.0"). This
3442variable can be specified to determine the sorting order of tags
3443with different suffixes.
Junio C Hamano07622622015-03-20 21:47:263444+
Junio C Hamanobcd98f42017-01-24 00:12:163445By specifying a single suffix in this variable, any tagname containing
3446that suffix will appear before the corresponding main release. E.g. if
3447the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3448"1.0". If specified multiple times, once per suffix, then the order of
3449suffixes in the configuration will determine the sorting order of tagnames
3450with those suffixes. E.g. if "-pre" appears before "-rc" in the
3451configuration, then all "1.0-preX" tags will be listed before any
3452"1.0-rcX" tags. The placement of the main release tag relative to tags
3453with various suffixes can be determined by specifying the empty suffix
3454among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3455"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3456are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3457"v4.8-bfsX".
3458+
3459If more than one suffixes match the same tagname, then that tagname will
3460be sorted according to the suffix which starts at the earliest position in
3461the tagname. If more than one different matching suffixes start at
3462that earliest position, then that tagname will be sorted according to the
3463longest of those suffixes.
3464The sorting order between different suffixes is undefined if they are
3465in multiple config files.
Junio C Hamano07622622015-03-20 21:47:263466
Junio C Hamano4e272312008-01-08 09:13:213467web.browser::
3468Specify a web browser that may be used by some commands.
3469Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3470may use it.