blob: 73904bce55ff1d78bd10a5eb6b83f5fdf36ea74a [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
17variables may appear multiple times.
Junio C Hamano07824ce2006-04-25 07:36:5418
Junio C Hamanobee172f2007-01-23 08:44:1819Syntax
20~~~~~~
21
Junio C Hamano07824ce2006-04-25 07:36:5422The syntax is fairly flexible and permissive; whitespaces are mostly
Junio C Hamanobee172f2007-01-23 08:44:1823ignored. The '#' and ';' characters begin comments to the end of line,
24blank lines are ignored.
25
26The file consists of sections and variables. A section begins with
27the name of the section in square brackets and continues until the next
28section begins. Section names are not case sensitive. Only alphanumeric
Junio C Hamanoea82cff2009-03-18 01:54:4829characters, `-` and `.` are allowed in section names. Each variable
Junio C Hamanof4581102009-04-25 08:29:5930must belong to some section, which means that there must be a section
31header before the first setting of a variable.
Junio C Hamanobee172f2007-01-23 08:44:1832
33Sections can be further divided into subsections. To begin a subsection
34put its name in double quotes, separated by space from the section name,
Junio C Hamanof4581102009-04-25 08:29:5935in the section header, like in the example below:
Junio C Hamanobee172f2007-01-23 08:44:1836
37--------
38[section "subsection"]
39
40--------
41
Junio C Hamanof4581102009-04-25 08:29:5942Subsection names are case sensitive and can contain any characters except
43newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
44respectively). Section headers cannot span multiple
Junio C Hamanobee172f2007-01-23 08:44:1845lines. Variables may belong directly to a section or to a given subsection.
46You can have `[section]` if you have `[section "subsection"]`, but you
47don't need to.
48
Junio C Hamano6231f822011-10-24 05:18:5249There is also a deprecated `[section.subsection]` syntax. With this
50syntax, the subsection name is converted to lower-case and is also
51compared case sensitively. These subsection names follow the same
52restrictions as section names.
Junio C Hamanobee172f2007-01-23 08:44:1853
Junio C Hamanoaa2cd762009-07-26 08:14:0154All the other lines (and the remainder of the line after the section
55header) are recognized as setting variables, in the form
Junio C Hamanobee172f2007-01-23 08:44:1856'name = value'. If there is no equal sign on the line, the entire line
57is taken as 'name' and the variable is recognized as boolean "true".
Junio C Hamano81d540a2012-03-02 19:52:4758The variable names are case-insensitive, allow only alphanumeric characters
59and `-`, and must start with an alphabetic character. There can be more
60than one value for a given variable; we say then that the variable is
61multivalued.
Junio C Hamanobee172f2007-01-23 08:44:1862
63Leading and trailing whitespace in a variable value is discarded.
64Internal whitespace within a variable value is retained verbatim.
65
66The values following the equals sign in variable assign are all either
67a string, an integer, or a boolean. Boolean values may be given as yes/no,
Junio C Hamano059bca52011-03-30 22:47:46681/0, true/false or on/off. Case is not significant in boolean values, when
Junio C Hamanobee172f2007-01-23 08:44:1869converting value to the canonical form using '--bool' type specifier;
Junio C Hamano1aa40d22010-01-21 17:46:4370'git config' will ensure that the output is "true" or "false".
Junio C Hamanobee172f2007-01-23 08:44:1871
72String values may be entirely or partially enclosed in double quotes.
Junio C Hamanof4581102009-04-25 08:29:5973You need to enclose variable values in double quotes if you want to
74preserve leading or trailing whitespace, or if the variable value contains
75comment characters (i.e. it contains '#' or ';').
76Double quote `"` and backslash `\` characters in variable values must
Junio C Hamanoea82cff2009-03-18 01:54:4877be escaped: use `\"` for `"` and `\\` for `\`.
Junio C Hamanobee172f2007-01-23 08:44:1878
Junio C Hamanoea82cff2009-03-18 01:54:4879The following escape sequences (beside `\"` and `\\`) are recognized:
80`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
81and `\b` for backspace (BS). No other char escape sequence, nor octal
Junio C Hamanobee172f2007-01-23 08:44:1882char sequences are valid.
83
Junio C Hamanof4581102009-04-25 08:29:5984Variable values ending in a `\` are continued on the next line in the
Junio C Hamanobee172f2007-01-23 08:44:1885customary UNIX fashion.
86
Junio C Hamanof4581102009-04-25 08:29:5987Some variables may require a special value format.
Junio C Hamano07824ce2006-04-25 07:36:5488
Junio C Hamanoe0238c22012-02-23 22:45:5089Includes
90~~~~~~~~
91
92You can include one config file from another by setting the special
93`include.path` variable to the name of the file to be included. The
94included file is expanded immediately, as if its contents had been
95found at the location of the include directive. If the value of the
96`include.path` variable is a relative path, the path is considered to be
97relative to the configuration file in which the include directive was
Junio C Hamano22700fb2012-05-03 23:07:2598found. The value of `include.path` is subject to tilde expansion: `~/`
99is expanded to the value of `$HOME`, and `~user/` to the specified
Junio C Hamano4d61c4a2012-04-30 01:10:22100user's home directory. See below for examples.
Junio C Hamanoe0238c22012-02-23 22:45:50101
Junio C Hamano07824ce2006-04-25 07:36:54102Example
103~~~~~~~
104
105# Core variables
106[core]
107; Don't trust file modes
108filemode = false
109
110# Our diff algorithm
111[diff]
Junio C Hamano85c71572008-07-28 00:03:31112external = /usr/local/bin/diff-wrapper
Junio C Hamano07824ce2006-04-25 07:36:54113renames = true
114
Junio C Hamano52401ef2006-12-19 00:54:38115[branch "devel"]
116remote = origin
117merge = refs/heads/devel
118
Junio C Hamanobee172f2007-01-23 08:44:18119# Proxy settings
120[core]
Junio C Hamanoc71a8732007-08-04 00:27:26121gitProxy="ssh" for "kernel.org"
Junio C Hamanobee172f2007-01-23 08:44:18122gitProxy=default-proxy ; for the rest
Junio C Hamano52401ef2006-12-19 00:54:38123
Junio C Hamanoe0238c22012-02-23 22:45:50124[include]
125path = /path/to/foo.inc ; include by absolute path
126path = foo ; expand "foo" relative to the current file
Junio C Hamano4d61c4a2012-04-30 01:10:22127path = ~/foo ; expand "foo" in your $HOME directory
Junio C Hamanoe0238c22012-02-23 22:45:50128
Junio C Hamano07824ce2006-04-25 07:36:54129Variables
130~~~~~~~~~
131
132Note that this list is non-comprehensive and not necessarily complete.
Junio C Hamanof1d14802006-06-08 00:48:17133For command-specific variables, you will find a more detailed description
134in the appropriate manual page. You will find a description of non-core
Junio C Hamano07824ce2006-04-25 07:36:54135porcelain configuration variables in the respective porcelain documentation.
136
Junio C Hamano7df6dcf2009-09-13 09:51:17137advice.*::
Junio C Hamano0df92712011-12-21 22:30:44138These variables control various optional help messages designed to
139aid new users. All 'advice.*' variables default to 'true', and you
140can tell Git that you do not need help by setting these to 'false':
Junio C Hamano7df6dcf2009-09-13 09:51:17141+
142--
Junio C Hamanoabad6da2013-01-06 09:06:32143pushUpdateRejected::
Junio C Hamano0c1b64e2012-04-20 23:50:49144Set this variable to 'false' if you want to disable
Junio C Hamano1d669b82014-03-11 21:36:00145'pushNonFFCurrent',
Junio C Hamano3f2ed6f2013-02-04 19:24:09146'pushNonFFMatching', 'pushAlreadyExists',
147'pushFetchFirst', and 'pushNeedsForce'
Junio C Hamanoabad6da2013-01-06 09:06:32148simultaneously.
Junio C Hamano0c1b64e2012-04-20 23:50:49149pushNonFFCurrent::
150Advice shown when linkgit:git-push[1] fails due to a
151non-fast-forward update to the current branch.
Junio C Hamano0c1b64e2012-04-20 23:50:49152pushNonFFMatching::
153Advice shown when you ran linkgit:git-push[1] and pushed
154'matching refs' explicitly (i.e. you used ':', or
155specified a refspec that isn't your current branch) and
156it resulted in a non-fast-forward error.
Junio C Hamanoabad6da2013-01-06 09:06:32157pushAlreadyExists::
158Shown when linkgit:git-push[1] rejects an update that
159does not qualify for fast-forwarding (e.g., a tag.)
Junio C Hamano3f2ed6f2013-02-04 19:24:09160pushFetchFirst::
161Shown when linkgit:git-push[1] rejects an update that
162tries to overwrite a remote ref that points at an
163object we do not have.
164pushNeedsForce::
165Shown when linkgit:git-push[1] rejects an update that
166tries to overwrite a remote ref that points at an
Junio C Hamanoe6f28d02013-09-17 21:34:00167object that is not a commit-ish, or make the remote
168ref point at an object that is not a commit-ish.
Junio C Hamano7df6dcf2009-09-13 09:51:17169statusHints::
Junio C Hamano644936c2012-06-28 23:05:14170Show directions on how to proceed from the current
Junio C Hamano917cd4f2012-12-04 23:41:10171state in the output of linkgit:git-status[1], in
Junio C Hamano644936c2012-06-28 23:05:14172the template shown when writing commit messages in
Junio C Hamano917cd4f2012-12-04 23:41:10173linkgit:git-commit[1], and in the help message shown
174by linkgit:git-checkout[1] when switching branch.
Junio C Hamano5e7f1312013-03-21 22:49:01175statusUoption::
176Advise to consider using the `-u` option to linkgit:git-status[1]
177when the command takes more than 2 seconds to enumerate untracked
178files.
Junio C Hamano5706e0b2009-11-24 10:54:16179commitBeforeMerge::
180Advice shown when linkgit:git-merge[1] refuses to
Junio C Hamano619596a2010-08-18 22:15:35181merge to avoid overwriting local changes.
Junio C Hamanoa9701f02010-01-21 00:42:16182resolveConflict::
Junio C Hamano5dab5a92013-02-25 18:51:24183Advice shown by various commands when conflicts
Junio C Hamanoa9701f02010-01-21 00:42:16184prevent the operation from being performed.
Junio C Hamanoa9701f02010-01-21 00:42:16185implicitIdentity::
186Advice on how to set your identity configuration when
187your information is guessed from the system username and
Junio C Hamano0df92712011-12-21 22:30:44188domain name.
Junio C Hamano74a198f2010-02-22 00:13:31189detachedHead::
Junio C Hamano0df92712011-12-21 22:30:44190Advice shown when you used linkgit:git-checkout[1] to
Junio C Hamano74a198f2010-02-22 00:13:31191move to the detach HEAD state, to instruct how to create
Junio C Hamano0df92712011-12-21 22:30:44192a local branch after the fact.
Junio C Hamanobb300642012-07-22 21:09:14193amWorkDir::
194Advice that shows the location of the patch file when
195linkgit:git-am[1] fails to apply it.
Junio C Hamano8ab94942013-06-24 21:55:30196rmHints::
197In case of failure in the output of linkgit:git-rm[1],
198show directions on how to proceed from the current state.
Junio C Hamano7df6dcf2009-09-13 09:51:17199--
200
Junio C Hamano07824ce2006-04-25 07:36:54201core.fileMode::
202If false, the executable bit differences between the index and
Junio C Hamano8fb66e52011-10-05 20:59:51203the working tree are ignored; useful on broken filesystems like FAT.
Junio C Hamano9df0c662009-11-23 11:09:27204See linkgit:git-update-index[1].
205+
206The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
207will probe and set core.fileMode false if appropriate when the
208repository is created.
Junio C Hamano07824ce2006-04-25 07:36:54209
Junio C Hamano9df0c662009-11-23 11:09:27210core.ignorecase::
211If true, this option enables various workarounds to enable
Junio C Hamano076ffcc2013-02-06 05:13:21212Git to work better on filesystems that are not case sensitive,
Junio C Hamano9df0c662009-11-23 11:09:27213like FAT. For example, if a directory listing finds
Junio C Hamano076ffcc2013-02-06 05:13:21214"makefile" when Git expects "Makefile", Git will assume
Junio C Hamano9df0c662009-11-23 11:09:27215it is really the same file, and continue to remember it as
216"Makefile".
217+
218The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
219will probe and set core.ignorecase true if appropriate when the repository
220is created.
221
Junio C Hamanob61a7772012-07-13 23:34:48222core.precomposeunicode::
Junio C Hamano076ffcc2013-02-06 05:13:21223This option is only used by Mac OS implementation of Git.
224When core.precomposeunicode=true, Git reverts the unicode decomposition
Junio C Hamanob61a7772012-07-13 23:34:48225of filenames done by Mac OS. This is useful when sharing a repository
226between Mac OS and Linux or Windows.
Junio C Hamano076ffcc2013-02-06 05:13:21227(Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
228When false, file names are handled fully transparent by Git,
229which is backward compatible with older versions of Git.
Junio C Hamanob61a7772012-07-13 23:34:48230
Junio C Hamano90ccff32008-07-29 08:17:24231core.trustctime::
232If false, the ctime differences between the index and the
Junio C Hamano8fb66e52011-10-05 20:59:51233working tree are ignored; useful when the inode change time
Junio C Hamano90ccff32008-07-29 08:17:24234is regularly modified by something outside Git (file system
235crawlers and some backup systems).
236See linkgit:git-update-index[1]. True by default.
237
Junio C Hamano4cfed0c2013-01-30 17:58:54238core.checkstat::
239Determines which stat fields to match between the index
240and work tree. The user can set this to 'default' or
241'minimal'. Default (or explicitly 'default'), is to check
242all fields, including the sub-second part of mtime and ctime.
243
Junio C Hamanod526ba92007-07-02 00:17:42244core.quotepath::
Junio C Hamanoba4b9282008-07-06 05:20:31245The commands that output paths (e.g. 'ls-files',
246'diff'), when not given the `-z` option, will quote
Junio C Hamanod526ba92007-07-02 00:17:42247"unusual" characters in the pathname by enclosing the
248pathname in a double-quote pair and with backslashes the
249same way strings in C source code are quoted. If this
250variable is set to false, the bytes higher than 0x80 are
251not quoted but output as verbatim. Note that double
252quote, backslash and control characters are always
253quoted without `-z` regardless of the setting of this
254variable.
255
Junio C Hamanobb88cf42010-06-21 15:23:55256core.eol::
257Sets the line ending type to use in the working directory for
258files that have the `text` property set. Alternatives are
259'lf', 'crlf' and 'native', which uses the platform's native
260line ending. The default value is `native`. See
261linkgit:gitattributes[5] for more information on end-of-line
262conversion.
Junio C Hamanod9e0e5d2007-04-14 16:22:04263
Junio C Hamano26e590a2008-02-17 03:53:51264core.safecrlf::
Junio C Hamano076ffcc2013-02-06 05:13:21265If true, makes Git check if converting `CRLF` is reversible when
Junio C Hamanobb88cf42010-06-21 15:23:55266end-of-line conversion is active. Git will verify if a command
Junio C Hamano26e590a2008-02-17 03:53:51267modifies a file in the work tree either directly or indirectly.
268For example, committing a file followed by checking out the
269same file should yield the original file in the work tree. If
270this is not the case for the current setting of
Junio C Hamano076ffcc2013-02-06 05:13:21271`core.autocrlf`, Git will reject the file. The variable can
272be set to "warn", in which case Git will only warn about an
Junio C Hamano26e590a2008-02-17 03:53:51273irreversible conversion but continue the operation.
274+
275CRLF conversion bears a slight chance of corrupting data.
Junio C Hamano076ffcc2013-02-06 05:13:21276When it is enabled, Git will convert CRLF to LF during commit and LF to
Junio C Hamano26e590a2008-02-17 03:53:51277CRLF during checkout. A file that contains a mixture of LF and
Junio C Hamano076ffcc2013-02-06 05:13:21278CRLF before the commit cannot be recreated by Git. For text
Junio C Hamano26e590a2008-02-17 03:53:51279files this is the right thing to do: it corrects line endings
280such that we have only LF line endings in the repository.
281But for binary files that are accidentally classified as text the
282conversion can corrupt data.
283+
284If you recognize such corruption early you can easily fix it by
285setting the conversion type explicitly in .gitattributes. Right
286after committing you still have the original file in your work
287tree and this file is not yet corrupted. You can explicitly tell
Junio C Hamano076ffcc2013-02-06 05:13:21288Git that this file is binary and Git will handle the file
Junio C Hamano26e590a2008-02-17 03:53:51289appropriately.
290+
291Unfortunately, the desired effect of cleaning up text files with
292mixed line endings and the undesired effect of corrupting binary
293files cannot be distinguished. In both cases CRLFs are removed
294in an irreversible way. For text files this is the right thing
295to do because CRLFs are line endings, while for binary files
296converting CRLFs corrupts data.
297+
298Note, this safety check does not mean that a checkout will generate a
299file identical to the original file for a different setting of
Junio C Hamanobb88cf42010-06-21 15:23:55300`core.eol` and `core.autocrlf`, but only for the current one. For
301example, a text file with `LF` would be accepted with `core.eol=lf`
302and could later be checked out with `core.eol=crlf`, in which case the
Junio C Hamano26e590a2008-02-17 03:53:51303resulting file would contain `CRLF`, although the original file
304contained `LF`. However, in both work trees the line endings would be
305consistent, that is either all `LF` or all `CRLF`, but never mixed. A
306file with mixed line endings would be reported by the `core.safecrlf`
307mechanism.
308
Junio C Hamanobb88cf42010-06-21 15:23:55309core.autocrlf::
310Setting this variable to "true" is almost the same as setting
311the `text` attribute to "auto" on all files except that text
312files are not guaranteed to be normalized: files that contain
313`CRLF` in the repository will not be touched. Use this
314setting if you want to have `CRLF` line endings in your
315working directory even though the repository does not have
316normalized line endings. This variable can be set to 'input',
317in which case no output conversion is performed.
318
Junio C Hamanoaa83a7d2007-03-05 02:37:29319core.symlinks::
320If false, symbolic links are checked out as small plain files that
Junio C Hamano35738e82008-01-07 07:55:46321contain the link text. linkgit:git-update-index[1] and
322linkgit:git-add[1] will not change the recorded type to regular
Junio C Hamanoaa83a7d2007-03-05 02:37:29323file. Useful on filesystems like FAT that do not support
Junio C Hamano9df0c662009-11-23 11:09:27324symbolic links.
325+
326The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
327will probe and set core.symlinks false if appropriate when the repository
328is created.
Junio C Hamanoaa83a7d2007-03-05 02:37:29329
Junio C Hamano07824ce2006-04-25 07:36:54330core.gitProxy::
331A "proxy command" to execute (as 'command host port') instead
332of establishing direct connection to the remote server when
Junio C Hamano076ffcc2013-02-06 05:13:21333using the Git protocol for fetching. If the variable value is
Junio C Hamano07824ce2006-04-25 07:36:54334in the "COMMAND for DOMAIN" format, the command is applied only
335on hostnames ending with the specified domain string. This variable
336may be set multiple times and is matched in the given order;
337the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17338+
339Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
340(which always applies universally, without the special "for"
341handling).
Junio C Hamanoea82cff2009-03-18 01:54:48342+
343The special string `none` can be used as the proxy command to
344specify that no proxy be used for a given domain pattern.
345This is useful for excluding servers inside a firewall from
346proxy use, while defaulting to a common proxy for external domains.
Junio C Hamano07824ce2006-04-25 07:36:54347
348core.ignoreStat::
Junio C Hamano054ea082008-06-01 08:26:34349If true, commands which modify both the working tree and the index
350will mark the updated paths with the "assume unchanged" bit in the
351index. These marked files are then assumed to stay unchanged in the
Junio C Hamano8fb66e52011-10-05 20:59:51352working tree, until you mark them otherwise manually - Git will not
Junio C Hamano054ea082008-06-01 08:26:34353detect the file changes by lstat() calls. This is useful on systems
354where those are very slow, such as Microsoft Windows.
355See linkgit:git-update-index[1].
Junio C Hamano07824ce2006-04-25 07:36:54356False by default.
357
Junio C Hamano88a3a072006-05-04 08:01:43358core.preferSymlinkRefs::
359Instead of the default "symref" format for HEAD
360and other symbolic reference files, use symbolic links.
361This is sometimes needed to work with old scripts that
362expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54363
Junio C Hamano1025e752007-02-23 07:21:26364core.bare::
365If true this repository is assumed to be 'bare' and has no
366working directory associated with it. If this is the case a
367number of commands that require a working directory will be
Junio C Hamano35738e82008-01-07 07:55:46368disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Junio C Hamano1025e752007-02-23 07:21:26369+
Junio C Hamano35738e82008-01-07 07:55:46370This setting is automatically guessed by linkgit:git-clone[1] or
371linkgit:git-init[1] when the repository was created. By default a
Junio C Hamano1025e752007-02-23 07:21:26372repository that ends in "/.git" is assumed to be not bare (bare =
373false), while all other repositories are assumed to be bare (bare
374= true).
375
Junio C Hamanod526ba92007-07-02 00:17:42376core.worktree::
Junio C Hamano80d58462011-01-24 22:52:52377Set the path to the root of the working tree.
Junio C Hamano764a6672007-10-23 01:23:31378This can be overridden by the GIT_WORK_TREE environment
Junio C Hamano80d58462011-01-24 22:52:52379variable and the '--work-tree' command line option.
Junio C Hamano5cd15182011-04-05 00:21:10380The value can be an absolute path or relative to the path to
Junio C Hamano80d58462011-01-24 22:52:52381the .git directory, which is either specified by --git-dir
382or GIT_DIR, or automatically discovered.
383If --git-dir or GIT_DIR is specified but none of
Junio C Hamano7d575a52008-04-30 08:45:27384--work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamano80d58462011-01-24 22:52:52385the current working directory is regarded as the top level
Junio C Hamano3609b332010-12-29 01:34:52386of your working tree.
Junio C Hamano80d58462011-01-24 22:52:52387+
388Note that this variable is honored even when set in a configuration
389file in a ".git" subdirectory of a directory and its value differs
390from the latter directory (e.g. "/path/to/.git/config" has
391core.worktree set to "/different/path"), which is most likely a
Junio C Hamano076ffcc2013-02-06 05:13:21392misconfiguration. Running Git commands in the "/path/to" directory will
Junio C Hamano80d58462011-01-24 22:52:52393still use "/different/path" as the root of the work tree and can cause
394confusion unless you know what you are doing (e.g. you are creating a
395read-only snapshot of the same index to a location different from the
396repository's usual working tree).
Junio C Hamanod526ba92007-07-02 00:17:42397
Junio C Hamano341071d2006-06-04 07:24:48398core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49399Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamanoa2ec14f2006-11-02 00:22:48400"$GIT_DIR/logs/<ref>", by appending the new and old
Junio C Hamanoe3f080d2013-04-22 02:27:13401SHA-1, the date/time and the reason of the update, but
Junio C Hamanoa2ec14f2006-11-02 00:22:48402only when the file exists. If this configuration
403variable is set to true, missing "$GIT_DIR/logs/<ref>"
Junio C Hamano15567bc2011-07-23 00:51:59404file is automatically created for branch heads (i.e. under
405refs/heads/), remote refs (i.e. under refs/remotes/),
406note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
Junio C Hamano1caaf472006-12-31 08:29:35407+
408This information can be used to determine what commit
409was the tip of a branch "2 days ago".
410+
411This value is true by default in a repository that has
412a working directory associated with it, and false by
413default in a bare repository.
Junio C Hamano341071d2006-06-04 07:24:48414
Junio C Hamano07824ce2006-04-25 07:36:54415core.repositoryFormatVersion::
416Internal variable identifying the repository format and layout
417version.
418
419core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42420When 'group' (or 'true'), the repository is made shareable between
421several users in a group (making sure all the files and objects are
422group-writable). When 'all' (or 'world' or 'everybody'), the
423repository will be readable by all users, additionally to being
Junio C Hamano076ffcc2013-02-06 05:13:21424group-shareable. When 'umask' (or 'false'), Git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37425reported by umask(2). When '0xxx', where '0xxx' is an octal number,
426files in the repository will have this mode value. '0xxx' will override
Junio C Hamano83eded12009-04-20 08:18:00427user's umask value (whereas the other options will only override
428requested parts of the user's umask value). Examples: '0660' will make
429the repo read/write-able for the owner and group, but inaccessible to
430others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Junio C Hamano2f102bb2008-04-26 02:23:37431repository that is group-readable but not group-writable.
432See linkgit:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54433
434core.warnAmbiguousRefs::
Junio C Hamano076ffcc2013-02-06 05:13:21435If true, Git will warn you if the ref name you passed it is ambiguous
Junio C Hamano947ab822013-03-19 23:07:29436and might match multiple refs in the repository. True by default.
Junio C Hamano07824ce2006-04-25 07:36:54437
Junio C Hamano7ec15722006-07-07 02:03:59438core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09439An integer -1..9, indicating a default compression level.
440-1 is the zlib default. 0 means no compression,
441and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42442If set, this provides a default to other compression variables,
443such as 'core.loosecompression' and 'pack.compression'.
Junio C Hamanoa126a3b2006-07-04 04:55:26444
Junio C Hamanof2ce2972007-05-20 19:12:09445core.loosecompression::
446An integer -1..9, indicating the compression level for objects that
447are not in a pack file. -1 is the zlib default. 0 means no
448compression, and 1..9 are various speed/size tradeoffs, 9 being
449slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42450not set, defaults to 1 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49451
Junio C Hamanofc4d38c2007-01-08 06:53:32452core.packedGitWindowSize::
453Number of bytes of a pack file to map into memory in a
454single mapping operation. Larger window sizes may allow
455your system to process a smaller number of large pack files
456more quickly. Smaller window sizes will negatively affect
457performance due to increased calls to the operating system's
458memory manager, but may improve performance when accessing
459a large number of large pack files.
460+
461Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
462MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
463be reasonable for all users/operating systems. You probably do
464not need to adjust this value.
465+
466Common unit suffixes of 'k', 'm', or 'g' are supported.
467
468core.packedGitLimit::
469Maximum number of bytes to map simultaneously into memory
470from pack files. If Git needs to access more than this many
471bytes at once to complete an operation it will unmap existing
472regions to reclaim virtual address space within the process.
473+
474Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
475This should be reasonable for all users/operating systems, except on
476the largest projects. You probably do not need to adjust this value.
477+
478Common unit suffixes of 'k', 'm', or 'g' are supported.
479
Junio C Hamanob8c51282007-03-19 10:43:30480core.deltaBaseCacheLimit::
481Maximum number of bytes to reserve for caching base objects
Junio C Hamano619596a2010-08-18 22:15:35482that may be referenced by multiple deltified objects. By storing the
Junio C Hamanob8c51282007-03-19 10:43:30483entire decompressed base objects in a cache Git is able
484to avoid unpacking and decompressing frequently used base
485objects multiple times.
486+
487Default is 16 MiB on all platforms. This should be reasonable
488for all users/operating systems, except on the largest projects.
489You probably do not need to adjust this value.
490+
491Common unit suffixes of 'k', 'm', or 'g' are supported.
492
Junio C Hamano5c246f22010-02-03 07:34:53493core.bigFileThreshold::
494Files larger than this size are stored deflated, without
495attempting delta compression. Storing large files without
496delta compression avoids excessive memory usage, at the
497slight expense of increased disk usage.
498+
499Default is 512 MiB on all platforms. This should be reasonable
500for most projects as source code and other text files can still
501be delta compressed, but larger binary media files won't be.
502+
503Common unit suffixes of 'k', 'm', or 'g' are supported.
Junio C Hamano5c246f22010-02-03 07:34:53504
Junio C Hamano1d90cb02007-07-03 07:05:31505core.excludesfile::
Junio C Hamano5e284b42007-05-22 07:23:37506In addition to '.gitignore' (per-directory) and
Junio C Hamano076ffcc2013-02-06 05:13:21507'.git/info/exclude', Git looks into this file for patterns
Junio C Hamanob76a6862012-05-02 22:02:46508of files which are not meant to be tracked. "`~/`" is expanded
509to the value of `$HOME` and "`~user/`" to the specified user's
Junio C Hamano8edb4c72012-07-09 20:33:55510home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
511If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
512is used instead. See linkgit:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37513
Junio C Hamano3fd7b262010-09-08 22:44:20514core.askpass::
515Some commands (e.g. svn and http interfaces) that interactively
516ask for a password can be told to use an external program given
517via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
518environment variable. If not set, fall back to the value of the
519'SSH_ASKPASS' environment variable or, failing that, a simple password
520prompt. The external program shall be given a suitable prompt as
521command line argument and write the password on its STDOUT.
522
Junio C Hamano3b4609d2010-09-30 00:04:34523core.attributesfile::
524In addition to '.gitattributes' (per-directory) and
Junio C Hamano076ffcc2013-02-06 05:13:21525'.git/info/attributes', Git looks into this file for attributes
Junio C Hamano3b4609d2010-09-30 00:04:34526(see linkgit:gitattributes[5]). Path expansions are made the same
Junio C Hamano8edb4c72012-07-09 20:33:55527way as for `core.excludesfile`. Its default value is
528$XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
529set or empty, $HOME/.config/git/attributes is used instead.
Junio C Hamano3b4609d2010-09-30 00:04:34530
Junio C Hamanof6002a92007-07-20 10:28:22531core.editor::
532Commands such as `commit` and `tag` that lets you edit
Junio C Hamanoa6387422007-08-25 03:54:27533messages by launching an editor uses the value of this
Junio C Hamanof6002a92007-07-20 10:28:22534variable when it is set, and the environment variable
Junio C Hamano3b70d3c2009-11-21 17:37:37535`GIT_EDITOR` is not set. See linkgit:git-var[1].
Junio C Hamanof6002a92007-07-20 10:28:22536
Junio C Hamano3f2ed6f2013-02-04 19:24:09537core.commentchar::
538Commands such as `commit` and `tag` that lets you edit
539messages consider a line that begins with this character
540commented, and removes them after the editor returns
541(default '#').
542
Junio C Hamano6231f822011-10-24 05:18:52543sequence.editor::
Junio C Hamano778a3412013-03-28 23:24:30544Text editor used by `git rebase -i` for editing the rebase instruction file.
Junio C Hamano6231f822011-10-24 05:18:52545The value is meant to be interpreted by the shell when it is used.
546It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
547When not configured the default commit message editor is used instead.
548
Junio C Hamano28d8ede2007-07-05 05:51:38549core.pager::
Junio C Hamano0e0e0d22013-09-12 23:25:03550Text viewer for use by Git commands (e.g., 'less'). The value
551is meant to be interpreted by the shell. The order of preference
552is the `$GIT_PAGER` environment variable, then `core.pager`
553configuration, then `$PAGER`, and then the default chosen at
554compile time (usually 'less').
555+
556When the `LESS` environment variable is unset, Git sets it to `FRSX`
557(if `LESS` environment variable is set, Git does not change it at
558all). If you want to selectively override Git's default setting
559for `LESS`, you can set `core.pager` to e.g. `less -+S`. This will
560be passed to the shell by Git, which will translate the final
561command to `LESS=FRSX less -+S`. The environment tells the command
562to set the `S` option to chop long lines but the command line
563resets it to the default to fold long lines.
Junio C Hamanobc8d4782014-01-13 23:35:50564+
565Likewise, when the `LV` environment variable is unset, Git sets it
566to `-c`. You can override this setting by exporting `LV` with
567another value or setting `core.pager` to `lv +c`.
Junio C Hamano28d8ede2007-07-05 05:51:38568
Junio C Hamano942b35e2007-12-09 10:19:33569core.whitespace::
570A comma separated list of common whitespace problems to
Junio C Hamano1aa40d22010-01-21 17:46:43571notice. 'git diff' will use `color.diff.whitespace` to
572highlight them, and 'git apply --whitespace=error' will
Junio C Hamano3db8b412008-07-26 06:45:59573consider them as errors. You can prefix `-` to disable
574any of them (e.g. `-trailing-space`):
Junio C Hamano942b35e2007-12-09 10:19:33575+
Junio C Hamanob71a22d2009-10-17 08:23:47576* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano942b35e2007-12-09 10:19:33577 as an error (enabled by default).
578* `space-before-tab` treats a space character that appears immediately
579 before a tab character in the initial indent part of the line as an
580 error (enabled by default).
Junio C Hamano281fd392012-09-17 23:57:41581* `indent-with-non-tab` treats a line that is indented with space
582 characters instead of the equivalent tabs as an error (not enabled by
583 default).
Junio C Hamanocb39aea2010-05-09 07:24:48584* `tab-in-indent` treats a tab character in the initial indent part of
585 the line as an error (not enabled by default).
Junio C Hamanob71a22d2009-10-17 08:23:47586* `blank-at-eof` treats blank lines added at the end of file as an error
587 (enabled by default).
588* `trailing-space` is a short-hand to cover both `blank-at-eol` and
589 `blank-at-eof`.
Junio C Hamano601f3e52008-02-25 08:40:42590* `cr-at-eol` treats a carriage-return at the end of line as
591 part of the line terminator, i.e. with it, `trailing-space`
592 does not trigger if the character before such a carriage-return
593 is not a whitespace (not enabled by default).
Junio C Hamanoeef01fe2010-12-13 08:31:58594* `tabwidth=<n>` tells how many character positions a tab occupies; this
Junio C Hamano076ffcc2013-02-06 05:13:21595 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
Junio C Hamanoeef01fe2010-12-13 08:31:58596 errors. The default tab width is 8. Allowed values are 1 to 63.
Junio C Hamano942b35e2007-12-09 10:19:33597
Junio C Hamano9eb57532008-06-26 06:33:46598core.fsyncobjectfiles::
599This boolean will enable 'fsync()' when writing object files.
600+
601This is a total waste of time and effort on a filesystem that orders
602data writes properly, but can be useful for filesystems that do not use
603journalling (traditional UNIX filesystems) or that only journal metadata
604and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
605
Junio C Hamano610d1762008-11-28 06:27:13606core.preloadindex::
607Enable parallel index preload for operations like 'git diff'
608+
609This can speed up operations like 'git diff' and 'git status' especially
610on filesystems like NFS that have weak caching semantics and thus
Junio C Hamano076ffcc2013-02-06 05:13:21611relatively high IO latencies. With this set to 'true', Git will do the
Junio C Hamano610d1762008-11-28 06:27:13612index comparison to the filesystem data in parallel, allowing
613overlapping IO's.
614
Junio C Hamanoa9499de2009-04-30 03:38:48615core.createObject::
616You can set this to 'link', in which case a hardlink followed by
617a delete of the source are used to make sure that object creation
618will not overwrite existing objects.
619+
620On some file system/operating system combinations, this is unreliable.
621Set this config setting to 'rename' there; However, This will remove the
622check that makes sure that existing object files will not get overwritten.
Junio C Hamanoe91ea772009-04-26 01:41:41623
Junio C Hamano3b70d3c2009-11-21 17:37:37624core.notesRef::
625When showing commit messages, also show notes which are stored in
Junio C Hamanoa574a092010-06-13 19:57:10626the given ref. The ref must be fully qualified. If the given
627ref does not exist, it is not an error but means that no
628notes should be printed.
Junio C Hamano3b70d3c2009-11-21 17:37:37629+
Junio C Hamanoa574a092010-06-13 19:57:10630This setting defaults to "refs/notes/commits", and it can be overridden by
631the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
Junio C Hamano3b70d3c2009-11-21 17:37:37632
Junio C Hamano3c8d6702010-01-13 23:09:03633core.sparseCheckout::
634Enable "sparse checkout" feature. See section "Sparse checkout" in
635linkgit:git-read-tree[1] for more information.
636
Junio C Hamano6371b0e2011-03-23 23:36:21637core.abbrev::
638Set the length object names are abbreviated to. If unspecified,
639many commands abbreviate to 7 hexdigits, which may not be enough
640for abbreviated object names to stay unique for sufficiently long
641time.
642
Junio C Hamano3d141512009-06-01 01:22:40643add.ignore-errors::
Junio C Hamano60186642010-12-02 14:18:26644add.ignoreErrors::
Junio C Hamano1aa40d22010-01-21 17:46:43645Tells 'git add' to continue adding files when some files cannot be
Junio C Hamano3d141512009-06-01 01:22:40646added due to indexing errors. Equivalent to the '--ignore-errors'
Junio C Hamano076ffcc2013-02-06 05:13:21647option of linkgit:git-add[1]. Older versions of Git accept only
Junio C Hamano60186642010-12-02 14:18:26648`add.ignore-errors`, which does not follow the usual naming
Junio C Hamano076ffcc2013-02-06 05:13:21649convention for configuration variables. Newer versions of Git
Junio C Hamano60186642010-12-02 14:18:26650honor `add.ignoreErrors` as well.
Junio C Hamano3d141512009-06-01 01:22:40651
Junio C Hamano33db4372006-06-07 19:51:45652alias.*::
Junio C Hamano35738e82008-01-07 07:55:46653Command aliases for the linkgit:git[1] command wrapper - e.g.
Junio C Hamano33db4372006-06-07 19:51:45654after defining "alias.last = cat-file commit HEAD", the invocation
655"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17656confusion and troubles with script usage, aliases that
Junio C Hamano076ffcc2013-02-06 05:13:21657hide existing Git commands are ignored. Arguments are split by
Junio C Hamanof1d14802006-06-08 00:48:17658spaces, the usual shell quoting and escaping is supported.
659quote pair and a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39660+
661If the alias expansion is prefixed with an exclamation point,
662it will be treated as a shell command. For example, defining
663"alias.new = !gitk --all --not ORIG_HEAD", the invocation
664"git new" is equivalent to running the shell command
Junio C Hamano48bc1ce2009-07-09 16:49:19665"gitk --all --not ORIG_HEAD". Note that shell commands will be
666executed from the top-level directory of a repository, which may
667not necessarily be the current directory.
Junio C Hamano5f2627d2011-05-06 20:23:48668'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
669from the original current directory. See linkgit:git-rev-parse[1].
Junio C Hamano9cb74f22007-02-12 04:15:05670
Junio C Hamanocaa712a2010-03-11 01:17:35671am.keepcr::
672If true, git-am will call git-mailsplit for patches in mbox format
673with parameter '--keep-cr'. In this case git-mailsplit will
Junio C Hamano619596a2010-08-18 22:15:35674not remove `\r` from lines ending with `\r\n`. Can be overridden
Junio C Hamanocaa712a2010-03-11 01:17:35675by giving '--no-keep-cr' from the command line.
676See linkgit:git-am[1], linkgit:git-mailsplit[1].
677
Junio C Hamanofe24db02009-08-22 05:10:47678apply.ignorewhitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43679When set to 'change', tells 'git apply' to ignore changes in
Junio C Hamanofe24db02009-08-22 05:10:47680whitespace, in the same way as the '--ignore-space-change'
681option.
Junio C Hamano1aa40d22010-01-21 17:46:43682When set to one of: no, none, never, false tells 'git apply' to
Junio C Hamanofe24db02009-08-22 05:10:47683respect all whitespace differences.
684See linkgit:git-apply[1].
685
Junio C Hamano07824ce2006-04-25 07:36:54686apply.whitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43687Tells 'git apply' how to handle whitespaces, in the same way
Junio C Hamano35738e82008-01-07 07:55:46688as the '--whitespace' option. See linkgit:git-apply[1].
Junio C Hamano07824ce2006-04-25 07:36:54689
Junio C Hamano7fd84172007-05-24 07:00:32690branch.autosetupmerge::
Junio C Hamano1aa40d22010-01-21 17:46:43691Tells 'git branch' and 'git checkout' to set up new branches
Junio C Hamano24bc09a2008-02-28 00:27:44692so that linkgit:git-pull[1] will appropriately merge from the
693starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32694this behavior can be chosen per-branch using the `--track`
Junio C Hamano24bc09a2008-02-28 00:27:44695and `--no-track` options. The valid settings are: `false` -- no
696automatic setup is done; `true` -- automatic setup is done when the
Junio C Hamano97bcb482010-11-25 03:16:07697starting point is a remote-tracking branch; `always` --
698automatic setup is done when the starting point is either a
699local branch or remote-tracking
Junio C Hamano24bc09a2008-02-28 00:27:44700branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32701
Junio C Hamano869bb802008-05-12 00:29:47702branch.autosetuprebase::
Junio C Hamano1aa40d22010-01-21 17:46:43703When a new branch is created with 'git branch' or 'git checkout'
Junio C Hamano076ffcc2013-02-06 05:13:21704that tracks another branch, this variable tells Git to set
Junio C Hamano869bb802008-05-12 00:29:47705up pull to rebase instead of merge (see "branch.<name>.rebase").
706When `never`, rebase is never automatically set to true.
707When `local`, rebase is set to true for tracked branches of
708other local branches.
709When `remote`, rebase is set to true for tracked branches of
Junio C Hamano97bcb482010-11-25 03:16:07710remote-tracking branches.
Junio C Hamano869bb802008-05-12 00:29:47711When `always`, rebase will be set to true for all tracking
712branches.
713See "branch.autosetupmerge" for details on how to set up a
714branch to track another branch.
715This option defaults to never.
716
Junio C Hamano47c1e3c2006-09-25 04:45:55717branch.<name>.remote::
Junio C Hamano63b6fdb2013-04-07 23:37:13718When on branch <name>, it tells 'git fetch' and 'git push'
719which remote to fetch from/push to. The remote to push to
720may be overridden with `remote.pushdefault` (for all branches).
721The remote to push to, for the current branch, may be further
722overridden by `branch.<name>.pushremote`. If no remote is
723configured, or if you are not on any branch, it defaults to
724`origin` for fetching and `remote.pushdefault` for pushing.
Junio C Hamano238ce9c2013-10-23 21:56:38725Additionally, `.` (a period) is the current local repository
726(a dot-repository), see `branch.<name>.merge`'s final note below.
Junio C Hamano63b6fdb2013-04-07 23:37:13727
728branch.<name>.pushremote::
729When on branch <name>, it overrides `branch.<name>.remote` for
730pushing. It also overrides `remote.pushdefault` for pushing
731from branch <name>. When you pull from one place (e.g. your
732upstream) and push to another place (e.g. your own publishing
733repository), you would want to set `remote.pushdefault` to
734specify the remote to push to for all branches, and use this
735option to override it for a specific branch.
Junio C Hamano47c1e3c2006-09-25 04:45:55736
737branch.<name>.merge::
Junio C Hamano0706c802009-03-30 22:34:19738Defines, together with branch.<name>.remote, the upstream branch
Junio C Hamanob02377c2011-04-28 22:26:02739for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
Junio C Hamano1aa40d22010-01-21 17:46:43740branch to merge and can also affect 'git push' (see push.default).
741When in branch <name>, it tells 'git fetch' the default
Junio C Hamanoc2b47092007-10-25 06:50:31742refspec to be marked for merging in FETCH_HEAD. The value is
743handled like the remote part of a refspec, and must match a
744ref which is fetched from the remote given by
745"branch.<name>.remote".
Junio C Hamano1aa40d22010-01-21 17:46:43746The merge information is used by 'git pull' (which at first calls
747'git fetch') to lookup the default branch for merging. Without
748this option, 'git pull' defaults to merge the first refspec fetched.
Junio C Hamano96010b22006-12-09 21:15:46749Specify multiple values to get an octopus merge.
Junio C Hamano1aa40d22010-01-21 17:46:43750If you wish to setup 'git pull' so that it merges into <name> from
Junio C Hamano6e149c02007-03-16 10:21:07751another branch in the local repository, you can point
Junio C Hamano238ce9c2013-10-23 21:56:38752branch.<name>.merge to the desired branch, and use the relative path
753setting `.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:55754
Junio C Hamano1b50ce92007-10-03 12:05:53755branch.<name>.mergeoptions::
756Sets default options for merging into branch <name>. The syntax and
Junio C Hamanoc0e55e72009-10-10 00:56:29757supported options are the same as those of linkgit:git-merge[1], but
Junio C Hamano1b50ce92007-10-03 12:05:53758option values containing whitespace characters are currently not
759supported.
760
Junio C Hamano0c999702007-12-03 09:57:55761branch.<name>.rebase::
762When true, rebase the branch <name> on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:08763instead of merging the default branch from the default remote when
Junio C Hamano515ab1d2011-12-09 23:41:20764"git pull" is run. See "pull.rebase" for doing this in a non
765branch-specific manner.
766+
Junio C Hamanocf4a1742013-09-11 22:57:50767When preserve, also pass `--preserve-merges` along to 'git rebase'
768so that locally committed merge commits will not be flattened
769by running 'git pull'.
770+
Junio C Hamano515ab1d2011-12-09 23:41:20771*NOTE*: this is a possibly dangerous operation; do *not* use
772it unless you understand the implications (see linkgit:git-rebase[1]
773for details).
Junio C Hamano0c999702007-12-03 09:57:55774
Junio C Hamano46247182013-01-09 20:50:28775branch.<name>.description::
776Branch description, can be edited with
777`git branch --edit-description`. Branch description is
778automatically added in the format-patch cover letter or
779request-pull summary.
780
Junio C Hamano8760ea62008-03-14 08:58:45781browser.<tool>.cmd::
782Specify the command to invoke the specified browser. The
783specified command is evaluated in shell with the URLs passed
Junio C Hamano360e3a12011-07-13 23:51:56784as arguments. (See linkgit:git-web{litdd}browse[1].)
Junio C Hamano8760ea62008-03-14 08:58:45785
Junio C Hamanoe35a6fc2008-01-29 09:46:27786browser.<tool>.path::
787Override the path for the given tool that may be used to
788browse HTML help (see '-w' option in linkgit:git-help[1]) or a
789working repository in gitweb (see linkgit:git-instaweb[1]).
790
Junio C Hamano47b9acd2007-04-24 07:34:34791clean.requireForce::
Junio C Hamanoe6f28d02013-09-17 21:34:00792A boolean to make git-clean do nothing unless given -f,
793-i or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:34794
Junio C Hamanoeb692952007-01-03 22:02:12795color.branch::
796A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46797linkgit:git-branch[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21798`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoeb692952007-01-03 22:02:12799only when the output is to a terminal. Defaults to false.
800
801color.branch.<slot>::
802Use customized color for branch coloration. `<slot>` is one of
803`current` (the current branch), `local` (a local branch),
Junio C Hamano76927822013-04-19 21:26:57804`remote` (a remote-tracking branch in refs/remotes/),
805`upstream` (upstream tracking branch), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:22806refs).
807+
808The value for these configuration variables is a list of colors (at most
809two) and attributes (at most one), separated by spaces. The colors
810accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
811`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
812`blink` and `reverse`. The first color given is the foreground; the
813second is the background. The position of the attribute, if any,
814doesn't matter.
Junio C Hamanoeb692952007-01-03 22:02:12815
Junio C Hamano3f403b02006-12-13 10:14:13816color.diff::
Junio C Hamano5f2627d2011-05-06 20:23:48817Whether to use ANSI escape sequences to add color to patches.
818If this is set to `always`, linkgit:git-diff[1],
819linkgit:git-log[1], and linkgit:git-show[1] will use color
820for all patches. If it is set to `true` or `auto`, those
821commands will only use color when output is to the terminal.
822Defaults to false.
823+
824This does not affect linkgit:git-format-patch[1] nor the
825'git-diff-{asterisk}' plumbing commands. Can be overridden on the
826command line with the `--color[=<when>]` option.
Junio C Hamano9ae1a062006-07-10 08:12:34827
Junio C Hamano3f403b02006-12-13 10:14:13828color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:22829Use customized color for diff colorization. `<slot>` specifies
830which part of the patch to use the specified color, and is one
831of `plain` (context text), `meta` (metainformation), `frag`
Junio C Hamano2bd8a742009-12-01 21:16:59832(hunk header), 'func' (function in hunk header), `old` (removed lines),
833`new` (added lines), `commit` (commit headers), or `whitespace`
834(highlighting whitespace errors). The values of these variables may be
835specified as in color.branch.<slot>.
Junio C Hamano9ae1a062006-07-10 08:12:34836
Junio C Hamano7d449522010-07-01 00:08:51837color.decorate.<slot>::
838Use customized color for 'git log --decorate' output. `<slot>` is one
839of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
Junio C Hamano97bcb482010-11-25 03:16:07840branches, remote-tracking branches, tags, stash and HEAD, respectively.
Junio C Hamano7d449522010-07-01 00:08:51841
Junio C Hamanod257cff2009-03-18 05:27:16842color.grep::
843When set to `always`, always highlight matches. When `false` (or
844`never`), never. When set to `true` or `auto`, use color only
845when the output is written to the terminal. Defaults to `false`.
846
Junio C Hamano0299d922010-03-20 20:59:31847color.grep.<slot>::
848Use customized color for grep colorization. `<slot>` specifies which
849part of the line to use the specified color, and is one of
850+
851--
852`context`;;
853non-matching text in context lines (when using `-A`, `-B`, or `-C`)
854`filename`;;
855filename prefix (when not using `-h`)
856`function`;;
857function name lines (when using `-p`)
858`linenumber`;;
859line number prefix (when using `-n`)
860`match`;;
861matching text
862`selected`;;
863non-matching text in selected lines
864`separator`;;
865separators between fields on a line (`:`, `-`, and `=`)
866and between hunks (`--`)
867--
868+
869The values of these variables may be specified as in color.branch.<slot>.
Junio C Hamanod257cff2009-03-18 05:27:16870
Junio C Hamano00b8b632007-12-07 09:50:49871color.interactive::
Junio C Hamano35738e82008-01-07 07:55:46872When set to `always`, always use colors for interactive prompts
Junio C Hamano58f587a2013-07-22 19:20:59873and displays (such as those used by "git-add --interactive" and
874"git-clean --interactive"). When false (or `never`), never.
875When set to `true` or `auto`, use colors only when the output is
876to the terminal. Defaults to false.
Junio C Hamano00b8b632007-12-07 09:50:49877
878color.interactive.<slot>::
Junio C Hamano58f587a2013-07-22 19:20:59879Use customized color for 'git add --interactive' and 'git clean
880--interactive' output. `<slot>` may be `prompt`, `header`, `help`
881or `error`, for four distinct types of normal output from
882interactive commands. The values of these variables may be
883specified as in color.branch.<slot>.
Junio C Hamano00b8b632007-12-07 09:50:49884
Junio C Hamanoe7935c42006-12-13 21:32:17885color.pager::
886A boolean to enable/disable colored output when the pager is in
887use (default is true).
888
Junio C Hamano52ba2952009-05-18 17:43:02889color.showbranch::
890A boolean to enable/disable color in the output of
891linkgit:git-show-branch[1]. May be set to `always`,
892`false` (or `never`) or `auto` (or `true`), in which case colors are used
893only when the output is to a terminal. Defaults to false.
894
Junio C Hamanoe7935c42006-12-13 21:32:17895color.status::
896A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46897linkgit:git-status[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21898`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoe7935c42006-12-13 21:32:17899only when the output is to a terminal. Defaults to false.
900
901color.status.<slot>::
902Use customized color for status colorization. `<slot>` is
903one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:04904`added` or `updated` (files which are added but not committed),
905`changed` (files which are changed but not added in the index),
Junio C Hamano076ffcc2013-02-06 05:13:21906`untracked` (files which are not tracked by Git),
Junio C Hamano0d75e872010-12-17 06:57:26907`branch` (the current branch), or
Junio C Hamanob713ff12008-05-24 01:12:30908`nobranch` (the color the 'no branch' warning is shown in, defaulting
909to red). The values of these variables may be specified as in
910color.branch.<slot>.
Junio C Hamanoe7935c42006-12-13 21:32:17911
Junio C Hamano83d46a22008-02-21 02:29:42912color.ui::
Junio C Hamano5f2627d2011-05-06 20:23:48913This variable determines the default value for variables such
914as `color.diff` and `color.grep` that control the use of color
915per command family. Its scope will expand as more commands learn
916configuration to set a default for the `--color` option. Set it
Junio C Hamanofa1d3492013-06-20 23:39:43917to `false` or `never` if you prefer Git commands not to use
918color unless enabled explicitly with some other configuration
919or the `--color` option. Set it to `always` if you want all
920output not intended for machine consumption to use color, to
921`true` or `auto` (this is the default since Git 1.8.4) if you
922want such output to use color when written to the terminal.
Junio C Hamano83d46a22008-02-21 02:29:42923
Junio C Hamano22700fb2012-05-03 23:07:25924column.ui::
925Specify whether supported commands should output in columns.
926This variable consists of a list of tokens separated by spaces
927or commas:
928+
Junio C Hamanoa1952302013-07-01 21:31:18929These options control when the feature should be enabled
930(defaults to 'never'):
931+
Junio C Hamano22700fb2012-05-03 23:07:25932--
933`always`;;
934always show in columns
935`never`;;
936never show in columns
937`auto`;;
938show in columns if the output is to the terminal
Junio C Hamanoa1952302013-07-01 21:31:18939--
940+
941These options control layout (defaults to 'column'). Setting any
942of these implies 'always' if none of 'always', 'never', or 'auto' are
943specified.
944+
945--
Junio C Hamano22700fb2012-05-03 23:07:25946`column`;;
Junio C Hamanoa1952302013-07-01 21:31:18947fill columns before rows
Junio C Hamano22700fb2012-05-03 23:07:25948`row`;;
949fill rows before columns
950`plain`;;
951show in one column
Junio C Hamanoa1952302013-07-01 21:31:18952--
953+
954Finally, these options can be combined with a layout option (defaults
955to 'nodense'):
956+
957--
Junio C Hamano22700fb2012-05-03 23:07:25958`dense`;;
959make unequal size columns to utilize more space
960`nodense`;;
961make equal size columns
962--
Junio C Hamano22700fb2012-05-03 23:07:25963
964column.branch::
965Specify whether to output branch listing in `git branch` in columns.
966See `column.ui` for details.
967
Junio C Hamano58f587a2013-07-22 19:20:59968column.clean::
969Specify the layout when list items in `git clean -i`, which always
970shows files and directories in columns. See `column.ui` for details.
971
Junio C Hamano22700fb2012-05-03 23:07:25972column.status::
973Specify whether to output untracked files in `git status` in columns.
974See `column.ui` for details.
975
976column.tag::
977Specify whether to output tag listing in `git tag` in columns.
978See `column.ui` for details.
979
Junio C Hamanoce836cc2013-01-21 02:01:53980commit.cleanup::
981This setting overrides the default of the `--cleanup` option in
982`git commit`. See linkgit:git-commit[1] for details. Changing the
983default can be useful when you always want to keep lines that begin
984with comment character `#` in your log message, in which case you
985would do `git config commit.cleanup whitespace` (note that you will
986have to remove the help lines that begin with `#` in the commit log
987template yourself, if you do this).
988
Junio C Hamano5b3533d2014-02-27 23:07:15989commit.gpgsign::
990
991A boolean to specify whether all commits should be GPG signed.
992Use of this option when doing operations such as rebase can
993result in a large number of commits being signed. It may be
994convenient to use an agent to avoid typing your GPG passphrase
995several times.
996
Junio C Hamanod0d892c2010-01-24 20:06:29997commit.status::
Junio C Hamano6ce6b6c2010-01-18 01:25:50998A boolean to enable/disable inclusion of status information in the
999commit message template when using an editor to prepare the commit
1000message. Defaults to true.
1001
Junio C Hamano4653c6f2008-11-26 22:50:201002commit.template::
1003Specify a file to use as the template for new commit messages.
Junio C Hamanob76a6862012-05-02 22:02:461004"`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
Junio C Hamanobf984de2009-11-23 06:11:191005specified user's home directory.
Junio C Hamano4653c6f2008-11-26 22:50:201006
Junio C Hamano0df92712011-12-21 22:30:441007credential.helper::
1008Specify an external helper to be called when a username or
1009password credential is needed; the helper may consult external
1010storage to avoid prompting the user for the credentials. See
1011linkgit:gitcredentials[7] for details.
1012
1013credential.useHttpPath::
1014When acquiring credentials, consider the "path" component of an http
1015or https URL to be important. Defaults to false. See
1016linkgit:gitcredentials[7] for more information.
1017
1018credential.username::
1019If no username is set for a network authentication, use this username
1020by default. See credential.<context>.* below, and
1021linkgit:gitcredentials[7].
1022
1023credential.<url>.*::
1024Any of the credential.* options above can be applied selectively to
1025some credentials. For example "credential.https://example.com.username"
1026would set the default username only for https connections to
1027example.com. See linkgit:gitcredentials[7] for details on how URLs are
1028matched.
1029
Junio C Hamano209ebe82011-04-27 21:09:591030include::diff-config.txt[]
Junio C Hamano3bd66e92009-04-18 06:17:561031
1032difftool.<tool>.path::
1033Override the path for the given tool. This is useful in case
1034your tool is not in the PATH.
1035
1036difftool.<tool>.cmd::
1037Specify the command to invoke the specified diff tool.
1038The specified command is evaluated in shell with the following
1039variables available: 'LOCAL' is set to the name of the temporary
1040file containing the contents of the diff pre-image and 'REMOTE'
1041is set to the name of the temporary file containing the contents
1042of the diff post-image.
1043
1044difftool.prompt::
1045Prompt before each invocation of the diff tool.
1046
Junio C Hamano0d75e872010-12-17 06:57:261047fetch.recurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:101048This option can be either set to a boolean value or to 'on-demand'.
1049Setting it to a boolean changes the behavior of fetch and pull to
1050unconditionally recurse into submodules when set to true or to not
1051recurse at all when set to false. When set to 'on-demand' (the default
1052value), fetch and pull will only recurse into a populated submodule
1053when its superproject retrieves a commit that updates the submodule's
1054reference.
Junio C Hamano0d75e872010-12-17 06:57:261055
Junio C Hamano8fb66e52011-10-05 20:59:511056fetch.fsckObjects::
1057If it is set to true, git-fetch-pack will check all fetched
1058objects. It will abort in the case of a malformed object or a
1059broken link. The result of an abort are only dangling objects.
1060Defaults to false. If not set, the value of `transfer.fsckObjects`
1061is used instead.
1062
Junio C Hamano54ea8d32007-01-25 07:59:481063fetch.unpackLimit::
Junio C Hamano076ffcc2013-02-06 05:13:211064If the number of objects fetched over the Git native
Junio C Hamano54ea8d32007-01-25 07:59:481065transfer is below this
1066limit, then the objects will be unpacked into loose object
1067files. However if the number of received objects equals or
1068exceeds this limit then the received pack will be stored as
1069a pack, after adding any missing delta bases. Storing the
1070pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:171071especially on slow filesystems. If not set, the value of
1072`transfer.unpackLimit` is used instead.
Junio C Hamano54ea8d32007-01-25 07:59:481073
Junio C Hamano8eac2682013-09-09 22:35:201074fetch.prune::
1075If true, fetch will automatically behave as if the `--prune`
1076option was given on the command line. See also `remote.<name>.prune`.
1077
Junio C Hamanof4581102009-04-25 08:29:591078format.attach::
1079Enable multipart/mixed attachments as the default for
1080'format-patch'. The value can also be a double quoted string
1081which will enable attachments as the default and set the
1082value as the boundary. See the --attach option in
1083linkgit:git-format-patch[1].
1084
Junio C Hamano8c5802d2007-11-15 00:13:361085format.numbered::
Junio C Hamano7d06a8a2008-10-20 05:42:331086A boolean which can enable or disable sequence numbers in patch
1087subjects. It defaults to "auto" which enables it only if there
1088is more than one patch. It can be enabled or disabled for all
1089messages by setting it to "true" or "false". See --numbered
1090option in linkgit:git-format-patch[1].
Junio C Hamano8c5802d2007-11-15 00:13:361091
Junio C Hamano07824ce2006-04-25 07:36:541092format.headers::
1093Additional email headers to include in a patch to be submitted
Junio C Hamano35738e82008-01-07 07:55:461094by mail. See linkgit:git-format-patch[1].
Junio C Hamano07824ce2006-04-25 07:36:541095
Junio C Hamano70664a02010-07-13 22:48:051096format.to::
Junio C Hamanof4581102009-04-25 08:29:591097format.cc::
Junio C Hamano70664a02010-07-13 22:48:051098Additional recipients to include in a patch to be submitted
1099by mail. See the --to and --cc options in
1100linkgit:git-format-patch[1].
Junio C Hamanof4581102009-04-25 08:29:591101
1102format.subjectprefix::
1103The default for format-patch is to output files with the '[PATCH]'
1104subject prefix. Use this variable to change that prefix.
1105
Junio C Hamano89a57342010-06-22 23:22:551106format.signature::
1107The default for format-patch is to output a signature containing
Junio C Hamano076ffcc2013-02-06 05:13:211108the Git version number. Use this variable to change that default.
Junio C Hamano89a57342010-06-22 23:22:551109Set this variable to the empty string ("") to suppress
1110signature generation.
1111
Junio C Hamanod4c8e112007-03-04 10:32:381112format.suffix::
1113The default for format-patch is to output files with the suffix
1114`.patch`. Use this variable to change that suffix (make sure to
1115include the dot if you want it).
1116
Junio C Hamano86bcccc2008-03-08 09:33:551117format.pretty::
1118The default pretty format for log/show/whatchanged command,
1119See linkgit:git-log[1], linkgit:git-show[1],
1120linkgit:git-whatchanged[1].
1121
Junio C Hamanoea6a7642009-03-11 23:56:191122format.thread::
Junio C Hamano1aa40d22010-01-21 17:46:431123The default threading style for 'git format-patch'. Can be
Junio C Hamanob141a922010-01-10 19:55:141124a boolean value, or `shallow` or `deep`. `shallow` threading
1125makes every mail a reply to the head of the series,
Junio C Hamanoea6a7642009-03-11 23:56:191126where the head is chosen from the cover letter, the
Junio C Hamanob76a6862012-05-02 22:02:461127`--in-reply-to`, and the first patch mail, in this order.
Junio C Hamanof4581102009-04-25 08:29:591128`deep` threading makes every mail a reply to the previous one.
Junio C Hamanoea6a7642009-03-11 23:56:191129A true boolean value is the same as `shallow`, and a false
1130value disables threading.
1131
Junio C Hamano5f9a6f02009-04-06 08:26:561132format.signoff::
Junio C Hamano804a9742013-04-28 23:10:311133A boolean value which lets you enable the `-s/--signoff` option of
1134format-patch by default. *Note:* Adding the Signed-off-by: line to a
1135patch should be a conscious act and means that you certify you have
1136the rights to submit this work under the same open source license.
1137Please see the 'SubmittingPatches' document for further discussion.
Junio C Hamano5f9a6f02009-04-06 08:26:561138
Junio C Hamanoea3b7522013-04-18 19:37:531139format.coverLetter::
1140A boolean that controls whether to generate a cover-letter when
1141format-patch is invoked, but in addition can be set to "auto", to
1142generate a cover-letter only when there's more than one patch.
1143
Junio C Hamano209ebe82011-04-27 21:09:591144filter.<driver>.clean::
1145The command which is used to convert the content of a worktree
1146file to a blob upon checkin. See linkgit:gitattributes[5] for
1147details.
1148
1149filter.<driver>.smudge::
1150The command which is used to convert the content of a blob
1151object to a worktree file upon checkout. See
1152linkgit:gitattributes[5] for details.
1153
Junio C Hamanof2ce2972007-05-20 19:12:091154gc.aggressiveWindow::
1155The window size parameter used in the delta compression
Junio C Hamano1aa40d22010-01-21 17:46:431156algorithm used by 'git gc --aggressive'. This defaults
Junio C Hamanob04bb3f2010-04-14 14:07:361157to 250.
Junio C Hamanof2ce2972007-05-20 19:12:091158
Junio C Hamano1b50ce92007-10-03 12:05:531159gc.auto::
1160When there are approximately more than this many loose
1161objects in the repository, `git gc --auto` will pack them.
1162Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:171163light-weight garbage collection from time to time. The
1164default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531165
1166gc.autopacklimit::
1167When there are more than this many packs that are not
1168marked with `*.keep` file in the repository, `git gc
Junio C Hamanoe77b0152008-01-12 06:44:171169--auto` consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:371170default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531171
Junio C Hamano08ef8c22014-03-10 14:53:441172gc.autodetach::
1173Make `git gc --auto` return immediately andrun in background
1174if the system supports it. Default is true.
1175
Junio C Hamano9d52e572007-02-13 23:48:201176gc.packrefs::
Junio C Hamanob141a922010-01-10 19:55:141177Running `git pack-refs` in a repository renders it
1178unclonable by Git versions prior to 1.5.1.2 over dumb
1179transports such as HTTP. This variable determines whether
Junio C Hamanocdd1c332010-12-20 10:08:001180'git gc' runs `git pack-refs`. This can be set to `notbare`
Junio C Hamanob141a922010-01-10 19:55:141181to enable it within all non-bare repos or it can be set to a
1182boolean value. The default is `true`.
Junio C Hamano9d52e572007-02-13 23:48:201183
Junio C Hamano09a926d2008-03-13 07:55:291184gc.pruneexpire::
Junio C Hamano1aa40d22010-01-21 17:46:431185When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
Junio C Hamanoa3148f52009-01-14 08:49:571186Override the grace period with this config variable. The value
1187"now" may be used to disable this grace period and always prune
1188unreachable objects immediately.
Junio C Hamano09a926d2008-03-13 07:55:291189
Junio C Hamano74640642006-12-27 10:59:551190gc.reflogexpire::
Junio C Hamanocc7636a2010-05-21 14:57:531191gc.<pattern>.reflogexpire::
Junio C Hamano1aa40d22010-01-21 17:46:431192'git reflog expire' removes reflog entries older than
Junio C Hamanocc7636a2010-05-21 14:57:531193this time; defaults to 90 days. With "<pattern>" (e.g.
1194"refs/stash") in the middle the setting applies only to
1195the refs that match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551196
1197gc.reflogexpireunreachable::
Junio C Hamanocc7636a2010-05-21 14:57:531198gc.<ref>.reflogexpireunreachable::
Junio C Hamano1aa40d22010-01-21 17:46:431199'git reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:551200this time and are not reachable from the current tip;
Junio C Hamanocc7636a2010-05-21 14:57:531201defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1202in the middle, the setting applies only to the refs that
1203match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551204
1205gc.rerereresolved::
1206Records of conflicted merge you resolved earlier are
Junio C Hamano1aa40d22010-01-21 17:46:431207kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461208The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551209
1210gc.rerereunresolved::
1211Records of conflicted merge you have not resolved are
Junio C Hamano1aa40d22010-01-21 17:46:431212kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461213The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551214
Junio C Hamanoa3148f52009-01-14 08:49:571215gitcvs.commitmsgannotation::
1216Append this string to each commit message. Set to empty string
1217to disable this feature. Defaults to "via git-CVS emulator".
1218
Junio C Hamano07824ce2006-04-25 07:36:541219gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:271220Whether the CVS server interface is enabled for this repository.
Junio C Hamano35738e82008-01-07 07:55:461221See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541222
1223gitcvs.logfile::
Junio C Hamanoa6387422007-08-25 03:54:271224Path to a log file where the CVS server interface well... logs
Junio C Hamano35738e82008-01-07 07:55:461225various stuff. See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541226
Junio C Hamano17bd2272008-09-01 06:11:171227gitcvs.usecrlfattr::
Junio C Hamanobb88cf42010-06-21 15:23:551228If true, the server will look up the end-of-line conversion
1229attributes for files to determine the '-k' modes to use. If
Junio C Hamano076ffcc2013-02-06 05:13:211230the attributes force Git to treat a file as text,
Junio C Hamano619596a2010-08-18 22:15:351231the '-k' mode will be left blank so CVS clients will
Junio C Hamanobb88cf42010-06-21 15:23:551232treat it as text. If they suppress text conversion, the file
Junio C Hamanocb1c44f2008-08-06 06:19:331233will be set with '-kb' mode, which suppresses any newline munging
Junio C Hamanobb88cf42010-06-21 15:23:551234the client might otherwise do. If the attributes do not allow
1235the file type to be determined, then 'gitcvs.allbinary' is
1236used. See linkgit:gitattributes[5].
Junio C Hamanodfccbb02008-05-26 01:16:141237
Junio C Hamanod9e0e5d2007-04-14 16:22:041238gitcvs.allbinary::
Junio C Hamanodfccbb02008-05-26 01:16:141239This is used if 'gitcvs.usecrlfattr' does not resolve
1240the correct '-kb' mode to use. If true, all
1241unresolved files are sent to the client in
1242mode '-kb'. This causes the client to treat them
1243as binary files, which suppresses any newline munging it
1244otherwise might do. Alternatively, if it is set to "guess",
1245then the contents of the file are examined to decide if
1246it is binary, similar to 'core.autocrlf'.
Junio C Hamanoa2ad99e2007-04-18 09:57:041247
1248gitcvs.dbname::
1249Database used by git-cvsserver to cache revision information
Junio C Hamano076ffcc2013-02-06 05:13:211250derived from the Git repository. The exact meaning depends on the
Junio C Hamanoa2ad99e2007-04-18 09:57:041251used database driver, for SQLite (which is the default driver) this
1252is a filename. Supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461253linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Junio C Hamanoa2ad99e2007-04-18 09:57:041254Default: '%Ggitcvs.%m.sqlite'
1255
1256gitcvs.dbdriver::
1257Used Perl DBI driver. You can specify any available driver
Junio C Hamano804a9742013-04-28 23:10:311258for this here, but it might not work. git-cvsserver is tested
Junio C Hamanoa2ad99e2007-04-18 09:57:041259with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1260reported *not* to work with 'DBD::mysql'. Experimental feature.
1261May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamano35738e82008-01-07 07:55:461262See linkgit:git-cvsserver[1].
Junio C Hamanod9e0e5d2007-04-14 16:22:041263
Junio C Hamanoa2ad99e2007-04-18 09:57:041264gitcvs.dbuser, gitcvs.dbpass::
1265Database user and password. Only useful if setting 'gitcvs.dbdriver',
1266since SQLite has no concept of database users and/or passwords.
1267'gitcvs.dbuser' supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461268linkgit:git-cvsserver[1] for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:041269
Junio C Hamanoa74efce2008-04-02 08:39:081270gitcvs.dbTableNamePrefix::
1271Database table name prefix. Prepended to the names of any
1272database tables used, allowing a single database to be used
1273for several repositories. Supports variable substitution (see
1274linkgit:git-cvsserver[1] for details). Any non-alphabetic
1275characters will be replaced with underscores.
1276
Junio C Hamanodfccbb02008-05-26 01:16:141277All gitcvs variables except for 'gitcvs.usecrlfattr' and
1278'gitcvs.allbinary' can also be specified as
1279'gitcvs.<access_method>.<varname>' (where 'access_method'
Junio C Hamanoa6387422007-08-25 03:54:271280is one of "ext" and "pserver") to make them apply only for the given
1281access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:041282
Junio C Hamano11821ed2011-10-19 18:42:091283gitweb.category::
1284gitweb.description::
1285gitweb.owner::
1286gitweb.url::
1287See linkgit:gitweb[1] for description.
1288
1289gitweb.avatar::
1290gitweb.blame::
1291gitweb.grep::
1292gitweb.highlight::
1293gitweb.patches::
1294gitweb.pickaxe::
1295gitweb.remote_heads::
1296gitweb.showsizes::
1297gitweb.snapshot::
1298See linkgit:gitweb.conf[5] for description.
1299
Junio C Hamanoa03ac862011-04-02 04:32:291300grep.lineNumber::
1301If set to true, enable '-n' option by default.
1302
Junio C Hamanoa00504d2012-08-27 21:11:231303grep.patternType::
1304Set the default matching behavior. Using a value of 'basic', 'extended',
1305'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1306'--fixed-strings', or '--perl-regexp' option accordingly, while the
1307value 'default' will return to the default matching behavior.
1308
Junio C Hamanoa03ac862011-04-02 04:32:291309grep.extendedRegexp::
Junio C Hamanoa00504d2012-08-27 21:11:231310If set to true, enable '--extended-regexp' option by default. This
1311option is ignored when the 'grep.patternType' option is set to a value
1312other than 'default'.
Junio C Hamanoa03ac862011-04-02 04:32:291313
Junio C Hamano4fd24422012-01-06 21:52:431314gpg.program::
1315Use this custom program instead of "gpg" found on $PATH when
1316making or verifying a PGP signature. The program must support the
1317same command line interface as GPG, namely, to verify a detached
1318signature, "gpg --verify $file - <$signature" is run, and the
1319program is expected to signal a good signature by exiting with
1320code 0, and to generate an ascii-armored detached signature, the
1321standard input of "gpg -bsau $key" is fed with the contents to be
1322signed, and the program is expected to send the result to its
1323standard output.
1324
Junio C Hamano6d76d612008-05-09 05:46:081325gui.commitmsgwidth::
1326Defines how wide the commit message window is in the
1327linkgit:git-gui[1]. "75" is the default.
1328
1329gui.diffcontext::
1330Specifies how many context lines should be used in calls to diff
1331made by the linkgit:git-gui[1]. The default is "5".
1332
Junio C Hamanod3452a02008-11-15 08:07:551333gui.encoding::
1334Specifies the default encoding to use for displaying of
1335file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1336It can be overridden by setting the 'encoding' attribute
1337for relevant files (see linkgit:gitattributes[5]).
1338If this option is not set, the tools default to the
1339locale encoding.
1340
Junio C Hamano6d76d612008-05-09 05:46:081341gui.matchtrackingbranch::
1342Determines if new branches created with linkgit:git-gui[1] should
1343default to tracking remote branches with matching names or
1344not. Default: "false".
1345
1346gui.newbranchtemplate::
1347Is used as suggested name when creating new branches using the
1348linkgit:git-gui[1].
1349
1350gui.pruneduringfetch::
Junio C Hamano97bcb482010-11-25 03:16:071351"true" if linkgit:git-gui[1] should prune remote-tracking branches when
Junio C Hamano6d76d612008-05-09 05:46:081352performing a fetch. The default value is "false".
1353
1354gui.trustmtime::
1355Determines if linkgit:git-gui[1] should trust the file modification
1356timestamp or not. By default the timestamps are not trusted.
1357
1358gui.spellingdictionary::
1359Specifies the dictionary used for spell checking commit messages in
1360the linkgit:git-gui[1]. When set to "none" spell checking is turned
1361off.
1362
Junio C Hamanod3452a02008-11-15 08:07:551363gui.fastcopyblame::
Junio C Hamano1aa40d22010-01-21 17:46:431364If true, 'git gui blame' uses `-C` instead of `-C -C` for original
Junio C Hamanod3452a02008-11-15 08:07:551365location detection. It makes blame significantly faster on huge
1366repositories at the expense of less thorough copy detection.
1367
1368gui.copyblamethreshold::
Junio C Hamano610d1762008-11-28 06:27:131369Specifies the threshold to use in 'git gui blame' original location
Junio C Hamanod3452a02008-11-15 08:07:551370detection, measured in alphanumeric characters. See the
1371linkgit:git-blame[1] manual for more information on copy detection.
1372
1373gui.blamehistoryctx::
1374Specifies the radius of history context in days to show in
1375linkgit:gitk[1] for the selected commit, when the `Show History
1376Context` menu item is invoked from 'git gui blame'. If this
1377variable is set to zero, the whole history is shown.
1378
Junio C Hamano92d312a2008-12-15 07:22:201379guitool.<name>.cmd::
1380Specifies the shell command line to execute when the corresponding item
1381of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1382mandatory for every tool. The command is executed from the root of
1383the working directory, and in the environment it receives the name of
1384the tool as 'GIT_GUITOOL', the name of the currently selected file as
1385'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1386the head is detached, 'CUR_BRANCH' is empty).
1387
1388guitool.<name>.needsfile::
1389Run the tool only if a diff is selected in the GUI. It guarantees
1390that 'FILENAME' is not empty.
1391
1392guitool.<name>.noconsole::
1393Run the command silently, without creating a window to display its
1394output.
1395
1396guitool.<name>.norescan::
1397Don't rescan the working directory for changes after the tool
1398finishes execution.
1399
1400guitool.<name>.confirm::
1401Show a confirmation dialog before actually running the tool.
1402
1403guitool.<name>.argprompt::
1404Request a string argument from the user, and pass it to the tool
1405through the 'ARGS' environment variable. Since requesting an
1406argument implies confirmation, the 'confirm' option has no effect
1407if this is enabled. If the option is set to 'true', 'yes', or '1',
1408the dialog uses a built-in generic prompt; otherwise the exact
1409value of the variable is used.
1410
1411guitool.<name>.revprompt::
1412Request a single valid revision from the user, and set the
1413'REVISION' environment variable. In other aspects this option
1414is similar to 'argprompt', and can be used together with it.
1415
1416guitool.<name>.revunmerged::
1417Show only unmerged branches in the 'revprompt' subdialog.
1418This is useful for tools similar to merge or rebase, but not
1419for things like checkout or reset.
1420
1421guitool.<name>.title::
1422Specifies the title to use for the prompt dialog. The default
1423is the tool name.
1424
1425guitool.<name>.prompt::
1426Specifies the general prompt string to display at the top of
1427the dialog, before subsections for 'argprompt' and 'revprompt'.
1428The default value includes the actual command.
1429
Junio C Hamano4e272312008-01-08 09:13:211430help.browser::
1431Specify the browser that will be used to display help in the
1432'web' format. See linkgit:git-help[1].
1433
1434help.format::
1435Override the default help format used by linkgit:git-help[1].
1436Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1437the default. 'web' and 'html' are the same.
1438
Junio C Hamanof24b8062008-09-09 01:34:391439help.autocorrect::
1440Automatically correct and execute mistyped commands after
1441waiting for the given number of deciseconds (0.1 sec). If more
1442than one command can be deduced from the entered text, nothing
1443will be executed. If the value of this option is negative,
1444the corrected command will be executed immediately. If the
1445value is 0 - the command will be just shown but not executed.
1446This is the default.
1447
Junio C Hamano5dd5fae2013-01-18 21:06:491448help.htmlpath::
1449Specify the path where the HTML documentation resides. File system paths
1450and URLs are supported. HTML pages will be prefixed with this path when
1451help is displayed in the 'web' format. This defaults to the documentation
1452path of your Git installation.
1453
Junio C Hamano58256872007-12-04 08:31:131454http.proxy::
Junio C Hamano3dd93922012-03-05 07:49:111455Override the HTTP proxy, normally configured using the 'http_proxy',
1456'https_proxy', and 'all_proxy' environment variables (see
1457`curl(1)`). This can be overridden on a per-remote basis; see
1458remote.<name>.proxy
Junio C Hamano58256872007-12-04 08:31:131459
Junio C Hamano4c4b0122011-06-30 01:19:321460http.cookiefile::
1461File containing previously stored cookie lines which should be used
Junio C Hamano076ffcc2013-02-06 05:13:211462in the Git http session, if they match the server. The file format
Junio C Hamano4c4b0122011-06-30 01:19:321463of the file to read cookies from should be plain HTTP headers or
1464the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1465NOTE that the file specified with http.cookiefile is only used as
Junio C Hamano8eac2682013-09-09 22:35:201466input unless http.saveCookies is set.
1467
1468http.savecookies::
1469If set, store cookies received during requests to the file specified by
1470http.cookiefile. Has no effect if http.cookiefile is unset.
Junio C Hamano4c4b0122011-06-30 01:19:321471
Junio C Hamano07824ce2006-04-25 07:36:541472http.sslVerify::
1473Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451474over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Junio C Hamano07824ce2006-04-25 07:36:541475variable.
1476
1477http.sslCert::
1478File containing the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451479over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Junio C Hamano07824ce2006-04-25 07:36:541480variable.
1481
1482http.sslKey::
1483File containing the SSL private key when fetching or pushing
Junio C Hamano341071d2006-06-04 07:24:481484over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Junio C Hamano07824ce2006-04-25 07:36:541485variable.
1486
Junio C Hamano48bc1ce2009-07-09 16:49:191487http.sslCertPasswordProtected::
Junio C Hamano076ffcc2013-02-06 05:13:211488Enable Git's password prompt for the SSL certificate. Otherwise
Junio C Hamano48bc1ce2009-07-09 16:49:191489OpenSSL will prompt the user, possibly many times, if the
1490certificate or private key is encrypted. Can be overridden by the
1491'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1492
Junio C Hamano07824ce2006-04-25 07:36:541493http.sslCAInfo::
1494File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:481495fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano07824ce2006-04-25 07:36:541496'GIT_SSL_CAINFO' environment variable.
1497
1498http.sslCAPath::
1499Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:451500with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541501by the 'GIT_SSL_CAPATH' environment variable.
1502
Junio C Hamano76927822013-04-19 21:26:571503http.sslTry::
1504Attempt to use AUTH SSL/TLS and encrypted data transfers
1505when connecting via regular FTP protocol. This might be needed
1506if the FTP server requires it for security reasons or you wish
1507to connect securely whenever remote FTP server supports it.
1508Default is false since it might trigger certificate verification
1509errors on misconfigured servers.
1510
Junio C Hamano07824ce2006-04-25 07:36:541511http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:481512How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541513by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1514
Junio C Hamanob141a922010-01-10 19:55:141515http.minSessions::
1516The number of curl sessions (counted across slots) to be kept across
1517requests. They will not be ended with curl_easy_cleanup() until
1518http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1519value will be capped at 1. Defaults to 1.
1520
Junio C Hamano3b70d3c2009-11-21 17:37:371521http.postBuffer::
1522Maximum size in bytes of the buffer used by smart HTTP
1523transports when POSTing data to the remote system.
1524For requests larger than this buffer size, HTTP/1.1 and
1525Transfer-Encoding: chunked is used to avoid creating a
1526massive pack file locally. Default is 1 MiB, which is
1527sufficient for most requests.
1528
Junio C Hamano07824ce2006-04-25 07:36:541529http.lowSpeedLimit, http.lowSpeedTime::
1530If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1531for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano341071d2006-06-04 07:24:481532Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Junio C Hamano07824ce2006-04-25 07:36:541533'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1534
Junio C Hamanof1dcdfe2006-09-29 08:10:511535http.noEPSV::
1536A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:041537This can helpful with some "poor" ftp servers which don't
Junio C Hamanof1dcdfe2006-09-29 08:10:511538support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1539environment variable. Default is false (curl will use EPSV).
1540
Junio C Hamano53ba6d02010-08-22 07:25:121541http.useragent::
1542The HTTP USER_AGENT string presented to an HTTP server. The default
Junio C Hamano076ffcc2013-02-06 05:13:211543value represents the version of the client Git such as git/1.7.1.
Junio C Hamano53ba6d02010-08-22 07:25:121544This option allows you to override this value to a more common value
1545such as Mozilla/4.0. This may be necessary, for instance, if
1546connecting through a firewall that restricts HTTP connections to a set
1547of common USER_AGENT strings (but not including those like git/1.7.1).
1548Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1549
Junio C Hamano8eac2682013-09-09 22:35:201550http.<url>.*::
1551Any of the http.* options above can be applied selectively to some urls.
1552For a config key to match a URL, each element of the config key is
1553compared to that of the URL, in the following order:
1554+
1555--
1556. Scheme (e.g., `https` in `https://example.com/`). This field
1557 must match exactly between the config key and the URL.
1558
1559. Host/domain name (e.g., `example.com` in `https://example.com/`).
1560 This field must match exactly between the config key and the URL.
1561
1562. Port number (e.g., `8080` in `http://example.com:8080/`).
1563 This field must match exactly between the config key and the URL.
1564 Omitted port numbers are automatically converted to the correct
1565 default for the scheme before matching.
1566
1567. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1568 path field of the config key must match the path field of the URL
1569 either exactly or as a prefix of slash-delimited path elements. This means
1570 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1571 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1572 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1573 key with just path `foo/`).
1574
1575. User name (e.g., `user` in `https://user@example.com/repo.git`). If
1576 the config key has a user name it must match the user name in the
1577 URL exactly. If the config key does not have a user name, that
1578 config key will match a URL with any user name (including none),
1579 but at a lower precedence than a config key with a user name.
1580--
1581+
1582The list above is ordered by decreasing precedence; a URL that matches
1583a config key's path is preferred to one that matches its user name. For example,
1584if the URL is `https://user@example.com/foo/bar` a config key match of
1585`https://example.com/foo` will be preferred over a config key match of
1586`https://user@example.com`.
1587+
1588All URLs are normalized before attempting any matching (the password part,
1589if embedded in the URL, is always ignored for matching purposes) so that
1590equivalent urls that are simply spelled differently will match properly.
1591Environment variable settings always override any matches. The urls that are
1592matched against are those given directly to Git commands. This means any URLs
1593visited as a result of a redirection do not participate in matching.
1594
Junio C Hamano07824ce2006-04-25 07:36:541595i18n.commitEncoding::
Junio C Hamano076ffcc2013-02-06 05:13:211596Character encoding the commit messages are stored in; Git itself
Junio C Hamano07824ce2006-04-25 07:36:541597does not care per se, but this information is necessary e.g. when
1598importing commits from emails or in the gitk graphical history
1599browser (and possibly at other places in the future or in other
Junio C Hamano35738e82008-01-07 07:55:461600porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Junio C Hamano07824ce2006-04-25 07:36:541601
Junio C Hamano51f92e22006-12-29 05:18:281602i18n.logOutputEncoding::
1603Character encoding the commit messages are converted to when
Junio C Hamano1aa40d22010-01-21 17:46:431604running 'git log' and friends.
Junio C Hamano51f92e22006-12-29 05:18:281605
Junio C Hamano4653c6f2008-11-26 22:50:201606imap::
1607The configuration variables in the 'imap' section are described
1608in linkgit:git-imap-send[1].
1609
Junio C Hamanocaa712a2010-03-11 01:17:351610init.templatedir::
1611Specify the directory from which templates will be copied.
1612(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1613
Junio C Hamano4e272312008-01-08 09:13:211614instaweb.browser::
1615Specify the program that will be used to browse your working
1616repository in gitweb. See linkgit:git-instaweb[1].
1617
1618instaweb.httpd::
1619The HTTP daemon command-line to start gitweb on your working
1620repository. See linkgit:git-instaweb[1].
1621
1622instaweb.local::
1623If true the web server started by linkgit:git-instaweb[1] will
1624be bound to the local IP (127.0.0.1).
1625
1626instaweb.modulepath::
Junio C Hamano619596a2010-08-18 22:15:351627The default module path for linkgit:git-instaweb[1] to use
1628instead of /usr/lib/apache2/modules. Only used if httpd
1629is Apache.
Junio C Hamano4e272312008-01-08 09:13:211630
1631instaweb.port::
1632The port number to bind the gitweb httpd to. See
1633linkgit:git-instaweb[1].
1634
Junio C Hamanoe5bf6c12009-02-07 21:43:101635interactive.singlekey::
Junio C Hamano27a128b2009-08-13 01:23:001636In interactive commands, allow the user to provide one-letter
Junio C Hamanoe5bf6c12009-02-07 21:43:101637input with a single key (i.e., without hitting enter).
Junio C Hamanob76a6862012-05-02 22:02:461638Currently this is used by the `--patch` mode of
Junio C Hamano3d050d62011-05-17 06:43:341639linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1640linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1641setting is silently ignored if portable keystroke input
1642is not available.
Junio C Hamanoe5bf6c12009-02-07 21:43:101643
Junio C Hamanof93530e2011-05-25 23:59:591644log.abbrevCommit::
1645If true, makes linkgit:git-log[1], linkgit:git-show[1], and
Junio C Hamanob76a6862012-05-02 22:02:461646linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1647override this option with `--no-abbrev-commit`.
Junio C Hamanof93530e2011-05-25 23:59:591648
Junio C Hamanob713ff12008-05-24 01:12:301649log.date::
Junio C Hamano2db3e752010-09-03 21:33:061650Set the default date-time mode for the 'log' command.
1651Setting a value for log.date is similar to using 'git log''s
Junio C Hamanob76a6862012-05-02 22:02:461652`--date` option. Possible values are `relative`, `local`,
Junio C Hamano2db3e752010-09-03 21:33:061653`default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1654for details.
Junio C Hamanob713ff12008-05-24 01:12:301655
Junio C Hamanocb39aea2010-05-09 07:24:481656log.decorate::
1657Print out the ref names of any commits that are shown by the log
1658command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1659'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1660specified, the full ref name (including prefix) will be printed.
1661This is the same as the log commands '--decorate' option.
1662
Junio C Hamanofe9acab2006-11-24 12:10:551663log.showroot::
1664If true, the initial commit will be shown as a big creation event.
1665This is equivalent to a diff against an empty tree.
Junio C Hamano35738e82008-01-07 07:55:461666Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Junio C Hamanofe9acab2006-11-24 12:10:551667normally hide the root commit will now show it. True by default.
1668
Junio C Hamanoce836cc2013-01-21 02:01:531669log.mailmap::
1670If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1671linkgit:git-whatchanged[1] assume `--use-mailmap`.
1672
Junio C Hamano8bc410e2009-02-15 10:38:191673mailmap.file::
1674The location of an augmenting mailmap file. The default
1675mailmap, located in the root of the repository, is loaded
1676first, then the mailmap file pointed to by this variable.
1677The location of the mailmap file may be in a repository
1678subdirectory, or somewhere outside of the repository itself.
1679See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1680
Junio C Hamanoabad6da2013-01-06 09:06:321681mailmap.blob::
1682Like `mailmap.file`, but consider the value as a reference to a
1683blob in the repository. If both `mailmap.file` and
1684`mailmap.blob` are given, both are parsed, with entries from
1685`mailmap.file` taking precedence. In a bare repository, this
1686defaults to `HEAD:.mailmap`. In a non-bare repository, it
1687defaults to empty.
1688
Junio C Hamano8b588d52008-03-15 09:48:371689man.viewer::
1690Specify the programs that may be used to display help in the
1691'man' format. See linkgit:git-help[1].
1692
Junio C Hamano6d76d612008-05-09 05:46:081693man.<tool>.cmd::
1694Specify the command to invoke the specified man viewer. The
1695specified command is evaluated in shell with the man page
1696passed as argument. (See linkgit:git-help[1].)
Junio C Hamano103ad7f2007-03-14 11:19:261697
Junio C Hamano6d76d612008-05-09 05:46:081698man.<tool>.path::
1699Override the path for the given tool that may be used to
1700display help in the 'man' format. See linkgit:git-help[1].
Junio C Hamanoe90436a2007-04-22 07:22:131701
Junio C Hamano4653c6f2008-11-26 22:50:201702include::merge-config.txt[]
Junio C Hamanoa476efa2008-10-10 15:31:421703
Junio C Hamano1fbbbc12007-12-18 07:01:271704mergetool.<tool>.path::
1705Override the path for the given tool. This is useful in case
1706your tool is not in the PATH.
1707
Junio C Hamano86bcccc2008-03-08 09:33:551708mergetool.<tool>.cmd::
1709Specify the command to invoke the specified merge tool. The
1710specified command is evaluated in shell with the following
1711variables available: 'BASE' is the name of a temporary file
1712containing the common base of the files to be merged, if available;
1713'LOCAL' is the name of a temporary file containing the contents of
1714the file on the current branch; 'REMOTE' is the name of a temporary
1715file containing the contents of the file from the branch being
1716merged; 'MERGED' contains the name of the file to which the merge
1717tool should write the results of a successful merge.
1718
1719mergetool.<tool>.trustExitCode::
1720For a custom merge command, specify whether the exit code of
1721the merge command can be used to determine whether the merge was
1722successful. If this is not set to true then the merge target file
1723timestamp is checked and the merge assumed to have been successful
1724if the file has been updated, otherwise the user is prompted to
1725indicate the success of the merge.
1726
1727mergetool.keepBackup::
1728After performing a merge, the original file with conflict markers
1729can be saved as a file with a `.orig` extension. If this variable
1730is set to `false` then this file is not preserved. Defaults to
1731`true` (i.e. keep the backup files).
1732
Junio C Hamano10b7a342009-01-01 22:05:171733mergetool.keepTemporaries::
Junio C Hamano076ffcc2013-02-06 05:13:211734When invoking a custom merge tool, Git uses a set of temporary
Junio C Hamano10b7a342009-01-01 22:05:171735files to pass to the tool. If the tool returns an error and this
1736variable is set to `true`, then these temporary files will be
1737preserved, otherwise they will be removed after the tool has
1738exited. Defaults to `false`.
1739
1740mergetool.prompt::
1741Prompt before each invocation of the merge resolution program.
1742
Junio C Hamano31667362010-03-25 00:38:531743notes.displayRef::
1744The (fully qualified) refname from which to show notes when
1745showing commit messages. The value of this variable can be set
1746to a glob, in which case notes from all matching refs will be
1747shown. You may also specify this configuration variable
1748several times. A warning will be issued for refs that do not
1749exist, but a glob that does not match any refs is silently
1750ignored.
1751+
1752This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1753environment variable, which must be a colon separated list of refs or
1754globs.
1755+
1756The effective value of "core.notesRef" (possibly overridden by
1757GIT_NOTES_REF) is also implicitly added to the list of refs to be
1758displayed.
1759
1760notes.rewrite.<command>::
1761When rewriting commits with <command> (currently `amend` or
Junio C Hamano076ffcc2013-02-06 05:13:211762`rebase`) and this variable is set to `true`, Git
Junio C Hamano31667362010-03-25 00:38:531763automatically copies your notes from the original to the
1764rewritten commit. Defaults to `true`, but see
1765"notes.rewriteRef" below.
Junio C Hamano31667362010-03-25 00:38:531766
1767notes.rewriteMode::
1768When copying notes during a rewrite (see the
1769"notes.rewrite.<command>" option), determines what to do if
1770the target commit already has a note. Must be one of
1771`overwrite`, `concatenate`, or `ignore`. Defaults to
1772`concatenate`.
1773+
1774This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1775environment variable.
1776
1777notes.rewriteRef::
1778When copying notes during a rewrite, specifies the (fully
1779qualified) ref whose notes should be copied. The ref may be a
1780glob, in which case notes in all matching refs will be copied.
1781You may also specify this configuration several times.
1782+
1783Does not have a default value; you must configure this variable to
Junio C Hamano8fb66e52011-10-05 20:59:511784enable note rewriting. Set it to `refs/notes/commits` to enable
1785rewriting for the default commit notes.
Junio C Hamano2b3ee5d2010-05-08 05:41:181786+
1787This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1788environment variable, which must be a colon separated list of refs or
1789globs.
Junio C Hamano31667362010-03-25 00:38:531790
Junio C Hamano75cc4c92006-07-24 08:25:031791pack.window::
Junio C Hamano35738e82008-01-07 07:55:461792The size of the window used by linkgit:git-pack-objects[1] when no
Junio C Hamano75cc4c92006-07-24 08:25:031793window size is given on the command line. Defaults to 10.
1794
Junio C Hamano91d44c52007-05-09 07:16:071795pack.depth::
Junio C Hamano35738e82008-01-07 07:55:461796The maximum delta depth used by linkgit:git-pack-objects[1] when no
Junio C Hamano91d44c52007-05-09 07:16:071797maximum depth is given on the command line. Defaults to 50.
1798
Junio C Hamano235d53f2007-07-13 00:25:151799pack.windowMemory::
Junio C Hamano35738e82008-01-07 07:55:461800The window memory size limit used by linkgit:git-pack-objects[1]
Junio C Hamano235d53f2007-07-13 00:25:151801when no limit is given on the command line. The value can be
1802suffixed with "k", "m", or "g". Defaults to 0, meaning no
1803limit.
1804
Junio C Hamanof2ce2972007-05-20 19:12:091805pack.compression::
1806An integer -1..9, indicating the compression level for objects
1807in a pack file. -1 is the zlib default. 0 means no
1808compression, and 1..9 are various speed/size tradeoffs, 9 being
1809slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:421810not set, defaults to -1, the zlib default, which is "a default
1811compromise between speed and compression (currently equivalent
1812to level 6)."
Junio C Hamano657fd8a2010-10-07 00:01:241813+
1814Note that changing the compression level will not automatically recompress
1815all existing objects. You can force recompression by passing the -F option
1816to linkgit:git-repack[1].
Junio C Hamanof2ce2972007-05-20 19:12:091817
Junio C Hamano679d22d2007-06-02 21:13:441818pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:271819The maximum memory in bytes used for caching deltas in
Junio C Hamano9f883862009-08-11 06:23:521820linkgit:git-pack-objects[1] before writing them out to a pack.
1821This cache is used to speed up the writing object phase by not
1822having to recompute the final delta result once the best match
1823for all objects is found. Repacking large repositories on machines
1824which are tight with memory might be badly impacted by this though,
1825especially if this cache pushes the system into swapping.
1826A value of 0 means no limit. The smallest size of 1 byte may be
1827used to virtually disable this cache. Defaults to 256 MiB.
Junio C Hamano679d22d2007-06-02 21:13:441828
1829pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:141830The maximum size of a delta, that is cached in
Junio C Hamano9f883862009-08-11 06:23:521831linkgit:git-pack-objects[1]. This cache is used to speed up the
1832writing object phase by not having to recompute the final delta
1833result once the best match for all objects is found. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:441834
Junio C Hamano58155b42007-09-15 07:46:141835pack.threads::
1836Specifies the number of threads to spawn when searching for best
Junio C Hamano35738e82008-01-07 07:55:461837delta matches. This requires that linkgit:git-pack-objects[1]
Junio C Hamano58155b42007-09-15 07:46:141838be compiled with pthreads otherwise this option is ignored with a
1839warning. This is meant to reduce packing time on multiprocessor
1840machines. The required amount of memory for the delta search window
1841is however multiplied by the number of threads.
Junio C Hamano076ffcc2013-02-06 05:13:211842Specifying 0 will cause Git to auto-detect the number of CPU's
Junio C Hamano24bc09a2008-02-28 00:27:441843and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:141844
Junio C Hamanod814b6d2007-11-04 11:13:491845pack.indexVersion::
1846Specify the default pack index version. Valid values are 1 for
1847legacy pack index used by Git versions prior to 1.5.2, and 2 for
1848the new pack index with capabilities for packs larger than 4 GB
1849as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:381850packs. Version 2 is the default. Note that version 2 is enforced
1851and this config option ignored whenever the corresponding pack is
1852larger than 2 GB.
1853+
Junio C Hamano076ffcc2013-02-06 05:13:211854If you have an old Git that does not understand the version 2 `*.idx` file,
Junio C Hamanofce7c7e2008-07-02 03:06:381855cloning or fetching over a non native protocol (e.g. "http" and "rsync")
Junio C Hamanob76a6862012-05-02 22:02:461856that will copy both `*.pack` file and corresponding `*.idx` file from the
Junio C Hamanofce7c7e2008-07-02 03:06:381857other side may give you a repository that cannot be accessed with your
Junio C Hamano076ffcc2013-02-06 05:13:211858older version of Git. If the `*.pack` file is smaller than 2 GB, however,
Junio C Hamanofce7c7e2008-07-02 03:06:381859you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
Junio C Hamanob76a6862012-05-02 22:02:461860the `*.idx` file.
Junio C Hamanod814b6d2007-11-04 11:13:491861
Junio C Hamano09a926d2008-03-13 07:55:291862pack.packSizeLimit::
Junio C Hamano4d979582010-02-04 06:27:291863The maximum size of a pack. This setting only affects
1864packing to a file when repacking, i.e. the git:// protocol
Junio C Hamanob76a6862012-05-02 22:02:461865is unaffected. It can be overridden by the `--max-pack-size`
Junio C Hamano4d979582010-02-04 06:27:291866option of linkgit:git-repack[1]. The minimum size allowed is
1867limited to 1 MiB. The default is unlimited.
1868Common unit suffixes of 'k', 'm', or 'g' are
1869supported.
Junio C Hamano49dccaf2008-02-10 10:48:011870
Junio C Hamano5b3533d2014-02-27 23:07:151871pack.useBitmaps::
1872When true, git will use pack bitmaps (if available) when packing
1873to stdout (e.g., during the server side of a fetch). Defaults to
1874true. You should not generally need to turn this off unless
1875you are debugging pack bitmaps.
1876
1877pack.writebitmaps::
1878When true, git will write a bitmap index when packing all
1879objects to disk (e.g., when `git repack -a` is run). This
1880index can speed up the "counting objects" phase of subsequent
1881packs created for clones and fetches, at the cost of some disk
1882space and extra time spent on the initial repack. Defaults to
1883false.
1884
1885pack.writeBitmapHashCache::
1886When true, git will include a "hash cache" section in the bitmap
1887index (if one is written). This cache can be used to feed git's
1888delta heuristics, potentially leading to better deltas between
1889bitmapped and non-bitmapped objects (e.g., when serving a fetch
1890between an older, bitmapped pack and objects that have been
1891pushed since the last gc). The downside is that it consumes 4
1892bytes per object of disk space, and that JGit's bitmap
1893implementation does not understand it, causing it to complain if
1894Git and JGit are used on the same repository. Defaults to false.
1895
Junio C Hamano9e96a1a2008-08-16 10:23:181896pager.<cmd>::
Junio C Hamano788eeba2010-12-08 22:50:431897If the value is boolean, turns on or off pagination of the
Junio C Hamano076ffcc2013-02-06 05:13:211898output of a particular Git subcommand when writing to a tty.
Junio C Hamano788eeba2010-12-08 22:50:431899Otherwise, turns on pagination for the subcommand using the
Junio C Hamanob76a6862012-05-02 22:02:461900pager specified by the value of `pager.<cmd>`. If `--paginate`
1901or `--no-pager` is specified on the command line, it takes
Junio C Hamano788eeba2010-12-08 22:50:431902precedence over this option. To disable pagination for all
1903commands, set `core.pager` or `GIT_PAGER` to `cat`.
Junio C Hamano9e96a1a2008-08-16 10:23:181904
Junio C Hamanoa574a092010-06-13 19:57:101905pretty.<name>::
1906Alias for a --pretty= format string, as specified in
1907linkgit:git-log[1]. Any aliases defined here can be used just
1908as the built-in pretty formats could. For example,
Junio C Hamanob76a6862012-05-02 22:02:461909running `git config pretty.changelog "format:* %H %s"`
Junio C Hamanoa574a092010-06-13 19:57:101910would cause the invocation `git log --pretty=changelog`
Junio C Hamanob76a6862012-05-02 22:02:461911to be equivalent to running `git log "--pretty=format:* %H %s"`.
Junio C Hamanoa574a092010-06-13 19:57:101912Note that an alias with the same name as a built-in format
1913will be silently ignored.
1914
Junio C Hamano5b3533d2014-02-27 23:07:151915pull.ff::
1916By default, Git does not create an extra merge commit when merging
1917a commit that is a descendant of the current commit. Instead, the
1918tip of the current branch is fast-forwarded. When set to `false`,
1919this variable tells Git to create an extra merge commit in such
1920a case (equivalent to giving the `--no-ff` option from the command
1921line). When set to `only`, only such fast-forward merges are
1922allowed (equivalent to giving the `--ff-only` option from the
1923command line).
1924
Junio C Hamano515ab1d2011-12-09 23:41:201925pull.rebase::
1926When true, rebase branches on top of the fetched branch, instead
1927of merging the default branch from the default remote when "git
1928pull" is run. See "branch.<name>.rebase" for setting this on a
1929per-branch basis.
1930+
Junio C Hamanocf4a1742013-09-11 22:57:501931When preserve, also pass `--preserve-merges` along to 'git rebase'
1932so that locally committed merge commits will not be flattened
1933by running 'git pull'.
1934+
Junio C Hamano515ab1d2011-12-09 23:41:201935*NOTE*: this is a possibly dangerous operation; do *not* use
1936it unless you understand the implications (see linkgit:git-rebase[1]
1937for details).
1938
Junio C Hamano07824ce2006-04-25 07:36:541939pull.octopus::
1940The default merge strategy to use when pulling multiple branches
1941at once.
1942
1943pull.twohead::
1944The default merge strategy to use when pulling a single branch.
1945
Junio C Hamano1de75722009-03-26 08:39:381946push.default::
Junio C Hamano58655592013-07-11 20:52:331947Defines the action `git push` should take if no refspec is
1948explicitly given. Different values are well-suited for
1949specific workflows; for instance, in a purely central workflow
1950(i.e. the fetch source is equal to the push destination),
1951`upstream` is probably what you want. Possible values are:
Junio C Hamano1de75722009-03-26 08:39:381952+
Junio C Hamanobcaa8bc2012-07-03 22:17:201953--
Junio C Hamano58655592013-07-11 20:52:331954
1955* `nothing` - do not push anything (error out) unless a refspec is
1956 explicitly given. This is primarily meant for people who want to
1957 avoid mistakes by always being explicit.
1958
1959* `current` - push the current branch to update a branch with the same
1960 name on the receiving end. Works in both central and non-central
1961 workflows.
1962
1963* `upstream` - push the current branch back to the branch whose
1964 changes are usually integrated into the current branch (which is
1965 called `@{upstream}`). This mode only makes sense if you are
1966 pushing to the same repository you would normally pull from
1967 (i.e. central workflow).
1968
1969* `simple` - in centralized workflow, work like `upstream` with an
1970 added safety to refuse to push if the upstream branch's name is
1971 different from the local one.
Junio C Hamanobcaa8bc2012-07-03 22:17:201972+
Junio C Hamano58655592013-07-11 20:52:331973When pushing to a remote that is different from the remote you normally
1974pull from, work as `current`. This is the safest option and is suited
1975for beginners.
1976+
Junio C Hamano1d669b82014-03-11 21:36:001977This mode has become the default in Git 2.0.
Junio C Hamano58655592013-07-11 20:52:331978
1979* `matching` - push all branches having the same name on both ends.
1980 This makes the repository you are pushing to remember the set of
1981 branches that will be pushed out (e.g. if you always push 'maint'
1982 and 'master' there and no other branches, the repository you push
1983 to will have these two branches, and your local 'maint' and
1984 'master' will be pushed there).
1985+
1986To use this mode effectively, you have to make sure _all_ the
1987branches you would push out are ready to be pushed out before
1988running 'git push', as the whole point of this mode is to allow you
1989to push all of the branches in one go. If you usually finish work
1990on only one branch and push out the result, while other branches are
1991unfinished, this mode is not for you. Also this mode is not
1992suitable for pushing into a shared central repository, as other
1993people may add new branches there, or update the tip of existing
1994branches outside your control.
1995+
Junio C Hamano1d669b82014-03-11 21:36:001996This used to be the default, but not since Git 2.0 (`simple` is the
1997new default).
Junio C Hamano58655592013-07-11 20:52:331998
1999--
Junio C Hamano1de75722009-03-26 08:39:382000
Junio C Hamanoea6a7642009-03-11 23:56:192001rebase.stat::
2002Whether to show a diffstat of what changed upstream since the last
2003rebase. False by default.
2004
Junio C Hamano075ae872010-09-01 18:43:072005rebase.autosquash::
2006If set to true enable '--autosquash' option by default.
2007
Junio C Hamanof1f5a7b2013-06-11 22:23:522008rebase.autostash::
2009When set to true, automatically create a temporary stash
2010before the operation begins, and apply it after the operation
2011ends. This means that you can run rebase on a dirty worktree.
2012However, use with care: the final stash application after a
2013successful rebase might result in non-trivial conflicts.
2014Defaults to false.
2015
Junio C Hamano621e1232009-10-26 05:16:472016receive.autogc::
2017By default, git-receive-pack will run "git-gc --auto" after
2018receiving data from git-push and updating refs. You can stop
2019it by setting this variable to false.
2020
Junio C Hamano4653c6f2008-11-26 22:50:202021receive.fsckObjects::
2022If it is set to true, git-receive-pack will check all received
2023objects. It will abort in the case of a malformed object or a
2024broken link. The result of an abort are only dangling objects.
Junio C Hamano8fb66e52011-10-05 20:59:512025Defaults to false. If not set, the value of `transfer.fsckObjects`
2026is used instead.
Junio C Hamano4653c6f2008-11-26 22:50:202027
2028receive.unpackLimit::
2029If the number of objects received in a push is below this
2030limit then the objects will be unpacked into loose object
2031files. However if the number of received objects equals or
2032exceeds this limit then the received pack will be stored as
2033a pack, after adding any missing delta bases. Storing the
2034pack from a push can make the push operation complete faster,
2035especially on slow filesystems. If not set, the value of
2036`transfer.unpackLimit` is used instead.
2037
2038receive.denyDeletes::
2039If set to true, git-receive-pack will deny a ref update that deletes
2040the ref. Use this to prevent such a ref deletion via a push.
2041
Junio C Hamanob4448a82010-07-26 09:02:322042receive.denyDeleteCurrent::
2043If set to true, git-receive-pack will deny a ref update that
2044deletes the currently checked out branch of a non-bare repository.
2045
Junio C Hamano4653c6f2008-11-26 22:50:202046receive.denyCurrentBranch::
Junio C Hamanoe97d5772010-05-19 08:13:582047If set to true or "refuse", git-receive-pack will deny a ref update
Junio C Hamano4653c6f2008-11-26 22:50:202048to the currently checked out branch of a non-bare repository.
2049Such a push is potentially dangerous because it brings the HEAD
2050out of sync with the index and working tree. If set to "warn",
2051print a warning of such a push to stderr, but allow the push to
2052proceed. If set to false or "ignore", allow such pushes with no
Junio C Hamanoafb395b2010-03-17 22:16:152053message. Defaults to "refuse".
Junio C Hamano4653c6f2008-11-26 22:50:202054
2055receive.denyNonFastForwards::
2056If set to true, git-receive-pack will deny a ref update which is
Junio C Hamano3f680f32009-11-16 02:10:542057not a fast-forward. Use this to prevent such an update via a push,
Junio C Hamano4653c6f2008-11-26 22:50:202058even if that push is forced. This configuration variable is
2059set when initializing a shared repository.
2060
Junio C Hamano80ad00d2013-02-18 00:19:032061receive.hiderefs::
2062String(s) `receive-pack` uses to decide which refs to omit
2063from its initial advertisement. Use more than one
2064definitions to specify multiple prefix strings. A ref that
2065are under the hierarchies listed on the value of this
2066variable is excluded, and is hidden when responding to `git
2067push`, and an attempt to update or delete a hidden ref by
2068`git push` is rejected.
2069
Junio C Hamano621e1232009-10-26 05:16:472070receive.updateserverinfo::
2071If set to true, git-receive-pack will run git-update-server-info
2072after receiving data from git-push and updating refs.
2073
Junio C Hamano61525f92014-01-17 22:46:492074receive.shallowupdate::
2075If set to true, .git/shallow can be updated when new refs
2076require new shallow roots. Otherwise those refs are rejected.
2077
Junio C Hamano63b6fdb2013-04-07 23:37:132078remote.pushdefault::
2079The remote to push to by default. Overrides
2080`branch.<name>.remote` for all branches, and is overridden by
2081`branch.<name>.pushremote` for specific branches.
2082
Junio C Hamano249572f2006-10-24 05:44:082083remote.<name>.url::
Junio C Hamano35738e82008-01-07 07:55:462084The URL of a remote repository. See linkgit:git-fetch[1] or
2085linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:082086
Junio C Hamano0e88f3e2009-06-21 08:03:252087remote.<name>.pushurl::
2088The push URL of a remote repository. See linkgit:git-push[1].
2089
Junio C Hamano58256872007-12-04 08:31:132090remote.<name>.proxy::
2091For remotes that require curl (http, https and ftp), the URL to
2092the proxy to use for that remote. Set to the empty string to
2093disable proxying for that remote.
2094
Junio C Hamano249572f2006-10-24 05:44:082095remote.<name>.fetch::
Junio C Hamano35738e82008-01-07 07:55:462096The default set of "refspec" for linkgit:git-fetch[1]. See
2097linkgit:git-fetch[1].
Junio C Hamano249572f2006-10-24 05:44:082098
2099remote.<name>.push::
Junio C Hamano35738e82008-01-07 07:55:462100The default set of "refspec" for linkgit:git-push[1]. See
2101linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:082102
Junio C Hamano47d68a52008-05-06 06:35:402103remote.<name>.mirror::
2104If true, pushing to this remote will automatically behave
Junio C Hamanob76a6862012-05-02 22:02:462105as if the `--mirror` option was given on the command line.
Junio C Hamano47d68a52008-05-06 06:35:402106
Junio C Hamano118d2772007-02-21 20:24:102107remote.<name>.skipDefaultUpdate::
2108If true, this remote will be skipped by default when updating
Junio C Hamano9df0c662009-11-23 11:09:272109using linkgit:git-fetch[1] or the `update` subcommand of
2110linkgit:git-remote[1].
2111
2112remote.<name>.skipFetchAll::
2113If true, this remote will be skipped by default when updating
2114using linkgit:git-fetch[1] or the `update` subcommand of
2115linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:102116
Junio C Hamano4ad294b2007-01-20 02:22:502117remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:482118The default program to execute on the remote side when pushing. See
Junio C Hamano86bcccc2008-03-08 09:33:552119option \--receive-pack of linkgit:git-push[1].
Junio C Hamano4ad294b2007-01-20 02:22:502120
Junio C Hamano54ea8d32007-01-25 07:59:482121remote.<name>.uploadpack::
2122The default program to execute on the remote side when fetching. See
Junio C Hamano86bcccc2008-03-08 09:33:552123option \--upload-pack of linkgit:git-fetch-pack[1].
Junio C Hamano54ea8d32007-01-25 07:59:482124
Junio C Hamano17dde0e2007-02-26 09:50:212125remote.<name>.tagopt::
Junio C Hamano86bcccc2008-03-08 09:33:552126Setting this value to \--no-tags disables automatic tag following when
Junio C Hamanocc7636a2010-05-21 14:57:532127fetching from remote <name>. Setting it to \--tags will fetch every
2128tag from remote <name>, even if they are not reachable from remote
Junio C Hamano075ae872010-09-01 18:43:072129branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2130override this setting. See options \--tags and \--no-tags of
2131linkgit:git-fetch[1].
Junio C Hamano17dde0e2007-02-26 09:50:212132
Junio C Hamano096dde22009-12-26 23:14:112133remote.<name>.vcs::
Junio C Hamano076ffcc2013-02-06 05:13:212134Setting this to a value <vcs> will cause Git to interact with
Junio C Hamano096dde22009-12-26 23:14:112135the remote with the git-remote-<vcs> helper.
2136
Junio C Hamano8eac2682013-09-09 22:35:202137remote.<name>.prune::
2138When set to true, fetching from this remote by default will also
Junio C Hamano4c8f2d92013-12-13 00:55:422139remove any remote-tracking references that no longer exist on the
2140remote (as if the `--prune` option was given on the command line).
Junio C Hamano8eac2682013-09-09 22:35:202141Overrides `fetch.prune` settings, if any.
2142
Junio C Hamano118d2772007-02-21 20:24:102143remotes.<group>::
2144The list of remotes which are fetched by "git remote update
Junio C Hamano35738e82008-01-07 07:55:462145<group>". See linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:102146
Junio C Hamano77b7e902006-10-23 07:18:502147repack.usedeltabaseoffset::
Junio C Hamanofce7c7e2008-07-02 03:06:382148By default, linkgit:git-repack[1] creates packs that use
2149delta-base offset. If you need to share your repository with
Junio C Hamano076ffcc2013-02-06 05:13:212150Git older than version 1.4.4, either directly or via a dumb
Junio C Hamanofce7c7e2008-07-02 03:06:382151protocol such as http, then you need to set this option to
Junio C Hamano076ffcc2013-02-06 05:13:212152"false" and repack. Access from old Git versions over the
Junio C Hamanofce7c7e2008-07-02 03:06:382153native protocol are unaffected by this option.
Junio C Hamano77b7e902006-10-23 07:18:502154
Junio C Hamano4653c6f2008-11-26 22:50:202155rerere.autoupdate::
2156When set to true, `git-rerere` updates the index with the
2157resulting contents after it cleanly resolves conflicts using
2158previously recorded resolution. Defaults to false.
2159
2160rerere.enabled::
2161Activate recording of resolved conflicts, so that identical
Junio C Hamano4fd24422012-01-06 21:52:432162conflict hunks can be resolved automatically, should they be
2163encountered again. By default, linkgit:git-rerere[1] is
2164enabled if there is an `rr-cache` directory under the
Junio C Hamano864ba892012-01-13 17:42:052165`$GIT_DIR`, e.g. if "rerere" was previously used in the
2166repository.
Junio C Hamano4653c6f2008-11-26 22:50:202167
Junio C Hamano1bbd0f42009-07-23 06:20:292168sendemail.identity::
2169A configuration identity. When given, causes values in the
2170'sendemail.<identity>' subsection to take precedence over
2171values in the 'sendemail' section. The default identity is
2172the value of 'sendemail.identity'.
2173
2174sendemail.smtpencryption::
2175See linkgit:git-send-email[1] for description. Note that this
2176setting is not subject to the 'identity' mechanism.
2177
2178sendemail.smtpssl::
2179Deprecated alias for 'sendemail.smtpencryption = ssl'.
2180
Junio C Hamano58f587a2013-07-22 19:20:592181sendemail.smtpsslcertpath::
2182Path to ca-certificates (either a directory or a single file).
2183Set it to an empty string to disable certificate verification.
2184
Junio C Hamano1bbd0f42009-07-23 06:20:292185sendemail.<identity>.*::
2186Identity-specific versions of the 'sendemail.*' parameters
2187found below, taking precedence over those when the this
2188identity is selected, through command-line or
2189'sendemail.identity'.
2190
2191sendemail.aliasesfile::
2192sendemail.aliasfiletype::
Junio C Hamanoea3b7522013-04-18 19:37:532193sendemail.annotate::
Junio C Hamano1bbd0f42009-07-23 06:20:292194sendemail.bcc::
2195sendemail.cc::
2196sendemail.cccmd::
2197sendemail.chainreplyto::
2198sendemail.confirm::
2199sendemail.envelopesender::
2200sendemail.from::
2201sendemail.multiedit::
2202sendemail.signedoffbycc::
2203sendemail.smtppass::
2204sendemail.suppresscc::
2205sendemail.suppressfrom::
2206sendemail.to::
Junio C Hamanocb39aea2010-05-09 07:24:482207sendemail.smtpdomain::
Junio C Hamano1bbd0f42009-07-23 06:20:292208sendemail.smtpserver::
2209sendemail.smtpserverport::
Junio C Hamano39c7a692010-10-27 06:08:542210sendemail.smtpserveroption::
Junio C Hamano1bbd0f42009-07-23 06:20:292211sendemail.smtpuser::
2212sendemail.thread::
2213sendemail.validate::
2214See linkgit:git-send-email[1] for description.
2215
2216sendemail.signedoffcc::
2217Deprecated alias for 'sendemail.signedoffbycc'.
2218
Junio C Hamano07824ce2006-04-25 07:36:542219showbranch.default::
Junio C Hamano35738e82008-01-07 07:55:462220The default set of branches for linkgit:git-show-branch[1].
2221See linkgit:git-show-branch[1].
Junio C Hamano07824ce2006-04-25 07:36:542222
Junio C Hamano942b35e2007-12-09 10:19:332223status.relativePaths::
Junio C Hamano35738e82008-01-07 07:55:462224By default, linkgit:git-status[1] shows paths relative to the
Junio C Hamano942b35e2007-12-09 10:19:332225current directory. Setting this variable to `false` shows paths
Junio C Hamano076ffcc2013-02-06 05:13:212226relative to the repository root (this was the default for Git
Junio C Hamano942b35e2007-12-09 10:19:332227prior to v1.5.4).
2228
Junio C Hamano58655592013-07-11 20:52:332229status.short::
2230Set to true to enable --short by default in linkgit:git-status[1].
2231The option --no-short takes precedence over this variable.
2232
2233status.branch::
2234Set to true to enable --branch by default in linkgit:git-status[1].
2235The option --no-branch takes precedence over this variable.
2236
Junio C Hamano79f4c7c2013-09-20 21:03:372237status.displayCommentPrefix::
2238If set to true, linkgit:git-status[1] will insert a comment
2239prefix before each output line (starting with
2240`core.commentChar`, i.e. `#` by default). This was the
2241behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2242Defaults to false.
2243
Junio C Hamano4224f992008-06-23 07:14:082244status.showUntrackedFiles::
2245By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2246files which are not currently tracked by Git. Directories which
2247contain only untracked files, are shown with the directory name
2248only. Showing untracked files means that Git needs to lstat() all
2249all the files in the whole repository, which might be slow on some
2250systems. So, this variable controls how the commands displays
2251the untracked files. Possible values are:
2252+
2253--
Junio C Hamano7f9fa862010-10-19 23:51:142254* `no` - Show no untracked files.
2255* `normal` - Show untracked files and directories.
2256* `all` - Show also individual files in untracked directories.
Junio C Hamano4224f992008-06-23 07:14:082257--
2258+
2259If this variable is not specified, it defaults to 'normal'.
2260This variable can be overridden with the -u|--untracked-files option
2261of linkgit:git-status[1] and linkgit:git-commit[1].
2262
Junio C Hamanob671fb52010-06-01 05:06:142263status.submodulesummary::
2264Defaults to false.
2265If this is set to a non zero number or true (identical to -1 or an
2266unlimited number), the submodule summary will be enabled and a
2267summary of commits for modified submodules will be shown (see
Junio C Hamano369e3402013-10-15 18:40:252268--summary-limit option of linkgit:git-submodule[1]). Please note
2269that the summary output command will be suppressed for all
2270submodules when `diff.ignoreSubmodules` is set to 'all' or only
2271for those submodules where `submodule.<name>.ignore=all`. To
2272also view the summary for ignored submodules you can either use
2273the --ignore-submodules=dirty command line option or the 'git
2274submodule summary' command, which shows a similar output but does
2275not honor these settings.
Junio C Hamanob671fb52010-06-01 05:06:142276
Junio C Hamano78e3a782010-07-15 22:24:452277submodule.<name>.path::
2278submodule.<name>.url::
2279submodule.<name>.update::
2280The path within this project, URL, and the updating strategy
2281for a submodule. These variables are initially populated
2282by 'git submodule init'; edit them to override the
2283URL and other values found in the `.gitmodules` file. See
2284linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2285
Junio C Hamanoabad6da2013-01-06 09:06:322286submodule.<name>.branch::
2287The remote branch name for a submodule, used by `git submodule
2288update --remote`. Set this option to override the value found in
2289the `.gitmodules` file. See linkgit:git-submodule[1] and
2290linkgit:gitmodules[5] for details.
2291
Junio C Hamano0d75e872010-12-17 06:57:262292submodule.<name>.fetchRecurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:102293This option can be used to control recursive fetching of this
Junio C Hamano7165bf72011-01-04 22:06:182294submodule. It can be overridden by using the --[no-]recurse-submodules
Junio C Hamano0d75e872010-12-17 06:57:262295command line option to "git fetch" and "git pull".
2296This setting will override that from in the linkgit:gitmodules[5]
2297file.
2298
Junio C Hamano619596a2010-08-18 22:15:352299submodule.<name>.ignore::
2300Defines under what circumstances "git status" and the diff family show
2301a submodule as modified. When set to "all", it will never be considered
2302modified, "dirty" will ignore all changes to the submodules work tree and
2303takes only differences between the HEAD of the submodule and the commit
2304recorded in the superproject into account. "untracked" will additionally
2305let submodules with modified tracked files in their work tree show up.
2306Using "none" (the default when this option is not set) also shows
2307submodules that have untracked files in their work tree as changed.
2308This setting overrides any setting made in .gitmodules for this submodule,
Junio C Hamanode9745c2010-08-23 17:10:182309both settings can be overridden on the command line by using the
Junio C Hamano369e3402013-10-15 18:40:252310"--ignore-submodules" option. The 'git submodule' commands are not
2311affected by this setting.
Junio C Hamano619596a2010-08-18 22:15:352312
Junio C Hamano75cc4c92006-07-24 08:25:032313tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:092314This variable can be used to restrict the permission bits of
2315tar archive entries. The default is 0002, which turns off the
2316world write bit. The special value "user" indicates that the
2317archiving user's umask will be used instead. See umask(2) and
Junio C Hamano35738e82008-01-07 07:55:462318linkgit:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:032319
Junio C Hamano8fb66e52011-10-05 20:59:512320transfer.fsckObjects::
2321When `fetch.fsckObjects` or `receive.fsckObjects` are
2322not set, the value of this variable is used instead.
2323Defaults to false.
2324
Junio C Hamano80ad00d2013-02-18 00:19:032325transfer.hiderefs::
2326This variable can be used to set both `receive.hiderefs`
2327and `uploadpack.hiderefs` at the same time to the same
2328values. See entries for these other variables.
2329
Junio C Hamano4653c6f2008-11-26 22:50:202330transfer.unpackLimit::
2331When `fetch.unpackLimit` or `receive.unpackLimit` are
2332not set, the value of this variable is used instead.
2333The default value is 100.
2334
Junio C Hamano80ad00d2013-02-18 00:19:032335uploadpack.hiderefs::
2336String(s) `upload-pack` uses to decide which refs to omit
2337from its initial advertisement. Use more than one
2338definitions to specify multiple prefix strings. A ref that
2339are under the hierarchies listed on the value of this
2340variable is excluded, and is hidden from `git ls-remote`,
2341`git fetch`, etc. An attempt to fetch a hidden ref by `git
Junio C Hamano5e7f1312013-03-21 22:49:012342fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2343
2344uploadpack.allowtipsha1inwant::
2345When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2346to accept a fetch request that asks for an object at the tip
2347of a hidden ref (by default, such a request is rejected).
2348see also `uploadpack.hiderefs`.
Junio C Hamano80ad00d2013-02-18 00:19:032349
Junio C Hamano79f4c7c2013-09-20 21:03:372350uploadpack.keepalive::
2351When `upload-pack` has started `pack-objects`, there may be a
2352quiet period while `pack-objects` prepares the pack. Normally
2353it would output progress information, but if `--quiet` was used
2354for the fetch, `pack-objects` will output nothing at all until
2355the pack data begins. Some clients and networks may consider
2356the server to be hung and give up. Setting this option instructs
2357`upload-pack` to send an empty keepalive packet every
2358`uploadpack.keepalive` seconds. Setting this option to 0
2359disables keepalive packets entirely. The default is 5 seconds.
2360
Junio C Hamano24bc09a2008-02-28 00:27:442361url.<base>.insteadOf::
2362Any URL that starts with this value will be rewritten to
2363start, instead, with <base>. In cases where some site serves a
2364large number of repositories, and serves them with multiple
2365access methods, and some users need to use different access
2366methods, this feature allows people to specify any of the
Junio C Hamano076ffcc2013-02-06 05:13:212367equivalent URLs and have Git automatically rewrite the URL to
Junio C Hamano24bc09a2008-02-28 00:27:442368the best alternative for the particular user, even for a
2369never-before-seen repository on the site. When more than one
2370insteadOf strings match a given URL, the longest match is used.
2371
Junio C Hamano7df6dcf2009-09-13 09:51:172372url.<base>.pushInsteadOf::
2373Any URL that starts with this value will not be pushed to;
2374instead, it will be rewritten to start with <base>, and the
2375resulting URL will be pushed to. In cases where some site serves
2376a large number of repositories, and serves them with multiple
2377access methods, some of which do not allow push, this feature
Junio C Hamano076ffcc2013-02-06 05:13:212378allows people to specify a pull-only URL and have Git
Junio C Hamano7df6dcf2009-09-13 09:51:172379automatically use an appropriate URL to push, even for a
2380never-before-seen repository on the site. When more than one
2381pushInsteadOf strings match a given URL, the longest match is
Junio C Hamano076ffcc2013-02-06 05:13:212382used. If a remote has an explicit pushurl, Git will ignore this
Junio C Hamano7df6dcf2009-09-13 09:51:172383setting for that remote.
2384
Junio C Hamano07824ce2006-04-25 07:36:542385user.email::
2386Your email address to be recorded in any newly created commits.
Junio C Hamano469d60e2007-04-29 18:30:342387Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Junio C Hamano35738e82008-01-07 07:55:462388'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:542389
2390user.name::
2391Your full name to be recorded in any newly created commits.
Junio C Hamano341071d2006-06-04 07:24:482392Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Junio C Hamano35738e82008-01-07 07:55:462393environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:542394
Junio C Hamanoa890c4f2007-01-28 10:29:212395user.signingkey::
Junio C Hamano369e3402013-10-15 18:40:252396If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2397key you want it to automatically when creating a signed tag or
2398commit, you can override the default selection with this variable.
2399This option is passed unchanged to gpg's --local-user parameter,
2400so you may specify a key using any method that gpg supports.
Junio C Hamanoa890c4f2007-01-28 10:29:212401
Junio C Hamano4e272312008-01-08 09:13:212402web.browser::
2403Specify a web browser that may be used by some commands.
2404Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2405may use it.