blob: 78ee90631986f8299a804c8f311282fadbc0dfd7 [file] [log] [blame]
Junio C Hamano07824ce2006-04-25 07:36:541CONFIGURATION FILE
2------------------
3
4The git configuration file contains a number of variables that affect
Junio C Hamanof4581102009-04-25 08:29:595the git command's behavior. The `.git/config` file in each repository
6is 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 Hamanof4581102009-04-25 08:29:5911The configuration variables are used by both the git plumbing
12and 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
15dot. The variable names are case-insensitive and only alphanumeric
16characters are allowed. Some variables may appear multiple times.
17
Junio C Hamanobee172f2007-01-23 08:44:1818Syntax
19~~~~~~
20
Junio C Hamano07824ce2006-04-25 07:36:5421The syntax is fairly flexible and permissive; whitespaces are mostly
Junio C Hamanobee172f2007-01-23 08:44:1822ignored. The '#' and ';' characters begin comments to the end of line,
23blank lines are ignored.
24
25The file consists of sections and variables. A section begins with
26the name of the section in square brackets and continues until the next
27section begins. Section names are not case sensitive. Only alphanumeric
Junio C Hamanoea82cff2009-03-18 01:54:4828characters, `-` and `.` are allowed in section names. Each variable
Junio C Hamanof4581102009-04-25 08:29:5929must belong to some section, which means that there must be a section
30header before the first setting of a variable.
Junio C Hamanobee172f2007-01-23 08:44:1831
32Sections can be further divided into subsections. To begin a subsection
33put its name in double quotes, separated by space from the section name,
Junio C Hamanof4581102009-04-25 08:29:5934in the section header, like in the example below:
Junio C Hamanobee172f2007-01-23 08:44:1835
36--------
37[section "subsection"]
38
39--------
40
Junio C Hamanof4581102009-04-25 08:29:5941Subsection names are case sensitive and can contain any characters except
42newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
43respectively). Section headers cannot span multiple
Junio C Hamanobee172f2007-01-23 08:44:1844lines. Variables may belong directly to a section or to a given subsection.
45You can have `[section]` if you have `[section "subsection"]`, but you
46don't need to.
47
Junio C Hamanof4581102009-04-25 08:29:5948There is also a case insensitive alternative `[section.subsection]` syntax.
49In this syntax, subsection names follow the same restrictions as for section
50names.
Junio C Hamanobee172f2007-01-23 08:44:1851
Junio C Hamanoaa2cd762009-07-26 08:14:0152All the other lines (and the remainder of the line after the section
53header) are recognized as setting variables, in the form
Junio C Hamanobee172f2007-01-23 08:44:1854'name = value'. If there is no equal sign on the line, the entire line
55is taken as 'name' and the variable is recognized as boolean "true".
56The variable names are case-insensitive and only alphanumeric
Junio C Hamanoea82cff2009-03-18 01:54:4857characters and `-` are allowed. There can be more than one value
Junio C Hamanobee172f2007-01-23 08:44:1858for a given variable; we say then that variable is multivalued.
59
60Leading and trailing whitespace in a variable value is discarded.
61Internal whitespace within a variable value is retained verbatim.
62
63The values following the equals sign in variable assign are all either
64a string, an integer, or a boolean. Boolean values may be given as yes/no,
Junio C Hamano4cfa5362009-04-18 23:01:01650/1, true/false or on/off. Case is not significant in boolean values, when
Junio C Hamanobee172f2007-01-23 08:44:1866converting value to the canonical form using '--bool' type specifier;
Junio C Hamanoba4b9282008-07-06 05:20:3167'git-config' will ensure that the output is "true" or "false".
Junio C Hamanobee172f2007-01-23 08:44:1868
69String values may be entirely or partially enclosed in double quotes.
Junio C Hamanof4581102009-04-25 08:29:5970You need to enclose variable values in double quotes if you want to
71preserve leading or trailing whitespace, or if the variable value contains
72comment characters (i.e. it contains '#' or ';').
73Double quote `"` and backslash `\` characters in variable values must
Junio C Hamanoea82cff2009-03-18 01:54:4874be escaped: use `\"` for `"` and `\\` for `\`.
Junio C Hamanobee172f2007-01-23 08:44:1875
Junio C Hamanoea82cff2009-03-18 01:54:4876The following escape sequences (beside `\"` and `\\`) are recognized:
77`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
78and `\b` for backspace (BS). No other char escape sequence, nor octal
Junio C Hamanobee172f2007-01-23 08:44:1879char sequences are valid.
80
Junio C Hamanof4581102009-04-25 08:29:5981Variable values ending in a `\` are continued on the next line in the
Junio C Hamanobee172f2007-01-23 08:44:1882customary UNIX fashion.
83
Junio C Hamanof4581102009-04-25 08:29:5984Some variables may require a special value format.
Junio C Hamano07824ce2006-04-25 07:36:5485
86Example
87~~~~~~~
88
89# Core variables
90[core]
91; Don't trust file modes
92filemode = false
93
94# Our diff algorithm
95[diff]
Junio C Hamano85c71572008-07-28 00:03:3196external = /usr/local/bin/diff-wrapper
Junio C Hamano07824ce2006-04-25 07:36:5497renames = true
98
Junio C Hamano52401ef2006-12-19 00:54:3899[branch "devel"]
100remote = origin
101merge = refs/heads/devel
102
Junio C Hamanobee172f2007-01-23 08:44:18103# Proxy settings
104[core]
Junio C Hamanoc71a8732007-08-04 00:27:26105gitProxy="ssh" for "kernel.org"
Junio C Hamanobee172f2007-01-23 08:44:18106gitProxy=default-proxy ; for the rest
Junio C Hamano52401ef2006-12-19 00:54:38107
Junio C Hamano07824ce2006-04-25 07:36:54108Variables
109~~~~~~~~~
110
111Note that this list is non-comprehensive and not necessarily complete.
Junio C Hamanof1d14802006-06-08 00:48:17112For command-specific variables, you will find a more detailed description
113in the appropriate manual page. You will find a description of non-core
Junio C Hamano07824ce2006-04-25 07:36:54114porcelain configuration variables in the respective porcelain documentation.
115
Junio C Hamano7df6dcf2009-09-13 09:51:17116advice.*::
117When set to 'true', display the given optional help message.
118When set to 'false', do not display. The configuration variables
119are:
120+
121--
122pushNonFastForward::
123Advice shown when linkgit:git-push[1] refuses
124non-fast-forward refs. Default: true.
125statusHints::
126Directions on how to stage/unstage/add shown in the
127output of linkgit:git-status[1] and the template shown
128when writing commit messages. Default: true.
129--
130
Junio C Hamano07824ce2006-04-25 07:36:54131core.fileMode::
132If false, the executable bit differences between the index and
133the working copy are ignored; useful on broken filesystems like FAT.
Junio C Hamano35738e82008-01-07 07:55:46134See linkgit:git-update-index[1]. True by default.
Junio C Hamano07824ce2006-04-25 07:36:54135
Junio C Hamanoa476efa2008-10-10 15:31:42136core.ignoreCygwinFSTricks::
137This option is only used by Cygwin implementation of Git. If false,
138the Cygwin stat() and lstat() functions are used. This may be useful
139if your repository consists of a few separate directories joined in
140one hierarchy using Cygwin mount. If true, Git uses native Win32 API
141whenever it is possible and falls back to Cygwin functions only to
142handle symbol links. The native mode is more than twice faster than
Junio C Hamano7d06a8a2008-10-20 05:42:33143normal Cygwin l/stat() functions. True by default, unless core.filemode
144is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
145POSIX emulation is required to support core.filemode.
Junio C Hamanoa476efa2008-10-10 15:31:42146
Junio C Hamano90ccff32008-07-29 08:17:24147core.trustctime::
148If false, the ctime differences between the index and the
149working copy are ignored; useful when the inode change time
150is regularly modified by something outside Git (file system
151crawlers and some backup systems).
152See linkgit:git-update-index[1]. True by default.
153
Junio C Hamanod526ba92007-07-02 00:17:42154core.quotepath::
Junio C Hamanoba4b9282008-07-06 05:20:31155The commands that output paths (e.g. 'ls-files',
156'diff'), when not given the `-z` option, will quote
Junio C Hamanod526ba92007-07-02 00:17:42157"unusual" characters in the pathname by enclosing the
158pathname in a double-quote pair and with backslashes the
159same way strings in C source code are quoted. If this
160variable is set to false, the bytes higher than 0x80 are
161not quoted but output as verbatim. Note that double
162quote, backslash and control characters are always
163quoted without `-z` regardless of the setting of this
164variable.
165
Junio C Hamanod9e0e5d2007-04-14 16:22:04166core.autocrlf::
167If true, makes git convert `CRLF` at the end of lines in text files to
168`LF` when reading from the filesystem, and convert in reverse when
169writing to the filesystem. The variable can be set to
170'input', in which case the conversion happens only while
171reading from the filesystem but files are written out with
172`LF` at the end of lines. Currently, which paths to consider
173"text" (i.e. be subjected to the autocrlf mechanism) is
174decided purely based on the contents.
175
Junio C Hamano26e590a2008-02-17 03:53:51176core.safecrlf::
177If true, makes git check if converting `CRLF` as controlled by
178`core.autocrlf` is reversible. Git will verify if a command
179modifies a file in the work tree either directly or indirectly.
180For example, committing a file followed by checking out the
181same file should yield the original file in the work tree. If
182this is not the case for the current setting of
183`core.autocrlf`, git will reject the file. The variable can
184be set to "warn", in which case git will only warn about an
185irreversible conversion but continue the operation.
186+
187CRLF conversion bears a slight chance of corrupting data.
188autocrlf=true will convert CRLF to LF during commit and LF to
189CRLF during checkout. A file that contains a mixture of LF and
190CRLF before the commit cannot be recreated by git. For text
191files this is the right thing to do: it corrects line endings
192such that we have only LF line endings in the repository.
193But for binary files that are accidentally classified as text the
194conversion can corrupt data.
195+
196If you recognize such corruption early you can easily fix it by
197setting the conversion type explicitly in .gitattributes. Right
198after committing you still have the original file in your work
199tree and this file is not yet corrupted. You can explicitly tell
200git that this file is binary and git will handle the file
201appropriately.
202+
203Unfortunately, the desired effect of cleaning up text files with
204mixed line endings and the undesired effect of corrupting binary
205files cannot be distinguished. In both cases CRLFs are removed
206in an irreversible way. For text files this is the right thing
207to do because CRLFs are line endings, while for binary files
208converting CRLFs corrupts data.
209+
210Note, this safety check does not mean that a checkout will generate a
211file identical to the original file for a different setting of
212`core.autocrlf`, but only for the current one. For example, a text
213file with `LF` would be accepted with `core.autocrlf=input` and could
214later be checked out with `core.autocrlf=true`, in which case the
215resulting file would contain `CRLF`, although the original file
216contained `LF`. However, in both work trees the line endings would be
217consistent, that is either all `LF` or all `CRLF`, but never mixed. A
218file with mixed line endings would be reported by the `core.safecrlf`
219mechanism.
220
Junio C Hamanoaa83a7d2007-03-05 02:37:29221core.symlinks::
222If false, symbolic links are checked out as small plain files that
Junio C Hamano35738e82008-01-07 07:55:46223contain the link text. linkgit:git-update-index[1] and
224linkgit:git-add[1] will not change the recorded type to regular
Junio C Hamanoaa83a7d2007-03-05 02:37:29225file. Useful on filesystems like FAT that do not support
226symbolic links. True by default.
227
Junio C Hamano07824ce2006-04-25 07:36:54228core.gitProxy::
229A "proxy command" to execute (as 'command host port') instead
230of establishing direct connection to the remote server when
231using the git protocol for fetching. If the variable value is
232in the "COMMAND for DOMAIN" format, the command is applied only
233on hostnames ending with the specified domain string. This variable
234may be set multiple times and is matched in the given order;
235the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17236+
237Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
238(which always applies universally, without the special "for"
239handling).
Junio C Hamanoea82cff2009-03-18 01:54:48240+
241The special string `none` can be used as the proxy command to
242specify that no proxy be used for a given domain pattern.
243This is useful for excluding servers inside a firewall from
244proxy use, while defaulting to a common proxy for external domains.
Junio C Hamano07824ce2006-04-25 07:36:54245
246core.ignoreStat::
Junio C Hamano054ea082008-06-01 08:26:34247If true, commands which modify both the working tree and the index
248will mark the updated paths with the "assume unchanged" bit in the
249index. These marked files are then assumed to stay unchanged in the
250working copy, until you mark them otherwise manually - Git will not
251detect the file changes by lstat() calls. This is useful on systems
252where those are very slow, such as Microsoft Windows.
253See linkgit:git-update-index[1].
Junio C Hamano07824ce2006-04-25 07:36:54254False by default.
255
Junio C Hamano88a3a072006-05-04 08:01:43256core.preferSymlinkRefs::
257Instead of the default "symref" format for HEAD
258and other symbolic reference files, use symbolic links.
259This is sometimes needed to work with old scripts that
260expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54261
Junio C Hamano1025e752007-02-23 07:21:26262core.bare::
263If true this repository is assumed to be 'bare' and has no
264working directory associated with it. If this is the case a
265number of commands that require a working directory will be
Junio C Hamano35738e82008-01-07 07:55:46266disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Junio C Hamano1025e752007-02-23 07:21:26267+
Junio C Hamano35738e82008-01-07 07:55:46268This setting is automatically guessed by linkgit:git-clone[1] or
269linkgit:git-init[1] when the repository was created. By default a
Junio C Hamano1025e752007-02-23 07:21:26270repository that ends in "/.git" is assumed to be not bare (bare =
271false), while all other repositories are assumed to be bare (bare
272= true).
273
Junio C Hamanod526ba92007-07-02 00:17:42274core.worktree::
275Set the path to the working tree. The value will not be
276used in combination with repositories found automatically in
277a .git directory (i.e. $GIT_DIR is not set).
Junio C Hamano764a6672007-10-23 01:23:31278This can be overridden by the GIT_WORK_TREE environment
Junio C Hamano7d575a52008-04-30 08:45:27279variable and the '--work-tree' command line option. It can be
280a absolute path or relative path to the directory specified by
281--git-dir or GIT_DIR.
282Note: If --git-dir or GIT_DIR are specified but none of
283--work-tree, GIT_WORK_TREE and core.worktree is specified,
284the current working directory is regarded as the top directory
285of your working tree.
Junio C Hamanod526ba92007-07-02 00:17:42286
Junio C Hamano341071d2006-06-04 07:24:48287core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49288Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamanoa2ec14f2006-11-02 00:22:48289"$GIT_DIR/logs/<ref>", by appending the new and old
290SHA1, the date/time and the reason of the update, but
291only when the file exists. If this configuration
292variable is set to true, missing "$GIT_DIR/logs/<ref>"
293file is automatically created for branch heads.
Junio C Hamano1caaf472006-12-31 08:29:35294+
295This information can be used to determine what commit
296was the tip of a branch "2 days ago".
297+
298This value is true by default in a repository that has
299a working directory associated with it, and false by
300default in a bare repository.
Junio C Hamano341071d2006-06-04 07:24:48301
Junio C Hamano07824ce2006-04-25 07:36:54302core.repositoryFormatVersion::
303Internal variable identifying the repository format and layout
304version.
305
306core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42307When 'group' (or 'true'), the repository is made shareable between
308several users in a group (making sure all the files and objects are
309group-writable). When 'all' (or 'world' or 'everybody'), the
310repository will be readable by all users, additionally to being
311group-shareable. When 'umask' (or 'false'), git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37312reported by umask(2). When '0xxx', where '0xxx' is an octal number,
313files in the repository will have this mode value. '0xxx' will override
Junio C Hamano83eded12009-04-20 08:18:00314user's umask value (whereas the other options will only override
315requested parts of the user's umask value). Examples: '0660' will make
316the repo read/write-able for the owner and group, but inaccessible to
317others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Junio C Hamano2f102bb2008-04-26 02:23:37318repository that is group-readable but not group-writable.
319See linkgit:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54320
321core.warnAmbiguousRefs::
322If true, git will warn you if the ref name you passed it is ambiguous
323and might match multiple refs in the .git/refs/ tree. True by default.
324
Junio C Hamano7ec15722006-07-07 02:03:59325core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09326An integer -1..9, indicating a default compression level.
327-1 is the zlib default. 0 means no compression,
328and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42329If set, this provides a default to other compression variables,
330such as 'core.loosecompression' and 'pack.compression'.
Junio C Hamanoa126a3b2006-07-04 04:55:26331
Junio C Hamanof2ce2972007-05-20 19:12:09332core.loosecompression::
333An integer -1..9, indicating the compression level for objects that
334are not in a pack file. -1 is the zlib default. 0 means no
335compression, and 1..9 are various speed/size tradeoffs, 9 being
336slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42337not set, defaults to 1 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49338
Junio C Hamanofc4d38c2007-01-08 06:53:32339core.packedGitWindowSize::
340Number of bytes of a pack file to map into memory in a
341single mapping operation. Larger window sizes may allow
342your system to process a smaller number of large pack files
343more quickly. Smaller window sizes will negatively affect
344performance due to increased calls to the operating system's
345memory manager, but may improve performance when accessing
346a large number of large pack files.
347+
348Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
349MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
350be reasonable for all users/operating systems. You probably do
351not need to adjust this value.
352+
353Common unit suffixes of 'k', 'm', or 'g' are supported.
354
355core.packedGitLimit::
356Maximum number of bytes to map simultaneously into memory
357from pack files. If Git needs to access more than this many
358bytes at once to complete an operation it will unmap existing
359regions to reclaim virtual address space within the process.
360+
361Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
362This should be reasonable for all users/operating systems, except on
363the largest projects. You probably do not need to adjust this value.
364+
365Common unit suffixes of 'k', 'm', or 'g' are supported.
366
Junio C Hamanob8c51282007-03-19 10:43:30367core.deltaBaseCacheLimit::
368Maximum number of bytes to reserve for caching base objects
369that multiple deltafied objects reference. By storing the
370entire decompressed base objects in a cache Git is able
371to avoid unpacking and decompressing frequently used base
372objects multiple times.
373+
374Default is 16 MiB on all platforms. This should be reasonable
375for all users/operating systems, except on the largest projects.
376You probably do not need to adjust this value.
377+
378Common unit suffixes of 'k', 'm', or 'g' are supported.
379
Junio C Hamano1d90cb02007-07-03 07:05:31380core.excludesfile::
Junio C Hamano5e284b42007-05-22 07:23:37381In addition to '.gitignore' (per-directory) and
382'.git/info/exclude', git looks into this file for patterns
Junio C Hamano679d22d2007-06-02 21:13:44383of files which are not meant to be tracked. See
Junio C Hamano35738e82008-01-07 07:55:46384linkgit:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37385
Junio C Hamanof6002a92007-07-20 10:28:22386core.editor::
387Commands such as `commit` and `tag` that lets you edit
Junio C Hamanoa6387422007-08-25 03:54:27388messages by launching an editor uses the value of this
Junio C Hamanof6002a92007-07-20 10:28:22389variable when it is set, and the environment variable
Junio C Hamano3b70d3c2009-11-21 17:37:37390`GIT_EDITOR` is not set. See linkgit:git-var[1].
Junio C Hamanof6002a92007-07-20 10:28:22391
Junio C Hamano28d8ede2007-07-05 05:51:38392core.pager::
Junio C Hamano0551f6a2008-08-25 00:33:33393The command that git will use to paginate output. Can
394be overridden with the `GIT_PAGER` environment
395variable. Note that git sets the `LESS` environment
396variable to `FRSX` if it is unset when it runs the
397pager. One can change these settings by setting the
Junio C Hamanoa476efa2008-10-10 15:31:42398`LESS` variable to some other value. Alternately,
399these settings can be overridden on a project or
400global basis by setting the `core.pager` option.
401Setting `core.pager` has no affect on the `LESS`
402environment variable behaviour above, so if you want
403to override git's default settings this way, you need
404to be explicit. For example, to disable the S option
405in a backward compatible manner, set `core.pager`
Junio C Hamanoea82cff2009-03-18 01:54:48406to `less -+$LESS -FRX`. This will be passed to the
Junio C Hamanoa476efa2008-10-10 15:31:42407shell by git, which will translate the final command to
Junio C Hamanoea82cff2009-03-18 01:54:48408`LESS=FRSX less -+FRSX -FRX`.
Junio C Hamano28d8ede2007-07-05 05:51:38409
Junio C Hamano942b35e2007-12-09 10:19:33410core.whitespace::
411A comma separated list of common whitespace problems to
Junio C Hamanoba4b9282008-07-06 05:20:31412notice. 'git-diff' will use `color.diff.whitespace` to
413highlight them, and 'git-apply --whitespace=error' will
Junio C Hamano3db8b412008-07-26 06:45:59414consider them as errors. You can prefix `-` to disable
415any of them (e.g. `-trailing-space`):
Junio C Hamano942b35e2007-12-09 10:19:33416+
Junio C Hamanob71a22d2009-10-17 08:23:47417* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano942b35e2007-12-09 10:19:33418 as an error (enabled by default).
419* `space-before-tab` treats a space character that appears immediately
420 before a tab character in the initial indent part of the line as an
421 error (enabled by default).
422* `indent-with-non-tab` treats a line that is indented with 8 or more
Junio C Hamano42a2e2d2007-12-16 22:13:42423 space characters as an error (not enabled by default).
Junio C Hamanob71a22d2009-10-17 08:23:47424* `blank-at-eof` treats blank lines added at the end of file as an error
425 (enabled by default).
426* `trailing-space` is a short-hand to cover both `blank-at-eol` and
427 `blank-at-eof`.
Junio C Hamano601f3e52008-02-25 08:40:42428* `cr-at-eol` treats a carriage-return at the end of line as
429 part of the line terminator, i.e. with it, `trailing-space`
430 does not trigger if the character before such a carriage-return
431 is not a whitespace (not enabled by default).
Junio C Hamano942b35e2007-12-09 10:19:33432
Junio C Hamano9eb57532008-06-26 06:33:46433core.fsyncobjectfiles::
434This boolean will enable 'fsync()' when writing object files.
435+
436This is a total waste of time and effort on a filesystem that orders
437data writes properly, but can be useful for filesystems that do not use
438journalling (traditional UNIX filesystems) or that only journal metadata
439and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
440
Junio C Hamano610d1762008-11-28 06:27:13441core.preloadindex::
442Enable parallel index preload for operations like 'git diff'
443+
444This can speed up operations like 'git diff' and 'git status' especially
445on filesystems like NFS that have weak caching semantics and thus
446relatively high IO latencies. With this set to 'true', git will do the
447index comparison to the filesystem data in parallel, allowing
448overlapping IO's.
449
Junio C Hamanoa9499de2009-04-30 03:38:48450core.createObject::
451You can set this to 'link', in which case a hardlink followed by
452a delete of the source are used to make sure that object creation
453will not overwrite existing objects.
454+
455On some file system/operating system combinations, this is unreliable.
456Set this config setting to 'rename' there; However, This will remove the
457check that makes sure that existing object files will not get overwritten.
Junio C Hamanoe91ea772009-04-26 01:41:41458
Junio C Hamano3b70d3c2009-11-21 17:37:37459core.notesRef::
460When showing commit messages, also show notes which are stored in
461the given ref. This ref is expected to contain files named
462after the full SHA-1 of the commit they annotate.
463+
464If such a file exists in the given ref, the referenced blob is read, and
465appended to the commit message, separated by a "Notes:" line. If the
466given ref itself does not exist, it is not an error, but means that no
467notes should be printed.
468+
469This setting defaults to "refs/notes/commits", and can be overridden by
470the `GIT_NOTES_REF` environment variable.
471
Junio C Hamano3d141512009-06-01 01:22:40472add.ignore-errors::
473Tells 'git-add' to continue adding files when some files cannot be
474added due to indexing errors. Equivalent to the '--ignore-errors'
475option of linkgit:git-add[1].
476
Junio C Hamano33db4372006-06-07 19:51:45477alias.*::
Junio C Hamano35738e82008-01-07 07:55:46478Command aliases for the linkgit:git[1] command wrapper - e.g.
Junio C Hamano33db4372006-06-07 19:51:45479after defining "alias.last = cat-file commit HEAD", the invocation
480"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17481confusion and troubles with script usage, aliases that
482hide existing git commands are ignored. Arguments are split by
483spaces, the usual shell quoting and escaping is supported.
484quote pair and a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39485+
486If the alias expansion is prefixed with an exclamation point,
487it will be treated as a shell command. For example, defining
488"alias.new = !gitk --all --not ORIG_HEAD", the invocation
489"git new" is equivalent to running the shell command
Junio C Hamano48bc1ce2009-07-09 16:49:19490"gitk --all --not ORIG_HEAD". Note that shell commands will be
491executed from the top-level directory of a repository, which may
492not necessarily be the current directory.
Junio C Hamano9cb74f22007-02-12 04:15:05493
Junio C Hamanofe24db02009-08-22 05:10:47494apply.ignorewhitespace::
495When set to 'change', tells 'git-apply' to ignore changes in
496whitespace, in the same way as the '--ignore-space-change'
497option.
498When set to one of: no, none, never, false tells 'git-apply' to
499respect all whitespace differences.
500See linkgit:git-apply[1].
501
Junio C Hamano07824ce2006-04-25 07:36:54502apply.whitespace::
Junio C Hamanoba4b9282008-07-06 05:20:31503Tells 'git-apply' how to handle whitespaces, in the same way
Junio C Hamano35738e82008-01-07 07:55:46504as the '--whitespace' option. See linkgit:git-apply[1].
Junio C Hamano07824ce2006-04-25 07:36:54505
Junio C Hamano7fd84172007-05-24 07:00:32506branch.autosetupmerge::
Junio C Hamanoba4b9282008-07-06 05:20:31507Tells 'git-branch' and 'git-checkout' to setup new branches
Junio C Hamano24bc09a2008-02-28 00:27:44508so that linkgit:git-pull[1] will appropriately merge from the
509starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32510this behavior can be chosen per-branch using the `--track`
Junio C Hamano24bc09a2008-02-28 00:27:44511and `--no-track` options. The valid settings are: `false` -- no
512automatic setup is done; `true` -- automatic setup is done when the
513starting point is a remote branch; `always` -- automatic setup is
514done when the starting point is either a local branch or remote
515branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32516
Junio C Hamano869bb802008-05-12 00:29:47517branch.autosetuprebase::
Junio C Hamanoba4b9282008-07-06 05:20:31518When a new branch is created with 'git-branch' or 'git-checkout'
Junio C Hamano869bb802008-05-12 00:29:47519that tracks another branch, this variable tells git to set
520up pull to rebase instead of merge (see "branch.<name>.rebase").
521When `never`, rebase is never automatically set to true.
522When `local`, rebase is set to true for tracked branches of
523other local branches.
524When `remote`, rebase is set to true for tracked branches of
525remote branches.
526When `always`, rebase will be set to true for all tracking
527branches.
528See "branch.autosetupmerge" for details on how to set up a
529branch to track another branch.
530This option defaults to never.
531
Junio C Hamano47c1e3c2006-09-25 04:45:55532branch.<name>.remote::
Junio C Hamano0706c802009-03-30 22:34:19533When in branch <name>, it tells 'git-fetch' and 'git-push' which
534remote to fetch from/push to. It defaults to `origin` if no remote is
535configured. `origin` is also used if you are not on any branch.
Junio C Hamano47c1e3c2006-09-25 04:45:55536
537branch.<name>.merge::
Junio C Hamano0706c802009-03-30 22:34:19538Defines, together with branch.<name>.remote, the upstream branch
539for the given branch. It tells 'git-fetch'/'git-pull' which
Junio C Hamano5f9a6f02009-04-06 08:26:56540branch to merge and can also affect 'git-push' (see push.default).
Junio C Hamanoba4b9282008-07-06 05:20:31541When in branch <name>, it tells 'git-fetch' the default
Junio C Hamanoc2b47092007-10-25 06:50:31542refspec to be marked for merging in FETCH_HEAD. The value is
543handled like the remote part of a refspec, and must match a
544ref which is fetched from the remote given by
545"branch.<name>.remote".
Junio C Hamanoba4b9282008-07-06 05:20:31546The merge information is used by 'git-pull' (which at first calls
547'git-fetch') to lookup the default branch for merging. Without
548this option, 'git-pull' defaults to merge the first refspec fetched.
Junio C Hamano96010b22006-12-09 21:15:46549Specify multiple values to get an octopus merge.
Junio C Hamanoba4b9282008-07-06 05:20:31550If you wish to setup 'git-pull' so that it merges into <name> from
Junio C Hamano6e149c02007-03-16 10:21:07551another branch in the local repository, you can point
552branch.<name>.merge to the desired branch, and use the special setting
553`.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:55554
Junio C Hamano1b50ce92007-10-03 12:05:53555branch.<name>.mergeoptions::
556Sets default options for merging into branch <name>. The syntax and
Junio C Hamanoc0e55e72009-10-10 00:56:29557supported options are the same as those of linkgit:git-merge[1], but
Junio C Hamano1b50ce92007-10-03 12:05:53558option values containing whitespace characters are currently not
559supported.
560
Junio C Hamano0c999702007-12-03 09:57:55561branch.<name>.rebase::
562When true, rebase the branch <name> on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:08563instead of merging the default branch from the default remote when
564"git pull" is run.
Junio C Hamano0c999702007-12-03 09:57:55565*NOTE*: this is a possibly dangerous operation; do *not* use
Junio C Hamano35738e82008-01-07 07:55:46566it unless you understand the implications (see linkgit:git-rebase[1]
Junio C Hamano0c999702007-12-03 09:57:55567for details).
568
Junio C Hamano8760ea62008-03-14 08:58:45569browser.<tool>.cmd::
570Specify the command to invoke the specified browser. The
571specified command is evaluated in shell with the URLs passed
572as arguments. (See linkgit:git-web--browse[1].)
573
Junio C Hamanoe35a6fc2008-01-29 09:46:27574browser.<tool>.path::
575Override the path for the given tool that may be used to
576browse HTML help (see '-w' option in linkgit:git-help[1]) or a
577working repository in gitweb (see linkgit:git-instaweb[1]).
578
Junio C Hamano47b9acd2007-04-24 07:34:34579clean.requireForce::
Junio C Hamano422cfec2007-11-08 08:07:45580A boolean to make git-clean do nothing unless given -f
581or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:34582
Junio C Hamanoeb692952007-01-03 22:02:12583color.branch::
584A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46585linkgit:git-branch[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21586`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoeb692952007-01-03 22:02:12587only when the output is to a terminal. Defaults to false.
588
589color.branch.<slot>::
590Use customized color for branch coloration. `<slot>` is one of
591`current` (the current branch), `local` (a local branch),
592`remote` (a tracking branch in refs/remotes/), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:22593refs).
594+
595The value for these configuration variables is a list of colors (at most
596two) and attributes (at most one), separated by spaces. The colors
597accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
598`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
599`blink` and `reverse`. The first color given is the foreground; the
600second is the background. The position of the attribute, if any,
601doesn't matter.
Junio C Hamanoeb692952007-01-03 22:02:12602
Junio C Hamano3f403b02006-12-13 10:14:13603color.diff::
Junio C Hamano0fc8cd92007-12-06 03:26:21604When set to `always`, always use colors in patch.
605When false (or `never`), never. When set to `true` or `auto`, use
606colors only when the output is to the terminal. Defaults to false.
Junio C Hamano9ae1a062006-07-10 08:12:34607
Junio C Hamano3f403b02006-12-13 10:14:13608color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:22609Use customized color for diff colorization. `<slot>` specifies
610which part of the patch to use the specified color, and is one
611of `plain` (context text), `meta` (metainformation), `frag`
612(hunk header), `old` (removed lines), `new` (added lines),
Junio C Hamano942b35e2007-12-09 10:19:33613`commit` (commit headers), or `whitespace` (highlighting
614whitespace errors). The values of these variables may be specified as
Junio C Hamano5a702332007-01-28 20:55:22615in color.branch.<slot>.
Junio C Hamano9ae1a062006-07-10 08:12:34616
Junio C Hamanod257cff2009-03-18 05:27:16617color.grep::
618When set to `always`, always highlight matches. When `false` (or
619`never`), never. When set to `true` or `auto`, use color only
620when the output is written to the terminal. Defaults to `false`.
621
622color.grep.external::
623The string value of this variable is passed to an external 'grep'
624command as a command line option if match highlighting is turned
625on. If set to an empty string, no option is passed at all,
626turning off coloring for external 'grep' calls; this is the default.
627For GNU grep, set it to `--color=always` to highlight matches even
628when a pager is used.
629
630color.grep.match::
631Use customized color for matches. The value of this variable
632may be specified as in color.branch.<slot>. It is passed using
633the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
634calling an external 'grep'.
635
Junio C Hamano00b8b632007-12-07 09:50:49636color.interactive::
Junio C Hamano35738e82008-01-07 07:55:46637When set to `always`, always use colors for interactive prompts
Junio C Hamanoba4b9282008-07-06 05:20:31638and displays (such as those used by "git-add --interactive").
Junio C Hamano00b8b632007-12-07 09:50:49639When false (or `never`), never. When set to `true` or `auto`, use
640colors only when the output is to the terminal. Defaults to false.
641
642color.interactive.<slot>::
Junio C Hamanoba4b9282008-07-06 05:20:31643Use customized color for 'git-add --interactive'
Junio C Hamanoe5bf6c12009-02-07 21:43:10644output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
645four distinct types of normal output from interactive
Junio C Hamano27a128b2009-08-13 01:23:00646commands. The values of these variables may be specified as
Junio C Hamano00b8b632007-12-07 09:50:49647in color.branch.<slot>.
648
Junio C Hamanoe7935c42006-12-13 21:32:17649color.pager::
650A boolean to enable/disable colored output when the pager is in
651use (default is true).
652
Junio C Hamano52ba2952009-05-18 17:43:02653color.showbranch::
654A boolean to enable/disable color in the output of
655linkgit:git-show-branch[1]. May be set to `always`,
656`false` (or `never`) or `auto` (or `true`), in which case colors are used
657only when the output is to a terminal. Defaults to false.
658
Junio C Hamanoe7935c42006-12-13 21:32:17659color.status::
660A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46661linkgit:git-status[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21662`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoe7935c42006-12-13 21:32:17663only when the output is to a terminal. Defaults to false.
664
665color.status.<slot>::
666Use customized color for status colorization. `<slot>` is
667one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:04668`added` or `updated` (files which are added but not committed),
669`changed` (files which are changed but not added in the index),
Junio C Hamanob713ff12008-05-24 01:12:30670`untracked` (files which are not tracked by git), or
671`nobranch` (the color the 'no branch' warning is shown in, defaulting
672to red). The values of these variables may be specified as in
673color.branch.<slot>.
Junio C Hamanoe7935c42006-12-13 21:32:17674
Junio C Hamano83d46a22008-02-21 02:29:42675color.ui::
676When set to `always`, always use colors in all git commands which
677are capable of colored output. When false (or `never`), never. When
678set to `true` or `auto`, use colors only when the output is to the
679terminal. When more specific variables of color.* are set, they always
680take precedence over this setting. Defaults to false.
681
Junio C Hamano4653c6f2008-11-26 22:50:20682commit.template::
683Specify a file to use as the template for new commit messages.
684
Junio C Hamanodbb64592007-09-01 11:17:39685diff.autorefreshindex::
Junio C Hamanoba4b9282008-07-06 05:20:31686When using 'git-diff' to compare with work tree
Junio C Hamanodbb64592007-09-01 11:17:39687files, do not consider stat-only change as changed.
688Instead, silently run `git update-index --refresh` to
689update the cached stat information for paths whose
690contents in the work tree match the contents in the
691index. This option defaults to true. Note that this
Junio C Hamanoba4b9282008-07-06 05:20:31692affects only 'git-diff' Porcelain, and not lower level
693'diff' commands, such as 'git-diff-files'.
Junio C Hamanodbb64592007-09-01 11:17:39694
Junio C Hamano1fbbbc12007-12-18 07:01:27695diff.external::
696If this config variable is set, diff generation is not
697performed using the internal diff machinery, but using the
Junio C Hamano85c71572008-07-28 00:03:31698given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
699environment variable. The command is called with parameters
700as described under "git Diffs" in linkgit:git[1]. Note: if
701you want to use an external diff program only on a subset of
702your files, you might want to use linkgit:gitattributes[5] instead.
Junio C Hamano1fbbbc12007-12-18 07:01:27703
Junio C Hamano5e4d8de2008-09-19 06:27:02704diff.mnemonicprefix::
705If set, 'git-diff' uses a prefix pair that is different from the
706standard "a/" and "b/" depending on what is being compared. When
707this configuration is in effect, reverse diff output also swaps
708the order of the prefixes:
709'git-diff';;
710compares the (i)ndex and the (w)ork tree;
711'git-diff HEAD';;
712 compares a (c)ommit and the (w)ork tree;
713'git diff --cached';;
714compares a (c)ommit and the (i)ndex;
715'git-diff HEAD:file1 file2';;
716compares an (o)bject and a (w)ork tree entity;
717'git diff --no-index a b';;
718compares two non-git things (1) and (2).
719
Junio C Hamano07824ce2006-04-25 07:36:54720diff.renameLimit::
721The number of files to consider when performing the copy/rename
Junio C Hamanoba4b9282008-07-06 05:20:31722detection; equivalent to the 'git-diff' option '-l'.
Junio C Hamano07824ce2006-04-25 07:36:54723
Junio C Hamano9ae1a062006-07-10 08:12:34724diff.renames::
725Tells git to detect renames. If set to any boolean value, it
726will enable basic rename detection. If set to "copies" or
727"copy", it will detect copies, as well.
728
Junio C Hamanobc4852e2009-01-21 10:51:14729diff.suppressBlankEmpty::
Junio C Hamanof1231492008-12-22 08:27:21730A boolean to inhibit the standard behavior of printing a space
731before each empty output line. Defaults to false.
732
Junio C Hamano3bd66e92009-04-18 06:17:56733diff.tool::
734Controls which diff tool is used. `diff.tool` overrides
735`merge.tool` when used by linkgit:git-difftool[1] and has
736the same valid values as `merge.tool` minus "tortoisemerge"
737and plus "kompare".
738
739difftool.<tool>.path::
740Override the path for the given tool. This is useful in case
741your tool is not in the PATH.
742
743difftool.<tool>.cmd::
744Specify the command to invoke the specified diff tool.
745The specified command is evaluated in shell with the following
746variables available: 'LOCAL' is set to the name of the temporary
747file containing the contents of the diff pre-image and 'REMOTE'
748is set to the name of the temporary file containing the contents
749of the diff post-image.
750
751difftool.prompt::
752Prompt before each invocation of the diff tool.
753
Junio C Hamano20d47e32009-01-26 06:36:02754diff.wordRegex::
755A POSIX Extended Regular Expression used to determine what is a "word"
756when performing word-by-word difference calculations. Character
757sequences that match the regular expression are "words", all other
758characters are *ignorable* whitespace.
759
Junio C Hamano54ea8d32007-01-25 07:59:48760fetch.unpackLimit::
761If the number of objects fetched over the git native
762transfer is below this
763limit, then the objects will be unpacked into loose object
764files. However if the number of received objects equals or
765exceeds this limit then the received pack will be stored as
766a pack, after adding any missing delta bases. Storing the
767pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:17768especially on slow filesystems. If not set, the value of
769`transfer.unpackLimit` is used instead.
Junio C Hamano54ea8d32007-01-25 07:59:48770
Junio C Hamanof4581102009-04-25 08:29:59771format.attach::
772Enable multipart/mixed attachments as the default for
773'format-patch'. The value can also be a double quoted string
774which will enable attachments as the default and set the
775value as the boundary. See the --attach option in
776linkgit:git-format-patch[1].
777
Junio C Hamano8c5802d2007-11-15 00:13:36778format.numbered::
Junio C Hamano7d06a8a2008-10-20 05:42:33779A boolean which can enable or disable sequence numbers in patch
780subjects. It defaults to "auto" which enables it only if there
781is more than one patch. It can be enabled or disabled for all
782messages by setting it to "true" or "false". See --numbered
783option in linkgit:git-format-patch[1].
Junio C Hamano8c5802d2007-11-15 00:13:36784
Junio C Hamano07824ce2006-04-25 07:36:54785format.headers::
786Additional email headers to include in a patch to be submitted
Junio C Hamano35738e82008-01-07 07:55:46787by mail. See linkgit:git-format-patch[1].
Junio C Hamano07824ce2006-04-25 07:36:54788
Junio C Hamanof4581102009-04-25 08:29:59789format.cc::
790Additional "Cc:" headers to include in a patch to be submitted
791by mail. See the --cc option in linkgit:git-format-patch[1].
792
793format.subjectprefix::
794The default for format-patch is to output files with the '[PATCH]'
795subject prefix. Use this variable to change that prefix.
796
Junio C Hamanod4c8e112007-03-04 10:32:38797format.suffix::
798The default for format-patch is to output files with the suffix
799`.patch`. Use this variable to change that suffix (make sure to
800include the dot if you want it).
801
Junio C Hamano86bcccc2008-03-08 09:33:55802format.pretty::
803The default pretty format for log/show/whatchanged command,
804See linkgit:git-log[1], linkgit:git-show[1],
805linkgit:git-whatchanged[1].
806
Junio C Hamanoea6a7642009-03-11 23:56:19807format.thread::
808The default threading style for 'git-format-patch'. Can be
Junio C Hamanof4581102009-04-25 08:29:59809either a boolean value, `shallow` or `deep`. `shallow`
Junio C Hamanoea6a7642009-03-11 23:56:19810threading makes every mail a reply to the head of the series,
811where the head is chosen from the cover letter, the
812`\--in-reply-to`, and the first patch mail, in this order.
Junio C Hamanof4581102009-04-25 08:29:59813`deep` threading makes every mail a reply to the previous one.
Junio C Hamanoea6a7642009-03-11 23:56:19814A true boolean value is the same as `shallow`, and a false
815value disables threading.
816
Junio C Hamano5f9a6f02009-04-06 08:26:56817format.signoff::
818 A boolean value which lets you enable the `-s/--signoff` option of
819 format-patch by default. *Note:* Adding the Signed-off-by: line to a
820 patch should be a conscious act and means that you certify you have
821 the rights to submit this work under the same open source license.
822 Please see the 'SubmittingPatches' document for further discussion.
823
Junio C Hamanof2ce2972007-05-20 19:12:09824gc.aggressiveWindow::
825The window size parameter used in the delta compression
Junio C Hamanoba4b9282008-07-06 05:20:31826algorithm used by 'git-gc --aggressive'. This defaults
Junio C Hamanof2ce2972007-05-20 19:12:09827to 10.
828
Junio C Hamano1b50ce92007-10-03 12:05:53829gc.auto::
830When there are approximately more than this many loose
831objects in the repository, `git gc --auto` will pack them.
832Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:17833light-weight garbage collection from time to time. The
834default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53835
836gc.autopacklimit::
837When there are more than this many packs that are not
838marked with `*.keep` file in the repository, `git gc
Junio C Hamanoe77b0152008-01-12 06:44:17839--auto` consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:37840default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53841
Junio C Hamano9d52e572007-02-13 23:48:20842gc.packrefs::
Junio C Hamanoba4b9282008-07-06 05:20:31843'git-gc' does not run `git pack-refs` in a bare repository by
Junio C Hamano9d52e572007-02-13 23:48:20844default so that older dumb-transport clients can still fetch
Junio C Hamanoba4b9282008-07-06 05:20:31845from the repository. Setting this to `true` lets 'git-gc'
846to run `git pack-refs`. Setting this to `false` tells
847'git-gc' never to run `git pack-refs`. The default setting is
Junio C Hamano9d52e572007-02-13 23:48:20848`notbare`. Enable it only when you know you do not have to
849support such clients. The default setting will change to `true`
850at some stage, and setting this to `false` will continue to
Junio C Hamanoba4b9282008-07-06 05:20:31851prevent `git pack-refs` from being run from 'git-gc'.
Junio C Hamano9d52e572007-02-13 23:48:20852
Junio C Hamano09a926d2008-03-13 07:55:29853gc.pruneexpire::
Junio C Hamanoba4b9282008-07-06 05:20:31854When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
Junio C Hamanoa3148f52009-01-14 08:49:57855Override the grace period with this config variable. The value
856"now" may be used to disable this grace period and always prune
857unreachable objects immediately.
Junio C Hamano09a926d2008-03-13 07:55:29858
Junio C Hamano74640642006-12-27 10:59:55859gc.reflogexpire::
Junio C Hamanoba4b9282008-07-06 05:20:31860'git-reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:55861this time; defaults to 90 days.
862
863gc.reflogexpireunreachable::
Junio C Hamanoba4b9282008-07-06 05:20:31864'git-reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:55865this time and are not reachable from the current tip;
866defaults to 30 days.
867
868gc.rerereresolved::
869Records of conflicted merge you resolved earlier are
Junio C Hamanoba4b9282008-07-06 05:20:31870kept for this many days when 'git-rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:46871The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:55872
873gc.rerereunresolved::
874Records of conflicted merge you have not resolved are
Junio C Hamanoba4b9282008-07-06 05:20:31875kept for this many days when 'git-rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:46876The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:55877
Junio C Hamanoa3148f52009-01-14 08:49:57878gitcvs.commitmsgannotation::
879Append this string to each commit message. Set to empty string
880to disable this feature. Defaults to "via git-CVS emulator".
881
Junio C Hamano07824ce2006-04-25 07:36:54882gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:27883Whether the CVS server interface is enabled for this repository.
Junio C Hamano35738e82008-01-07 07:55:46884See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:54885
886gitcvs.logfile::
Junio C Hamanoa6387422007-08-25 03:54:27887Path to a log file where the CVS server interface well... logs
Junio C Hamano35738e82008-01-07 07:55:46888various stuff. See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:54889
Junio C Hamano17bd2272008-09-01 06:11:17890gitcvs.usecrlfattr::
Junio C Hamanodfccbb02008-05-26 01:16:14891If true, the server will look up the `crlf` attribute for
892files to determine the '-k' modes to use. If `crlf` is set,
893the '-k' mode will be left blank, so cvs clients will
894treat it as text. If `crlf` is explicitly unset, the file
Junio C Hamanocb1c44f2008-08-06 06:19:33895will be set with '-kb' mode, which suppresses any newline munging
Junio C Hamanodfccbb02008-05-26 01:16:14896the client might otherwise do. If `crlf` is not specified,
Junio C Hamanod32738e2008-07-09 19:53:42897then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
Junio C Hamanodfccbb02008-05-26 01:16:14898
Junio C Hamanod9e0e5d2007-04-14 16:22:04899gitcvs.allbinary::
Junio C Hamanodfccbb02008-05-26 01:16:14900This is used if 'gitcvs.usecrlfattr' does not resolve
901the correct '-kb' mode to use. If true, all
902unresolved files are sent to the client in
903mode '-kb'. This causes the client to treat them
904as binary files, which suppresses any newline munging it
905otherwise might do. Alternatively, if it is set to "guess",
906then the contents of the file are examined to decide if
907it is binary, similar to 'core.autocrlf'.
Junio C Hamanoa2ad99e2007-04-18 09:57:04908
909gitcvs.dbname::
910Database used by git-cvsserver to cache revision information
911derived from the git repository. The exact meaning depends on the
912used database driver, for SQLite (which is the default driver) this
913is a filename. Supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:46914linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Junio C Hamanoa2ad99e2007-04-18 09:57:04915Default: '%Ggitcvs.%m.sqlite'
916
917gitcvs.dbdriver::
918Used Perl DBI driver. You can specify any available driver
919 for this here, but it might not work. git-cvsserver is tested
920with 'DBD::SQLite', reported to work with 'DBD::Pg', and
921reported *not* to work with 'DBD::mysql'. Experimental feature.
922May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamano35738e82008-01-07 07:55:46923See linkgit:git-cvsserver[1].
Junio C Hamanod9e0e5d2007-04-14 16:22:04924
Junio C Hamanoa2ad99e2007-04-18 09:57:04925gitcvs.dbuser, gitcvs.dbpass::
926Database user and password. Only useful if setting 'gitcvs.dbdriver',
927since SQLite has no concept of database users and/or passwords.
928'gitcvs.dbuser' supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:46929linkgit:git-cvsserver[1] for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:04930
Junio C Hamanoa74efce2008-04-02 08:39:08931gitcvs.dbTableNamePrefix::
932Database table name prefix. Prepended to the names of any
933database tables used, allowing a single database to be used
934for several repositories. Supports variable substitution (see
935linkgit:git-cvsserver[1] for details). Any non-alphabetic
936characters will be replaced with underscores.
937
Junio C Hamanodfccbb02008-05-26 01:16:14938All gitcvs variables except for 'gitcvs.usecrlfattr' and
939'gitcvs.allbinary' can also be specified as
940'gitcvs.<access_method>.<varname>' (where 'access_method'
Junio C Hamanoa6387422007-08-25 03:54:27941is one of "ext" and "pserver") to make them apply only for the given
942access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:04943
Junio C Hamano6d76d612008-05-09 05:46:08944gui.commitmsgwidth::
945Defines how wide the commit message window is in the
946linkgit:git-gui[1]. "75" is the default.
947
948gui.diffcontext::
949Specifies how many context lines should be used in calls to diff
950made by the linkgit:git-gui[1]. The default is "5".
951
Junio C Hamanod3452a02008-11-15 08:07:55952gui.encoding::
953Specifies the default encoding to use for displaying of
954file contents in linkgit:git-gui[1] and linkgit:gitk[1].
955It can be overridden by setting the 'encoding' attribute
956for relevant files (see linkgit:gitattributes[5]).
957If this option is not set, the tools default to the
958locale encoding.
959
Junio C Hamano6d76d612008-05-09 05:46:08960gui.matchtrackingbranch::
961Determines if new branches created with linkgit:git-gui[1] should
962default to tracking remote branches with matching names or
963not. Default: "false".
964
965gui.newbranchtemplate::
966Is used as suggested name when creating new branches using the
967linkgit:git-gui[1].
968
969gui.pruneduringfetch::
970"true" if linkgit:git-gui[1] should prune tracking branches when
971performing a fetch. The default value is "false".
972
973gui.trustmtime::
974Determines if linkgit:git-gui[1] should trust the file modification
975timestamp or not. By default the timestamps are not trusted.
976
977gui.spellingdictionary::
978Specifies the dictionary used for spell checking commit messages in
979the linkgit:git-gui[1]. When set to "none" spell checking is turned
980off.
981
Junio C Hamanod3452a02008-11-15 08:07:55982gui.fastcopyblame::
983If true, 'git gui blame' uses '-C' instead of '-C -C' for original
984location detection. It makes blame significantly faster on huge
985repositories at the expense of less thorough copy detection.
986
987gui.copyblamethreshold::
Junio C Hamano610d1762008-11-28 06:27:13988Specifies the threshold to use in 'git gui blame' original location
Junio C Hamanod3452a02008-11-15 08:07:55989detection, measured in alphanumeric characters. See the
990linkgit:git-blame[1] manual for more information on copy detection.
991
992gui.blamehistoryctx::
993Specifies the radius of history context in days to show in
994linkgit:gitk[1] for the selected commit, when the `Show History
995Context` menu item is invoked from 'git gui blame'. If this
996variable is set to zero, the whole history is shown.
997
Junio C Hamano92d312a2008-12-15 07:22:20998guitool.<name>.cmd::
999Specifies the shell command line to execute when the corresponding item
1000of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1001mandatory for every tool. The command is executed from the root of
1002the working directory, and in the environment it receives the name of
1003the tool as 'GIT_GUITOOL', the name of the currently selected file as
1004'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1005the head is detached, 'CUR_BRANCH' is empty).
1006
1007guitool.<name>.needsfile::
1008Run the tool only if a diff is selected in the GUI. It guarantees
1009that 'FILENAME' is not empty.
1010
1011guitool.<name>.noconsole::
1012Run the command silently, without creating a window to display its
1013output.
1014
1015guitool.<name>.norescan::
1016Don't rescan the working directory for changes after the tool
1017finishes execution.
1018
1019guitool.<name>.confirm::
1020Show a confirmation dialog before actually running the tool.
1021
1022guitool.<name>.argprompt::
1023Request a string argument from the user, and pass it to the tool
1024through the 'ARGS' environment variable. Since requesting an
1025argument implies confirmation, the 'confirm' option has no effect
1026if this is enabled. If the option is set to 'true', 'yes', or '1',
1027the dialog uses a built-in generic prompt; otherwise the exact
1028value of the variable is used.
1029
1030guitool.<name>.revprompt::
1031Request a single valid revision from the user, and set the
1032'REVISION' environment variable. In other aspects this option
1033is similar to 'argprompt', and can be used together with it.
1034
1035guitool.<name>.revunmerged::
1036Show only unmerged branches in the 'revprompt' subdialog.
1037This is useful for tools similar to merge or rebase, but not
1038for things like checkout or reset.
1039
1040guitool.<name>.title::
1041Specifies the title to use for the prompt dialog. The default
1042is the tool name.
1043
1044guitool.<name>.prompt::
1045Specifies the general prompt string to display at the top of
1046the dialog, before subsections for 'argprompt' and 'revprompt'.
1047The default value includes the actual command.
1048
Junio C Hamano4e272312008-01-08 09:13:211049help.browser::
1050Specify the browser that will be used to display help in the
1051'web' format. See linkgit:git-help[1].
1052
1053help.format::
1054Override the default help format used by linkgit:git-help[1].
1055Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1056the default. 'web' and 'html' are the same.
1057
Junio C Hamanof24b8062008-09-09 01:34:391058help.autocorrect::
1059Automatically correct and execute mistyped commands after
1060waiting for the given number of deciseconds (0.1 sec). If more
1061than one command can be deduced from the entered text, nothing
1062will be executed. If the value of this option is negative,
1063the corrected command will be executed immediately. If the
1064value is 0 - the command will be just shown but not executed.
1065This is the default.
1066
Junio C Hamano58256872007-12-04 08:31:131067http.proxy::
1068Override the HTTP proxy, normally configured using the 'http_proxy'
Junio C Hamano35738e82008-01-07 07:55:461069environment variable (see linkgit:curl[1]). This can be overridden
Junio C Hamano58256872007-12-04 08:31:131070on a per-remote basis; see remote.<name>.proxy
1071
Junio C Hamano07824ce2006-04-25 07:36:541072http.sslVerify::
1073Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451074over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Junio C Hamano07824ce2006-04-25 07:36:541075variable.
1076
1077http.sslCert::
1078File containing the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451079over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Junio C Hamano07824ce2006-04-25 07:36:541080variable.
1081
1082http.sslKey::
1083File containing the SSL private key when fetching or pushing
Junio C Hamano341071d2006-06-04 07:24:481084over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Junio C Hamano07824ce2006-04-25 07:36:541085variable.
1086
Junio C Hamano48bc1ce2009-07-09 16:49:191087http.sslCertPasswordProtected::
1088Enable git's password prompt for the SSL certificate. Otherwise
1089OpenSSL will prompt the user, possibly many times, if the
1090certificate or private key is encrypted. Can be overridden by the
1091'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1092
Junio C Hamano07824ce2006-04-25 07:36:541093http.sslCAInfo::
1094File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:481095fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano07824ce2006-04-25 07:36:541096'GIT_SSL_CAINFO' environment variable.
1097
1098http.sslCAPath::
1099Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:451100with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541101by the 'GIT_SSL_CAPATH' environment variable.
1102
1103http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:481104How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541105by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1106
Junio C Hamano3b70d3c2009-11-21 17:37:371107http.postBuffer::
1108Maximum size in bytes of the buffer used by smart HTTP
1109transports when POSTing data to the remote system.
1110For requests larger than this buffer size, HTTP/1.1 and
1111Transfer-Encoding: chunked is used to avoid creating a
1112massive pack file locally. Default is 1 MiB, which is
1113sufficient for most requests.
1114
Junio C Hamano07824ce2006-04-25 07:36:541115http.lowSpeedLimit, http.lowSpeedTime::
1116If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1117for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano341071d2006-06-04 07:24:481118Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Junio C Hamano07824ce2006-04-25 07:36:541119'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1120
Junio C Hamanof1dcdfe2006-09-29 08:10:511121http.noEPSV::
1122A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:041123This can helpful with some "poor" ftp servers which don't
Junio C Hamanof1dcdfe2006-09-29 08:10:511124support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1125environment variable. Default is false (curl will use EPSV).
1126
Junio C Hamano07824ce2006-04-25 07:36:541127i18n.commitEncoding::
1128Character encoding the commit messages are stored in; git itself
1129does not care per se, but this information is necessary e.g. when
1130importing commits from emails or in the gitk graphical history
1131browser (and possibly at other places in the future or in other
Junio C Hamano35738e82008-01-07 07:55:461132porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Junio C Hamano07824ce2006-04-25 07:36:541133
Junio C Hamano51f92e22006-12-29 05:18:281134i18n.logOutputEncoding::
1135Character encoding the commit messages are converted to when
Junio C Hamanoba4b9282008-07-06 05:20:311136running 'git-log' and friends.
Junio C Hamano51f92e22006-12-29 05:18:281137
Junio C Hamano4653c6f2008-11-26 22:50:201138imap::
1139The configuration variables in the 'imap' section are described
1140in linkgit:git-imap-send[1].
1141
Junio C Hamano4e272312008-01-08 09:13:211142instaweb.browser::
1143Specify the program that will be used to browse your working
1144repository in gitweb. See linkgit:git-instaweb[1].
1145
1146instaweb.httpd::
1147The HTTP daemon command-line to start gitweb on your working
1148repository. See linkgit:git-instaweb[1].
1149
1150instaweb.local::
1151If true the web server started by linkgit:git-instaweb[1] will
1152be bound to the local IP (127.0.0.1).
1153
1154instaweb.modulepath::
1155The module path for an apache httpd used by linkgit:git-instaweb[1].
1156
1157instaweb.port::
1158The port number to bind the gitweb httpd to. See
1159linkgit:git-instaweb[1].
1160
Junio C Hamanoe5bf6c12009-02-07 21:43:101161interactive.singlekey::
Junio C Hamano27a128b2009-08-13 01:23:001162In interactive commands, allow the user to provide one-letter
Junio C Hamanoe5bf6c12009-02-07 21:43:101163input with a single key (i.e., without hitting enter).
1164Currently this is used only by the `\--patch` mode of
1165linkgit:git-add[1]. Note that this setting is silently
1166ignored if portable keystroke input is not available.
1167
Junio C Hamanob713ff12008-05-24 01:12:301168log.date::
1169Set default date-time mode for the log command. Setting log.date
Junio C Hamanoba4b9282008-07-06 05:20:311170value is similar to using 'git-log'\'s --date option. The value is one of the
Junio C Hamanob713ff12008-05-24 01:12:301171following alternatives: {relative,local,default,iso,rfc,short}.
1172See linkgit:git-log[1].
1173
Junio C Hamanofe9acab2006-11-24 12:10:551174log.showroot::
1175If true, the initial commit will be shown as a big creation event.
1176This is equivalent to a diff against an empty tree.
Junio C Hamano35738e82008-01-07 07:55:461177Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Junio C Hamanofe9acab2006-11-24 12:10:551178normally hide the root commit will now show it. True by default.
1179
Junio C Hamano8bc410e2009-02-15 10:38:191180mailmap.file::
1181The location of an augmenting mailmap file. The default
1182mailmap, located in the root of the repository, is loaded
1183first, then the mailmap file pointed to by this variable.
1184The location of the mailmap file may be in a repository
1185subdirectory, or somewhere outside of the repository itself.
1186See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1187
Junio C Hamano8b588d52008-03-15 09:48:371188man.viewer::
1189Specify the programs that may be used to display help in the
1190'man' format. See linkgit:git-help[1].
1191
Junio C Hamano6d76d612008-05-09 05:46:081192man.<tool>.cmd::
1193Specify the command to invoke the specified man viewer. The
1194specified command is evaluated in shell with the man page
1195passed as argument. (See linkgit:git-help[1].)
Junio C Hamano103ad7f2007-03-14 11:19:261196
Junio C Hamano6d76d612008-05-09 05:46:081197man.<tool>.path::
1198Override the path for the given tool that may be used to
1199display help in the 'man' format. See linkgit:git-help[1].
Junio C Hamanoe90436a2007-04-22 07:22:131200
Junio C Hamano4653c6f2008-11-26 22:50:201201include::merge-config.txt[]
Junio C Hamanoa476efa2008-10-10 15:31:421202
Junio C Hamano1fbbbc12007-12-18 07:01:271203mergetool.<tool>.path::
1204Override the path for the given tool. This is useful in case
1205your tool is not in the PATH.
1206
Junio C Hamano86bcccc2008-03-08 09:33:551207mergetool.<tool>.cmd::
1208Specify the command to invoke the specified merge tool. The
1209specified command is evaluated in shell with the following
1210variables available: 'BASE' is the name of a temporary file
1211containing the common base of the files to be merged, if available;
1212'LOCAL' is the name of a temporary file containing the contents of
1213the file on the current branch; 'REMOTE' is the name of a temporary
1214file containing the contents of the file from the branch being
1215merged; 'MERGED' contains the name of the file to which the merge
1216tool should write the results of a successful merge.
1217
1218mergetool.<tool>.trustExitCode::
1219For a custom merge command, specify whether the exit code of
1220the merge command can be used to determine whether the merge was
1221successful. If this is not set to true then the merge target file
1222timestamp is checked and the merge assumed to have been successful
1223if the file has been updated, otherwise the user is prompted to
1224indicate the success of the merge.
1225
1226mergetool.keepBackup::
1227After performing a merge, the original file with conflict markers
1228can be saved as a file with a `.orig` extension. If this variable
1229is set to `false` then this file is not preserved. Defaults to
1230`true` (i.e. keep the backup files).
1231
Junio C Hamano10b7a342009-01-01 22:05:171232mergetool.keepTemporaries::
1233When invoking a custom merge tool, git uses a set of temporary
1234files to pass to the tool. If the tool returns an error and this
1235variable is set to `true`, then these temporary files will be
1236preserved, otherwise they will be removed after the tool has
1237exited. Defaults to `false`.
1238
1239mergetool.prompt::
1240Prompt before each invocation of the merge resolution program.
1241
Junio C Hamano75cc4c92006-07-24 08:25:031242pack.window::
Junio C Hamano35738e82008-01-07 07:55:461243The size of the window used by linkgit:git-pack-objects[1] when no
Junio C Hamano75cc4c92006-07-24 08:25:031244window size is given on the command line. Defaults to 10.
1245
Junio C Hamano91d44c52007-05-09 07:16:071246pack.depth::
Junio C Hamano35738e82008-01-07 07:55:461247The maximum delta depth used by linkgit:git-pack-objects[1] when no
Junio C Hamano91d44c52007-05-09 07:16:071248maximum depth is given on the command line. Defaults to 50.
1249
Junio C Hamano235d53f2007-07-13 00:25:151250pack.windowMemory::
Junio C Hamano35738e82008-01-07 07:55:461251The window memory size limit used by linkgit:git-pack-objects[1]
Junio C Hamano235d53f2007-07-13 00:25:151252when no limit is given on the command line. The value can be
1253suffixed with "k", "m", or "g". Defaults to 0, meaning no
1254limit.
1255
Junio C Hamanof2ce2972007-05-20 19:12:091256pack.compression::
1257An integer -1..9, indicating the compression level for objects
1258in a pack file. -1 is the zlib default. 0 means no
1259compression, and 1..9 are various speed/size tradeoffs, 9 being
1260slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:421261not set, defaults to -1, the zlib default, which is "a default
1262compromise between speed and compression (currently equivalent
1263to level 6)."
Junio C Hamanof2ce2972007-05-20 19:12:091264
Junio C Hamano679d22d2007-06-02 21:13:441265pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:271266The maximum memory in bytes used for caching deltas in
Junio C Hamano9f883862009-08-11 06:23:521267linkgit:git-pack-objects[1] before writing them out to a pack.
1268This cache is used to speed up the writing object phase by not
1269having to recompute the final delta result once the best match
1270for all objects is found. Repacking large repositories on machines
1271which are tight with memory might be badly impacted by this though,
1272especially if this cache pushes the system into swapping.
1273A value of 0 means no limit. The smallest size of 1 byte may be
1274used to virtually disable this cache. Defaults to 256 MiB.
Junio C Hamano679d22d2007-06-02 21:13:441275
1276pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:141277The maximum size of a delta, that is cached in
Junio C Hamano9f883862009-08-11 06:23:521278linkgit:git-pack-objects[1]. This cache is used to speed up the
1279writing object phase by not having to recompute the final delta
1280result once the best match for all objects is found. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:441281
Junio C Hamano58155b42007-09-15 07:46:141282pack.threads::
1283Specifies the number of threads to spawn when searching for best
Junio C Hamano35738e82008-01-07 07:55:461284delta matches. This requires that linkgit:git-pack-objects[1]
Junio C Hamano58155b42007-09-15 07:46:141285be compiled with pthreads otherwise this option is ignored with a
1286warning. This is meant to reduce packing time on multiprocessor
1287machines. The required amount of memory for the delta search window
1288is however multiplied by the number of threads.
Junio C Hamano24bc09a2008-02-28 00:27:441289Specifying 0 will cause git to auto-detect the number of CPU's
1290and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:141291
Junio C Hamanod814b6d2007-11-04 11:13:491292pack.indexVersion::
1293Specify the default pack index version. Valid values are 1 for
1294legacy pack index used by Git versions prior to 1.5.2, and 2 for
1295the new pack index with capabilities for packs larger than 4 GB
1296as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:381297packs. Version 2 is the default. Note that version 2 is enforced
1298and this config option ignored whenever the corresponding pack is
1299larger than 2 GB.
1300+
1301If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1302cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1303that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1304other side may give you a repository that cannot be accessed with your
1305older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1306you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1307the `{asterisk}.idx` file.
Junio C Hamanod814b6d2007-11-04 11:13:491308
Junio C Hamano09a926d2008-03-13 07:55:291309pack.packSizeLimit::
Junio C Hamano49dccaf2008-02-10 10:48:011310The default maximum size of a pack. This setting only affects
1311packing to a file, i.e. the git:// protocol is unaffected. It
1312can be overridden by the `\--max-pack-size` option of
1313linkgit:git-repack[1].
1314
Junio C Hamano9e96a1a2008-08-16 10:23:181315pager.<cmd>::
Junio C Hamano0551f6a2008-08-25 00:33:331316Allows turning on or off pagination of the output of a
1317particular git subcommand when writing to a tty. If
1318`\--paginate` or `\--no-pager` is specified on the command line,
1319it takes precedence over this option. To disable pagination for
Junio C Hamanoea82cff2009-03-18 01:54:481320all commands, set `core.pager` or `GIT_PAGER` to `cat`.
Junio C Hamano9e96a1a2008-08-16 10:23:181321
Junio C Hamano07824ce2006-04-25 07:36:541322pull.octopus::
1323The default merge strategy to use when pulling multiple branches
1324at once.
1325
1326pull.twohead::
1327The default merge strategy to use when pulling a single branch.
1328
Junio C Hamano1de75722009-03-26 08:39:381329push.default::
1330Defines the action git push should take if no refspec is given
1331on the command line, no refspec is configured in the remote, and
1332no refspec is implied by any of the options given on the command
Junio C Hamano0706c802009-03-30 22:34:191333line. Possible values are:
Junio C Hamano1de75722009-03-26 08:39:381334+
1335* `nothing` do not push anything.
Junio C Hamano0706c802009-03-30 22:34:191336* `matching` push all matching branches.
Junio C Hamano1de75722009-03-26 08:39:381337 All branches having the same name in both ends are considered to be
Junio C Hamano0706c802009-03-30 22:34:191338 matching. This is the default.
Junio C Hamano98e32c32009-04-13 02:39:531339* `tracking` push the current branch to its upstream branch.
Junio C Hamano0706c802009-03-30 22:34:191340* `current` push the current branch to a branch of the same name.
Junio C Hamano1de75722009-03-26 08:39:381341
Junio C Hamanoea6a7642009-03-11 23:56:191342rebase.stat::
1343Whether to show a diffstat of what changed upstream since the last
1344rebase. False by default.
1345
Junio C Hamano621e1232009-10-26 05:16:471346receive.autogc::
1347By default, git-receive-pack will run "git-gc --auto" after
1348receiving data from git-push and updating refs. You can stop
1349it by setting this variable to false.
1350
Junio C Hamano4653c6f2008-11-26 22:50:201351receive.fsckObjects::
1352If it is set to true, git-receive-pack will check all received
1353objects. It will abort in the case of a malformed object or a
1354broken link. The result of an abort are only dangling objects.
1355Defaults to false.
1356
1357receive.unpackLimit::
1358If the number of objects received in a push is below this
1359limit then the objects will be unpacked into loose object
1360files. However if the number of received objects equals or
1361exceeds this limit then the received pack will be stored as
1362a pack, after adding any missing delta bases. Storing the
1363pack from a push can make the push operation complete faster,
1364especially on slow filesystems. If not set, the value of
1365`transfer.unpackLimit` is used instead.
1366
1367receive.denyDeletes::
1368If set to true, git-receive-pack will deny a ref update that deletes
1369the ref. Use this to prevent such a ref deletion via a push.
1370
1371receive.denyCurrentBranch::
1372If set to true or "refuse", receive-pack will deny a ref update
1373to the currently checked out branch of a non-bare repository.
1374Such a push is potentially dangerous because it brings the HEAD
1375out of sync with the index and working tree. If set to "warn",
1376print a warning of such a push to stderr, but allow the push to
1377proceed. If set to false or "ignore", allow such pushes with no
1378message. Defaults to "warn".
1379
1380receive.denyNonFastForwards::
1381If set to true, git-receive-pack will deny a ref update which is
Junio C Hamano3f680f32009-11-16 02:10:541382not a fast-forward. Use this to prevent such an update via a push,
Junio C Hamano4653c6f2008-11-26 22:50:201383even if that push is forced. This configuration variable is
1384set when initializing a shared repository.
1385
Junio C Hamano621e1232009-10-26 05:16:471386receive.updateserverinfo::
1387If set to true, git-receive-pack will run git-update-server-info
1388after receiving data from git-push and updating refs.
1389
Junio C Hamano249572f2006-10-24 05:44:081390remote.<name>.url::
Junio C Hamano35738e82008-01-07 07:55:461391The URL of a remote repository. See linkgit:git-fetch[1] or
1392linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:081393
Junio C Hamano0e88f3e2009-06-21 08:03:251394remote.<name>.pushurl::
1395The push URL of a remote repository. See linkgit:git-push[1].
1396
Junio C Hamano58256872007-12-04 08:31:131397remote.<name>.proxy::
1398For remotes that require curl (http, https and ftp), the URL to
1399the proxy to use for that remote. Set to the empty string to
1400disable proxying for that remote.
1401
Junio C Hamano249572f2006-10-24 05:44:081402remote.<name>.fetch::
Junio C Hamano35738e82008-01-07 07:55:461403The default set of "refspec" for linkgit:git-fetch[1]. See
1404linkgit:git-fetch[1].
Junio C Hamano249572f2006-10-24 05:44:081405
1406remote.<name>.push::
Junio C Hamano35738e82008-01-07 07:55:461407The default set of "refspec" for linkgit:git-push[1]. See
1408linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:081409
Junio C Hamano47d68a52008-05-06 06:35:401410remote.<name>.mirror::
1411If true, pushing to this remote will automatically behave
1412as if the `\--mirror` option was given on the command line.
1413
Junio C Hamano118d2772007-02-21 20:24:101414remote.<name>.skipDefaultUpdate::
1415If true, this remote will be skipped by default when updating
Junio C Hamano35738e82008-01-07 07:55:461416using the update subcommand of linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101417
Junio C Hamano4ad294b2007-01-20 02:22:501418remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:481419The default program to execute on the remote side when pushing. See
Junio C Hamano86bcccc2008-03-08 09:33:551420option \--receive-pack of linkgit:git-push[1].
Junio C Hamano4ad294b2007-01-20 02:22:501421
Junio C Hamano54ea8d32007-01-25 07:59:481422remote.<name>.uploadpack::
1423The default program to execute on the remote side when fetching. See
Junio C Hamano86bcccc2008-03-08 09:33:551424option \--upload-pack of linkgit:git-fetch-pack[1].
Junio C Hamano54ea8d32007-01-25 07:59:481425
Junio C Hamano17dde0e2007-02-26 09:50:211426remote.<name>.tagopt::
Junio C Hamano86bcccc2008-03-08 09:33:551427Setting this value to \--no-tags disables automatic tag following when
1428fetching from remote <name>
Junio C Hamano17dde0e2007-02-26 09:50:211429
Junio C Hamano118d2772007-02-21 20:24:101430remotes.<group>::
1431The list of remotes which are fetched by "git remote update
Junio C Hamano35738e82008-01-07 07:55:461432<group>". See linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101433
Junio C Hamano77b7e902006-10-23 07:18:501434repack.usedeltabaseoffset::
Junio C Hamanofce7c7e2008-07-02 03:06:381435By default, linkgit:git-repack[1] creates packs that use
1436delta-base offset. If you need to share your repository with
1437git older than version 1.4.4, either directly or via a dumb
1438protocol such as http, then you need to set this option to
1439"false" and repack. Access from old git versions over the
1440native protocol are unaffected by this option.
Junio C Hamano77b7e902006-10-23 07:18:501441
Junio C Hamano4653c6f2008-11-26 22:50:201442rerere.autoupdate::
1443When set to true, `git-rerere` updates the index with the
1444resulting contents after it cleanly resolves conflicts using
1445previously recorded resolution. Defaults to false.
1446
1447rerere.enabled::
1448Activate recording of resolved conflicts, so that identical
1449conflict hunks can be resolved automatically, should they
1450be encountered again. linkgit:git-rerere[1] command is by
1451default enabled if you create `rr-cache` directory under
1452`$GIT_DIR`, but can be disabled by setting this option to false.
1453
Junio C Hamano1bbd0f42009-07-23 06:20:291454sendemail.identity::
1455A configuration identity. When given, causes values in the
1456'sendemail.<identity>' subsection to take precedence over
1457values in the 'sendemail' section. The default identity is
1458the value of 'sendemail.identity'.
1459
1460sendemail.smtpencryption::
1461See linkgit:git-send-email[1] for description. Note that this
1462setting is not subject to the 'identity' mechanism.
1463
1464sendemail.smtpssl::
1465Deprecated alias for 'sendemail.smtpencryption = ssl'.
1466
1467sendemail.<identity>.*::
1468Identity-specific versions of the 'sendemail.*' parameters
1469found below, taking precedence over those when the this
1470identity is selected, through command-line or
1471'sendemail.identity'.
1472
1473sendemail.aliasesfile::
1474sendemail.aliasfiletype::
1475sendemail.bcc::
1476sendemail.cc::
1477sendemail.cccmd::
1478sendemail.chainreplyto::
1479sendemail.confirm::
1480sendemail.envelopesender::
1481sendemail.from::
1482sendemail.multiedit::
1483sendemail.signedoffbycc::
1484sendemail.smtppass::
1485sendemail.suppresscc::
1486sendemail.suppressfrom::
1487sendemail.to::
1488sendemail.smtpserver::
1489sendemail.smtpserverport::
1490sendemail.smtpuser::
1491sendemail.thread::
1492sendemail.validate::
1493See linkgit:git-send-email[1] for description.
1494
1495sendemail.signedoffcc::
1496Deprecated alias for 'sendemail.signedoffbycc'.
1497
Junio C Hamano07824ce2006-04-25 07:36:541498showbranch.default::
Junio C Hamano35738e82008-01-07 07:55:461499The default set of branches for linkgit:git-show-branch[1].
1500See linkgit:git-show-branch[1].
Junio C Hamano07824ce2006-04-25 07:36:541501
Junio C Hamano942b35e2007-12-09 10:19:331502status.relativePaths::
Junio C Hamano35738e82008-01-07 07:55:461503By default, linkgit:git-status[1] shows paths relative to the
Junio C Hamano942b35e2007-12-09 10:19:331504current directory. Setting this variable to `false` shows paths
1505relative to the repository root (this was the default for git
1506prior to v1.5.4).
1507
Junio C Hamano4224f992008-06-23 07:14:081508status.showUntrackedFiles::
1509By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1510files which are not currently tracked by Git. Directories which
1511contain only untracked files, are shown with the directory name
1512only. Showing untracked files means that Git needs to lstat() all
1513all the files in the whole repository, which might be slow on some
1514systems. So, this variable controls how the commands displays
1515the untracked files. Possible values are:
1516+
1517--
1518- 'no' - Show no untracked files
1519- 'normal' - Shows untracked files and directories
1520- 'all' - Shows also individual files in untracked directories.
1521--
1522+
1523If this variable is not specified, it defaults to 'normal'.
1524This variable can be overridden with the -u|--untracked-files option
1525of linkgit:git-status[1] and linkgit:git-commit[1].
1526
Junio C Hamano75cc4c92006-07-24 08:25:031527tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:091528This variable can be used to restrict the permission bits of
1529tar archive entries. The default is 0002, which turns off the
1530world write bit. The special value "user" indicates that the
1531archiving user's umask will be used instead. See umask(2) and
Junio C Hamano35738e82008-01-07 07:55:461532linkgit:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:031533
Junio C Hamano4653c6f2008-11-26 22:50:201534transfer.unpackLimit::
1535When `fetch.unpackLimit` or `receive.unpackLimit` are
1536not set, the value of this variable is used instead.
1537The default value is 100.
1538
Junio C Hamano24bc09a2008-02-28 00:27:441539url.<base>.insteadOf::
1540Any URL that starts with this value will be rewritten to
1541start, instead, with <base>. In cases where some site serves a
1542large number of repositories, and serves them with multiple
1543access methods, and some users need to use different access
1544methods, this feature allows people to specify any of the
1545equivalent URLs and have git automatically rewrite the URL to
1546the best alternative for the particular user, even for a
1547never-before-seen repository on the site. When more than one
1548insteadOf strings match a given URL, the longest match is used.
1549
Junio C Hamano7df6dcf2009-09-13 09:51:171550url.<base>.pushInsteadOf::
1551Any URL that starts with this value will not be pushed to;
1552instead, it will be rewritten to start with <base>, and the
1553resulting URL will be pushed to. In cases where some site serves
1554a large number of repositories, and serves them with multiple
1555access methods, some of which do not allow push, this feature
1556allows people to specify a pull-only URL and have git
1557automatically use an appropriate URL to push, even for a
1558never-before-seen repository on the site. When more than one
1559pushInsteadOf strings match a given URL, the longest match is
1560used. If a remote has an explicit pushurl, git will ignore this
1561setting for that remote.
1562
Junio C Hamano07824ce2006-04-25 07:36:541563user.email::
1564Your email address to be recorded in any newly created commits.
Junio C Hamano469d60e2007-04-29 18:30:341565Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Junio C Hamano35738e82008-01-07 07:55:461566'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:541567
1568user.name::
1569Your full name to be recorded in any newly created commits.
Junio C Hamano341071d2006-06-04 07:24:481570Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Junio C Hamano35738e82008-01-07 07:55:461571environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:541572
Junio C Hamanoa890c4f2007-01-28 10:29:211573user.signingkey::
Junio C Hamano35738e82008-01-07 07:55:461574If linkgit:git-tag[1] is not selecting the key you want it to
Junio C Hamanoa890c4f2007-01-28 10:29:211575automatically when creating a signed tag, you can override the
1576default selection with this variable. This option is passed
1577unchanged to gpg's --local-user parameter, so you may specify a key
1578using any method that gpg supports.
1579
Junio C Hamano4e272312008-01-08 09:13:211580web.browser::
1581Specify a web browser that may be used by some commands.
1582Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1583may use it.