blob: e0b9fd0bc38a08077896240384f0bb1690532884 [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 Hamanocb06ef92017-03-21 22:40:1482You can include a config file from another by setting the special
Junio C Hamanoe0238c22012-02-23 22:45:5083`include.path` variable to the name of the file to be included. The
Junio C Hamano198b1f12016-05-17 22:27:2484variable takes a pathname as its value, and is subject to tilde
Junio C Hamanocb06ef92017-03-21 22:40:1485expansion. `include.path` can be given multiple times.
Junio C Hamano198b1f12016-05-17 22:27:2486
Junio C Hamanocb06ef92017-03-21 22:40:1487The included file is expanded immediately, as if its contents had been
Junio C Hamanoe0238c22012-02-23 22:45:5088found at the location of the include directive. If the value of the
Junio C Hamanocb06ef92017-03-21 22:40:1489`include.path` variable is a relative path, the path is considered to
90be relative to the configuration file in which the include directive
91was found. See below for examples.
Junio C Hamano198b1f12016-05-17 22:27:2492
Junio C Hamanocb06ef92017-03-21 22:40:1493Conditional includes
94~~~~~~~~~~~~~~~~~~~~
95
96You can include a config file from another conditionally by setting a
97`includeIf.<condition>.path` variable to the name of the file to be
98included. The variable's value is treated the same way as
99`include.path`. `includeIf.<condition>.path` can be given multiple times.
100
101The condition starts with a keyword followed by a colon and some data
102whose format and meaning depends on the keyword. Supported keywords
103are:
104
105`gitdir`::
106
107The data that follows the keyword `gitdir:` is used as a glob
108pattern. If the location of the .git directory matches the
109pattern, the include condition is met.
110+
111The .git location may be auto-discovered, or come from `$GIT_DIR`
112environment variable. If the repository is auto discovered via a .git
113file (e.g. from submodules, or a linked worktree), the .git location
114would be the final location where the .git directory is, not where the
115.git file is.
116+
117The pattern can contain standard globbing wildcards and two additional
118ones, `**/` and `/**`, that can match multiple path components. Please
119refer to linkgit:gitignore[5] for details. For convenience:
120
121 * If the pattern starts with `~/`, `~` will be substituted with the
122 content of the environment variable `HOME`.
123
124 * If the pattern starts with `./`, it is replaced with the directory
125 containing the current config file.
126
127 * If the pattern does not start with either `~/`, `./` or `/`, `**/`
128 will be automatically prepended. For example, the pattern `foo/bar`
129 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`.
130
131 * If the pattern ends with `/`, `**` will be automatically added. For
132 example, the pattern `foo/` becomes `foo/**`. In other words, it
133 matches "foo" and everything inside, recursively.
134
135`gitdir/i`::
136This is the same as `gitdir` except that matching is done
137case-insensitively (e.g. on case-insensitive file sytems)
138
139A few more notes on matching via `gitdir` and `gitdir/i`:
140
141 * Symlinks in `$GIT_DIR` are not resolved before matching.
142
143 * Note that "../" is not special and will match literally, which is
144 unlikely what you want.
Junio C Hamanoe0238c22012-02-23 22:45:50145
Junio C Hamano07824ce2006-04-25 07:36:54146Example
147~~~~~~~
148
149# Core variables
150[core]
151; Don't trust file modes
152filemode = false
153
154# Our diff algorithm
155[diff]
Junio C Hamano85c71572008-07-28 00:03:31156external = /usr/local/bin/diff-wrapper
Junio C Hamano07824ce2006-04-25 07:36:54157renames = true
158
Junio C Hamano52401ef2006-12-19 00:54:38159[branch "devel"]
160remote = origin
161merge = refs/heads/devel
162
Junio C Hamanobee172f2007-01-23 08:44:18163# Proxy settings
164[core]
Junio C Hamanoc71a8732007-08-04 00:27:26165gitProxy="ssh" for "kernel.org"
Junio C Hamanobee172f2007-01-23 08:44:18166gitProxy=default-proxy ; for the rest
Junio C Hamano52401ef2006-12-19 00:54:38167
Junio C Hamanoe0238c22012-02-23 22:45:50168[include]
169path = /path/to/foo.inc ; include by absolute path
170path = foo ; expand "foo" relative to the current file
Junio C Hamano198b1f12016-05-17 22:27:24171path = ~/foo ; expand "foo" in your `$HOME` directory
Junio C Hamanoe0238c22012-02-23 22:45:50172
Junio C Hamanocb06ef92017-03-21 22:40:14173; include if $GIT_DIR is /path/to/foo/.git
174[includeIf "gitdir:/path/to/foo/.git"]
175path = /path/to/foo.inc
176
177; include for all repositories inside /path/to/group
178[includeIf "gitdir:/path/to/group/"]
179path = /path/to/foo.inc
180
181; include for all repositories inside $HOME/to/group
182[includeIf "gitdir:~/to/group/"]
183path = /path/to/foo.inc
Junio C Hamano07622622015-03-20 21:47:26184
185Values
186~~~~~~
187
188Values of many variables are treated as a simple string, but there
189are variables that take values of specific types and there are rules
190as to how to spell them.
191
192boolean::
193
194 When a variable is said to take a boolean value, many
195 synonyms are accepted for 'true' and 'false'; these are all
196 case-insensitive.
197
198 true;; Boolean true can be spelled as `yes`, `on`, `true`,
199or `1`. Also, a variable defined without `= <value>`
200is taken as true.
201
202 false;; Boolean false can be spelled as `no`, `off`,
203`false`, or `0`.
204+
Junio C Hamano92d80372016-07-13 22:00:05205When converting value to the canonical form using `--bool` type
Junio C Hamano07622622015-03-20 21:47:26206specifier; 'git config' will ensure that the output is "true" or
207"false" (spelled in lowercase).
208
209integer::
210 The value for many variables that specify various sizes can
211 be suffixed with `k`, `M`,... to mean "scale the number by
212 1024", "by 1024x1024", etc.
213
214color::
Junio C Hamano48931e22016-07-11 20:08:47215 The value for a variable that takes a color is a list of
216 colors (at most two, one for foreground and one for background)
217 and attributes (as many as you want), separated by spaces.
Junio C Hamano07622622015-03-20 21:47:26218+
Junio C Hamano48931e22016-07-11 20:08:47219The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
220`blue`, `magenta`, `cyan` and `white`. The first color given is the
221foreground; the second is the background.
Junio C Hamano07622622015-03-20 21:47:26222+
Junio C Hamano48931e22016-07-11 20:08:47223Colors may also be given as numbers between 0 and 255; these use ANSI
224256-color mode (but note that not all terminals may support this). If
225your terminal supports it, you may also specify 24-bit RGB values as
226hex, like `#ff0ab3`.
227+
228The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
229`italic`, and `strike` (for crossed-out or "strikethrough" letters).
230The position of any attributes with respect to the colors
231(before, after, or in between), doesn't matter. Specific attributes may
232be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
233`no-ul`, etc).
234+
Junio C Hamanob86c8032017-02-02 21:50:19235An empty color string produces no color effect at all. This can be used
236to avoid coloring specific elements without disabling color entirely.
237+
Junio C Hamano48931e22016-07-11 20:08:47238For git's pre-defined color slots, the attributes are meant to be reset
239at the beginning of each item in the colored output. So setting
240`color.decorate.branch` to `black` will paint that branch name in a
241plain `black`, even if the previous thing on the same output line (e.g.
242opening parenthesis before the list of branch names in `log --decorate`
243output) is set to be painted with `bold` or some other attribute.
244However, custom log formats may do more complicated and layered
245coloring, and the negated forms may be useful there.
Junio C Hamano07622622015-03-20 21:47:26246
Junio C Hamano198b1f12016-05-17 22:27:24247pathname::
248A variable that takes a pathname value can be given a
249string that begins with "`~/`" or "`~user/`", and the usual
250tilde expansion happens to such a string: `~/`
251is expanded to the value of `$HOME`, and `~user/` to the
252specified user's home directory.
253
Junio C Hamano07622622015-03-20 21:47:26254
Junio C Hamano07824ce2006-04-25 07:36:54255Variables
256~~~~~~~~~
257
258Note that this list is non-comprehensive and not necessarily complete.
Junio C Hamanof1d14802006-06-08 00:48:17259For command-specific variables, you will find a more detailed description
Junio C Hamano52b6ba32014-04-01 00:26:48260in the appropriate manual page.
261
262Other git-related tools may and do use their own variables. When
263inventing new variables for use in your own tool, make sure their
264names do not conflict with those that are used by Git itself and
265other popular tools, and describe them in your documentation.
266
Junio C Hamano07824ce2006-04-25 07:36:54267
Junio C Hamano7df6dcf2009-09-13 09:51:17268advice.*::
Junio C Hamano0df92712011-12-21 22:30:44269These variables control various optional help messages designed to
270aid new users. All 'advice.*' variables default to 'true', and you
271can tell Git that you do not need help by setting these to 'false':
Junio C Hamano7df6dcf2009-09-13 09:51:17272+
273--
Junio C Hamanoabad6da2013-01-06 09:06:32274pushUpdateRejected::
Junio C Hamano0c1b64e2012-04-20 23:50:49275Set this variable to 'false' if you want to disable
Junio C Hamano1d669b82014-03-11 21:36:00276'pushNonFFCurrent',
Junio C Hamano3f2ed6f2013-02-04 19:24:09277'pushNonFFMatching', 'pushAlreadyExists',
278'pushFetchFirst', and 'pushNeedsForce'
Junio C Hamanoabad6da2013-01-06 09:06:32279simultaneously.
Junio C Hamano0c1b64e2012-04-20 23:50:49280pushNonFFCurrent::
281Advice shown when linkgit:git-push[1] fails due to a
282non-fast-forward update to the current branch.
Junio C Hamano0c1b64e2012-04-20 23:50:49283pushNonFFMatching::
284Advice shown when you ran linkgit:git-push[1] and pushed
285'matching refs' explicitly (i.e. you used ':', or
286specified a refspec that isn't your current branch) and
287it resulted in a non-fast-forward error.
Junio C Hamanoabad6da2013-01-06 09:06:32288pushAlreadyExists::
289Shown when linkgit:git-push[1] rejects an update that
290does not qualify for fast-forwarding (e.g., a tag.)
Junio C Hamano3f2ed6f2013-02-04 19:24:09291pushFetchFirst::
292Shown when linkgit:git-push[1] rejects an update that
293tries to overwrite a remote ref that points at an
294object we do not have.
295pushNeedsForce::
296Shown when linkgit:git-push[1] rejects an update that
297tries to overwrite a remote ref that points at an
Junio C Hamanoe6f28d02013-09-17 21:34:00298object that is not a commit-ish, or make the remote
299ref point at an object that is not a commit-ish.
Junio C Hamano7df6dcf2009-09-13 09:51:17300statusHints::
Junio C Hamano644936c2012-06-28 23:05:14301Show directions on how to proceed from the current
Junio C Hamano917cd4f2012-12-04 23:41:10302state in the output of linkgit:git-status[1], in
Junio C Hamano644936c2012-06-28 23:05:14303the template shown when writing commit messages in
Junio C Hamano917cd4f2012-12-04 23:41:10304linkgit:git-commit[1], and in the help message shown
305by linkgit:git-checkout[1] when switching branch.
Junio C Hamano5e7f1312013-03-21 22:49:01306statusUoption::
307Advise to consider using the `-u` option to linkgit:git-status[1]
308when the command takes more than 2 seconds to enumerate untracked
309files.
Junio C Hamano5706e0b2009-11-24 10:54:16310commitBeforeMerge::
311Advice shown when linkgit:git-merge[1] refuses to
Junio C Hamano619596a2010-08-18 22:15:35312merge to avoid overwriting local changes.
Junio C Hamanoa9701f02010-01-21 00:42:16313resolveConflict::
Junio C Hamano5dab5a92013-02-25 18:51:24314Advice shown by various commands when conflicts
Junio C Hamanoa9701f02010-01-21 00:42:16315prevent the operation from being performed.
Junio C Hamanoa9701f02010-01-21 00:42:16316implicitIdentity::
317Advice on how to set your identity configuration when
318your information is guessed from the system username and
Junio C Hamano0df92712011-12-21 22:30:44319domain name.
Junio C Hamano74a198f2010-02-22 00:13:31320detachedHead::
Junio C Hamano0df92712011-12-21 22:30:44321Advice shown when you used linkgit:git-checkout[1] to
Junio C Hamano74a198f2010-02-22 00:13:31322move to the detach HEAD state, to instruct how to create
Junio C Hamano0df92712011-12-21 22:30:44323a local branch after the fact.
Junio C Hamanobb300642012-07-22 21:09:14324amWorkDir::
325Advice that shows the location of the patch file when
326linkgit:git-am[1] fails to apply it.
Junio C Hamano8ab94942013-06-24 21:55:30327rmHints::
328In case of failure in the output of linkgit:git-rm[1],
329show directions on how to proceed from the current state.
Junio C Hamano7df6dcf2009-09-13 09:51:17330--
331
Junio C Hamano07824ce2006-04-25 07:36:54332core.fileMode::
Junio C Hamanod2c28482014-10-24 22:28:25333Tells Git if the executable bit of files in the working tree
334is to be honored.
Junio C Hamano9df0c662009-11-23 11:09:27335+
Junio C Hamanod2c28482014-10-24 22:28:25336Some filesystems lose the executable bit when a file that is
337marked as executable is checked out, or checks out an
338non-executable file with executable bit on.
339linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
340to see if it handles the executable bit correctly
341and this variable is automatically set as necessary.
342+
343A repository, however, may be on a filesystem that handles
344the filemode correctly, and this variable is set to 'true'
345when created, but later may be made accessible from another
346environment that loses the filemode (e.g. exporting ext4 via
347CIFS mount, visiting a Cygwin created repository with
348Git for Windows or Eclipse).
349In such a case it may be necessary to set this variable to 'false'.
350See linkgit:git-update-index[1].
351+
352The default is true (when core.filemode is not specified in the config file).
Junio C Hamano07824ce2006-04-25 07:36:54353
Junio C Hamano198b1f12016-05-17 22:27:24354core.hideDotFiles::
355(Windows-only) If true, mark newly-created directories and files whose
356name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
357directory is hidden, but no other files starting with a dot. The
358default mode is 'dotGitOnly'.
359
Junio C Hamano322c6242015-03-23 21:32:46360core.ignoreCase::
Junio C Hamano9df0c662009-11-23 11:09:27361If true, this option enables various workarounds to enable
Junio C Hamano076ffcc2013-02-06 05:13:21362Git to work better on filesystems that are not case sensitive,
Junio C Hamano9df0c662009-11-23 11:09:27363like FAT. For example, if a directory listing finds
Junio C Hamano076ffcc2013-02-06 05:13:21364"makefile" when Git expects "Makefile", Git will assume
Junio C Hamano9df0c662009-11-23 11:09:27365it is really the same file, and continue to remember it as
366"Makefile".
367+
368The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
Junio C Hamano322c6242015-03-23 21:32:46369will probe and set core.ignoreCase true if appropriate when the repository
Junio C Hamano9df0c662009-11-23 11:09:27370is created.
371
Junio C Hamano322c6242015-03-23 21:32:46372core.precomposeUnicode::
Junio C Hamano076ffcc2013-02-06 05:13:21373This option is only used by Mac OS implementation of Git.
Junio C Hamano322c6242015-03-23 21:32:46374When core.precomposeUnicode=true, Git reverts the unicode decomposition
Junio C Hamanob61a7772012-07-13 23:34:48375of filenames done by Mac OS. This is useful when sharing a repository
376between Mac OS and Linux or Windows.
Junio C Hamano076ffcc2013-02-06 05:13:21377(Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
378When false, file names are handled fully transparent by Git,
379which is backward compatible with older versions of Git.
Junio C Hamanob61a7772012-07-13 23:34:48380
Junio C Hamano30758bd2014-12-18 20:44:14381core.protectHFS::
382If set to true, do not allow checkout of paths that would
383be considered equivalent to `.git` on an HFS+ filesystem.
384Defaults to `true` on Mac OS, and `false` elsewhere.
385
386core.protectNTFS::
387If set to true, do not allow checkout of paths that would
388cause problems with the NTFS filesystem, e.g. conflict with
3898.3 "short" names.
390Defaults to `true` on Windows, and `false` elsewhere.
391
Junio C Hamano90ccff32008-07-29 08:17:24392core.trustctime::
393If false, the ctime differences between the index and the
Junio C Hamano8fb66e52011-10-05 20:59:51394working tree are ignored; useful when the inode change time
Junio C Hamano90ccff32008-07-29 08:17:24395is regularly modified by something outside Git (file system
396crawlers and some backup systems).
397See linkgit:git-update-index[1]. True by default.
398
Junio C Hamano3d4a66d2017-03-17 21:07:26399core.splitIndex::
400If true, the split-index feature of the index will be used.
401See linkgit:git-update-index[1]. False by default.
402
Junio C Hamano9099a7c2016-02-10 23:42:05403core.untrackedCache::
404Determines what to do about the untracked cache feature of the
405index. It will be kept, if this variable is unset or set to
406`keep`. It will automatically be added if set to `true`. And
407it will automatically be removed, if set to `false`. Before
408setting it to `true`, you should check that mtime is working
409properly on your system.
410See linkgit:git-update-index[1]. `keep` by default.
411
Junio C Hamano322c6242015-03-23 21:32:46412core.checkStat::
Junio C Hamano4cfed0c2013-01-30 17:58:54413Determines which stat fields to match between the index
414and work tree. The user can set this to 'default' or
415'minimal'. Default (or explicitly 'default'), is to check
416all fields, including the sub-second part of mtime and ctime.
417
Junio C Hamano322c6242015-03-23 21:32:46418core.quotePath::
Junio C Hamano0f6f3bf2017-03-13 07:01:53419Commands that output paths (e.g. 'ls-files', 'diff'), will
420quote "unusual" characters in the pathname by enclosing the
421pathname in double-quotes and escaping those characters with
422backslashes in the same way C escapes control characters (e.g.
423`\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
424values larger than 0x80 (e.g. octal `\302\265` for "micro" in
425UTF-8). If this variable is set to false, bytes higher than
4260x80 are not considered "unusual" any more. Double-quotes,
427backslash and control characters are always escaped regardless
428of the setting of this variable. A simple space character is
429not considered "unusual". Many commands can output pathnames
430completely verbatim using the `-z` option. The default value
431is true.
Junio C Hamanod526ba92007-07-02 00:17:42432
Junio C Hamanobb88cf42010-06-21 15:23:55433core.eol::
434Sets the line ending type to use in the working directory for
Junio C Hamanof2a3a752016-05-23 22:54:39435files that have the `text` property set when core.autocrlf is false.
436Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
437native line ending. The default value is `native`. See
Junio C Hamanobb88cf42010-06-21 15:23:55438linkgit:gitattributes[5] for more information on end-of-line
439conversion.
Junio C Hamanod9e0e5d2007-04-14 16:22:04440
Junio C Hamano26e590a2008-02-17 03:53:51441core.safecrlf::
Junio C Hamano076ffcc2013-02-06 05:13:21442If true, makes Git check if converting `CRLF` is reversible when
Junio C Hamanobb88cf42010-06-21 15:23:55443end-of-line conversion is active. Git will verify if a command
Junio C Hamano26e590a2008-02-17 03:53:51444modifies a file in the work tree either directly or indirectly.
445For example, committing a file followed by checking out the
446same file should yield the original file in the work tree. If
447this is not the case for the current setting of
Junio C Hamano076ffcc2013-02-06 05:13:21448`core.autocrlf`, Git will reject the file. The variable can
449be set to "warn", in which case Git will only warn about an
Junio C Hamano26e590a2008-02-17 03:53:51450irreversible conversion but continue the operation.
451+
452CRLF conversion bears a slight chance of corrupting data.
Junio C Hamano076ffcc2013-02-06 05:13:21453When it is enabled, Git will convert CRLF to LF during commit and LF to
Junio C Hamano26e590a2008-02-17 03:53:51454CRLF during checkout. A file that contains a mixture of LF and
Junio C Hamano076ffcc2013-02-06 05:13:21455CRLF before the commit cannot be recreated by Git. For text
Junio C Hamano26e590a2008-02-17 03:53:51456files this is the right thing to do: it corrects line endings
457such that we have only LF line endings in the repository.
458But for binary files that are accidentally classified as text the
459conversion can corrupt data.
460+
461If you recognize such corruption early you can easily fix it by
462setting the conversion type explicitly in .gitattributes. Right
463after committing you still have the original file in your work
464tree and this file is not yet corrupted. You can explicitly tell
Junio C Hamano076ffcc2013-02-06 05:13:21465Git that this file is binary and Git will handle the file
Junio C Hamano26e590a2008-02-17 03:53:51466appropriately.
467+
468Unfortunately, the desired effect of cleaning up text files with
469mixed line endings and the undesired effect of corrupting binary
470files cannot be distinguished. In both cases CRLFs are removed
471in an irreversible way. For text files this is the right thing
472to do because CRLFs are line endings, while for binary files
473converting CRLFs corrupts data.
474+
475Note, this safety check does not mean that a checkout will generate a
476file identical to the original file for a different setting of
Junio C Hamanobb88cf42010-06-21 15:23:55477`core.eol` and `core.autocrlf`, but only for the current one. For
478example, a text file with `LF` would be accepted with `core.eol=lf`
479and could later be checked out with `core.eol=crlf`, in which case the
Junio C Hamano26e590a2008-02-17 03:53:51480resulting file would contain `CRLF`, although the original file
481contained `LF`. However, in both work trees the line endings would be
482consistent, that is either all `LF` or all `CRLF`, but never mixed. A
483file with mixed line endings would be reported by the `core.safecrlf`
484mechanism.
485
Junio C Hamanobb88cf42010-06-21 15:23:55486core.autocrlf::
Junio C Hamanoeed15af2016-07-25 22:49:42487Setting this variable to "true" is the same as setting
488the `text` attribute to "auto" on all files and core.eol to "crlf".
489Set to true if you want to have `CRLF` line endings in your
490working directory and the repository has LF line endings.
491This variable can be set to 'input',
Junio C Hamanobb88cf42010-06-21 15:23:55492in which case no output conversion is performed.
493
Junio C Hamanoaa83a7d2007-03-05 02:37:29494core.symlinks::
495If false, symbolic links are checked out as small plain files that
Junio C Hamano35738e82008-01-07 07:55:46496contain the link text. linkgit:git-update-index[1] and
497linkgit:git-add[1] will not change the recorded type to regular
Junio C Hamanoaa83a7d2007-03-05 02:37:29498file. Useful on filesystems like FAT that do not support
Junio C Hamano9df0c662009-11-23 11:09:27499symbolic links.
500+
501The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
502will probe and set core.symlinks false if appropriate when the repository
503is created.
Junio C Hamanoaa83a7d2007-03-05 02:37:29504
Junio C Hamano07824ce2006-04-25 07:36:54505core.gitProxy::
506A "proxy command" to execute (as 'command host port') instead
507of establishing direct connection to the remote server when
Junio C Hamano076ffcc2013-02-06 05:13:21508using the Git protocol for fetching. If the variable value is
Junio C Hamano07824ce2006-04-25 07:36:54509in the "COMMAND for DOMAIN" format, the command is applied only
510on hostnames ending with the specified domain string. This variable
511may be set multiple times and is matched in the given order;
512the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17513+
Junio C Hamano042f2142016-06-27 18:05:05514Can be overridden by the `GIT_PROXY_COMMAND` environment variable
Junio C Hamanof1d14802006-06-08 00:48:17515(which always applies universally, without the special "for"
516handling).
Junio C Hamanoea82cff2009-03-18 01:54:48517+
518The special string `none` can be used as the proxy command to
519specify that no proxy be used for a given domain pattern.
520This is useful for excluding servers inside a firewall from
521proxy use, while defaulting to a common proxy for external domains.
Junio C Hamano07824ce2006-04-25 07:36:54522
Junio C Hamano1a1b8472016-07-19 21:37:13523core.sshCommand::
524If this variable is set, `git fetch` and `git push` will
525use the specified command instead of `ssh` when they need to
526connect to a remote system. The command is in the same form as
527the `GIT_SSH_COMMAND` environment variable and is overridden
528when the environment variable is set.
529
Junio C Hamano07824ce2006-04-25 07:36:54530core.ignoreStat::
Junio C Hamanoe8acc8e2015-01-14 22:01:34531If true, Git will avoid using lstat() calls to detect if files have
532changed by setting the "assume-unchanged" bit for those tracked files
533which it has updated identically in both the index and working tree.
534+
535When files are modified outside of Git, the user will need to stage
536the modified files explicitly (e.g. see 'Examples' section in
537linkgit:git-update-index[1]).
538Git will not normally detect changes to those files.
539+
540This is useful on systems where lstat() calls are very slow, such as
541CIFS/Microsoft Windows.
542+
543False by default.
Junio C Hamano07824ce2006-04-25 07:36:54544
Junio C Hamano88a3a072006-05-04 08:01:43545core.preferSymlinkRefs::
546Instead of the default "symref" format for HEAD
547and other symbolic reference files, use symbolic links.
548This is sometimes needed to work with old scripts that
549expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54550
Junio C Hamano1025e752007-02-23 07:21:26551core.bare::
552If true this repository is assumed to be 'bare' and has no
553working directory associated with it. If this is the case a
554number of commands that require a working directory will be
Junio C Hamano35738e82008-01-07 07:55:46555disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Junio C Hamano1025e752007-02-23 07:21:26556+
Junio C Hamano35738e82008-01-07 07:55:46557This setting is automatically guessed by linkgit:git-clone[1] or
558linkgit:git-init[1] when the repository was created. By default a
Junio C Hamano1025e752007-02-23 07:21:26559repository that ends in "/.git" is assumed to be not bare (bare =
560false), while all other repositories are assumed to be bare (bare
561= true).
562
Junio C Hamanod526ba92007-07-02 00:17:42563core.worktree::
Junio C Hamano80d58462011-01-24 22:52:52564Set the path to the root of the working tree.
Junio C Hamano042f2142016-06-27 18:05:05565If `GIT_COMMON_DIR` environment variable is set, core.worktree
Junio C Hamano4cc4a842015-05-11 22:41:02566is ignored and not used for determining the root of working tree.
Junio C Hamano042f2142016-06-27 18:05:05567This can be overridden by the `GIT_WORK_TREE` environment
Junio C Hamano92d80372016-07-13 22:00:05568variable and the `--work-tree` command-line option.
Junio C Hamano5cd15182011-04-05 00:21:10569The value can be an absolute path or relative to the path to
Junio C Hamano80d58462011-01-24 22:52:52570the .git directory, which is either specified by --git-dir
571or GIT_DIR, or automatically discovered.
572If --git-dir or GIT_DIR is specified but none of
Junio C Hamano7d575a52008-04-30 08:45:27573--work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamano80d58462011-01-24 22:52:52574the current working directory is regarded as the top level
Junio C Hamano3609b332010-12-29 01:34:52575of your working tree.
Junio C Hamano80d58462011-01-24 22:52:52576+
577Note that this variable is honored even when set in a configuration
578file in a ".git" subdirectory of a directory and its value differs
579from the latter directory (e.g. "/path/to/.git/config" has
580core.worktree set to "/different/path"), which is most likely a
Junio C Hamano076ffcc2013-02-06 05:13:21581misconfiguration. Running Git commands in the "/path/to" directory will
Junio C Hamano80d58462011-01-24 22:52:52582still use "/different/path" as the root of the work tree and can cause
583confusion unless you know what you are doing (e.g. you are creating a
584read-only snapshot of the same index to a location different from the
585repository's usual working tree).
Junio C Hamanod526ba92007-07-02 00:17:42586
Junio C Hamano341071d2006-06-04 07:24:48587core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49588Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamano198b1f12016-05-17 22:27:24589"`$GIT_DIR/logs/<ref>`", by appending the new and old
Junio C Hamanoe3f080d2013-04-22 02:27:13590SHA-1, the date/time and the reason of the update, but
Junio C Hamanoa2ec14f2006-11-02 00:22:48591only when the file exists. If this configuration
Junio C Hamanoa8e42612017-02-03 21:44:07592variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
Junio C Hamano15567bc2011-07-23 00:51:59593file is automatically created for branch heads (i.e. under
Junio C Hamanoa8e42612017-02-03 21:44:07594`refs/heads/`), remote refs (i.e. under `refs/remotes/`),
595note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
596If it is set to `always`, then a missing reflog is automatically
597created for any ref under `refs/`.
Junio C Hamano1caaf472006-12-31 08:29:35598+
599This information can be used to determine what commit
600was the tip of a branch "2 days ago".
601+
602This value is true by default in a repository that has
603a working directory associated with it, and false by
604default in a bare repository.
Junio C Hamano341071d2006-06-04 07:24:48605
Junio C Hamano07824ce2006-04-25 07:36:54606core.repositoryFormatVersion::
607Internal variable identifying the repository format and layout
608version.
609
610core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42611When 'group' (or 'true'), the repository is made shareable between
612several users in a group (making sure all the files and objects are
613group-writable). When 'all' (or 'world' or 'everybody'), the
614repository will be readable by all users, additionally to being
Junio C Hamano076ffcc2013-02-06 05:13:21615group-shareable. When 'umask' (or 'false'), Git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37616reported by umask(2). When '0xxx', where '0xxx' is an octal number,
617files in the repository will have this mode value. '0xxx' will override
Junio C Hamano83eded12009-04-20 08:18:00618user's umask value (whereas the other options will only override
619requested parts of the user's umask value). Examples: '0660' will make
620the repo read/write-able for the owner and group, but inaccessible to
621others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Junio C Hamano2f102bb2008-04-26 02:23:37622repository that is group-readable but not group-writable.
623See linkgit:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54624
625core.warnAmbiguousRefs::
Junio C Hamano076ffcc2013-02-06 05:13:21626If true, Git will warn you if the ref name you passed it is ambiguous
Junio C Hamano947ab822013-03-19 23:07:29627and might match multiple refs in the repository. True by default.
Junio C Hamano07824ce2006-04-25 07:36:54628
Junio C Hamano7ec15722006-07-07 02:03:59629core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09630An integer -1..9, indicating a default compression level.
631-1 is the zlib default. 0 means no compression,
632and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42633If set, this provides a default to other compression variables,
Junio C Hamano042f2142016-06-27 18:05:05634such as `core.looseCompression` and `pack.compression`.
Junio C Hamanoa126a3b2006-07-04 04:55:26635
Junio C Hamano322c6242015-03-23 21:32:46636core.looseCompression::
Junio C Hamanof2ce2972007-05-20 19:12:09637An integer -1..9, indicating the compression level for objects that
638are not in a pack file. -1 is the zlib default. 0 means no
639compression, and 1..9 are various speed/size tradeoffs, 9 being
640slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42641not set, defaults to 1 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49642
Junio C Hamanofc4d38c2007-01-08 06:53:32643core.packedGitWindowSize::
644Number of bytes of a pack file to map into memory in a
645single mapping operation. Larger window sizes may allow
646your system to process a smaller number of large pack files
647more quickly. Smaller window sizes will negatively affect
648performance due to increased calls to the operating system's
649memory manager, but may improve performance when accessing
650a large number of large pack files.
651+
652Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
653MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
654be reasonable for all users/operating systems. You probably do
655not need to adjust this value.
656+
657Common unit suffixes of 'k', 'm', or 'g' are supported.
658
659core.packedGitLimit::
660Maximum number of bytes to map simultaneously into memory
661from pack files. If Git needs to access more than this many
662bytes at once to complete an operation it will unmap existing
663regions to reclaim virtual address space within the process.
664+
665Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
666This should be reasonable for all users/operating systems, except on
667the largest projects. You probably do not need to adjust this value.
668+
669Common unit suffixes of 'k', 'm', or 'g' are supported.
670
Junio C Hamanob8c51282007-03-19 10:43:30671core.deltaBaseCacheLimit::
672Maximum number of bytes to reserve for caching base objects
Junio C Hamano619596a2010-08-18 22:15:35673that may be referenced by multiple deltified objects. By storing the
Junio C Hamanob8c51282007-03-19 10:43:30674entire decompressed base objects in a cache Git is able
675to avoid unpacking and decompressing frequently used base
676objects multiple times.
677+
Junio C Hamanoe1aeb5e2014-06-06 19:16:29678Default is 96 MiB on all platforms. This should be reasonable
Junio C Hamanob8c51282007-03-19 10:43:30679for all users/operating systems, except on the largest projects.
680You probably do not need to adjust this value.
681+
682Common unit suffixes of 'k', 'm', or 'g' are supported.
683
Junio C Hamano5c246f22010-02-03 07:34:53684core.bigFileThreshold::
685Files larger than this size are stored deflated, without
686attempting delta compression. Storing large files without
687delta compression avoids excessive memory usage, at the
Junio C Hamano8e61f1f2014-09-11 21:53:45688slight expense of increased disk usage. Additionally files
689larger than this size are always treated as binary.
Junio C Hamano5c246f22010-02-03 07:34:53690+
691Default is 512 MiB on all platforms. This should be reasonable
692for most projects as source code and other text files can still
693be delta compressed, but larger binary media files won't be.
694+
695Common unit suffixes of 'k', 'm', or 'g' are supported.
Junio C Hamano5c246f22010-02-03 07:34:53696
Junio C Hamano322c6242015-03-23 21:32:46697core.excludesFile::
Junio C Hamano198b1f12016-05-17 22:27:24698Specifies the pathname to the file that contains patterns to
699describe paths that are not meant to be tracked, in addition
700to '.gitignore' (per-directory) and '.git/info/exclude'.
701Defaults to `$XDG_CONFIG_HOME/git/ignore`.
702If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
Junio C Hamano8edb4c72012-07-09 20:33:55703is used instead. See linkgit:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37704
Junio C Hamano322c6242015-03-23 21:32:46705core.askPass::
Junio C Hamano3fd7b262010-09-08 22:44:20706Some commands (e.g. svn and http interfaces) that interactively
707ask for a password can be told to use an external program given
Junio C Hamano042f2142016-06-27 18:05:05708via the value of this variable. Can be overridden by the `GIT_ASKPASS`
Junio C Hamano3fd7b262010-09-08 22:44:20709environment variable. If not set, fall back to the value of the
Junio C Hamano042f2142016-06-27 18:05:05710`SSH_ASKPASS` environment variable or, failing that, a simple password
Junio C Hamano3fd7b262010-09-08 22:44:20711prompt. The external program shall be given a suitable prompt as
Junio C Hamanoe1aeb5e2014-06-06 19:16:29712command-line argument and write the password on its STDOUT.
Junio C Hamano3fd7b262010-09-08 22:44:20713
Junio C Hamano322c6242015-03-23 21:32:46714core.attributesFile::
Junio C Hamano3b4609d2010-09-30 00:04:34715In addition to '.gitattributes' (per-directory) and
Junio C Hamano076ffcc2013-02-06 05:13:21716'.git/info/attributes', Git looks into this file for attributes
Junio C Hamano3b4609d2010-09-30 00:04:34717(see linkgit:gitattributes[5]). Path expansions are made the same
Junio C Hamano322c6242015-03-23 21:32:46718way as for `core.excludesFile`. Its default value is
Junio C Hamano198b1f12016-05-17 22:27:24719`$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
720set or empty, `$HOME/.config/git/attributes` is used instead.
721
722core.hooksPath::
723By default Git will look for your hooks in the
724'$GIT_DIR/hooks' directory. Set this to different path,
725e.g. '/etc/git/hooks', and Git will try to find your hooks in
726that directory, e.g. '/etc/git/hooks/pre-receive' instead of
727in '$GIT_DIR/hooks/pre-receive'.
728+
729The path can be either absolute or relative. A relative path is
730taken as relative to the directory where the hooks are run (see
731the "DESCRIPTION" section of linkgit:githooks[5]).
732+
733This configuration variable is useful in cases where you'd like to
734centrally configure your Git hooks instead of configuring them on a
735per-repository basis, or as a more flexible and centralized
736alternative to having an `init.templateDir` where you've changed
737default hooks.
Junio C Hamano3b4609d2010-09-30 00:04:34738
Junio C Hamanof6002a92007-07-20 10:28:22739core.editor::
Junio C Hamano7ab74c42017-03-27 18:23:59740Commands such as `commit` and `tag` that let you edit
741messages by launching an editor use the value of this
Junio C Hamanof6002a92007-07-20 10:28:22742variable when it is set, and the environment variable
Junio C Hamano3b70d3c2009-11-21 17:37:37743`GIT_EDITOR` is not set. See linkgit:git-var[1].
Junio C Hamanof6002a92007-07-20 10:28:22744
Junio C Hamano322c6242015-03-23 21:32:46745core.commentChar::
Junio C Hamano7ab74c42017-03-27 18:23:59746Commands such as `commit` and `tag` that let you edit
Junio C Hamano3f2ed6f2013-02-04 19:24:09747messages consider a line that begins with this character
748commented, and removes them after the editor returns
749(default '#').
Junio C Hamanoe1aeb5e2014-06-06 19:16:29750+
751If set to "auto", `git-commit` would select a character that is not
752the beginning character of any line in existing commit messages.
Junio C Hamano3f2ed6f2013-02-04 19:24:09753
Junio C Hamano1dbca522015-05-22 20:48:55754core.packedRefsTimeout::
755The length of time, in milliseconds, to retry when trying to
756lock the `packed-refs` file. Value 0 means not to retry at
757all; -1 means to try indefinitely. Default is 1000 (i.e.,
758retry for 1 second).
759
Junio C Hamano6231f822011-10-24 05:18:52760sequence.editor::
Junio C Hamano778a3412013-03-28 23:24:30761Text editor used by `git rebase -i` for editing the rebase instruction file.
Junio C Hamano6231f822011-10-24 05:18:52762The value is meant to be interpreted by the shell when it is used.
763It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
764When not configured the default commit message editor is used instead.
765
Junio C Hamano28d8ede2007-07-05 05:51:38766core.pager::
Junio C Hamano0e0e0d22013-09-12 23:25:03767Text viewer for use by Git commands (e.g., 'less'). The value
768is meant to be interpreted by the shell. The order of preference
769is the `$GIT_PAGER` environment variable, then `core.pager`
770configuration, then `$PAGER`, and then the default chosen at
771compile time (usually 'less').
772+
Junio C Hamanoe1aeb5e2014-06-06 19:16:29773When the `LESS` environment variable is unset, Git sets it to `FRX`
Junio C Hamano0e0e0d22013-09-12 23:25:03774(if `LESS` environment variable is set, Git does not change it at
775all). If you want to selectively override Git's default setting
Junio C Hamanoe1aeb5e2014-06-06 19:16:29776for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
Junio C Hamano0e0e0d22013-09-12 23:25:03777be passed to the shell by Git, which will translate the final
Junio C Hamanoe1aeb5e2014-06-06 19:16:29778command to `LESS=FRX less -S`. The environment does not set the
779`S` option but the command line does, instructing less to truncate
780long lines. Similarly, setting `core.pager` to `less -+F` will
781deactivate the `F` option specified by the environment from the
782command-line, deactivating the "quit if one screen" behavior of
783`less`. One can specifically activate some flags for particular
784commands: for example, setting `pager.blame` to `less -S` enables
785line truncation only for `git blame`.
Junio C Hamanobc8d4782014-01-13 23:35:50786+
787Likewise, when the `LV` environment variable is unset, Git sets it
788to `-c`. You can override this setting by exporting `LV` with
789another value or setting `core.pager` to `lv +c`.
Junio C Hamano28d8ede2007-07-05 05:51:38790
Junio C Hamano942b35e2007-12-09 10:19:33791core.whitespace::
792A comma separated list of common whitespace problems to
Junio C Hamano1aa40d22010-01-21 17:46:43793notice. 'git diff' will use `color.diff.whitespace` to
794highlight them, and 'git apply --whitespace=error' will
Junio C Hamano3db8b412008-07-26 06:45:59795consider them as errors. You can prefix `-` to disable
796any of them (e.g. `-trailing-space`):
Junio C Hamano942b35e2007-12-09 10:19:33797+
Junio C Hamanob71a22d2009-10-17 08:23:47798* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano942b35e2007-12-09 10:19:33799 as an error (enabled by default).
800* `space-before-tab` treats a space character that appears immediately
801 before a tab character in the initial indent part of the line as an
802 error (enabled by default).
Junio C Hamano281fd392012-09-17 23:57:41803* `indent-with-non-tab` treats a line that is indented with space
804 characters instead of the equivalent tabs as an error (not enabled by
805 default).
Junio C Hamanocb39aea2010-05-09 07:24:48806* `tab-in-indent` treats a tab character in the initial indent part of
807 the line as an error (not enabled by default).
Junio C Hamanob71a22d2009-10-17 08:23:47808* `blank-at-eof` treats blank lines added at the end of file as an error
809 (enabled by default).
810* `trailing-space` is a short-hand to cover both `blank-at-eol` and
811 `blank-at-eof`.
Junio C Hamano601f3e52008-02-25 08:40:42812* `cr-at-eol` treats a carriage-return at the end of line as
813 part of the line terminator, i.e. with it, `trailing-space`
814 does not trigger if the character before such a carriage-return
815 is not a whitespace (not enabled by default).
Junio C Hamanoeef01fe2010-12-13 08:31:58816* `tabwidth=<n>` tells how many character positions a tab occupies; this
Junio C Hamano076ffcc2013-02-06 05:13:21817 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
Junio C Hamanoeef01fe2010-12-13 08:31:58818 errors. The default tab width is 8. Allowed values are 1 to 63.
Junio C Hamano942b35e2007-12-09 10:19:33819
Junio C Hamano322c6242015-03-23 21:32:46820core.fsyncObjectFiles::
Junio C Hamano9eb57532008-06-26 06:33:46821This boolean will enable 'fsync()' when writing object files.
822+
823This is a total waste of time and effort on a filesystem that orders
824data writes properly, but can be useful for filesystems that do not use
825journalling (traditional UNIX filesystems) or that only journal metadata
826and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
827
Junio C Hamano322c6242015-03-23 21:32:46828core.preloadIndex::
Junio C Hamano610d1762008-11-28 06:27:13829Enable parallel index preload for operations like 'git diff'
830+
831This can speed up operations like 'git diff' and 'git status' especially
832on filesystems like NFS that have weak caching semantics and thus
Junio C Hamanoc8c398a2014-06-16 21:14:05833relatively high IO latencies. When enabled, Git will do the
Junio C Hamano610d1762008-11-28 06:27:13834index comparison to the filesystem data in parallel, allowing
Junio C Hamanoc8c398a2014-06-16 21:14:05835overlapping IO's. Defaults to true.
Junio C Hamano610d1762008-11-28 06:27:13836
Junio C Hamanoa9499de2009-04-30 03:38:48837core.createObject::
838You can set this to 'link', in which case a hardlink followed by
839a delete of the source are used to make sure that object creation
840will not overwrite existing objects.
841+
842On some file system/operating system combinations, this is unreliable.
843Set this config setting to 'rename' there; However, This will remove the
844check that makes sure that existing object files will not get overwritten.
Junio C Hamanoe91ea772009-04-26 01:41:41845
Junio C Hamano3b70d3c2009-11-21 17:37:37846core.notesRef::
847When showing commit messages, also show notes which are stored in
Junio C Hamanoa574a092010-06-13 19:57:10848the given ref. The ref must be fully qualified. If the given
849ref does not exist, it is not an error but means that no
850notes should be printed.
Junio C Hamano3b70d3c2009-11-21 17:37:37851+
Junio C Hamanoa574a092010-06-13 19:57:10852This setting defaults to "refs/notes/commits", and it can be overridden by
Junio C Hamano042f2142016-06-27 18:05:05853the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
Junio C Hamano3b70d3c2009-11-21 17:37:37854
Junio C Hamano3c8d6702010-01-13 23:09:03855core.sparseCheckout::
856Enable "sparse checkout" feature. See section "Sparse checkout" in
857linkgit:git-read-tree[1] for more information.
858
Junio C Hamano6371b0e2011-03-23 23:36:21859core.abbrev::
Junio C Hamano56ace3d2017-01-10 23:43:41860Set the length object names are abbreviated to. If
861unspecified or set to "auto", an appropriate value is
862computed based on the approximate number of packed objects
863in your repository, which hopefully is enough for
864abbreviated object names to stay unique for some time.
Junio C Hamano6371b0e2011-03-23 23:36:21865
Junio C Hamano60186642010-12-02 14:18:26866add.ignoreErrors::
Junio C Hamanobe087982015-02-22 21:29:39867add.ignore-errors (deprecated)::
Junio C Hamano1aa40d22010-01-21 17:46:43868Tells 'git add' to continue adding files when some files cannot be
Junio C Hamano92d80372016-07-13 22:00:05869added due to indexing errors. Equivalent to the `--ignore-errors`
Junio C Hamanobe087982015-02-22 21:29:39870option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
871as it does not follow the usual naming convention for configuration
872variables.
Junio C Hamano3d141512009-06-01 01:22:40873
Junio C Hamano33db4372006-06-07 19:51:45874alias.*::
Junio C Hamano35738e82008-01-07 07:55:46875Command aliases for the linkgit:git[1] command wrapper - e.g.
Junio C Hamano33db4372006-06-07 19:51:45876after defining "alias.last = cat-file commit HEAD", the invocation
877"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17878confusion and troubles with script usage, aliases that
Junio C Hamano076ffcc2013-02-06 05:13:21879hide existing Git commands are ignored. Arguments are split by
Junio C Hamanof1d14802006-06-08 00:48:17880spaces, the usual shell quoting and escaping is supported.
Junio C Hamano2efd5e42014-11-10 22:38:52881A quote pair or a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39882+
883If the alias expansion is prefixed with an exclamation point,
884it will be treated as a shell command. For example, defining
885"alias.new = !gitk --all --not ORIG_HEAD", the invocation
886"git new" is equivalent to running the shell command
Junio C Hamano48bc1ce2009-07-09 16:49:19887"gitk --all --not ORIG_HEAD". Note that shell commands will be
888executed from the top-level directory of a repository, which may
889not necessarily be the current directory.
Junio C Hamano042f2142016-06-27 18:05:05890`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
Junio C Hamano5f2627d2011-05-06 20:23:48891from the original current directory. See linkgit:git-rev-parse[1].
Junio C Hamano9cb74f22007-02-12 04:15:05892
Junio C Hamanocaa712a2010-03-11 01:17:35893am.keepcr::
894If true, git-am will call git-mailsplit for patches in mbox format
Junio C Hamano92d80372016-07-13 22:00:05895with parameter `--keep-cr`. In this case git-mailsplit will
Junio C Hamano619596a2010-08-18 22:15:35896not remove `\r` from lines ending with `\r\n`. Can be overridden
Junio C Hamano92d80372016-07-13 22:00:05897by giving `--no-keep-cr` from the command line.
Junio C Hamanocaa712a2010-03-11 01:17:35898See linkgit:git-am[1], linkgit:git-mailsplit[1].
899
Junio C Hamano9c512872015-08-12 21:59:25900am.threeWay::
901By default, `git am` will fail if the patch does not apply cleanly. When
902set to true, this setting tells `git am` to fall back on 3-way merge if
903the patch records the identity of blobs it is supposed to apply to and
904we have those blobs available locally (equivalent to giving the `--3way`
905option from the command line). Defaults to `false`.
906See linkgit:git-am[1].
907
Junio C Hamano322c6242015-03-23 21:32:46908apply.ignoreWhitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43909When set to 'change', tells 'git apply' to ignore changes in
Junio C Hamano92d80372016-07-13 22:00:05910whitespace, in the same way as the `--ignore-space-change`
Junio C Hamanofe24db02009-08-22 05:10:47911option.
Junio C Hamano1aa40d22010-01-21 17:46:43912When set to one of: no, none, never, false tells 'git apply' to
Junio C Hamanofe24db02009-08-22 05:10:47913respect all whitespace differences.
914See linkgit:git-apply[1].
915
Junio C Hamano07824ce2006-04-25 07:36:54916apply.whitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43917Tells 'git apply' how to handle whitespaces, in the same way
Junio C Hamano92d80372016-07-13 22:00:05918as the `--whitespace` option. See linkgit:git-apply[1].
Junio C Hamano07824ce2006-04-25 07:36:54919
Junio C Hamano322c6242015-03-23 21:32:46920branch.autoSetupMerge::
Junio C Hamano1aa40d22010-01-21 17:46:43921Tells 'git branch' and 'git checkout' to set up new branches
Junio C Hamano24bc09a2008-02-28 00:27:44922so that linkgit:git-pull[1] will appropriately merge from the
923starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32924this behavior can be chosen per-branch using the `--track`
Junio C Hamano24bc09a2008-02-28 00:27:44925and `--no-track` options. The valid settings are: `false` -- no
926automatic setup is done; `true` -- automatic setup is done when the
Junio C Hamano97bcb482010-11-25 03:16:07927starting point is a remote-tracking branch; `always` --
928automatic setup is done when the starting point is either a
929local branch or remote-tracking
Junio C Hamano24bc09a2008-02-28 00:27:44930branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32931
Junio C Hamano322c6242015-03-23 21:32:46932branch.autoSetupRebase::
Junio C Hamano1aa40d22010-01-21 17:46:43933When a new branch is created with 'git branch' or 'git checkout'
Junio C Hamano076ffcc2013-02-06 05:13:21934that tracks another branch, this variable tells Git to set
Junio C Hamano869bb802008-05-12 00:29:47935up pull to rebase instead of merge (see "branch.<name>.rebase").
936When `never`, rebase is never automatically set to true.
937When `local`, rebase is set to true for tracked branches of
938other local branches.
939When `remote`, rebase is set to true for tracked branches of
Junio C Hamano97bcb482010-11-25 03:16:07940remote-tracking branches.
Junio C Hamano869bb802008-05-12 00:29:47941When `always`, rebase will be set to true for all tracking
942branches.
Junio C Hamano322c6242015-03-23 21:32:46943See "branch.autoSetupMerge" for details on how to set up a
Junio C Hamano869bb802008-05-12 00:29:47944branch to track another branch.
945This option defaults to never.
946
Junio C Hamano47c1e3c2006-09-25 04:45:55947branch.<name>.remote::
Junio C Hamano63b6fdb2013-04-07 23:37:13948When on branch <name>, it tells 'git fetch' and 'git push'
949which remote to fetch from/push to. The remote to push to
Junio C Hamano322c6242015-03-23 21:32:46950may be overridden with `remote.pushDefault` (for all branches).
Junio C Hamano63b6fdb2013-04-07 23:37:13951The remote to push to, for the current branch, may be further
Junio C Hamano322c6242015-03-23 21:32:46952overridden by `branch.<name>.pushRemote`. If no remote is
Junio C Hamano63b6fdb2013-04-07 23:37:13953configured, or if you are not on any branch, it defaults to
Junio C Hamano322c6242015-03-23 21:32:46954`origin` for fetching and `remote.pushDefault` for pushing.
Junio C Hamano238ce9c2013-10-23 21:56:38955Additionally, `.` (a period) is the current local repository
956(a dot-repository), see `branch.<name>.merge`'s final note below.
Junio C Hamano63b6fdb2013-04-07 23:37:13957
Junio C Hamano322c6242015-03-23 21:32:46958branch.<name>.pushRemote::
Junio C Hamano63b6fdb2013-04-07 23:37:13959When on branch <name>, it overrides `branch.<name>.remote` for
Junio C Hamano322c6242015-03-23 21:32:46960pushing. It also overrides `remote.pushDefault` for pushing
Junio C Hamano63b6fdb2013-04-07 23:37:13961from branch <name>. When you pull from one place (e.g. your
962upstream) and push to another place (e.g. your own publishing
Junio C Hamano322c6242015-03-23 21:32:46963repository), you would want to set `remote.pushDefault` to
Junio C Hamano63b6fdb2013-04-07 23:37:13964specify the remote to push to for all branches, and use this
965option to override it for a specific branch.
Junio C Hamano47c1e3c2006-09-25 04:45:55966
967branch.<name>.merge::
Junio C Hamano0706c802009-03-30 22:34:19968Defines, together with branch.<name>.remote, the upstream branch
Junio C Hamanob02377c2011-04-28 22:26:02969for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
Junio C Hamano1aa40d22010-01-21 17:46:43970branch to merge and can also affect 'git push' (see push.default).
971When in branch <name>, it tells 'git fetch' the default
Junio C Hamanoc2b47092007-10-25 06:50:31972refspec to be marked for merging in FETCH_HEAD. The value is
973handled like the remote part of a refspec, and must match a
974ref which is fetched from the remote given by
975"branch.<name>.remote".
Junio C Hamano1aa40d22010-01-21 17:46:43976The merge information is used by 'git pull' (which at first calls
977'git fetch') to lookup the default branch for merging. Without
978this option, 'git pull' defaults to merge the first refspec fetched.
Junio C Hamano96010b22006-12-09 21:15:46979Specify multiple values to get an octopus merge.
Junio C Hamano1aa40d22010-01-21 17:46:43980If you wish to setup 'git pull' so that it merges into <name> from
Junio C Hamano6e149c02007-03-16 10:21:07981another branch in the local repository, you can point
Junio C Hamano238ce9c2013-10-23 21:56:38982branch.<name>.merge to the desired branch, and use the relative path
983setting `.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:55984
Junio C Hamano322c6242015-03-23 21:32:46985branch.<name>.mergeOptions::
Junio C Hamano1b50ce92007-10-03 12:05:53986Sets default options for merging into branch <name>. The syntax and
Junio C Hamanoc0e55e72009-10-10 00:56:29987supported options are the same as those of linkgit:git-merge[1], but
Junio C Hamano1b50ce92007-10-03 12:05:53988option values containing whitespace characters are currently not
989supported.
990
Junio C Hamano0c999702007-12-03 09:57:55991branch.<name>.rebase::
992When true, rebase the branch <name> on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:08993instead of merging the default branch from the default remote when
Junio C Hamano515ab1d2011-12-09 23:41:20994"git pull" is run. See "pull.rebase" for doing this in a non
995branch-specific manner.
996+
Junio C Hamano7db630e2015-09-17 20:26:22997When preserve, also pass `--preserve-merges` along to 'git rebase'
998so that locally committed merge commits will not be flattened
999by running 'git pull'.
Junio C Hamanocf4a1742013-09-11 22:57:501000+
Junio C Hamano289d7e82016-01-27 00:20:381001When the value is `interactive`, the rebase is run in interactive mode.
1002+
Junio C Hamano515ab1d2011-12-09 23:41:201003*NOTE*: this is a possibly dangerous operation; do *not* use
1004it unless you understand the implications (see linkgit:git-rebase[1]
1005for details).
Junio C Hamano0c999702007-12-03 09:57:551006
Junio C Hamano46247182013-01-09 20:50:281007branch.<name>.description::
1008Branch description, can be edited with
1009`git branch --edit-description`. Branch description is
1010automatically added in the format-patch cover letter or
1011request-pull summary.
1012
Junio C Hamano8760ea62008-03-14 08:58:451013browser.<tool>.cmd::
1014Specify the command to invoke the specified browser. The
1015specified command is evaluated in shell with the URLs passed
Junio C Hamano360e3a12011-07-13 23:51:561016as arguments. (See linkgit:git-web{litdd}browse[1].)
Junio C Hamano8760ea62008-03-14 08:58:451017
Junio C Hamanoe35a6fc2008-01-29 09:46:271018browser.<tool>.path::
1019Override the path for the given tool that may be used to
Junio C Hamano92d80372016-07-13 22:00:051020browse HTML help (see `-w` option in linkgit:git-help[1]) or a
Junio C Hamanoe35a6fc2008-01-29 09:46:271021working repository in gitweb (see linkgit:git-instaweb[1]).
1022
Junio C Hamano47b9acd2007-04-24 07:34:341023clean.requireForce::
Junio C Hamanoe6f28d02013-09-17 21:34:001024A boolean to make git-clean do nothing unless given -f,
1025-i or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:341026
Junio C Hamanoeb692952007-01-03 22:02:121027color.branch::
1028A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:461029linkgit:git-branch[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:211030`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoad70bf02016-09-26 23:44:271031only when the output is to a terminal. If unset, then the
1032value of `color.ui` is used (`auto` by default).
Junio C Hamanoeb692952007-01-03 22:02:121033
1034color.branch.<slot>::
1035Use customized color for branch coloration. `<slot>` is one of
1036`current` (the current branch), `local` (a local branch),
Junio C Hamano76927822013-04-19 21:26:571037`remote` (a remote-tracking branch in refs/remotes/),
1038`upstream` (upstream tracking branch), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:221039refs).
Junio C Hamanoeb692952007-01-03 22:02:121040
Junio C Hamano3f403b02006-12-13 10:14:131041color.diff::
Junio C Hamano5f2627d2011-05-06 20:23:481042Whether to use ANSI escape sequences to add color to patches.
1043If this is set to `always`, linkgit:git-diff[1],
1044linkgit:git-log[1], and linkgit:git-show[1] will use color
1045for all patches. If it is set to `true` or `auto`, those
1046commands will only use color when output is to the terminal.
Junio C Hamanoad70bf02016-09-26 23:44:271047If unset, then the value of `color.ui` is used (`auto` by
1048default).
Junio C Hamano5f2627d2011-05-06 20:23:481049+
Junio C Hamanod75148a2014-04-08 19:48:381050This does not affect linkgit:git-format-patch[1] or the
Junio C Hamano5f2627d2011-05-06 20:23:481051'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1052command line with the `--color[=<when>]` option.
Junio C Hamano9ae1a062006-07-10 08:12:341053
Junio C Hamano3f403b02006-12-13 10:14:131054color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:221055Use customized color for diff colorization. `<slot>` specifies
1056which part of the patch to use the specified color, and is one
Junio C Hamano8c5d5942015-06-11 19:37:481057of `context` (context text - `plain` is a historical synonym),
1058`meta` (metainformation), `frag`
Junio C Hamano2bd8a742009-12-01 21:16:591059(hunk header), 'func' (function in hunk header), `old` (removed lines),
1060`new` (added lines), `commit` (commit headers), or `whitespace`
Junio C Hamano07622622015-03-20 21:47:261061(highlighting whitespace errors).
Junio C Hamano9ae1a062006-07-10 08:12:341062
Junio C Hamano7d449522010-07-01 00:08:511063color.decorate.<slot>::
1064Use customized color for 'git log --decorate' output. `<slot>` is one
1065of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
Junio C Hamano97bcb482010-11-25 03:16:071066branches, remote-tracking branches, tags, stash and HEAD, respectively.
Junio C Hamano7d449522010-07-01 00:08:511067
Junio C Hamanod257cff2009-03-18 05:27:161068color.grep::
1069When set to `always`, always highlight matches. When `false` (or
1070`never`), never. When set to `true` or `auto`, use color only
Junio C Hamanoad70bf02016-09-26 23:44:271071when the output is written to the terminal. If unset, then the
1072value of `color.ui` is used (`auto` by default).
Junio C Hamanod257cff2009-03-18 05:27:161073
Junio C Hamano0299d922010-03-20 20:59:311074color.grep.<slot>::
1075Use customized color for grep colorization. `<slot>` specifies which
1076part of the line to use the specified color, and is one of
1077+
1078--
1079`context`;;
1080non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1081`filename`;;
1082filename prefix (when not using `-h`)
1083`function`;;
1084function name lines (when using `-p`)
1085`linenumber`;;
1086line number prefix (when using `-n`)
1087`match`;;
Junio C Hamanoc14e6ad2014-10-31 20:25:531088matching text (same as setting `matchContext` and `matchSelected`)
1089`matchContext`;;
1090matching text in context lines
1091`matchSelected`;;
1092matching text in selected lines
Junio C Hamano0299d922010-03-20 20:59:311093`selected`;;
1094non-matching text in selected lines
1095`separator`;;
1096separators between fields on a line (`:`, `-`, and `=`)
1097and between hunks (`--`)
1098--
Junio C Hamanod257cff2009-03-18 05:27:161099
Junio C Hamano00b8b632007-12-07 09:50:491100color.interactive::
Junio C Hamano35738e82008-01-07 07:55:461101When set to `always`, always use colors for interactive prompts
Junio C Hamano58f587a2013-07-22 19:20:591102and displays (such as those used by "git-add --interactive" and
1103"git-clean --interactive"). When false (or `never`), never.
1104When set to `true` or `auto`, use colors only when the output is
Junio C Hamanoad70bf02016-09-26 23:44:271105to the terminal. If unset, then the value of `color.ui` is
1106used (`auto` by default).
Junio C Hamano00b8b632007-12-07 09:50:491107
1108color.interactive.<slot>::
Junio C Hamano58f587a2013-07-22 19:20:591109Use customized color for 'git add --interactive' and 'git clean
1110--interactive' output. `<slot>` may be `prompt`, `header`, `help`
1111or `error`, for four distinct types of normal output from
Junio C Hamano07622622015-03-20 21:47:261112interactive commands.
Junio C Hamano00b8b632007-12-07 09:50:491113
Junio C Hamanoe7935c42006-12-13 21:32:171114color.pager::
1115A boolean to enable/disable colored output when the pager is in
1116use (default is true).
1117
Junio C Hamano322c6242015-03-23 21:32:461118color.showBranch::
Junio C Hamano52ba2952009-05-18 17:43:021119A boolean to enable/disable color in the output of
1120linkgit:git-show-branch[1]. May be set to `always`,
1121`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoad70bf02016-09-26 23:44:271122only when the output is to a terminal. If unset, then the
1123value of `color.ui` is used (`auto` by default).
Junio C Hamano52ba2952009-05-18 17:43:021124
Junio C Hamanoe7935c42006-12-13 21:32:171125color.status::
1126A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:461127linkgit:git-status[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:211128`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoad70bf02016-09-26 23:44:271129only when the output is to a terminal. If unset, then the
1130value of `color.ui` is used (`auto` by default).
Junio C Hamanoe7935c42006-12-13 21:32:171131
1132color.status.<slot>::
1133Use customized color for status colorization. `<slot>` is
1134one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:041135`added` or `updated` (files which are added but not committed),
1136`changed` (files which are changed but not added in the index),
Junio C Hamano076ffcc2013-02-06 05:13:211137`untracked` (files which are not tracked by Git),
Junio C Hamano5992a252015-03-17 23:39:301138`branch` (the current branch),
Junio C Hamanob713ff12008-05-24 01:12:301139`nobranch` (the color the 'no branch' warning is shown in, defaulting
Junio C Hamanod5176902017-05-16 04:30:561140to red),
1141`localBranch` or `remoteBranch` (the local and remote branch names,
1142respectively, when branch and tracking information is displayed in the
1143status short-format), or
Junio C Hamano5992a252015-03-17 23:39:301144`unmerged` (files which have unmerged changes).
Junio C Hamanoe7935c42006-12-13 21:32:171145
Junio C Hamano83d46a22008-02-21 02:29:421146color.ui::
Junio C Hamano5f2627d2011-05-06 20:23:481147This variable determines the default value for variables such
1148as `color.diff` and `color.grep` that control the use of color
1149per command family. Its scope will expand as more commands learn
1150configuration to set a default for the `--color` option. Set it
Junio C Hamanofa1d3492013-06-20 23:39:431151to `false` or `never` if you prefer Git commands not to use
1152color unless enabled explicitly with some other configuration
1153or the `--color` option. Set it to `always` if you want all
1154output not intended for machine consumption to use color, to
1155`true` or `auto` (this is the default since Git 1.8.4) if you
1156want such output to use color when written to the terminal.
Junio C Hamano83d46a22008-02-21 02:29:421157
Junio C Hamano22700fb2012-05-03 23:07:251158column.ui::
1159Specify whether supported commands should output in columns.
1160This variable consists of a list of tokens separated by spaces
1161or commas:
1162+
Junio C Hamanoa1952302013-07-01 21:31:181163These options control when the feature should be enabled
1164(defaults to 'never'):
1165+
Junio C Hamano22700fb2012-05-03 23:07:251166--
1167`always`;;
1168always show in columns
1169`never`;;
1170never show in columns
1171`auto`;;
1172show in columns if the output is to the terminal
Junio C Hamanoa1952302013-07-01 21:31:181173--
1174+
1175These options control layout (defaults to 'column'). Setting any
1176of these implies 'always' if none of 'always', 'never', or 'auto' are
1177specified.
1178+
1179--
Junio C Hamano22700fb2012-05-03 23:07:251180`column`;;
Junio C Hamanoa1952302013-07-01 21:31:181181fill columns before rows
Junio C Hamano22700fb2012-05-03 23:07:251182`row`;;
1183fill rows before columns
1184`plain`;;
1185show in one column
Junio C Hamanoa1952302013-07-01 21:31:181186--
1187+
1188Finally, these options can be combined with a layout option (defaults
1189to 'nodense'):
1190+
1191--
Junio C Hamano22700fb2012-05-03 23:07:251192`dense`;;
1193make unequal size columns to utilize more space
1194`nodense`;;
1195make equal size columns
1196--
Junio C Hamano22700fb2012-05-03 23:07:251197
1198column.branch::
1199Specify whether to output branch listing in `git branch` in columns.
1200See `column.ui` for details.
1201
Junio C Hamano58f587a2013-07-22 19:20:591202column.clean::
1203Specify the layout when list items in `git clean -i`, which always
1204shows files and directories in columns. See `column.ui` for details.
1205
Junio C Hamano22700fb2012-05-03 23:07:251206column.status::
1207Specify whether to output untracked files in `git status` in columns.
1208See `column.ui` for details.
1209
1210column.tag::
1211Specify whether to output tag listing in `git tag` in columns.
1212See `column.ui` for details.
1213
Junio C Hamanoce836cc2013-01-21 02:01:531214commit.cleanup::
1215This setting overrides the default of the `--cleanup` option in
1216`git commit`. See linkgit:git-commit[1] for details. Changing the
1217default can be useful when you always want to keep lines that begin
1218with comment character `#` in your log message, in which case you
1219would do `git config commit.cleanup whitespace` (note that you will
1220have to remove the help lines that begin with `#` in the commit log
1221template yourself, if you do this).
1222
Junio C Hamano322c6242015-03-23 21:32:461223commit.gpgSign::
Junio C Hamano5b3533d2014-02-27 23:07:151224
1225A boolean to specify whether all commits should be GPG signed.
1226Use of this option when doing operations such as rebase can
1227result in a large number of commits being signed. It may be
1228convenient to use an agent to avoid typing your GPG passphrase
1229several times.
1230
Junio C Hamanod0d892c2010-01-24 20:06:291231commit.status::
Junio C Hamano6ce6b6c2010-01-18 01:25:501232A boolean to enable/disable inclusion of status information in the
1233commit message template when using an editor to prepare the commit
1234message. Defaults to true.
1235
Junio C Hamano4653c6f2008-11-26 22:50:201236commit.template::
Junio C Hamano198b1f12016-05-17 22:27:241237Specify the pathname of a file to use as the template for
1238new commit messages.
Junio C Hamano4653c6f2008-11-26 22:50:201239
Junio C Hamanof2a3a752016-05-23 22:54:391240commit.verbose::
1241A boolean or int to specify the level of verbose with `git commit`.
1242See linkgit:git-commit[1].
1243
Junio C Hamano0df92712011-12-21 22:30:441244credential.helper::
1245Specify an external helper to be called when a username or
1246password credential is needed; the helper may consult external
Junio C Hamano4ba4a782016-04-03 19:11:321247storage to avoid prompting the user for the credentials. Note
1248that multiple helpers may be defined. See linkgit:gitcredentials[7]
1249for details.
Junio C Hamano0df92712011-12-21 22:30:441250
1251credential.useHttpPath::
1252When acquiring credentials, consider the "path" component of an http
1253or https URL to be important. Defaults to false. See
1254linkgit:gitcredentials[7] for more information.
1255
1256credential.username::
1257If no username is set for a network authentication, use this username
1258by default. See credential.<context>.* below, and
1259linkgit:gitcredentials[7].
1260
1261credential.<url>.*::
1262Any of the credential.* options above can be applied selectively to
1263some credentials. For example "credential.https://example.com.username"
1264would set the default username only for https connections to
1265example.com. See linkgit:gitcredentials[7] for details on how URLs are
1266matched.
1267
Junio C Hamanoabb8a052015-12-04 22:43:111268credentialCache.ignoreSIGHUP::
1269Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1270
Junio C Hamano209ebe82011-04-27 21:09:591271include::diff-config.txt[]
Junio C Hamano3bd66e92009-04-18 06:17:561272
1273difftool.<tool>.path::
1274Override the path for the given tool. This is useful in case
1275your tool is not in the PATH.
1276
1277difftool.<tool>.cmd::
1278Specify the command to invoke the specified diff tool.
1279The specified command is evaluated in shell with the following
1280variables available: 'LOCAL' is set to the name of the temporary
1281file containing the contents of the diff pre-image and 'REMOTE'
1282is set to the name of the temporary file containing the contents
1283of the diff post-image.
1284
1285difftool.prompt::
1286Prompt before each invocation of the diff tool.
1287
Junio C Hamanofedb1b42016-06-20 21:23:401288fastimport.unpackLimit::
1289If the number of objects imported by linkgit:git-fast-import[1]
1290is below this limit, then the objects will be unpacked into
1291loose object files. However if the number of imported objects
1292equals or exceeds this limit then the pack will be stored as a
1293pack. Storing the pack from a fast-import can make the import
1294operation complete faster, especially on slow filesystems. If
1295not set, the value of `transfer.unpackLimit` is used instead.
1296
Junio C Hamano0d75e872010-12-17 06:57:261297fetch.recurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:101298This option can be either set to a boolean value or to 'on-demand'.
1299Setting it to a boolean changes the behavior of fetch and pull to
1300unconditionally recurse into submodules when set to true or to not
1301recurse at all when set to false. When set to 'on-demand' (the default
1302value), fetch and pull will only recurse into a populated submodule
1303when its superproject retrieves a commit that updates the submodule's
1304reference.
Junio C Hamano0d75e872010-12-17 06:57:261305
Junio C Hamano8fb66e52011-10-05 20:59:511306fetch.fsckObjects::
1307If it is set to true, git-fetch-pack will check all fetched
1308objects. It will abort in the case of a malformed object or a
1309broken link. The result of an abort are only dangling objects.
1310Defaults to false. If not set, the value of `transfer.fsckObjects`
1311is used instead.
1312
Junio C Hamano54ea8d32007-01-25 07:59:481313fetch.unpackLimit::
Junio C Hamano076ffcc2013-02-06 05:13:211314If the number of objects fetched over the Git native
Junio C Hamano54ea8d32007-01-25 07:59:481315transfer is below this
1316limit, then the objects will be unpacked into loose object
1317files. However if the number of received objects equals or
1318exceeds this limit then the received pack will be stored as
1319a pack, after adding any missing delta bases. Storing the
1320pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:171321especially on slow filesystems. If not set, the value of
1322`transfer.unpackLimit` is used instead.
Junio C Hamano54ea8d32007-01-25 07:59:481323
Junio C Hamano8eac2682013-09-09 22:35:201324fetch.prune::
1325If true, fetch will automatically behave as if the `--prune`
1326option was given on the command line. See also `remote.<name>.prune`.
1327
Junio C Hamano1a1b8472016-07-19 21:37:131328fetch.output::
1329Control how ref update status is printed. Valid values are
1330`full` and `compact`. Default value is `full`. See section
1331OUTPUT in linkgit:git-fetch[1] for detail.
1332
Junio C Hamanof4581102009-04-25 08:29:591333format.attach::
1334Enable multipart/mixed attachments as the default for
1335'format-patch'. The value can also be a double quoted string
1336which will enable attachments as the default and set the
1337value as the boundary. See the --attach option in
1338linkgit:git-format-patch[1].
1339
Junio C Hamanoaf182942016-08-10 20:46:261340format.from::
1341Provides the default value for the `--from` option to format-patch.
1342Accepts a boolean value, or a name and email address. If false,
1343format-patch defaults to `--no-from`, using commit authors directly in
1344the "From:" field of patch mails. If true, format-patch defaults to
1345`--from`, using your committer identity in the "From:" field of patch
1346mails and including a "From:" field in the body of the patch mail if
1347different. If set to a non-boolean value, format-patch uses that
1348value instead of your committer identity. Defaults to false.
1349
Junio C Hamano8c5802d2007-11-15 00:13:361350format.numbered::
Junio C Hamano7d06a8a2008-10-20 05:42:331351A boolean which can enable or disable sequence numbers in patch
1352subjects. It defaults to "auto" which enables it only if there
1353is more than one patch. It can be enabled or disabled for all
1354messages by setting it to "true" or "false". See --numbered
1355option in linkgit:git-format-patch[1].
Junio C Hamano8c5802d2007-11-15 00:13:361356
Junio C Hamano07824ce2006-04-25 07:36:541357format.headers::
1358Additional email headers to include in a patch to be submitted
Junio C Hamano35738e82008-01-07 07:55:461359by mail. See linkgit:git-format-patch[1].
Junio C Hamano07824ce2006-04-25 07:36:541360
Junio C Hamano70664a02010-07-13 22:48:051361format.to::
Junio C Hamanof4581102009-04-25 08:29:591362format.cc::
Junio C Hamano70664a02010-07-13 22:48:051363Additional recipients to include in a patch to be submitted
1364by mail. See the --to and --cc options in
1365linkgit:git-format-patch[1].
Junio C Hamanof4581102009-04-25 08:29:591366
Junio C Hamano322c6242015-03-23 21:32:461367format.subjectPrefix::
Junio C Hamanof4581102009-04-25 08:29:591368The default for format-patch is to output files with the '[PATCH]'
1369subject prefix. Use this variable to change that prefix.
1370
Junio C Hamano89a57342010-06-22 23:22:551371format.signature::
1372The default for format-patch is to output a signature containing
Junio C Hamano076ffcc2013-02-06 05:13:211373the Git version number. Use this variable to change that default.
Junio C Hamano89a57342010-06-22 23:22:551374Set this variable to the empty string ("") to suppress
1375signature generation.
1376
Junio C Hamano322c6242015-03-23 21:32:461377format.signatureFile::
Junio C Hamanoc8c398a2014-06-16 21:14:051378Works just like format.signature except the contents of the
1379file specified by this variable will be used as the signature.
1380
Junio C Hamanod4c8e112007-03-04 10:32:381381format.suffix::
1382The default for format-patch is to output files with the suffix
1383`.patch`. Use this variable to change that suffix (make sure to
1384include the dot if you want it).
1385
Junio C Hamano86bcccc2008-03-08 09:33:551386format.pretty::
1387The default pretty format for log/show/whatchanged command,
1388See linkgit:git-log[1], linkgit:git-show[1],
1389linkgit:git-whatchanged[1].
1390
Junio C Hamanoea6a7642009-03-11 23:56:191391format.thread::
Junio C Hamano1aa40d22010-01-21 17:46:431392The default threading style for 'git format-patch'. Can be
Junio C Hamanob141a922010-01-10 19:55:141393a boolean value, or `shallow` or `deep`. `shallow` threading
1394makes every mail a reply to the head of the series,
Junio C Hamanoea6a7642009-03-11 23:56:191395where the head is chosen from the cover letter, the
Junio C Hamanob76a6862012-05-02 22:02:461396`--in-reply-to`, and the first patch mail, in this order.
Junio C Hamanof4581102009-04-25 08:29:591397`deep` threading makes every mail a reply to the previous one.
Junio C Hamanoea6a7642009-03-11 23:56:191398A true boolean value is the same as `shallow`, and a false
1399value disables threading.
1400
Junio C Hamano322c6242015-03-23 21:32:461401format.signOff::
Junio C Hamano804a9742013-04-28 23:10:311402A boolean value which lets you enable the `-s/--signoff` option of
1403format-patch by default. *Note:* Adding the Signed-off-by: line to a
1404patch should be a conscious act and means that you certify you have
1405the rights to submit this work under the same open source license.
1406Please see the 'SubmittingPatches' document for further discussion.
Junio C Hamano5f9a6f02009-04-06 08:26:561407
Junio C Hamanoea3b7522013-04-18 19:37:531408format.coverLetter::
1409A boolean that controls whether to generate a cover-letter when
1410format-patch is invoked, but in addition can be set to "auto", to
1411generate a cover-letter only when there's more than one patch.
1412
Junio C Hamano289d7e82016-01-27 00:20:381413format.outputDirectory::
1414Set a custom directory to store the resulting files instead of the
1415current working directory.
1416
Junio C Hamanof2a3a752016-05-23 22:54:391417format.useAutoBase::
1418A boolean value which lets you enable the `--base=auto` option of
1419format-patch by default.
1420
Junio C Hamano209ebe82011-04-27 21:09:591421filter.<driver>.clean::
1422The command which is used to convert the content of a worktree
1423file to a blob upon checkin. See linkgit:gitattributes[5] for
1424details.
1425
1426filter.<driver>.smudge::
1427The command which is used to convert the content of a blob
1428object to a worktree file upon checkout. See
1429linkgit:gitattributes[5] for details.
1430
Junio C Hamanod7ed4042015-08-03 19:43:001431fsck.<msg-id>::
1432Allows overriding the message type (error, warn or ignore) of a
1433specific message ID such as `missingEmail`.
1434+
1435For convenience, fsck prefixes the error/warning with the message ID,
1436e.g. "missingEmail: invalid author/committer line - missing email" means
1437that setting `fsck.missingEmail = ignore` will hide that issue.
1438+
1439This feature is intended to support working with legacy repositories
1440which cannot be repaired without disruptive changes.
1441
1442fsck.skipList::
1443The path to a sorted list of object names (i.e. one SHA-1 per
1444line) that are known to be broken in a non-fatal way and should
1445be ignored. This feature is useful when an established project
1446should be accepted despite early commits containing errors that
1447can be safely ignored such as invalid committer email addresses.
1448Note: corrupt objects cannot be skipped with this setting.
1449
Junio C Hamano624dd4c2014-04-03 21:56:301450gc.aggressiveDepth::
1451The depth parameter used in the delta compression
1452algorithm used by 'git gc --aggressive'. This defaults
Junio C Hamano53800482016-09-21 23:26:431453to 50.
Junio C Hamano624dd4c2014-04-03 21:56:301454
Junio C Hamanof2ce2972007-05-20 19:12:091455gc.aggressiveWindow::
1456The window size parameter used in the delta compression
Junio C Hamano1aa40d22010-01-21 17:46:431457algorithm used by 'git gc --aggressive'. This defaults
Junio C Hamanob04bb3f2010-04-14 14:07:361458to 250.
Junio C Hamanof2ce2972007-05-20 19:12:091459
Junio C Hamano1b50ce92007-10-03 12:05:531460gc.auto::
1461When there are approximately more than this many loose
1462objects in the repository, `git gc --auto` will pack them.
1463Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:171464light-weight garbage collection from time to time. The
1465default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531466
Junio C Hamano322c6242015-03-23 21:32:461467gc.autoPackLimit::
Junio C Hamano1b50ce92007-10-03 12:05:531468When there are more than this many packs that are not
1469marked with `*.keep` file in the repository, `git gc
Junio C Hamanoe77b0152008-01-12 06:44:171470--auto` consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:371471default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531472
Junio C Hamano322c6242015-03-23 21:32:461473gc.autoDetach::
Junio C Hamanofb5ffde2014-11-04 22:38:561474Make `git gc --auto` return immediately and run in background
Junio C Hamano08ef8c22014-03-10 14:53:441475if the system supports it. Default is true.
1476
Junio C Hamanocbe0eb22017-02-27 23:37:491477gc.logExpiry::
1478If the file gc.log exists, then `git gc --auto` won't run
1479unless that file is more than 'gc.logExpiry' old. Default is
1480"1.day". See `gc.pruneExpire` for more ways to specify its
1481value.
1482
Junio C Hamano322c6242015-03-23 21:32:461483gc.packRefs::
Junio C Hamanob141a922010-01-10 19:55:141484Running `git pack-refs` in a repository renders it
1485unclonable by Git versions prior to 1.5.1.2 over dumb
1486transports such as HTTP. This variable determines whether
Junio C Hamanocdd1c332010-12-20 10:08:001487'git gc' runs `git pack-refs`. This can be set to `notbare`
Junio C Hamanob141a922010-01-10 19:55:141488to enable it within all non-bare repos or it can be set to a
1489boolean value. The default is `true`.
Junio C Hamano9d52e572007-02-13 23:48:201490
Junio C Hamano322c6242015-03-23 21:32:461491gc.pruneExpire::
Junio C Hamano1aa40d22010-01-21 17:46:431492When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
Junio C Hamanoa3148f52009-01-14 08:49:571493Override the grace period with this config variable. The value
Junio C Hamano9c512872015-08-12 21:59:251494"now" may be used to disable this grace period and always prune
1495unreachable objects immediately, or "never" may be used to
Junio C Hamano56ace3d2017-01-10 23:43:411496suppress pruning. This feature helps prevent corruption when
1497'git gc' runs concurrently with another process writing to the
1498repository; see the "NOTES" section of linkgit:git-gc[1].
Junio C Hamano09a926d2008-03-13 07:55:291499
Junio C Hamano9c512872015-08-12 21:59:251500gc.worktreePruneExpire::
1501When 'git gc' is run, it calls
1502'git worktree prune --expire 3.months.ago'.
1503This config variable can be used to set a different grace
1504period. The value "now" may be used to disable the grace
Junio C Hamano198b1f12016-05-17 22:27:241505period and prune `$GIT_DIR/worktrees` immediately, or "never"
Junio C Hamano9c512872015-08-12 21:59:251506may be used to suppress pruning.
Junio C Hamano4cc4a842015-05-11 22:41:021507
Junio C Hamano322c6242015-03-23 21:32:461508gc.reflogExpire::
1509gc.<pattern>.reflogExpire::
Junio C Hamano1aa40d22010-01-21 17:46:431510'git reflog expire' removes reflog entries older than
Junio C Hamano9c512872015-08-12 21:59:251511this time; defaults to 90 days. The value "now" expires all
1512entries immediately, and "never" suppresses expiration
1513altogether. With "<pattern>" (e.g.
Junio C Hamanocc7636a2010-05-21 14:57:531514"refs/stash") in the middle the setting applies only to
1515the refs that match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551516
Junio C Hamano322c6242015-03-23 21:32:461517gc.reflogExpireUnreachable::
Junio C Hamanoa1746be2015-08-26 23:07:071518gc.<pattern>.reflogExpireUnreachable::
Junio C Hamano1aa40d22010-01-21 17:46:431519'git reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:551520this time and are not reachable from the current tip;
Junio C Hamano9c512872015-08-12 21:59:251521defaults to 30 days. The value "now" expires all entries
1522immediately, and "never" suppresses expiration altogether.
1523With "<pattern>" (e.g. "refs/stash")
Junio C Hamanocc7636a2010-05-21 14:57:531524in the middle, the setting applies only to the refs that
1525match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551526
Junio C Hamano322c6242015-03-23 21:32:461527gc.rerereResolved::
Junio C Hamano74640642006-12-27 10:59:551528Records of conflicted merge you resolved earlier are
Junio C Hamano1aa40d22010-01-21 17:46:431529kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461530The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551531
Junio C Hamano322c6242015-03-23 21:32:461532gc.rerereUnresolved::
Junio C Hamano74640642006-12-27 10:59:551533Records of conflicted merge you have not resolved are
Junio C Hamano1aa40d22010-01-21 17:46:431534kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461535The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551536
Junio C Hamano322c6242015-03-23 21:32:461537gitcvs.commitMsgAnnotation::
Junio C Hamanoa3148f52009-01-14 08:49:571538Append this string to each commit message. Set to empty string
1539to disable this feature. Defaults to "via git-CVS emulator".
1540
Junio C Hamano07824ce2006-04-25 07:36:541541gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:271542Whether the CVS server interface is enabled for this repository.
Junio C Hamano35738e82008-01-07 07:55:461543See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541544
Junio C Hamano322c6242015-03-23 21:32:461545gitcvs.logFile::
Junio C Hamanoa6387422007-08-25 03:54:271546Path to a log file where the CVS server interface well... logs
Junio C Hamano35738e82008-01-07 07:55:461547various stuff. See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541548
Junio C Hamano17bd2272008-09-01 06:11:171549gitcvs.usecrlfattr::
Junio C Hamanobb88cf42010-06-21 15:23:551550If true, the server will look up the end-of-line conversion
Junio C Hamano92d80372016-07-13 22:00:051551attributes for files to determine the `-k` modes to use. If
Junio C Hamano076ffcc2013-02-06 05:13:211552the attributes force Git to treat a file as text,
Junio C Hamano92d80372016-07-13 22:00:051553the `-k` mode will be left blank so CVS clients will
Junio C Hamanobb88cf42010-06-21 15:23:551554treat it as text. If they suppress text conversion, the file
Junio C Hamanocb1c44f2008-08-06 06:19:331555will be set with '-kb' mode, which suppresses any newline munging
Junio C Hamanobb88cf42010-06-21 15:23:551556the client might otherwise do. If the attributes do not allow
Junio C Hamano042f2142016-06-27 18:05:051557the file type to be determined, then `gitcvs.allBinary` is
Junio C Hamanobb88cf42010-06-21 15:23:551558used. See linkgit:gitattributes[5].
Junio C Hamanodfccbb02008-05-26 01:16:141559
Junio C Hamano322c6242015-03-23 21:32:461560gitcvs.allBinary::
Junio C Hamano042f2142016-06-27 18:05:051561This is used if `gitcvs.usecrlfattr` does not resolve
Junio C Hamanodfccbb02008-05-26 01:16:141562the correct '-kb' mode to use. If true, all
1563unresolved files are sent to the client in
1564mode '-kb'. This causes the client to treat them
1565as binary files, which suppresses any newline munging it
1566otherwise might do. Alternatively, if it is set to "guess",
1567then the contents of the file are examined to decide if
Junio C Hamano042f2142016-06-27 18:05:051568it is binary, similar to `core.autocrlf`.
Junio C Hamanoa2ad99e2007-04-18 09:57:041569
Junio C Hamano322c6242015-03-23 21:32:461570gitcvs.dbName::
Junio C Hamanoa2ad99e2007-04-18 09:57:041571Database used by git-cvsserver to cache revision information
Junio C Hamano076ffcc2013-02-06 05:13:211572derived from the Git repository. The exact meaning depends on the
Junio C Hamanoa2ad99e2007-04-18 09:57:041573used database driver, for SQLite (which is the default driver) this
1574is a filename. Supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461575linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Junio C Hamanoa2ad99e2007-04-18 09:57:041576Default: '%Ggitcvs.%m.sqlite'
1577
Junio C Hamano322c6242015-03-23 21:32:461578gitcvs.dbDriver::
Junio C Hamanoa2ad99e2007-04-18 09:57:041579Used Perl DBI driver. You can specify any available driver
Junio C Hamano804a9742013-04-28 23:10:311580for this here, but it might not work. git-cvsserver is tested
Junio C Hamanoa2ad99e2007-04-18 09:57:041581with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1582reported *not* to work with 'DBD::mysql'. Experimental feature.
1583May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamano35738e82008-01-07 07:55:461584See linkgit:git-cvsserver[1].
Junio C Hamanod9e0e5d2007-04-14 16:22:041585
Junio C Hamano322c6242015-03-23 21:32:461586gitcvs.dbUser, gitcvs.dbPass::
Junio C Hamano042f2142016-06-27 18:05:051587Database user and password. Only useful if setting `gitcvs.dbDriver`,
Junio C Hamanoa2ad99e2007-04-18 09:57:041588since SQLite has no concept of database users and/or passwords.
Junio C Hamano322c6242015-03-23 21:32:461589'gitcvs.dbUser' supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461590linkgit:git-cvsserver[1] for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:041591
Junio C Hamanoa74efce2008-04-02 08:39:081592gitcvs.dbTableNamePrefix::
1593Database table name prefix. Prepended to the names of any
1594database tables used, allowing a single database to be used
1595for several repositories. Supports variable substitution (see
1596linkgit:git-cvsserver[1] for details). Any non-alphabetic
1597characters will be replaced with underscores.
1598
Junio C Hamano042f2142016-06-27 18:05:051599All gitcvs variables except for `gitcvs.usecrlfattr` and
1600`gitcvs.allBinary` can also be specified as
Junio C Hamanodfccbb02008-05-26 01:16:141601'gitcvs.<access_method>.<varname>' (where 'access_method'
Junio C Hamanoa6387422007-08-25 03:54:271602is one of "ext" and "pserver") to make them apply only for the given
1603access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:041604
Junio C Hamano11821ed2011-10-19 18:42:091605gitweb.category::
1606gitweb.description::
1607gitweb.owner::
1608gitweb.url::
1609See linkgit:gitweb[1] for description.
1610
1611gitweb.avatar::
1612gitweb.blame::
1613gitweb.grep::
1614gitweb.highlight::
1615gitweb.patches::
1616gitweb.pickaxe::
1617gitweb.remote_heads::
Junio C Hamano322c6242015-03-23 21:32:461618gitweb.showSizes::
Junio C Hamano11821ed2011-10-19 18:42:091619gitweb.snapshot::
1620See linkgit:gitweb.conf[5] for description.
1621
Junio C Hamanoa03ac862011-04-02 04:32:291622grep.lineNumber::
Junio C Hamano92d80372016-07-13 22:00:051623If set to true, enable `-n` option by default.
Junio C Hamanoa03ac862011-04-02 04:32:291624
Junio C Hamanoa00504d2012-08-27 21:11:231625grep.patternType::
1626Set the default matching behavior. Using a value of 'basic', 'extended',
Junio C Hamano92d80372016-07-13 22:00:051627'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1628`--fixed-strings`, or `--perl-regexp` option accordingly, while the
Junio C Hamanoa00504d2012-08-27 21:11:231629value 'default' will return to the default matching behavior.
1630
Junio C Hamanoa03ac862011-04-02 04:32:291631grep.extendedRegexp::
Junio C Hamano92d80372016-07-13 22:00:051632If set to true, enable `--extended-regexp` option by default. This
Junio C Hamano042f2142016-06-27 18:05:051633option is ignored when the `grep.patternType` option is set to a value
Junio C Hamanoa00504d2012-08-27 21:11:231634other than 'default'.
Junio C Hamanoa03ac862011-04-02 04:32:291635
Junio C Hamanoa7da1ba2016-01-13 00:19:451636grep.threads::
1637Number of grep worker threads to use.
1638See `grep.threads` in linkgit:git-grep[1] for more information.
1639
Junio C Hamano4e6ba272016-01-20 23:23:191640grep.fallbackToNoIndex::
1641If set to true, fall back to git grep --no-index if git grep
1642is executed outside of a git repository. Defaults to false.
1643
Junio C Hamano4fd24422012-01-06 21:52:431644gpg.program::
Junio C Hamano198b1f12016-05-17 22:27:241645Use this custom program instead of "`gpg`" found on `$PATH` when
Junio C Hamano4fd24422012-01-06 21:52:431646making or verifying a PGP signature. The program must support the
Junio C Hamanoe1aeb5e2014-06-06 19:16:291647same command-line interface as GPG, namely, to verify a detached
Junio C Hamano198b1f12016-05-17 22:27:241648signature, "`gpg --verify $file - <$signature`" is run, and the
Junio C Hamano4fd24422012-01-06 21:52:431649program is expected to signal a good signature by exiting with
Junio C Hamanofb5ffde2014-11-04 22:38:561650code 0, and to generate an ASCII-armored detached signature, the
Junio C Hamano198b1f12016-05-17 22:27:241651standard input of "`gpg -bsau $key`" is fed with the contents to be
Junio C Hamano4fd24422012-01-06 21:52:431652signed, and the program is expected to send the result to its
1653standard output.
1654
Junio C Hamano322c6242015-03-23 21:32:461655gui.commitMsgWidth::
Junio C Hamano6d76d612008-05-09 05:46:081656Defines how wide the commit message window is in the
1657linkgit:git-gui[1]. "75" is the default.
1658
Junio C Hamano322c6242015-03-23 21:32:461659gui.diffContext::
Junio C Hamano6d76d612008-05-09 05:46:081660Specifies how many context lines should be used in calls to diff
1661made by the linkgit:git-gui[1]. The default is "5".
1662
Junio C Hamano322c6242015-03-23 21:32:461663gui.displayUntracked::
Junio C Hamano198b1f12016-05-17 22:27:241664Determines if linkgit:git-gui[1] shows untracked files
Junio C Hamano796c55f2014-05-02 21:45:151665in the file list. The default is "true".
1666
Junio C Hamanod3452a02008-11-15 08:07:551667gui.encoding::
1668Specifies the default encoding to use for displaying of
1669file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1670It can be overridden by setting the 'encoding' attribute
1671for relevant files (see linkgit:gitattributes[5]).
1672If this option is not set, the tools default to the
1673locale encoding.
1674
Junio C Hamano322c6242015-03-23 21:32:461675gui.matchTrackingBranch::
Junio C Hamano6d76d612008-05-09 05:46:081676Determines if new branches created with linkgit:git-gui[1] should
1677default to tracking remote branches with matching names or
1678not. Default: "false".
1679
Junio C Hamano322c6242015-03-23 21:32:461680gui.newBranchTemplate::
Junio C Hamano6d76d612008-05-09 05:46:081681Is used as suggested name when creating new branches using the
1682linkgit:git-gui[1].
1683
Junio C Hamano322c6242015-03-23 21:32:461684gui.pruneDuringFetch::
Junio C Hamano97bcb482010-11-25 03:16:071685"true" if linkgit:git-gui[1] should prune remote-tracking branches when
Junio C Hamano6d76d612008-05-09 05:46:081686performing a fetch. The default value is "false".
1687
1688gui.trustmtime::
1689Determines if linkgit:git-gui[1] should trust the file modification
1690timestamp or not. By default the timestamps are not trusted.
1691
Junio C Hamano322c6242015-03-23 21:32:461692gui.spellingDictionary::
Junio C Hamano6d76d612008-05-09 05:46:081693Specifies the dictionary used for spell checking commit messages in
1694the linkgit:git-gui[1]. When set to "none" spell checking is turned
1695off.
1696
Junio C Hamano322c6242015-03-23 21:32:461697gui.fastCopyBlame::
Junio C Hamano1aa40d22010-01-21 17:46:431698If true, 'git gui blame' uses `-C` instead of `-C -C` for original
Junio C Hamanod3452a02008-11-15 08:07:551699location detection. It makes blame significantly faster on huge
1700repositories at the expense of less thorough copy detection.
1701
Junio C Hamano322c6242015-03-23 21:32:461702gui.copyBlameThreshold::
Junio C Hamano610d1762008-11-28 06:27:131703Specifies the threshold to use in 'git gui blame' original location
Junio C Hamanod3452a02008-11-15 08:07:551704detection, measured in alphanumeric characters. See the
1705linkgit:git-blame[1] manual for more information on copy detection.
1706
1707gui.blamehistoryctx::
1708Specifies the radius of history context in days to show in
1709linkgit:gitk[1] for the selected commit, when the `Show History
1710Context` menu item is invoked from 'git gui blame'. If this
1711variable is set to zero, the whole history is shown.
1712
Junio C Hamano92d312a2008-12-15 07:22:201713guitool.<name>.cmd::
1714Specifies the shell command line to execute when the corresponding item
1715of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1716mandatory for every tool. The command is executed from the root of
1717the working directory, and in the environment it receives the name of
Junio C Hamano042f2142016-06-27 18:05:051718the tool as `GIT_GUITOOL`, the name of the currently selected file as
Junio C Hamano92d312a2008-12-15 07:22:201719'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1720the head is detached, 'CUR_BRANCH' is empty).
1721
Junio C Hamano322c6242015-03-23 21:32:461722guitool.<name>.needsFile::
Junio C Hamano92d312a2008-12-15 07:22:201723Run the tool only if a diff is selected in the GUI. It guarantees
1724that 'FILENAME' is not empty.
1725
Junio C Hamano322c6242015-03-23 21:32:461726guitool.<name>.noConsole::
Junio C Hamano92d312a2008-12-15 07:22:201727Run the command silently, without creating a window to display its
1728output.
1729
Junio C Hamano322c6242015-03-23 21:32:461730guitool.<name>.noRescan::
Junio C Hamano92d312a2008-12-15 07:22:201731Don't rescan the working directory for changes after the tool
1732finishes execution.
1733
1734guitool.<name>.confirm::
1735Show a confirmation dialog before actually running the tool.
1736
Junio C Hamano322c6242015-03-23 21:32:461737guitool.<name>.argPrompt::
Junio C Hamano92d312a2008-12-15 07:22:201738Request a string argument from the user, and pass it to the tool
Junio C Hamano042f2142016-06-27 18:05:051739through the `ARGS` environment variable. Since requesting an
Junio C Hamano92d312a2008-12-15 07:22:201740argument implies confirmation, the 'confirm' option has no effect
1741if this is enabled. If the option is set to 'true', 'yes', or '1',
1742the dialog uses a built-in generic prompt; otherwise the exact
1743value of the variable is used.
1744
Junio C Hamano322c6242015-03-23 21:32:461745guitool.<name>.revPrompt::
Junio C Hamano92d312a2008-12-15 07:22:201746Request a single valid revision from the user, and set the
Junio C Hamano042f2142016-06-27 18:05:051747`REVISION` environment variable. In other aspects this option
Junio C Hamano322c6242015-03-23 21:32:461748is similar to 'argPrompt', and can be used together with it.
Junio C Hamano92d312a2008-12-15 07:22:201749
Junio C Hamano322c6242015-03-23 21:32:461750guitool.<name>.revUnmerged::
1751Show only unmerged branches in the 'revPrompt' subdialog.
Junio C Hamano92d312a2008-12-15 07:22:201752This is useful for tools similar to merge or rebase, but not
1753for things like checkout or reset.
1754
1755guitool.<name>.title::
1756Specifies the title to use for the prompt dialog. The default
1757is the tool name.
1758
1759guitool.<name>.prompt::
1760Specifies the general prompt string to display at the top of
Junio C Hamano322c6242015-03-23 21:32:461761the dialog, before subsections for 'argPrompt' and 'revPrompt'.
Junio C Hamano92d312a2008-12-15 07:22:201762The default value includes the actual command.
1763
Junio C Hamano4e272312008-01-08 09:13:211764help.browser::
1765Specify the browser that will be used to display help in the
1766'web' format. See linkgit:git-help[1].
1767
1768help.format::
1769Override the default help format used by linkgit:git-help[1].
1770Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1771the default. 'web' and 'html' are the same.
1772
Junio C Hamano322c6242015-03-23 21:32:461773help.autoCorrect::
Junio C Hamanof24b8062008-09-09 01:34:391774Automatically correct and execute mistyped commands after
1775waiting for the given number of deciseconds (0.1 sec). If more
1776than one command can be deduced from the entered text, nothing
1777will be executed. If the value of this option is negative,
1778the corrected command will be executed immediately. If the
1779value is 0 - the command will be just shown but not executed.
1780This is the default.
1781
Junio C Hamano322c6242015-03-23 21:32:461782help.htmlPath::
Junio C Hamano5dd5fae2013-01-18 21:06:491783Specify the path where the HTML documentation resides. File system paths
1784and URLs are supported. HTML pages will be prefixed with this path when
1785help is displayed in the 'web' format. This defaults to the documentation
1786path of your Git installation.
1787
Junio C Hamano58256872007-12-04 08:31:131788http.proxy::
Junio C Hamano3dd93922012-03-05 07:49:111789Override the HTTP proxy, normally configured using the 'http_proxy',
Junio C Hamanoffe10ca2016-02-04 00:44:231790'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1791addition to the syntax understood by curl, it is possible to specify a
1792proxy string with a user name but no password, in which case git will
1793attempt to acquire one in the same way it does for other credentials. See
1794linkgit:gitcredentials[7] for more information. The syntax thus is
1795'[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1796on a per-remote basis; see remote.<name>.proxy
1797
1798http.proxyAuthMethod::
1799Set the method with which to authenticate against the HTTP proxy. This
1800only takes effect if the configured proxy string contains a user name part
1801(i.e. is of the form 'user@host' or 'user@host:port'). This can be
1802overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
Junio C Hamano042f2142016-06-27 18:05:051803Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
Junio C Hamanoffe10ca2016-02-04 00:44:231804variable. Possible values are:
1805+
1806--
1807* `anyauth` - Automatically pick a suitable authentication method. It is
1808 assumed that the proxy answers an unauthenticated request with a 407
1809 status code and one or more Proxy-authenticate headers with supported
1810 authentication methods. This is the default.
1811* `basic` - HTTP Basic authentication
1812* `digest` - HTTP Digest authentication; this prevents the password from being
1813 transmitted to the proxy in clear text
1814* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1815 of `curl(1)`)
1816* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1817--
Junio C Hamano58256872007-12-04 08:31:131818
Junio C Hamano3fcdd072016-02-24 23:41:081819http.emptyAuth::
1820Attempt authentication without seeking a username or password. This
1821can be used to attempt GSS-Negotiate authentication without specifying
1822a username in the URL, as libcurl normally requires a username for
1823authentication.
1824
Junio C Hamano34afdb22016-10-06 22:16:391825http.delegation::
1826Control GSSAPI credential delegation. The delegation is disabled
1827by default in libcurl since version 7.21.7. Set parameter to tell
1828the server what it is allowed to delegate when it comes to user
1829credentials. Used with GSS/kerberos. Possible values are:
1830+
1831--
1832* `none` - Don't allow any delegation.
1833* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
1834 Kerberos service ticket, which is a matter of realm policy.
1835* `always` - Unconditionally allow the server to delegate.
1836--
1837
1838
Junio C Hamanoccdabca2016-05-06 22:27:091839http.extraHeader::
1840Pass an additional HTTP header when communicating with a server. If
1841more than one such entry exists, all of them are added as extra
1842headers. To allow overriding the settings inherited from the system
1843config, an empty value will reset the extra headers to the empty list.
1844
Junio C Hamano322c6242015-03-23 21:32:461845http.cookieFile::
Junio C Hamano198b1f12016-05-17 22:27:241846The pathname of a file containing previously stored cookie lines,
1847which should be used
Junio C Hamano076ffcc2013-02-06 05:13:211848in the Git http session, if they match the server. The file format
Junio C Hamano4c4b0122011-06-30 01:19:321849of the file to read cookies from should be plain HTTP headers or
Junio C Hamano198b1f12016-05-17 22:27:241850the Netscape/Mozilla cookie file format (see `curl(1)`).
1851NOTE that the file specified with http.cookieFile is used only as
Junio C Hamano8eac2682013-09-09 22:35:201852input unless http.saveCookies is set.
1853
Junio C Hamano322c6242015-03-23 21:32:461854http.saveCookies::
Junio C Hamano8eac2682013-09-09 22:35:201855If set, store cookies received during requests to the file specified by
Junio C Hamano322c6242015-03-23 21:32:461856http.cookieFile. Has no effect if http.cookieFile is unset.
Junio C Hamano4c4b0122011-06-30 01:19:321857
Junio C Hamanoa1746be2015-08-26 23:07:071858http.sslVersion::
1859The SSL version to use when negotiating an SSL connection, if you
1860want to force the default. The available and default version
1861depend on whether libcurl was built against NSS or OpenSSL and the
1862particular configuration of the crypto library in use. Internally
1863this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1864documentation for more details on the format of this option and
1865for the ssl version supported. Actually the possible values of
1866this option are:
1867
1868- sslv2
1869- sslv3
1870- tlsv1
1871- tlsv1.0
1872- tlsv1.1
1873- tlsv1.2
1874
1875+
Junio C Hamano042f2142016-06-27 18:05:051876Can be overridden by the `GIT_SSL_VERSION` environment variable.
Junio C Hamanoa1746be2015-08-26 23:07:071877To force git to use libcurl's default ssl version and ignore any
Junio C Hamano042f2142016-06-27 18:05:051878explicit http.sslversion option, set `GIT_SSL_VERSION` to the
Junio C Hamanoa1746be2015-08-26 23:07:071879empty string.
1880
Junio C Hamano1dbca522015-05-22 20:48:551881http.sslCipherList::
1882 A list of SSL ciphers to use when negotiating an SSL connection.
1883 The available ciphers depend on whether libcurl was built against
1884 NSS or OpenSSL and the particular configuration of the crypto
1885 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1886 option; see the libcurl documentation for more details on the format
1887 of this list.
1888+
Junio C Hamano042f2142016-06-27 18:05:051889Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
Junio C Hamano1dbca522015-05-22 20:48:551890To force git to use libcurl's default cipher list and ignore any
Junio C Hamano042f2142016-06-27 18:05:051891explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
Junio C Hamano1dbca522015-05-22 20:48:551892empty string.
1893
Junio C Hamano07824ce2006-04-25 07:36:541894http.sslVerify::
1895Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano042f2142016-06-27 18:05:051896over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment
Junio C Hamano07824ce2006-04-25 07:36:541897variable.
1898
1899http.sslCert::
1900File containing the SSL certificate when fetching or pushing
Junio C Hamano042f2142016-06-27 18:05:051901over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
Junio C Hamano07824ce2006-04-25 07:36:541902variable.
1903
1904http.sslKey::
1905File containing the SSL private key when fetching or pushing
Junio C Hamano042f2142016-06-27 18:05:051906over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
Junio C Hamano07824ce2006-04-25 07:36:541907variable.
1908
Junio C Hamano48bc1ce2009-07-09 16:49:191909http.sslCertPasswordProtected::
Junio C Hamano076ffcc2013-02-06 05:13:211910Enable Git's password prompt for the SSL certificate. Otherwise
Junio C Hamano48bc1ce2009-07-09 16:49:191911OpenSSL will prompt the user, possibly many times, if the
1912certificate or private key is encrypted. Can be overridden by the
Junio C Hamano042f2142016-06-27 18:05:051913`GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
Junio C Hamano48bc1ce2009-07-09 16:49:191914
Junio C Hamano07824ce2006-04-25 07:36:541915http.sslCAInfo::
1916File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:481917fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano042f2142016-06-27 18:05:051918`GIT_SSL_CAINFO` environment variable.
Junio C Hamano07824ce2006-04-25 07:36:541919
1920http.sslCAPath::
1921Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:451922with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano042f2142016-06-27 18:05:051923by the `GIT_SSL_CAPATH` environment variable.
Junio C Hamano07824ce2006-04-25 07:36:541924
Junio C Hamano3fcdd072016-02-24 23:41:081925http.pinnedpubkey::
1926Public key of the https service. It may either be the filename of
1927a PEM or DER encoded public key file or a string starting with
1928'sha256//' followed by the base64 encoded sha256 hash of the
1929public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
1930exit with an error if this option is set but not supported by
1931cURL.
1932
Junio C Hamano76927822013-04-19 21:26:571933http.sslTry::
1934Attempt to use AUTH SSL/TLS and encrypted data transfers
1935when connecting via regular FTP protocol. This might be needed
1936if the FTP server requires it for security reasons or you wish
1937to connect securely whenever remote FTP server supports it.
1938Default is false since it might trigger certificate verification
1939errors on misconfigured servers.
1940
Junio C Hamano07824ce2006-04-25 07:36:541941http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:481942How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano042f2142016-06-27 18:05:051943by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
Junio C Hamano07824ce2006-04-25 07:36:541944
Junio C Hamanob141a922010-01-10 19:55:141945http.minSessions::
1946The number of curl sessions (counted across slots) to be kept across
1947requests. They will not be ended with curl_easy_cleanup() until
1948http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1949value will be capped at 1. Defaults to 1.
1950
Junio C Hamano3b70d3c2009-11-21 17:37:371951http.postBuffer::
1952Maximum size in bytes of the buffer used by smart HTTP
1953transports when POSTing data to the remote system.
1954For requests larger than this buffer size, HTTP/1.1 and
1955Transfer-Encoding: chunked is used to avoid creating a
1956massive pack file locally. Default is 1 MiB, which is
1957sufficient for most requests.
1958
Junio C Hamano07824ce2006-04-25 07:36:541959http.lowSpeedLimit, http.lowSpeedTime::
1960If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1961for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano042f2142016-06-27 18:05:051962Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
1963`GIT_HTTP_LOW_SPEED_TIME` environment variables.
Junio C Hamano07824ce2006-04-25 07:36:541964
Junio C Hamanof1dcdfe2006-09-29 08:10:511965http.noEPSV::
1966A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:041967This can helpful with some "poor" ftp servers which don't
Junio C Hamano042f2142016-06-27 18:05:051968support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
Junio C Hamanof1dcdfe2006-09-29 08:10:511969environment variable. Default is false (curl will use EPSV).
1970
Junio C Hamano322c6242015-03-23 21:32:461971http.userAgent::
Junio C Hamano53ba6d02010-08-22 07:25:121972The HTTP USER_AGENT string presented to an HTTP server. The default
Junio C Hamano076ffcc2013-02-06 05:13:211973value represents the version of the client Git such as git/1.7.1.
Junio C Hamano53ba6d02010-08-22 07:25:121974This option allows you to override this value to a more common value
1975such as Mozilla/4.0. This may be necessary, for instance, if
1976connecting through a firewall that restricts HTTP connections to a set
1977of common USER_AGENT strings (but not including those like git/1.7.1).
Junio C Hamano042f2142016-06-27 18:05:051978Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
Junio C Hamano53ba6d02010-08-22 07:25:121979
Junio C Hamano52b1cfb2016-12-20 00:18:361980http.followRedirects::
1981Whether git should follow HTTP redirects. If set to `true`, git
1982will transparently follow any redirect issued by a server it
1983encounters. If set to `false`, git will treat all redirects as
1984errors. If set to `initial`, git will follow redirects only for
1985the initial request to a remote, but not for subsequent
1986follow-up HTTP requests. Since git uses the redirected URL as
1987the base for the follow-up requests, this is generally
1988sufficient. The default is `initial`.
1989
Junio C Hamano8eac2682013-09-09 22:35:201990http.<url>.*::
Junio C Hamanofb5ffde2014-11-04 22:38:561991Any of the http.* options above can be applied selectively to some URLs.
Junio C Hamano8eac2682013-09-09 22:35:201992For a config key to match a URL, each element of the config key is
1993compared to that of the URL, in the following order:
1994+
1995--
1996. Scheme (e.g., `https` in `https://example.com/`). This field
1997 must match exactly between the config key and the URL.
1998
1999. Host/domain name (e.g., `example.com` in `https://example.com/`).
Junio C Hamanocbe0eb22017-02-27 23:37:492000 This field must match between the config key and the URL. It is
2001 possible to specify a `*` as part of the host name to match all subdomains
2002 at this level. `https://*.example.com/` for example would match
2003 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
Junio C Hamano8eac2682013-09-09 22:35:202004
2005. Port number (e.g., `8080` in `http://example.com:8080/`).
2006 This field must match exactly between the config key and the URL.
2007 Omitted port numbers are automatically converted to the correct
2008 default for the scheme before matching.
2009
2010. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2011 path field of the config key must match the path field of the URL
2012 either exactly or as a prefix of slash-delimited path elements. This means
2013 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
2014 match on a slash (`/`) boundary. Longer matches take precedence (so a config
2015 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2016 key with just path `foo/`).
2017
2018. User name (e.g., `user` in `https://user@example.com/repo.git`). If
2019 the config key has a user name it must match the user name in the
2020 URL exactly. If the config key does not have a user name, that
2021 config key will match a URL with any user name (including none),
2022 but at a lower precedence than a config key with a user name.
2023--
2024+
2025The list above is ordered by decreasing precedence; a URL that matches
2026a config key's path is preferred to one that matches its user name. For example,
2027if the URL is `https://user@example.com/foo/bar` a config key match of
2028`https://example.com/foo` will be preferred over a config key match of
2029`https://user@example.com`.
2030+
2031All URLs are normalized before attempting any matching (the password part,
2032if embedded in the URL, is always ignored for matching purposes) so that
Junio C Hamanofb5ffde2014-11-04 22:38:562033equivalent URLs that are simply spelled differently will match properly.
2034Environment variable settings always override any matches. The URLs that are
Junio C Hamano8eac2682013-09-09 22:35:202035matched against are those given directly to Git commands. This means any URLs
2036visited as a result of a redirection do not participate in matching.
2037
Junio C Hamanocbe0eb22017-02-27 23:37:492038ssh.variant::
2039Depending on the value of the environment variables `GIT_SSH` or
2040`GIT_SSH_COMMAND`, or the config setting `core.sshCommand`, Git
2041auto-detects whether to adjust its command-line parameters for use
2042with plink or tortoiseplink, as opposed to the default (OpenSSH).
2043+
2044The config variable `ssh.variant` can be set to override this auto-detection;
2045valid values are `ssh`, `plink`, `putty` or `tortoiseplink`. Any other value
2046will be treated as normal ssh. This setting can be overridden via the
2047environment variable `GIT_SSH_VARIANT`.
2048
Junio C Hamano07824ce2006-04-25 07:36:542049i18n.commitEncoding::
Junio C Hamano076ffcc2013-02-06 05:13:212050Character encoding the commit messages are stored in; Git itself
Junio C Hamano07824ce2006-04-25 07:36:542051does not care per se, but this information is necessary e.g. when
2052importing commits from emails or in the gitk graphical history
2053browser (and possibly at other places in the future or in other
Junio C Hamano35738e82008-01-07 07:55:462054porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Junio C Hamano07824ce2006-04-25 07:36:542055
Junio C Hamano51f92e22006-12-29 05:18:282056i18n.logOutputEncoding::
2057Character encoding the commit messages are converted to when
Junio C Hamano1aa40d22010-01-21 17:46:432058running 'git log' and friends.
Junio C Hamano51f92e22006-12-29 05:18:282059
Junio C Hamano4653c6f2008-11-26 22:50:202060imap::
2061The configuration variables in the 'imap' section are described
2062in linkgit:git-imap-send[1].
2063
Junio C Hamano81703b22014-03-14 22:00:272064index.version::
2065Specify the version with which new index files should be
2066initialized. This does not affect existing repositories.
2067
Junio C Hamano322c6242015-03-23 21:32:462068init.templateDir::
Junio C Hamanocaa712a2010-03-11 01:17:352069Specify the directory from which templates will be copied.
2070(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2071
Junio C Hamano4e272312008-01-08 09:13:212072instaweb.browser::
2073Specify the program that will be used to browse your working
2074repository in gitweb. See linkgit:git-instaweb[1].
2075
2076instaweb.httpd::
2077The HTTP daemon command-line to start gitweb on your working
2078repository. See linkgit:git-instaweb[1].
2079
2080instaweb.local::
2081If true the web server started by linkgit:git-instaweb[1] will
2082be bound to the local IP (127.0.0.1).
2083
Junio C Hamano322c6242015-03-23 21:32:462084instaweb.modulePath::
Junio C Hamano619596a2010-08-18 22:15:352085The default module path for linkgit:git-instaweb[1] to use
2086instead of /usr/lib/apache2/modules. Only used if httpd
2087is Apache.
Junio C Hamano4e272312008-01-08 09:13:212088
2089instaweb.port::
2090The port number to bind the gitweb httpd to. See
2091linkgit:git-instaweb[1].
2092
Junio C Hamano322c6242015-03-23 21:32:462093interactive.singleKey::
Junio C Hamano27a128b2009-08-13 01:23:002094In interactive commands, allow the user to provide one-letter
Junio C Hamanoe5bf6c12009-02-07 21:43:102095input with a single key (i.e., without hitting enter).
Junio C Hamanob76a6862012-05-02 22:02:462096Currently this is used by the `--patch` mode of
Junio C Hamano3d050d62011-05-17 06:43:342097linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2098linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2099setting is silently ignored if portable keystroke input
Junio C Hamano81703b22014-03-14 22:00:272100is not available; requires the Perl module Term::ReadKey.
Junio C Hamanoe5bf6c12009-02-07 21:43:102101
Junio C Hamano4ba4a782016-04-03 19:11:322102interactive.diffFilter::
2103When an interactive command (such as `git add --patch`) shows
2104a colorized diff, git will pipe the diff through the shell
2105command defined by this configuration variable. The command may
2106mark up the diff further for human consumption, provided that it
2107retains a one-to-one correspondence with the lines in the
2108original diff. Defaults to disabled (no filtering).
2109
Junio C Hamanof93530e2011-05-25 23:59:592110log.abbrevCommit::
2111If true, makes linkgit:git-log[1], linkgit:git-show[1], and
Junio C Hamanob76a6862012-05-02 22:02:462112linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2113override this option with `--no-abbrev-commit`.
Junio C Hamanof93530e2011-05-25 23:59:592114
Junio C Hamanob713ff12008-05-24 01:12:302115log.date::
Junio C Hamano2db3e752010-09-03 21:33:062116Set the default date-time mode for the 'log' command.
2117Setting a value for log.date is similar to using 'git log''s
Junio C Hamano1eb56092015-10-05 20:39:532118`--date` option. See linkgit:git-log[1] for details.
Junio C Hamanob713ff12008-05-24 01:12:302119
Junio C Hamanocb39aea2010-05-09 07:24:482120log.decorate::
2121Print out the ref names of any commits that are shown by the log
2122command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2123'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2124specified, the full ref name (including prefix) will be printed.
Junio C Hamano37cf4082016-05-30 01:22:142125If 'auto' is specified, then if the output is going to a terminal,
2126the ref names are shown as if 'short' were given, otherwise no ref
Junio C Hamano92d80372016-07-13 22:00:052127names are shown. This is the same as the `--decorate` option
Junio C Hamano37cf4082016-05-30 01:22:142128of the `git log`.
Junio C Hamanocb39aea2010-05-09 07:24:482129
Junio C Hamanob0a1e832015-10-15 23:08:312130log.follow::
2131If `true`, `git log` will act as if the `--follow` option was used when
2132a single <path> is given. This has the same limitations as `--follow`,
2133i.e. it cannot be used to follow multiple files and does not work well
2134on non-linear history.
2135
Junio C Hamanob86c8032017-02-02 21:50:192136log.graphColors::
2137A list of colors, separated by commas, that can be used to draw
2138history lines in `git log --graph`.
2139
Junio C Hamano322c6242015-03-23 21:32:462140log.showRoot::
Junio C Hamanofe9acab2006-11-24 12:10:552141If true, the initial commit will be shown as a big creation event.
2142This is equivalent to a diff against an empty tree.
Junio C Hamano35738e82008-01-07 07:55:462143Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Junio C Hamanofe9acab2006-11-24 12:10:552144normally hide the root commit will now show it. True by default.
2145
Junio C Hamanoce836cc2013-01-21 02:01:532146log.mailmap::
2147If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2148linkgit:git-whatchanged[1] assume `--use-mailmap`.
2149
Junio C Hamano7f1bc9d2015-03-05 22:38:262150mailinfo.scissors::
2151If true, makes linkgit:git-mailinfo[1] (and therefore
2152linkgit:git-am[1]) act by default as if the --scissors option
2153was provided on the command-line. When active, this features
2154removes everything from the message body before a scissors
2155line (i.e. consisting mainly of ">8", "8<" and "-").
2156
Junio C Hamano8bc410e2009-02-15 10:38:192157mailmap.file::
2158The location of an augmenting mailmap file. The default
2159mailmap, located in the root of the repository, is loaded
2160first, then the mailmap file pointed to by this variable.
2161The location of the mailmap file may be in a repository
2162subdirectory, or somewhere outside of the repository itself.
2163See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2164
Junio C Hamanoabad6da2013-01-06 09:06:322165mailmap.blob::
2166Like `mailmap.file`, but consider the value as a reference to a
2167blob in the repository. If both `mailmap.file` and
2168`mailmap.blob` are given, both are parsed, with entries from
2169`mailmap.file` taking precedence. In a bare repository, this
2170defaults to `HEAD:.mailmap`. In a non-bare repository, it
2171defaults to empty.
2172
Junio C Hamano8b588d52008-03-15 09:48:372173man.viewer::
2174Specify the programs that may be used to display help in the
2175'man' format. See linkgit:git-help[1].
2176
Junio C Hamano6d76d612008-05-09 05:46:082177man.<tool>.cmd::
2178Specify the command to invoke the specified man viewer. The
2179specified command is evaluated in shell with the man page
2180passed as argument. (See linkgit:git-help[1].)
Junio C Hamano103ad7f2007-03-14 11:19:262181
Junio C Hamano6d76d612008-05-09 05:46:082182man.<tool>.path::
2183Override the path for the given tool that may be used to
2184display help in the 'man' format. See linkgit:git-help[1].
Junio C Hamanoe90436a2007-04-22 07:22:132185
Junio C Hamano4653c6f2008-11-26 22:50:202186include::merge-config.txt[]
Junio C Hamanoa476efa2008-10-10 15:31:422187
Junio C Hamano1fbbbc12007-12-18 07:01:272188mergetool.<tool>.path::
2189Override the path for the given tool. This is useful in case
2190your tool is not in the PATH.
2191
Junio C Hamano86bcccc2008-03-08 09:33:552192mergetool.<tool>.cmd::
2193Specify the command to invoke the specified merge tool. The
2194specified command is evaluated in shell with the following
2195variables available: 'BASE' is the name of a temporary file
2196containing the common base of the files to be merged, if available;
2197'LOCAL' is the name of a temporary file containing the contents of
2198the file on the current branch; 'REMOTE' is the name of a temporary
2199file containing the contents of the file from the branch being
2200merged; 'MERGED' contains the name of the file to which the merge
2201tool should write the results of a successful merge.
2202
2203mergetool.<tool>.trustExitCode::
2204For a custom merge command, specify whether the exit code of
2205the merge command can be used to determine whether the merge was
2206successful. If this is not set to true then the merge target file
2207timestamp is checked and the merge assumed to have been successful
2208if the file has been updated, otherwise the user is prompted to
2209indicate the success of the merge.
2210
Junio C Hamanoe478e402014-10-21 22:14:452211mergetool.meld.hasOutput::
2212Older versions of `meld` do not support the `--output` option.
2213Git will attempt to detect whether `meld` supports `--output`
2214by inspecting the output of `meld --help`. Configuring
2215`mergetool.meld.hasOutput` will make Git skip these checks and
2216use the configured value instead. Setting `mergetool.meld.hasOutput`
2217to `true` tells Git to unconditionally use the `--output` option,
2218and `false` avoids using `--output`.
2219
Junio C Hamano86bcccc2008-03-08 09:33:552220mergetool.keepBackup::
2221After performing a merge, the original file with conflict markers
2222can be saved as a file with a `.orig` extension. If this variable
2223is set to `false` then this file is not preserved. Defaults to
2224`true` (i.e. keep the backup files).
2225
Junio C Hamano10b7a342009-01-01 22:05:172226mergetool.keepTemporaries::
Junio C Hamano076ffcc2013-02-06 05:13:212227When invoking a custom merge tool, Git uses a set of temporary
Junio C Hamano10b7a342009-01-01 22:05:172228files to pass to the tool. If the tool returns an error and this
2229variable is set to `true`, then these temporary files will be
2230preserved, otherwise they will be removed after the tool has
2231exited. Defaults to `false`.
2232
Junio C Hamanoe478e402014-10-21 22:14:452233mergetool.writeToTemp::
2234Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2235conflicting files in the worktree by default. Git will attempt
2236to use a temporary directory for these files when set `true`.
2237Defaults to `false`.
2238
Junio C Hamano10b7a342009-01-01 22:05:172239mergetool.prompt::
2240Prompt before each invocation of the merge resolution program.
2241
Junio C Hamano3891e252015-08-31 23:06:132242notes.mergeStrategy::
2243Which merge strategy to choose by default when resolving notes
2244conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2245`cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2246section of linkgit:git-notes[1] for more information on each strategy.
2247
2248notes.<name>.mergeStrategy::
2249Which merge strategy to choose when doing a notes merge into
2250refs/notes/<name>. This overrides the more general
2251"notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2252linkgit:git-notes[1] for more information on the available strategies.
2253
Junio C Hamano31667362010-03-25 00:38:532254notes.displayRef::
2255The (fully qualified) refname from which to show notes when
2256showing commit messages. The value of this variable can be set
2257to a glob, in which case notes from all matching refs will be
2258shown. You may also specify this configuration variable
2259several times. A warning will be issued for refs that do not
2260exist, but a glob that does not match any refs is silently
2261ignored.
2262+
2263This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2264environment variable, which must be a colon separated list of refs or
2265globs.
2266+
2267The effective value of "core.notesRef" (possibly overridden by
2268GIT_NOTES_REF) is also implicitly added to the list of refs to be
2269displayed.
2270
2271notes.rewrite.<command>::
2272When rewriting commits with <command> (currently `amend` or
Junio C Hamano076ffcc2013-02-06 05:13:212273`rebase`) and this variable is set to `true`, Git
Junio C Hamano31667362010-03-25 00:38:532274automatically copies your notes from the original to the
2275rewritten commit. Defaults to `true`, but see
2276"notes.rewriteRef" below.
Junio C Hamano31667362010-03-25 00:38:532277
2278notes.rewriteMode::
2279When copying notes during a rewrite (see the
2280"notes.rewrite.<command>" option), determines what to do if
2281the target commit already has a note. Must be one of
Junio C Hamano3891e252015-08-31 23:06:132282`overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2283Defaults to `concatenate`.
Junio C Hamano31667362010-03-25 00:38:532284+
2285This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2286environment variable.
2287
2288notes.rewriteRef::
2289When copying notes during a rewrite, specifies the (fully
2290qualified) ref whose notes should be copied. The ref may be a
2291glob, in which case notes in all matching refs will be copied.
2292You may also specify this configuration several times.
2293+
2294Does not have a default value; you must configure this variable to
Junio C Hamano8fb66e52011-10-05 20:59:512295enable note rewriting. Set it to `refs/notes/commits` to enable
2296rewriting for the default commit notes.
Junio C Hamano2b3ee5d2010-05-08 05:41:182297+
2298This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2299environment variable, which must be a colon separated list of refs or
2300globs.
Junio C Hamano31667362010-03-25 00:38:532301
Junio C Hamano75cc4c92006-07-24 08:25:032302pack.window::
Junio C Hamano35738e82008-01-07 07:55:462303The size of the window used by linkgit:git-pack-objects[1] when no
Junio C Hamano75cc4c92006-07-24 08:25:032304window size is given on the command line. Defaults to 10.
2305
Junio C Hamano91d44c52007-05-09 07:16:072306pack.depth::
Junio C Hamano35738e82008-01-07 07:55:462307The maximum delta depth used by linkgit:git-pack-objects[1] when no
Junio C Hamano91d44c52007-05-09 07:16:072308maximum depth is given on the command line. Defaults to 50.
2309
Junio C Hamano235d53f2007-07-13 00:25:152310pack.windowMemory::
Junio C Hamano2a4bcbc2014-10-29 20:07:392311The maximum size of memory that is consumed by each thread
2312in linkgit:git-pack-objects[1] for pack window memory when
2313no limit is given on the command line. The value can be
2314suffixed with "k", "m", or "g". When left unconfigured (or
2315set explicitly to 0), there will be no limit.
Junio C Hamano235d53f2007-07-13 00:25:152316
Junio C Hamanof2ce2972007-05-20 19:12:092317pack.compression::
2318An integer -1..9, indicating the compression level for objects
2319in a pack file. -1 is the zlib default. 0 means no
2320compression, and 1..9 are various speed/size tradeoffs, 9 being
2321slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:422322not set, defaults to -1, the zlib default, which is "a default
2323compromise between speed and compression (currently equivalent
2324to level 6)."
Junio C Hamano657fd8a2010-10-07 00:01:242325+
2326Note that changing the compression level will not automatically recompress
2327all existing objects. You can force recompression by passing the -F option
2328to linkgit:git-repack[1].
Junio C Hamanof2ce2972007-05-20 19:12:092329
Junio C Hamano679d22d2007-06-02 21:13:442330pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:272331The maximum memory in bytes used for caching deltas in
Junio C Hamano9f883862009-08-11 06:23:522332linkgit:git-pack-objects[1] before writing them out to a pack.
2333This cache is used to speed up the writing object phase by not
2334having to recompute the final delta result once the best match
2335for all objects is found. Repacking large repositories on machines
2336which are tight with memory might be badly impacted by this though,
2337especially if this cache pushes the system into swapping.
2338A value of 0 means no limit. The smallest size of 1 byte may be
2339used to virtually disable this cache. Defaults to 256 MiB.
Junio C Hamano679d22d2007-06-02 21:13:442340
2341pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:142342The maximum size of a delta, that is cached in
Junio C Hamano9f883862009-08-11 06:23:522343linkgit:git-pack-objects[1]. This cache is used to speed up the
2344writing object phase by not having to recompute the final delta
2345result once the best match for all objects is found. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:442346
Junio C Hamano58155b42007-09-15 07:46:142347pack.threads::
2348Specifies the number of threads to spawn when searching for best
Junio C Hamano35738e82008-01-07 07:55:462349delta matches. This requires that linkgit:git-pack-objects[1]
Junio C Hamano58155b42007-09-15 07:46:142350be compiled with pthreads otherwise this option is ignored with a
2351warning. This is meant to reduce packing time on multiprocessor
2352machines. The required amount of memory for the delta search window
2353is however multiplied by the number of threads.
Junio C Hamano076ffcc2013-02-06 05:13:212354Specifying 0 will cause Git to auto-detect the number of CPU's
Junio C Hamano24bc09a2008-02-28 00:27:442355and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:142356
Junio C Hamanod814b6d2007-11-04 11:13:492357pack.indexVersion::
2358Specify the default pack index version. Valid values are 1 for
2359legacy pack index used by Git versions prior to 1.5.2, and 2 for
2360the new pack index with capabilities for packs larger than 4 GB
2361as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:382362packs. Version 2 is the default. Note that version 2 is enforced
2363and this config option ignored whenever the corresponding pack is
2364larger than 2 GB.
2365+
Junio C Hamano076ffcc2013-02-06 05:13:212366If you have an old Git that does not understand the version 2 `*.idx` file,
Junio C Hamanof85ef632016-02-17 22:31:062367cloning or fetching over a non native protocol (e.g. "http")
Junio C Hamanob76a6862012-05-02 22:02:462368that will copy both `*.pack` file and corresponding `*.idx` file from the
Junio C Hamanofce7c7e2008-07-02 03:06:382369other side may give you a repository that cannot be accessed with your
Junio C Hamano076ffcc2013-02-06 05:13:212370older version of Git. If the `*.pack` file is smaller than 2 GB, however,
Junio C Hamanofce7c7e2008-07-02 03:06:382371you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
Junio C Hamanob76a6862012-05-02 22:02:462372the `*.idx` file.
Junio C Hamanod814b6d2007-11-04 11:13:492373
Junio C Hamano09a926d2008-03-13 07:55:292374pack.packSizeLimit::
Junio C Hamano4d979582010-02-04 06:27:292375The maximum size of a pack. This setting only affects
2376packing to a file when repacking, i.e. the git:// protocol
Junio C Hamanob76a6862012-05-02 22:02:462377is unaffected. It can be overridden by the `--max-pack-size`
Junio C Hamano74fd0fc2016-05-10 21:23:562378option of linkgit:git-repack[1]. Reaching this limit results
2379in the creation of multiple packfiles; which in turn prevents
2380bitmaps from being created.
2381The minimum size allowed is limited to 1 MiB.
2382The default is unlimited.
Junio C Hamano4d979582010-02-04 06:27:292383Common unit suffixes of 'k', 'm', or 'g' are
2384supported.
Junio C Hamano49dccaf2008-02-10 10:48:012385
Junio C Hamano5b3533d2014-02-27 23:07:152386pack.useBitmaps::
2387When true, git will use pack bitmaps (if available) when packing
2388to stdout (e.g., during the server side of a fetch). Defaults to
2389true. You should not generally need to turn this off unless
2390you are debugging pack bitmaps.
2391
Junio C Hamano322c6242015-03-23 21:32:462392pack.writeBitmaps (deprecated)::
Junio C Hamano38d02532014-06-26 21:48:502393This is a deprecated synonym for `repack.writeBitmaps`.
Junio C Hamano5b3533d2014-02-27 23:07:152394
2395pack.writeBitmapHashCache::
2396When true, git will include a "hash cache" section in the bitmap
2397index (if one is written). This cache can be used to feed git's
2398delta heuristics, potentially leading to better deltas between
2399bitmapped and non-bitmapped objects (e.g., when serving a fetch
2400between an older, bitmapped pack and objects that have been
2401pushed since the last gc). The downside is that it consumes 4
2402bytes per object of disk space, and that JGit's bitmap
2403implementation does not understand it, causing it to complain if
2404Git and JGit are used on the same repository. Defaults to false.
2405
Junio C Hamano9e96a1a2008-08-16 10:23:182406pager.<cmd>::
Junio C Hamano788eeba2010-12-08 22:50:432407If the value is boolean, turns on or off pagination of the
Junio C Hamano076ffcc2013-02-06 05:13:212408output of a particular Git subcommand when writing to a tty.
Junio C Hamano788eeba2010-12-08 22:50:432409Otherwise, turns on pagination for the subcommand using the
Junio C Hamanob76a6862012-05-02 22:02:462410pager specified by the value of `pager.<cmd>`. If `--paginate`
2411or `--no-pager` is specified on the command line, it takes
Junio C Hamano788eeba2010-12-08 22:50:432412precedence over this option. To disable pagination for all
2413commands, set `core.pager` or `GIT_PAGER` to `cat`.
Junio C Hamano9e96a1a2008-08-16 10:23:182414
Junio C Hamanoa574a092010-06-13 19:57:102415pretty.<name>::
2416Alias for a --pretty= format string, as specified in
2417linkgit:git-log[1]. Any aliases defined here can be used just
2418as the built-in pretty formats could. For example,
Junio C Hamanob76a6862012-05-02 22:02:462419running `git config pretty.changelog "format:* %H %s"`
Junio C Hamanoa574a092010-06-13 19:57:102420would cause the invocation `git log --pretty=changelog`
Junio C Hamanob76a6862012-05-02 22:02:462421to be equivalent to running `git log "--pretty=format:* %H %s"`.
Junio C Hamanoa574a092010-06-13 19:57:102422Note that an alias with the same name as a built-in format
2423will be silently ignored.
2424
Junio C Hamano9e35abf2016-12-27 22:37:272425protocol.allow::
2426If set, provide a user defined default policy for all protocols which
2427don't explicitly have a policy (`protocol.<name>.allow`). By default,
2428if unset, known-safe protocols (http, https, git, ssh, file) have a
2429default policy of `always`, known-dangerous protocols (ext) have a
2430default policy of `never`, and all other protocols have a default
2431policy of `user`. Supported policies:
2432+
2433--
2434
2435* `always` - protocol is always able to be used.
2436
2437* `never` - protocol is never able to be used.
2438
2439* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2440 either unset or has a value of 1. This policy should be used when you want a
2441 protocol to be directly usable by the user but don't want it used by commands which
2442 execute clone/fetch/push commands without user input, e.g. recursive
2443 submodule initialization.
2444
2445--
2446
2447protocol.<name>.allow::
2448Set a policy to be used by protocol `<name>` with clone/fetch/push
2449commands. See `protocol.allow` above for the available policies.
2450+
2451The protocol names currently used by git are:
2452+
2453--
2454 - `file`: any local file-based path (including `file://` URLs,
2455 or local paths)
2456
2457 - `git`: the anonymous git protocol over a direct TCP
2458 connection (or proxy, if configured)
2459
2460 - `ssh`: git over ssh (including `host:path` syntax,
2461 `ssh://`, etc).
2462
2463 - `http`: git over http, both "smart http" and "dumb http".
2464 Note that this does _not_ include `https`; if you want to configure
2465 both, you must do so individually.
2466
2467 - any external helpers are named by their protocol (e.g., use
2468 `hg` to allow the `git-remote-hg` helper)
2469--
2470
Junio C Hamano5b3533d2014-02-27 23:07:152471pull.ff::
2472By default, Git does not create an extra merge commit when merging
2473a commit that is a descendant of the current commit. Instead, the
2474tip of the current branch is fast-forwarded. When set to `false`,
2475this variable tells Git to create an extra merge commit in such
2476a case (equivalent to giving the `--no-ff` option from the command
2477line). When set to `only`, only such fast-forward merges are
2478allowed (equivalent to giving the `--ff-only` option from the
Junio C Hamanoc4e2a202015-05-26 21:38:472479command line). This setting overrides `merge.ff` when pulling.
Junio C Hamano5b3533d2014-02-27 23:07:152480
Junio C Hamano515ab1d2011-12-09 23:41:202481pull.rebase::
2482When true, rebase branches on top of the fetched branch, instead
2483of merging the default branch from the default remote when "git
2484pull" is run. See "branch.<name>.rebase" for setting this on a
2485per-branch basis.
2486+
Junio C Hamano7db630e2015-09-17 20:26:222487When preserve, also pass `--preserve-merges` along to 'git rebase'
2488so that locally committed merge commits will not be flattened
2489by running 'git pull'.
Junio C Hamanocf4a1742013-09-11 22:57:502490+
Junio C Hamano289d7e82016-01-27 00:20:382491When the value is `interactive`, the rebase is run in interactive mode.
2492+
Junio C Hamano515ab1d2011-12-09 23:41:202493*NOTE*: this is a possibly dangerous operation; do *not* use
2494it unless you understand the implications (see linkgit:git-rebase[1]
2495for details).
2496
Junio C Hamano07824ce2006-04-25 07:36:542497pull.octopus::
2498The default merge strategy to use when pulling multiple branches
2499at once.
2500
2501pull.twohead::
2502The default merge strategy to use when pulling a single branch.
2503
Junio C Hamano1de75722009-03-26 08:39:382504push.default::
Junio C Hamano58655592013-07-11 20:52:332505Defines the action `git push` should take if no refspec is
2506explicitly given. Different values are well-suited for
2507specific workflows; for instance, in a purely central workflow
2508(i.e. the fetch source is equal to the push destination),
2509`upstream` is probably what you want. Possible values are:
Junio C Hamano1de75722009-03-26 08:39:382510+
Junio C Hamanobcaa8bc2012-07-03 22:17:202511--
Junio C Hamano58655592013-07-11 20:52:332512
2513* `nothing` - do not push anything (error out) unless a refspec is
2514 explicitly given. This is primarily meant for people who want to
2515 avoid mistakes by always being explicit.
2516
2517* `current` - push the current branch to update a branch with the same
2518 name on the receiving end. Works in both central and non-central
2519 workflows.
2520
2521* `upstream` - push the current branch back to the branch whose
2522 changes are usually integrated into the current branch (which is
2523 called `@{upstream}`). This mode only makes sense if you are
2524 pushing to the same repository you would normally pull from
2525 (i.e. central workflow).
2526
Junio C Hamanocb06ef92017-03-21 22:40:142527* `tracking` - This is a deprecated synonym for `upstream`.
2528
Junio C Hamano58655592013-07-11 20:52:332529* `simple` - in centralized workflow, work like `upstream` with an
2530 added safety to refuse to push if the upstream branch's name is
2531 different from the local one.
Junio C Hamanobcaa8bc2012-07-03 22:17:202532+
Junio C Hamano58655592013-07-11 20:52:332533When pushing to a remote that is different from the remote you normally
2534pull from, work as `current`. This is the safest option and is suited
2535for beginners.
2536+
Junio C Hamano1d669b82014-03-11 21:36:002537This mode has become the default in Git 2.0.
Junio C Hamano58655592013-07-11 20:52:332538
2539* `matching` - push all branches having the same name on both ends.
2540 This makes the repository you are pushing to remember the set of
2541 branches that will be pushed out (e.g. if you always push 'maint'
2542 and 'master' there and no other branches, the repository you push
2543 to will have these two branches, and your local 'maint' and
2544 'master' will be pushed there).
2545+
2546To use this mode effectively, you have to make sure _all_ the
2547branches you would push out are ready to be pushed out before
2548running 'git push', as the whole point of this mode is to allow you
2549to push all of the branches in one go. If you usually finish work
2550on only one branch and push out the result, while other branches are
2551unfinished, this mode is not for you. Also this mode is not
2552suitable for pushing into a shared central repository, as other
2553people may add new branches there, or update the tip of existing
2554branches outside your control.
2555+
Junio C Hamano1d669b82014-03-11 21:36:002556This used to be the default, but not since Git 2.0 (`simple` is the
2557new default).
Junio C Hamano58655592013-07-11 20:52:332558
2559--
Junio C Hamano1de75722009-03-26 08:39:382560
Junio C Hamano322c6242015-03-23 21:32:462561push.followTags::
Junio C Hamano92d80372016-07-13 22:00:052562If set to true enable `--follow-tags` option by default. You
Junio C Hamano322c6242015-03-23 21:32:462563may override this configuration at time of push by specifying
Junio C Hamano92d80372016-07-13 22:00:052564`--no-follow-tags`.
Junio C Hamano322c6242015-03-23 21:32:462565
Junio C Hamano3891e252015-08-31 23:06:132566push.gpgSign::
2567May be set to a boolean value, or the string 'if-asked'. A true
Junio C Hamano92d80372016-07-13 22:00:052568value causes all pushes to be GPG signed, as if `--signed` is
Junio C Hamano3891e252015-08-31 23:06:132569passed to linkgit:git-push[1]. The string 'if-asked' causes
2570pushes to be signed if the server supports it, as if
Junio C Hamano92d80372016-07-13 22:00:052571`--signed=if-asked` is passed to 'git push'. A false value may
Junio C Hamano3891e252015-08-31 23:06:132572override a value from a lower-priority config file. An explicit
2573command-line flag always overrides this config option.
Junio C Hamano322c6242015-03-23 21:32:462574
Junio C Hamano409a33a2015-12-22 23:45:232575push.recurseSubmodules::
2576Make sure all submodule commits used by the revisions to be pushed
2577are available on a remote-tracking branch. If the value is 'check'
2578then Git will verify that all submodule commits that changed in the
2579revisions to be pushed are available on at least one remote of the
2580submodule. If any commits are missing, the push will be aborted and
2581exit with non-zero status. If the value is 'on-demand' then all
2582submodules that changed in the revisions to be pushed will be
2583pushed. If on-demand was not able to push all necessary revisions
2584it will also be aborted and exit with non-zero status. If the value
2585is 'no' then default behavior of ignoring submodules when pushing
2586is retained. You may override this configuration at time of push by
2587specifying '--recurse-submodules=check|on-demand|no'.
2588
Junio C Hamanoea6a7642009-03-11 23:56:192589rebase.stat::
2590Whether to show a diffstat of what changed upstream since the last
2591rebase. False by default.
2592
Junio C Hamano322c6242015-03-23 21:32:462593rebase.autoSquash::
Junio C Hamano92d80372016-07-13 22:00:052594If set to true enable `--autosquash` option by default.
Junio C Hamano075ae872010-09-01 18:43:072595
Junio C Hamano322c6242015-03-23 21:32:462596rebase.autoStash::
Junio C Hamanof1f5a7b2013-06-11 22:23:522597When set to true, automatically create a temporary stash
2598before the operation begins, and apply it after the operation
2599ends. This means that you can run rebase on a dirty worktree.
2600However, use with care: the final stash application after a
2601successful rebase might result in non-trivial conflicts.
2602Defaults to false.
2603
Junio C Hamanod7ed4042015-08-03 19:43:002604rebase.missingCommitsCheck::
2605If set to "warn", git rebase -i will print a warning if some
2606commits are removed (e.g. a line was deleted), however the
2607rebase will still proceed. If set to "error", it will print
2608the previous warning and stop the rebase, 'git rebase
2609--edit-todo' can then be used to correct the error. If set to
2610"ignore", no checking is done.
2611To drop a commit without warning or error, use the `drop`
2612command in the todo-list.
2613Defaults to "ignore".
2614
Junio C Hamanof2f28b12016-10-31 21:41:582615rebase.instructionFormat::
Junio C Hamanod7ed4042015-08-03 19:43:002616A format string, as specified in linkgit:git-log[1], to be used for
2617the instruction list during an interactive rebase. The format will automatically
2618have the long commit hash prepended to the format.
2619
Junio C Hamano322c6242015-03-23 21:32:462620receive.advertiseAtomic::
Junio C Hamano6bb32e62015-02-17 22:11:262621By default, git-receive-pack will advertise the atomic push
Junio C Hamanoe48a1132016-08-03 22:40:212622capability to its clients. If you don't want to advertise this
2623capability, set this variable to false.
2624
2625receive.advertisePushOptions::
Junio C Hamanod3ab1ad2017-05-23 06:52:182626When set to true, git-receive-pack will advertise the push options
2627capability to its clients. False by default.
Junio C Hamano6bb32e62015-02-17 22:11:262628
Junio C Hamano621e1232009-10-26 05:16:472629receive.autogc::
2630By default, git-receive-pack will run "git-gc --auto" after
2631receiving data from git-push and updating refs. You can stop
2632it by setting this variable to false.
2633
Junio C Hamano322c6242015-03-23 21:32:462634receive.certNonceSeed::
Junio C Hamano9236fea2014-10-14 22:28:092635By setting this variable to a string, `git receive-pack`
2636will accept a `git push --signed` and verifies it by using
2637a "nonce" protected by HMAC using this string as a secret
2638key.
2639
Junio C Hamano322c6242015-03-23 21:32:462640receive.certNonceSlop::
Junio C Hamano9236fea2014-10-14 22:28:092641When a `git push --signed` sent a push certificate with a
2642"nonce" that was issued by a receive-pack serving the same
2643repository within this many seconds, export the "nonce"
2644found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2645hooks (instead of what the receive-pack asked the sending
2646side to include). This may allow writing checks in
2647`pre-receive` and `post-receive` a bit easier. Instead of
2648checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2649that records by how many seconds the nonce is stale to
2650decide if they want to accept the certificate, they only
2651can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2652
Junio C Hamano4653c6f2008-11-26 22:50:202653receive.fsckObjects::
2654If it is set to true, git-receive-pack will check all received
2655objects. It will abort in the case of a malformed object or a
2656broken link. The result of an abort are only dangling objects.
Junio C Hamano8fb66e52011-10-05 20:59:512657Defaults to false. If not set, the value of `transfer.fsckObjects`
2658is used instead.
Junio C Hamano4653c6f2008-11-26 22:50:202659
Junio C Hamanod7ed4042015-08-03 19:43:002660receive.fsck.<msg-id>::
2661When `receive.fsckObjects` is set to true, errors can be switched
2662to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2663setting where the `<msg-id>` is the fsck message ID and the value
2664is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2665the error/warning with the message ID, e.g. "missingEmail: invalid
2666author/committer line - missing email" means that setting
2667`receive.fsck.missingEmail = ignore` will hide that issue.
2668+
2669This feature is intended to support working with legacy repositories
2670which would not pass pushing when `receive.fsckObjects = true`, allowing
2671the host to accept repositories with certain known issues but still catch
2672other issues.
2673
2674receive.fsck.skipList::
2675The path to a sorted list of object names (i.e. one SHA-1 per
2676line) that are known to be broken in a non-fatal way and should
2677be ignored. This feature is useful when an established project
2678should be accepted despite early commits containing errors that
2679can be safely ignored such as invalid committer email addresses.
2680Note: corrupt objects cannot be skipped with this setting.
2681
Junio C Hamanoe48a1132016-08-03 22:40:212682receive.keepAlive::
2683After receiving the pack from the client, `receive-pack` may
2684produce no output (if `--quiet` was specified) while processing
2685the pack, causing some networks to drop the TCP connection.
2686With this option set, if `receive-pack` does not transmit
2687any data in this phase for `receive.keepAlive` seconds, it will
2688send a short keepalive packet. The default is 5 seconds; set
2689to 0 to disable keepalives entirely.
2690
Junio C Hamano4653c6f2008-11-26 22:50:202691receive.unpackLimit::
2692If the number of objects received in a push is below this
2693limit then the objects will be unpacked into loose object
2694files. However if the number of received objects equals or
2695exceeds this limit then the received pack will be stored as
2696a pack, after adding any missing delta bases. Storing the
2697pack from a push can make the push operation complete faster,
2698especially on slow filesystems. If not set, the value of
2699`transfer.unpackLimit` is used instead.
2700
Junio C Hamanocd451662016-09-13 00:54:092701receive.maxInputSize::
2702If the size of the incoming pack stream is larger than this
2703limit, then git-receive-pack will error out, instead of
2704accepting the pack file. If not set or set to 0, then the size
2705is unlimited.
2706
Junio C Hamano4653c6f2008-11-26 22:50:202707receive.denyDeletes::
2708If set to true, git-receive-pack will deny a ref update that deletes
2709the ref. Use this to prevent such a ref deletion via a push.
2710
Junio C Hamanob4448a82010-07-26 09:02:322711receive.denyDeleteCurrent::
2712If set to true, git-receive-pack will deny a ref update that
2713deletes the currently checked out branch of a non-bare repository.
2714
Junio C Hamano4653c6f2008-11-26 22:50:202715receive.denyCurrentBranch::
Junio C Hamanoe97d5772010-05-19 08:13:582716If set to true or "refuse", git-receive-pack will deny a ref update
Junio C Hamano4653c6f2008-11-26 22:50:202717to the currently checked out branch of a non-bare repository.
2718Such a push is potentially dangerous because it brings the HEAD
2719out of sync with the index and working tree. If set to "warn",
2720print a warning of such a push to stderr, but allow the push to
2721proceed. If set to false or "ignore", allow such pushes with no
Junio C Hamanoafb395b2010-03-17 22:16:152722message. Defaults to "refuse".
Junio C Hamano6df93d92014-12-22 22:48:092723+
2724Another option is "updateInstead" which will update the working
Junio C Hamano6bb32e62015-02-17 22:11:262725tree if pushing into the current branch. This option is
Junio C Hamano6df93d92014-12-22 22:48:092726intended for synchronizing working directories when one side is not easily
2727accessible via interactive ssh (e.g. a live web site, hence the requirement
2728that the working directory be clean). This mode also comes in handy when
2729developing inside a VM to test and fix code on different Operating Systems.
Junio C Hamano6bb32e62015-02-17 22:11:262730+
2731By default, "updateInstead" will refuse the push if the working tree or
2732the index have any difference from the HEAD, but the `push-to-checkout`
2733hook can be used to customize this. See linkgit:githooks[5].
Junio C Hamano4653c6f2008-11-26 22:50:202734
2735receive.denyNonFastForwards::
2736If set to true, git-receive-pack will deny a ref update which is
Junio C Hamano3f680f32009-11-16 02:10:542737not a fast-forward. Use this to prevent such an update via a push,
Junio C Hamano4653c6f2008-11-26 22:50:202738even if that push is forced. This configuration variable is
2739set when initializing a shared repository.
2740
Junio C Hamano322c6242015-03-23 21:32:462741receive.hideRefs::
Junio C Hamanob6aa12e2015-08-19 22:40:172742This variable is the same as `transfer.hideRefs`, but applies
2743only to `receive-pack` (and so affects pushes, but not fetches).
2744An attempt to update or delete a hidden ref by `git push` is
2745rejected.
Junio C Hamano80ad00d2013-02-18 00:19:032746
Junio C Hamano322c6242015-03-23 21:32:462747receive.updateServerInfo::
Junio C Hamano621e1232009-10-26 05:16:472748If set to true, git-receive-pack will run git-update-server-info
2749after receiving data from git-push and updating refs.
2750
Junio C Hamano322c6242015-03-23 21:32:462751receive.shallowUpdate::
Junio C Hamano61525f92014-01-17 22:46:492752If set to true, .git/shallow can be updated when new refs
2753require new shallow roots. Otherwise those refs are rejected.
2754
Junio C Hamano322c6242015-03-23 21:32:462755remote.pushDefault::
Junio C Hamano63b6fdb2013-04-07 23:37:132756The remote to push to by default. Overrides
2757`branch.<name>.remote` for all branches, and is overridden by
Junio C Hamano322c6242015-03-23 21:32:462758`branch.<name>.pushRemote` for specific branches.
Junio C Hamano63b6fdb2013-04-07 23:37:132759
Junio C Hamano249572f2006-10-24 05:44:082760remote.<name>.url::
Junio C Hamano35738e82008-01-07 07:55:462761The URL of a remote repository. See linkgit:git-fetch[1] or
2762linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:082763
Junio C Hamano0e88f3e2009-06-21 08:03:252764remote.<name>.pushurl::
2765The push URL of a remote repository. See linkgit:git-push[1].
2766
Junio C Hamano58256872007-12-04 08:31:132767remote.<name>.proxy::
2768For remotes that require curl (http, https and ftp), the URL to
2769the proxy to use for that remote. Set to the empty string to
2770disable proxying for that remote.
2771
Junio C Hamanoffe10ca2016-02-04 00:44:232772remote.<name>.proxyAuthMethod::
2773For remotes that require curl (http, https and ftp), the method to use for
2774authenticating against the proxy in use (probably set in
2775`remote.<name>.proxy`). See `http.proxyAuthMethod`.
2776
Junio C Hamano249572f2006-10-24 05:44:082777remote.<name>.fetch::
Junio C Hamano35738e82008-01-07 07:55:462778The default set of "refspec" for linkgit:git-fetch[1]. See
2779linkgit:git-fetch[1].
Junio C Hamano249572f2006-10-24 05:44:082780
2781remote.<name>.push::
Junio C Hamano35738e82008-01-07 07:55:462782The default set of "refspec" for linkgit:git-push[1]. See
2783linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:082784
Junio C Hamano47d68a52008-05-06 06:35:402785remote.<name>.mirror::
2786If true, pushing to this remote will automatically behave
Junio C Hamanob76a6862012-05-02 22:02:462787as if the `--mirror` option was given on the command line.
Junio C Hamano47d68a52008-05-06 06:35:402788
Junio C Hamano118d2772007-02-21 20:24:102789remote.<name>.skipDefaultUpdate::
2790If true, this remote will be skipped by default when updating
Junio C Hamano9df0c662009-11-23 11:09:272791using linkgit:git-fetch[1] or the `update` subcommand of
2792linkgit:git-remote[1].
2793
2794remote.<name>.skipFetchAll::
2795If true, this remote will be skipped by default when updating
2796using linkgit:git-fetch[1] or the `update` subcommand of
2797linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:102798
Junio C Hamano4ad294b2007-01-20 02:22:502799remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:482800The default program to execute on the remote side when pushing. See
Junio C Hamano1dbca522015-05-22 20:48:552801option --receive-pack of linkgit:git-push[1].
Junio C Hamano4ad294b2007-01-20 02:22:502802
Junio C Hamano54ea8d32007-01-25 07:59:482803remote.<name>.uploadpack::
2804The default program to execute on the remote side when fetching. See
Junio C Hamano1dbca522015-05-22 20:48:552805option --upload-pack of linkgit:git-fetch-pack[1].
Junio C Hamano54ea8d32007-01-25 07:59:482806
Junio C Hamano322c6242015-03-23 21:32:462807remote.<name>.tagOpt::
Junio C Hamano1dbca522015-05-22 20:48:552808Setting this value to --no-tags disables automatic tag following when
2809fetching from remote <name>. Setting it to --tags will fetch every
Junio C Hamanocc7636a2010-05-21 14:57:532810tag from remote <name>, even if they are not reachable from remote
Junio C Hamano075ae872010-09-01 18:43:072811branch heads. Passing these flags directly to linkgit:git-fetch[1] can
Junio C Hamano1dbca522015-05-22 20:48:552812override this setting. See options --tags and --no-tags of
Junio C Hamano075ae872010-09-01 18:43:072813linkgit:git-fetch[1].
Junio C Hamano17dde0e2007-02-26 09:50:212814
Junio C Hamano096dde22009-12-26 23:14:112815remote.<name>.vcs::
Junio C Hamano076ffcc2013-02-06 05:13:212816Setting this to a value <vcs> will cause Git to interact with
Junio C Hamano096dde22009-12-26 23:14:112817the remote with the git-remote-<vcs> helper.
2818
Junio C Hamano8eac2682013-09-09 22:35:202819remote.<name>.prune::
2820When set to true, fetching from this remote by default will also
Junio C Hamano4c8f2d92013-12-13 00:55:422821remove any remote-tracking references that no longer exist on the
2822remote (as if the `--prune` option was given on the command line).
Junio C Hamano8eac2682013-09-09 22:35:202823Overrides `fetch.prune` settings, if any.
2824
Junio C Hamano118d2772007-02-21 20:24:102825remotes.<group>::
2826The list of remotes which are fetched by "git remote update
Junio C Hamano35738e82008-01-07 07:55:462827<group>". See linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:102828
Junio C Hamano322c6242015-03-23 21:32:462829repack.useDeltaBaseOffset::
Junio C Hamanofce7c7e2008-07-02 03:06:382830By default, linkgit:git-repack[1] creates packs that use
2831delta-base offset. If you need to share your repository with
Junio C Hamano076ffcc2013-02-06 05:13:212832Git older than version 1.4.4, either directly or via a dumb
Junio C Hamanofce7c7e2008-07-02 03:06:382833protocol such as http, then you need to set this option to
Junio C Hamano076ffcc2013-02-06 05:13:212834"false" and repack. Access from old Git versions over the
Junio C Hamanofce7c7e2008-07-02 03:06:382835native protocol are unaffected by this option.
Junio C Hamano77b7e902006-10-23 07:18:502836
Junio C Hamano3b0cdc22014-03-18 22:06:162837repack.packKeptObjects::
2838If set to true, makes `git repack` act as if
2839`--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2840details. Defaults to `false` normally, but `true` if a bitmap
2841index is being written (either via `--write-bitmap-index` or
Junio C Hamano38d02532014-06-26 21:48:502842`repack.writeBitmaps`).
2843
2844repack.writeBitmaps::
2845When true, git will write a bitmap index when packing all
2846objects to disk (e.g., when `git repack -a` is run). This
2847index can speed up the "counting objects" phase of subsequent
2848packs created for clones and fetches, at the cost of some disk
Junio C Hamano74fd0fc2016-05-10 21:23:562849space and extra time spent on the initial repack. This has
2850no effect if multiple packfiles are created.
2851Defaults to false.
Junio C Hamano3b0cdc22014-03-18 22:06:162852
Junio C Hamano322c6242015-03-23 21:32:462853rerere.autoUpdate::
Junio C Hamano4653c6f2008-11-26 22:50:202854When set to true, `git-rerere` updates the index with the
2855resulting contents after it cleanly resolves conflicts using
2856previously recorded resolution. Defaults to false.
2857
2858rerere.enabled::
2859Activate recording of resolved conflicts, so that identical
Junio C Hamano4fd24422012-01-06 21:52:432860conflict hunks can be resolved automatically, should they be
2861encountered again. By default, linkgit:git-rerere[1] is
2862enabled if there is an `rr-cache` directory under the
Junio C Hamano864ba892012-01-13 17:42:052863`$GIT_DIR`, e.g. if "rerere" was previously used in the
2864repository.
Junio C Hamano4653c6f2008-11-26 22:50:202865
Junio C Hamano1bbd0f42009-07-23 06:20:292866sendemail.identity::
2867A configuration identity. When given, causes values in the
2868'sendemail.<identity>' subsection to take precedence over
2869values in the 'sendemail' section. The default identity is
Junio C Hamano042f2142016-06-27 18:05:052870the value of `sendemail.identity`.
Junio C Hamano1bbd0f42009-07-23 06:20:292871
Junio C Hamano322c6242015-03-23 21:32:462872sendemail.smtpEncryption::
Junio C Hamano1bbd0f42009-07-23 06:20:292873See linkgit:git-send-email[1] for description. Note that this
2874setting is not subject to the 'identity' mechanism.
2875
Junio C Hamanobe087982015-02-22 21:29:392876sendemail.smtpssl (deprecated)::
Junio C Hamano322c6242015-03-23 21:32:462877Deprecated alias for 'sendemail.smtpEncryption = ssl'.
Junio C Hamano1bbd0f42009-07-23 06:20:292878
Junio C Hamano58f587a2013-07-22 19:20:592879sendemail.smtpsslcertpath::
2880Path to ca-certificates (either a directory or a single file).
2881Set it to an empty string to disable certificate verification.
2882
Junio C Hamano1bbd0f42009-07-23 06:20:292883sendemail.<identity>.*::
2884Identity-specific versions of the 'sendemail.*' parameters
2885found below, taking precedence over those when the this
2886identity is selected, through command-line or
Junio C Hamano042f2142016-06-27 18:05:052887`sendemail.identity`.
Junio C Hamano1bbd0f42009-07-23 06:20:292888
Junio C Hamano322c6242015-03-23 21:32:462889sendemail.aliasesFile::
2890sendemail.aliasFileType::
Junio C Hamanoea3b7522013-04-18 19:37:532891sendemail.annotate::
Junio C Hamano1bbd0f42009-07-23 06:20:292892sendemail.bcc::
2893sendemail.cc::
Junio C Hamano322c6242015-03-23 21:32:462894sendemail.ccCmd::
2895sendemail.chainReplyTo::
Junio C Hamano1bbd0f42009-07-23 06:20:292896sendemail.confirm::
Junio C Hamano322c6242015-03-23 21:32:462897sendemail.envelopeSender::
Junio C Hamano1bbd0f42009-07-23 06:20:292898sendemail.from::
Junio C Hamano322c6242015-03-23 21:32:462899sendemail.multiEdit::
Junio C Hamano1bbd0f42009-07-23 06:20:292900sendemail.signedoffbycc::
Junio C Hamano322c6242015-03-23 21:32:462901sendemail.smtpPass::
Junio C Hamano1bbd0f42009-07-23 06:20:292902sendemail.suppresscc::
Junio C Hamano322c6242015-03-23 21:32:462903sendemail.suppressFrom::
Junio C Hamano1bbd0f42009-07-23 06:20:292904sendemail.to::
Junio C Hamano322c6242015-03-23 21:32:462905sendemail.smtpDomain::
2906sendemail.smtpServer::
2907sendemail.smtpServerPort::
2908sendemail.smtpServerOption::
2909sendemail.smtpUser::
Junio C Hamano1bbd0f42009-07-23 06:20:292910sendemail.thread::
Junio C Hamano322c6242015-03-23 21:32:462911sendemail.transferEncoding::
Junio C Hamano1bbd0f42009-07-23 06:20:292912sendemail.validate::
Junio C Hamanoc9394b22015-01-07 22:45:482913sendemail.xmailer::
Junio C Hamano1bbd0f42009-07-23 06:20:292914See linkgit:git-send-email[1] for description.
2915
Junio C Hamanobe087982015-02-22 21:29:392916sendemail.signedoffcc (deprecated)::
Junio C Hamano042f2142016-06-27 18:05:052917Deprecated alias for `sendemail.signedoffbycc`.
Junio C Hamano1bbd0f42009-07-23 06:20:292918
Junio C Hamano07824ce2006-04-25 07:36:542919showbranch.default::
Junio C Hamano35738e82008-01-07 07:55:462920The default set of branches for linkgit:git-show-branch[1].
2921See linkgit:git-show-branch[1].
Junio C Hamano07824ce2006-04-25 07:36:542922
Junio C Hamano3d4a66d2017-03-17 21:07:262923splitIndex.maxPercentChange::
2924When the split index feature is used, this specifies the
2925percent of entries the split index can contain compared to the
2926total number of entries in both the split index and the shared
2927index before a new shared index is written.
2928The value should be between 0 and 100. If the value is 0 then
2929a new shared index is always written, if it is 100 a new
2930shared index is never written.
2931By default the value is 20, so a new shared index is written
2932if the number of entries in the split index would be greater
2933than 20 percent of the total number of entries.
2934See linkgit:git-update-index[1].
2935
2936splitIndex.sharedIndexExpire::
2937When the split index feature is used, shared index files that
2938were not modified since the time this variable specifies will
2939be removed when a new shared index file is created. The value
2940"now" expires all entries immediately, and "never" suppresses
2941expiration altogether.
2942The default value is "2.weeks.ago".
2943Note that a shared index file is considered modified (for the
2944purpose of expiration) each time a new split-index file is
2945either created based on it or read from it.
2946See linkgit:git-update-index[1].
2947
Junio C Hamano942b35e2007-12-09 10:19:332948status.relativePaths::
Junio C Hamano35738e82008-01-07 07:55:462949By default, linkgit:git-status[1] shows paths relative to the
Junio C Hamano942b35e2007-12-09 10:19:332950current directory. Setting this variable to `false` shows paths
Junio C Hamano076ffcc2013-02-06 05:13:212951relative to the repository root (this was the default for Git
Junio C Hamano942b35e2007-12-09 10:19:332952prior to v1.5.4).
2953
Junio C Hamano58655592013-07-11 20:52:332954status.short::
2955Set to true to enable --short by default in linkgit:git-status[1].
2956The option --no-short takes precedence over this variable.
2957
2958status.branch::
2959Set to true to enable --branch by default in linkgit:git-status[1].
2960The option --no-branch takes precedence over this variable.
2961
Junio C Hamano79f4c7c2013-09-20 21:03:372962status.displayCommentPrefix::
2963If set to true, linkgit:git-status[1] will insert a comment
2964prefix before each output line (starting with
2965`core.commentChar`, i.e. `#` by default). This was the
2966behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2967Defaults to false.
2968
Junio C Hamano4224f992008-06-23 07:14:082969status.showUntrackedFiles::
2970By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2971files which are not currently tracked by Git. Directories which
2972contain only untracked files, are shown with the directory name
2973only. Showing untracked files means that Git needs to lstat() all
Junio C Hamano2efd5e42014-11-10 22:38:522974the files in the whole repository, which might be slow on some
Junio C Hamano4224f992008-06-23 07:14:082975systems. So, this variable controls how the commands displays
2976the untracked files. Possible values are:
2977+
2978--
Junio C Hamano7f9fa862010-10-19 23:51:142979* `no` - Show no untracked files.
2980* `normal` - Show untracked files and directories.
2981* `all` - Show also individual files in untracked directories.
Junio C Hamano4224f992008-06-23 07:14:082982--
2983+
2984If this variable is not specified, it defaults to 'normal'.
2985This variable can be overridden with the -u|--untracked-files option
2986of linkgit:git-status[1] and linkgit:git-commit[1].
2987
Junio C Hamano322c6242015-03-23 21:32:462988status.submoduleSummary::
Junio C Hamanob671fb52010-06-01 05:06:142989Defaults to false.
2990If this is set to a non zero number or true (identical to -1 or an
2991unlimited number), the submodule summary will be enabled and a
2992summary of commits for modified submodules will be shown (see
Junio C Hamano369e3402013-10-15 18:40:252993--summary-limit option of linkgit:git-submodule[1]). Please note
2994that the summary output command will be suppressed for all
2995submodules when `diff.ignoreSubmodules` is set to 'all' or only
Junio C Hamanoc8c398a2014-06-16 21:14:052996for those submodules where `submodule.<name>.ignore=all`. The only
2997exception to that rule is that status and commit will show staged
2998submodule changes. To
Junio C Hamano369e3402013-10-15 18:40:252999also view the summary for ignored submodules you can either use
Junio C Hamanoe1aeb5e2014-06-06 19:16:293000the --ignore-submodules=dirty command-line option or the 'git
Junio C Hamano369e3402013-10-15 18:40:253001submodule summary' command, which shows a similar output but does
3002not honor these settings.
Junio C Hamanob671fb52010-06-01 05:06:143003
Junio C Hamano1eb56092015-10-05 20:39:533004stash.showPatch::
3005If this is set to true, the `git stash show` command without an
3006option will show the stash in patch form. Defaults to false.
3007See description of 'show' command in linkgit:git-stash[1].
3008
3009stash.showStat::
3010If this is set to true, the `git stash show` command without an
3011option will show diffstat of the stash. Defaults to true.
3012See description of 'show' command in linkgit:git-stash[1].
3013
Junio C Hamano78e3a782010-07-15 22:24:453014submodule.<name>.url::
Junio C Hamanoc0859f72016-10-17 22:22:573015The URL for a submodule. This variable is copied from the .gitmodules
3016file to the git config via 'git submodule init'. The user can change
3017the configured URL before obtaining the submodule via 'git submodule
Junio C Hamanodc8d0c32017-03-30 23:00:213018update'. If neither submodule.<name>.active or submodule.active are
3019set, the presence of this variable is used as a fallback to indicate
3020whether the submodule is of interest to git commands.
Junio C Hamanoc0859f72016-10-17 22:22:573021See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
Junio C Hamano6bf68cf2015-03-06 23:46:293022
Junio C Hamano78e3a782010-07-15 22:24:453023submodule.<name>.update::
Junio C Hamano6bf68cf2015-03-06 23:46:293024The default update procedure for a submodule. This variable
3025is populated by `git submodule init` from the
3026linkgit:gitmodules[5] file. See description of 'update'
3027command in linkgit:git-submodule[1].
Junio C Hamano78e3a782010-07-15 22:24:453028
Junio C Hamanoabad6da2013-01-06 09:06:323029submodule.<name>.branch::
3030The remote branch name for a submodule, used by `git submodule
3031update --remote`. Set this option to override the value found in
3032the `.gitmodules` file. See linkgit:git-submodule[1] and
3033linkgit:gitmodules[5] for details.
3034
Junio C Hamano0d75e872010-12-17 06:57:263035submodule.<name>.fetchRecurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:103036This option can be used to control recursive fetching of this
Junio C Hamano7165bf72011-01-04 22:06:183037submodule. It can be overridden by using the --[no-]recurse-submodules
Junio C Hamanoe1aeb5e2014-06-06 19:16:293038command-line option to "git fetch" and "git pull".
Junio C Hamano0d75e872010-12-17 06:57:263039This setting will override that from in the linkgit:gitmodules[5]
3040file.
3041
Junio C Hamano619596a2010-08-18 22:15:353042submodule.<name>.ignore::
3043Defines under what circumstances "git status" and the diff family show
3044a submodule as modified. When set to "all", it will never be considered
Junio C Hamanoc8c398a2014-06-16 21:14:053045modified (but it will nonetheless show up in the output of status and
3046commit when it has been staged), "dirty" will ignore all changes
3047to the submodules work tree and
Junio C Hamano619596a2010-08-18 22:15:353048takes only differences between the HEAD of the submodule and the commit
3049recorded in the superproject into account. "untracked" will additionally
3050let submodules with modified tracked files in their work tree show up.
3051Using "none" (the default when this option is not set) also shows
3052submodules that have untracked files in their work tree as changed.
3053This setting overrides any setting made in .gitmodules for this submodule,
Junio C Hamanode9745c2010-08-23 17:10:183054both settings can be overridden on the command line by using the
Junio C Hamano369e3402013-10-15 18:40:253055"--ignore-submodules" option. The 'git submodule' commands are not
3056affected by this setting.
Junio C Hamano619596a2010-08-18 22:15:353057
Junio C Hamanodc8d0c32017-03-30 23:00:213058submodule.<name>.active::
3059Boolean value indicating if the submodule is of interest to git
3060commands. This config option takes precedence over the
3061submodule.active config option.
3062
3063submodule.active::
3064A repeated field which contains a pathspec used to match against a
3065submodule's path to determine if the submodule is of interest to git
3066commands.
3067
Junio C Hamanobec5da42016-04-06 22:58:213068submodule.fetchJobs::
3069Specifies how many submodules are fetched/cloned at the same time.
3070A positive integer allows up to that number of submodules fetched
3071in parallel. A value of 0 will give some reasonable default.
3072If unset, it defaults to 1.
3073
Junio C Hamanocd451662016-09-13 00:54:093074submodule.alternateLocation::
3075Specifies how the submodules obtain alternates when submodules are
3076cloned. Possible values are `no`, `superproject`.
3077By default `no` is assumed, which doesn't add references. When the
3078value is set to `superproject` the submodule to be cloned computes
3079its alternates location relative to the superprojects alternate.
3080
Junio C Hamanoce01de82017-02-16 22:59:123081submodule.alternateErrorStrategy::
Junio C Hamanocd451662016-09-13 00:54:093082Specifies how to treat errors with the alternates for a submodule
3083as computed via `submodule.alternateLocation`. Possible values are
3084`ignore`, `info`, `die`. Default is `die`.
3085
Junio C Hamanobec5da42016-04-06 22:58:213086tag.forceSignAnnotated::
3087A boolean to specify whether annotated tags created should be GPG signed.
3088If `--annotate` is specified on the command line, it takes
3089precedence over this option.
3090
Junio C Hamano7b43d412014-07-23 23:09:443091tag.sort::
3092This variable controls the sort ordering of tags when displayed by
3093linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3094value of this variable will be used as the default.
3095
Junio C Hamano75cc4c92006-07-24 08:25:033096tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:093097This variable can be used to restrict the permission bits of
3098tar archive entries. The default is 0002, which turns off the
3099world write bit. The special value "user" indicates that the
3100archiving user's umask will be used instead. See umask(2) and
Junio C Hamano35738e82008-01-07 07:55:463101linkgit:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:033102
Junio C Hamano8fb66e52011-10-05 20:59:513103transfer.fsckObjects::
3104When `fetch.fsckObjects` or `receive.fsckObjects` are
3105not set, the value of this variable is used instead.
3106Defaults to false.
3107
Junio C Hamano322c6242015-03-23 21:32:463108transfer.hideRefs::
Junio C Hamanob6aa12e2015-08-19 22:40:173109String(s) `receive-pack` and `upload-pack` use to decide which
3110refs to omit from their initial advertisements. Use more than
3111one definition to specify multiple prefix strings. A ref that is
3112under the hierarchies listed in the value of this variable is
3113excluded, and is hidden when responding to `git push` or `git
3114fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
3115program-specific versions of this config.
3116+
3117You may also include a `!` in front of the ref name to negate the entry,
3118explicitly exposing it, even if an earlier entry marked it as hidden.
3119If you have multiple hideRefs values, later entries override earlier ones
3120(and entries in more-specific config files override less-specific ones).
Junio C Hamano713eded2015-12-03 00:24:023121+
3122If a namespace is in use, the namespace prefix is stripped from each
3123reference before it is matched against `transfer.hiderefs` patterns.
3124For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3125the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3126is omitted from the advertisements but `refs/heads/master` and
3127`refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3128"have" lines. In order to match refs before stripping, add a `^` in front of
3129the ref name. If you combine `!` and `^`, `!` must be specified first.
Junio C Hamano56ace3d2017-01-10 23:43:413130+
3131Even if you hide refs, a client may still be able to steal the target
3132objects via the techniques described in the "SECURITY" section of the
3133linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3134separate repository.
Junio C Hamano80ad00d2013-02-18 00:19:033135
Junio C Hamano4653c6f2008-11-26 22:50:203136transfer.unpackLimit::
3137When `fetch.unpackLimit` or `receive.unpackLimit` are
3138not set, the value of this variable is used instead.
3139The default value is 100.
3140
Junio C Hamano81703b22014-03-14 22:00:273141uploadarchive.allowUnreachable::
3142If true, allow clients to use `git archive --remote` to request
3143any tree, whether reachable from the ref tips or not. See the
Junio C Hamano56ace3d2017-01-10 23:43:413144discussion in the "SECURITY" section of
Junio C Hamano81703b22014-03-14 22:00:273145linkgit:git-upload-archive[1] for more details. Defaults to
3146`false`.
3147
Junio C Hamano322c6242015-03-23 21:32:463148uploadpack.hideRefs::
Junio C Hamanob6aa12e2015-08-19 22:40:173149This variable is the same as `transfer.hideRefs`, but applies
3150only to `upload-pack` (and so affects only fetches, not pushes).
3151An attempt to fetch a hidden ref by `git fetch` will fail. See
3152also `uploadpack.allowTipSHA1InWant`.
Junio C Hamano5e7f1312013-03-21 22:49:013153
Junio C Hamano85f1fde2015-06-01 20:37:323154uploadpack.allowTipSHA1InWant::
Junio C Hamano322c6242015-03-23 21:32:463155When `uploadpack.hideRefs` is in effect, allow `upload-pack`
Junio C Hamano5e7f1312013-03-21 22:49:013156to accept a fetch request that asks for an object at the tip
3157of a hidden ref (by default, such a request is rejected).
Junio C Hamano56ace3d2017-01-10 23:43:413158See also `uploadpack.hideRefs`. Even if this is false, a client
3159may be able to steal objects via the techniques described in the
3160"SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3161best to keep private data in a separate repository.
Junio C Hamano80ad00d2013-02-18 00:19:033162
Junio C Hamano85f1fde2015-06-01 20:37:323163uploadpack.allowReachableSHA1InWant::
3164Allow `upload-pack` to accept a fetch request that asks for an
3165object that is reachable from any ref tip. However, note that
3166calculating object reachability is computationally expensive.
Junio C Hamano56ace3d2017-01-10 23:43:413167Defaults to `false`. Even if this is false, a client may be able
3168to steal objects via the techniques described in the "SECURITY"
3169section of the linkgit:gitnamespaces[7] man page; it's best to
3170keep private data in a separate repository.
3171
3172uploadpack.allowAnySHA1InWant::
3173Allow `upload-pack` to accept a fetch request that asks for any
3174object at all.
Junio C Hamano85f1fde2015-06-01 20:37:323175Defaults to `false`.
3176
Junio C Hamano322c6242015-03-23 21:32:463177uploadpack.keepAlive::
Junio C Hamano79f4c7c2013-09-20 21:03:373178When `upload-pack` has started `pack-objects`, there may be a
3179quiet period while `pack-objects` prepares the pack. Normally
3180it would output progress information, but if `--quiet` was used
3181for the fetch, `pack-objects` will output nothing at all until
3182the pack data begins. Some clients and networks may consider
3183the server to be hung and give up. Setting this option instructs
3184`upload-pack` to send an empty keepalive packet every
Junio C Hamano322c6242015-03-23 21:32:463185`uploadpack.keepAlive` seconds. Setting this option to 0
Junio C Hamano79f4c7c2013-09-20 21:03:373186disables keepalive packets entirely. The default is 5 seconds.
3187
Junio C Hamanoc6c919b2016-07-06 21:34:153188uploadpack.packObjectsHook::
3189If this option is set, when `upload-pack` would run
3190`git pack-objects` to create a packfile for a client, it will
3191run this shell command instead. The `pack-objects` command and
3192arguments it _would_ have run (including the `git pack-objects`
3193at the beginning) are appended to the shell command. The stdin
3194and stdout of the hook are treated as if `pack-objects` itself
3195was run. I.e., `upload-pack` will feed input intended for
3196`pack-objects` to the hook, and expects a completed packfile on
3197stdout.
3198+
3199Note that this configuration variable is ignored if it is seen in the
3200repository-level config (this is a safety measure against fetching from
3201untrusted repositories).
3202
Junio C Hamano24bc09a2008-02-28 00:27:443203url.<base>.insteadOf::
3204Any URL that starts with this value will be rewritten to
3205start, instead, with <base>. In cases where some site serves a
3206large number of repositories, and serves them with multiple
3207access methods, and some users need to use different access
3208methods, this feature allows people to specify any of the
Junio C Hamano076ffcc2013-02-06 05:13:213209equivalent URLs and have Git automatically rewrite the URL to
Junio C Hamano24bc09a2008-02-28 00:27:443210the best alternative for the particular user, even for a
3211never-before-seen repository on the site. When more than one
3212insteadOf strings match a given URL, the longest match is used.
3213
Junio C Hamano7df6dcf2009-09-13 09:51:173214url.<base>.pushInsteadOf::
3215Any URL that starts with this value will not be pushed to;
3216instead, it will be rewritten to start with <base>, and the
3217resulting URL will be pushed to. In cases where some site serves
3218a large number of repositories, and serves them with multiple
3219access methods, some of which do not allow push, this feature
Junio C Hamano076ffcc2013-02-06 05:13:213220allows people to specify a pull-only URL and have Git
Junio C Hamano7df6dcf2009-09-13 09:51:173221automatically use an appropriate URL to push, even for a
3222never-before-seen repository on the site. When more than one
3223pushInsteadOf strings match a given URL, the longest match is
Junio C Hamano076ffcc2013-02-06 05:13:213224used. If a remote has an explicit pushurl, Git will ignore this
Junio C Hamano7df6dcf2009-09-13 09:51:173225setting for that remote.
3226
Junio C Hamano07824ce2006-04-25 07:36:543227user.email::
3228Your email address to be recorded in any newly created commits.
Junio C Hamano042f2142016-06-27 18:05:053229Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3230`EMAIL` environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:543231
3232user.name::
3233Your full name to be recorded in any newly created commits.
Junio C Hamano042f2142016-06-27 18:05:053234Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
Junio C Hamano35738e82008-01-07 07:55:463235environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:543236
Junio C Hamanof85ef632016-02-17 22:31:063237user.useConfigOnly::
Junio C Hamano042f2142016-06-27 18:05:053238Instruct Git to avoid trying to guess defaults for `user.email`
3239and `user.name`, and instead retrieve the values only from the
Junio C Hamanof85ef632016-02-17 22:31:063240configuration. For example, if you have multiple email addresses
3241and would like to use a different one for each repository, then
3242with this configuration option set to `true` in the global config
3243along with a name, Git will prompt you to set up an email before
3244making new commits in a newly cloned repository.
3245Defaults to `false`.
3246
Junio C Hamano322c6242015-03-23 21:32:463247user.signingKey::
Junio C Hamano369e3402013-10-15 18:40:253248If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3249key you want it to automatically when creating a signed tag or
3250commit, you can override the default selection with this variable.
3251This option is passed unchanged to gpg's --local-user parameter,
3252so you may specify a key using any method that gpg supports.
Junio C Hamanoa890c4f2007-01-28 10:29:213253
Junio C Hamanobcd98f42017-01-24 00:12:163254versionsort.prereleaseSuffix (deprecated)::
3255Deprecated alias for `versionsort.suffix`. Ignored if
3256`versionsort.suffix` is set.
3257
3258versionsort.suffix::
3259Even when version sort is used in linkgit:git-tag[1], tagnames
3260with the same base version but different suffixes are still sorted
3261lexicographically, resulting e.g. in prerelease tags appearing
3262after the main release (e.g. "1.0-rc1" after "1.0"). This
3263variable can be specified to determine the sorting order of tags
3264with different suffixes.
Junio C Hamano07622622015-03-20 21:47:263265+
Junio C Hamanobcd98f42017-01-24 00:12:163266By specifying a single suffix in this variable, any tagname containing
3267that suffix will appear before the corresponding main release. E.g. if
3268the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3269"1.0". If specified multiple times, once per suffix, then the order of
3270suffixes in the configuration will determine the sorting order of tagnames
3271with those suffixes. E.g. if "-pre" appears before "-rc" in the
3272configuration, then all "1.0-preX" tags will be listed before any
3273"1.0-rcX" tags. The placement of the main release tag relative to tags
3274with various suffixes can be determined by specifying the empty suffix
3275among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3276"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3277are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3278"v4.8-bfsX".
3279+
3280If more than one suffixes match the same tagname, then that tagname will
3281be sorted according to the suffix which starts at the earliest position in
3282the tagname. If more than one different matching suffixes start at
3283that earliest position, then that tagname will be sorted according to the
3284longest of those suffixes.
3285The sorting order between different suffixes is undefined if they are
3286in multiple config files.
Junio C Hamano07622622015-03-20 21:47:263287
Junio C Hamano4e272312008-01-08 09:13:213288web.browser::
3289Specify a web browser that may be used by some commands.
3290Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3291may use it.