Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1 | CONFIGURATION FILE |
| 2 | ------------------ |
| 3 | |
| 4 | The git configuration file contains a number of variables that affect |
Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 5 | the git command's behavior. The `.git/config` file in each repository |
| 6 | is used to store the configuration for that repository, and |
| 7 | `$HOME/.gitconfig` is used to store a per-user configuration as |
| 8 | fallback values for the `.git/config` file. The file `/etc/gitconfig` |
| 9 | can be used to store a system-wide default configuration. |
Junio C Hamano | 8f76dc6 | 2007-01-17 07:24:25 | [diff] [blame] | 10 | |
Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 11 | The configuration variables are used by both the git plumbing |
| 12 | and the porcelains. The variables are divided into sections, wherein |
| 13 | the fully qualified variable name of the variable itself is the last |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 14 | dot-separated segment and the section name is everything before the last |
| 15 | dot. The variable names are case-insensitive and only alphanumeric |
| 16 | characters are allowed. Some variables may appear multiple times. |
| 17 | |
Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 18 | Syntax |
| 19 | ~~~~~~ |
| 20 | |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 21 | The syntax is fairly flexible and permissive; whitespaces are mostly |
Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 22 | ignored. The '#' and ';' characters begin comments to the end of line, |
| 23 | blank lines are ignored. |
| 24 | |
| 25 | The file consists of sections and variables. A section begins with |
| 26 | the name of the section in square brackets and continues until the next |
| 27 | section begins. Section names are not case sensitive. Only alphanumeric |
Junio C Hamano | ea82cff | 2009-03-18 01:54:48 | [diff] [blame] | 28 | characters, `-` and `.` are allowed in section names. Each variable |
Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 29 | must belong to some section, which means that there must be a section |
| 30 | header before the first setting of a variable. |
Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 31 | |
| 32 | Sections can be further divided into subsections. To begin a subsection |
| 33 | put its name in double quotes, separated by space from the section name, |
Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 34 | in the section header, like in the example below: |
Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 35 | |
| 36 | -------- |
| 37 | [section "subsection"] |
| 38 | |
| 39 | -------- |
| 40 | |
Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 41 | Subsection names are case sensitive and can contain any characters except |
| 42 | newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`, |
| 43 | respectively). Section headers cannot span multiple |
Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 44 | lines. Variables may belong directly to a section or to a given subsection. |
| 45 | You can have `[section]` if you have `[section "subsection"]`, but you |
| 46 | don't need to. |
| 47 | |
Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 48 | There is also a case insensitive alternative `[section.subsection]` syntax. |
| 49 | In this syntax, subsection names follow the same restrictions as for section |
| 50 | names. |
Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 51 | |
Junio C Hamano | aa2cd76 | 2009-07-26 08:14:01 | [diff] [blame] | 52 | All the other lines (and the remainder of the line after the section |
| 53 | header) are recognized as setting variables, in the form |
Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 54 | 'name = value'. If there is no equal sign on the line, the entire line |
| 55 | is taken as 'name' and the variable is recognized as boolean "true". |
| 56 | The variable names are case-insensitive and only alphanumeric |
Junio C Hamano | ea82cff | 2009-03-18 01:54:48 | [diff] [blame] | 57 | characters and `-` are allowed. There can be more than one value |
Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 58 | for a given variable; we say then that variable is multivalued. |
| 59 | |
| 60 | Leading and trailing whitespace in a variable value is discarded. |
| 61 | Internal whitespace within a variable value is retained verbatim. |
| 62 | |
| 63 | The values following the equals sign in variable assign are all either |
| 64 | a string, an integer, or a boolean. Boolean values may be given as yes/no, |
Junio C Hamano | 4cfa536 | 2009-04-18 23:01:01 | [diff] [blame] | 65 | 0/1, true/false or on/off. Case is not significant in boolean values, when |
Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 66 | converting value to the canonical form using '--bool' type specifier; |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 67 | 'git-config' will ensure that the output is "true" or "false". |
Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 68 | |
| 69 | String values may be entirely or partially enclosed in double quotes. |
Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 70 | You need to enclose variable values in double quotes if you want to |
| 71 | preserve leading or trailing whitespace, or if the variable value contains |
| 72 | comment characters (i.e. it contains '#' or ';'). |
| 73 | Double quote `"` and backslash `\` characters in variable values must |
Junio C Hamano | ea82cff | 2009-03-18 01:54:48 | [diff] [blame] | 74 | be escaped: use `\"` for `"` and `\\` for `\`. |
Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 75 | |
Junio C Hamano | ea82cff | 2009-03-18 01:54:48 | [diff] [blame] | 76 | The following escape sequences (beside `\"` and `\\`) are recognized: |
| 77 | `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) |
| 78 | and `\b` for backspace (BS). No other char escape sequence, nor octal |
Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 79 | char sequences are valid. |
| 80 | |
Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 81 | Variable values ending in a `\` are continued on the next line in the |
Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 82 | customary UNIX fashion. |
| 83 | |
Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 84 | Some variables may require a special value format. |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 85 | |
| 86 | Example |
| 87 | ~~~~~~~ |
| 88 | |
| 89 | # Core variables |
| 90 | [core] |
| 91 | ; Don't trust file modes |
| 92 | filemode = false |
| 93 | |
| 94 | # Our diff algorithm |
| 95 | [diff] |
Junio C Hamano | 85c7157 | 2008-07-28 00:03:31 | [diff] [blame] | 96 | external = /usr/local/bin/diff-wrapper |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 97 | renames = true |
| 98 | |
Junio C Hamano | 52401ef | 2006-12-19 00:54:38 | [diff] [blame] | 99 | [branch "devel"] |
| 100 | remote = origin |
| 101 | merge = refs/heads/devel |
| 102 | |
Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 103 | # Proxy settings |
| 104 | [core] |
Junio C Hamano | c71a873 | 2007-08-04 00:27:26 | [diff] [blame] | 105 | gitProxy="ssh" for "kernel.org" |
Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 106 | gitProxy=default-proxy ; for the rest |
Junio C Hamano | 52401ef | 2006-12-19 00:54:38 | [diff] [blame] | 107 | |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 108 | Variables |
| 109 | ~~~~~~~~~ |
| 110 | |
| 111 | Note that this list is non-comprehensive and not necessarily complete. |
Junio C Hamano | f1d1480 | 2006-06-08 00:48:17 | [diff] [blame] | 112 | For command-specific variables, you will find a more detailed description |
| 113 | in the appropriate manual page. You will find a description of non-core |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 114 | porcelain configuration variables in the respective porcelain documentation. |
| 115 | |
| 116 | core.fileMode:: |
| 117 | If false, the executable bit differences between the index and |
| 118 | the working copy are ignored; useful on broken filesystems like FAT. |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 119 | See linkgit:git-update-index[1]. True by default. |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 120 | |
Junio C Hamano | a476efa | 2008-10-10 15:31:42 | [diff] [blame] | 121 | core.ignoreCygwinFSTricks:: |
| 122 | This option is only used by Cygwin implementation of Git. If false, |
| 123 | the Cygwin stat() and lstat() functions are used. This may be useful |
| 124 | if your repository consists of a few separate directories joined in |
| 125 | one hierarchy using Cygwin mount. If true, Git uses native Win32 API |
| 126 | whenever it is possible and falls back to Cygwin functions only to |
| 127 | handle symbol links. The native mode is more than twice faster than |
Junio C Hamano | 7d06a8a | 2008-10-20 05:42:33 | [diff] [blame] | 128 | normal Cygwin l/stat() functions. True by default, unless core.filemode |
| 129 | is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's |
| 130 | POSIX emulation is required to support core.filemode. |
Junio C Hamano | a476efa | 2008-10-10 15:31:42 | [diff] [blame] | 131 | |
Junio C Hamano | 90ccff3 | 2008-07-29 08:17:24 | [diff] [blame] | 132 | core.trustctime:: |
| 133 | If false, the ctime differences between the index and the |
| 134 | working copy are ignored; useful when the inode change time |
| 135 | is regularly modified by something outside Git (file system |
| 136 | crawlers and some backup systems). |
| 137 | See linkgit:git-update-index[1]. True by default. |
| 138 | |
Junio C Hamano | d526ba9 | 2007-07-02 00:17:42 | [diff] [blame] | 139 | core.quotepath:: |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 140 | The commands that output paths (e.g. 'ls-files', |
| 141 | 'diff'), when not given the `-z` option, will quote |
Junio C Hamano | d526ba9 | 2007-07-02 00:17:42 | [diff] [blame] | 142 | "unusual" characters in the pathname by enclosing the |
| 143 | pathname in a double-quote pair and with backslashes the |
| 144 | same way strings in C source code are quoted. If this |
| 145 | variable is set to false, the bytes higher than 0x80 are |
| 146 | not quoted but output as verbatim. Note that double |
| 147 | quote, backslash and control characters are always |
| 148 | quoted without `-z` regardless of the setting of this |
| 149 | variable. |
| 150 | |
Junio C Hamano | d9e0e5d | 2007-04-14 16:22:04 | [diff] [blame] | 151 | core.autocrlf:: |
| 152 | If true, makes git convert `CRLF` at the end of lines in text files to |
| 153 | `LF` when reading from the filesystem, and convert in reverse when |
| 154 | writing to the filesystem. The variable can be set to |
| 155 | 'input', in which case the conversion happens only while |
| 156 | reading from the filesystem but files are written out with |
| 157 | `LF` at the end of lines. Currently, which paths to consider |
| 158 | "text" (i.e. be subjected to the autocrlf mechanism) is |
| 159 | decided purely based on the contents. |
| 160 | |
Junio C Hamano | 26e590a | 2008-02-17 03:53:51 | [diff] [blame] | 161 | core.safecrlf:: |
| 162 | If true, makes git check if converting `CRLF` as controlled by |
| 163 | `core.autocrlf` is reversible. Git will verify if a command |
| 164 | modifies a file in the work tree either directly or indirectly. |
| 165 | For example, committing a file followed by checking out the |
| 166 | same file should yield the original file in the work tree. If |
| 167 | this is not the case for the current setting of |
| 168 | `core.autocrlf`, git will reject the file. The variable can |
| 169 | be set to "warn", in which case git will only warn about an |
| 170 | irreversible conversion but continue the operation. |
| 171 | + |
| 172 | CRLF conversion bears a slight chance of corrupting data. |
| 173 | autocrlf=true will convert CRLF to LF during commit and LF to |
| 174 | CRLF during checkout. A file that contains a mixture of LF and |
| 175 | CRLF before the commit cannot be recreated by git. For text |
| 176 | files this is the right thing to do: it corrects line endings |
| 177 | such that we have only LF line endings in the repository. |
| 178 | But for binary files that are accidentally classified as text the |
| 179 | conversion can corrupt data. |
| 180 | + |
| 181 | If you recognize such corruption early you can easily fix it by |
| 182 | setting the conversion type explicitly in .gitattributes. Right |
| 183 | after committing you still have the original file in your work |
| 184 | tree and this file is not yet corrupted. You can explicitly tell |
| 185 | git that this file is binary and git will handle the file |
| 186 | appropriately. |
| 187 | + |
| 188 | Unfortunately, the desired effect of cleaning up text files with |
| 189 | mixed line endings and the undesired effect of corrupting binary |
| 190 | files cannot be distinguished. In both cases CRLFs are removed |
| 191 | in an irreversible way. For text files this is the right thing |
| 192 | to do because CRLFs are line endings, while for binary files |
| 193 | converting CRLFs corrupts data. |
| 194 | + |
| 195 | Note, this safety check does not mean that a checkout will generate a |
| 196 | file identical to the original file for a different setting of |
| 197 | `core.autocrlf`, but only for the current one. For example, a text |
| 198 | file with `LF` would be accepted with `core.autocrlf=input` and could |
| 199 | later be checked out with `core.autocrlf=true`, in which case the |
| 200 | resulting file would contain `CRLF`, although the original file |
| 201 | contained `LF`. However, in both work trees the line endings would be |
| 202 | consistent, that is either all `LF` or all `CRLF`, but never mixed. A |
| 203 | file with mixed line endings would be reported by the `core.safecrlf` |
| 204 | mechanism. |
| 205 | |
Junio C Hamano | aa83a7d | 2007-03-05 02:37:29 | [diff] [blame] | 206 | core.symlinks:: |
| 207 | If false, symbolic links are checked out as small plain files that |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 208 | contain the link text. linkgit:git-update-index[1] and |
| 209 | linkgit:git-add[1] will not change the recorded type to regular |
Junio C Hamano | aa83a7d | 2007-03-05 02:37:29 | [diff] [blame] | 210 | file. Useful on filesystems like FAT that do not support |
| 211 | symbolic links. True by default. |
| 212 | |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 213 | core.gitProxy:: |
| 214 | A "proxy command" to execute (as 'command host port') instead |
| 215 | of establishing direct connection to the remote server when |
| 216 | using the git protocol for fetching. If the variable value is |
| 217 | in the "COMMAND for DOMAIN" format, the command is applied only |
| 218 | on hostnames ending with the specified domain string. This variable |
| 219 | may be set multiple times and is matched in the given order; |
| 220 | the first match wins. |
Junio C Hamano | f1d1480 | 2006-06-08 00:48:17 | [diff] [blame] | 221 | + |
| 222 | Can be overridden by the 'GIT_PROXY_COMMAND' environment variable |
| 223 | (which always applies universally, without the special "for" |
| 224 | handling). |
Junio C Hamano | ea82cff | 2009-03-18 01:54:48 | [diff] [blame] | 225 | + |
| 226 | The special string `none` can be used as the proxy command to |
| 227 | specify that no proxy be used for a given domain pattern. |
| 228 | This is useful for excluding servers inside a firewall from |
| 229 | proxy use, while defaulting to a common proxy for external domains. |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 230 | |
| 231 | core.ignoreStat:: |
Junio C Hamano | 054ea08 | 2008-06-01 08:26:34 | [diff] [blame] | 232 | If true, commands which modify both the working tree and the index |
| 233 | will mark the updated paths with the "assume unchanged" bit in the |
| 234 | index. These marked files are then assumed to stay unchanged in the |
| 235 | working copy, until you mark them otherwise manually - Git will not |
| 236 | detect the file changes by lstat() calls. This is useful on systems |
| 237 | where those are very slow, such as Microsoft Windows. |
| 238 | See linkgit:git-update-index[1]. |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 239 | False by default. |
| 240 | |
Junio C Hamano | 88a3a07 | 2006-05-04 08:01:43 | [diff] [blame] | 241 | core.preferSymlinkRefs:: |
| 242 | Instead of the default "symref" format for HEAD |
| 243 | and other symbolic reference files, use symbolic links. |
| 244 | This is sometimes needed to work with old scripts that |
| 245 | expect HEAD to be a symbolic link. |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 246 | |
Junio C Hamano | 1025e75 | 2007-02-23 07:21:26 | [diff] [blame] | 247 | core.bare:: |
| 248 | If true this repository is assumed to be 'bare' and has no |
| 249 | working directory associated with it. If this is the case a |
| 250 | number of commands that require a working directory will be |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 251 | disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. |
Junio C Hamano | 1025e75 | 2007-02-23 07:21:26 | [diff] [blame] | 252 | + |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 253 | This setting is automatically guessed by linkgit:git-clone[1] or |
| 254 | linkgit:git-init[1] when the repository was created. By default a |
Junio C Hamano | 1025e75 | 2007-02-23 07:21:26 | [diff] [blame] | 255 | repository that ends in "/.git" is assumed to be not bare (bare = |
| 256 | false), while all other repositories are assumed to be bare (bare |
| 257 | = true). |
| 258 | |
Junio C Hamano | d526ba9 | 2007-07-02 00:17:42 | [diff] [blame] | 259 | core.worktree:: |
| 260 | Set the path to the working tree. The value will not be |
| 261 | used in combination with repositories found automatically in |
| 262 | a .git directory (i.e. $GIT_DIR is not set). |
Junio C Hamano | 764a667 | 2007-10-23 01:23:31 | [diff] [blame] | 263 | This can be overridden by the GIT_WORK_TREE environment |
Junio C Hamano | 7d575a5 | 2008-04-30 08:45:27 | [diff] [blame] | 264 | variable and the '--work-tree' command line option. It can be |
| 265 | a absolute path or relative path to the directory specified by |
| 266 | --git-dir or GIT_DIR. |
| 267 | Note: If --git-dir or GIT_DIR are specified but none of |
| 268 | --work-tree, GIT_WORK_TREE and core.worktree is specified, |
| 269 | the current working directory is regarded as the top directory |
| 270 | of your working tree. |
Junio C Hamano | d526ba9 | 2007-07-02 00:17:42 | [diff] [blame] | 271 | |
Junio C Hamano | 341071d | 2006-06-04 07:24:48 | [diff] [blame] | 272 | core.logAllRefUpdates:: |
Junio C Hamano | cae8627 | 2007-08-21 02:20:49 | [diff] [blame] | 273 | Enable the reflog. Updates to a ref <ref> is logged to the file |
Junio C Hamano | a2ec14f | 2006-11-02 00:22:48 | [diff] [blame] | 274 | "$GIT_DIR/logs/<ref>", by appending the new and old |
| 275 | SHA1, the date/time and the reason of the update, but |
| 276 | only when the file exists. If this configuration |
| 277 | variable is set to true, missing "$GIT_DIR/logs/<ref>" |
| 278 | file is automatically created for branch heads. |
Junio C Hamano | 1caaf47 | 2006-12-31 08:29:35 | [diff] [blame] | 279 | + |
| 280 | This information can be used to determine what commit |
| 281 | was the tip of a branch "2 days ago". |
| 282 | + |
| 283 | This value is true by default in a repository that has |
| 284 | a working directory associated with it, and false by |
| 285 | default in a bare repository. |
Junio C Hamano | 341071d | 2006-06-04 07:24:48 | [diff] [blame] | 286 | |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 287 | core.repositoryFormatVersion:: |
| 288 | Internal variable identifying the repository format and layout |
| 289 | version. |
| 290 | |
| 291 | core.sharedRepository:: |
Junio C Hamano | 0ab78ae | 2006-08-09 01:00:42 | [diff] [blame] | 292 | When 'group' (or 'true'), the repository is made shareable between |
| 293 | several users in a group (making sure all the files and objects are |
| 294 | group-writable). When 'all' (or 'world' or 'everybody'), the |
| 295 | repository will be readable by all users, additionally to being |
| 296 | group-shareable. When 'umask' (or 'false'), git will use permissions |
Junio C Hamano | 2f102bb | 2008-04-26 02:23:37 | [diff] [blame] | 297 | reported by umask(2). When '0xxx', where '0xxx' is an octal number, |
| 298 | files in the repository will have this mode value. '0xxx' will override |
Junio C Hamano | 83eded1 | 2009-04-20 08:18:00 | [diff] [blame] | 299 | user's umask value (whereas the other options will only override |
| 300 | requested parts of the user's umask value). Examples: '0660' will make |
| 301 | the repo read/write-able for the owner and group, but inaccessible to |
| 302 | others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a |
Junio C Hamano | 2f102bb | 2008-04-26 02:23:37 | [diff] [blame] | 303 | repository that is group-readable but not group-writable. |
| 304 | See linkgit:git-init[1]. False by default. |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 305 | |
| 306 | core.warnAmbiguousRefs:: |
| 307 | If true, git will warn you if the ref name you passed it is ambiguous |
| 308 | and might match multiple refs in the .git/refs/ tree. True by default. |
| 309 | |
Junio C Hamano | 7ec1572 | 2006-07-07 02:03:59 | [diff] [blame] | 310 | core.compression:: |
Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 311 | An integer -1..9, indicating a default compression level. |
| 312 | -1 is the zlib default. 0 means no compression, |
| 313 | and 1..9 are various speed/size tradeoffs, 9 being slowest. |
Junio C Hamano | 2e72a94 | 2007-11-21 08:54:42 | [diff] [blame] | 314 | If set, this provides a default to other compression variables, |
| 315 | such as 'core.loosecompression' and 'pack.compression'. |
Junio C Hamano | a126a3b | 2006-07-04 04:55:26 | [diff] [blame] | 316 | |
Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 317 | core.loosecompression:: |
| 318 | An integer -1..9, indicating the compression level for objects that |
| 319 | are not in a pack file. -1 is the zlib default. 0 means no |
| 320 | compression, and 1..9 are various speed/size tradeoffs, 9 being |
| 321 | slowest. If not set, defaults to core.compression. If that is |
Junio C Hamano | 2e72a94 | 2007-11-21 08:54:42 | [diff] [blame] | 322 | not set, defaults to 1 (best speed). |
Junio C Hamano | 28d9dfe | 2006-07-25 03:50:49 | [diff] [blame] | 323 | |
Junio C Hamano | fc4d38c | 2007-01-08 06:53:32 | [diff] [blame] | 324 | core.packedGitWindowSize:: |
| 325 | Number of bytes of a pack file to map into memory in a |
| 326 | single mapping operation. Larger window sizes may allow |
| 327 | your system to process a smaller number of large pack files |
| 328 | more quickly. Smaller window sizes will negatively affect |
| 329 | performance due to increased calls to the operating system's |
| 330 | memory manager, but may improve performance when accessing |
| 331 | a large number of large pack files. |
| 332 | + |
| 333 | Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 |
| 334 | MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should |
| 335 | be reasonable for all users/operating systems. You probably do |
| 336 | not need to adjust this value. |
| 337 | + |
| 338 | Common unit suffixes of 'k', 'm', or 'g' are supported. |
| 339 | |
| 340 | core.packedGitLimit:: |
| 341 | Maximum number of bytes to map simultaneously into memory |
| 342 | from pack files. If Git needs to access more than this many |
| 343 | bytes at once to complete an operation it will unmap existing |
| 344 | regions to reclaim virtual address space within the process. |
| 345 | + |
| 346 | Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. |
| 347 | This should be reasonable for all users/operating systems, except on |
| 348 | the largest projects. You probably do not need to adjust this value. |
| 349 | + |
| 350 | Common unit suffixes of 'k', 'm', or 'g' are supported. |
| 351 | |
Junio C Hamano | b8c5128 | 2007-03-19 10:43:30 | [diff] [blame] | 352 | core.deltaBaseCacheLimit:: |
| 353 | Maximum number of bytes to reserve for caching base objects |
| 354 | that multiple deltafied objects reference. By storing the |
| 355 | entire decompressed base objects in a cache Git is able |
| 356 | to avoid unpacking and decompressing frequently used base |
| 357 | objects multiple times. |
| 358 | + |
| 359 | Default is 16 MiB on all platforms. This should be reasonable |
| 360 | for all users/operating systems, except on the largest projects. |
| 361 | You probably do not need to adjust this value. |
| 362 | + |
| 363 | Common unit suffixes of 'k', 'm', or 'g' are supported. |
| 364 | |
Junio C Hamano | 1d90cb0 | 2007-07-03 07:05:31 | [diff] [blame] | 365 | core.excludesfile:: |
Junio C Hamano | 5e284b4 | 2007-05-22 07:23:37 | [diff] [blame] | 366 | In addition to '.gitignore' (per-directory) and |
| 367 | '.git/info/exclude', git looks into this file for patterns |
Junio C Hamano | 679d22d | 2007-06-02 21:13:44 | [diff] [blame] | 368 | of files which are not meant to be tracked. See |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 369 | linkgit:gitignore[5]. |
Junio C Hamano | 5e284b4 | 2007-05-22 07:23:37 | [diff] [blame] | 370 | |
Junio C Hamano | f6002a9 | 2007-07-20 10:28:22 | [diff] [blame] | 371 | core.editor:: |
| 372 | Commands such as `commit` and `tag` that lets you edit |
Junio C Hamano | a638742 | 2007-08-25 03:54:27 | [diff] [blame] | 373 | messages by launching an editor uses the value of this |
Junio C Hamano | f6002a9 | 2007-07-20 10:28:22 | [diff] [blame] | 374 | variable when it is set, and the environment variable |
| 375 | `GIT_EDITOR` is not set. The order of preference is |
Junio C Hamano | de9879a | 2007-07-22 09:33:42 | [diff] [blame] | 376 | `GIT_EDITOR` environment, `core.editor`, `VISUAL` and |
| 377 | `EDITOR` environment variables and then finally `vi`. |
Junio C Hamano | f6002a9 | 2007-07-20 10:28:22 | [diff] [blame] | 378 | |
Junio C Hamano | 28d8ede | 2007-07-05 05:51:38 | [diff] [blame] | 379 | core.pager:: |
Junio C Hamano | 0551f6a | 2008-08-25 00:33:33 | [diff] [blame] | 380 | The command that git will use to paginate output. Can |
| 381 | be overridden with the `GIT_PAGER` environment |
| 382 | variable. Note that git sets the `LESS` environment |
| 383 | variable to `FRSX` if it is unset when it runs the |
| 384 | pager. One can change these settings by setting the |
Junio C Hamano | a476efa | 2008-10-10 15:31:42 | [diff] [blame] | 385 | `LESS` variable to some other value. Alternately, |
| 386 | these settings can be overridden on a project or |
| 387 | global basis by setting the `core.pager` option. |
| 388 | Setting `core.pager` has no affect on the `LESS` |
| 389 | environment variable behaviour above, so if you want |
| 390 | to override git's default settings this way, you need |
| 391 | to be explicit. For example, to disable the S option |
| 392 | in a backward compatible manner, set `core.pager` |
Junio C Hamano | ea82cff | 2009-03-18 01:54:48 | [diff] [blame] | 393 | to `less -+$LESS -FRX`. This will be passed to the |
Junio C Hamano | a476efa | 2008-10-10 15:31:42 | [diff] [blame] | 394 | shell by git, which will translate the final command to |
Junio C Hamano | ea82cff | 2009-03-18 01:54:48 | [diff] [blame] | 395 | `LESS=FRSX less -+FRSX -FRX`. |
Junio C Hamano | 28d8ede | 2007-07-05 05:51:38 | [diff] [blame] | 396 | |
Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 397 | core.whitespace:: |
| 398 | A comma separated list of common whitespace problems to |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 399 | notice. 'git-diff' will use `color.diff.whitespace` to |
| 400 | highlight them, and 'git-apply --whitespace=error' will |
Junio C Hamano | 3db8b41 | 2008-07-26 06:45:59 | [diff] [blame] | 401 | consider them as errors. You can prefix `-` to disable |
| 402 | any of them (e.g. `-trailing-space`): |
Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 403 | + |
| 404 | * `trailing-space` treats trailing whitespaces at the end of the line |
| 405 | as an error (enabled by default). |
| 406 | * `space-before-tab` treats a space character that appears immediately |
| 407 | before a tab character in the initial indent part of the line as an |
| 408 | error (enabled by default). |
| 409 | * `indent-with-non-tab` treats a line that is indented with 8 or more |
Junio C Hamano | 42a2e2d | 2007-12-16 22:13:42 | [diff] [blame] | 410 | space characters as an error (not enabled by default). |
Junio C Hamano | 601f3e5 | 2008-02-25 08:40:42 | [diff] [blame] | 411 | * `cr-at-eol` treats a carriage-return at the end of line as |
| 412 | part of the line terminator, i.e. with it, `trailing-space` |
| 413 | does not trigger if the character before such a carriage-return |
| 414 | is not a whitespace (not enabled by default). |
Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 415 | |
Junio C Hamano | 9eb5753 | 2008-06-26 06:33:46 | [diff] [blame] | 416 | core.fsyncobjectfiles:: |
| 417 | This boolean will enable 'fsync()' when writing object files. |
| 418 | + |
| 419 | This is a total waste of time and effort on a filesystem that orders |
| 420 | data writes properly, but can be useful for filesystems that do not use |
| 421 | journalling (traditional UNIX filesystems) or that only journal metadata |
| 422 | and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). |
| 423 | |
Junio C Hamano | 610d176 | 2008-11-28 06:27:13 | [diff] [blame] | 424 | core.preloadindex:: |
| 425 | Enable parallel index preload for operations like 'git diff' |
| 426 | + |
| 427 | This can speed up operations like 'git diff' and 'git status' especially |
| 428 | on filesystems like NFS that have weak caching semantics and thus |
| 429 | relatively high IO latencies. With this set to 'true', git will do the |
| 430 | index comparison to the filesystem data in parallel, allowing |
| 431 | overlapping IO's. |
| 432 | |
Junio C Hamano | a9499de | 2009-04-30 03:38:48 | [diff] [blame] | 433 | core.createObject:: |
| 434 | You can set this to 'link', in which case a hardlink followed by |
| 435 | a delete of the source are used to make sure that object creation |
| 436 | will not overwrite existing objects. |
| 437 | + |
| 438 | On some file system/operating system combinations, this is unreliable. |
| 439 | Set this config setting to 'rename' there; However, This will remove the |
| 440 | check that makes sure that existing object files will not get overwritten. |
Junio C Hamano | e91ea77 | 2009-04-26 01:41:41 | [diff] [blame] | 441 | |
Junio C Hamano | 3d14151 | 2009-06-01 01:22:40 | [diff] [blame] | 442 | add.ignore-errors:: |
| 443 | Tells 'git-add' to continue adding files when some files cannot be |
| 444 | added due to indexing errors. Equivalent to the '--ignore-errors' |
| 445 | option of linkgit:git-add[1]. |
| 446 | |
Junio C Hamano | 33db437 | 2006-06-07 19:51:45 | [diff] [blame] | 447 | alias.*:: |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 448 | Command aliases for the linkgit:git[1] command wrapper - e.g. |
Junio C Hamano | 33db437 | 2006-06-07 19:51:45 | [diff] [blame] | 449 | after defining "alias.last = cat-file commit HEAD", the invocation |
| 450 | "git last" is equivalent to "git cat-file commit HEAD". To avoid |
Junio C Hamano | f1d1480 | 2006-06-08 00:48:17 | [diff] [blame] | 451 | confusion and troubles with script usage, aliases that |
| 452 | hide existing git commands are ignored. Arguments are split by |
| 453 | spaces, the usual shell quoting and escaping is supported. |
| 454 | quote pair and a backslash can be used to quote them. |
Junio C Hamano | dbb6459 | 2007-09-01 11:17:39 | [diff] [blame] | 455 | + |
| 456 | If the alias expansion is prefixed with an exclamation point, |
| 457 | it will be treated as a shell command. For example, defining |
| 458 | "alias.new = !gitk --all --not ORIG_HEAD", the invocation |
| 459 | "git new" is equivalent to running the shell command |
Junio C Hamano | 48bc1ce | 2009-07-09 16:49:19 | [diff] [blame] | 460 | "gitk --all --not ORIG_HEAD". Note that shell commands will be |
| 461 | executed from the top-level directory of a repository, which may |
| 462 | not necessarily be the current directory. |
Junio C Hamano | 9cb74f2 | 2007-02-12 04:15:05 | [diff] [blame] | 463 | |
Junio C Hamano | fe24db0 | 2009-08-22 05:10:47 | [diff] [blame^] | 464 | apply.ignorewhitespace:: |
| 465 | When set to 'change', tells 'git-apply' to ignore changes in |
| 466 | whitespace, in the same way as the '--ignore-space-change' |
| 467 | option. |
| 468 | When set to one of: no, none, never, false tells 'git-apply' to |
| 469 | respect all whitespace differences. |
| 470 | See linkgit:git-apply[1]. |
| 471 | |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 472 | apply.whitespace:: |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 473 | Tells 'git-apply' how to handle whitespaces, in the same way |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 474 | as the '--whitespace' option. See linkgit:git-apply[1]. |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 475 | |
Junio C Hamano | 7fd8417 | 2007-05-24 07:00:32 | [diff] [blame] | 476 | branch.autosetupmerge:: |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 477 | Tells 'git-branch' and 'git-checkout' to setup new branches |
Junio C Hamano | 24bc09a | 2008-02-28 00:27:44 | [diff] [blame] | 478 | so that linkgit:git-pull[1] will appropriately merge from the |
| 479 | starting point branch. Note that even if this option is not set, |
Junio C Hamano | 7fd8417 | 2007-05-24 07:00:32 | [diff] [blame] | 480 | this behavior can be chosen per-branch using the `--track` |
Junio C Hamano | 24bc09a | 2008-02-28 00:27:44 | [diff] [blame] | 481 | and `--no-track` options. The valid settings are: `false` -- no |
| 482 | automatic setup is done; `true` -- automatic setup is done when the |
| 483 | starting point is a remote branch; `always` -- automatic setup is |
| 484 | done when the starting point is either a local branch or remote |
| 485 | branch. This option defaults to true. |
Junio C Hamano | 7fd8417 | 2007-05-24 07:00:32 | [diff] [blame] | 486 | |
Junio C Hamano | 869bb80 | 2008-05-12 00:29:47 | [diff] [blame] | 487 | branch.autosetuprebase:: |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 488 | When a new branch is created with 'git-branch' or 'git-checkout' |
Junio C Hamano | 869bb80 | 2008-05-12 00:29:47 | [diff] [blame] | 489 | that tracks another branch, this variable tells git to set |
| 490 | up pull to rebase instead of merge (see "branch.<name>.rebase"). |
| 491 | When `never`, rebase is never automatically set to true. |
| 492 | When `local`, rebase is set to true for tracked branches of |
| 493 | other local branches. |
| 494 | When `remote`, rebase is set to true for tracked branches of |
| 495 | remote branches. |
| 496 | When `always`, rebase will be set to true for all tracking |
| 497 | branches. |
| 498 | See "branch.autosetupmerge" for details on how to set up a |
| 499 | branch to track another branch. |
| 500 | This option defaults to never. |
| 501 | |
Junio C Hamano | 47c1e3c | 2006-09-25 04:45:55 | [diff] [blame] | 502 | branch.<name>.remote:: |
Junio C Hamano | 0706c80 | 2009-03-30 22:34:19 | [diff] [blame] | 503 | When in branch <name>, it tells 'git-fetch' and 'git-push' which |
| 504 | remote to fetch from/push to. It defaults to `origin` if no remote is |
| 505 | configured. `origin` is also used if you are not on any branch. |
Junio C Hamano | 47c1e3c | 2006-09-25 04:45:55 | [diff] [blame] | 506 | |
| 507 | branch.<name>.merge:: |
Junio C Hamano | 0706c80 | 2009-03-30 22:34:19 | [diff] [blame] | 508 | Defines, together with branch.<name>.remote, the upstream branch |
| 509 | for the given branch. It tells 'git-fetch'/'git-pull' which |
Junio C Hamano | 5f9a6f0 | 2009-04-06 08:26:56 | [diff] [blame] | 510 | branch to merge and can also affect 'git-push' (see push.default). |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 511 | When in branch <name>, it tells 'git-fetch' the default |
Junio C Hamano | c2b4709 | 2007-10-25 06:50:31 | [diff] [blame] | 512 | refspec to be marked for merging in FETCH_HEAD. The value is |
| 513 | handled like the remote part of a refspec, and must match a |
| 514 | ref which is fetched from the remote given by |
| 515 | "branch.<name>.remote". |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 516 | The merge information is used by 'git-pull' (which at first calls |
| 517 | 'git-fetch') to lookup the default branch for merging. Without |
| 518 | this option, 'git-pull' defaults to merge the first refspec fetched. |
Junio C Hamano | 96010b2 | 2006-12-09 21:15:46 | [diff] [blame] | 519 | Specify multiple values to get an octopus merge. |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 520 | If you wish to setup 'git-pull' so that it merges into <name> from |
Junio C Hamano | 6e149c0 | 2007-03-16 10:21:07 | [diff] [blame] | 521 | another branch in the local repository, you can point |
| 522 | branch.<name>.merge to the desired branch, and use the special setting |
| 523 | `.` (a period) for branch.<name>.remote. |
Junio C Hamano | 47c1e3c | 2006-09-25 04:45:55 | [diff] [blame] | 524 | |
Junio C Hamano | 1b50ce9 | 2007-10-03 12:05:53 | [diff] [blame] | 525 | branch.<name>.mergeoptions:: |
| 526 | Sets default options for merging into branch <name>. The syntax and |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 527 | supported options are equal to that of linkgit:git-merge[1], but |
Junio C Hamano | 1b50ce9 | 2007-10-03 12:05:53 | [diff] [blame] | 528 | option values containing whitespace characters are currently not |
| 529 | supported. |
| 530 | |
Junio C Hamano | 0c99970 | 2007-12-03 09:57:55 | [diff] [blame] | 531 | branch.<name>.rebase:: |
| 532 | When true, rebase the branch <name> on top of the fetched branch, |
Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 533 | instead of merging the default branch from the default remote when |
| 534 | "git pull" is run. |
Junio C Hamano | 0c99970 | 2007-12-03 09:57:55 | [diff] [blame] | 535 | *NOTE*: this is a possibly dangerous operation; do *not* use |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 536 | it unless you understand the implications (see linkgit:git-rebase[1] |
Junio C Hamano | 0c99970 | 2007-12-03 09:57:55 | [diff] [blame] | 537 | for details). |
| 538 | |
Junio C Hamano | 8760ea6 | 2008-03-14 08:58:45 | [diff] [blame] | 539 | browser.<tool>.cmd:: |
| 540 | Specify the command to invoke the specified browser. The |
| 541 | specified command is evaluated in shell with the URLs passed |
| 542 | as arguments. (See linkgit:git-web--browse[1].) |
| 543 | |
Junio C Hamano | e35a6fc | 2008-01-29 09:46:27 | [diff] [blame] | 544 | browser.<tool>.path:: |
| 545 | Override the path for the given tool that may be used to |
| 546 | browse HTML help (see '-w' option in linkgit:git-help[1]) or a |
| 547 | working repository in gitweb (see linkgit:git-instaweb[1]). |
| 548 | |
Junio C Hamano | 47b9acd | 2007-04-24 07:34:34 | [diff] [blame] | 549 | clean.requireForce:: |
Junio C Hamano | 422cfec | 2007-11-08 08:07:45 | [diff] [blame] | 550 | A boolean to make git-clean do nothing unless given -f |
| 551 | or -n. Defaults to true. |
Junio C Hamano | 47b9acd | 2007-04-24 07:34:34 | [diff] [blame] | 552 | |
Junio C Hamano | eb69295 | 2007-01-03 22:02:12 | [diff] [blame] | 553 | color.branch:: |
| 554 | A boolean to enable/disable color in the output of |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 555 | linkgit:git-branch[1]. May be set to `always`, |
Junio C Hamano | 0fc8cd9 | 2007-12-06 03:26:21 | [diff] [blame] | 556 | `false` (or `never`) or `auto` (or `true`), in which case colors are used |
Junio C Hamano | eb69295 | 2007-01-03 22:02:12 | [diff] [blame] | 557 | only when the output is to a terminal. Defaults to false. |
| 558 | |
| 559 | color.branch.<slot>:: |
| 560 | Use customized color for branch coloration. `<slot>` is one of |
| 561 | `current` (the current branch), `local` (a local branch), |
| 562 | `remote` (a tracking branch in refs/remotes/), `plain` (other |
Junio C Hamano | 5a70233 | 2007-01-28 20:55:22 | [diff] [blame] | 563 | refs). |
| 564 | + |
| 565 | The value for these configuration variables is a list of colors (at most |
| 566 | two) and attributes (at most one), separated by spaces. The colors |
| 567 | accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, |
| 568 | `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, |
| 569 | `blink` and `reverse`. The first color given is the foreground; the |
| 570 | second is the background. The position of the attribute, if any, |
| 571 | doesn't matter. |
Junio C Hamano | eb69295 | 2007-01-03 22:02:12 | [diff] [blame] | 572 | |
Junio C Hamano | 3f403b0 | 2006-12-13 10:14:13 | [diff] [blame] | 573 | color.diff:: |
Junio C Hamano | 0fc8cd9 | 2007-12-06 03:26:21 | [diff] [blame] | 574 | When set to `always`, always use colors in patch. |
| 575 | When false (or `never`), never. When set to `true` or `auto`, use |
| 576 | colors only when the output is to the terminal. Defaults to false. |
Junio C Hamano | 9ae1a06 | 2006-07-10 08:12:34 | [diff] [blame] | 577 | |
Junio C Hamano | 3f403b0 | 2006-12-13 10:14:13 | [diff] [blame] | 578 | color.diff.<slot>:: |
Junio C Hamano | 5a70233 | 2007-01-28 20:55:22 | [diff] [blame] | 579 | Use customized color for diff colorization. `<slot>` specifies |
| 580 | which part of the patch to use the specified color, and is one |
| 581 | of `plain` (context text), `meta` (metainformation), `frag` |
| 582 | (hunk header), `old` (removed lines), `new` (added lines), |
Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 583 | `commit` (commit headers), or `whitespace` (highlighting |
| 584 | whitespace errors). The values of these variables may be specified as |
Junio C Hamano | 5a70233 | 2007-01-28 20:55:22 | [diff] [blame] | 585 | in color.branch.<slot>. |
Junio C Hamano | 9ae1a06 | 2006-07-10 08:12:34 | [diff] [blame] | 586 | |
Junio C Hamano | d257cff | 2009-03-18 05:27:16 | [diff] [blame] | 587 | color.grep:: |
| 588 | When set to `always`, always highlight matches. When `false` (or |
| 589 | `never`), never. When set to `true` or `auto`, use color only |
| 590 | when the output is written to the terminal. Defaults to `false`. |
| 591 | |
| 592 | color.grep.external:: |
| 593 | The string value of this variable is passed to an external 'grep' |
| 594 | command as a command line option if match highlighting is turned |
| 595 | on. If set to an empty string, no option is passed at all, |
| 596 | turning off coloring for external 'grep' calls; this is the default. |
| 597 | For GNU grep, set it to `--color=always` to highlight matches even |
| 598 | when a pager is used. |
| 599 | |
| 600 | color.grep.match:: |
| 601 | Use customized color for matches. The value of this variable |
| 602 | may be specified as in color.branch.<slot>. It is passed using |
| 603 | the environment variables 'GREP_COLOR' and 'GREP_COLORS' when |
| 604 | calling an external 'grep'. |
| 605 | |
Junio C Hamano | 00b8b63 | 2007-12-07 09:50:49 | [diff] [blame] | 606 | color.interactive:: |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 607 | When set to `always`, always use colors for interactive prompts |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 608 | and displays (such as those used by "git-add --interactive"). |
Junio C Hamano | 00b8b63 | 2007-12-07 09:50:49 | [diff] [blame] | 609 | When false (or `never`), never. When set to `true` or `auto`, use |
| 610 | colors only when the output is to the terminal. Defaults to false. |
| 611 | |
| 612 | color.interactive.<slot>:: |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 613 | Use customized color for 'git-add --interactive' |
Junio C Hamano | e5bf6c1 | 2009-02-07 21:43:10 | [diff] [blame] | 614 | output. `<slot>` may be `prompt`, `header`, `help` or `error`, for |
| 615 | four distinct types of normal output from interactive |
Junio C Hamano | 27a128b | 2009-08-13 01:23:00 | [diff] [blame] | 616 | commands. The values of these variables may be specified as |
Junio C Hamano | 00b8b63 | 2007-12-07 09:50:49 | [diff] [blame] | 617 | in color.branch.<slot>. |
| 618 | |
Junio C Hamano | e7935c4 | 2006-12-13 21:32:17 | [diff] [blame] | 619 | color.pager:: |
| 620 | A boolean to enable/disable colored output when the pager is in |
| 621 | use (default is true). |
| 622 | |
Junio C Hamano | 52ba295 | 2009-05-18 17:43:02 | [diff] [blame] | 623 | color.showbranch:: |
| 624 | A boolean to enable/disable color in the output of |
| 625 | linkgit:git-show-branch[1]. May be set to `always`, |
| 626 | `false` (or `never`) or `auto` (or `true`), in which case colors are used |
| 627 | only when the output is to a terminal. Defaults to false. |
| 628 | |
Junio C Hamano | e7935c4 | 2006-12-13 21:32:17 | [diff] [blame] | 629 | color.status:: |
| 630 | A boolean to enable/disable color in the output of |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 631 | linkgit:git-status[1]. May be set to `always`, |
Junio C Hamano | 0fc8cd9 | 2007-12-06 03:26:21 | [diff] [blame] | 632 | `false` (or `never`) or `auto` (or `true`), in which case colors are used |
Junio C Hamano | e7935c4 | 2006-12-13 21:32:17 | [diff] [blame] | 633 | only when the output is to a terminal. Defaults to false. |
| 634 | |
| 635 | color.status.<slot>:: |
| 636 | Use customized color for status colorization. `<slot>` is |
| 637 | one of `header` (the header text of the status message), |
Junio C Hamano | 7d23f5e | 2006-12-16 07:44:04 | [diff] [blame] | 638 | `added` or `updated` (files which are added but not committed), |
| 639 | `changed` (files which are changed but not added in the index), |
Junio C Hamano | b713ff1 | 2008-05-24 01:12:30 | [diff] [blame] | 640 | `untracked` (files which are not tracked by git), or |
| 641 | `nobranch` (the color the 'no branch' warning is shown in, defaulting |
| 642 | to red). The values of these variables may be specified as in |
| 643 | color.branch.<slot>. |
Junio C Hamano | e7935c4 | 2006-12-13 21:32:17 | [diff] [blame] | 644 | |
Junio C Hamano | 83d46a2 | 2008-02-21 02:29:42 | [diff] [blame] | 645 | color.ui:: |
| 646 | When set to `always`, always use colors in all git commands which |
| 647 | are capable of colored output. When false (or `never`), never. When |
| 648 | set to `true` or `auto`, use colors only when the output is to the |
| 649 | terminal. When more specific variables of color.* are set, they always |
| 650 | take precedence over this setting. Defaults to false. |
| 651 | |
Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 652 | commit.template:: |
| 653 | Specify a file to use as the template for new commit messages. |
| 654 | |
Junio C Hamano | dbb6459 | 2007-09-01 11:17:39 | [diff] [blame] | 655 | diff.autorefreshindex:: |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 656 | When using 'git-diff' to compare with work tree |
Junio C Hamano | dbb6459 | 2007-09-01 11:17:39 | [diff] [blame] | 657 | files, do not consider stat-only change as changed. |
| 658 | Instead, silently run `git update-index --refresh` to |
| 659 | update the cached stat information for paths whose |
| 660 | contents in the work tree match the contents in the |
| 661 | index. This option defaults to true. Note that this |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 662 | affects only 'git-diff' Porcelain, and not lower level |
| 663 | 'diff' commands, such as 'git-diff-files'. |
Junio C Hamano | dbb6459 | 2007-09-01 11:17:39 | [diff] [blame] | 664 | |
Junio C Hamano | 1fbbbc1 | 2007-12-18 07:01:27 | [diff] [blame] | 665 | diff.external:: |
| 666 | If this config variable is set, diff generation is not |
| 667 | performed using the internal diff machinery, but using the |
Junio C Hamano | 85c7157 | 2008-07-28 00:03:31 | [diff] [blame] | 668 | given command. Can be overridden with the `GIT_EXTERNAL_DIFF' |
| 669 | environment variable. The command is called with parameters |
| 670 | as described under "git Diffs" in linkgit:git[1]. Note: if |
| 671 | you want to use an external diff program only on a subset of |
| 672 | your files, you might want to use linkgit:gitattributes[5] instead. |
Junio C Hamano | 1fbbbc1 | 2007-12-18 07:01:27 | [diff] [blame] | 673 | |
Junio C Hamano | 5e4d8de | 2008-09-19 06:27:02 | [diff] [blame] | 674 | diff.mnemonicprefix:: |
| 675 | If set, 'git-diff' uses a prefix pair that is different from the |
| 676 | standard "a/" and "b/" depending on what is being compared. When |
| 677 | this configuration is in effect, reverse diff output also swaps |
| 678 | the order of the prefixes: |
| 679 | 'git-diff';; |
| 680 | compares the (i)ndex and the (w)ork tree; |
| 681 | 'git-diff HEAD';; |
| 682 | compares a (c)ommit and the (w)ork tree; |
| 683 | 'git diff --cached';; |
| 684 | compares a (c)ommit and the (i)ndex; |
| 685 | 'git-diff HEAD:file1 file2';; |
| 686 | compares an (o)bject and a (w)ork tree entity; |
| 687 | 'git diff --no-index a b';; |
| 688 | compares two non-git things (1) and (2). |
| 689 | |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 690 | diff.renameLimit:: |
| 691 | The number of files to consider when performing the copy/rename |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 692 | detection; equivalent to the 'git-diff' option '-l'. |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 693 | |
Junio C Hamano | 9ae1a06 | 2006-07-10 08:12:34 | [diff] [blame] | 694 | diff.renames:: |
| 695 | Tells git to detect renames. If set to any boolean value, it |
| 696 | will enable basic rename detection. If set to "copies" or |
| 697 | "copy", it will detect copies, as well. |
| 698 | |
Junio C Hamano | bc4852e | 2009-01-21 10:51:14 | [diff] [blame] | 699 | diff.suppressBlankEmpty:: |
Junio C Hamano | f123149 | 2008-12-22 08:27:21 | [diff] [blame] | 700 | A boolean to inhibit the standard behavior of printing a space |
| 701 | before each empty output line. Defaults to false. |
| 702 | |
Junio C Hamano | 3bd66e9 | 2009-04-18 06:17:56 | [diff] [blame] | 703 | diff.tool:: |
| 704 | Controls which diff tool is used. `diff.tool` overrides |
| 705 | `merge.tool` when used by linkgit:git-difftool[1] and has |
| 706 | the same valid values as `merge.tool` minus "tortoisemerge" |
| 707 | and plus "kompare". |
| 708 | |
| 709 | difftool.<tool>.path:: |
| 710 | Override the path for the given tool. This is useful in case |
| 711 | your tool is not in the PATH. |
| 712 | |
| 713 | difftool.<tool>.cmd:: |
| 714 | Specify the command to invoke the specified diff tool. |
| 715 | The specified command is evaluated in shell with the following |
| 716 | variables available: 'LOCAL' is set to the name of the temporary |
| 717 | file containing the contents of the diff pre-image and 'REMOTE' |
| 718 | is set to the name of the temporary file containing the contents |
| 719 | of the diff post-image. |
| 720 | |
| 721 | difftool.prompt:: |
| 722 | Prompt before each invocation of the diff tool. |
| 723 | |
Junio C Hamano | 20d47e3 | 2009-01-26 06:36:02 | [diff] [blame] | 724 | diff.wordRegex:: |
| 725 | A POSIX Extended Regular Expression used to determine what is a "word" |
| 726 | when performing word-by-word difference calculations. Character |
| 727 | sequences that match the regular expression are "words", all other |
| 728 | characters are *ignorable* whitespace. |
| 729 | |
Junio C Hamano | 54ea8d3 | 2007-01-25 07:59:48 | [diff] [blame] | 730 | fetch.unpackLimit:: |
| 731 | If the number of objects fetched over the git native |
| 732 | transfer is below this |
| 733 | limit, then the objects will be unpacked into loose object |
| 734 | files. However if the number of received objects equals or |
| 735 | exceeds this limit then the received pack will be stored as |
| 736 | a pack, after adding any missing delta bases. Storing the |
| 737 | pack from a push can make the push operation complete faster, |
Junio C Hamano | e77b015 | 2008-01-12 06:44:17 | [diff] [blame] | 738 | especially on slow filesystems. If not set, the value of |
| 739 | `transfer.unpackLimit` is used instead. |
Junio C Hamano | 54ea8d3 | 2007-01-25 07:59:48 | [diff] [blame] | 740 | |
Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 741 | format.attach:: |
| 742 | Enable multipart/mixed attachments as the default for |
| 743 | 'format-patch'. The value can also be a double quoted string |
| 744 | which will enable attachments as the default and set the |
| 745 | value as the boundary. See the --attach option in |
| 746 | linkgit:git-format-patch[1]. |
| 747 | |
Junio C Hamano | 8c5802d | 2007-11-15 00:13:36 | [diff] [blame] | 748 | format.numbered:: |
Junio C Hamano | 7d06a8a | 2008-10-20 05:42:33 | [diff] [blame] | 749 | A boolean which can enable or disable sequence numbers in patch |
| 750 | subjects. It defaults to "auto" which enables it only if there |
| 751 | is more than one patch. It can be enabled or disabled for all |
| 752 | messages by setting it to "true" or "false". See --numbered |
| 753 | option in linkgit:git-format-patch[1]. |
Junio C Hamano | 8c5802d | 2007-11-15 00:13:36 | [diff] [blame] | 754 | |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 755 | format.headers:: |
| 756 | Additional email headers to include in a patch to be submitted |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 757 | by mail. See linkgit:git-format-patch[1]. |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 758 | |
Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 759 | format.cc:: |
| 760 | Additional "Cc:" headers to include in a patch to be submitted |
| 761 | by mail. See the --cc option in linkgit:git-format-patch[1]. |
| 762 | |
| 763 | format.subjectprefix:: |
| 764 | The default for format-patch is to output files with the '[PATCH]' |
| 765 | subject prefix. Use this variable to change that prefix. |
| 766 | |
Junio C Hamano | d4c8e11 | 2007-03-04 10:32:38 | [diff] [blame] | 767 | format.suffix:: |
| 768 | The default for format-patch is to output files with the suffix |
| 769 | `.patch`. Use this variable to change that suffix (make sure to |
| 770 | include the dot if you want it). |
| 771 | |
Junio C Hamano | 86bcccc | 2008-03-08 09:33:55 | [diff] [blame] | 772 | format.pretty:: |
| 773 | The default pretty format for log/show/whatchanged command, |
| 774 | See linkgit:git-log[1], linkgit:git-show[1], |
| 775 | linkgit:git-whatchanged[1]. |
| 776 | |
Junio C Hamano | ea6a764 | 2009-03-11 23:56:19 | [diff] [blame] | 777 | format.thread:: |
| 778 | The default threading style for 'git-format-patch'. Can be |
Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 779 | either a boolean value, `shallow` or `deep`. `shallow` |
Junio C Hamano | ea6a764 | 2009-03-11 23:56:19 | [diff] [blame] | 780 | threading makes every mail a reply to the head of the series, |
| 781 | where the head is chosen from the cover letter, the |
| 782 | `\--in-reply-to`, and the first patch mail, in this order. |
Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 783 | `deep` threading makes every mail a reply to the previous one. |
Junio C Hamano | ea6a764 | 2009-03-11 23:56:19 | [diff] [blame] | 784 | A true boolean value is the same as `shallow`, and a false |
| 785 | value disables threading. |
| 786 | |
Junio C Hamano | 5f9a6f0 | 2009-04-06 08:26:56 | [diff] [blame] | 787 | format.signoff:: |
| 788 | A boolean value which lets you enable the `-s/--signoff` option of |
| 789 | format-patch by default. *Note:* Adding the Signed-off-by: line to a |
| 790 | patch should be a conscious act and means that you certify you have |
| 791 | the rights to submit this work under the same open source license. |
| 792 | Please see the 'SubmittingPatches' document for further discussion. |
| 793 | |
Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 794 | gc.aggressiveWindow:: |
| 795 | The window size parameter used in the delta compression |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 796 | algorithm used by 'git-gc --aggressive'. This defaults |
Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 797 | to 10. |
| 798 | |
Junio C Hamano | 1b50ce9 | 2007-10-03 12:05:53 | [diff] [blame] | 799 | gc.auto:: |
| 800 | When there are approximately more than this many loose |
| 801 | objects in the repository, `git gc --auto` will pack them. |
| 802 | Some Porcelain commands use this command to perform a |
Junio C Hamano | e77b015 | 2008-01-12 06:44:17 | [diff] [blame] | 803 | light-weight garbage collection from time to time. The |
| 804 | default value is 6700. Setting this to 0 disables it. |
Junio C Hamano | 1b50ce9 | 2007-10-03 12:05:53 | [diff] [blame] | 805 | |
| 806 | gc.autopacklimit:: |
| 807 | When there are more than this many packs that are not |
| 808 | marked with `*.keep` file in the repository, `git gc |
Junio C Hamano | e77b015 | 2008-01-12 06:44:17 | [diff] [blame] | 809 | --auto` consolidates them into one larger pack. The |
Junio C Hamano | 25c0b70 | 2008-03-23 09:41:37 | [diff] [blame] | 810 | default value is 50. Setting this to 0 disables it. |
Junio C Hamano | 1b50ce9 | 2007-10-03 12:05:53 | [diff] [blame] | 811 | |
Junio C Hamano | 9d52e57 | 2007-02-13 23:48:20 | [diff] [blame] | 812 | gc.packrefs:: |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 813 | 'git-gc' does not run `git pack-refs` in a bare repository by |
Junio C Hamano | 9d52e57 | 2007-02-13 23:48:20 | [diff] [blame] | 814 | default so that older dumb-transport clients can still fetch |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 815 | from the repository. Setting this to `true` lets 'git-gc' |
| 816 | to run `git pack-refs`. Setting this to `false` tells |
| 817 | 'git-gc' never to run `git pack-refs`. The default setting is |
Junio C Hamano | 9d52e57 | 2007-02-13 23:48:20 | [diff] [blame] | 818 | `notbare`. Enable it only when you know you do not have to |
| 819 | support such clients. The default setting will change to `true` |
| 820 | at some stage, and setting this to `false` will continue to |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 821 | prevent `git pack-refs` from being run from 'git-gc'. |
Junio C Hamano | 9d52e57 | 2007-02-13 23:48:20 | [diff] [blame] | 822 | |
Junio C Hamano | 09a926d | 2008-03-13 07:55:29 | [diff] [blame] | 823 | gc.pruneexpire:: |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 824 | When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'. |
Junio C Hamano | a3148f5 | 2009-01-14 08:49:57 | [diff] [blame] | 825 | Override the grace period with this config variable. The value |
| 826 | "now" may be used to disable this grace period and always prune |
| 827 | unreachable objects immediately. |
Junio C Hamano | 09a926d | 2008-03-13 07:55:29 | [diff] [blame] | 828 | |
Junio C Hamano | 7464064 | 2006-12-27 10:59:55 | [diff] [blame] | 829 | gc.reflogexpire:: |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 830 | 'git-reflog expire' removes reflog entries older than |
Junio C Hamano | 7464064 | 2006-12-27 10:59:55 | [diff] [blame] | 831 | this time; defaults to 90 days. |
| 832 | |
| 833 | gc.reflogexpireunreachable:: |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 834 | 'git-reflog expire' removes reflog entries older than |
Junio C Hamano | 7464064 | 2006-12-27 10:59:55 | [diff] [blame] | 835 | this time and are not reachable from the current tip; |
| 836 | defaults to 30 days. |
| 837 | |
| 838 | gc.rerereresolved:: |
| 839 | Records of conflicted merge you resolved earlier are |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 840 | kept for this many days when 'git-rerere gc' is run. |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 841 | The default is 60 days. See linkgit:git-rerere[1]. |
Junio C Hamano | 7464064 | 2006-12-27 10:59:55 | [diff] [blame] | 842 | |
| 843 | gc.rerereunresolved:: |
| 844 | Records of conflicted merge you have not resolved are |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 845 | kept for this many days when 'git-rerere gc' is run. |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 846 | The default is 15 days. See linkgit:git-rerere[1]. |
Junio C Hamano | 7464064 | 2006-12-27 10:59:55 | [diff] [blame] | 847 | |
Junio C Hamano | a3148f5 | 2009-01-14 08:49:57 | [diff] [blame] | 848 | gitcvs.commitmsgannotation:: |
| 849 | Append this string to each commit message. Set to empty string |
| 850 | to disable this feature. Defaults to "via git-CVS emulator". |
| 851 | |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 852 | gitcvs.enabled:: |
Junio C Hamano | a638742 | 2007-08-25 03:54:27 | [diff] [blame] | 853 | Whether the CVS server interface is enabled for this repository. |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 854 | See linkgit:git-cvsserver[1]. |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 855 | |
| 856 | gitcvs.logfile:: |
Junio C Hamano | a638742 | 2007-08-25 03:54:27 | [diff] [blame] | 857 | Path to a log file where the CVS server interface well... logs |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 858 | various stuff. See linkgit:git-cvsserver[1]. |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 859 | |
Junio C Hamano | 17bd227 | 2008-09-01 06:11:17 | [diff] [blame] | 860 | gitcvs.usecrlfattr:: |
Junio C Hamano | dfccbb0 | 2008-05-26 01:16:14 | [diff] [blame] | 861 | If true, the server will look up the `crlf` attribute for |
| 862 | files to determine the '-k' modes to use. If `crlf` is set, |
| 863 | the '-k' mode will be left blank, so cvs clients will |
| 864 | treat it as text. If `crlf` is explicitly unset, the file |
Junio C Hamano | cb1c44f | 2008-08-06 06:19:33 | [diff] [blame] | 865 | will be set with '-kb' mode, which suppresses any newline munging |
Junio C Hamano | dfccbb0 | 2008-05-26 01:16:14 | [diff] [blame] | 866 | the client might otherwise do. If `crlf` is not specified, |
Junio C Hamano | d32738e | 2008-07-09 19:53:42 | [diff] [blame] | 867 | then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5]. |
Junio C Hamano | dfccbb0 | 2008-05-26 01:16:14 | [diff] [blame] | 868 | |
Junio C Hamano | d9e0e5d | 2007-04-14 16:22:04 | [diff] [blame] | 869 | gitcvs.allbinary:: |
Junio C Hamano | dfccbb0 | 2008-05-26 01:16:14 | [diff] [blame] | 870 | This is used if 'gitcvs.usecrlfattr' does not resolve |
| 871 | the correct '-kb' mode to use. If true, all |
| 872 | unresolved files are sent to the client in |
| 873 | mode '-kb'. This causes the client to treat them |
| 874 | as binary files, which suppresses any newline munging it |
| 875 | otherwise might do. Alternatively, if it is set to "guess", |
| 876 | then the contents of the file are examined to decide if |
| 877 | it is binary, similar to 'core.autocrlf'. |
Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 878 | |
| 879 | gitcvs.dbname:: |
| 880 | Database used by git-cvsserver to cache revision information |
| 881 | derived from the git repository. The exact meaning depends on the |
| 882 | used database driver, for SQLite (which is the default driver) this |
| 883 | is a filename. Supports variable substitution (see |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 884 | linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`). |
Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 885 | Default: '%Ggitcvs.%m.sqlite' |
| 886 | |
| 887 | gitcvs.dbdriver:: |
| 888 | Used Perl DBI driver. You can specify any available driver |
| 889 | for this here, but it might not work. git-cvsserver is tested |
| 890 | with 'DBD::SQLite', reported to work with 'DBD::Pg', and |
| 891 | reported *not* to work with 'DBD::mysql'. Experimental feature. |
| 892 | May not contain double colons (`:`). Default: 'SQLite'. |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 893 | See linkgit:git-cvsserver[1]. |
Junio C Hamano | d9e0e5d | 2007-04-14 16:22:04 | [diff] [blame] | 894 | |
Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 895 | gitcvs.dbuser, gitcvs.dbpass:: |
| 896 | Database user and password. Only useful if setting 'gitcvs.dbdriver', |
| 897 | since SQLite has no concept of database users and/or passwords. |
| 898 | 'gitcvs.dbuser' supports variable substitution (see |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 899 | linkgit:git-cvsserver[1] for details). |
Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 900 | |
Junio C Hamano | a74efce | 2008-04-02 08:39:08 | [diff] [blame] | 901 | gitcvs.dbTableNamePrefix:: |
| 902 | Database table name prefix. Prepended to the names of any |
| 903 | database tables used, allowing a single database to be used |
| 904 | for several repositories. Supports variable substitution (see |
| 905 | linkgit:git-cvsserver[1] for details). Any non-alphabetic |
| 906 | characters will be replaced with underscores. |
| 907 | |
Junio C Hamano | dfccbb0 | 2008-05-26 01:16:14 | [diff] [blame] | 908 | All gitcvs variables except for 'gitcvs.usecrlfattr' and |
| 909 | 'gitcvs.allbinary' can also be specified as |
| 910 | 'gitcvs.<access_method>.<varname>' (where 'access_method' |
Junio C Hamano | a638742 | 2007-08-25 03:54:27 | [diff] [blame] | 911 | is one of "ext" and "pserver") to make them apply only for the given |
| 912 | access method. |
Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 913 | |
Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 914 | gui.commitmsgwidth:: |
| 915 | Defines how wide the commit message window is in the |
| 916 | linkgit:git-gui[1]. "75" is the default. |
| 917 | |
| 918 | gui.diffcontext:: |
| 919 | Specifies how many context lines should be used in calls to diff |
| 920 | made by the linkgit:git-gui[1]. The default is "5". |
| 921 | |
Junio C Hamano | d3452a0 | 2008-11-15 08:07:55 | [diff] [blame] | 922 | gui.encoding:: |
| 923 | Specifies the default encoding to use for displaying of |
| 924 | file contents in linkgit:git-gui[1] and linkgit:gitk[1]. |
| 925 | It can be overridden by setting the 'encoding' attribute |
| 926 | for relevant files (see linkgit:gitattributes[5]). |
| 927 | If this option is not set, the tools default to the |
| 928 | locale encoding. |
| 929 | |
Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 930 | gui.matchtrackingbranch:: |
| 931 | Determines if new branches created with linkgit:git-gui[1] should |
| 932 | default to tracking remote branches with matching names or |
| 933 | not. Default: "false". |
| 934 | |
| 935 | gui.newbranchtemplate:: |
| 936 | Is used as suggested name when creating new branches using the |
| 937 | linkgit:git-gui[1]. |
| 938 | |
| 939 | gui.pruneduringfetch:: |
| 940 | "true" if linkgit:git-gui[1] should prune tracking branches when |
| 941 | performing a fetch. The default value is "false". |
| 942 | |
| 943 | gui.trustmtime:: |
| 944 | Determines if linkgit:git-gui[1] should trust the file modification |
| 945 | timestamp or not. By default the timestamps are not trusted. |
| 946 | |
| 947 | gui.spellingdictionary:: |
| 948 | Specifies the dictionary used for spell checking commit messages in |
| 949 | the linkgit:git-gui[1]. When set to "none" spell checking is turned |
| 950 | off. |
| 951 | |
Junio C Hamano | d3452a0 | 2008-11-15 08:07:55 | [diff] [blame] | 952 | gui.fastcopyblame:: |
| 953 | If true, 'git gui blame' uses '-C' instead of '-C -C' for original |
| 954 | location detection. It makes blame significantly faster on huge |
| 955 | repositories at the expense of less thorough copy detection. |
| 956 | |
| 957 | gui.copyblamethreshold:: |
Junio C Hamano | 610d176 | 2008-11-28 06:27:13 | [diff] [blame] | 958 | Specifies the threshold to use in 'git gui blame' original location |
Junio C Hamano | d3452a0 | 2008-11-15 08:07:55 | [diff] [blame] | 959 | detection, measured in alphanumeric characters. See the |
| 960 | linkgit:git-blame[1] manual for more information on copy detection. |
| 961 | |
| 962 | gui.blamehistoryctx:: |
| 963 | Specifies the radius of history context in days to show in |
| 964 | linkgit:gitk[1] for the selected commit, when the `Show History |
| 965 | Context` menu item is invoked from 'git gui blame'. If this |
| 966 | variable is set to zero, the whole history is shown. |
| 967 | |
Junio C Hamano | 92d312a | 2008-12-15 07:22:20 | [diff] [blame] | 968 | guitool.<name>.cmd:: |
| 969 | Specifies the shell command line to execute when the corresponding item |
| 970 | of the linkgit:git-gui[1] `Tools` menu is invoked. This option is |
| 971 | mandatory for every tool. The command is executed from the root of |
| 972 | the working directory, and in the environment it receives the name of |
| 973 | the tool as 'GIT_GUITOOL', the name of the currently selected file as |
| 974 | 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if |
| 975 | the head is detached, 'CUR_BRANCH' is empty). |
| 976 | |
| 977 | guitool.<name>.needsfile:: |
| 978 | Run the tool only if a diff is selected in the GUI. It guarantees |
| 979 | that 'FILENAME' is not empty. |
| 980 | |
| 981 | guitool.<name>.noconsole:: |
| 982 | Run the command silently, without creating a window to display its |
| 983 | output. |
| 984 | |
| 985 | guitool.<name>.norescan:: |
| 986 | Don't rescan the working directory for changes after the tool |
| 987 | finishes execution. |
| 988 | |
| 989 | guitool.<name>.confirm:: |
| 990 | Show a confirmation dialog before actually running the tool. |
| 991 | |
| 992 | guitool.<name>.argprompt:: |
| 993 | Request a string argument from the user, and pass it to the tool |
| 994 | through the 'ARGS' environment variable. Since requesting an |
| 995 | argument implies confirmation, the 'confirm' option has no effect |
| 996 | if this is enabled. If the option is set to 'true', 'yes', or '1', |
| 997 | the dialog uses a built-in generic prompt; otherwise the exact |
| 998 | value of the variable is used. |
| 999 | |
| 1000 | guitool.<name>.revprompt:: |
| 1001 | Request a single valid revision from the user, and set the |
| 1002 | 'REVISION' environment variable. In other aspects this option |
| 1003 | is similar to 'argprompt', and can be used together with it. |
| 1004 | |
| 1005 | guitool.<name>.revunmerged:: |
| 1006 | Show only unmerged branches in the 'revprompt' subdialog. |
| 1007 | This is useful for tools similar to merge or rebase, but not |
| 1008 | for things like checkout or reset. |
| 1009 | |
| 1010 | guitool.<name>.title:: |
| 1011 | Specifies the title to use for the prompt dialog. The default |
| 1012 | is the tool name. |
| 1013 | |
| 1014 | guitool.<name>.prompt:: |
| 1015 | Specifies the general prompt string to display at the top of |
| 1016 | the dialog, before subsections for 'argprompt' and 'revprompt'. |
| 1017 | The default value includes the actual command. |
| 1018 | |
Junio C Hamano | 4e27231 | 2008-01-08 09:13:21 | [diff] [blame] | 1019 | help.browser:: |
| 1020 | Specify the browser that will be used to display help in the |
| 1021 | 'web' format. See linkgit:git-help[1]. |
| 1022 | |
| 1023 | help.format:: |
| 1024 | Override the default help format used by linkgit:git-help[1]. |
| 1025 | Values 'man', 'info', 'web' and 'html' are supported. 'man' is |
| 1026 | the default. 'web' and 'html' are the same. |
| 1027 | |
Junio C Hamano | f24b806 | 2008-09-09 01:34:39 | [diff] [blame] | 1028 | help.autocorrect:: |
| 1029 | Automatically correct and execute mistyped commands after |
| 1030 | waiting for the given number of deciseconds (0.1 sec). If more |
| 1031 | than one command can be deduced from the entered text, nothing |
| 1032 | will be executed. If the value of this option is negative, |
| 1033 | the corrected command will be executed immediately. If the |
| 1034 | value is 0 - the command will be just shown but not executed. |
| 1035 | This is the default. |
| 1036 | |
Junio C Hamano | 5825687 | 2007-12-04 08:31:13 | [diff] [blame] | 1037 | http.proxy:: |
| 1038 | Override the HTTP proxy, normally configured using the 'http_proxy' |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1039 | environment variable (see linkgit:curl[1]). This can be overridden |
Junio C Hamano | 5825687 | 2007-12-04 08:31:13 | [diff] [blame] | 1040 | on a per-remote basis; see remote.<name>.proxy |
| 1041 | |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1042 | http.sslVerify:: |
| 1043 | Whether to verify the SSL certificate when fetching or pushing |
Junio C Hamano | 33db437 | 2006-06-07 19:51:45 | [diff] [blame] | 1044 | over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1045 | variable. |
| 1046 | |
| 1047 | http.sslCert:: |
| 1048 | File containing the SSL certificate when fetching or pushing |
Junio C Hamano | 33db437 | 2006-06-07 19:51:45 | [diff] [blame] | 1049 | over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1050 | variable. |
| 1051 | |
| 1052 | http.sslKey:: |
| 1053 | File containing the SSL private key when fetching or pushing |
Junio C Hamano | 341071d | 2006-06-04 07:24:48 | [diff] [blame] | 1054 | over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1055 | variable. |
| 1056 | |
Junio C Hamano | 48bc1ce | 2009-07-09 16:49:19 | [diff] [blame] | 1057 | http.sslCertPasswordProtected:: |
| 1058 | Enable git's password prompt for the SSL certificate. Otherwise |
| 1059 | OpenSSL will prompt the user, possibly many times, if the |
| 1060 | certificate or private key is encrypted. Can be overridden by the |
| 1061 | 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable. |
| 1062 | |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1063 | http.sslCAInfo:: |
| 1064 | File containing the certificates to verify the peer with when |
Junio C Hamano | 341071d | 2006-06-04 07:24:48 | [diff] [blame] | 1065 | fetching or pushing over HTTPS. Can be overridden by the |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1066 | 'GIT_SSL_CAINFO' environment variable. |
| 1067 | |
| 1068 | http.sslCAPath:: |
| 1069 | Path containing files with the CA certificates to verify the peer |
Junio C Hamano | 33db437 | 2006-06-07 19:51:45 | [diff] [blame] | 1070 | with when fetching or pushing over HTTPS. Can be overridden |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1071 | by the 'GIT_SSL_CAPATH' environment variable. |
| 1072 | |
| 1073 | http.maxRequests:: |
Junio C Hamano | 341071d | 2006-06-04 07:24:48 | [diff] [blame] | 1074 | How many HTTP requests to launch in parallel. Can be overridden |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1075 | by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5. |
| 1076 | |
| 1077 | http.lowSpeedLimit, http.lowSpeedTime:: |
| 1078 | If the HTTP transfer speed is less than 'http.lowSpeedLimit' |
| 1079 | for longer than 'http.lowSpeedTime' seconds, the transfer is aborted. |
Junio C Hamano | 341071d | 2006-06-04 07:24:48 | [diff] [blame] | 1080 | Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1081 | 'GIT_HTTP_LOW_SPEED_TIME' environment variables. |
| 1082 | |
Junio C Hamano | f1dcdfe | 2006-09-29 08:10:51 | [diff] [blame] | 1083 | http.noEPSV:: |
| 1084 | A boolean which disables using of EPSV ftp command by curl. |
Junio C Hamano | d9e0e5d | 2007-04-14 16:22:04 | [diff] [blame] | 1085 | This can helpful with some "poor" ftp servers which don't |
Junio C Hamano | f1dcdfe | 2006-09-29 08:10:51 | [diff] [blame] | 1086 | support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV' |
| 1087 | environment variable. Default is false (curl will use EPSV). |
| 1088 | |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1089 | i18n.commitEncoding:: |
| 1090 | Character encoding the commit messages are stored in; git itself |
| 1091 | does not care per se, but this information is necessary e.g. when |
| 1092 | importing commits from emails or in the gitk graphical history |
| 1093 | browser (and possibly at other places in the future or in other |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1094 | porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'. |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1095 | |
Junio C Hamano | 51f92e2 | 2006-12-29 05:18:28 | [diff] [blame] | 1096 | i18n.logOutputEncoding:: |
| 1097 | Character encoding the commit messages are converted to when |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 1098 | running 'git-log' and friends. |
Junio C Hamano | 51f92e2 | 2006-12-29 05:18:28 | [diff] [blame] | 1099 | |
Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 1100 | imap:: |
| 1101 | The configuration variables in the 'imap' section are described |
| 1102 | in linkgit:git-imap-send[1]. |
| 1103 | |
Junio C Hamano | 4e27231 | 2008-01-08 09:13:21 | [diff] [blame] | 1104 | instaweb.browser:: |
| 1105 | Specify the program that will be used to browse your working |
| 1106 | repository in gitweb. See linkgit:git-instaweb[1]. |
| 1107 | |
| 1108 | instaweb.httpd:: |
| 1109 | The HTTP daemon command-line to start gitweb on your working |
| 1110 | repository. See linkgit:git-instaweb[1]. |
| 1111 | |
| 1112 | instaweb.local:: |
| 1113 | If true the web server started by linkgit:git-instaweb[1] will |
| 1114 | be bound to the local IP (127.0.0.1). |
| 1115 | |
| 1116 | instaweb.modulepath:: |
| 1117 | The module path for an apache httpd used by linkgit:git-instaweb[1]. |
| 1118 | |
| 1119 | instaweb.port:: |
| 1120 | The port number to bind the gitweb httpd to. See |
| 1121 | linkgit:git-instaweb[1]. |
| 1122 | |
Junio C Hamano | e5bf6c1 | 2009-02-07 21:43:10 | [diff] [blame] | 1123 | interactive.singlekey:: |
Junio C Hamano | 27a128b | 2009-08-13 01:23:00 | [diff] [blame] | 1124 | In interactive commands, allow the user to provide one-letter |
Junio C Hamano | e5bf6c1 | 2009-02-07 21:43:10 | [diff] [blame] | 1125 | input with a single key (i.e., without hitting enter). |
| 1126 | Currently this is used only by the `\--patch` mode of |
| 1127 | linkgit:git-add[1]. Note that this setting is silently |
| 1128 | ignored if portable keystroke input is not available. |
| 1129 | |
Junio C Hamano | b713ff1 | 2008-05-24 01:12:30 | [diff] [blame] | 1130 | log.date:: |
| 1131 | Set default date-time mode for the log command. Setting log.date |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 1132 | value is similar to using 'git-log'\'s --date option. The value is one of the |
Junio C Hamano | b713ff1 | 2008-05-24 01:12:30 | [diff] [blame] | 1133 | following alternatives: {relative,local,default,iso,rfc,short}. |
| 1134 | See linkgit:git-log[1]. |
| 1135 | |
Junio C Hamano | fe9acab | 2006-11-24 12:10:55 | [diff] [blame] | 1136 | log.showroot:: |
| 1137 | If true, the initial commit will be shown as a big creation event. |
| 1138 | This is equivalent to a diff against an empty tree. |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1139 | Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which |
Junio C Hamano | fe9acab | 2006-11-24 12:10:55 | [diff] [blame] | 1140 | normally hide the root commit will now show it. True by default. |
| 1141 | |
Junio C Hamano | 8bc410e | 2009-02-15 10:38:19 | [diff] [blame] | 1142 | mailmap.file:: |
| 1143 | The location of an augmenting mailmap file. The default |
| 1144 | mailmap, located in the root of the repository, is loaded |
| 1145 | first, then the mailmap file pointed to by this variable. |
| 1146 | The location of the mailmap file may be in a repository |
| 1147 | subdirectory, or somewhere outside of the repository itself. |
| 1148 | See linkgit:git-shortlog[1] and linkgit:git-blame[1]. |
| 1149 | |
Junio C Hamano | 8b588d5 | 2008-03-15 09:48:37 | [diff] [blame] | 1150 | man.viewer:: |
| 1151 | Specify the programs that may be used to display help in the |
| 1152 | 'man' format. See linkgit:git-help[1]. |
| 1153 | |
Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 1154 | man.<tool>.cmd:: |
| 1155 | Specify the command to invoke the specified man viewer. The |
| 1156 | specified command is evaluated in shell with the man page |
| 1157 | passed as argument. (See linkgit:git-help[1].) |
Junio C Hamano | 103ad7f | 2007-03-14 11:19:26 | [diff] [blame] | 1158 | |
Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 1159 | man.<tool>.path:: |
| 1160 | Override the path for the given tool that may be used to |
| 1161 | display help in the 'man' format. See linkgit:git-help[1]. |
Junio C Hamano | e90436a | 2007-04-22 07:22:13 | [diff] [blame] | 1162 | |
Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 1163 | include::merge-config.txt[] |
Junio C Hamano | a476efa | 2008-10-10 15:31:42 | [diff] [blame] | 1164 | |
Junio C Hamano | 1fbbbc1 | 2007-12-18 07:01:27 | [diff] [blame] | 1165 | mergetool.<tool>.path:: |
| 1166 | Override the path for the given tool. This is useful in case |
| 1167 | your tool is not in the PATH. |
| 1168 | |
Junio C Hamano | 86bcccc | 2008-03-08 09:33:55 | [diff] [blame] | 1169 | mergetool.<tool>.cmd:: |
| 1170 | Specify the command to invoke the specified merge tool. The |
| 1171 | specified command is evaluated in shell with the following |
| 1172 | variables available: 'BASE' is the name of a temporary file |
| 1173 | containing the common base of the files to be merged, if available; |
| 1174 | 'LOCAL' is the name of a temporary file containing the contents of |
| 1175 | the file on the current branch; 'REMOTE' is the name of a temporary |
| 1176 | file containing the contents of the file from the branch being |
| 1177 | merged; 'MERGED' contains the name of the file to which the merge |
| 1178 | tool should write the results of a successful merge. |
| 1179 | |
| 1180 | mergetool.<tool>.trustExitCode:: |
| 1181 | For a custom merge command, specify whether the exit code of |
| 1182 | the merge command can be used to determine whether the merge was |
| 1183 | successful. If this is not set to true then the merge target file |
| 1184 | timestamp is checked and the merge assumed to have been successful |
| 1185 | if the file has been updated, otherwise the user is prompted to |
| 1186 | indicate the success of the merge. |
| 1187 | |
| 1188 | mergetool.keepBackup:: |
| 1189 | After performing a merge, the original file with conflict markers |
| 1190 | can be saved as a file with a `.orig` extension. If this variable |
| 1191 | is set to `false` then this file is not preserved. Defaults to |
| 1192 | `true` (i.e. keep the backup files). |
| 1193 | |
Junio C Hamano | 10b7a34 | 2009-01-01 22:05:17 | [diff] [blame] | 1194 | mergetool.keepTemporaries:: |
| 1195 | When invoking a custom merge tool, git uses a set of temporary |
| 1196 | files to pass to the tool. If the tool returns an error and this |
| 1197 | variable is set to `true`, then these temporary files will be |
| 1198 | preserved, otherwise they will be removed after the tool has |
| 1199 | exited. Defaults to `false`. |
| 1200 | |
| 1201 | mergetool.prompt:: |
| 1202 | Prompt before each invocation of the merge resolution program. |
| 1203 | |
Junio C Hamano | 75cc4c9 | 2006-07-24 08:25:03 | [diff] [blame] | 1204 | pack.window:: |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1205 | The size of the window used by linkgit:git-pack-objects[1] when no |
Junio C Hamano | 75cc4c9 | 2006-07-24 08:25:03 | [diff] [blame] | 1206 | window size is given on the command line. Defaults to 10. |
| 1207 | |
Junio C Hamano | 91d44c5 | 2007-05-09 07:16:07 | [diff] [blame] | 1208 | pack.depth:: |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1209 | The maximum delta depth used by linkgit:git-pack-objects[1] when no |
Junio C Hamano | 91d44c5 | 2007-05-09 07:16:07 | [diff] [blame] | 1210 | maximum depth is given on the command line. Defaults to 50. |
| 1211 | |
Junio C Hamano | 235d53f | 2007-07-13 00:25:15 | [diff] [blame] | 1212 | pack.windowMemory:: |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1213 | The window memory size limit used by linkgit:git-pack-objects[1] |
Junio C Hamano | 235d53f | 2007-07-13 00:25:15 | [diff] [blame] | 1214 | when no limit is given on the command line. The value can be |
| 1215 | suffixed with "k", "m", or "g". Defaults to 0, meaning no |
| 1216 | limit. |
| 1217 | |
Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 1218 | pack.compression:: |
| 1219 | An integer -1..9, indicating the compression level for objects |
| 1220 | in a pack file. -1 is the zlib default. 0 means no |
| 1221 | compression, and 1..9 are various speed/size tradeoffs, 9 being |
| 1222 | slowest. If not set, defaults to core.compression. If that is |
Junio C Hamano | 2e72a94 | 2007-11-21 08:54:42 | [diff] [blame] | 1223 | not set, defaults to -1, the zlib default, which is "a default |
| 1224 | compromise between speed and compression (currently equivalent |
| 1225 | to level 6)." |
Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 1226 | |
Junio C Hamano | 679d22d | 2007-06-02 21:13:44 | [diff] [blame] | 1227 | pack.deltaCacheSize:: |
Junio C Hamano | a638742 | 2007-08-25 03:54:27 | [diff] [blame] | 1228 | The maximum memory in bytes used for caching deltas in |
Junio C Hamano | 9f88386 | 2009-08-11 06:23:52 | [diff] [blame] | 1229 | linkgit:git-pack-objects[1] before writing them out to a pack. |
| 1230 | This cache is used to speed up the writing object phase by not |
| 1231 | having to recompute the final delta result once the best match |
| 1232 | for all objects is found. Repacking large repositories on machines |
| 1233 | which are tight with memory might be badly impacted by this though, |
| 1234 | especially if this cache pushes the system into swapping. |
| 1235 | A value of 0 means no limit. The smallest size of 1 byte may be |
| 1236 | used to virtually disable this cache. Defaults to 256 MiB. |
Junio C Hamano | 679d22d | 2007-06-02 21:13:44 | [diff] [blame] | 1237 | |
| 1238 | pack.deltaCacheLimit:: |
Junio C Hamano | 58155b4 | 2007-09-15 07:46:14 | [diff] [blame] | 1239 | The maximum size of a delta, that is cached in |
Junio C Hamano | 9f88386 | 2009-08-11 06:23:52 | [diff] [blame] | 1240 | linkgit:git-pack-objects[1]. This cache is used to speed up the |
| 1241 | writing object phase by not having to recompute the final delta |
| 1242 | result once the best match for all objects is found. Defaults to 1000. |
Junio C Hamano | 679d22d | 2007-06-02 21:13:44 | [diff] [blame] | 1243 | |
Junio C Hamano | 58155b4 | 2007-09-15 07:46:14 | [diff] [blame] | 1244 | pack.threads:: |
| 1245 | Specifies the number of threads to spawn when searching for best |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1246 | delta matches. This requires that linkgit:git-pack-objects[1] |
Junio C Hamano | 58155b4 | 2007-09-15 07:46:14 | [diff] [blame] | 1247 | be compiled with pthreads otherwise this option is ignored with a |
| 1248 | warning. This is meant to reduce packing time on multiprocessor |
| 1249 | machines. The required amount of memory for the delta search window |
| 1250 | is however multiplied by the number of threads. |
Junio C Hamano | 24bc09a | 2008-02-28 00:27:44 | [diff] [blame] | 1251 | Specifying 0 will cause git to auto-detect the number of CPU's |
| 1252 | and set the number of threads accordingly. |
Junio C Hamano | 58155b4 | 2007-09-15 07:46:14 | [diff] [blame] | 1253 | |
Junio C Hamano | d814b6d | 2007-11-04 11:13:49 | [diff] [blame] | 1254 | pack.indexVersion:: |
| 1255 | Specify the default pack index version. Valid values are 1 for |
| 1256 | legacy pack index used by Git versions prior to 1.5.2, and 2 for |
| 1257 | the new pack index with capabilities for packs larger than 4 GB |
| 1258 | as well as proper protection against the repacking of corrupted |
Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame] | 1259 | packs. Version 2 is the default. Note that version 2 is enforced |
| 1260 | and this config option ignored whenever the corresponding pack is |
| 1261 | larger than 2 GB. |
| 1262 | + |
| 1263 | If you have an old git that does not understand the version 2 `{asterisk}.idx` file, |
| 1264 | cloning or fetching over a non native protocol (e.g. "http" and "rsync") |
| 1265 | that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the |
| 1266 | other side may give you a repository that cannot be accessed with your |
| 1267 | older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however, |
| 1268 | you can use linkgit:git-index-pack[1] on the *.pack file to regenerate |
| 1269 | the `{asterisk}.idx` file. |
Junio C Hamano | d814b6d | 2007-11-04 11:13:49 | [diff] [blame] | 1270 | |
Junio C Hamano | 09a926d | 2008-03-13 07:55:29 | [diff] [blame] | 1271 | pack.packSizeLimit:: |
Junio C Hamano | 49dccaf | 2008-02-10 10:48:01 | [diff] [blame] | 1272 | The default maximum size of a pack. This setting only affects |
| 1273 | packing to a file, i.e. the git:// protocol is unaffected. It |
| 1274 | can be overridden by the `\--max-pack-size` option of |
| 1275 | linkgit:git-repack[1]. |
| 1276 | |
Junio C Hamano | 9e96a1a | 2008-08-16 10:23:18 | [diff] [blame] | 1277 | pager.<cmd>:: |
Junio C Hamano | 0551f6a | 2008-08-25 00:33:33 | [diff] [blame] | 1278 | Allows turning on or off pagination of the output of a |
| 1279 | particular git subcommand when writing to a tty. If |
| 1280 | `\--paginate` or `\--no-pager` is specified on the command line, |
| 1281 | it takes precedence over this option. To disable pagination for |
Junio C Hamano | ea82cff | 2009-03-18 01:54:48 | [diff] [blame] | 1282 | all commands, set `core.pager` or `GIT_PAGER` to `cat`. |
Junio C Hamano | 9e96a1a | 2008-08-16 10:23:18 | [diff] [blame] | 1283 | |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1284 | pull.octopus:: |
| 1285 | The default merge strategy to use when pulling multiple branches |
| 1286 | at once. |
| 1287 | |
| 1288 | pull.twohead:: |
| 1289 | The default merge strategy to use when pulling a single branch. |
| 1290 | |
Junio C Hamano | 1de7572 | 2009-03-26 08:39:38 | [diff] [blame] | 1291 | push.default:: |
| 1292 | Defines the action git push should take if no refspec is given |
| 1293 | on the command line, no refspec is configured in the remote, and |
| 1294 | no refspec is implied by any of the options given on the command |
Junio C Hamano | 0706c80 | 2009-03-30 22:34:19 | [diff] [blame] | 1295 | line. Possible values are: |
Junio C Hamano | 1de7572 | 2009-03-26 08:39:38 | [diff] [blame] | 1296 | + |
| 1297 | * `nothing` do not push anything. |
Junio C Hamano | 0706c80 | 2009-03-30 22:34:19 | [diff] [blame] | 1298 | * `matching` push all matching branches. |
Junio C Hamano | 1de7572 | 2009-03-26 08:39:38 | [diff] [blame] | 1299 | All branches having the same name in both ends are considered to be |
Junio C Hamano | 0706c80 | 2009-03-30 22:34:19 | [diff] [blame] | 1300 | matching. This is the default. |
Junio C Hamano | 98e32c3 | 2009-04-13 02:39:53 | [diff] [blame] | 1301 | * `tracking` push the current branch to its upstream branch. |
Junio C Hamano | 0706c80 | 2009-03-30 22:34:19 | [diff] [blame] | 1302 | * `current` push the current branch to a branch of the same name. |
Junio C Hamano | 1de7572 | 2009-03-26 08:39:38 | [diff] [blame] | 1303 | |
Junio C Hamano | ea6a764 | 2009-03-11 23:56:19 | [diff] [blame] | 1304 | rebase.stat:: |
| 1305 | Whether to show a diffstat of what changed upstream since the last |
| 1306 | rebase. False by default. |
| 1307 | |
Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 1308 | receive.fsckObjects:: |
| 1309 | If it is set to true, git-receive-pack will check all received |
| 1310 | objects. It will abort in the case of a malformed object or a |
| 1311 | broken link. The result of an abort are only dangling objects. |
| 1312 | Defaults to false. |
| 1313 | |
| 1314 | receive.unpackLimit:: |
| 1315 | If the number of objects received in a push is below this |
| 1316 | limit then the objects will be unpacked into loose object |
| 1317 | files. However if the number of received objects equals or |
| 1318 | exceeds this limit then the received pack will be stored as |
| 1319 | a pack, after adding any missing delta bases. Storing the |
| 1320 | pack from a push can make the push operation complete faster, |
| 1321 | especially on slow filesystems. If not set, the value of |
| 1322 | `transfer.unpackLimit` is used instead. |
| 1323 | |
| 1324 | receive.denyDeletes:: |
| 1325 | If set to true, git-receive-pack will deny a ref update that deletes |
| 1326 | the ref. Use this to prevent such a ref deletion via a push. |
| 1327 | |
| 1328 | receive.denyCurrentBranch:: |
| 1329 | If set to true or "refuse", receive-pack will deny a ref update |
| 1330 | to the currently checked out branch of a non-bare repository. |
| 1331 | Such a push is potentially dangerous because it brings the HEAD |
| 1332 | out of sync with the index and working tree. If set to "warn", |
| 1333 | print a warning of such a push to stderr, but allow the push to |
| 1334 | proceed. If set to false or "ignore", allow such pushes with no |
| 1335 | message. Defaults to "warn". |
| 1336 | |
| 1337 | receive.denyNonFastForwards:: |
| 1338 | If set to true, git-receive-pack will deny a ref update which is |
| 1339 | not a fast forward. Use this to prevent such an update via a push, |
| 1340 | even if that push is forced. This configuration variable is |
| 1341 | set when initializing a shared repository. |
| 1342 | |
Junio C Hamano | 249572f | 2006-10-24 05:44:08 | [diff] [blame] | 1343 | remote.<name>.url:: |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1344 | The URL of a remote repository. See linkgit:git-fetch[1] or |
| 1345 | linkgit:git-push[1]. |
Junio C Hamano | 249572f | 2006-10-24 05:44:08 | [diff] [blame] | 1346 | |
Junio C Hamano | 0e88f3e | 2009-06-21 08:03:25 | [diff] [blame] | 1347 | remote.<name>.pushurl:: |
| 1348 | The push URL of a remote repository. See linkgit:git-push[1]. |
| 1349 | |
Junio C Hamano | 5825687 | 2007-12-04 08:31:13 | [diff] [blame] | 1350 | remote.<name>.proxy:: |
| 1351 | For remotes that require curl (http, https and ftp), the URL to |
| 1352 | the proxy to use for that remote. Set to the empty string to |
| 1353 | disable proxying for that remote. |
| 1354 | |
Junio C Hamano | 249572f | 2006-10-24 05:44:08 | [diff] [blame] | 1355 | remote.<name>.fetch:: |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1356 | The default set of "refspec" for linkgit:git-fetch[1]. See |
| 1357 | linkgit:git-fetch[1]. |
Junio C Hamano | 249572f | 2006-10-24 05:44:08 | [diff] [blame] | 1358 | |
| 1359 | remote.<name>.push:: |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1360 | The default set of "refspec" for linkgit:git-push[1]. See |
| 1361 | linkgit:git-push[1]. |
Junio C Hamano | 249572f | 2006-10-24 05:44:08 | [diff] [blame] | 1362 | |
Junio C Hamano | 47d68a5 | 2008-05-06 06:35:40 | [diff] [blame] | 1363 | remote.<name>.mirror:: |
| 1364 | If true, pushing to this remote will automatically behave |
| 1365 | as if the `\--mirror` option was given on the command line. |
| 1366 | |
Junio C Hamano | 118d277 | 2007-02-21 20:24:10 | [diff] [blame] | 1367 | remote.<name>.skipDefaultUpdate:: |
| 1368 | If true, this remote will be skipped by default when updating |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1369 | using the update subcommand of linkgit:git-remote[1]. |
Junio C Hamano | 118d277 | 2007-02-21 20:24:10 | [diff] [blame] | 1370 | |
Junio C Hamano | 4ad294b | 2007-01-20 02:22:50 | [diff] [blame] | 1371 | remote.<name>.receivepack:: |
Junio C Hamano | 54ea8d3 | 2007-01-25 07:59:48 | [diff] [blame] | 1372 | The default program to execute on the remote side when pushing. See |
Junio C Hamano | 86bcccc | 2008-03-08 09:33:55 | [diff] [blame] | 1373 | option \--receive-pack of linkgit:git-push[1]. |
Junio C Hamano | 4ad294b | 2007-01-20 02:22:50 | [diff] [blame] | 1374 | |
Junio C Hamano | 54ea8d3 | 2007-01-25 07:59:48 | [diff] [blame] | 1375 | remote.<name>.uploadpack:: |
| 1376 | The default program to execute on the remote side when fetching. See |
Junio C Hamano | 86bcccc | 2008-03-08 09:33:55 | [diff] [blame] | 1377 | option \--upload-pack of linkgit:git-fetch-pack[1]. |
Junio C Hamano | 54ea8d3 | 2007-01-25 07:59:48 | [diff] [blame] | 1378 | |
Junio C Hamano | 17dde0e | 2007-02-26 09:50:21 | [diff] [blame] | 1379 | remote.<name>.tagopt:: |
Junio C Hamano | 86bcccc | 2008-03-08 09:33:55 | [diff] [blame] | 1380 | Setting this value to \--no-tags disables automatic tag following when |
| 1381 | fetching from remote <name> |
Junio C Hamano | 17dde0e | 2007-02-26 09:50:21 | [diff] [blame] | 1382 | |
Junio C Hamano | 118d277 | 2007-02-21 20:24:10 | [diff] [blame] | 1383 | remotes.<group>:: |
| 1384 | The list of remotes which are fetched by "git remote update |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1385 | <group>". See linkgit:git-remote[1]. |
Junio C Hamano | 118d277 | 2007-02-21 20:24:10 | [diff] [blame] | 1386 | |
Junio C Hamano | 77b7e90 | 2006-10-23 07:18:50 | [diff] [blame] | 1387 | repack.usedeltabaseoffset:: |
Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame] | 1388 | By default, linkgit:git-repack[1] creates packs that use |
| 1389 | delta-base offset. If you need to share your repository with |
| 1390 | git older than version 1.4.4, either directly or via a dumb |
| 1391 | protocol such as http, then you need to set this option to |
| 1392 | "false" and repack. Access from old git versions over the |
| 1393 | native protocol are unaffected by this option. |
Junio C Hamano | 77b7e90 | 2006-10-23 07:18:50 | [diff] [blame] | 1394 | |
Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 1395 | rerere.autoupdate:: |
| 1396 | When set to true, `git-rerere` updates the index with the |
| 1397 | resulting contents after it cleanly resolves conflicts using |
| 1398 | previously recorded resolution. Defaults to false. |
| 1399 | |
| 1400 | rerere.enabled:: |
| 1401 | Activate recording of resolved conflicts, so that identical |
| 1402 | conflict hunks can be resolved automatically, should they |
| 1403 | be encountered again. linkgit:git-rerere[1] command is by |
| 1404 | default enabled if you create `rr-cache` directory under |
| 1405 | `$GIT_DIR`, but can be disabled by setting this option to false. |
| 1406 | |
Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 1407 | sendemail.identity:: |
| 1408 | A configuration identity. When given, causes values in the |
| 1409 | 'sendemail.<identity>' subsection to take precedence over |
| 1410 | values in the 'sendemail' section. The default identity is |
| 1411 | the value of 'sendemail.identity'. |
| 1412 | |
| 1413 | sendemail.smtpencryption:: |
| 1414 | See linkgit:git-send-email[1] for description. Note that this |
| 1415 | setting is not subject to the 'identity' mechanism. |
| 1416 | |
| 1417 | sendemail.smtpssl:: |
| 1418 | Deprecated alias for 'sendemail.smtpencryption = ssl'. |
| 1419 | |
| 1420 | sendemail.<identity>.*:: |
| 1421 | Identity-specific versions of the 'sendemail.*' parameters |
| 1422 | found below, taking precedence over those when the this |
| 1423 | identity is selected, through command-line or |
| 1424 | 'sendemail.identity'. |
| 1425 | |
| 1426 | sendemail.aliasesfile:: |
| 1427 | sendemail.aliasfiletype:: |
| 1428 | sendemail.bcc:: |
| 1429 | sendemail.cc:: |
| 1430 | sendemail.cccmd:: |
| 1431 | sendemail.chainreplyto:: |
| 1432 | sendemail.confirm:: |
| 1433 | sendemail.envelopesender:: |
| 1434 | sendemail.from:: |
| 1435 | sendemail.multiedit:: |
| 1436 | sendemail.signedoffbycc:: |
| 1437 | sendemail.smtppass:: |
| 1438 | sendemail.suppresscc:: |
| 1439 | sendemail.suppressfrom:: |
| 1440 | sendemail.to:: |
| 1441 | sendemail.smtpserver:: |
| 1442 | sendemail.smtpserverport:: |
| 1443 | sendemail.smtpuser:: |
| 1444 | sendemail.thread:: |
| 1445 | sendemail.validate:: |
| 1446 | See linkgit:git-send-email[1] for description. |
| 1447 | |
| 1448 | sendemail.signedoffcc:: |
| 1449 | Deprecated alias for 'sendemail.signedoffbycc'. |
| 1450 | |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1451 | showbranch.default:: |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1452 | The default set of branches for linkgit:git-show-branch[1]. |
| 1453 | See linkgit:git-show-branch[1]. |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1454 | |
Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 1455 | status.relativePaths:: |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1456 | By default, linkgit:git-status[1] shows paths relative to the |
Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 1457 | current directory. Setting this variable to `false` shows paths |
| 1458 | relative to the repository root (this was the default for git |
| 1459 | prior to v1.5.4). |
| 1460 | |
Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 1461 | status.showUntrackedFiles:: |
| 1462 | By default, linkgit:git-status[1] and linkgit:git-commit[1] show |
| 1463 | files which are not currently tracked by Git. Directories which |
| 1464 | contain only untracked files, are shown with the directory name |
| 1465 | only. Showing untracked files means that Git needs to lstat() all |
| 1466 | all the files in the whole repository, which might be slow on some |
| 1467 | systems. So, this variable controls how the commands displays |
| 1468 | the untracked files. Possible values are: |
| 1469 | + |
| 1470 | -- |
| 1471 | - 'no' - Show no untracked files |
| 1472 | - 'normal' - Shows untracked files and directories |
| 1473 | - 'all' - Shows also individual files in untracked directories. |
| 1474 | -- |
| 1475 | + |
| 1476 | If this variable is not specified, it defaults to 'normal'. |
| 1477 | This variable can be overridden with the -u|--untracked-files option |
| 1478 | of linkgit:git-status[1] and linkgit:git-commit[1]. |
| 1479 | |
Junio C Hamano | 75cc4c9 | 2006-07-24 08:25:03 | [diff] [blame] | 1480 | tar.umask:: |
Junio C Hamano | bdebabb | 2007-08-23 00:25:09 | [diff] [blame] | 1481 | This variable can be used to restrict the permission bits of |
| 1482 | tar archive entries. The default is 0002, which turns off the |
| 1483 | world write bit. The special value "user" indicates that the |
| 1484 | archiving user's umask will be used instead. See umask(2) and |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1485 | linkgit:git-archive[1]. |
Junio C Hamano | 75cc4c9 | 2006-07-24 08:25:03 | [diff] [blame] | 1486 | |
Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 1487 | transfer.unpackLimit:: |
| 1488 | When `fetch.unpackLimit` or `receive.unpackLimit` are |
| 1489 | not set, the value of this variable is used instead. |
| 1490 | The default value is 100. |
| 1491 | |
Junio C Hamano | 24bc09a | 2008-02-28 00:27:44 | [diff] [blame] | 1492 | url.<base>.insteadOf:: |
| 1493 | Any URL that starts with this value will be rewritten to |
| 1494 | start, instead, with <base>. In cases where some site serves a |
| 1495 | large number of repositories, and serves them with multiple |
| 1496 | access methods, and some users need to use different access |
| 1497 | methods, this feature allows people to specify any of the |
| 1498 | equivalent URLs and have git automatically rewrite the URL to |
| 1499 | the best alternative for the particular user, even for a |
| 1500 | never-before-seen repository on the site. When more than one |
| 1501 | insteadOf strings match a given URL, the longest match is used. |
| 1502 | |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1503 | user.email:: |
| 1504 | Your email address to be recorded in any newly created commits. |
Junio C Hamano | 469d60e | 2007-04-29 18:30:34 | [diff] [blame] | 1505 | Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1506 | 'EMAIL' environment variables. See linkgit:git-commit-tree[1]. |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1507 | |
| 1508 | user.name:: |
| 1509 | Your full name to be recorded in any newly created commits. |
Junio C Hamano | 341071d | 2006-06-04 07:24:48 | [diff] [blame] | 1510 | Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME' |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1511 | environment variables. See linkgit:git-commit-tree[1]. |
Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1512 | |
Junio C Hamano | a890c4f | 2007-01-28 10:29:21 | [diff] [blame] | 1513 | user.signingkey:: |
Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1514 | If linkgit:git-tag[1] is not selecting the key you want it to |
Junio C Hamano | a890c4f | 2007-01-28 10:29:21 | [diff] [blame] | 1515 | automatically when creating a signed tag, you can override the |
| 1516 | default selection with this variable. This option is passed |
| 1517 | unchanged to gpg's --local-user parameter, so you may specify a key |
| 1518 | using any method that gpg supports. |
| 1519 | |
Junio C Hamano | 4e27231 | 2008-01-08 09:13:21 | [diff] [blame] | 1520 | web.browser:: |
| 1521 | Specify a web browser that may be used by some commands. |
| 1522 | Currently only linkgit:git-instaweb[1] and linkgit:git-help[1] |
| 1523 | may use it. |