blob: b18c0f97fec8dda4ba90a245f8e827b57a585cf4 [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 Hamano047135e2017-12-19 21:57:54357waitingForEditor::
358Print a message to the terminal whenever Git is waiting for
359editor input from the user.
Junio C Hamano7df6dcf2009-09-13 09:51:17360--
361
Junio C Hamano07824ce2006-04-25 07:36:54362core.fileMode::
Junio C Hamanod2c28482014-10-24 22:28:25363Tells Git if the executable bit of files in the working tree
364is to be honored.
Junio C Hamano9df0c662009-11-23 11:09:27365+
Junio C Hamanod2c28482014-10-24 22:28:25366Some filesystems lose the executable bit when a file that is
Junio C Hamano6b6144f2017-05-29 06:20:15367marked as executable is checked out, or checks out a
Junio C Hamanod2c28482014-10-24 22:28:25368non-executable file with executable bit on.
369linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
370to see if it handles the executable bit correctly
371and this variable is automatically set as necessary.
372+
373A repository, however, may be on a filesystem that handles
374the filemode correctly, and this variable is set to 'true'
375when created, but later may be made accessible from another
376environment that loses the filemode (e.g. exporting ext4 via
377CIFS mount, visiting a Cygwin created repository with
378Git for Windows or Eclipse).
379In such a case it may be necessary to set this variable to 'false'.
380See linkgit:git-update-index[1].
381+
382The default is true (when core.filemode is not specified in the config file).
Junio C Hamano07824ce2006-04-25 07:36:54383
Junio C Hamano198b1f12016-05-17 22:27:24384core.hideDotFiles::
385(Windows-only) If true, mark newly-created directories and files whose
386name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
387directory is hidden, but no other files starting with a dot. The
388default mode is 'dotGitOnly'.
389
Junio C Hamano322c6242015-03-23 21:32:46390core.ignoreCase::
Junio C Hamano9df0c662009-11-23 11:09:27391If true, this option enables various workarounds to enable
Junio C Hamano076ffcc2013-02-06 05:13:21392Git to work better on filesystems that are not case sensitive,
Junio C Hamano9df0c662009-11-23 11:09:27393like FAT. For example, if a directory listing finds
Junio C Hamano076ffcc2013-02-06 05:13:21394"makefile" when Git expects "Makefile", Git will assume
Junio C Hamano9df0c662009-11-23 11:09:27395it is really the same file, and continue to remember it as
396"Makefile".
397+
398The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
Junio C Hamano322c6242015-03-23 21:32:46399will probe and set core.ignoreCase true if appropriate when the repository
Junio C Hamano9df0c662009-11-23 11:09:27400is created.
401
Junio C Hamano322c6242015-03-23 21:32:46402core.precomposeUnicode::
Junio C Hamano076ffcc2013-02-06 05:13:21403This option is only used by Mac OS implementation of Git.
Junio C Hamano322c6242015-03-23 21:32:46404When core.precomposeUnicode=true, Git reverts the unicode decomposition
Junio C Hamanob61a7772012-07-13 23:34:48405of filenames done by Mac OS. This is useful when sharing a repository
406between Mac OS and Linux or Windows.
Junio C Hamano076ffcc2013-02-06 05:13:21407(Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
408When false, file names are handled fully transparent by Git,
409which is backward compatible with older versions of Git.
Junio C Hamanob61a7772012-07-13 23:34:48410
Junio C Hamano30758bd2014-12-18 20:44:14411core.protectHFS::
412If set to true, do not allow checkout of paths that would
413be considered equivalent to `.git` on an HFS+ filesystem.
414Defaults to `true` on Mac OS, and `false` elsewhere.
415
416core.protectNTFS::
417If set to true, do not allow checkout of paths that would
418cause problems with the NTFS filesystem, e.g. conflict with
4198.3 "short" names.
420Defaults to `true` on Windows, and `false` elsewhere.
421
Junio C Hamanod7105602017-11-21 05:32:50422core.fsmonitor::
423If set, the value of this variable is used as a command which
424will identify all files that may have changed since the
425requested date/time. This information is used to speed up git by
426avoiding unnecessary processing of files that have not changed.
427See the "fsmonitor-watchman" section of linkgit:githooks[5].
428
Junio C Hamano90ccff32008-07-29 08:17:24429core.trustctime::
430If false, the ctime differences between the index and the
Junio C Hamano8fb66e52011-10-05 20:59:51431working tree are ignored; useful when the inode change time
Junio C Hamano90ccff32008-07-29 08:17:24432is regularly modified by something outside Git (file system
433crawlers and some backup systems).
434See linkgit:git-update-index[1]. True by default.
435
Junio C Hamano3d4a66d2017-03-17 21:07:26436core.splitIndex::
437If true, the split-index feature of the index will be used.
438See linkgit:git-update-index[1]. False by default.
439
Junio C Hamano9099a7c2016-02-10 23:42:05440core.untrackedCache::
441Determines what to do about the untracked cache feature of the
442index. It will be kept, if this variable is unset or set to
443`keep`. It will automatically be added if set to `true`. And
444it will automatically be removed, if set to `false`. Before
445setting it to `true`, you should check that mtime is working
446properly on your system.
447See linkgit:git-update-index[1]. `keep` by default.
448
Junio C Hamano322c6242015-03-23 21:32:46449core.checkStat::
Junio C Hamano4cfed0c2013-01-30 17:58:54450Determines which stat fields to match between the index
451and work tree. The user can set this to 'default' or
452'minimal'. Default (or explicitly 'default'), is to check
453all fields, including the sub-second part of mtime and ctime.
454
Junio C Hamano322c6242015-03-23 21:32:46455core.quotePath::
Junio C Hamano0f6f3bf2017-03-13 07:01:53456Commands that output paths (e.g. 'ls-files', 'diff'), will
457quote "unusual" characters in the pathname by enclosing the
458pathname in double-quotes and escaping those characters with
459backslashes in the same way C escapes control characters (e.g.
460`\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
461values larger than 0x80 (e.g. octal `\302\265` for "micro" in
462UTF-8). If this variable is set to false, bytes higher than
4630x80 are not considered "unusual" any more. Double-quotes,
464backslash and control characters are always escaped regardless
465of the setting of this variable. A simple space character is
466not considered "unusual". Many commands can output pathnames
467completely verbatim using the `-z` option. The default value
468is true.
Junio C Hamanod526ba92007-07-02 00:17:42469
Junio C Hamanobb88cf42010-06-21 15:23:55470core.eol::
471Sets the line ending type to use in the working directory for
Junio C Hamanof2a3a752016-05-23 22:54:39472files that have the `text` property set when core.autocrlf is false.
473Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
474native line ending. The default value is `native`. See
Junio C Hamanobb88cf42010-06-21 15:23:55475linkgit:gitattributes[5] for more information on end-of-line
476conversion.
Junio C Hamanod9e0e5d2007-04-14 16:22:04477
Junio C Hamano26e590a2008-02-17 03:53:51478core.safecrlf::
Junio C Hamano076ffcc2013-02-06 05:13:21479If true, makes Git check if converting `CRLF` is reversible when
Junio C Hamanobb88cf42010-06-21 15:23:55480end-of-line conversion is active. Git will verify if a command
Junio C Hamano26e590a2008-02-17 03:53:51481modifies a file in the work tree either directly or indirectly.
482For example, committing a file followed by checking out the
483same file should yield the original file in the work tree. If
484this is not the case for the current setting of
Junio C Hamano076ffcc2013-02-06 05:13:21485`core.autocrlf`, Git will reject the file. The variable can
486be set to "warn", in which case Git will only warn about an
Junio C Hamano26e590a2008-02-17 03:53:51487irreversible conversion but continue the operation.
488+
489CRLF conversion bears a slight chance of corrupting data.
Junio C Hamano076ffcc2013-02-06 05:13:21490When it is enabled, Git will convert CRLF to LF during commit and LF to
Junio C Hamano26e590a2008-02-17 03:53:51491CRLF during checkout. A file that contains a mixture of LF and
Junio C Hamano076ffcc2013-02-06 05:13:21492CRLF before the commit cannot be recreated by Git. For text
Junio C Hamano26e590a2008-02-17 03:53:51493files this is the right thing to do: it corrects line endings
494such that we have only LF line endings in the repository.
495But for binary files that are accidentally classified as text the
496conversion can corrupt data.
497+
498If you recognize such corruption early you can easily fix it by
499setting the conversion type explicitly in .gitattributes. Right
500after committing you still have the original file in your work
501tree and this file is not yet corrupted. You can explicitly tell
Junio C Hamano076ffcc2013-02-06 05:13:21502Git that this file is binary and Git will handle the file
Junio C Hamano26e590a2008-02-17 03:53:51503appropriately.
504+
505Unfortunately, the desired effect of cleaning up text files with
506mixed line endings and the undesired effect of corrupting binary
507files cannot be distinguished. In both cases CRLFs are removed
508in an irreversible way. For text files this is the right thing
509to do because CRLFs are line endings, while for binary files
510converting CRLFs corrupts data.
511+
512Note, this safety check does not mean that a checkout will generate a
513file identical to the original file for a different setting of
Junio C Hamanobb88cf42010-06-21 15:23:55514`core.eol` and `core.autocrlf`, but only for the current one. For
515example, a text file with `LF` would be accepted with `core.eol=lf`
516and could later be checked out with `core.eol=crlf`, in which case the
Junio C Hamano26e590a2008-02-17 03:53:51517resulting file would contain `CRLF`, although the original file
518contained `LF`. However, in both work trees the line endings would be
519consistent, that is either all `LF` or all `CRLF`, but never mixed. A
520file with mixed line endings would be reported by the `core.safecrlf`
521mechanism.
522
Junio C Hamanobb88cf42010-06-21 15:23:55523core.autocrlf::
Junio C Hamanoeed15af2016-07-25 22:49:42524Setting this variable to "true" is the same as setting
525the `text` attribute to "auto" on all files and core.eol to "crlf".
526Set to true if you want to have `CRLF` line endings in your
527working directory and the repository has LF line endings.
528This variable can be set to 'input',
Junio C Hamanobb88cf42010-06-21 15:23:55529in which case no output conversion is performed.
530
Junio C Hamanoaa83a7d2007-03-05 02:37:29531core.symlinks::
532If false, symbolic links are checked out as small plain files that
Junio C Hamano35738e82008-01-07 07:55:46533contain the link text. linkgit:git-update-index[1] and
534linkgit:git-add[1] will not change the recorded type to regular
Junio C Hamanoaa83a7d2007-03-05 02:37:29535file. Useful on filesystems like FAT that do not support
Junio C Hamano9df0c662009-11-23 11:09:27536symbolic links.
537+
538The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
539will probe and set core.symlinks false if appropriate when the repository
540is created.
Junio C Hamanoaa83a7d2007-03-05 02:37:29541
Junio C Hamano07824ce2006-04-25 07:36:54542core.gitProxy::
543A "proxy command" to execute (as 'command host port') instead
544of establishing direct connection to the remote server when
Junio C Hamano076ffcc2013-02-06 05:13:21545using the Git protocol for fetching. If the variable value is
Junio C Hamano07824ce2006-04-25 07:36:54546in the "COMMAND for DOMAIN" format, the command is applied only
547on hostnames ending with the specified domain string. This variable
548may be set multiple times and is matched in the given order;
549the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17550+
Junio C Hamano042f2142016-06-27 18:05:05551Can be overridden by the `GIT_PROXY_COMMAND` environment variable
Junio C Hamanof1d14802006-06-08 00:48:17552(which always applies universally, without the special "for"
553handling).
Junio C Hamanoea82cff2009-03-18 01:54:48554+
555The special string `none` can be used as the proxy command to
556specify that no proxy be used for a given domain pattern.
557This is useful for excluding servers inside a firewall from
558proxy use, while defaulting to a common proxy for external domains.
Junio C Hamano07824ce2006-04-25 07:36:54559
Junio C Hamano1a1b8472016-07-19 21:37:13560core.sshCommand::
561If this variable is set, `git fetch` and `git push` will
562use the specified command instead of `ssh` when they need to
563connect to a remote system. The command is in the same form as
564the `GIT_SSH_COMMAND` environment variable and is overridden
565when the environment variable is set.
566
Junio C Hamano07824ce2006-04-25 07:36:54567core.ignoreStat::
Junio C Hamanoe8acc8e2015-01-14 22:01:34568If true, Git will avoid using lstat() calls to detect if files have
569changed by setting the "assume-unchanged" bit for those tracked files
570which it has updated identically in both the index and working tree.
571+
572When files are modified outside of Git, the user will need to stage
573the modified files explicitly (e.g. see 'Examples' section in
574linkgit:git-update-index[1]).
575Git will not normally detect changes to those files.
576+
577This is useful on systems where lstat() calls are very slow, such as
578CIFS/Microsoft Windows.
579+
580False by default.
Junio C Hamano07824ce2006-04-25 07:36:54581
Junio C Hamano88a3a072006-05-04 08:01:43582core.preferSymlinkRefs::
583Instead of the default "symref" format for HEAD
584and other symbolic reference files, use symbolic links.
585This is sometimes needed to work with old scripts that
586expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54587
Junio C Hamano1025e752007-02-23 07:21:26588core.bare::
589If true this repository is assumed to be 'bare' and has no
590working directory associated with it. If this is the case a
591number of commands that require a working directory will be
Junio C Hamano35738e82008-01-07 07:55:46592disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Junio C Hamano1025e752007-02-23 07:21:26593+
Junio C Hamano35738e82008-01-07 07:55:46594This setting is automatically guessed by linkgit:git-clone[1] or
595linkgit:git-init[1] when the repository was created. By default a
Junio C Hamano1025e752007-02-23 07:21:26596repository that ends in "/.git" is assumed to be not bare (bare =
597false), while all other repositories are assumed to be bare (bare
598= true).
599
Junio C Hamanod526ba92007-07-02 00:17:42600core.worktree::
Junio C Hamano80d58462011-01-24 22:52:52601Set the path to the root of the working tree.
Junio C Hamano042f2142016-06-27 18:05:05602If `GIT_COMMON_DIR` environment variable is set, core.worktree
Junio C Hamano4cc4a842015-05-11 22:41:02603is ignored and not used for determining the root of working tree.
Junio C Hamano042f2142016-06-27 18:05:05604This can be overridden by the `GIT_WORK_TREE` environment
Junio C Hamano92d80372016-07-13 22:00:05605variable and the `--work-tree` command-line option.
Junio C Hamano5cd15182011-04-05 00:21:10606The value can be an absolute path or relative to the path to
Junio C Hamano80d58462011-01-24 22:52:52607the .git directory, which is either specified by --git-dir
608or GIT_DIR, or automatically discovered.
609If --git-dir or GIT_DIR is specified but none of
Junio C Hamano7d575a52008-04-30 08:45:27610--work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamano80d58462011-01-24 22:52:52611the current working directory is regarded as the top level
Junio C Hamano3609b332010-12-29 01:34:52612of your working tree.
Junio C Hamano80d58462011-01-24 22:52:52613+
614Note that this variable is honored even when set in a configuration
615file in a ".git" subdirectory of a directory and its value differs
616from the latter directory (e.g. "/path/to/.git/config" has
617core.worktree set to "/different/path"), which is most likely a
Junio C Hamano076ffcc2013-02-06 05:13:21618misconfiguration. Running Git commands in the "/path/to" directory will
Junio C Hamano80d58462011-01-24 22:52:52619still use "/different/path" as the root of the work tree and can cause
620confusion unless you know what you are doing (e.g. you are creating a
621read-only snapshot of the same index to a location different from the
622repository's usual working tree).
Junio C Hamanod526ba92007-07-02 00:17:42623
Junio C Hamano341071d2006-06-04 07:24:48624core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49625Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamano198b1f12016-05-17 22:27:24626"`$GIT_DIR/logs/<ref>`", by appending the new and old
Junio C Hamanoe3f080d2013-04-22 02:27:13627SHA-1, the date/time and the reason of the update, but
Junio C Hamanoa2ec14f2006-11-02 00:22:48628only when the file exists. If this configuration
Junio C Hamanoa8e42612017-02-03 21:44:07629variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
Junio C Hamano15567bc2011-07-23 00:51:59630file is automatically created for branch heads (i.e. under
Junio C Hamanoa8e42612017-02-03 21:44:07631`refs/heads/`), remote refs (i.e. under `refs/remotes/`),
632note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
633If it is set to `always`, then a missing reflog is automatically
634created for any ref under `refs/`.
Junio C Hamano1caaf472006-12-31 08:29:35635+
636This information can be used to determine what commit
637was the tip of a branch "2 days ago".
638+
639This value is true by default in a repository that has
640a working directory associated with it, and false by
641default in a bare repository.
Junio C Hamano341071d2006-06-04 07:24:48642
Junio C Hamano07824ce2006-04-25 07:36:54643core.repositoryFormatVersion::
644Internal variable identifying the repository format and layout
645version.
646
647core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42648When 'group' (or 'true'), the repository is made shareable between
649several users in a group (making sure all the files and objects are
650group-writable). When 'all' (or 'world' or 'everybody'), the
651repository will be readable by all users, additionally to being
Junio C Hamano076ffcc2013-02-06 05:13:21652group-shareable. When 'umask' (or 'false'), Git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37653reported by umask(2). When '0xxx', where '0xxx' is an octal number,
654files in the repository will have this mode value. '0xxx' will override
Junio C Hamano83eded12009-04-20 08:18:00655user's umask value (whereas the other options will only override
656requested parts of the user's umask value). Examples: '0660' will make
657the repo read/write-able for the owner and group, but inaccessible to
658others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Junio C Hamano2f102bb2008-04-26 02:23:37659repository that is group-readable but not group-writable.
660See linkgit:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54661
662core.warnAmbiguousRefs::
Junio C Hamano076ffcc2013-02-06 05:13:21663If true, Git will warn you if the ref name you passed it is ambiguous
Junio C Hamano947ab822013-03-19 23:07:29664and might match multiple refs in the repository. True by default.
Junio C Hamano07824ce2006-04-25 07:36:54665
Junio C Hamano7ec15722006-07-07 02:03:59666core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09667An integer -1..9, indicating a default compression level.
668-1 is the zlib default. 0 means no compression,
669and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42670If set, this provides a default to other compression variables,
Junio C Hamano042f2142016-06-27 18:05:05671such as `core.looseCompression` and `pack.compression`.
Junio C Hamanoa126a3b2006-07-04 04:55:26672
Junio C Hamano322c6242015-03-23 21:32:46673core.looseCompression::
Junio C Hamanof2ce2972007-05-20 19:12:09674An integer -1..9, indicating the compression level for objects that
675are not in a pack file. -1 is the zlib default. 0 means no
676compression, and 1..9 are various speed/size tradeoffs, 9 being
677slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42678not set, defaults to 1 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49679
Junio C Hamanofc4d38c2007-01-08 06:53:32680core.packedGitWindowSize::
681Number of bytes of a pack file to map into memory in a
682single mapping operation. Larger window sizes may allow
683your system to process a smaller number of large pack files
684more quickly. Smaller window sizes will negatively affect
685performance due to increased calls to the operating system's
686memory manager, but may improve performance when accessing
687a large number of large pack files.
688+
689Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
690MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
691be reasonable for all users/operating systems. You probably do
692not need to adjust this value.
693+
694Common unit suffixes of 'k', 'm', or 'g' are supported.
695
696core.packedGitLimit::
697Maximum number of bytes to map simultaneously into memory
698from pack files. If Git needs to access more than this many
699bytes at once to complete an operation it will unmap existing
700regions to reclaim virtual address space within the process.
701+
Junio C Hamano967cda72017-06-30 21:49:53702Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
703unlimited) on 64 bit platforms.
Junio C Hamanofc4d38c2007-01-08 06:53:32704This should be reasonable for all users/operating systems, except on
705the largest projects. You probably do not need to adjust this value.
706+
707Common unit suffixes of 'k', 'm', or 'g' are supported.
708
Junio C Hamanob8c51282007-03-19 10:43:30709core.deltaBaseCacheLimit::
710Maximum number of bytes to reserve for caching base objects
Junio C Hamano619596a2010-08-18 22:15:35711that may be referenced by multiple deltified objects. By storing the
Junio C Hamanob8c51282007-03-19 10:43:30712entire decompressed base objects in a cache Git is able
713to avoid unpacking and decompressing frequently used base
714objects multiple times.
715+
Junio C Hamanoe1aeb5e2014-06-06 19:16:29716Default is 96 MiB on all platforms. This should be reasonable
Junio C Hamanob8c51282007-03-19 10:43:30717for all users/operating systems, except on the largest projects.
718You probably do not need to adjust this value.
719+
720Common unit suffixes of 'k', 'm', or 'g' are supported.
721
Junio C Hamano5c246f22010-02-03 07:34:53722core.bigFileThreshold::
723Files larger than this size are stored deflated, without
724attempting delta compression. Storing large files without
725delta compression avoids excessive memory usage, at the
Junio C Hamano8e61f1f2014-09-11 21:53:45726slight expense of increased disk usage. Additionally files
727larger than this size are always treated as binary.
Junio C Hamano5c246f22010-02-03 07:34:53728+
729Default is 512 MiB on all platforms. This should be reasonable
730for most projects as source code and other text files can still
731be delta compressed, but larger binary media files won't be.
732+
733Common unit suffixes of 'k', 'm', or 'g' are supported.
Junio C Hamano5c246f22010-02-03 07:34:53734
Junio C Hamano322c6242015-03-23 21:32:46735core.excludesFile::
Junio C Hamano198b1f12016-05-17 22:27:24736Specifies the pathname to the file that contains patterns to
737describe paths that are not meant to be tracked, in addition
738to '.gitignore' (per-directory) and '.git/info/exclude'.
739Defaults to `$XDG_CONFIG_HOME/git/ignore`.
740If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
Junio C Hamano8edb4c72012-07-09 20:33:55741is used instead. See linkgit:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37742
Junio C Hamano322c6242015-03-23 21:32:46743core.askPass::
Junio C Hamano3fd7b262010-09-08 22:44:20744Some commands (e.g. svn and http interfaces) that interactively
745ask for a password can be told to use an external program given
Junio C Hamano042f2142016-06-27 18:05:05746via the value of this variable. Can be overridden by the `GIT_ASKPASS`
Junio C Hamano3fd7b262010-09-08 22:44:20747environment variable. If not set, fall back to the value of the
Junio C Hamano042f2142016-06-27 18:05:05748`SSH_ASKPASS` environment variable or, failing that, a simple password
Junio C Hamano3fd7b262010-09-08 22:44:20749prompt. The external program shall be given a suitable prompt as
Junio C Hamanoe1aeb5e2014-06-06 19:16:29750command-line argument and write the password on its STDOUT.
Junio C Hamano3fd7b262010-09-08 22:44:20751
Junio C Hamano322c6242015-03-23 21:32:46752core.attributesFile::
Junio C Hamano3b4609d2010-09-30 00:04:34753In addition to '.gitattributes' (per-directory) and
Junio C Hamano076ffcc2013-02-06 05:13:21754'.git/info/attributes', Git looks into this file for attributes
Junio C Hamano3b4609d2010-09-30 00:04:34755(see linkgit:gitattributes[5]). Path expansions are made the same
Junio C Hamano322c6242015-03-23 21:32:46756way as for `core.excludesFile`. Its default value is
Junio C Hamano198b1f12016-05-17 22:27:24757`$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
758set or empty, `$HOME/.config/git/attributes` is used instead.
759
760core.hooksPath::
761By default Git will look for your hooks in the
762'$GIT_DIR/hooks' directory. Set this to different path,
763e.g. '/etc/git/hooks', and Git will try to find your hooks in
764that directory, e.g. '/etc/git/hooks/pre-receive' instead of
765in '$GIT_DIR/hooks/pre-receive'.
766+
767The path can be either absolute or relative. A relative path is
768taken as relative to the directory where the hooks are run (see
769the "DESCRIPTION" section of linkgit:githooks[5]).
770+
771This configuration variable is useful in cases where you'd like to
772centrally configure your Git hooks instead of configuring them on a
773per-repository basis, or as a more flexible and centralized
774alternative to having an `init.templateDir` where you've changed
775default hooks.
Junio C Hamano3b4609d2010-09-30 00:04:34776
Junio C Hamanof6002a92007-07-20 10:28:22777core.editor::
Junio C Hamano7ab74c42017-03-27 18:23:59778Commands such as `commit` and `tag` that let you edit
779messages by launching an editor use the value of this
Junio C Hamanof6002a92007-07-20 10:28:22780variable when it is set, and the environment variable
Junio C Hamano3b70d3c2009-11-21 17:37:37781`GIT_EDITOR` is not set. See linkgit:git-var[1].
Junio C Hamanof6002a92007-07-20 10:28:22782
Junio C Hamano322c6242015-03-23 21:32:46783core.commentChar::
Junio C Hamano7ab74c42017-03-27 18:23:59784Commands such as `commit` and `tag` that let you edit
Junio C Hamano3f2ed6f2013-02-04 19:24:09785messages consider a line that begins with this character
786commented, and removes them after the editor returns
787(default '#').
Junio C Hamanoe1aeb5e2014-06-06 19:16:29788+
789If set to "auto", `git-commit` would select a character that is not
790the beginning character of any line in existing commit messages.
Junio C Hamano3f2ed6f2013-02-04 19:24:09791
Junio C Hamanofb1fdf12017-08-27 06:14:59792core.filesRefLockTimeout::
793The length of time, in milliseconds, to retry when trying to
794lock an individual reference. Value 0 means not to retry at
795all; -1 means to try indefinitely. Default is 100 (i.e.,
796retry for 100ms).
797
Junio C Hamano1dbca522015-05-22 20:48:55798core.packedRefsTimeout::
799The length of time, in milliseconds, to retry when trying to
800lock the `packed-refs` file. Value 0 means not to retry at
801all; -1 means to try indefinitely. Default is 1000 (i.e.,
802retry for 1 second).
803
Junio C Hamano6231f822011-10-24 05:18:52804sequence.editor::
Junio C Hamano778a3412013-03-28 23:24:30805Text editor used by `git rebase -i` for editing the rebase instruction file.
Junio C Hamano6231f822011-10-24 05:18:52806The value is meant to be interpreted by the shell when it is used.
807It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
808When not configured the default commit message editor is used instead.
809
Junio C Hamano28d8ede2007-07-05 05:51:38810core.pager::
Junio C Hamano0e0e0d22013-09-12 23:25:03811Text viewer for use by Git commands (e.g., 'less'). The value
812is meant to be interpreted by the shell. The order of preference
813is the `$GIT_PAGER` environment variable, then `core.pager`
814configuration, then `$PAGER`, and then the default chosen at
815compile time (usually 'less').
816+
Junio C Hamanoe1aeb5e2014-06-06 19:16:29817When the `LESS` environment variable is unset, Git sets it to `FRX`
Junio C Hamano0e0e0d22013-09-12 23:25:03818(if `LESS` environment variable is set, Git does not change it at
819all). If you want to selectively override Git's default setting
Junio C Hamanoe1aeb5e2014-06-06 19:16:29820for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
Junio C Hamano0e0e0d22013-09-12 23:25:03821be passed to the shell by Git, which will translate the final
Junio C Hamanoe1aeb5e2014-06-06 19:16:29822command to `LESS=FRX less -S`. The environment does not set the
823`S` option but the command line does, instructing less to truncate
824long lines. Similarly, setting `core.pager` to `less -+F` will
825deactivate the `F` option specified by the environment from the
826command-line, deactivating the "quit if one screen" behavior of
827`less`. One can specifically activate some flags for particular
828commands: for example, setting `pager.blame` to `less -S` enables
829line truncation only for `git blame`.
Junio C Hamanobc8d4782014-01-13 23:35:50830+
831Likewise, when the `LV` environment variable is unset, Git sets it
832to `-c`. You can override this setting by exporting `LV` with
833another value or setting `core.pager` to `lv +c`.
Junio C Hamano28d8ede2007-07-05 05:51:38834
Junio C Hamano942b35e2007-12-09 10:19:33835core.whitespace::
836A comma separated list of common whitespace problems to
Junio C Hamano1aa40d22010-01-21 17:46:43837notice. 'git diff' will use `color.diff.whitespace` to
838highlight them, and 'git apply --whitespace=error' will
Junio C Hamano3db8b412008-07-26 06:45:59839consider them as errors. You can prefix `-` to disable
840any of them (e.g. `-trailing-space`):
Junio C Hamano942b35e2007-12-09 10:19:33841+
Junio C Hamanob71a22d2009-10-17 08:23:47842* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano942b35e2007-12-09 10:19:33843 as an error (enabled by default).
844* `space-before-tab` treats a space character that appears immediately
845 before a tab character in the initial indent part of the line as an
846 error (enabled by default).
Junio C Hamano281fd392012-09-17 23:57:41847* `indent-with-non-tab` treats a line that is indented with space
848 characters instead of the equivalent tabs as an error (not enabled by
849 default).
Junio C Hamanocb39aea2010-05-09 07:24:48850* `tab-in-indent` treats a tab character in the initial indent part of
851 the line as an error (not enabled by default).
Junio C Hamanob71a22d2009-10-17 08:23:47852* `blank-at-eof` treats blank lines added at the end of file as an error
853 (enabled by default).
854* `trailing-space` is a short-hand to cover both `blank-at-eol` and
855 `blank-at-eof`.
Junio C Hamano601f3e52008-02-25 08:40:42856* `cr-at-eol` treats a carriage-return at the end of line as
857 part of the line terminator, i.e. with it, `trailing-space`
858 does not trigger if the character before such a carriage-return
859 is not a whitespace (not enabled by default).
Junio C Hamanoeef01fe2010-12-13 08:31:58860* `tabwidth=<n>` tells how many character positions a tab occupies; this
Junio C Hamano076ffcc2013-02-06 05:13:21861 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
Junio C Hamanoeef01fe2010-12-13 08:31:58862 errors. The default tab width is 8. Allowed values are 1 to 63.
Junio C Hamano942b35e2007-12-09 10:19:33863
Junio C Hamano322c6242015-03-23 21:32:46864core.fsyncObjectFiles::
Junio C Hamano9eb57532008-06-26 06:33:46865This boolean will enable 'fsync()' when writing object files.
866+
867This is a total waste of time and effort on a filesystem that orders
868data writes properly, but can be useful for filesystems that do not use
869journalling (traditional UNIX filesystems) or that only journal metadata
870and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
871
Junio C Hamano322c6242015-03-23 21:32:46872core.preloadIndex::
Junio C Hamano610d1762008-11-28 06:27:13873Enable parallel index preload for operations like 'git diff'
874+
875This can speed up operations like 'git diff' and 'git status' especially
876on filesystems like NFS that have weak caching semantics and thus
Junio C Hamanoc8c398a2014-06-16 21:14:05877relatively high IO latencies. When enabled, Git will do the
Junio C Hamano610d1762008-11-28 06:27:13878index comparison to the filesystem data in parallel, allowing
Junio C Hamanoc8c398a2014-06-16 21:14:05879overlapping IO's. Defaults to true.
Junio C Hamano610d1762008-11-28 06:27:13880
Junio C Hamanoa9499de2009-04-30 03:38:48881core.createObject::
882You can set this to 'link', in which case a hardlink followed by
883a delete of the source are used to make sure that object creation
884will not overwrite existing objects.
885+
886On some file system/operating system combinations, this is unreliable.
887Set this config setting to 'rename' there; However, This will remove the
888check that makes sure that existing object files will not get overwritten.
Junio C Hamanoe91ea772009-04-26 01:41:41889
Junio C Hamano3b70d3c2009-11-21 17:37:37890core.notesRef::
891When showing commit messages, also show notes which are stored in
Junio C Hamanoa574a092010-06-13 19:57:10892the given ref. The ref must be fully qualified. If the given
893ref does not exist, it is not an error but means that no
894notes should be printed.
Junio C Hamano3b70d3c2009-11-21 17:37:37895+
Junio C Hamanoa574a092010-06-13 19:57:10896This setting defaults to "refs/notes/commits", and it can be overridden by
Junio C Hamano042f2142016-06-27 18:05:05897the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
Junio C Hamano3b70d3c2009-11-21 17:37:37898
Junio C Hamano3c8d6702010-01-13 23:09:03899core.sparseCheckout::
900Enable "sparse checkout" feature. See section "Sparse checkout" in
901linkgit:git-read-tree[1] for more information.
902
Junio C Hamano6371b0e2011-03-23 23:36:21903core.abbrev::
Junio C Hamano56ace3d2017-01-10 23:43:41904Set the length object names are abbreviated to. If
905unspecified or set to "auto", an appropriate value is
906computed based on the approximate number of packed objects
907in your repository, which hopefully is enough for
908abbreviated object names to stay unique for some time.
Junio C Hamanoe0e20df2017-06-04 02:10:21909The minimum length is 4.
Junio C Hamano6371b0e2011-03-23 23:36:21910
Junio C Hamano60186642010-12-02 14:18:26911add.ignoreErrors::
Junio C Hamanobe087982015-02-22 21:29:39912add.ignore-errors (deprecated)::
Junio C Hamano1aa40d22010-01-21 17:46:43913Tells 'git add' to continue adding files when some files cannot be
Junio C Hamano92d80372016-07-13 22:00:05914added due to indexing errors. Equivalent to the `--ignore-errors`
Junio C Hamanobe087982015-02-22 21:29:39915option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
916as it does not follow the usual naming convention for configuration
917variables.
Junio C Hamano3d141512009-06-01 01:22:40918
Junio C Hamano33db4372006-06-07 19:51:45919alias.*::
Junio C Hamano35738e82008-01-07 07:55:46920Command aliases for the linkgit:git[1] command wrapper - e.g.
Junio C Hamano33db4372006-06-07 19:51:45921after defining "alias.last = cat-file commit HEAD", the invocation
922"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17923confusion and troubles with script usage, aliases that
Junio C Hamano076ffcc2013-02-06 05:13:21924hide existing Git commands are ignored. Arguments are split by
Junio C Hamanof1d14802006-06-08 00:48:17925spaces, the usual shell quoting and escaping is supported.
Junio C Hamano2efd5e42014-11-10 22:38:52926A quote pair or a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39927+
928If the alias expansion is prefixed with an exclamation point,
929it will be treated as a shell command. For example, defining
930"alias.new = !gitk --all --not ORIG_HEAD", the invocation
931"git new" is equivalent to running the shell command
Junio C Hamano48bc1ce2009-07-09 16:49:19932"gitk --all --not ORIG_HEAD". Note that shell commands will be
933executed from the top-level directory of a repository, which may
934not necessarily be the current directory.
Junio C Hamano042f2142016-06-27 18:05:05935`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
Junio C Hamano5f2627d2011-05-06 20:23:48936from the original current directory. See linkgit:git-rev-parse[1].
Junio C Hamano9cb74f22007-02-12 04:15:05937
Junio C Hamanocaa712a2010-03-11 01:17:35938am.keepcr::
939If true, git-am will call git-mailsplit for patches in mbox format
Junio C Hamano92d80372016-07-13 22:00:05940with parameter `--keep-cr`. In this case git-mailsplit will
Junio C Hamano619596a2010-08-18 22:15:35941not remove `\r` from lines ending with `\r\n`. Can be overridden
Junio C Hamano92d80372016-07-13 22:00:05942by giving `--no-keep-cr` from the command line.
Junio C Hamanocaa712a2010-03-11 01:17:35943See linkgit:git-am[1], linkgit:git-mailsplit[1].
944
Junio C Hamano9c512872015-08-12 21:59:25945am.threeWay::
946By default, `git am` will fail if the patch does not apply cleanly. When
947set to true, this setting tells `git am` to fall back on 3-way merge if
948the patch records the identity of blobs it is supposed to apply to and
949we have those blobs available locally (equivalent to giving the `--3way`
950option from the command line). Defaults to `false`.
951See linkgit:git-am[1].
952
Junio C Hamano322c6242015-03-23 21:32:46953apply.ignoreWhitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43954When set to 'change', tells 'git apply' to ignore changes in
Junio C Hamano92d80372016-07-13 22:00:05955whitespace, in the same way as the `--ignore-space-change`
Junio C Hamanofe24db02009-08-22 05:10:47956option.
Junio C Hamano1aa40d22010-01-21 17:46:43957When set to one of: no, none, never, false tells 'git apply' to
Junio C Hamanofe24db02009-08-22 05:10:47958respect all whitespace differences.
959See linkgit:git-apply[1].
960
Junio C Hamano07824ce2006-04-25 07:36:54961apply.whitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43962Tells 'git apply' how to handle whitespaces, in the same way
Junio C Hamano92d80372016-07-13 22:00:05963as the `--whitespace` option. See linkgit:git-apply[1].
Junio C Hamano07824ce2006-04-25 07:36:54964
Junio C Hamano3a9c0342017-11-10 06:01:12965blame.showRoot::
966Do not treat root commits as boundaries in linkgit:git-blame[1].
967This option defaults to false.
968
969blame.blankBoundary::
970Show blank commit object name for boundary commits in
971linkgit:git-blame[1]. This option defaults to false.
972
973blame.showEmail::
974Show the author email instead of author name in linkgit:git-blame[1].
975This option defaults to false.
976
977blame.date::
978Specifies the format used to output dates in linkgit:git-blame[1].
979If unset the iso format is used. For supported values,
980see the discussion of the `--date` option at linkgit:git-log[1].
981
Junio C Hamano322c6242015-03-23 21:32:46982branch.autoSetupMerge::
Junio C Hamano1aa40d22010-01-21 17:46:43983Tells 'git branch' and 'git checkout' to set up new branches
Junio C Hamano24bc09a2008-02-28 00:27:44984so that linkgit:git-pull[1] will appropriately merge from the
985starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32986this behavior can be chosen per-branch using the `--track`
Junio C Hamano24bc09a2008-02-28 00:27:44987and `--no-track` options. The valid settings are: `false` -- no
988automatic setup is done; `true` -- automatic setup is done when the
Junio C Hamano97bcb482010-11-25 03:16:07989starting point is a remote-tracking branch; `always` --
990automatic setup is done when the starting point is either a
991local branch or remote-tracking
Junio C Hamano24bc09a2008-02-28 00:27:44992branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32993
Junio C Hamano322c6242015-03-23 21:32:46994branch.autoSetupRebase::
Junio C Hamano1aa40d22010-01-21 17:46:43995When a new branch is created with 'git branch' or 'git checkout'
Junio C Hamano076ffcc2013-02-06 05:13:21996that tracks another branch, this variable tells Git to set
Junio C Hamano869bb802008-05-12 00:29:47997up pull to rebase instead of merge (see "branch.<name>.rebase").
998When `never`, rebase is never automatically set to true.
999When `local`, rebase is set to true for tracked branches of
1000other local branches.
1001When `remote`, rebase is set to true for tracked branches of
Junio C Hamano97bcb482010-11-25 03:16:071002remote-tracking branches.
Junio C Hamano869bb802008-05-12 00:29:471003When `always`, rebase will be set to true for all tracking
1004branches.
Junio C Hamano322c6242015-03-23 21:32:461005See "branch.autoSetupMerge" for details on how to set up a
Junio C Hamano869bb802008-05-12 00:29:471006branch to track another branch.
1007This option defaults to never.
1008
Junio C Hamano47c1e3c2006-09-25 04:45:551009branch.<name>.remote::
Junio C Hamano63b6fdb2013-04-07 23:37:131010When on branch <name>, it tells 'git fetch' and 'git push'
1011which remote to fetch from/push to. The remote to push to
Junio C Hamano322c6242015-03-23 21:32:461012may be overridden with `remote.pushDefault` (for all branches).
Junio C Hamano63b6fdb2013-04-07 23:37:131013The remote to push to, for the current branch, may be further
Junio C Hamano322c6242015-03-23 21:32:461014overridden by `branch.<name>.pushRemote`. If no remote is
Junio C Hamano63b6fdb2013-04-07 23:37:131015configured, or if you are not on any branch, it defaults to
Junio C Hamano322c6242015-03-23 21:32:461016`origin` for fetching and `remote.pushDefault` for pushing.
Junio C Hamano238ce9c2013-10-23 21:56:381017Additionally, `.` (a period) is the current local repository
1018(a dot-repository), see `branch.<name>.merge`'s final note below.
Junio C Hamano63b6fdb2013-04-07 23:37:131019
Junio C Hamano322c6242015-03-23 21:32:461020branch.<name>.pushRemote::
Junio C Hamano63b6fdb2013-04-07 23:37:131021When on branch <name>, it overrides `branch.<name>.remote` for
Junio C Hamano322c6242015-03-23 21:32:461022pushing. It also overrides `remote.pushDefault` for pushing
Junio C Hamano63b6fdb2013-04-07 23:37:131023from branch <name>. When you pull from one place (e.g. your
1024upstream) and push to another place (e.g. your own publishing
Junio C Hamano322c6242015-03-23 21:32:461025repository), you would want to set `remote.pushDefault` to
Junio C Hamano63b6fdb2013-04-07 23:37:131026specify the remote to push to for all branches, and use this
1027option to override it for a specific branch.
Junio C Hamano47c1e3c2006-09-25 04:45:551028
1029branch.<name>.merge::
Junio C Hamano0706c802009-03-30 22:34:191030Defines, together with branch.<name>.remote, the upstream branch
Junio C Hamanob02377c2011-04-28 22:26:021031for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
Junio C Hamano1aa40d22010-01-21 17:46:431032branch to merge and can also affect 'git push' (see push.default).
1033When in branch <name>, it tells 'git fetch' the default
Junio C Hamanoc2b47092007-10-25 06:50:311034refspec to be marked for merging in FETCH_HEAD. The value is
1035handled like the remote part of a refspec, and must match a
1036ref which is fetched from the remote given by
1037"branch.<name>.remote".
Junio C Hamano1aa40d22010-01-21 17:46:431038The merge information is used by 'git pull' (which at first calls
1039'git fetch') to lookup the default branch for merging. Without
1040this option, 'git pull' defaults to merge the first refspec fetched.
Junio C Hamano96010b22006-12-09 21:15:461041Specify multiple values to get an octopus merge.
Junio C Hamano1aa40d22010-01-21 17:46:431042If you wish to setup 'git pull' so that it merges into <name> from
Junio C Hamano6e149c02007-03-16 10:21:071043another branch in the local repository, you can point
Junio C Hamano238ce9c2013-10-23 21:56:381044branch.<name>.merge to the desired branch, and use the relative path
1045setting `.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:551046
Junio C Hamano322c6242015-03-23 21:32:461047branch.<name>.mergeOptions::
Junio C Hamano1b50ce92007-10-03 12:05:531048Sets default options for merging into branch <name>. The syntax and
Junio C Hamanoc0e55e72009-10-10 00:56:291049supported options are the same as those of linkgit:git-merge[1], but
Junio C Hamano1b50ce92007-10-03 12:05:531050option values containing whitespace characters are currently not
1051supported.
1052
Junio C Hamano0c999702007-12-03 09:57:551053branch.<name>.rebase::
1054When true, rebase the branch <name> on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:081055instead of merging the default branch from the default remote when
Junio C Hamano515ab1d2011-12-09 23:41:201056"git pull" is run. See "pull.rebase" for doing this in a non
1057branch-specific manner.
1058+
Junio C Hamano7db630e2015-09-17 20:26:221059When preserve, also pass `--preserve-merges` along to 'git rebase'
1060so that locally committed merge commits will not be flattened
1061by running 'git pull'.
Junio C Hamanocf4a1742013-09-11 22:57:501062+
Junio C Hamano289d7e82016-01-27 00:20:381063When the value is `interactive`, the rebase is run in interactive mode.
1064+
Junio C Hamano515ab1d2011-12-09 23:41:201065*NOTE*: this is a possibly dangerous operation; do *not* use
1066it unless you understand the implications (see linkgit:git-rebase[1]
1067for details).
Junio C Hamano0c999702007-12-03 09:57:551068
Junio C Hamano46247182013-01-09 20:50:281069branch.<name>.description::
1070Branch description, can be edited with
1071`git branch --edit-description`. Branch description is
1072automatically added in the format-patch cover letter or
1073request-pull summary.
1074
Junio C Hamano8760ea62008-03-14 08:58:451075browser.<tool>.cmd::
1076Specify the command to invoke the specified browser. The
1077specified command is evaluated in shell with the URLs passed
Junio C Hamano360e3a12011-07-13 23:51:561078as arguments. (See linkgit:git-web{litdd}browse[1].)
Junio C Hamano8760ea62008-03-14 08:58:451079
Junio C Hamanoe35a6fc2008-01-29 09:46:271080browser.<tool>.path::
1081Override the path for the given tool that may be used to
Junio C Hamano92d80372016-07-13 22:00:051082browse HTML help (see `-w` option in linkgit:git-help[1]) or a
Junio C Hamanoe35a6fc2008-01-29 09:46:271083working repository in gitweb (see linkgit:git-instaweb[1]).
1084
Junio C Hamano47b9acd2007-04-24 07:34:341085clean.requireForce::
Junio C Hamanoe6f28d02013-09-17 21:34:001086A boolean to make git-clean do nothing unless given -f,
1087-i or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:341088
Junio C Hamanoeb692952007-01-03 22:02:121089color.branch::
1090A boolean to enable/disable color in the output of
Junio C Hamano5d4238d2017-10-18 03:01:151091linkgit:git-branch[1]. May be set to `always`,
1092`false` (or `never`) or `auto` (or `true`), in which case colors are used
1093only when the output is to a terminal. If unset, then the
1094value of `color.ui` is used (`auto` by default).
Junio C Hamanoeb692952007-01-03 22:02:121095
1096color.branch.<slot>::
1097Use customized color for branch coloration. `<slot>` is one of
1098`current` (the current branch), `local` (a local branch),
Junio C Hamano76927822013-04-19 21:26:571099`remote` (a remote-tracking branch in refs/remotes/),
1100`upstream` (upstream tracking branch), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:221101refs).
Junio C Hamanoeb692952007-01-03 22:02:121102
Junio C Hamano3f403b02006-12-13 10:14:131103color.diff::
Junio C Hamano5f2627d2011-05-06 20:23:481104Whether to use ANSI escape sequences to add color to patches.
Junio C Hamano5d4238d2017-10-18 03:01:151105If this is set to `always`, linkgit:git-diff[1],
Junio C Hamano5f2627d2011-05-06 20:23:481106linkgit:git-log[1], and linkgit:git-show[1] will use color
Junio C Hamano5d4238d2017-10-18 03:01:151107for all patches. If it is set to `true` or `auto`, those
1108commands will only use color when output is to the terminal.
1109If unset, then the value of `color.ui` is used (`auto` by
1110default).
Junio C Hamano5f2627d2011-05-06 20:23:481111+
Junio C Hamanod75148a2014-04-08 19:48:381112This does not affect linkgit:git-format-patch[1] or the
Junio C Hamano5f2627d2011-05-06 20:23:481113'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1114command line with the `--color[=<when>]` option.
Junio C Hamano9ae1a062006-07-10 08:12:341115
Junio C Hamanofb1fdf12017-08-27 06:14:591116diff.colorMoved::
1117If set to either a valid `<mode>` or a true value, moved lines
1118in a diff are colored differently, for details of valid modes
1119see '--color-moved' in linkgit:git-diff[1]. If simply set to
1120true the default color mode will be used. When set to false,
1121moved lines are not colored.
1122
Junio C Hamano3f403b02006-12-13 10:14:131123color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:221124Use customized color for diff colorization. `<slot>` specifies
1125which part of the patch to use the specified color, and is one
Junio C Hamano8c5d5942015-06-11 19:37:481126of `context` (context text - `plain` is a historical synonym),
1127`meta` (metainformation), `frag`
Junio C Hamano2bd8a742009-12-01 21:16:591128(hunk header), 'func' (function in hunk header), `old` (removed lines),
Junio C Hamanofb1fdf12017-08-27 06:14:591129`new` (added lines), `commit` (commit headers), `whitespace`
1130(highlighting whitespace errors), `oldMoved` (deleted lines),
1131`newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1132`oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1133and `newMovedAlternativeDimmed` (See the '<mode>'
1134setting of '--color-moved' in linkgit:git-diff[1] for details).
Junio C Hamano9ae1a062006-07-10 08:12:341135
Junio C Hamano7d449522010-07-01 00:08:511136color.decorate.<slot>::
1137Use customized color for 'git log --decorate' output. `<slot>` is one
1138of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
Junio C Hamano97bcb482010-11-25 03:16:071139branches, remote-tracking branches, tags, stash and HEAD, respectively.
Junio C Hamano7d449522010-07-01 00:08:511140
Junio C Hamanod257cff2009-03-18 05:27:161141color.grep::
1142When set to `always`, always highlight matches. When `false` (or
1143`never`), never. When set to `true` or `auto`, use color only
Junio C Hamanoad70bf02016-09-26 23:44:271144when the output is written to the terminal. If unset, then the
1145value of `color.ui` is used (`auto` by default).
Junio C Hamanod257cff2009-03-18 05:27:161146
Junio C Hamano0299d922010-03-20 20:59:311147color.grep.<slot>::
1148Use customized color for grep colorization. `<slot>` specifies which
1149part of the line to use the specified color, and is one of
1150+
1151--
1152`context`;;
1153non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1154`filename`;;
1155filename prefix (when not using `-h`)
1156`function`;;
1157function name lines (when using `-p`)
1158`linenumber`;;
1159line number prefix (when using `-n`)
1160`match`;;
Junio C Hamanoc14e6ad2014-10-31 20:25:531161matching text (same as setting `matchContext` and `matchSelected`)
1162`matchContext`;;
1163matching text in context lines
1164`matchSelected`;;
1165matching text in selected lines
Junio C Hamano0299d922010-03-20 20:59:311166`selected`;;
1167non-matching text in selected lines
1168`separator`;;
1169separators between fields on a line (`:`, `-`, and `=`)
1170and between hunks (`--`)
1171--
Junio C Hamanod257cff2009-03-18 05:27:161172
Junio C Hamano00b8b632007-12-07 09:50:491173color.interactive::
Junio C Hamano5d4238d2017-10-18 03:01:151174When set to `always`, always use colors for interactive prompts
Junio C Hamano58f587a2013-07-22 19:20:591175and displays (such as those used by "git-add --interactive" and
Junio C Hamano5d4238d2017-10-18 03:01:151176"git-clean --interactive"). When false (or `never`), never.
1177When set to `true` or `auto`, use colors only when the output is
1178to the terminal. If unset, then the value of `color.ui` is
1179used (`auto` by default).
Junio C Hamano00b8b632007-12-07 09:50:491180
1181color.interactive.<slot>::
Junio C Hamano58f587a2013-07-22 19:20:591182Use customized color for 'git add --interactive' and 'git clean
1183--interactive' output. `<slot>` may be `prompt`, `header`, `help`
1184or `error`, for four distinct types of normal output from
Junio C Hamano07622622015-03-20 21:47:261185interactive commands.
Junio C Hamano00b8b632007-12-07 09:50:491186
Junio C Hamanoe7935c42006-12-13 21:32:171187color.pager::
1188A boolean to enable/disable colored output when the pager is in
1189use (default is true).
1190
Junio C Hamano322c6242015-03-23 21:32:461191color.showBranch::
Junio C Hamano52ba2952009-05-18 17:43:021192A boolean to enable/disable color in the output of
1193linkgit:git-show-branch[1]. May be set to `always`,
1194`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoad70bf02016-09-26 23:44:271195only when the output is to a terminal. If unset, then the
1196value of `color.ui` is used (`auto` by default).
Junio C Hamano52ba2952009-05-18 17:43:021197
Junio C Hamanoe7935c42006-12-13 21:32:171198color.status::
1199A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:461200linkgit:git-status[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:211201`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoad70bf02016-09-26 23:44:271202only when the output is to a terminal. If unset, then the
1203value of `color.ui` is used (`auto` by default).
Junio C Hamanoe7935c42006-12-13 21:32:171204
1205color.status.<slot>::
1206Use customized color for status colorization. `<slot>` is
1207one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:041208`added` or `updated` (files which are added but not committed),
1209`changed` (files which are changed but not added in the index),
Junio C Hamano076ffcc2013-02-06 05:13:211210`untracked` (files which are not tracked by Git),
Junio C Hamano5992a252015-03-17 23:39:301211`branch` (the current branch),
Junio C Hamanob713ff12008-05-24 01:12:301212`nobranch` (the color the 'no branch' warning is shown in, defaulting
Junio C Hamanod5176902017-05-16 04:30:561213to red),
1214`localBranch` or `remoteBranch` (the local and remote branch names,
1215respectively, when branch and tracking information is displayed in the
1216status short-format), or
Junio C Hamano5992a252015-03-17 23:39:301217`unmerged` (files which have unmerged changes).
Junio C Hamanoe7935c42006-12-13 21:32:171218
Junio C Hamano83d46a22008-02-21 02:29:421219color.ui::
Junio C Hamano5f2627d2011-05-06 20:23:481220This variable determines the default value for variables such
1221as `color.diff` and `color.grep` that control the use of color
1222per command family. Its scope will expand as more commands learn
1223configuration to set a default for the `--color` option. Set it
Junio C Hamanofa1d3492013-06-20 23:39:431224to `false` or `never` if you prefer Git commands not to use
1225color unless enabled explicitly with some other configuration
Junio C Hamano5d4238d2017-10-18 03:01:151226or the `--color` option. Set it to `always` if you want all
1227output not intended for machine consumption to use color, to
1228`true` or `auto` (this is the default since Git 1.8.4) if you
1229want such output to use color when written to the terminal.
Junio C Hamano83d46a22008-02-21 02:29:421230
Junio C Hamano22700fb2012-05-03 23:07:251231column.ui::
1232Specify whether supported commands should output in columns.
1233This variable consists of a list of tokens separated by spaces
1234or commas:
1235+
Junio C Hamanoa1952302013-07-01 21:31:181236These options control when the feature should be enabled
1237(defaults to 'never'):
1238+
Junio C Hamano22700fb2012-05-03 23:07:251239--
1240`always`;;
1241always show in columns
1242`never`;;
1243never show in columns
1244`auto`;;
1245show in columns if the output is to the terminal
Junio C Hamanoa1952302013-07-01 21:31:181246--
1247+
1248These options control layout (defaults to 'column'). Setting any
1249of these implies 'always' if none of 'always', 'never', or 'auto' are
1250specified.
1251+
1252--
Junio C Hamano22700fb2012-05-03 23:07:251253`column`;;
Junio C Hamanoa1952302013-07-01 21:31:181254fill columns before rows
Junio C Hamano22700fb2012-05-03 23:07:251255`row`;;
1256fill rows before columns
1257`plain`;;
1258show in one column
Junio C Hamanoa1952302013-07-01 21:31:181259--
1260+
1261Finally, these options can be combined with a layout option (defaults
1262to 'nodense'):
1263+
1264--
Junio C Hamano22700fb2012-05-03 23:07:251265`dense`;;
1266make unequal size columns to utilize more space
1267`nodense`;;
1268make equal size columns
1269--
Junio C Hamano22700fb2012-05-03 23:07:251270
1271column.branch::
1272Specify whether to output branch listing in `git branch` in columns.
1273See `column.ui` for details.
1274
Junio C Hamano58f587a2013-07-22 19:20:591275column.clean::
1276Specify the layout when list items in `git clean -i`, which always
1277shows files and directories in columns. See `column.ui` for details.
1278
Junio C Hamano22700fb2012-05-03 23:07:251279column.status::
1280Specify whether to output untracked files in `git status` in columns.
1281See `column.ui` for details.
1282
1283column.tag::
1284Specify whether to output tag listing in `git tag` in columns.
1285See `column.ui` for details.
1286
Junio C Hamanoce836cc2013-01-21 02:01:531287commit.cleanup::
1288This setting overrides the default of the `--cleanup` option in
1289`git commit`. See linkgit:git-commit[1] for details. Changing the
1290default can be useful when you always want to keep lines that begin
1291with comment character `#` in your log message, in which case you
1292would do `git config commit.cleanup whitespace` (note that you will
1293have to remove the help lines that begin with `#` in the commit log
1294template yourself, if you do this).
1295
Junio C Hamano322c6242015-03-23 21:32:461296commit.gpgSign::
Junio C Hamano5b3533d2014-02-27 23:07:151297
1298A boolean to specify whether all commits should be GPG signed.
1299Use of this option when doing operations such as rebase can
1300result in a large number of commits being signed. It may be
1301convenient to use an agent to avoid typing your GPG passphrase
1302several times.
1303
Junio C Hamanod0d892c2010-01-24 20:06:291304commit.status::
Junio C Hamano6ce6b6c2010-01-18 01:25:501305A boolean to enable/disable inclusion of status information in the
1306commit message template when using an editor to prepare the commit
1307message. Defaults to true.
1308
Junio C Hamano4653c6f2008-11-26 22:50:201309commit.template::
Junio C Hamano198b1f12016-05-17 22:27:241310Specify the pathname of a file to use as the template for
1311new commit messages.
Junio C Hamano4653c6f2008-11-26 22:50:201312
Junio C Hamanof2a3a752016-05-23 22:54:391313commit.verbose::
1314A boolean or int to specify the level of verbose with `git commit`.
1315See linkgit:git-commit[1].
1316
Junio C Hamano0df92712011-12-21 22:30:441317credential.helper::
1318Specify an external helper to be called when a username or
1319password credential is needed; the helper may consult external
Junio C Hamano4ba4a782016-04-03 19:11:321320storage to avoid prompting the user for the credentials. Note
1321that multiple helpers may be defined. See linkgit:gitcredentials[7]
1322for details.
Junio C Hamano0df92712011-12-21 22:30:441323
1324credential.useHttpPath::
1325When acquiring credentials, consider the "path" component of an http
1326or https URL to be important. Defaults to false. See
1327linkgit:gitcredentials[7] for more information.
1328
1329credential.username::
1330If no username is set for a network authentication, use this username
1331by default. See credential.<context>.* below, and
1332linkgit:gitcredentials[7].
1333
1334credential.<url>.*::
1335Any of the credential.* options above can be applied selectively to
1336some credentials. For example "credential.https://example.com.username"
1337would set the default username only for https connections to
1338example.com. See linkgit:gitcredentials[7] for details on how URLs are
1339matched.
1340
Junio C Hamanoabb8a052015-12-04 22:43:111341credentialCache.ignoreSIGHUP::
1342Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1343
Junio C Hamano209ebe82011-04-27 21:09:591344include::diff-config.txt[]
Junio C Hamano3bd66e92009-04-18 06:17:561345
1346difftool.<tool>.path::
1347Override the path for the given tool. This is useful in case
1348your tool is not in the PATH.
1349
1350difftool.<tool>.cmd::
1351Specify the command to invoke the specified diff tool.
1352The specified command is evaluated in shell with the following
1353variables available: 'LOCAL' is set to the name of the temporary
1354file containing the contents of the diff pre-image and 'REMOTE'
1355is set to the name of the temporary file containing the contents
1356of the diff post-image.
1357
1358difftool.prompt::
1359Prompt before each invocation of the diff tool.
1360
Junio C Hamanofedb1b42016-06-20 21:23:401361fastimport.unpackLimit::
1362If the number of objects imported by linkgit:git-fast-import[1]
1363is below this limit, then the objects will be unpacked into
1364loose object files. However if the number of imported objects
1365equals or exceeds this limit then the pack will be stored as a
1366pack. Storing the pack from a fast-import can make the import
1367operation complete faster, especially on slow filesystems. If
1368not set, the value of `transfer.unpackLimit` is used instead.
1369
Junio C Hamano0d75e872010-12-17 06:57:261370fetch.recurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:101371This option can be either set to a boolean value or to 'on-demand'.
1372Setting it to a boolean changes the behavior of fetch and pull to
1373unconditionally recurse into submodules when set to true or to not
1374recurse at all when set to false. When set to 'on-demand' (the default
1375value), fetch and pull will only recurse into a populated submodule
1376when its superproject retrieves a commit that updates the submodule's
1377reference.
Junio C Hamano0d75e872010-12-17 06:57:261378
Junio C Hamano8fb66e52011-10-05 20:59:511379fetch.fsckObjects::
1380If it is set to true, git-fetch-pack will check all fetched
1381objects. It will abort in the case of a malformed object or a
1382broken link. The result of an abort are only dangling objects.
1383Defaults to false. If not set, the value of `transfer.fsckObjects`
1384is used instead.
1385
Junio C Hamano54ea8d32007-01-25 07:59:481386fetch.unpackLimit::
Junio C Hamano076ffcc2013-02-06 05:13:211387If the number of objects fetched over the Git native
Junio C Hamano54ea8d32007-01-25 07:59:481388transfer is below this
1389limit, then the objects will be unpacked into loose object
1390files. However if the number of received objects equals or
1391exceeds this limit then the received pack will be stored as
1392a pack, after adding any missing delta bases. Storing the
1393pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:171394especially on slow filesystems. If not set, the value of
1395`transfer.unpackLimit` is used instead.
Junio C Hamano54ea8d32007-01-25 07:59:481396
Junio C Hamano8eac2682013-09-09 22:35:201397fetch.prune::
1398If true, fetch will automatically behave as if the `--prune`
1399option was given on the command line. See also `remote.<name>.prune`.
1400
Junio C Hamano1a1b8472016-07-19 21:37:131401fetch.output::
1402Control how ref update status is printed. Valid values are
1403`full` and `compact`. Default value is `full`. See section
1404OUTPUT in linkgit:git-fetch[1] for detail.
1405
Junio C Hamanof4581102009-04-25 08:29:591406format.attach::
1407Enable multipart/mixed attachments as the default for
1408'format-patch'. The value can also be a double quoted string
1409which will enable attachments as the default and set the
1410value as the boundary. See the --attach option in
1411linkgit:git-format-patch[1].
1412
Junio C Hamanoaf182942016-08-10 20:46:261413format.from::
1414Provides the default value for the `--from` option to format-patch.
1415Accepts a boolean value, or a name and email address. If false,
1416format-patch defaults to `--no-from`, using commit authors directly in
1417the "From:" field of patch mails. If true, format-patch defaults to
1418`--from`, using your committer identity in the "From:" field of patch
1419mails and including a "From:" field in the body of the patch mail if
1420different. If set to a non-boolean value, format-patch uses that
1421value instead of your committer identity. Defaults to false.
1422
Junio C Hamano8c5802d2007-11-15 00:13:361423format.numbered::
Junio C Hamano7d06a8a2008-10-20 05:42:331424A boolean which can enable or disable sequence numbers in patch
1425subjects. It defaults to "auto" which enables it only if there
1426is more than one patch. It can be enabled or disabled for all
1427messages by setting it to "true" or "false". See --numbered
1428option in linkgit:git-format-patch[1].
Junio C Hamano8c5802d2007-11-15 00:13:361429
Junio C Hamano07824ce2006-04-25 07:36:541430format.headers::
1431Additional email headers to include in a patch to be submitted
Junio C Hamano35738e82008-01-07 07:55:461432by mail. See linkgit:git-format-patch[1].
Junio C Hamano07824ce2006-04-25 07:36:541433
Junio C Hamano70664a02010-07-13 22:48:051434format.to::
Junio C Hamanof4581102009-04-25 08:29:591435format.cc::
Junio C Hamano70664a02010-07-13 22:48:051436Additional recipients to include in a patch to be submitted
1437by mail. See the --to and --cc options in
1438linkgit:git-format-patch[1].
Junio C Hamanof4581102009-04-25 08:29:591439
Junio C Hamano322c6242015-03-23 21:32:461440format.subjectPrefix::
Junio C Hamanof4581102009-04-25 08:29:591441The default for format-patch is to output files with the '[PATCH]'
1442subject prefix. Use this variable to change that prefix.
1443
Junio C Hamano89a57342010-06-22 23:22:551444format.signature::
1445The default for format-patch is to output a signature containing
Junio C Hamano076ffcc2013-02-06 05:13:211446the Git version number. Use this variable to change that default.
Junio C Hamano89a57342010-06-22 23:22:551447Set this variable to the empty string ("") to suppress
1448signature generation.
1449
Junio C Hamano322c6242015-03-23 21:32:461450format.signatureFile::
Junio C Hamanoc8c398a2014-06-16 21:14:051451Works just like format.signature except the contents of the
1452file specified by this variable will be used as the signature.
1453
Junio C Hamanod4c8e112007-03-04 10:32:381454format.suffix::
1455The default for format-patch is to output files with the suffix
1456`.patch`. Use this variable to change that suffix (make sure to
1457include the dot if you want it).
1458
Junio C Hamano86bcccc2008-03-08 09:33:551459format.pretty::
1460The default pretty format for log/show/whatchanged command,
1461See linkgit:git-log[1], linkgit:git-show[1],
1462linkgit:git-whatchanged[1].
1463
Junio C Hamanoea6a7642009-03-11 23:56:191464format.thread::
Junio C Hamano1aa40d22010-01-21 17:46:431465The default threading style for 'git format-patch'. Can be
Junio C Hamanob141a922010-01-10 19:55:141466a boolean value, or `shallow` or `deep`. `shallow` threading
1467makes every mail a reply to the head of the series,
Junio C Hamanoea6a7642009-03-11 23:56:191468where the head is chosen from the cover letter, the
Junio C Hamanob76a6862012-05-02 22:02:461469`--in-reply-to`, and the first patch mail, in this order.
Junio C Hamanof4581102009-04-25 08:29:591470`deep` threading makes every mail a reply to the previous one.
Junio C Hamanoea6a7642009-03-11 23:56:191471A true boolean value is the same as `shallow`, and a false
1472value disables threading.
1473
Junio C Hamano322c6242015-03-23 21:32:461474format.signOff::
Junio C Hamano804a9742013-04-28 23:10:311475A boolean value which lets you enable the `-s/--signoff` option of
1476format-patch by default. *Note:* Adding the Signed-off-by: line to a
1477patch should be a conscious act and means that you certify you have
1478the rights to submit this work under the same open source license.
1479Please see the 'SubmittingPatches' document for further discussion.
Junio C Hamano5f9a6f02009-04-06 08:26:561480
Junio C Hamanoea3b7522013-04-18 19:37:531481format.coverLetter::
1482A boolean that controls whether to generate a cover-letter when
1483format-patch is invoked, but in addition can be set to "auto", to
1484generate a cover-letter only when there's more than one patch.
1485
Junio C Hamano289d7e82016-01-27 00:20:381486format.outputDirectory::
1487Set a custom directory to store the resulting files instead of the
1488current working directory.
1489
Junio C Hamanof2a3a752016-05-23 22:54:391490format.useAutoBase::
1491A boolean value which lets you enable the `--base=auto` option of
1492format-patch by default.
1493
Junio C Hamano209ebe82011-04-27 21:09:591494filter.<driver>.clean::
1495The command which is used to convert the content of a worktree
1496file to a blob upon checkin. See linkgit:gitattributes[5] for
1497details.
1498
1499filter.<driver>.smudge::
1500The command which is used to convert the content of a blob
1501object to a worktree file upon checkout. See
1502linkgit:gitattributes[5] for details.
1503
Junio C Hamanod7ed4042015-08-03 19:43:001504fsck.<msg-id>::
1505Allows overriding the message type (error, warn or ignore) of a
1506specific message ID such as `missingEmail`.
1507+
1508For convenience, fsck prefixes the error/warning with the message ID,
1509e.g. "missingEmail: invalid author/committer line - missing email" means
1510that setting `fsck.missingEmail = ignore` will hide that issue.
1511+
1512This feature is intended to support working with legacy repositories
1513which cannot be repaired without disruptive changes.
1514
1515fsck.skipList::
1516The path to a sorted list of object names (i.e. one SHA-1 per
1517line) that are known to be broken in a non-fatal way and should
1518be ignored. This feature is useful when an established project
1519should be accepted despite early commits containing errors that
1520can be safely ignored such as invalid committer email addresses.
1521Note: corrupt objects cannot be skipped with this setting.
1522
Junio C Hamano624dd4c2014-04-03 21:56:301523gc.aggressiveDepth::
1524The depth parameter used in the delta compression
1525algorithm used by 'git gc --aggressive'. This defaults
Junio C Hamano53800482016-09-21 23:26:431526to 50.
Junio C Hamano624dd4c2014-04-03 21:56:301527
Junio C Hamanof2ce2972007-05-20 19:12:091528gc.aggressiveWindow::
1529The window size parameter used in the delta compression
Junio C Hamano1aa40d22010-01-21 17:46:431530algorithm used by 'git gc --aggressive'. This defaults
Junio C Hamanob04bb3f2010-04-14 14:07:361531to 250.
Junio C Hamanof2ce2972007-05-20 19:12:091532
Junio C Hamano1b50ce92007-10-03 12:05:531533gc.auto::
1534When there are approximately more than this many loose
1535objects in the repository, `git gc --auto` will pack them.
1536Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:171537light-weight garbage collection from time to time. The
1538default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531539
Junio C Hamano322c6242015-03-23 21:32:461540gc.autoPackLimit::
Junio C Hamano1b50ce92007-10-03 12:05:531541When there are more than this many packs that are not
1542marked with `*.keep` file in the repository, `git gc
Junio C Hamanoe77b0152008-01-12 06:44:171543--auto` consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:371544default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531545
Junio C Hamano322c6242015-03-23 21:32:461546gc.autoDetach::
Junio C Hamanofb5ffde2014-11-04 22:38:561547Make `git gc --auto` return immediately and run in background
Junio C Hamano08ef8c22014-03-10 14:53:441548if the system supports it. Default is true.
1549
Junio C Hamanocbe0eb22017-02-27 23:37:491550gc.logExpiry::
1551If the file gc.log exists, then `git gc --auto` won't run
1552unless that file is more than 'gc.logExpiry' old. Default is
1553"1.day". See `gc.pruneExpire` for more ways to specify its
1554value.
1555
Junio C Hamano322c6242015-03-23 21:32:461556gc.packRefs::
Junio C Hamanob141a922010-01-10 19:55:141557Running `git pack-refs` in a repository renders it
1558unclonable by Git versions prior to 1.5.1.2 over dumb
1559transports such as HTTP. This variable determines whether
Junio C Hamanocdd1c332010-12-20 10:08:001560'git gc' runs `git pack-refs`. This can be set to `notbare`
Junio C Hamanob141a922010-01-10 19:55:141561to enable it within all non-bare repos or it can be set to a
1562boolean value. The default is `true`.
Junio C Hamano9d52e572007-02-13 23:48:201563
Junio C Hamano322c6242015-03-23 21:32:461564gc.pruneExpire::
Junio C Hamano1aa40d22010-01-21 17:46:431565When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
Junio C Hamanoa3148f52009-01-14 08:49:571566Override the grace period with this config variable. The value
Junio C Hamano9c512872015-08-12 21:59:251567"now" may be used to disable this grace period and always prune
1568unreachable objects immediately, or "never" may be used to
Junio C Hamano56ace3d2017-01-10 23:43:411569suppress pruning. This feature helps prevent corruption when
1570'git gc' runs concurrently with another process writing to the
1571repository; see the "NOTES" section of linkgit:git-gc[1].
Junio C Hamano09a926d2008-03-13 07:55:291572
Junio C Hamano9c512872015-08-12 21:59:251573gc.worktreePruneExpire::
1574When 'git gc' is run, it calls
1575'git worktree prune --expire 3.months.ago'.
1576This config variable can be used to set a different grace
1577period. The value "now" may be used to disable the grace
Junio C Hamano198b1f12016-05-17 22:27:241578period and prune `$GIT_DIR/worktrees` immediately, or "never"
Junio C Hamano9c512872015-08-12 21:59:251579may be used to suppress pruning.
Junio C Hamano4cc4a842015-05-11 22:41:021580
Junio C Hamano322c6242015-03-23 21:32:461581gc.reflogExpire::
1582gc.<pattern>.reflogExpire::
Junio C Hamano1aa40d22010-01-21 17:46:431583'git reflog expire' removes reflog entries older than
Junio C Hamano9c512872015-08-12 21:59:251584this time; defaults to 90 days. The value "now" expires all
1585entries immediately, and "never" suppresses expiration
1586altogether. With "<pattern>" (e.g.
Junio C Hamanocc7636a2010-05-21 14:57:531587"refs/stash") in the middle the setting applies only to
1588the refs that match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551589
Junio C Hamano322c6242015-03-23 21:32:461590gc.reflogExpireUnreachable::
Junio C Hamanoa1746be2015-08-26 23:07:071591gc.<pattern>.reflogExpireUnreachable::
Junio C Hamano1aa40d22010-01-21 17:46:431592'git reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:551593this time and are not reachable from the current tip;
Junio C Hamano9c512872015-08-12 21:59:251594defaults to 30 days. The value "now" expires all entries
1595immediately, and "never" suppresses expiration altogether.
1596With "<pattern>" (e.g. "refs/stash")
Junio C Hamanocc7636a2010-05-21 14:57:531597in the middle, the setting applies only to the refs that
1598match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551599
Junio C Hamano322c6242015-03-23 21:32:461600gc.rerereResolved::
Junio C Hamano74640642006-12-27 10:59:551601Records of conflicted merge you resolved earlier are
Junio C Hamano1aa40d22010-01-21 17:46:431602kept for this many days when 'git rerere gc' is run.
Junio C Hamanofb1fdf12017-08-27 06:14:591603You can also use more human-readable "1.month.ago", etc.
Junio C Hamano35738e82008-01-07 07:55:461604The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551605
Junio C Hamano322c6242015-03-23 21:32:461606gc.rerereUnresolved::
Junio C Hamano74640642006-12-27 10:59:551607Records of conflicted merge you have not resolved are
Junio C Hamano1aa40d22010-01-21 17:46:431608kept for this many days when 'git rerere gc' is run.
Junio C Hamanofb1fdf12017-08-27 06:14:591609You can also use more human-readable "1.month.ago", etc.
Junio C Hamano35738e82008-01-07 07:55:461610The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551611
Junio C Hamano322c6242015-03-23 21:32:461612gitcvs.commitMsgAnnotation::
Junio C Hamanoa3148f52009-01-14 08:49:571613Append this string to each commit message. Set to empty string
1614to disable this feature. Defaults to "via git-CVS emulator".
1615
Junio C Hamano07824ce2006-04-25 07:36:541616gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:271617Whether the CVS server interface is enabled for this repository.
Junio C Hamano35738e82008-01-07 07:55:461618See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541619
Junio C Hamano322c6242015-03-23 21:32:461620gitcvs.logFile::
Junio C Hamanoa6387422007-08-25 03:54:271621Path to a log file where the CVS server interface well... logs
Junio C Hamano35738e82008-01-07 07:55:461622various stuff. See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541623
Junio C Hamano17bd2272008-09-01 06:11:171624gitcvs.usecrlfattr::
Junio C Hamanobb88cf42010-06-21 15:23:551625If true, the server will look up the end-of-line conversion
Junio C Hamano92d80372016-07-13 22:00:051626attributes for files to determine the `-k` modes to use. If
Junio C Hamano076ffcc2013-02-06 05:13:211627the attributes force Git to treat a file as text,
Junio C Hamano92d80372016-07-13 22:00:051628the `-k` mode will be left blank so CVS clients will
Junio C Hamanobb88cf42010-06-21 15:23:551629treat it as text. If they suppress text conversion, the file
Junio C Hamanocb1c44f2008-08-06 06:19:331630will be set with '-kb' mode, which suppresses any newline munging
Junio C Hamanobb88cf42010-06-21 15:23:551631the client might otherwise do. If the attributes do not allow
Junio C Hamano042f2142016-06-27 18:05:051632the file type to be determined, then `gitcvs.allBinary` is
Junio C Hamanobb88cf42010-06-21 15:23:551633used. See linkgit:gitattributes[5].
Junio C Hamanodfccbb02008-05-26 01:16:141634
Junio C Hamano322c6242015-03-23 21:32:461635gitcvs.allBinary::
Junio C Hamano042f2142016-06-27 18:05:051636This is used if `gitcvs.usecrlfattr` does not resolve
Junio C Hamanodfccbb02008-05-26 01:16:141637the correct '-kb' mode to use. If true, all
1638unresolved files are sent to the client in
1639mode '-kb'. This causes the client to treat them
1640as binary files, which suppresses any newline munging it
1641otherwise might do. Alternatively, if it is set to "guess",
1642then the contents of the file are examined to decide if
Junio C Hamano042f2142016-06-27 18:05:051643it is binary, similar to `core.autocrlf`.
Junio C Hamanoa2ad99e2007-04-18 09:57:041644
Junio C Hamano322c6242015-03-23 21:32:461645gitcvs.dbName::
Junio C Hamanoa2ad99e2007-04-18 09:57:041646Database used by git-cvsserver to cache revision information
Junio C Hamano076ffcc2013-02-06 05:13:211647derived from the Git repository. The exact meaning depends on the
Junio C Hamanoa2ad99e2007-04-18 09:57:041648used database driver, for SQLite (which is the default driver) this
1649is a filename. Supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461650linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Junio C Hamanoa2ad99e2007-04-18 09:57:041651Default: '%Ggitcvs.%m.sqlite'
1652
Junio C Hamano322c6242015-03-23 21:32:461653gitcvs.dbDriver::
Junio C Hamanoa2ad99e2007-04-18 09:57:041654Used Perl DBI driver. You can specify any available driver
Junio C Hamano804a9742013-04-28 23:10:311655for this here, but it might not work. git-cvsserver is tested
Junio C Hamanoa2ad99e2007-04-18 09:57:041656with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1657reported *not* to work with 'DBD::mysql'. Experimental feature.
1658May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamano35738e82008-01-07 07:55:461659See linkgit:git-cvsserver[1].
Junio C Hamanod9e0e5d2007-04-14 16:22:041660
Junio C Hamano322c6242015-03-23 21:32:461661gitcvs.dbUser, gitcvs.dbPass::
Junio C Hamano042f2142016-06-27 18:05:051662Database user and password. Only useful if setting `gitcvs.dbDriver`,
Junio C Hamanoa2ad99e2007-04-18 09:57:041663since SQLite has no concept of database users and/or passwords.
Junio C Hamano322c6242015-03-23 21:32:461664'gitcvs.dbUser' supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461665linkgit:git-cvsserver[1] for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:041666
Junio C Hamanoa74efce2008-04-02 08:39:081667gitcvs.dbTableNamePrefix::
1668Database table name prefix. Prepended to the names of any
1669database tables used, allowing a single database to be used
1670for several repositories. Supports variable substitution (see
1671linkgit:git-cvsserver[1] for details). Any non-alphabetic
1672characters will be replaced with underscores.
1673
Junio C Hamano042f2142016-06-27 18:05:051674All gitcvs variables except for `gitcvs.usecrlfattr` and
1675`gitcvs.allBinary` can also be specified as
Junio C Hamanodfccbb02008-05-26 01:16:141676'gitcvs.<access_method>.<varname>' (where 'access_method'
Junio C Hamanoa6387422007-08-25 03:54:271677is one of "ext" and "pserver") to make them apply only for the given
1678access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:041679
Junio C Hamano11821ed2011-10-19 18:42:091680gitweb.category::
1681gitweb.description::
1682gitweb.owner::
1683gitweb.url::
1684See linkgit:gitweb[1] for description.
1685
1686gitweb.avatar::
1687gitweb.blame::
1688gitweb.grep::
1689gitweb.highlight::
1690gitweb.patches::
1691gitweb.pickaxe::
1692gitweb.remote_heads::
Junio C Hamano322c6242015-03-23 21:32:461693gitweb.showSizes::
Junio C Hamano11821ed2011-10-19 18:42:091694gitweb.snapshot::
1695See linkgit:gitweb.conf[5] for description.
1696
Junio C Hamanoa03ac862011-04-02 04:32:291697grep.lineNumber::
Junio C Hamano92d80372016-07-13 22:00:051698If set to true, enable `-n` option by default.
Junio C Hamanoa03ac862011-04-02 04:32:291699
Junio C Hamanoa00504d2012-08-27 21:11:231700grep.patternType::
1701Set the default matching behavior. Using a value of 'basic', 'extended',
Junio C Hamano92d80372016-07-13 22:00:051702'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1703`--fixed-strings`, or `--perl-regexp` option accordingly, while the
Junio C Hamanoa00504d2012-08-27 21:11:231704value 'default' will return to the default matching behavior.
1705
Junio C Hamanoa03ac862011-04-02 04:32:291706grep.extendedRegexp::
Junio C Hamano92d80372016-07-13 22:00:051707If set to true, enable `--extended-regexp` option by default. This
Junio C Hamano042f2142016-06-27 18:05:051708option is ignored when the `grep.patternType` option is set to a value
Junio C Hamanoa00504d2012-08-27 21:11:231709other than 'default'.
Junio C Hamanoa03ac862011-04-02 04:32:291710
Junio C Hamanoa7da1ba2016-01-13 00:19:451711grep.threads::
1712Number of grep worker threads to use.
1713See `grep.threads` in linkgit:git-grep[1] for more information.
1714
Junio C Hamano4e6ba272016-01-20 23:23:191715grep.fallbackToNoIndex::
1716If set to true, fall back to git grep --no-index if git grep
1717is executed outside of a git repository. Defaults to false.
1718
Junio C Hamano4fd24422012-01-06 21:52:431719gpg.program::
Junio C Hamano198b1f12016-05-17 22:27:241720Use this custom program instead of "`gpg`" found on `$PATH` when
Junio C Hamano4fd24422012-01-06 21:52:431721making or verifying a PGP signature. The program must support the
Junio C Hamanoe1aeb5e2014-06-06 19:16:291722same command-line interface as GPG, namely, to verify a detached
Junio C Hamano198b1f12016-05-17 22:27:241723signature, "`gpg --verify $file - <$signature`" is run, and the
Junio C Hamano4fd24422012-01-06 21:52:431724program is expected to signal a good signature by exiting with
Junio C Hamanofb5ffde2014-11-04 22:38:561725code 0, and to generate an ASCII-armored detached signature, the
Junio C Hamano198b1f12016-05-17 22:27:241726standard input of "`gpg -bsau $key`" is fed with the contents to be
Junio C Hamano4fd24422012-01-06 21:52:431727signed, and the program is expected to send the result to its
1728standard output.
1729
Junio C Hamano322c6242015-03-23 21:32:461730gui.commitMsgWidth::
Junio C Hamano6d76d612008-05-09 05:46:081731Defines how wide the commit message window is in the
1732linkgit:git-gui[1]. "75" is the default.
1733
Junio C Hamano322c6242015-03-23 21:32:461734gui.diffContext::
Junio C Hamano6d76d612008-05-09 05:46:081735Specifies how many context lines should be used in calls to diff
1736made by the linkgit:git-gui[1]. The default is "5".
1737
Junio C Hamano322c6242015-03-23 21:32:461738gui.displayUntracked::
Junio C Hamano198b1f12016-05-17 22:27:241739Determines if linkgit:git-gui[1] shows untracked files
Junio C Hamano796c55f2014-05-02 21:45:151740in the file list. The default is "true".
1741
Junio C Hamanod3452a02008-11-15 08:07:551742gui.encoding::
1743Specifies the default encoding to use for displaying of
1744file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1745It can be overridden by setting the 'encoding' attribute
1746for relevant files (see linkgit:gitattributes[5]).
1747If this option is not set, the tools default to the
1748locale encoding.
1749
Junio C Hamano322c6242015-03-23 21:32:461750gui.matchTrackingBranch::
Junio C Hamano6d76d612008-05-09 05:46:081751Determines if new branches created with linkgit:git-gui[1] should
1752default to tracking remote branches with matching names or
1753not. Default: "false".
1754
Junio C Hamano322c6242015-03-23 21:32:461755gui.newBranchTemplate::
Junio C Hamano6d76d612008-05-09 05:46:081756Is used as suggested name when creating new branches using the
1757linkgit:git-gui[1].
1758
Junio C Hamano322c6242015-03-23 21:32:461759gui.pruneDuringFetch::
Junio C Hamano97bcb482010-11-25 03:16:071760"true" if linkgit:git-gui[1] should prune remote-tracking branches when
Junio C Hamano6d76d612008-05-09 05:46:081761performing a fetch. The default value is "false".
1762
1763gui.trustmtime::
1764Determines if linkgit:git-gui[1] should trust the file modification
1765timestamp or not. By default the timestamps are not trusted.
1766
Junio C Hamano322c6242015-03-23 21:32:461767gui.spellingDictionary::
Junio C Hamano6d76d612008-05-09 05:46:081768Specifies the dictionary used for spell checking commit messages in
1769the linkgit:git-gui[1]. When set to "none" spell checking is turned
1770off.
1771
Junio C Hamano322c6242015-03-23 21:32:461772gui.fastCopyBlame::
Junio C Hamano1aa40d22010-01-21 17:46:431773If true, 'git gui blame' uses `-C` instead of `-C -C` for original
Junio C Hamanod3452a02008-11-15 08:07:551774location detection. It makes blame significantly faster on huge
1775repositories at the expense of less thorough copy detection.
1776
Junio C Hamano322c6242015-03-23 21:32:461777gui.copyBlameThreshold::
Junio C Hamano610d1762008-11-28 06:27:131778Specifies the threshold to use in 'git gui blame' original location
Junio C Hamanod3452a02008-11-15 08:07:551779detection, measured in alphanumeric characters. See the
1780linkgit:git-blame[1] manual for more information on copy detection.
1781
1782gui.blamehistoryctx::
1783Specifies the radius of history context in days to show in
1784linkgit:gitk[1] for the selected commit, when the `Show History
1785Context` menu item is invoked from 'git gui blame'. If this
1786variable is set to zero, the whole history is shown.
1787
Junio C Hamano92d312a2008-12-15 07:22:201788guitool.<name>.cmd::
1789Specifies the shell command line to execute when the corresponding item
1790of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1791mandatory for every tool. The command is executed from the root of
1792the working directory, and in the environment it receives the name of
Junio C Hamano042f2142016-06-27 18:05:051793the tool as `GIT_GUITOOL`, the name of the currently selected file as
Junio C Hamano92d312a2008-12-15 07:22:201794'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1795the head is detached, 'CUR_BRANCH' is empty).
1796
Junio C Hamano322c6242015-03-23 21:32:461797guitool.<name>.needsFile::
Junio C Hamano92d312a2008-12-15 07:22:201798Run the tool only if a diff is selected in the GUI. It guarantees
1799that 'FILENAME' is not empty.
1800
Junio C Hamano322c6242015-03-23 21:32:461801guitool.<name>.noConsole::
Junio C Hamano92d312a2008-12-15 07:22:201802Run the command silently, without creating a window to display its
1803output.
1804
Junio C Hamano322c6242015-03-23 21:32:461805guitool.<name>.noRescan::
Junio C Hamano92d312a2008-12-15 07:22:201806Don't rescan the working directory for changes after the tool
1807finishes execution.
1808
1809guitool.<name>.confirm::
1810Show a confirmation dialog before actually running the tool.
1811
Junio C Hamano322c6242015-03-23 21:32:461812guitool.<name>.argPrompt::
Junio C Hamano92d312a2008-12-15 07:22:201813Request a string argument from the user, and pass it to the tool
Junio C Hamano042f2142016-06-27 18:05:051814through the `ARGS` environment variable. Since requesting an
Junio C Hamano92d312a2008-12-15 07:22:201815argument implies confirmation, the 'confirm' option has no effect
1816if this is enabled. If the option is set to 'true', 'yes', or '1',
1817the dialog uses a built-in generic prompt; otherwise the exact
1818value of the variable is used.
1819
Junio C Hamano322c6242015-03-23 21:32:461820guitool.<name>.revPrompt::
Junio C Hamano92d312a2008-12-15 07:22:201821Request a single valid revision from the user, and set the
Junio C Hamano042f2142016-06-27 18:05:051822`REVISION` environment variable. In other aspects this option
Junio C Hamano322c6242015-03-23 21:32:461823is similar to 'argPrompt', and can be used together with it.
Junio C Hamano92d312a2008-12-15 07:22:201824
Junio C Hamano322c6242015-03-23 21:32:461825guitool.<name>.revUnmerged::
1826Show only unmerged branches in the 'revPrompt' subdialog.
Junio C Hamano92d312a2008-12-15 07:22:201827This is useful for tools similar to merge or rebase, but not
1828for things like checkout or reset.
1829
1830guitool.<name>.title::
1831Specifies the title to use for the prompt dialog. The default
1832is the tool name.
1833
1834guitool.<name>.prompt::
1835Specifies the general prompt string to display at the top of
Junio C Hamano322c6242015-03-23 21:32:461836the dialog, before subsections for 'argPrompt' and 'revPrompt'.
Junio C Hamano92d312a2008-12-15 07:22:201837The default value includes the actual command.
1838
Junio C Hamano4e272312008-01-08 09:13:211839help.browser::
1840Specify the browser that will be used to display help in the
1841'web' format. See linkgit:git-help[1].
1842
1843help.format::
1844Override the default help format used by linkgit:git-help[1].
1845Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1846the default. 'web' and 'html' are the same.
1847
Junio C Hamano322c6242015-03-23 21:32:461848help.autoCorrect::
Junio C Hamanof24b8062008-09-09 01:34:391849Automatically correct and execute mistyped commands after
1850waiting for the given number of deciseconds (0.1 sec). If more
1851than one command can be deduced from the entered text, nothing
1852will be executed. If the value of this option is negative,
1853the corrected command will be executed immediately. If the
1854value is 0 - the command will be just shown but not executed.
1855This is the default.
1856
Junio C Hamano322c6242015-03-23 21:32:461857help.htmlPath::
Junio C Hamano5dd5fae2013-01-18 21:06:491858Specify the path where the HTML documentation resides. File system paths
1859and URLs are supported. HTML pages will be prefixed with this path when
1860help is displayed in the 'web' format. This defaults to the documentation
1861path of your Git installation.
1862
Junio C Hamano58256872007-12-04 08:31:131863http.proxy::
Junio C Hamano3dd93922012-03-05 07:49:111864Override the HTTP proxy, normally configured using the 'http_proxy',
Junio C Hamanoffe10ca2016-02-04 00:44:231865'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1866addition to the syntax understood by curl, it is possible to specify a
1867proxy string with a user name but no password, in which case git will
1868attempt to acquire one in the same way it does for other credentials. See
1869linkgit:gitcredentials[7] for more information. The syntax thus is
1870'[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1871on a per-remote basis; see remote.<name>.proxy
1872
1873http.proxyAuthMethod::
1874Set the method with which to authenticate against the HTTP proxy. This
1875only takes effect if the configured proxy string contains a user name part
1876(i.e. is of the form 'user@host' or 'user@host:port'). This can be
1877overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
Junio C Hamano042f2142016-06-27 18:05:051878Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
Junio C Hamanoffe10ca2016-02-04 00:44:231879variable. Possible values are:
1880+
1881--
1882* `anyauth` - Automatically pick a suitable authentication method. It is
1883 assumed that the proxy answers an unauthenticated request with a 407
1884 status code and one or more Proxy-authenticate headers with supported
1885 authentication methods. This is the default.
1886* `basic` - HTTP Basic authentication
1887* `digest` - HTTP Digest authentication; this prevents the password from being
1888 transmitted to the proxy in clear text
1889* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1890 of `curl(1)`)
1891* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1892--
Junio C Hamano58256872007-12-04 08:31:131893
Junio C Hamano3fcdd072016-02-24 23:41:081894http.emptyAuth::
1895Attempt authentication without seeking a username or password. This
1896can be used to attempt GSS-Negotiate authentication without specifying
1897a username in the URL, as libcurl normally requires a username for
1898authentication.
1899
Junio C Hamano34afdb22016-10-06 22:16:391900http.delegation::
1901Control GSSAPI credential delegation. The delegation is disabled
1902by default in libcurl since version 7.21.7. Set parameter to tell
1903the server what it is allowed to delegate when it comes to user
1904credentials. Used with GSS/kerberos. Possible values are:
1905+
1906--
1907* `none` - Don't allow any delegation.
1908* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
1909 Kerberos service ticket, which is a matter of realm policy.
1910* `always` - Unconditionally allow the server to delegate.
1911--
1912
1913
Junio C Hamanoccdabca2016-05-06 22:27:091914http.extraHeader::
1915Pass an additional HTTP header when communicating with a server. If
1916more than one such entry exists, all of them are added as extra
1917headers. To allow overriding the settings inherited from the system
1918config, an empty value will reset the extra headers to the empty list.
1919
Junio C Hamano322c6242015-03-23 21:32:461920http.cookieFile::
Junio C Hamano198b1f12016-05-17 22:27:241921The pathname of a file containing previously stored cookie lines,
1922which should be used
Junio C Hamano076ffcc2013-02-06 05:13:211923in the Git http session, if they match the server. The file format
Junio C Hamano4c4b0122011-06-30 01:19:321924of the file to read cookies from should be plain HTTP headers or
Junio C Hamano198b1f12016-05-17 22:27:241925the Netscape/Mozilla cookie file format (see `curl(1)`).
1926NOTE that the file specified with http.cookieFile is used only as
Junio C Hamano8eac2682013-09-09 22:35:201927input unless http.saveCookies is set.
1928
Junio C Hamano322c6242015-03-23 21:32:461929http.saveCookies::
Junio C Hamano8eac2682013-09-09 22:35:201930If set, store cookies received during requests to the file specified by
Junio C Hamano322c6242015-03-23 21:32:461931http.cookieFile. Has no effect if http.cookieFile is unset.
Junio C Hamano4c4b0122011-06-30 01:19:321932
Junio C Hamanoa1746be2015-08-26 23:07:071933http.sslVersion::
1934The SSL version to use when negotiating an SSL connection, if you
1935want to force the default. The available and default version
1936depend on whether libcurl was built against NSS or OpenSSL and the
1937particular configuration of the crypto library in use. Internally
1938this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1939documentation for more details on the format of this option and
1940for the ssl version supported. Actually the possible values of
1941this option are:
1942
1943- sslv2
1944- sslv3
1945- tlsv1
1946- tlsv1.0
1947- tlsv1.1
1948- tlsv1.2
1949
1950+
Junio C Hamano042f2142016-06-27 18:05:051951Can be overridden by the `GIT_SSL_VERSION` environment variable.
Junio C Hamanoa1746be2015-08-26 23:07:071952To force git to use libcurl's default ssl version and ignore any
Junio C Hamano042f2142016-06-27 18:05:051953explicit http.sslversion option, set `GIT_SSL_VERSION` to the
Junio C Hamanoa1746be2015-08-26 23:07:071954empty string.
1955
Junio C Hamano1dbca522015-05-22 20:48:551956http.sslCipherList::
1957 A list of SSL ciphers to use when negotiating an SSL connection.
1958 The available ciphers depend on whether libcurl was built against
1959 NSS or OpenSSL and the particular configuration of the crypto
1960 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1961 option; see the libcurl documentation for more details on the format
1962 of this list.
1963+
Junio C Hamano042f2142016-06-27 18:05:051964Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
Junio C Hamano1dbca522015-05-22 20:48:551965To force git to use libcurl's default cipher list and ignore any
Junio C Hamano042f2142016-06-27 18:05:051966explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
Junio C Hamano1dbca522015-05-22 20:48:551967empty string.
1968
Junio C Hamano07824ce2006-04-25 07:36:541969http.sslVerify::
1970Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano042f2142016-06-27 18:05:051971over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment
Junio C Hamano07824ce2006-04-25 07:36:541972variable.
1973
1974http.sslCert::
1975File containing the SSL certificate when fetching or pushing
Junio C Hamano042f2142016-06-27 18:05:051976over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
Junio C Hamano07824ce2006-04-25 07:36:541977variable.
1978
1979http.sslKey::
1980File containing the SSL private key when fetching or pushing
Junio C Hamano042f2142016-06-27 18:05:051981over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
Junio C Hamano07824ce2006-04-25 07:36:541982variable.
1983
Junio C Hamano48bc1ce2009-07-09 16:49:191984http.sslCertPasswordProtected::
Junio C Hamano076ffcc2013-02-06 05:13:211985Enable Git's password prompt for the SSL certificate. Otherwise
Junio C Hamano48bc1ce2009-07-09 16:49:191986OpenSSL will prompt the user, possibly many times, if the
1987certificate or private key is encrypted. Can be overridden by the
Junio C Hamano042f2142016-06-27 18:05:051988`GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
Junio C Hamano48bc1ce2009-07-09 16:49:191989
Junio C Hamano07824ce2006-04-25 07:36:541990http.sslCAInfo::
1991File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:481992fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano042f2142016-06-27 18:05:051993`GIT_SSL_CAINFO` environment variable.
Junio C Hamano07824ce2006-04-25 07:36:541994
1995http.sslCAPath::
1996Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:451997with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano042f2142016-06-27 18:05:051998by the `GIT_SSL_CAPATH` environment variable.
Junio C Hamano07824ce2006-04-25 07:36:541999
Junio C Hamano3fcdd072016-02-24 23:41:082000http.pinnedpubkey::
2001Public key of the https service. It may either be the filename of
2002a PEM or DER encoded public key file or a string starting with
2003'sha256//' followed by the base64 encoded sha256 hash of the
2004public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
2005exit with an error if this option is set but not supported by
2006cURL.
2007
Junio C Hamano76927822013-04-19 21:26:572008http.sslTry::
2009Attempt to use AUTH SSL/TLS and encrypted data transfers
2010when connecting via regular FTP protocol. This might be needed
2011if the FTP server requires it for security reasons or you wish
2012to connect securely whenever remote FTP server supports it.
2013Default is false since it might trigger certificate verification
2014errors on misconfigured servers.
2015
Junio C Hamano07824ce2006-04-25 07:36:542016http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:482017How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano042f2142016-06-27 18:05:052018by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
Junio C Hamano07824ce2006-04-25 07:36:542019
Junio C Hamanob141a922010-01-10 19:55:142020http.minSessions::
2021The number of curl sessions (counted across slots) to be kept across
2022requests. They will not be ended with curl_easy_cleanup() until
2023http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2024value will be capped at 1. Defaults to 1.
2025
Junio C Hamano3b70d3c2009-11-21 17:37:372026http.postBuffer::
2027Maximum size in bytes of the buffer used by smart HTTP
2028transports when POSTing data to the remote system.
2029For requests larger than this buffer size, HTTP/1.1 and
2030Transfer-Encoding: chunked is used to avoid creating a
2031massive pack file locally. Default is 1 MiB, which is
2032sufficient for most requests.
2033
Junio C Hamano07824ce2006-04-25 07:36:542034http.lowSpeedLimit, http.lowSpeedTime::
2035If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2036for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano042f2142016-06-27 18:05:052037Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2038`GIT_HTTP_LOW_SPEED_TIME` environment variables.
Junio C Hamano07824ce2006-04-25 07:36:542039
Junio C Hamanof1dcdfe2006-09-29 08:10:512040http.noEPSV::
2041A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:042042This can helpful with some "poor" ftp servers which don't
Junio C Hamano042f2142016-06-27 18:05:052043support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
Junio C Hamanof1dcdfe2006-09-29 08:10:512044environment variable. Default is false (curl will use EPSV).
2045
Junio C Hamano322c6242015-03-23 21:32:462046http.userAgent::
Junio C Hamano53ba6d02010-08-22 07:25:122047The HTTP USER_AGENT string presented to an HTTP server. The default
Junio C Hamano076ffcc2013-02-06 05:13:212048value represents the version of the client Git such as git/1.7.1.
Junio C Hamano53ba6d02010-08-22 07:25:122049This option allows you to override this value to a more common value
2050such as Mozilla/4.0. This may be necessary, for instance, if
2051connecting through a firewall that restricts HTTP connections to a set
2052of common USER_AGENT strings (but not including those like git/1.7.1).
Junio C Hamano042f2142016-06-27 18:05:052053Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
Junio C Hamano53ba6d02010-08-22 07:25:122054
Junio C Hamano52b1cfb2016-12-20 00:18:362055http.followRedirects::
2056Whether git should follow HTTP redirects. If set to `true`, git
2057will transparently follow any redirect issued by a server it
2058encounters. If set to `false`, git will treat all redirects as
2059errors. If set to `initial`, git will follow redirects only for
2060the initial request to a remote, but not for subsequent
2061follow-up HTTP requests. Since git uses the redirected URL as
2062the base for the follow-up requests, this is generally
2063sufficient. The default is `initial`.
2064
Junio C Hamano8eac2682013-09-09 22:35:202065http.<url>.*::
Junio C Hamanofb5ffde2014-11-04 22:38:562066Any of the http.* options above can be applied selectively to some URLs.
Junio C Hamano8eac2682013-09-09 22:35:202067For a config key to match a URL, each element of the config key is
2068compared to that of the URL, in the following order:
2069+
2070--
2071. Scheme (e.g., `https` in `https://example.com/`). This field
2072 must match exactly between the config key and the URL.
2073
2074. Host/domain name (e.g., `example.com` in `https://example.com/`).
Junio C Hamanocbe0eb22017-02-27 23:37:492075 This field must match between the config key and the URL. It is
2076 possible to specify a `*` as part of the host name to match all subdomains
2077 at this level. `https://*.example.com/` for example would match
2078 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
Junio C Hamano8eac2682013-09-09 22:35:202079
2080. Port number (e.g., `8080` in `http://example.com:8080/`).
2081 This field must match exactly between the config key and the URL.
2082 Omitted port numbers are automatically converted to the correct
2083 default for the scheme before matching.
2084
2085. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2086 path field of the config key must match the path field of the URL
2087 either exactly or as a prefix of slash-delimited path elements. This means
2088 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2089 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2090 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2091 key with just path `foo/`).
2092
2093. User name (e.g., `user` in `https://user@example.com/repo.git`). If
2094 the config key has a user name it must match the user name in the
2095 URL exactly. If the config key does not have a user name, that
2096 config key will match a URL with any user name (including none),
2097 but at a lower precedence than a config key with a user name.
2098--
2099+
2100The list above is ordered by decreasing precedence; a URL that matches
2101a config key's path is preferred to one that matches its user name. For example,
2102if the URL is `https://user@example.com/foo/bar` a config key match of
2103`https://example.com/foo` will be preferred over a config key match of
2104`https://user@example.com`.
2105+
2106All URLs are normalized before attempting any matching (the password part,
2107if embedded in the URL, is always ignored for matching purposes) so that
Junio C Hamanofb5ffde2014-11-04 22:38:562108equivalent URLs that are simply spelled differently will match properly.
2109Environment variable settings always override any matches. The URLs that are
Junio C Hamano8eac2682013-09-09 22:35:202110matched against are those given directly to Git commands. This means any URLs
2111visited as a result of a redirection do not participate in matching.
2112
Junio C Hamanocbe0eb22017-02-27 23:37:492113ssh.variant::
Junio C Hamano912712b2017-12-06 18:04:012114By default, Git determines the command line arguments to use
2115based on the basename of the configured SSH command (configured
2116using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2117the config setting `core.sshCommand`). If the basename is
2118unrecognized, Git will attempt to detect support of OpenSSH
2119options by first invoking the configured SSH command with the
2120`-G` (print configuration) option and will subsequently use
2121OpenSSH options (if that is successful) or no options besides
2122the host and remote command (if it fails).
Junio C Hamanocbe0eb22017-02-27 23:37:492123+
Junio C Hamano912712b2017-12-06 18:04:012124The config variable `ssh.variant` can be set to override this detection.
2125Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2126`tortoiseplink`, `simple` (no options except the host and remote command).
2127The default auto-detection can be explicitly requested using the value
2128`auto`. Any other value is treated as `ssh`. This setting can also be
2129overridden via the environment variable `GIT_SSH_VARIANT`.
2130+
2131The current command-line parameters used for each variant are as
2132follows:
2133+
2134--
2135
2136* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2137
2138* `simple` - [username@]host command
2139
2140* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2141
2142* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2143
2144--
2145+
2146Except for the `simple` variant, command-line parameters are likely to
2147change as git gains new features.
Junio C Hamanocbe0eb22017-02-27 23:37:492148
Junio C Hamano07824ce2006-04-25 07:36:542149i18n.commitEncoding::
Junio C Hamano076ffcc2013-02-06 05:13:212150Character encoding the commit messages are stored in; Git itself
Junio C Hamano07824ce2006-04-25 07:36:542151does not care per se, but this information is necessary e.g. when
2152importing commits from emails or in the gitk graphical history
2153browser (and possibly at other places in the future or in other
Junio C Hamano35738e82008-01-07 07:55:462154porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Junio C Hamano07824ce2006-04-25 07:36:542155
Junio C Hamano51f92e22006-12-29 05:18:282156i18n.logOutputEncoding::
2157Character encoding the commit messages are converted to when
Junio C Hamano1aa40d22010-01-21 17:46:432158running 'git log' and friends.
Junio C Hamano51f92e22006-12-29 05:18:282159
Junio C Hamano4653c6f2008-11-26 22:50:202160imap::
2161The configuration variables in the 'imap' section are described
2162in linkgit:git-imap-send[1].
2163
Junio C Hamano81703b22014-03-14 22:00:272164index.version::
2165Specify the version with which new index files should be
2166initialized. This does not affect existing repositories.
2167
Junio C Hamano322c6242015-03-23 21:32:462168init.templateDir::
Junio C Hamanocaa712a2010-03-11 01:17:352169Specify the directory from which templates will be copied.
2170(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2171
Junio C Hamano4e272312008-01-08 09:13:212172instaweb.browser::
2173Specify the program that will be used to browse your working
2174repository in gitweb. See linkgit:git-instaweb[1].
2175
2176instaweb.httpd::
2177The HTTP daemon command-line to start gitweb on your working
2178repository. See linkgit:git-instaweb[1].
2179
2180instaweb.local::
2181If true the web server started by linkgit:git-instaweb[1] will
2182be bound to the local IP (127.0.0.1).
2183
Junio C Hamano322c6242015-03-23 21:32:462184instaweb.modulePath::
Junio C Hamano619596a2010-08-18 22:15:352185The default module path for linkgit:git-instaweb[1] to use
2186instead of /usr/lib/apache2/modules. Only used if httpd
2187is Apache.
Junio C Hamano4e272312008-01-08 09:13:212188
2189instaweb.port::
2190The port number to bind the gitweb httpd to. See
2191linkgit:git-instaweb[1].
2192
Junio C Hamano322c6242015-03-23 21:32:462193interactive.singleKey::
Junio C Hamano27a128b2009-08-13 01:23:002194In interactive commands, allow the user to provide one-letter
Junio C Hamanoe5bf6c12009-02-07 21:43:102195input with a single key (i.e., without hitting enter).
Junio C Hamanob76a6862012-05-02 22:02:462196Currently this is used by the `--patch` mode of
Junio C Hamano3d050d62011-05-17 06:43:342197linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2198linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2199setting is silently ignored if portable keystroke input
Junio C Hamano81703b22014-03-14 22:00:272200is not available; requires the Perl module Term::ReadKey.
Junio C Hamanoe5bf6c12009-02-07 21:43:102201
Junio C Hamano4ba4a782016-04-03 19:11:322202interactive.diffFilter::
2203When an interactive command (such as `git add --patch`) shows
2204a colorized diff, git will pipe the diff through the shell
2205command defined by this configuration variable. The command may
2206mark up the diff further for human consumption, provided that it
2207retains a one-to-one correspondence with the lines in the
2208original diff. Defaults to disabled (no filtering).
2209
Junio C Hamanof93530e2011-05-25 23:59:592210log.abbrevCommit::
2211If true, makes linkgit:git-log[1], linkgit:git-show[1], and
Junio C Hamanob76a6862012-05-02 22:02:462212linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2213override this option with `--no-abbrev-commit`.
Junio C Hamanof93530e2011-05-25 23:59:592214
Junio C Hamanob713ff12008-05-24 01:12:302215log.date::
Junio C Hamano2db3e752010-09-03 21:33:062216Set the default date-time mode for the 'log' command.
2217Setting a value for log.date is similar to using 'git log''s
Junio C Hamano1eb56092015-10-05 20:39:532218`--date` option. See linkgit:git-log[1] for details.
Junio C Hamanob713ff12008-05-24 01:12:302219
Junio C Hamanocb39aea2010-05-09 07:24:482220log.decorate::
2221Print out the ref names of any commits that are shown by the log
2222command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2223'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2224specified, the full ref name (including prefix) will be printed.
Junio C Hamano37cf4082016-05-30 01:22:142225If 'auto' is specified, then if the output is going to a terminal,
2226the ref names are shown as if 'short' were given, otherwise no ref
Junio C Hamano92d80372016-07-13 22:00:052227names are shown. This is the same as the `--decorate` option
Junio C Hamano37cf4082016-05-30 01:22:142228of the `git log`.
Junio C Hamanocb39aea2010-05-09 07:24:482229
Junio C Hamanob0a1e832015-10-15 23:08:312230log.follow::
2231If `true`, `git log` will act as if the `--follow` option was used when
2232a single <path> is given. This has the same limitations as `--follow`,
2233i.e. it cannot be used to follow multiple files and does not work well
2234on non-linear history.
2235
Junio C Hamanob86c8032017-02-02 21:50:192236log.graphColors::
2237A list of colors, separated by commas, that can be used to draw
2238history lines in `git log --graph`.
2239
Junio C Hamano322c6242015-03-23 21:32:462240log.showRoot::
Junio C Hamanofe9acab2006-11-24 12:10:552241If true, the initial commit will be shown as a big creation event.
2242This is equivalent to a diff against an empty tree.
Junio C Hamano35738e82008-01-07 07:55:462243Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Junio C Hamanofe9acab2006-11-24 12:10:552244normally hide the root commit will now show it. True by default.
2245
Junio C Hamano6b6144f2017-05-29 06:20:152246log.showSignature::
2247If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2248linkgit:git-whatchanged[1] assume `--show-signature`.
2249
Junio C Hamanoce836cc2013-01-21 02:01:532250log.mailmap::
2251If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2252linkgit:git-whatchanged[1] assume `--use-mailmap`.
2253
Junio C Hamano7f1bc9d2015-03-05 22:38:262254mailinfo.scissors::
2255If true, makes linkgit:git-mailinfo[1] (and therefore
2256linkgit:git-am[1]) act by default as if the --scissors option
2257was provided on the command-line. When active, this features
2258removes everything from the message body before a scissors
2259line (i.e. consisting mainly of ">8", "8<" and "-").
2260
Junio C Hamano8bc410e2009-02-15 10:38:192261mailmap.file::
2262The location of an augmenting mailmap file. The default
2263mailmap, located in the root of the repository, is loaded
2264first, then the mailmap file pointed to by this variable.
2265The location of the mailmap file may be in a repository
2266subdirectory, or somewhere outside of the repository itself.
2267See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2268
Junio C Hamanoabad6da2013-01-06 09:06:322269mailmap.blob::
2270Like `mailmap.file`, but consider the value as a reference to a
2271blob in the repository. If both `mailmap.file` and
2272`mailmap.blob` are given, both are parsed, with entries from
2273`mailmap.file` taking precedence. In a bare repository, this
2274defaults to `HEAD:.mailmap`. In a non-bare repository, it
2275defaults to empty.
2276
Junio C Hamano8b588d52008-03-15 09:48:372277man.viewer::
2278Specify the programs that may be used to display help in the
2279'man' format. See linkgit:git-help[1].
2280
Junio C Hamano6d76d612008-05-09 05:46:082281man.<tool>.cmd::
2282Specify the command to invoke the specified man viewer. The
2283specified command is evaluated in shell with the man page
2284passed as argument. (See linkgit:git-help[1].)
Junio C Hamano103ad7f2007-03-14 11:19:262285
Junio C Hamano6d76d612008-05-09 05:46:082286man.<tool>.path::
2287Override the path for the given tool that may be used to
2288display help in the 'man' format. See linkgit:git-help[1].
Junio C Hamanoe90436a2007-04-22 07:22:132289
Junio C Hamano4653c6f2008-11-26 22:50:202290include::merge-config.txt[]
Junio C Hamanoa476efa2008-10-10 15:31:422291
Junio C Hamano1fbbbc12007-12-18 07:01:272292mergetool.<tool>.path::
2293Override the path for the given tool. This is useful in case
2294your tool is not in the PATH.
2295
Junio C Hamano86bcccc2008-03-08 09:33:552296mergetool.<tool>.cmd::
2297Specify the command to invoke the specified merge tool. The
2298specified command is evaluated in shell with the following
2299variables available: 'BASE' is the name of a temporary file
2300containing the common base of the files to be merged, if available;
2301'LOCAL' is the name of a temporary file containing the contents of
2302the file on the current branch; 'REMOTE' is the name of a temporary
2303file containing the contents of the file from the branch being
2304merged; 'MERGED' contains the name of the file to which the merge
2305tool should write the results of a successful merge.
2306
2307mergetool.<tool>.trustExitCode::
2308For a custom merge command, specify whether the exit code of
2309the merge command can be used to determine whether the merge was
2310successful. If this is not set to true then the merge target file
2311timestamp is checked and the merge assumed to have been successful
2312if the file has been updated, otherwise the user is prompted to
2313indicate the success of the merge.
2314
Junio C Hamanoe478e402014-10-21 22:14:452315mergetool.meld.hasOutput::
2316Older versions of `meld` do not support the `--output` option.
2317Git will attempt to detect whether `meld` supports `--output`
2318by inspecting the output of `meld --help`. Configuring
2319`mergetool.meld.hasOutput` will make Git skip these checks and
2320use the configured value instead. Setting `mergetool.meld.hasOutput`
2321to `true` tells Git to unconditionally use the `--output` option,
2322and `false` avoids using `--output`.
2323
Junio C Hamano86bcccc2008-03-08 09:33:552324mergetool.keepBackup::
2325After performing a merge, the original file with conflict markers
2326can be saved as a file with a `.orig` extension. If this variable
2327is set to `false` then this file is not preserved. Defaults to
2328`true` (i.e. keep the backup files).
2329
Junio C Hamano10b7a342009-01-01 22:05:172330mergetool.keepTemporaries::
Junio C Hamano076ffcc2013-02-06 05:13:212331When invoking a custom merge tool, Git uses a set of temporary
Junio C Hamano10b7a342009-01-01 22:05:172332files to pass to the tool. If the tool returns an error and this
2333variable is set to `true`, then these temporary files will be
2334preserved, otherwise they will be removed after the tool has
2335exited. Defaults to `false`.
2336
Junio C Hamanoe478e402014-10-21 22:14:452337mergetool.writeToTemp::
2338Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2339conflicting files in the worktree by default. Git will attempt
2340to use a temporary directory for these files when set `true`.
2341Defaults to `false`.
2342
Junio C Hamano10b7a342009-01-01 22:05:172343mergetool.prompt::
2344Prompt before each invocation of the merge resolution program.
2345
Junio C Hamano3891e252015-08-31 23:06:132346notes.mergeStrategy::
2347Which merge strategy to choose by default when resolving notes
2348conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2349`cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2350section of linkgit:git-notes[1] for more information on each strategy.
2351
2352notes.<name>.mergeStrategy::
2353Which merge strategy to choose when doing a notes merge into
2354refs/notes/<name>. This overrides the more general
2355"notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2356linkgit:git-notes[1] for more information on the available strategies.
2357
Junio C Hamano31667362010-03-25 00:38:532358notes.displayRef::
2359The (fully qualified) refname from which to show notes when
2360showing commit messages. The value of this variable can be set
2361to a glob, in which case notes from all matching refs will be
2362shown. You may also specify this configuration variable
2363several times. A warning will be issued for refs that do not
2364exist, but a glob that does not match any refs is silently
2365ignored.
2366+
2367This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2368environment variable, which must be a colon separated list of refs or
2369globs.
2370+
2371The effective value of "core.notesRef" (possibly overridden by
2372GIT_NOTES_REF) is also implicitly added to the list of refs to be
2373displayed.
2374
2375notes.rewrite.<command>::
2376When rewriting commits with <command> (currently `amend` or
Junio C Hamano076ffcc2013-02-06 05:13:212377`rebase`) and this variable is set to `true`, Git
Junio C Hamano31667362010-03-25 00:38:532378automatically copies your notes from the original to the
2379rewritten commit. Defaults to `true`, but see
2380"notes.rewriteRef" below.
Junio C Hamano31667362010-03-25 00:38:532381
2382notes.rewriteMode::
2383When copying notes during a rewrite (see the
2384"notes.rewrite.<command>" option), determines what to do if
2385the target commit already has a note. Must be one of
Junio C Hamano3891e252015-08-31 23:06:132386`overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2387Defaults to `concatenate`.
Junio C Hamano31667362010-03-25 00:38:532388+
2389This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2390environment variable.
2391
2392notes.rewriteRef::
2393When copying notes during a rewrite, specifies the (fully
2394qualified) ref whose notes should be copied. The ref may be a
2395glob, in which case notes in all matching refs will be copied.
2396You may also specify this configuration several times.
2397+
2398Does not have a default value; you must configure this variable to
Junio C Hamano8fb66e52011-10-05 20:59:512399enable note rewriting. Set it to `refs/notes/commits` to enable
2400rewriting for the default commit notes.
Junio C Hamano2b3ee5d2010-05-08 05:41:182401+
2402This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2403environment variable, which must be a colon separated list of refs or
2404globs.
Junio C Hamano31667362010-03-25 00:38:532405
Junio C Hamano75cc4c92006-07-24 08:25:032406pack.window::
Junio C Hamano35738e82008-01-07 07:55:462407The size of the window used by linkgit:git-pack-objects[1] when no
Junio C Hamano75cc4c92006-07-24 08:25:032408window size is given on the command line. Defaults to 10.
2409
Junio C Hamano91d44c52007-05-09 07:16:072410pack.depth::
Junio C Hamano35738e82008-01-07 07:55:462411The maximum delta depth used by linkgit:git-pack-objects[1] when no
Junio C Hamano91d44c52007-05-09 07:16:072412maximum depth is given on the command line. Defaults to 50.
2413
Junio C Hamano235d53f2007-07-13 00:25:152414pack.windowMemory::
Junio C Hamano2a4bcbc2014-10-29 20:07:392415The maximum size of memory that is consumed by each thread
2416in linkgit:git-pack-objects[1] for pack window memory when
2417no limit is given on the command line. The value can be
2418suffixed with "k", "m", or "g". When left unconfigured (or
2419set explicitly to 0), there will be no limit.
Junio C Hamano235d53f2007-07-13 00:25:152420
Junio C Hamanof2ce2972007-05-20 19:12:092421pack.compression::
2422An integer -1..9, indicating the compression level for objects
2423in a pack file. -1 is the zlib default. 0 means no
2424compression, and 1..9 are various speed/size tradeoffs, 9 being
2425slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:422426not set, defaults to -1, the zlib default, which is "a default
2427compromise between speed and compression (currently equivalent
2428to level 6)."
Junio C Hamano657fd8a2010-10-07 00:01:242429+
2430Note that changing the compression level will not automatically recompress
2431all existing objects. You can force recompression by passing the -F option
2432to linkgit:git-repack[1].
Junio C Hamanof2ce2972007-05-20 19:12:092433
Junio C Hamano679d22d2007-06-02 21:13:442434pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:272435The maximum memory in bytes used for caching deltas in
Junio C Hamano9f883862009-08-11 06:23:522436linkgit:git-pack-objects[1] before writing them out to a pack.
2437This cache is used to speed up the writing object phase by not
2438having to recompute the final delta result once the best match
2439for all objects is found. Repacking large repositories on machines
2440which are tight with memory might be badly impacted by this though,
2441especially if this cache pushes the system into swapping.
2442A value of 0 means no limit. The smallest size of 1 byte may be
2443used to virtually disable this cache. Defaults to 256 MiB.
Junio C Hamano679d22d2007-06-02 21:13:442444
2445pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:142446The maximum size of a delta, that is cached in
Junio C Hamano9f883862009-08-11 06:23:522447linkgit:git-pack-objects[1]. This cache is used to speed up the
2448writing object phase by not having to recompute the final delta
2449result once the best match for all objects is found. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:442450
Junio C Hamano58155b42007-09-15 07:46:142451pack.threads::
2452Specifies the number of threads to spawn when searching for best
Junio C Hamano35738e82008-01-07 07:55:462453delta matches. This requires that linkgit:git-pack-objects[1]
Junio C Hamano58155b42007-09-15 07:46:142454be compiled with pthreads otherwise this option is ignored with a
2455warning. This is meant to reduce packing time on multiprocessor
2456machines. The required amount of memory for the delta search window
2457is however multiplied by the number of threads.
Junio C Hamano076ffcc2013-02-06 05:13:212458Specifying 0 will cause Git to auto-detect the number of CPU's
Junio C Hamano24bc09a2008-02-28 00:27:442459and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:142460
Junio C Hamanod814b6d2007-11-04 11:13:492461pack.indexVersion::
2462Specify the default pack index version. Valid values are 1 for
2463legacy pack index used by Git versions prior to 1.5.2, and 2 for
2464the new pack index with capabilities for packs larger than 4 GB
2465as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:382466packs. Version 2 is the default. Note that version 2 is enforced
2467and this config option ignored whenever the corresponding pack is
2468larger than 2 GB.
2469+
Junio C Hamano076ffcc2013-02-06 05:13:212470If you have an old Git that does not understand the version 2 `*.idx` file,
Junio C Hamanof85ef632016-02-17 22:31:062471cloning or fetching over a non native protocol (e.g. "http")
Junio C Hamanob76a6862012-05-02 22:02:462472that will copy both `*.pack` file and corresponding `*.idx` file from the
Junio C Hamanofce7c7e2008-07-02 03:06:382473other side may give you a repository that cannot be accessed with your
Junio C Hamano076ffcc2013-02-06 05:13:212474older version of Git. If the `*.pack` file is smaller than 2 GB, however,
Junio C Hamanofce7c7e2008-07-02 03:06:382475you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
Junio C Hamanob76a6862012-05-02 22:02:462476the `*.idx` file.
Junio C Hamanod814b6d2007-11-04 11:13:492477
Junio C Hamano09a926d2008-03-13 07:55:292478pack.packSizeLimit::
Junio C Hamano4d979582010-02-04 06:27:292479The maximum size of a pack. This setting only affects
2480packing to a file when repacking, i.e. the git:// protocol
Junio C Hamanob76a6862012-05-02 22:02:462481is unaffected. It can be overridden by the `--max-pack-size`
Junio C Hamano74fd0fc2016-05-10 21:23:562482option of linkgit:git-repack[1]. Reaching this limit results
2483in the creation of multiple packfiles; which in turn prevents
2484bitmaps from being created.
2485The minimum size allowed is limited to 1 MiB.
2486The default is unlimited.
Junio C Hamano4d979582010-02-04 06:27:292487Common unit suffixes of 'k', 'm', or 'g' are
2488supported.
Junio C Hamano49dccaf2008-02-10 10:48:012489
Junio C Hamano5b3533d2014-02-27 23:07:152490pack.useBitmaps::
2491When true, git will use pack bitmaps (if available) when packing
2492to stdout (e.g., during the server side of a fetch). Defaults to
2493true. You should not generally need to turn this off unless
2494you are debugging pack bitmaps.
2495
Junio C Hamano322c6242015-03-23 21:32:462496pack.writeBitmaps (deprecated)::
Junio C Hamano38d02532014-06-26 21:48:502497This is a deprecated synonym for `repack.writeBitmaps`.
Junio C Hamano5b3533d2014-02-27 23:07:152498
2499pack.writeBitmapHashCache::
2500When true, git will include a "hash cache" section in the bitmap
2501index (if one is written). This cache can be used to feed git's
2502delta heuristics, potentially leading to better deltas between
2503bitmapped and non-bitmapped objects (e.g., when serving a fetch
2504between an older, bitmapped pack and objects that have been
2505pushed since the last gc). The downside is that it consumes 4
2506bytes per object of disk space, and that JGit's bitmap
2507implementation does not understand it, causing it to complain if
2508Git and JGit are used on the same repository. Defaults to false.
2509
Junio C Hamano9e96a1a2008-08-16 10:23:182510pager.<cmd>::
Junio C Hamano788eeba2010-12-08 22:50:432511If the value is boolean, turns on or off pagination of the
Junio C Hamano076ffcc2013-02-06 05:13:212512output of a particular Git subcommand when writing to a tty.
Junio C Hamano788eeba2010-12-08 22:50:432513Otherwise, turns on pagination for the subcommand using the
Junio C Hamanob76a6862012-05-02 22:02:462514pager specified by the value of `pager.<cmd>`. If `--paginate`
2515or `--no-pager` is specified on the command line, it takes
Junio C Hamano788eeba2010-12-08 22:50:432516precedence over this option. To disable pagination for all
2517commands, set `core.pager` or `GIT_PAGER` to `cat`.
Junio C Hamano9e96a1a2008-08-16 10:23:182518
Junio C Hamanoa574a092010-06-13 19:57:102519pretty.<name>::
2520Alias for a --pretty= format string, as specified in
2521linkgit:git-log[1]. Any aliases defined here can be used just
2522as the built-in pretty formats could. For example,
Junio C Hamanob76a6862012-05-02 22:02:462523running `git config pretty.changelog "format:* %H %s"`
Junio C Hamanoa574a092010-06-13 19:57:102524would cause the invocation `git log --pretty=changelog`
Junio C Hamanob76a6862012-05-02 22:02:462525to be equivalent to running `git log "--pretty=format:* %H %s"`.
Junio C Hamanoa574a092010-06-13 19:57:102526Note that an alias with the same name as a built-in format
2527will be silently ignored.
2528
Junio C Hamano9e35abf2016-12-27 22:37:272529protocol.allow::
2530If set, provide a user defined default policy for all protocols which
2531don't explicitly have a policy (`protocol.<name>.allow`). By default,
2532if unset, known-safe protocols (http, https, git, ssh, file) have a
2533default policy of `always`, known-dangerous protocols (ext) have a
2534default policy of `never`, and all other protocols have a default
2535policy of `user`. Supported policies:
2536+
2537--
2538
2539* `always` - protocol is always able to be used.
2540
2541* `never` - protocol is never able to be used.
2542
2543* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2544 either unset or has a value of 1. This policy should be used when you want a
2545 protocol to be directly usable by the user but don't want it used by commands which
2546 execute clone/fetch/push commands without user input, e.g. recursive
2547 submodule initialization.
2548
2549--
2550
2551protocol.<name>.allow::
2552Set a policy to be used by protocol `<name>` with clone/fetch/push
2553commands. See `protocol.allow` above for the available policies.
2554+
2555The protocol names currently used by git are:
2556+
2557--
2558 - `file`: any local file-based path (including `file://` URLs,
2559 or local paths)
2560
2561 - `git`: the anonymous git protocol over a direct TCP
2562 connection (or proxy, if configured)
2563
2564 - `ssh`: git over ssh (including `host:path` syntax,
2565 `ssh://`, etc).
2566
2567 - `http`: git over http, both "smart http" and "dumb http".
2568 Note that this does _not_ include `https`; if you want to configure
2569 both, you must do so individually.
2570
2571 - any external helpers are named by their protocol (e.g., use
2572 `hg` to allow the `git-remote-hg` helper)
2573--
2574
Junio C Hamano912712b2017-12-06 18:04:012575protocol.version::
2576Experimental. If set, clients will attempt to communicate with a
2577server using the specified protocol version. If unset, no
2578attempt will be made by the client to communicate using a
2579particular protocol version, this results in protocol version 0
2580being used.
2581Supported versions:
2582+
2583--
2584
2585* `0` - the original wire protocol.
2586
2587* `1` - the original wire protocol with the addition of a version string
2588 in the initial response from the server.
2589
2590--
2591
Junio C Hamano5b3533d2014-02-27 23:07:152592pull.ff::
2593By default, Git does not create an extra merge commit when merging
2594a commit that is a descendant of the current commit. Instead, the
2595tip of the current branch is fast-forwarded. When set to `false`,
2596this variable tells Git to create an extra merge commit in such
2597a case (equivalent to giving the `--no-ff` option from the command
2598line). When set to `only`, only such fast-forward merges are
2599allowed (equivalent to giving the `--ff-only` option from the
Junio C Hamanoc4e2a202015-05-26 21:38:472600command line). This setting overrides `merge.ff` when pulling.
Junio C Hamano5b3533d2014-02-27 23:07:152601
Junio C Hamano515ab1d2011-12-09 23:41:202602pull.rebase::
2603When true, rebase branches on top of the fetched branch, instead
2604of merging the default branch from the default remote when "git
2605pull" is run. See "branch.<name>.rebase" for setting this on a
2606per-branch basis.
2607+
Junio C Hamano7db630e2015-09-17 20:26:222608When preserve, also pass `--preserve-merges` along to 'git rebase'
2609so that locally committed merge commits will not be flattened
2610by running 'git pull'.
Junio C Hamanocf4a1742013-09-11 22:57:502611+
Junio C Hamano289d7e82016-01-27 00:20:382612When the value is `interactive`, the rebase is run in interactive mode.
2613+
Junio C Hamano515ab1d2011-12-09 23:41:202614*NOTE*: this is a possibly dangerous operation; do *not* use
2615it unless you understand the implications (see linkgit:git-rebase[1]
2616for details).
2617
Junio C Hamano07824ce2006-04-25 07:36:542618pull.octopus::
2619The default merge strategy to use when pulling multiple branches
2620at once.
2621
2622pull.twohead::
2623The default merge strategy to use when pulling a single branch.
2624
Junio C Hamano1de75722009-03-26 08:39:382625push.default::
Junio C Hamano58655592013-07-11 20:52:332626Defines the action `git push` should take if no refspec is
2627explicitly given. Different values are well-suited for
2628specific workflows; for instance, in a purely central workflow
2629(i.e. the fetch source is equal to the push destination),
2630`upstream` is probably what you want. Possible values are:
Junio C Hamano1de75722009-03-26 08:39:382631+
Junio C Hamanobcaa8bc2012-07-03 22:17:202632--
Junio C Hamano58655592013-07-11 20:52:332633
2634* `nothing` - do not push anything (error out) unless a refspec is
2635 explicitly given. This is primarily meant for people who want to
2636 avoid mistakes by always being explicit.
2637
2638* `current` - push the current branch to update a branch with the same
2639 name on the receiving end. Works in both central and non-central
2640 workflows.
2641
2642* `upstream` - push the current branch back to the branch whose
2643 changes are usually integrated into the current branch (which is
2644 called `@{upstream}`). This mode only makes sense if you are
2645 pushing to the same repository you would normally pull from
2646 (i.e. central workflow).
2647
Junio C Hamanocb06ef92017-03-21 22:40:142648* `tracking` - This is a deprecated synonym for `upstream`.
2649
Junio C Hamano58655592013-07-11 20:52:332650* `simple` - in centralized workflow, work like `upstream` with an
2651 added safety to refuse to push if the upstream branch's name is
2652 different from the local one.
Junio C Hamanobcaa8bc2012-07-03 22:17:202653+
Junio C Hamano58655592013-07-11 20:52:332654When pushing to a remote that is different from the remote you normally
2655pull from, work as `current`. This is the safest option and is suited
2656for beginners.
2657+
Junio C Hamano1d669b82014-03-11 21:36:002658This mode has become the default in Git 2.0.
Junio C Hamano58655592013-07-11 20:52:332659
2660* `matching` - push all branches having the same name on both ends.
2661 This makes the repository you are pushing to remember the set of
2662 branches that will be pushed out (e.g. if you always push 'maint'
2663 and 'master' there and no other branches, the repository you push
2664 to will have these two branches, and your local 'maint' and
2665 'master' will be pushed there).
2666+
2667To use this mode effectively, you have to make sure _all_ the
2668branches you would push out are ready to be pushed out before
2669running 'git push', as the whole point of this mode is to allow you
2670to push all of the branches in one go. If you usually finish work
2671on only one branch and push out the result, while other branches are
2672unfinished, this mode is not for you. Also this mode is not
2673suitable for pushing into a shared central repository, as other
2674people may add new branches there, or update the tip of existing
2675branches outside your control.
2676+
Junio C Hamano1d669b82014-03-11 21:36:002677This used to be the default, but not since Git 2.0 (`simple` is the
2678new default).
Junio C Hamano58655592013-07-11 20:52:332679
2680--
Junio C Hamano1de75722009-03-26 08:39:382681
Junio C Hamano322c6242015-03-23 21:32:462682push.followTags::
Junio C Hamano92d80372016-07-13 22:00:052683If set to true enable `--follow-tags` option by default. You
Junio C Hamano322c6242015-03-23 21:32:462684may override this configuration at time of push by specifying
Junio C Hamano92d80372016-07-13 22:00:052685`--no-follow-tags`.
Junio C Hamano322c6242015-03-23 21:32:462686
Junio C Hamano3891e252015-08-31 23:06:132687push.gpgSign::
2688May be set to a boolean value, or the string 'if-asked'. A true
Junio C Hamano92d80372016-07-13 22:00:052689value causes all pushes to be GPG signed, as if `--signed` is
Junio C Hamano3891e252015-08-31 23:06:132690passed to linkgit:git-push[1]. The string 'if-asked' causes
2691pushes to be signed if the server supports it, as if
Junio C Hamano92d80372016-07-13 22:00:052692`--signed=if-asked` is passed to 'git push'. A false value may
Junio C Hamano3891e252015-08-31 23:06:132693override a value from a lower-priority config file. An explicit
2694command-line flag always overrides this config option.
Junio C Hamano322c6242015-03-23 21:32:462695
Junio C Hamano3a9c0342017-11-10 06:01:122696push.pushOption::
2697When no `--push-option=<option>` argument is given from the
2698command line, `git push` behaves as if each <value> of
2699this variable is given as `--push-option=<value>`.
2700+
2701This is a multi-valued variable, and an empty value can be used in a
2702higher priority configuration file (e.g. `.git/config` in a
2703repository) to clear the values inherited from a lower priority
2704configuration files (e.g. `$HOME/.gitconfig`).
2705+
2706--
2707
2708Example:
2709
2710/etc/gitconfig
2711 push.pushoption = a
2712 push.pushoption = b
2713
2714~/.gitconfig
2715 push.pushoption = c
2716
2717repo/.git/config
2718 push.pushoption =
2719 push.pushoption = b
2720
2721This will result in only b (a and c are cleared).
2722
2723--
2724
Junio C Hamano409a33a2015-12-22 23:45:232725push.recurseSubmodules::
2726Make sure all submodule commits used by the revisions to be pushed
2727are available on a remote-tracking branch. If the value is 'check'
2728then Git will verify that all submodule commits that changed in the
2729revisions to be pushed are available on at least one remote of the
2730submodule. If any commits are missing, the push will be aborted and
2731exit with non-zero status. If the value is 'on-demand' then all
2732submodules that changed in the revisions to be pushed will be
2733pushed. If on-demand was not able to push all necessary revisions
2734it will also be aborted and exit with non-zero status. If the value
2735is 'no' then default behavior of ignoring submodules when pushing
2736is retained. You may override this configuration at time of push by
2737specifying '--recurse-submodules=check|on-demand|no'.
2738
Junio C Hamanoea6a7642009-03-11 23:56:192739rebase.stat::
2740Whether to show a diffstat of what changed upstream since the last
2741rebase. False by default.
2742
Junio C Hamano322c6242015-03-23 21:32:462743rebase.autoSquash::
Junio C Hamano92d80372016-07-13 22:00:052744If set to true enable `--autosquash` option by default.
Junio C Hamano075ae872010-09-01 18:43:072745
Junio C Hamano322c6242015-03-23 21:32:462746rebase.autoStash::
Junio C Hamano967cda72017-06-30 21:49:532747When set to true, automatically create a temporary stash entry
Junio C Hamanof1f5a7b2013-06-11 22:23:522748before the operation begins, and apply it after the operation
2749ends. This means that you can run rebase on a dirty worktree.
2750However, use with care: the final stash application after a
2751successful rebase might result in non-trivial conflicts.
2752Defaults to false.
2753
Junio C Hamanod7ed4042015-08-03 19:43:002754rebase.missingCommitsCheck::
2755If set to "warn", git rebase -i will print a warning if some
2756commits are removed (e.g. a line was deleted), however the
2757rebase will still proceed. If set to "error", it will print
2758the previous warning and stop the rebase, 'git rebase
2759--edit-todo' can then be used to correct the error. If set to
2760"ignore", no checking is done.
2761To drop a commit without warning or error, use the `drop`
2762command in the todo-list.
2763Defaults to "ignore".
2764
Junio C Hamanof2f28b12016-10-31 21:41:582765rebase.instructionFormat::
Junio C Hamanod7ed4042015-08-03 19:43:002766A format string, as specified in linkgit:git-log[1], to be used for
2767the instruction list during an interactive rebase. The format will automatically
2768have the long commit hash prepended to the format.
2769
Junio C Hamano322c6242015-03-23 21:32:462770receive.advertiseAtomic::
Junio C Hamano6bb32e62015-02-17 22:11:262771By default, git-receive-pack will advertise the atomic push
Junio C Hamanoe48a1132016-08-03 22:40:212772capability to its clients. If you don't want to advertise this
2773capability, set this variable to false.
2774
2775receive.advertisePushOptions::
Junio C Hamanod3ab1ad2017-05-23 06:52:182776When set to true, git-receive-pack will advertise the push options
2777capability to its clients. False by default.
Junio C Hamano6bb32e62015-02-17 22:11:262778
Junio C Hamano621e1232009-10-26 05:16:472779receive.autogc::
2780By default, git-receive-pack will run "git-gc --auto" after
2781receiving data from git-push and updating refs. You can stop
2782it by setting this variable to false.
2783
Junio C Hamano322c6242015-03-23 21:32:462784receive.certNonceSeed::
Junio C Hamano9236fea2014-10-14 22:28:092785By setting this variable to a string, `git receive-pack`
2786will accept a `git push --signed` and verifies it by using
2787a "nonce" protected by HMAC using this string as a secret
2788key.
2789
Junio C Hamano322c6242015-03-23 21:32:462790receive.certNonceSlop::
Junio C Hamano9236fea2014-10-14 22:28:092791When a `git push --signed` sent a push certificate with a
2792"nonce" that was issued by a receive-pack serving the same
2793repository within this many seconds, export the "nonce"
2794found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2795hooks (instead of what the receive-pack asked the sending
2796side to include). This may allow writing checks in
2797`pre-receive` and `post-receive` a bit easier. Instead of
2798checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2799that records by how many seconds the nonce is stale to
2800decide if they want to accept the certificate, they only
2801can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2802
Junio C Hamano4653c6f2008-11-26 22:50:202803receive.fsckObjects::
2804If it is set to true, git-receive-pack will check all received
2805objects. It will abort in the case of a malformed object or a
2806broken link. The result of an abort are only dangling objects.
Junio C Hamano8fb66e52011-10-05 20:59:512807Defaults to false. If not set, the value of `transfer.fsckObjects`
2808is used instead.
Junio C Hamano4653c6f2008-11-26 22:50:202809
Junio C Hamanod7ed4042015-08-03 19:43:002810receive.fsck.<msg-id>::
2811When `receive.fsckObjects` is set to true, errors can be switched
2812to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2813setting where the `<msg-id>` is the fsck message ID and the value
2814is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2815the error/warning with the message ID, e.g. "missingEmail: invalid
2816author/committer line - missing email" means that setting
2817`receive.fsck.missingEmail = ignore` will hide that issue.
2818+
2819This feature is intended to support working with legacy repositories
2820which would not pass pushing when `receive.fsckObjects = true`, allowing
2821the host to accept repositories with certain known issues but still catch
2822other issues.
2823
2824receive.fsck.skipList::
2825The path to a sorted list of object names (i.e. one SHA-1 per
2826line) that are known to be broken in a non-fatal way and should
2827be ignored. This feature is useful when an established project
2828should be accepted despite early commits containing errors that
2829can be safely ignored such as invalid committer email addresses.
2830Note: corrupt objects cannot be skipped with this setting.
2831
Junio C Hamanoe48a1132016-08-03 22:40:212832receive.keepAlive::
2833After receiving the pack from the client, `receive-pack` may
2834produce no output (if `--quiet` was specified) while processing
2835the pack, causing some networks to drop the TCP connection.
2836With this option set, if `receive-pack` does not transmit
2837any data in this phase for `receive.keepAlive` seconds, it will
2838send a short keepalive packet. The default is 5 seconds; set
2839to 0 to disable keepalives entirely.
2840
Junio C Hamano4653c6f2008-11-26 22:50:202841receive.unpackLimit::
2842If the number of objects received in a push is below this
2843limit then the objects will be unpacked into loose object
2844files. However if the number of received objects equals or
2845exceeds this limit then the received pack will be stored as
2846a pack, after adding any missing delta bases. Storing the
2847pack from a push can make the push operation complete faster,
2848especially on slow filesystems. If not set, the value of
2849`transfer.unpackLimit` is used instead.
2850
Junio C Hamanocd451662016-09-13 00:54:092851receive.maxInputSize::
2852If the size of the incoming pack stream is larger than this
2853limit, then git-receive-pack will error out, instead of
2854accepting the pack file. If not set or set to 0, then the size
2855is unlimited.
2856
Junio C Hamano4653c6f2008-11-26 22:50:202857receive.denyDeletes::
2858If set to true, git-receive-pack will deny a ref update that deletes
2859the ref. Use this to prevent such a ref deletion via a push.
2860
Junio C Hamanob4448a82010-07-26 09:02:322861receive.denyDeleteCurrent::
2862If set to true, git-receive-pack will deny a ref update that
2863deletes the currently checked out branch of a non-bare repository.
2864
Junio C Hamano4653c6f2008-11-26 22:50:202865receive.denyCurrentBranch::
Junio C Hamanoe97d5772010-05-19 08:13:582866If set to true or "refuse", git-receive-pack will deny a ref update
Junio C Hamano4653c6f2008-11-26 22:50:202867to the currently checked out branch of a non-bare repository.
2868Such a push is potentially dangerous because it brings the HEAD
2869out of sync with the index and working tree. If set to "warn",
2870print a warning of such a push to stderr, but allow the push to
2871proceed. If set to false or "ignore", allow such pushes with no
Junio C Hamanoafb395b2010-03-17 22:16:152872message. Defaults to "refuse".
Junio C Hamano6df93d92014-12-22 22:48:092873+
2874Another option is "updateInstead" which will update the working
Junio C Hamano6bb32e62015-02-17 22:11:262875tree if pushing into the current branch. This option is
Junio C Hamano6df93d92014-12-22 22:48:092876intended for synchronizing working directories when one side is not easily
2877accessible via interactive ssh (e.g. a live web site, hence the requirement
2878that the working directory be clean). This mode also comes in handy when
2879developing inside a VM to test and fix code on different Operating Systems.
Junio C Hamano6bb32e62015-02-17 22:11:262880+
2881By default, "updateInstead" will refuse the push if the working tree or
2882the index have any difference from the HEAD, but the `push-to-checkout`
2883hook can be used to customize this. See linkgit:githooks[5].
Junio C Hamano4653c6f2008-11-26 22:50:202884
2885receive.denyNonFastForwards::
2886If set to true, git-receive-pack will deny a ref update which is
Junio C Hamano3f680f32009-11-16 02:10:542887not a fast-forward. Use this to prevent such an update via a push,
Junio C Hamano4653c6f2008-11-26 22:50:202888even if that push is forced. This configuration variable is
2889set when initializing a shared repository.
2890
Junio C Hamano322c6242015-03-23 21:32:462891receive.hideRefs::
Junio C Hamanob6aa12e2015-08-19 22:40:172892This variable is the same as `transfer.hideRefs`, but applies
2893only to `receive-pack` (and so affects pushes, but not fetches).
2894An attempt to update or delete a hidden ref by `git push` is
2895rejected.
Junio C Hamano80ad00d2013-02-18 00:19:032896
Junio C Hamano322c6242015-03-23 21:32:462897receive.updateServerInfo::
Junio C Hamano621e1232009-10-26 05:16:472898If set to true, git-receive-pack will run git-update-server-info
2899after receiving data from git-push and updating refs.
2900
Junio C Hamano322c6242015-03-23 21:32:462901receive.shallowUpdate::
Junio C Hamano61525f92014-01-17 22:46:492902If set to true, .git/shallow can be updated when new refs
2903require new shallow roots. Otherwise those refs are rejected.
2904
Junio C Hamano322c6242015-03-23 21:32:462905remote.pushDefault::
Junio C Hamano63b6fdb2013-04-07 23:37:132906The remote to push to by default. Overrides
2907`branch.<name>.remote` for all branches, and is overridden by
Junio C Hamano322c6242015-03-23 21:32:462908`branch.<name>.pushRemote` for specific branches.
Junio C Hamano63b6fdb2013-04-07 23:37:132909
Junio C Hamano249572f2006-10-24 05:44:082910remote.<name>.url::
Junio C Hamano35738e82008-01-07 07:55:462911The URL of a remote repository. See linkgit:git-fetch[1] or
2912linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:082913
Junio C Hamano0e88f3e2009-06-21 08:03:252914remote.<name>.pushurl::
2915The push URL of a remote repository. See linkgit:git-push[1].
2916
Junio C Hamano58256872007-12-04 08:31:132917remote.<name>.proxy::
2918For remotes that require curl (http, https and ftp), the URL to
2919the proxy to use for that remote. Set to the empty string to
2920disable proxying for that remote.
2921
Junio C Hamanoffe10ca2016-02-04 00:44:232922remote.<name>.proxyAuthMethod::
2923For remotes that require curl (http, https and ftp), the method to use for
2924authenticating against the proxy in use (probably set in
2925`remote.<name>.proxy`). See `http.proxyAuthMethod`.
2926
Junio C Hamano249572f2006-10-24 05:44:082927remote.<name>.fetch::
Junio C Hamano35738e82008-01-07 07:55:462928The default set of "refspec" for linkgit:git-fetch[1]. See
2929linkgit:git-fetch[1].
Junio C Hamano249572f2006-10-24 05:44:082930
2931remote.<name>.push::
Junio C Hamano35738e82008-01-07 07:55:462932The default set of "refspec" for linkgit:git-push[1]. See
2933linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:082934
Junio C Hamano47d68a52008-05-06 06:35:402935remote.<name>.mirror::
2936If true, pushing to this remote will automatically behave
Junio C Hamanob76a6862012-05-02 22:02:462937as if the `--mirror` option was given on the command line.
Junio C Hamano47d68a52008-05-06 06:35:402938
Junio C Hamano118d2772007-02-21 20:24:102939remote.<name>.skipDefaultUpdate::
2940If true, this remote will be skipped by default when updating
Junio C Hamano9df0c662009-11-23 11:09:272941using linkgit:git-fetch[1] or the `update` subcommand of
2942linkgit:git-remote[1].
2943
2944remote.<name>.skipFetchAll::
2945If true, this remote will be skipped by default when updating
2946using linkgit:git-fetch[1] or the `update` subcommand of
2947linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:102948
Junio C Hamano4ad294b2007-01-20 02:22:502949remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:482950The default program to execute on the remote side when pushing. See
Junio C Hamano1dbca522015-05-22 20:48:552951option --receive-pack of linkgit:git-push[1].
Junio C Hamano4ad294b2007-01-20 02:22:502952
Junio C Hamano54ea8d32007-01-25 07:59:482953remote.<name>.uploadpack::
2954The default program to execute on the remote side when fetching. See
Junio C Hamano1dbca522015-05-22 20:48:552955option --upload-pack of linkgit:git-fetch-pack[1].
Junio C Hamano54ea8d32007-01-25 07:59:482956
Junio C Hamano322c6242015-03-23 21:32:462957remote.<name>.tagOpt::
Junio C Hamano1dbca522015-05-22 20:48:552958Setting this value to --no-tags disables automatic tag following when
2959fetching from remote <name>. Setting it to --tags will fetch every
Junio C Hamanocc7636a2010-05-21 14:57:532960tag from remote <name>, even if they are not reachable from remote
Junio C Hamano075ae872010-09-01 18:43:072961branch heads. Passing these flags directly to linkgit:git-fetch[1] can
Junio C Hamano1dbca522015-05-22 20:48:552962override this setting. See options --tags and --no-tags of
Junio C Hamano075ae872010-09-01 18:43:072963linkgit:git-fetch[1].
Junio C Hamano17dde0e2007-02-26 09:50:212964
Junio C Hamano096dde22009-12-26 23:14:112965remote.<name>.vcs::
Junio C Hamano076ffcc2013-02-06 05:13:212966Setting this to a value <vcs> will cause Git to interact with
Junio C Hamano096dde22009-12-26 23:14:112967the remote with the git-remote-<vcs> helper.
2968
Junio C Hamano8eac2682013-09-09 22:35:202969remote.<name>.prune::
2970When set to true, fetching from this remote by default will also
Junio C Hamano4c8f2d92013-12-13 00:55:422971remove any remote-tracking references that no longer exist on the
2972remote (as if the `--prune` option was given on the command line).
Junio C Hamano8eac2682013-09-09 22:35:202973Overrides `fetch.prune` settings, if any.
2974
Junio C Hamano118d2772007-02-21 20:24:102975remotes.<group>::
2976The list of remotes which are fetched by "git remote update
Junio C Hamano35738e82008-01-07 07:55:462977<group>". See linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:102978
Junio C Hamano322c6242015-03-23 21:32:462979repack.useDeltaBaseOffset::
Junio C Hamanofce7c7e2008-07-02 03:06:382980By default, linkgit:git-repack[1] creates packs that use
2981delta-base offset. If you need to share your repository with
Junio C Hamano076ffcc2013-02-06 05:13:212982Git older than version 1.4.4, either directly or via a dumb
Junio C Hamanofce7c7e2008-07-02 03:06:382983protocol such as http, then you need to set this option to
Junio C Hamano076ffcc2013-02-06 05:13:212984"false" and repack. Access from old Git versions over the
Junio C Hamanofce7c7e2008-07-02 03:06:382985native protocol are unaffected by this option.
Junio C Hamano77b7e902006-10-23 07:18:502986
Junio C Hamano3b0cdc22014-03-18 22:06:162987repack.packKeptObjects::
2988If set to true, makes `git repack` act as if
2989`--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2990details. Defaults to `false` normally, but `true` if a bitmap
2991index is being written (either via `--write-bitmap-index` or
Junio C Hamano38d02532014-06-26 21:48:502992`repack.writeBitmaps`).
2993
2994repack.writeBitmaps::
2995When true, git will write a bitmap index when packing all
2996objects to disk (e.g., when `git repack -a` is run). This
2997index can speed up the "counting objects" phase of subsequent
2998packs created for clones and fetches, at the cost of some disk
Junio C Hamano74fd0fc2016-05-10 21:23:562999space and extra time spent on the initial repack. This has
3000no effect if multiple packfiles are created.
3001Defaults to false.
Junio C Hamano3b0cdc22014-03-18 22:06:163002
Junio C Hamano322c6242015-03-23 21:32:463003rerere.autoUpdate::
Junio C Hamano4653c6f2008-11-26 22:50:203004When set to true, `git-rerere` updates the index with the
3005resulting contents after it cleanly resolves conflicts using
3006previously recorded resolution. Defaults to false.
3007
3008rerere.enabled::
3009Activate recording of resolved conflicts, so that identical
Junio C Hamano4fd24422012-01-06 21:52:433010conflict hunks can be resolved automatically, should they be
3011encountered again. By default, linkgit:git-rerere[1] is
3012enabled if there is an `rr-cache` directory under the
Junio C Hamano864ba892012-01-13 17:42:053013`$GIT_DIR`, e.g. if "rerere" was previously used in the
3014repository.
Junio C Hamano4653c6f2008-11-26 22:50:203015
Junio C Hamano1bbd0f42009-07-23 06:20:293016sendemail.identity::
3017A configuration identity. When given, causes values in the
3018'sendemail.<identity>' subsection to take precedence over
3019values in the 'sendemail' section. The default identity is
Junio C Hamano042f2142016-06-27 18:05:053020the value of `sendemail.identity`.
Junio C Hamano1bbd0f42009-07-23 06:20:293021
Junio C Hamano322c6242015-03-23 21:32:463022sendemail.smtpEncryption::
Junio C Hamano1bbd0f42009-07-23 06:20:293023See linkgit:git-send-email[1] for description. Note that this
3024setting is not subject to the 'identity' mechanism.
3025
Junio C Hamanobe087982015-02-22 21:29:393026sendemail.smtpssl (deprecated)::
Junio C Hamano322c6242015-03-23 21:32:463027Deprecated alias for 'sendemail.smtpEncryption = ssl'.
Junio C Hamano1bbd0f42009-07-23 06:20:293028
Junio C Hamano58f587a2013-07-22 19:20:593029sendemail.smtpsslcertpath::
3030Path to ca-certificates (either a directory or a single file).
3031Set it to an empty string to disable certificate verification.
3032
Junio C Hamano1bbd0f42009-07-23 06:20:293033sendemail.<identity>.*::
3034Identity-specific versions of the 'sendemail.*' parameters
Junio C Hamano7526f0a2017-08-24 18:09:353035found below, taking precedence over those when this
3036identity is selected, through either the command-line or
Junio C Hamano042f2142016-06-27 18:05:053037`sendemail.identity`.
Junio C Hamano1bbd0f42009-07-23 06:20:293038
Junio C Hamano322c6242015-03-23 21:32:463039sendemail.aliasesFile::
3040sendemail.aliasFileType::
Junio C Hamanoea3b7522013-04-18 19:37:533041sendemail.annotate::
Junio C Hamano1bbd0f42009-07-23 06:20:293042sendemail.bcc::
3043sendemail.cc::
Junio C Hamano322c6242015-03-23 21:32:463044sendemail.ccCmd::
3045sendemail.chainReplyTo::
Junio C Hamano1bbd0f42009-07-23 06:20:293046sendemail.confirm::
Junio C Hamano322c6242015-03-23 21:32:463047sendemail.envelopeSender::
Junio C Hamano1bbd0f42009-07-23 06:20:293048sendemail.from::
Junio C Hamano322c6242015-03-23 21:32:463049sendemail.multiEdit::
Junio C Hamano1bbd0f42009-07-23 06:20:293050sendemail.signedoffbycc::
Junio C Hamano322c6242015-03-23 21:32:463051sendemail.smtpPass::
Junio C Hamano1bbd0f42009-07-23 06:20:293052sendemail.suppresscc::
Junio C Hamano322c6242015-03-23 21:32:463053sendemail.suppressFrom::
Junio C Hamano1bbd0f42009-07-23 06:20:293054sendemail.to::
Junio C Hamano4886c772017-11-27 03:33:283055sendemail.tocmd::
Junio C Hamano322c6242015-03-23 21:32:463056sendemail.smtpDomain::
3057sendemail.smtpServer::
3058sendemail.smtpServerPort::
3059sendemail.smtpServerOption::
3060sendemail.smtpUser::
Junio C Hamano1bbd0f42009-07-23 06:20:293061sendemail.thread::
Junio C Hamano322c6242015-03-23 21:32:463062sendemail.transferEncoding::
Junio C Hamano1bbd0f42009-07-23 06:20:293063sendemail.validate::
Junio C Hamanoc9394b22015-01-07 22:45:483064sendemail.xmailer::
Junio C Hamano1bbd0f42009-07-23 06:20:293065See linkgit:git-send-email[1] for description.
3066
Junio C Hamanobe087982015-02-22 21:29:393067sendemail.signedoffcc (deprecated)::
Junio C Hamano042f2142016-06-27 18:05:053068Deprecated alias for `sendemail.signedoffbycc`.
Junio C Hamano1bbd0f42009-07-23 06:20:293069
Junio C Hamano08a3a232017-07-07 02:28:443070sendemail.smtpBatchSize::
3071Number of messages to be sent per connection, after that a relogin
3072will happen. If the value is 0 or undefined, send all messages in
3073one connection.
3074See also the `--batch-size` option of linkgit:git-send-email[1].
3075
3076sendemail.smtpReloginDelay::
3077Seconds wait before reconnecting to smtp server.
3078See also the `--relogin-delay` option of linkgit:git-send-email[1].
3079
Junio C Hamano07824ce2006-04-25 07:36:543080showbranch.default::
Junio C Hamano35738e82008-01-07 07:55:463081The default set of branches for linkgit:git-show-branch[1].
3082See linkgit:git-show-branch[1].
Junio C Hamano07824ce2006-04-25 07:36:543083
Junio C Hamano3d4a66d2017-03-17 21:07:263084splitIndex.maxPercentChange::
3085When the split index feature is used, this specifies the
3086percent of entries the split index can contain compared to the
3087total number of entries in both the split index and the shared
3088index before a new shared index is written.
3089The value should be between 0 and 100. If the value is 0 then
3090a new shared index is always written, if it is 100 a new
3091shared index is never written.
3092By default the value is 20, so a new shared index is written
3093if the number of entries in the split index would be greater
3094than 20 percent of the total number of entries.
3095See linkgit:git-update-index[1].
3096
3097splitIndex.sharedIndexExpire::
3098When the split index feature is used, shared index files that
3099were not modified since the time this variable specifies will
3100be removed when a new shared index file is created. The value
3101"now" expires all entries immediately, and "never" suppresses
3102expiration altogether.
3103The default value is "2.weeks.ago".
3104Note that a shared index file is considered modified (for the
3105purpose of expiration) each time a new split-index file is
3106either created based on it or read from it.
3107See linkgit:git-update-index[1].
3108
Junio C Hamano942b35e2007-12-09 10:19:333109status.relativePaths::
Junio C Hamano35738e82008-01-07 07:55:463110By default, linkgit:git-status[1] shows paths relative to the
Junio C Hamano942b35e2007-12-09 10:19:333111current directory. Setting this variable to `false` shows paths
Junio C Hamano076ffcc2013-02-06 05:13:213112relative to the repository root (this was the default for Git
Junio C Hamano942b35e2007-12-09 10:19:333113prior to v1.5.4).
3114
Junio C Hamano58655592013-07-11 20:52:333115status.short::
3116Set to true to enable --short by default in linkgit:git-status[1].
3117The option --no-short takes precedence over this variable.
3118
3119status.branch::
3120Set to true to enable --branch by default in linkgit:git-status[1].
3121The option --no-branch takes precedence over this variable.
3122
Junio C Hamano79f4c7c2013-09-20 21:03:373123status.displayCommentPrefix::
3124If set to true, linkgit:git-status[1] will insert a comment
3125prefix before each output line (starting with
3126`core.commentChar`, i.e. `#` by default). This was the
3127behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
3128Defaults to false.
3129
Junio C Hamano967cda72017-06-30 21:49:533130status.showStash::
3131If set to true, linkgit:git-status[1] will display the number of
3132entries currently stashed away.
3133Defaults to false.
3134
Junio C Hamano4224f992008-06-23 07:14:083135status.showUntrackedFiles::
3136By default, linkgit:git-status[1] and linkgit:git-commit[1] show
3137files which are not currently tracked by Git. Directories which
3138contain only untracked files, are shown with the directory name
3139only. Showing untracked files means that Git needs to lstat() all
Junio C Hamano2efd5e42014-11-10 22:38:523140the files in the whole repository, which might be slow on some
Junio C Hamano4224f992008-06-23 07:14:083141systems. So, this variable controls how the commands displays
3142the untracked files. Possible values are:
3143+
3144--
Junio C Hamano7f9fa862010-10-19 23:51:143145* `no` - Show no untracked files.
3146* `normal` - Show untracked files and directories.
3147* `all` - Show also individual files in untracked directories.
Junio C Hamano4224f992008-06-23 07:14:083148--
3149+
3150If this variable is not specified, it defaults to 'normal'.
3151This variable can be overridden with the -u|--untracked-files option
3152of linkgit:git-status[1] and linkgit:git-commit[1].
3153
Junio C Hamano322c6242015-03-23 21:32:463154status.submoduleSummary::
Junio C Hamanob671fb52010-06-01 05:06:143155Defaults to false.
3156If this is set to a non zero number or true (identical to -1 or an
3157unlimited number), the submodule summary will be enabled and a
3158summary of commits for modified submodules will be shown (see
Junio C Hamano369e3402013-10-15 18:40:253159--summary-limit option of linkgit:git-submodule[1]). Please note
3160that the summary output command will be suppressed for all
3161submodules when `diff.ignoreSubmodules` is set to 'all' or only
Junio C Hamanoc8c398a2014-06-16 21:14:053162for those submodules where `submodule.<name>.ignore=all`. The only
3163exception to that rule is that status and commit will show staged
3164submodule changes. To
Junio C Hamano369e3402013-10-15 18:40:253165also view the summary for ignored submodules you can either use
Junio C Hamanoe1aeb5e2014-06-06 19:16:293166the --ignore-submodules=dirty command-line option or the 'git
Junio C Hamano369e3402013-10-15 18:40:253167submodule summary' command, which shows a similar output but does
3168not honor these settings.
Junio C Hamanob671fb52010-06-01 05:06:143169
Junio C Hamano1eb56092015-10-05 20:39:533170stash.showPatch::
3171If this is set to true, the `git stash show` command without an
Junio C Hamano967cda72017-06-30 21:49:533172option will show the stash entry in patch form. Defaults to false.
Junio C Hamano1eb56092015-10-05 20:39:533173See description of 'show' command in linkgit:git-stash[1].
3174
3175stash.showStat::
3176If this is set to true, the `git stash show` command without an
Junio C Hamano967cda72017-06-30 21:49:533177option will show diffstat of the stash entry. Defaults to true.
Junio C Hamano1eb56092015-10-05 20:39:533178See description of 'show' command in linkgit:git-stash[1].
3179
Junio C Hamano78e3a782010-07-15 22:24:453180submodule.<name>.url::
Junio C Hamanoc0859f72016-10-17 22:22:573181The URL for a submodule. This variable is copied from the .gitmodules
3182file to the git config via 'git submodule init'. The user can change
3183the configured URL before obtaining the submodule via 'git submodule
Junio C Hamanodc8d0c32017-03-30 23:00:213184update'. If neither submodule.<name>.active or submodule.active are
3185set, the presence of this variable is used as a fallback to indicate
3186whether the submodule is of interest to git commands.
Junio C Hamanoc0859f72016-10-17 22:22:573187See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
Junio C Hamano6bf68cf2015-03-06 23:46:293188
Junio C Hamano78e3a782010-07-15 22:24:453189submodule.<name>.update::
Junio C Hamanoef75f372017-09-29 04:22:333190The method by which a submodule is updated by 'git submodule update',
3191which is the only affected command, others such as
3192'git checkout --recurse-submodules' are unaffected. It exists for
3193historical reasons, when 'git submodule' was the only command to
3194interact with submodules; settings like `submodule.active`
3195and `pull.rebase` are more specific. It is populated by
3196`git submodule init` from the linkgit:gitmodules[5] file.
3197See description of 'update' command in linkgit:git-submodule[1].
Junio C Hamano78e3a782010-07-15 22:24:453198
Junio C Hamanoabad6da2013-01-06 09:06:323199submodule.<name>.branch::
3200The remote branch name for a submodule, used by `git submodule
3201update --remote`. Set this option to override the value found in
3202the `.gitmodules` file. See linkgit:git-submodule[1] and
3203linkgit:gitmodules[5] for details.
3204
Junio C Hamano0d75e872010-12-17 06:57:263205submodule.<name>.fetchRecurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:103206This option can be used to control recursive fetching of this
Junio C Hamano7165bf72011-01-04 22:06:183207submodule. It can be overridden by using the --[no-]recurse-submodules
Junio C Hamanoe1aeb5e2014-06-06 19:16:293208command-line option to "git fetch" and "git pull".
Junio C Hamano0d75e872010-12-17 06:57:263209This setting will override that from in the linkgit:gitmodules[5]
3210file.
3211
Junio C Hamano619596a2010-08-18 22:15:353212submodule.<name>.ignore::
3213Defines under what circumstances "git status" and the diff family show
3214a submodule as modified. When set to "all", it will never be considered
Junio C Hamanoc8c398a2014-06-16 21:14:053215modified (but it will nonetheless show up in the output of status and
3216commit when it has been staged), "dirty" will ignore all changes
3217to the submodules work tree and
Junio C Hamano619596a2010-08-18 22:15:353218takes only differences between the HEAD of the submodule and the commit
3219recorded in the superproject into account. "untracked" will additionally
3220let submodules with modified tracked files in their work tree show up.
3221Using "none" (the default when this option is not set) also shows
3222submodules that have untracked files in their work tree as changed.
3223This setting overrides any setting made in .gitmodules for this submodule,
Junio C Hamanode9745c2010-08-23 17:10:183224both settings can be overridden on the command line by using the
Junio C Hamano369e3402013-10-15 18:40:253225"--ignore-submodules" option. The 'git submodule' commands are not
3226affected by this setting.
Junio C Hamano619596a2010-08-18 22:15:353227
Junio C Hamanodc8d0c32017-03-30 23:00:213228submodule.<name>.active::
3229Boolean value indicating if the submodule is of interest to git
3230commands. This config option takes precedence over the
3231submodule.active config option.
3232
3233submodule.active::
3234A repeated field which contains a pathspec used to match against a
3235submodule's path to determine if the submodule is of interest to git
3236commands.
3237
Junio C Hamano3a31ce52017-06-13 21:15:553238submodule.recurse::
3239Specifies if commands recurse into submodules by default. This
3240applies to all commands that have a `--recurse-submodules` option.
3241Defaults to false.
3242
Junio C Hamanobec5da42016-04-06 22:58:213243submodule.fetchJobs::
3244Specifies how many submodules are fetched/cloned at the same time.
3245A positive integer allows up to that number of submodules fetched
3246in parallel. A value of 0 will give some reasonable default.
3247If unset, it defaults to 1.
3248
Junio C Hamanocd451662016-09-13 00:54:093249submodule.alternateLocation::
3250Specifies how the submodules obtain alternates when submodules are
3251cloned. Possible values are `no`, `superproject`.
3252By default `no` is assumed, which doesn't add references. When the
3253value is set to `superproject` the submodule to be cloned computes
3254its alternates location relative to the superprojects alternate.
3255
Junio C Hamanoce01de82017-02-16 22:59:123256submodule.alternateErrorStrategy::
Junio C Hamanocd451662016-09-13 00:54:093257Specifies how to treat errors with the alternates for a submodule
3258as computed via `submodule.alternateLocation`. Possible values are
3259`ignore`, `info`, `die`. Default is `die`.
3260
Junio C Hamanobec5da42016-04-06 22:58:213261tag.forceSignAnnotated::
3262A boolean to specify whether annotated tags created should be GPG signed.
3263If `--annotate` is specified on the command line, it takes
3264precedence over this option.
3265
Junio C Hamano7b43d412014-07-23 23:09:443266tag.sort::
3267This variable controls the sort ordering of tags when displayed by
3268linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3269value of this variable will be used as the default.
3270
Junio C Hamano75cc4c92006-07-24 08:25:033271tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:093272This variable can be used to restrict the permission bits of
3273tar archive entries. The default is 0002, which turns off the
3274world write bit. The special value "user" indicates that the
3275archiving user's umask will be used instead. See umask(2) and
Junio C Hamano35738e82008-01-07 07:55:463276linkgit:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:033277
Junio C Hamano8fb66e52011-10-05 20:59:513278transfer.fsckObjects::
3279When `fetch.fsckObjects` or `receive.fsckObjects` are
3280not set, the value of this variable is used instead.
3281Defaults to false.
3282
Junio C Hamano322c6242015-03-23 21:32:463283transfer.hideRefs::
Junio C Hamanob6aa12e2015-08-19 22:40:173284String(s) `receive-pack` and `upload-pack` use to decide which
3285refs to omit from their initial advertisements. Use more than
3286one definition to specify multiple prefix strings. A ref that is
3287under the hierarchies listed in the value of this variable is
3288excluded, and is hidden when responding to `git push` or `git
3289fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
3290program-specific versions of this config.
3291+
3292You may also include a `!` in front of the ref name to negate the entry,
3293explicitly exposing it, even if an earlier entry marked it as hidden.
3294If you have multiple hideRefs values, later entries override earlier ones
3295(and entries in more-specific config files override less-specific ones).
Junio C Hamano713eded2015-12-03 00:24:023296+
3297If a namespace is in use, the namespace prefix is stripped from each
3298reference before it is matched against `transfer.hiderefs` patterns.
3299For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3300the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3301is omitted from the advertisements but `refs/heads/master` and
3302`refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3303"have" lines. In order to match refs before stripping, add a `^` in front of
3304the ref name. If you combine `!` and `^`, `!` must be specified first.
Junio C Hamano56ace3d2017-01-10 23:43:413305+
3306Even if you hide refs, a client may still be able to steal the target
3307objects via the techniques described in the "SECURITY" section of the
3308linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3309separate repository.
Junio C Hamano80ad00d2013-02-18 00:19:033310
Junio C Hamano4653c6f2008-11-26 22:50:203311transfer.unpackLimit::
3312When `fetch.unpackLimit` or `receive.unpackLimit` are
3313not set, the value of this variable is used instead.
3314The default value is 100.
3315
Junio C Hamano81703b22014-03-14 22:00:273316uploadarchive.allowUnreachable::
3317If true, allow clients to use `git archive --remote` to request
3318any tree, whether reachable from the ref tips or not. See the
Junio C Hamano56ace3d2017-01-10 23:43:413319discussion in the "SECURITY" section of
Junio C Hamano81703b22014-03-14 22:00:273320linkgit:git-upload-archive[1] for more details. Defaults to
3321`false`.
3322
Junio C Hamano322c6242015-03-23 21:32:463323uploadpack.hideRefs::
Junio C Hamanob6aa12e2015-08-19 22:40:173324This variable is the same as `transfer.hideRefs`, but applies
3325only to `upload-pack` (and so affects only fetches, not pushes).
3326An attempt to fetch a hidden ref by `git fetch` will fail. See
3327also `uploadpack.allowTipSHA1InWant`.
Junio C Hamano5e7f1312013-03-21 22:49:013328
Junio C Hamano85f1fde2015-06-01 20:37:323329uploadpack.allowTipSHA1InWant::
Junio C Hamano322c6242015-03-23 21:32:463330When `uploadpack.hideRefs` is in effect, allow `upload-pack`
Junio C Hamano5e7f1312013-03-21 22:49:013331to accept a fetch request that asks for an object at the tip
3332of a hidden ref (by default, such a request is rejected).
Junio C Hamano56ace3d2017-01-10 23:43:413333See also `uploadpack.hideRefs`. Even if this is false, a client
3334may be able to steal objects via the techniques described in the
3335"SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3336best to keep private data in a separate repository.
Junio C Hamano80ad00d2013-02-18 00:19:033337
Junio C Hamano85f1fde2015-06-01 20:37:323338uploadpack.allowReachableSHA1InWant::
3339Allow `upload-pack` to accept a fetch request that asks for an
3340object that is reachable from any ref tip. However, note that
3341calculating object reachability is computationally expensive.
Junio C Hamano56ace3d2017-01-10 23:43:413342Defaults to `false`. Even if this is false, a client may be able
3343to steal objects via the techniques described in the "SECURITY"
3344section of the linkgit:gitnamespaces[7] man page; it's best to
3345keep private data in a separate repository.
3346
3347uploadpack.allowAnySHA1InWant::
3348Allow `upload-pack` to accept a fetch request that asks for any
3349object at all.
Junio C Hamano85f1fde2015-06-01 20:37:323350Defaults to `false`.
3351
Junio C Hamano322c6242015-03-23 21:32:463352uploadpack.keepAlive::
Junio C Hamano79f4c7c2013-09-20 21:03:373353When `upload-pack` has started `pack-objects`, there may be a
3354quiet period while `pack-objects` prepares the pack. Normally
3355it would output progress information, but if `--quiet` was used
3356for the fetch, `pack-objects` will output nothing at all until
3357the pack data begins. Some clients and networks may consider
3358the server to be hung and give up. Setting this option instructs
3359`upload-pack` to send an empty keepalive packet every
Junio C Hamano322c6242015-03-23 21:32:463360`uploadpack.keepAlive` seconds. Setting this option to 0
Junio C Hamano79f4c7c2013-09-20 21:03:373361disables keepalive packets entirely. The default is 5 seconds.
3362
Junio C Hamanoc6c919b2016-07-06 21:34:153363uploadpack.packObjectsHook::
3364If this option is set, when `upload-pack` would run
3365`git pack-objects` to create a packfile for a client, it will
3366run this shell command instead. The `pack-objects` command and
3367arguments it _would_ have run (including the `git pack-objects`
3368at the beginning) are appended to the shell command. The stdin
3369and stdout of the hook are treated as if `pack-objects` itself
3370was run. I.e., `upload-pack` will feed input intended for
3371`pack-objects` to the hook, and expects a completed packfile on
3372stdout.
3373+
3374Note that this configuration variable is ignored if it is seen in the
3375repository-level config (this is a safety measure against fetching from
3376untrusted repositories).
3377
Junio C Hamano24bc09a2008-02-28 00:27:443378url.<base>.insteadOf::
3379Any URL that starts with this value will be rewritten to
3380start, instead, with <base>. In cases where some site serves a
3381large number of repositories, and serves them with multiple
3382access methods, and some users need to use different access
3383methods, this feature allows people to specify any of the
Junio C Hamano076ffcc2013-02-06 05:13:213384equivalent URLs and have Git automatically rewrite the URL to
Junio C Hamano24bc09a2008-02-28 00:27:443385the best alternative for the particular user, even for a
3386never-before-seen repository on the site. When more than one
3387insteadOf strings match a given URL, the longest match is used.
Junio C Hamanoe0e20df2017-06-04 02:10:213388+
3389Note that any protocol restrictions will be applied to the rewritten
3390URL. If the rewrite changes the URL to use a custom protocol or remote
3391helper, you may need to adjust the `protocol.*.allow` config to permit
3392the request. In particular, protocols you expect to use for submodules
3393must be set to `always` rather than the default of `user`. See the
3394description of `protocol.allow` above.
Junio C Hamano24bc09a2008-02-28 00:27:443395
Junio C Hamano7df6dcf2009-09-13 09:51:173396url.<base>.pushInsteadOf::
3397Any URL that starts with this value will not be pushed to;
3398instead, it will be rewritten to start with <base>, and the
3399resulting URL will be pushed to. In cases where some site serves
3400a large number of repositories, and serves them with multiple
3401access methods, some of which do not allow push, this feature
Junio C Hamano076ffcc2013-02-06 05:13:213402allows people to specify a pull-only URL and have Git
Junio C Hamano7df6dcf2009-09-13 09:51:173403automatically use an appropriate URL to push, even for a
3404never-before-seen repository on the site. When more than one
3405pushInsteadOf strings match a given URL, the longest match is
Junio C Hamano076ffcc2013-02-06 05:13:213406used. If a remote has an explicit pushurl, Git will ignore this
Junio C Hamano7df6dcf2009-09-13 09:51:173407setting for that remote.
3408
Junio C Hamano07824ce2006-04-25 07:36:543409user.email::
3410Your email address to be recorded in any newly created commits.
Junio C Hamano042f2142016-06-27 18:05:053411Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3412`EMAIL` environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:543413
3414user.name::
3415Your full name to be recorded in any newly created commits.
Junio C Hamano042f2142016-06-27 18:05:053416Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
Junio C Hamano35738e82008-01-07 07:55:463417environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:543418
Junio C Hamanof85ef632016-02-17 22:31:063419user.useConfigOnly::
Junio C Hamano042f2142016-06-27 18:05:053420Instruct Git to avoid trying to guess defaults for `user.email`
3421and `user.name`, and instead retrieve the values only from the
Junio C Hamanof85ef632016-02-17 22:31:063422configuration. For example, if you have multiple email addresses
3423and would like to use a different one for each repository, then
3424with this configuration option set to `true` in the global config
3425along with a name, Git will prompt you to set up an email before
3426making new commits in a newly cloned repository.
3427Defaults to `false`.
3428
Junio C Hamano322c6242015-03-23 21:32:463429user.signingKey::
Junio C Hamano369e3402013-10-15 18:40:253430If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3431key you want it to automatically when creating a signed tag or
3432commit, you can override the default selection with this variable.
3433This option is passed unchanged to gpg's --local-user parameter,
3434so you may specify a key using any method that gpg supports.
Junio C Hamanoa890c4f2007-01-28 10:29:213435
Junio C Hamanobcd98f42017-01-24 00:12:163436versionsort.prereleaseSuffix (deprecated)::
3437Deprecated alias for `versionsort.suffix`. Ignored if
3438`versionsort.suffix` is set.
3439
3440versionsort.suffix::
3441Even when version sort is used in linkgit:git-tag[1], tagnames
3442with the same base version but different suffixes are still sorted
3443lexicographically, resulting e.g. in prerelease tags appearing
3444after the main release (e.g. "1.0-rc1" after "1.0"). This
3445variable can be specified to determine the sorting order of tags
3446with different suffixes.
Junio C Hamano07622622015-03-20 21:47:263447+
Junio C Hamanobcd98f42017-01-24 00:12:163448By specifying a single suffix in this variable, any tagname containing
3449that suffix will appear before the corresponding main release. E.g. if
3450the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3451"1.0". If specified multiple times, once per suffix, then the order of
3452suffixes in the configuration will determine the sorting order of tagnames
3453with those suffixes. E.g. if "-pre" appears before "-rc" in the
3454configuration, then all "1.0-preX" tags will be listed before any
3455"1.0-rcX" tags. The placement of the main release tag relative to tags
3456with various suffixes can be determined by specifying the empty suffix
3457among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3458"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3459are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3460"v4.8-bfsX".
3461+
3462If more than one suffixes match the same tagname, then that tagname will
3463be sorted according to the suffix which starts at the earliest position in
3464the tagname. If more than one different matching suffixes start at
3465that earliest position, then that tagname will be sorted according to the
3466longest of those suffixes.
3467The sorting order between different suffixes is undefined if they are
3468in multiple config files.
Junio C Hamano07622622015-03-20 21:47:263469
Junio C Hamano4e272312008-01-08 09:13:213470web.browser::
3471Specify a web browser that may be used by some commands.
3472Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3473may use it.
Junio C Hamano047135e2017-12-19 21:57:543474
3475worktree.guessRemote::
3476With `add`, if no branch argument, and neither of `-b` nor
3477`-B` nor `--detach` are given, the command defaults to
3478creating a new branch from HEAD. If `worktree.guessRemote` is
3479set to true, `worktree add` tries to find a remote-tracking
3480branch whose name uniquely matches the new branch name. If
3481such a branch exists, it is checked out and set as "upstream"
3482for the new branch. If no such match can be found, it falls
3483back to creating a new branch from the current HEAD.