Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1 | CONFIGURATION FILE |
| 2 | ------------------ |
| 3 | |
| 4 | The git configuration file contains a number of variables that affect |
Stephen Boyd | 773002a | 2009-04-23 02:38:00 -0700 | [diff] [blame] | 5 | the git command's behavior. The `.git/config` file in each repository |
Stephen Boyd | 66e35fc | 2009-04-23 02:38:02 -0700 | [diff] [blame] | 6 | is used to store the configuration for that repository, and |
| 7 | `$HOME/.gitconfig` is used to store a per-user configuration as |
Stephen Boyd | 773002a | 2009-04-23 02:38:00 -0700 | [diff] [blame] | 8 | fallback values for the `.git/config` file. The file `/etc/gitconfig` |
Stephen Boyd | 66e35fc | 2009-04-23 02:38:02 -0700 | [diff] [blame] | 9 | can be used to store a system-wide default configuration. |
Junio C Hamano | 5ea5621 | 2007-01-16 22:45:35 -0800 | [diff] [blame] | 10 | |
Stephen Boyd | b7ee226 | 2009-04-23 02:38:01 -0700 | [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 |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [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 | |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [diff] [blame] | 18 | Syntax |
| 19 | ~~~~~~ |
| 20 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 21 | The syntax is fairly flexible and permissive; whitespaces are mostly |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [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 |
Chris Johnsen | dcb1126 | 2009-03-15 06:30:52 -0500 | [diff] [blame] | 28 | characters, `-` and `.` are allowed in section names. Each variable |
Stephen Boyd | 773002a | 2009-04-23 02:38:00 -0700 | [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. |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [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, |
Stephen Boyd | 773002a | 2009-04-23 02:38:00 -0700 | [diff] [blame] | 34 | in the section header, like in the example below: |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [diff] [blame] | 35 | |
| 36 | -------- |
| 37 | [section "subsection"] |
| 38 | |
| 39 | -------- |
| 40 | |
Stephen Boyd | b7ee226 | 2009-04-23 02:38:01 -0700 | [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 |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [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 | |
Stephen Boyd | 773002a | 2009-04-23 02:38:00 -0700 | [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. |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [diff] [blame] | 51 | |
Nanako Shiraishi | 2ceb639 | 2009-07-25 09:28:50 +0900 | [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 |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [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 |
Chris Johnsen | dcb1126 | 2009-03-15 06:30:52 -0500 | [diff] [blame] | 57 | characters and `-` are allowed. There can be more than one value |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [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, |
Michał Kiedrowicz | 0cbcf7a | 2009-04-17 22:34:25 +0200 | [diff] [blame] | 65 | 0/1, true/false or on/off. Case is not significant in boolean values, when |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [diff] [blame] | 66 | converting value to the canonical form using '--bool' type specifier; |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 67 | 'git config' will ensure that the output is "true" or "false". |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [diff] [blame] | 68 | |
| 69 | String values may be entirely or partially enclosed in double quotes. |
Stephen Boyd | 773002a | 2009-04-23 02:38:00 -0700 | [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 |
Chris Johnsen | dcb1126 | 2009-03-15 06:30:52 -0500 | [diff] [blame] | 74 | be escaped: use `\"` for `"` and `\\` for `\`. |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [diff] [blame] | 75 | |
Chris Johnsen | dcb1126 | 2009-03-15 06:30:52 -0500 | [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 |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [diff] [blame] | 79 | char sequences are valid. |
| 80 | |
Stephen Boyd | 773002a | 2009-04-23 02:38:00 -0700 | [diff] [blame] | 81 | Variable values ending in a `\` are continued on the next line in the |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [diff] [blame] | 82 | customary UNIX fashion. |
| 83 | |
Stephen Boyd | 773002a | 2009-04-23 02:38:00 -0700 | [diff] [blame] | 84 | Some variables may require a special value format. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [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] |
Anders Melchiorsen | 6bb9e51 | 2008-07-27 13:12:15 +0200 | [diff] [blame] | 96 | external = /usr/local/bin/diff-wrapper |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 97 | renames = true |
| 98 | |
Aneesh Kumar K.V | 910c00c | 2006-12-07 12:06:55 +0530 | [diff] [blame] | 99 | [branch "devel"] |
| 100 | remote = origin |
| 101 | merge = refs/heads/devel |
| 102 | |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [diff] [blame] | 103 | # Proxy settings |
| 104 | [core] |
David Symonds | 29093c2 | 2007-08-03 08:45:56 +1000 | [diff] [blame] | 105 | gitProxy="ssh" for "kernel.org" |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [diff] [blame] | 106 | gitProxy=default-proxy ; for the rest |
Aneesh Kumar K.V | 910c00c | 2006-12-07 12:06:55 +0530 | [diff] [blame] | 107 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 108 | Variables |
| 109 | ~~~~~~~~~ |
| 110 | |
| 111 | Note that this list is non-comprehensive and not necessarily complete. |
Francis Daly | b8936cf | 2006-06-08 00:15:05 +0100 | [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 |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 114 | porcelain configuration variables in the respective porcelain documentation. |
| 115 | |
Jeff King | 7519443 | 2009-09-09 07:38:58 -0400 | [diff] [blame] | 116 | advice.*:: |
| 117 | When set to 'true', display the given optional help message. |
| 118 | When set to 'false', do not display. The configuration variables |
| 119 | are: |
| 120 | + |
| 121 | -- |
| 122 | pushNonFastForward:: |
| 123 | Advice shown when linkgit:git-push[1] refuses |
| 124 | non-fast-forward refs. Default: true. |
Jeff King | edf563f | 2009-09-09 07:43:03 -0400 | [diff] [blame] | 125 | statusHints:: |
| 126 | Directions on how to stage/unstage/add shown in the |
| 127 | output of linkgit:git-status[1] and the template shown |
| 128 | when writing commit messages. Default: true. |
Matthieu Moy | 4c371f9 | 2009-11-22 23:26:17 +0100 | [diff] [blame] | 129 | commitBeforeMerge:: |
| 130 | Advice shown when linkgit:git-merge[1] refuses to |
| 131 | merge to avoid overwritting local changes. |
| 132 | Default: true. |
Matthieu Moy | d38a30d | 2010-01-12 10:54:44 +0100 | [diff] [blame] | 133 | resolveConflict:: |
| 134 | Advices shown by various commands when conflicts |
| 135 | prevent the operation from being performed. |
| 136 | Default: true. |
Jeff King | b706fcf | 2010-01-13 15:17:08 -0500 | [diff] [blame] | 137 | implicitIdentity:: |
| 138 | Advice on how to set your identity configuration when |
| 139 | your information is guessed from the system username and |
| 140 | domain name. Default: true. |
Junio C Hamano | 13be3e3 | 2010-01-29 22:03:24 -0800 | [diff] [blame] | 141 | |
| 142 | detachedHead:: |
| 143 | Advice shown when you used linkgit::git-checkout[1] to |
| 144 | move to the detach HEAD state, to instruct how to create |
| 145 | a local branch after the fact. Default: true. |
Jeff King | 7519443 | 2009-09-09 07:38:58 -0400 | [diff] [blame] | 146 | -- |
| 147 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 148 | core.fileMode:: |
| 149 | If false, the executable bit differences between the index and |
| 150 | the working copy are ignored; useful on broken filesystems like FAT. |
Matthew Ogilvie | 7b35724 | 2009-11-22 19:07:30 -0700 | [diff] [blame] | 151 | See linkgit:git-update-index[1]. |
| 152 | + |
| 153 | The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] |
| 154 | will probe and set core.fileMode false if appropriate when the |
| 155 | repository is created. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 156 | |
Dmitry Potapov | adbc0b6 | 2008-09-30 17:53:47 +0400 | [diff] [blame] | 157 | core.ignoreCygwinFSTricks:: |
| 158 | This option is only used by Cygwin implementation of Git. If false, |
| 159 | the Cygwin stat() and lstat() functions are used. This may be useful |
| 160 | if your repository consists of a few separate directories joined in |
| 161 | one hierarchy using Cygwin mount. If true, Git uses native Win32 API |
| 162 | whenever it is possible and falls back to Cygwin functions only to |
| 163 | handle symbol links. The native mode is more than twice faster than |
Mark Levedahl | 7faee6b | 2008-10-13 00:33:31 -0400 | [diff] [blame] | 164 | normal Cygwin l/stat() functions. True by default, unless core.filemode |
| 165 | is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's |
| 166 | POSIX emulation is required to support core.filemode. |
Dmitry Potapov | adbc0b6 | 2008-09-30 17:53:47 +0400 | [diff] [blame] | 167 | |
Matthew Ogilvie | 7b35724 | 2009-11-22 19:07:30 -0700 | [diff] [blame] | 168 | core.ignorecase:: |
| 169 | If true, this option enables various workarounds to enable |
| 170 | git to work better on filesystems that are not case sensitive, |
| 171 | like FAT. For example, if a directory listing finds |
| 172 | "makefile" when git expects "Makefile", git will assume |
| 173 | it is really the same file, and continue to remember it as |
| 174 | "Makefile". |
| 175 | + |
| 176 | The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] |
| 177 | will probe and set core.ignorecase true if appropriate when the repository |
| 178 | is created. |
| 179 | |
Alex Riesen | 1ce4790 | 2008-07-28 08:31:28 +0200 | [diff] [blame] | 180 | core.trustctime:: |
| 181 | If false, the ctime differences between the index and the |
| 182 | working copy are ignored; useful when the inode change time |
| 183 | is regularly modified by something outside Git (file system |
| 184 | crawlers and some backup systems). |
| 185 | See linkgit:git-update-index[1]. True by default. |
| 186 | |
Junio C Hamano | 9378c16 | 2007-06-24 15:11:24 -0700 | [diff] [blame] | 187 | core.quotepath:: |
Jonathan Nieder | 5833d73 | 2008-07-03 00:59:09 -0500 | [diff] [blame] | 188 | The commands that output paths (e.g. 'ls-files', |
| 189 | 'diff'), when not given the `-z` option, will quote |
Junio C Hamano | 9378c16 | 2007-06-24 15:11:24 -0700 | [diff] [blame] | 190 | "unusual" characters in the pathname by enclosing the |
| 191 | pathname in a double-quote pair and with backslashes the |
| 192 | same way strings in C source code are quoted. If this |
| 193 | variable is set to false, the bytes higher than 0x80 are |
| 194 | not quoted but output as verbatim. Note that double |
| 195 | quote, backslash and control characters are always |
| 196 | quoted without `-z` regardless of the setting of this |
| 197 | variable. |
| 198 | |
Eyvind Bernhardsen | 942e774 | 2010-06-04 21:29:08 +0200 | [diff] [blame] | 199 | core.eol:: |
| 200 | Sets the line ending type to use in the working directory for |
| 201 | files that have the `text` property set. Alternatives are |
| 202 | 'lf', 'crlf' and 'native', which uses the platform's native |
| 203 | line ending. The default value is `native`. See |
| 204 | linkgit:gitattributes[5] for more information on end-of-line |
| 205 | conversion. |
Frank Lichtenheld | 5cb71f8 | 2007-04-13 18:02:31 +0200 | [diff] [blame] | 206 | |
Steffen Prohaska | 21e5ad5 | 2008-02-06 12:25:58 +0100 | [diff] [blame] | 207 | core.safecrlf:: |
Eyvind Bernhardsen | fd6cce9 | 2010-05-19 22:43:10 +0200 | [diff] [blame] | 208 | If true, makes git check if converting `CRLF` is reversible when |
| 209 | end-of-line conversion is active. Git will verify if a command |
Steffen Prohaska | 21e5ad5 | 2008-02-06 12:25:58 +0100 | [diff] [blame] | 210 | modifies a file in the work tree either directly or indirectly. |
| 211 | For example, committing a file followed by checking out the |
| 212 | same file should yield the original file in the work tree. If |
| 213 | this is not the case for the current setting of |
| 214 | `core.autocrlf`, git will reject the file. The variable can |
| 215 | be set to "warn", in which case git will only warn about an |
| 216 | irreversible conversion but continue the operation. |
| 217 | + |
| 218 | CRLF conversion bears a slight chance of corrupting data. |
Eyvind Bernhardsen | 942e774 | 2010-06-04 21:29:08 +0200 | [diff] [blame] | 219 | When it is enabled, git will convert CRLF to LF during commit and LF to |
Steffen Prohaska | 21e5ad5 | 2008-02-06 12:25:58 +0100 | [diff] [blame] | 220 | CRLF during checkout. A file that contains a mixture of LF and |
| 221 | CRLF before the commit cannot be recreated by git. For text |
| 222 | files this is the right thing to do: it corrects line endings |
| 223 | such that we have only LF line endings in the repository. |
| 224 | But for binary files that are accidentally classified as text the |
| 225 | conversion can corrupt data. |
| 226 | + |
| 227 | If you recognize such corruption early you can easily fix it by |
| 228 | setting the conversion type explicitly in .gitattributes. Right |
| 229 | after committing you still have the original file in your work |
| 230 | tree and this file is not yet corrupted. You can explicitly tell |
| 231 | git that this file is binary and git will handle the file |
| 232 | appropriately. |
| 233 | + |
| 234 | Unfortunately, the desired effect of cleaning up text files with |
| 235 | mixed line endings and the undesired effect of corrupting binary |
| 236 | files cannot be distinguished. In both cases CRLFs are removed |
| 237 | in an irreversible way. For text files this is the right thing |
| 238 | to do because CRLFs are line endings, while for binary files |
| 239 | converting CRLFs corrupts data. |
| 240 | + |
| 241 | Note, this safety check does not mean that a checkout will generate a |
| 242 | file identical to the original file for a different setting of |
Eyvind Bernhardsen | 942e774 | 2010-06-04 21:29:08 +0200 | [diff] [blame] | 243 | `core.eol` and `core.autocrlf`, but only for the current one. For |
| 244 | example, a text file with `LF` would be accepted with `core.eol=lf` |
| 245 | and could later be checked out with `core.eol=crlf`, in which case the |
Steffen Prohaska | 21e5ad5 | 2008-02-06 12:25:58 +0100 | [diff] [blame] | 246 | resulting file would contain `CRLF`, although the original file |
| 247 | contained `LF`. However, in both work trees the line endings would be |
| 248 | consistent, that is either all `LF` or all `CRLF`, but never mixed. A |
| 249 | file with mixed line endings would be reported by the `core.safecrlf` |
| 250 | mechanism. |
| 251 | |
Eyvind Bernhardsen | 942e774 | 2010-06-04 21:29:08 +0200 | [diff] [blame] | 252 | core.autocrlf:: |
| 253 | Setting this variable to "true" is almost the same as setting |
| 254 | the `text` attribute to "auto" on all files except that text |
| 255 | files are not guaranteed to be normalized: files that contain |
| 256 | `CRLF` in the repository will not be touched. Use this |
| 257 | setting if you want to have `CRLF` line endings in your |
| 258 | working directory even though the repository does not have |
| 259 | normalized line endings. This variable can be set to 'input', |
| 260 | in which case no output conversion is performed. |
| 261 | |
Johannes Sixt | 78a8d64 | 2007-03-02 22:11:30 +0100 | [diff] [blame] | 262 | core.symlinks:: |
| 263 | If false, symbolic links are checked out as small plain files that |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 264 | contain the link text. linkgit:git-update-index[1] and |
| 265 | linkgit:git-add[1] will not change the recorded type to regular |
Johannes Sixt | 78a8d64 | 2007-03-02 22:11:30 +0100 | [diff] [blame] | 266 | file. Useful on filesystems like FAT that do not support |
Matthew Ogilvie | 7b35724 | 2009-11-22 19:07:30 -0700 | [diff] [blame] | 267 | symbolic links. |
| 268 | + |
| 269 | The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] |
| 270 | will probe and set core.symlinks false if appropriate when the repository |
| 271 | is created. |
Johannes Sixt | 78a8d64 | 2007-03-02 22:11:30 +0100 | [diff] [blame] | 272 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 273 | core.gitProxy:: |
| 274 | A "proxy command" to execute (as 'command host port') instead |
| 275 | of establishing direct connection to the remote server when |
| 276 | using the git protocol for fetching. If the variable value is |
| 277 | in the "COMMAND for DOMAIN" format, the command is applied only |
| 278 | on hostnames ending with the specified domain string. This variable |
| 279 | may be set multiple times and is matched in the given order; |
| 280 | the first match wins. |
Francis Daly | b8936cf | 2006-06-08 00:15:05 +0100 | [diff] [blame] | 281 | + |
| 282 | Can be overridden by the 'GIT_PROXY_COMMAND' environment variable |
| 283 | (which always applies universally, without the special "for" |
| 284 | handling). |
Emil Sit | 642d084 | 2009-03-17 13:31:42 -0400 | [diff] [blame] | 285 | + |
| 286 | The special string `none` can be used as the proxy command to |
| 287 | specify that no proxy be used for a given domain pattern. |
| 288 | This is useful for excluding servers inside a firewall from |
| 289 | proxy use, while defaulting to a common proxy for external domains. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 290 | |
| 291 | core.ignoreStat:: |
Marius Storm-Olsen | b7f685a | 2008-05-30 13:14:24 +0200 | [diff] [blame] | 292 | If true, commands which modify both the working tree and the index |
| 293 | will mark the updated paths with the "assume unchanged" bit in the |
| 294 | index. These marked files are then assumed to stay unchanged in the |
| 295 | working copy, until you mark them otherwise manually - Git will not |
| 296 | detect the file changes by lstat() calls. This is useful on systems |
| 297 | where those are very slow, such as Microsoft Windows. |
| 298 | See linkgit:git-update-index[1]. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 299 | False by default. |
| 300 | |
Junio C Hamano | 9f0bb90 | 2006-05-02 00:40:24 -0700 | [diff] [blame] | 301 | core.preferSymlinkRefs:: |
| 302 | Instead of the default "symref" format for HEAD |
| 303 | and other symbolic reference files, use symbolic links. |
| 304 | This is sometimes needed to work with old scripts that |
| 305 | expect HEAD to be a symbolic link. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 306 | |
Shawn O. Pearce | e4a15f4 | 2007-02-21 17:59:08 -0500 | [diff] [blame] | 307 | core.bare:: |
| 308 | If true this repository is assumed to be 'bare' and has no |
| 309 | working directory associated with it. If this is the case a |
| 310 | number of commands that require a working directory will be |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 311 | disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. |
Shawn O. Pearce | e4a15f4 | 2007-02-21 17:59:08 -0500 | [diff] [blame] | 312 | + |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 313 | This setting is automatically guessed by linkgit:git-clone[1] or |
| 314 | linkgit:git-init[1] when the repository was created. By default a |
Shawn O. Pearce | e4a15f4 | 2007-02-21 17:59:08 -0500 | [diff] [blame] | 315 | repository that ends in "/.git" is assumed to be not bare (bare = |
| 316 | false), while all other repositories are assumed to be bare (bare |
| 317 | = true). |
| 318 | |
Matthias Lederhofer | 892c41b | 2007-06-06 09:10:42 +0200 | [diff] [blame] | 319 | core.worktree:: |
Nguyễn Thái Ngọc Duy | f5e025a | 2009-12-29 14:48:41 +0700 | [diff] [blame] | 320 | Set the path to the root of the work tree. |
Ralf Wildenhues | 06ada15 | 2007-10-09 23:00:03 +0200 | [diff] [blame] | 321 | This can be overridden by the GIT_WORK_TREE environment |
Liu Yubao | 302cc11 | 2008-04-29 04:09:20 +0800 | [diff] [blame] | 322 | variable and the '--work-tree' command line option. It can be |
Nguyễn Thái Ngọc Duy | f5e025a | 2009-12-29 14:48:41 +0700 | [diff] [blame] | 323 | an absolute path or a relative path to the .git directory, |
| 324 | either specified by --git-dir or GIT_DIR, or automatically |
| 325 | discovered. |
| 326 | If --git-dir or GIT_DIR are specified but none of |
Liu Yubao | 302cc11 | 2008-04-29 04:09:20 +0800 | [diff] [blame] | 327 | --work-tree, GIT_WORK_TREE and core.worktree is specified, |
Nguyễn Thái Ngọc Duy | f5e025a | 2009-12-29 14:48:41 +0700 | [diff] [blame] | 328 | the current working directory is regarded as the root of the |
| 329 | work tree. |
| 330 | + |
| 331 | Note that this variable is honored even when set in a configuration |
| 332 | file in a ".git" subdirectory of a directory, and its value differs |
| 333 | from the latter directory (e.g. "/path/to/.git/config" has |
| 334 | core.worktree set to "/different/path"), which is most likely a |
| 335 | misconfiguration. Running git commands in "/path/to" directory will |
| 336 | still use "/different/path" as the root of the work tree and can cause |
| 337 | great confusion to the users. |
Matthias Lederhofer | 892c41b | 2007-06-06 09:10:42 +0200 | [diff] [blame] | 338 | |
Shawn Pearce | 6de08ae | 2006-05-17 05:55:40 -0400 | [diff] [blame] | 339 | core.logAllRefUpdates:: |
Lukas Sandström | 14cd560 | 2007-08-19 23:38:57 +0200 | [diff] [blame] | 340 | Enable the reflog. Updates to a ref <ref> is logged to the file |
Junio C Hamano | 4057deb | 2006-10-08 01:35:18 -0700 | [diff] [blame] | 341 | "$GIT_DIR/logs/<ref>", by appending the new and old |
| 342 | SHA1, the date/time and the reason of the update, but |
| 343 | only when the file exists. If this configuration |
| 344 | variable is set to true, missing "$GIT_DIR/logs/<ref>" |
| 345 | file is automatically created for branch heads. |
Junio C Hamano | a862f97 | 2006-12-30 22:39:24 -0800 | [diff] [blame] | 346 | + |
| 347 | This information can be used to determine what commit |
| 348 | was the tip of a branch "2 days ago". |
| 349 | + |
| 350 | This value is true by default in a repository that has |
| 351 | a working directory associated with it, and false by |
| 352 | default in a bare repository. |
Shawn Pearce | 6de08ae | 2006-05-17 05:55:40 -0400 | [diff] [blame] | 353 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 354 | core.repositoryFormatVersion:: |
| 355 | Internal variable identifying the repository format and layout |
| 356 | version. |
| 357 | |
| 358 | core.sharedRepository:: |
Jonas Fonseca | d5dc6a7 | 2006-08-09 02:26:23 +0200 | [diff] [blame] | 359 | When 'group' (or 'true'), the repository is made shareable between |
| 360 | several users in a group (making sure all the files and objects are |
| 361 | group-writable). When 'all' (or 'world' or 'everybody'), the |
| 362 | repository will be readable by all users, additionally to being |
| 363 | group-shareable. When 'umask' (or 'false'), git will use permissions |
Heikki Orsila | 06cbe85 | 2008-04-16 11:34:24 +0300 | [diff] [blame] | 364 | reported by umask(2). When '0xxx', where '0xxx' is an octal number, |
| 365 | files in the repository will have this mode value. '0xxx' will override |
Johan Herland | 098082f | 2009-04-14 15:15:42 +0200 | [diff] [blame] | 366 | user's umask value (whereas the other options will only override |
| 367 | requested parts of the user's umask value). Examples: '0660' will make |
| 368 | the repo read/write-able for the owner and group, but inaccessible to |
| 369 | others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a |
Heikki Orsila | 06cbe85 | 2008-04-16 11:34:24 +0300 | [diff] [blame] | 370 | repository that is group-readable but not group-writable. |
| 371 | See linkgit:git-init[1]. False by default. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 372 | |
| 373 | core.warnAmbiguousRefs:: |
| 374 | If true, git will warn you if the ref name you passed it is ambiguous |
| 375 | and might match multiple refs in the .git/refs/ tree. True by default. |
| 376 | |
Joachim Berdal Haga | 3d3e95a | 2006-07-06 22:35:54 +0200 | [diff] [blame] | 377 | core.compression:: |
Dana How | 960ccca | 2007-05-09 13:56:50 -0700 | [diff] [blame] | 378 | An integer -1..9, indicating a default compression level. |
| 379 | -1 is the zlib default. 0 means no compression, |
| 380 | and 1..9 are various speed/size tradeoffs, 9 being slowest. |
Brian Downing | dec9230 | 2007-11-19 10:58:51 -0600 | [diff] [blame] | 381 | If set, this provides a default to other compression variables, |
| 382 | such as 'core.loosecompression' and 'pack.compression'. |
Dana How | 960ccca | 2007-05-09 13:56:50 -0700 | [diff] [blame] | 383 | |
| 384 | core.loosecompression:: |
Joachim B Haga | 12f6c30 | 2006-07-03 22:11:47 +0200 | [diff] [blame] | 385 | An integer -1..9, indicating the compression level for objects that |
Dana How | 960ccca | 2007-05-09 13:56:50 -0700 | [diff] [blame] | 386 | are not in a pack file. -1 is the zlib default. 0 means no |
Joachim B Haga | 12f6c30 | 2006-07-03 22:11:47 +0200 | [diff] [blame] | 387 | compression, and 1..9 are various speed/size tradeoffs, 9 being |
Dana How | 960ccca | 2007-05-09 13:56:50 -0700 | [diff] [blame] | 388 | slowest. If not set, defaults to core.compression. If that is |
Brian Downing | de1b246 | 2007-11-19 10:58:50 -0600 | [diff] [blame] | 389 | not set, defaults to 1 (best speed). |
Joachim B Haga | 12f6c30 | 2006-07-03 22:11:47 +0200 | [diff] [blame] | 390 | |
Shawn O. Pearce | 60bb8b1 | 2006-12-23 02:34:28 -0500 | [diff] [blame] | 391 | core.packedGitWindowSize:: |
| 392 | Number of bytes of a pack file to map into memory in a |
| 393 | single mapping operation. Larger window sizes may allow |
| 394 | your system to process a smaller number of large pack files |
| 395 | more quickly. Smaller window sizes will negatively affect |
Shawn O. Pearce | eb92242 | 2006-12-30 22:13:43 -0500 | [diff] [blame] | 396 | performance due to increased calls to the operating system's |
Shawn O. Pearce | 60bb8b1 | 2006-12-23 02:34:28 -0500 | [diff] [blame] | 397 | memory manager, but may improve performance when accessing |
Shawn O. Pearce | 22bac0e | 2007-01-04 22:28:08 -0500 | [diff] [blame] | 398 | a large number of large pack files. |
| 399 | + |
| 400 | Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 |
| 401 | MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should |
| 402 | be reasonable for all users/operating systems. You probably do |
| 403 | not need to adjust this value. |
Shawn O. Pearce | eb92242 | 2006-12-30 22:13:43 -0500 | [diff] [blame] | 404 | + |
| 405 | Common unit suffixes of 'k', 'm', or 'g' are supported. |
Shawn O. Pearce | 60bb8b1 | 2006-12-23 02:34:28 -0500 | [diff] [blame] | 406 | |
Shawn O. Pearce | 77ccc5b | 2006-12-23 02:33:35 -0500 | [diff] [blame] | 407 | core.packedGitLimit:: |
| 408 | Maximum number of bytes to map simultaneously into memory |
| 409 | from pack files. If Git needs to access more than this many |
| 410 | bytes at once to complete an operation it will unmap existing |
| 411 | regions to reclaim virtual address space within the process. |
Shawn O. Pearce | 22bac0e | 2007-01-04 22:28:08 -0500 | [diff] [blame] | 412 | + |
| 413 | Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. |
| 414 | This should be reasonable for all users/operating systems, except on |
| 415 | the largest projects. You probably do not need to adjust this value. |
Shawn O. Pearce | eb92242 | 2006-12-30 22:13:43 -0500 | [diff] [blame] | 416 | + |
| 417 | Common unit suffixes of 'k', 'm', or 'g' are supported. |
Shawn O. Pearce | 77ccc5b | 2006-12-23 02:33:35 -0500 | [diff] [blame] | 418 | |
Shawn O. Pearce | 18bdec1 | 2007-03-19 01:14:37 -0400 | [diff] [blame] | 419 | core.deltaBaseCacheLimit:: |
| 420 | Maximum number of bytes to reserve for caching base objects |
| 421 | that multiple deltafied objects reference. By storing the |
| 422 | entire decompressed base objects in a cache Git is able |
| 423 | to avoid unpacking and decompressing frequently used base |
| 424 | objects multiple times. |
| 425 | + |
| 426 | Default is 16 MiB on all platforms. This should be reasonable |
| 427 | for all users/operating systems, except on the largest projects. |
| 428 | You probably do not need to adjust this value. |
| 429 | + |
| 430 | Common unit suffixes of 'k', 'm', or 'g' are supported. |
| 431 | |
Shawn O. Pearce | 5eef828 | 2010-02-01 09:27:35 -0800 | [diff] [blame] | 432 | core.bigFileThreshold:: |
| 433 | Files larger than this size are stored deflated, without |
| 434 | attempting delta compression. Storing large files without |
| 435 | delta compression avoids excessive memory usage, at the |
| 436 | slight expense of increased disk usage. |
| 437 | + |
| 438 | Default is 512 MiB on all platforms. This should be reasonable |
| 439 | for most projects as source code and other text files can still |
| 440 | be delta compressed, but larger binary media files won't be. |
| 441 | + |
| 442 | Common unit suffixes of 'k', 'm', or 'g' are supported. |
| 443 | + |
| 444 | Currently only linkgit:git-fast-import[1] honors this setting. |
| 445 | |
Michael Hendricks | e8964a5 | 2007-07-02 10:48:34 -0600 | [diff] [blame] | 446 | core.excludesfile:: |
Johannes Schindelin | 0ba956d | 2007-05-22 01:12:17 +0100 | [diff] [blame] | 447 | In addition to '.gitignore' (per-directory) and |
| 448 | '.git/info/exclude', git looks into this file for patterns |
Junio C Hamano | 0f7fb21 | 2009-11-21 00:37:26 -0800 | [diff] [blame] | 449 | of files which are not meant to be tracked. "{tilde}/" is expanded |
| 450 | to the value of `$HOME` and "{tilde}user/" to the specified user's |
Matthieu Moy | df2a79f | 2009-11-19 16:21:15 +0100 | [diff] [blame] | 451 | home directory. See linkgit:gitignore[5]. |
Johannes Schindelin | 0ba956d | 2007-05-22 01:12:17 +0100 | [diff] [blame] | 452 | |
Adam Roben | ef0c2ab | 2007-07-19 22:09:35 -0700 | [diff] [blame] | 453 | core.editor:: |
| 454 | Commands such as `commit` and `tag` that lets you edit |
Brian Hetro | 0278307 | 2007-08-23 20:44:13 -0400 | [diff] [blame] | 455 | messages by launching an editor uses the value of this |
Adam Roben | ef0c2ab | 2007-07-19 22:09:35 -0700 | [diff] [blame] | 456 | variable when it is set, and the environment variable |
Jonathan Nieder | b4479f0 | 2009-10-30 20:42:34 -0500 | [diff] [blame] | 457 | `GIT_EDITOR` is not set. See linkgit:git-var[1]. |
Adam Roben | ef0c2ab | 2007-07-19 22:09:35 -0700 | [diff] [blame] | 458 | |
Brian Gernhardt | 54adf37 | 2007-07-03 14:18:11 -0400 | [diff] [blame] | 459 | core.pager:: |
Jonathan Nieder | ab54cd6 | 2008-08-24 00:28:32 -0500 | [diff] [blame] | 460 | The command that git will use to paginate output. Can |
| 461 | be overridden with the `GIT_PAGER` environment |
| 462 | variable. Note that git sets the `LESS` environment |
| 463 | variable to `FRSX` if it is unset when it runs the |
| 464 | pager. One can change these settings by setting the |
Chris Frey | fee7545 | 2008-09-24 19:21:28 -0400 | [diff] [blame] | 465 | `LESS` variable to some other value. Alternately, |
| 466 | these settings can be overridden on a project or |
| 467 | global basis by setting the `core.pager` option. |
| 468 | Setting `core.pager` has no affect on the `LESS` |
| 469 | environment variable behaviour above, so if you want |
| 470 | to override git's default settings this way, you need |
| 471 | to be explicit. For example, to disable the S option |
| 472 | in a backward compatible manner, set `core.pager` |
Chris Johnsen | dcb1126 | 2009-03-15 06:30:52 -0500 | [diff] [blame] | 473 | to `less -+$LESS -FRX`. This will be passed to the |
Chris Frey | fee7545 | 2008-09-24 19:21:28 -0400 | [diff] [blame] | 474 | shell by git, which will translate the final command to |
Chris Johnsen | dcb1126 | 2009-03-15 06:30:52 -0500 | [diff] [blame] | 475 | `LESS=FRSX less -+FRSX -FRX`. |
Brian Gernhardt | 54adf37 | 2007-07-03 14:18:11 -0400 | [diff] [blame] | 476 | |
Junio C Hamano | 91af7ae | 2007-11-24 11:57:41 -0800 | [diff] [blame] | 477 | core.whitespace:: |
| 478 | A comma separated list of common whitespace problems to |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 479 | notice. 'git diff' will use `color.diff.whitespace` to |
| 480 | highlight them, and 'git apply --whitespace=error' will |
Junio C Hamano | c921cc9 | 2008-07-25 00:34:47 -0700 | [diff] [blame] | 481 | consider them as errors. You can prefix `-` to disable |
| 482 | any of them (e.g. `-trailing-space`): |
Junio C Hamano | 91af7ae | 2007-11-24 11:57:41 -0800 | [diff] [blame] | 483 | + |
Junio C Hamano | aeb84b0 | 2009-09-05 22:21:17 -0700 | [diff] [blame] | 484 | * `blank-at-eol` treats trailing whitespaces at the end of the line |
Junio C Hamano | 91af7ae | 2007-11-24 11:57:41 -0800 | [diff] [blame] | 485 | as an error (enabled by default). |
| 486 | * `space-before-tab` treats a space character that appears immediately |
| 487 | before a tab character in the initial indent part of the line as an |
| 488 | error (enabled by default). |
| 489 | * `indent-with-non-tab` treats a line that is indented with 8 or more |
J. Bruce Fields | 127f72e | 2007-12-16 11:31:42 -0500 | [diff] [blame] | 490 | space characters as an error (not enabled by default). |
Chris Webb | 3e3ec2a | 2010-04-03 00:37:08 +0100 | [diff] [blame] | 491 | * `tab-in-indent` treats a tab character in the initial indent part of |
| 492 | the line as an error (not enabled by default). |
Junio C Hamano | 77b15bb | 2009-09-03 16:02:32 -0700 | [diff] [blame] | 493 | * `blank-at-eof` treats blank lines added at the end of file as an error |
| 494 | (enabled by default). |
Junio C Hamano | aeb84b0 | 2009-09-05 22:21:17 -0700 | [diff] [blame] | 495 | * `trailing-space` is a short-hand to cover both `blank-at-eol` and |
| 496 | `blank-at-eof`. |
Junio C Hamano | b2979ff | 2008-01-15 00:59:05 -0800 | [diff] [blame] | 497 | * `cr-at-eol` treats a carriage-return at the end of line as |
| 498 | part of the line terminator, i.e. with it, `trailing-space` |
| 499 | does not trigger if the character before such a carriage-return |
| 500 | is not a whitespace (not enabled by default). |
Junio C Hamano | 91af7ae | 2007-11-24 11:57:41 -0800 | [diff] [blame] | 501 | |
Linus Torvalds | aafe9fb | 2008-06-18 15:18:44 -0700 | [diff] [blame] | 502 | core.fsyncobjectfiles:: |
| 503 | This boolean will enable 'fsync()' when writing object files. |
| 504 | + |
| 505 | This is a total waste of time and effort on a filesystem that orders |
| 506 | data writes properly, but can be useful for filesystems that do not use |
| 507 | journalling (traditional UNIX filesystems) or that only journal metadata |
| 508 | and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). |
| 509 | |
Linus Torvalds | 671c9b7 | 2008-11-13 16:36:30 -0800 | [diff] [blame] | 510 | core.preloadindex:: |
| 511 | Enable parallel index preload for operations like 'git diff' |
| 512 | + |
| 513 | This can speed up operations like 'git diff' and 'git status' especially |
| 514 | on filesystems like NFS that have weak caching semantics and thus |
| 515 | relatively high IO latencies. With this set to 'true', git will do the |
| 516 | index comparison to the filesystem data in parallel, allowing |
| 517 | overlapping IO's. |
| 518 | |
Johannes Schindelin | 348df16 | 2009-04-28 00:32:25 +0200 | [diff] [blame] | 519 | core.createObject:: |
| 520 | You can set this to 'link', in which case a hardlink followed by |
| 521 | a delete of the source are used to make sure that object creation |
| 522 | will not overwrite existing objects. |
| 523 | + |
| 524 | On some file system/operating system combinations, this is unreliable. |
| 525 | Set this config setting to 'rename' there; However, This will remove the |
| 526 | check that makes sure that existing object files will not get overwritten. |
Johannes Schindelin | be66a6c | 2009-04-25 11:57:14 +0200 | [diff] [blame] | 527 | |
Johannes Schindelin | a97a746 | 2009-10-09 12:21:57 +0200 | [diff] [blame] | 528 | core.notesRef:: |
| 529 | When showing commit messages, also show notes which are stored in |
Jonathan Nieder | 9eb3f81 | 2010-05-08 22:19:35 -0500 | [diff] [blame] | 530 | the given ref. The ref must be fully qualified. If the given |
| 531 | ref does not exist, it is not an error but means that no |
| 532 | notes should be printed. |
Johannes Schindelin | a97a746 | 2009-10-09 12:21:57 +0200 | [diff] [blame] | 533 | + |
Jonathan Nieder | 9eb3f81 | 2010-05-08 22:19:35 -0500 | [diff] [blame] | 534 | This setting defaults to "refs/notes/commits", and it can be overridden by |
| 535 | the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. |
Johannes Schindelin | a97a746 | 2009-10-09 12:21:57 +0200 | [diff] [blame] | 536 | |
Nguyễn Thái Ngọc Duy | 08aefc9 | 2009-08-20 20:47:08 +0700 | [diff] [blame] | 537 | core.sparseCheckout:: |
| 538 | Enable "sparse checkout" feature. See section "Sparse checkout" in |
| 539 | linkgit:git-read-tree[1] for more information. |
| 540 | |
Stephen Boyd | 13bd213 | 2009-05-30 22:08:02 -0700 | [diff] [blame] | 541 | add.ignore-errors:: |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 542 | Tells 'git add' to continue adding files when some files cannot be |
Stephen Boyd | 13bd213 | 2009-05-30 22:08:02 -0700 | [diff] [blame] | 543 | added due to indexing errors. Equivalent to the '--ignore-errors' |
| 544 | option of linkgit:git-add[1]. |
| 545 | |
Petr Baudis | 4514ad4 | 2006-06-07 20:43:50 +0200 | [diff] [blame] | 546 | alias.*:: |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 547 | Command aliases for the linkgit:git[1] command wrapper - e.g. |
Petr Baudis | 4514ad4 | 2006-06-07 20:43:50 +0200 | [diff] [blame] | 548 | after defining "alias.last = cat-file commit HEAD", the invocation |
| 549 | "git last" is equivalent to "git cat-file commit HEAD". To avoid |
Petr Baudis | 99b41c8 | 2006-06-07 17:25:21 -0700 | [diff] [blame] | 550 | confusion and troubles with script usage, aliases that |
| 551 | hide existing git commands are ignored. Arguments are split by |
| 552 | spaces, the usual shell quoting and escaping is supported. |
| 553 | quote pair and a backslash can be used to quote them. |
Junio C Hamano | f368f5a | 2007-09-01 04:01:54 -0700 | [diff] [blame] | 554 | + |
| 555 | If the alias expansion is prefixed with an exclamation point, |
| 556 | it will be treated as a shell command. For example, defining |
| 557 | "alias.new = !gitk --all --not ORIG_HEAD", the invocation |
| 558 | "git new" is equivalent to running the shell command |
Sitaram Chamarty | 595b8db | 2009-07-01 21:30:31 +0530 | [diff] [blame] | 559 | "gitk --all --not ORIG_HEAD". Note that shell commands will be |
| 560 | executed from the top-level directory of a repository, which may |
| 561 | not necessarily be the current directory. |
Theodore Ts'o | dfd42a3 | 2007-02-10 19:33:58 -0500 | [diff] [blame] | 562 | |
Stefan-W. Hahn | e80d4cb | 2010-02-27 15:20:27 +0100 | [diff] [blame] | 563 | am.keepcr:: |
| 564 | If true, git-am will call git-mailsplit for patches in mbox format |
| 565 | with parameter '--keep-cr'. In this case git-mailsplit will |
| 566 | not remove `\r` from lines ending with `\r\n`. Can be overrriden |
| 567 | by giving '--no-keep-cr' from the command line. |
| 568 | See linkgit:git-am[1], linkgit:git-mailsplit[1]. |
| 569 | |
Giuseppe Bilotta | 86c91f9 | 2009-08-04 13:16:49 +0200 | [diff] [blame] | 570 | apply.ignorewhitespace:: |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 571 | When set to 'change', tells 'git apply' to ignore changes in |
Giuseppe Bilotta | 86c91f9 | 2009-08-04 13:16:49 +0200 | [diff] [blame] | 572 | whitespace, in the same way as the '--ignore-space-change' |
| 573 | option. |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 574 | When set to one of: no, none, never, false tells 'git apply' to |
Giuseppe Bilotta | 86c91f9 | 2009-08-04 13:16:49 +0200 | [diff] [blame] | 575 | respect all whitespace differences. |
| 576 | See linkgit:git-apply[1]. |
| 577 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 578 | apply.whitespace:: |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 579 | Tells 'git apply' how to handle whitespaces, in the same way |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 580 | as the '--whitespace' option. See linkgit:git-apply[1]. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 581 | |
Paolo Bonzini | 9902387 | 2007-05-23 07:07:54 +0200 | [diff] [blame] | 582 | branch.autosetupmerge:: |
Junio C Hamano | add0951 | 2010-01-20 20:28:49 -0800 | [diff] [blame] | 583 | Tells 'git branch' and 'git checkout' to set up new branches |
Jay Soffian | 572fc81 | 2008-02-19 11:24:38 -0500 | [diff] [blame] | 584 | so that linkgit:git-pull[1] will appropriately merge from the |
| 585 | starting point branch. Note that even if this option is not set, |
Paolo Bonzini | 9902387 | 2007-05-23 07:07:54 +0200 | [diff] [blame] | 586 | this behavior can be chosen per-branch using the `--track` |
Jay Soffian | 572fc81 | 2008-02-19 11:24:38 -0500 | [diff] [blame] | 587 | and `--no-track` options. The valid settings are: `false` -- no |
| 588 | automatic setup is done; `true` -- automatic setup is done when the |
| 589 | starting point is a remote branch; `always` -- automatic setup is |
| 590 | done when the starting point is either a local branch or remote |
| 591 | branch. This option defaults to true. |
Paolo Bonzini | 9902387 | 2007-05-23 07:07:54 +0200 | [diff] [blame] | 592 | |
Dustin Sallings | c998ae9 | 2008-05-10 15:36:29 -0700 | [diff] [blame] | 593 | branch.autosetuprebase:: |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 594 | When a new branch is created with 'git branch' or 'git checkout' |
Dustin Sallings | c998ae9 | 2008-05-10 15:36:29 -0700 | [diff] [blame] | 595 | that tracks another branch, this variable tells git to set |
| 596 | up pull to rebase instead of merge (see "branch.<name>.rebase"). |
| 597 | When `never`, rebase is never automatically set to true. |
| 598 | When `local`, rebase is set to true for tracked branches of |
| 599 | other local branches. |
| 600 | When `remote`, rebase is set to true for tracked branches of |
| 601 | remote branches. |
| 602 | When `always`, rebase will be set to true for all tracking |
| 603 | branches. |
| 604 | See "branch.autosetupmerge" for details on how to set up a |
| 605 | branch to track another branch. |
| 606 | This option defaults to never. |
| 607 | |
Santi Béjar | 648ad18 | 2006-09-23 12:05:43 +0200 | [diff] [blame] | 608 | branch.<name>.remote:: |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 609 | When in branch <name>, it tells 'git fetch' and 'git push' which |
Santi Béjar | 76d3cc5 | 2009-03-30 12:11:40 +0200 | [diff] [blame] | 610 | remote to fetch from/push to. It defaults to `origin` if no remote is |
| 611 | configured. `origin` is also used if you are not on any branch. |
Santi Béjar | 648ad18 | 2006-09-23 12:05:43 +0200 | [diff] [blame] | 612 | |
Santi Béjar | 5372806 | 2006-09-23 22:53:04 +0200 | [diff] [blame] | 613 | branch.<name>.merge:: |
Santi Béjar | 76d3cc5 | 2009-03-30 12:11:40 +0200 | [diff] [blame] | 614 | Defines, together with branch.<name>.remote, the upstream branch |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 615 | for the given branch. It tells 'git fetch'/'git pull' which |
| 616 | branch to merge and can also affect 'git push' (see push.default). |
| 617 | When in branch <name>, it tells 'git fetch' the default |
Daniel Barkalow | b888d61 | 2007-09-10 23:03:25 -0400 | [diff] [blame] | 618 | refspec to be marked for merging in FETCH_HEAD. The value is |
| 619 | handled like the remote part of a refspec, and must match a |
| 620 | ref which is fetched from the remote given by |
| 621 | "branch.<name>.remote". |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 622 | The merge information is used by 'git pull' (which at first calls |
| 623 | 'git fetch') to lookup the default branch for merging. Without |
| 624 | this option, 'git pull' defaults to merge the first refspec fetched. |
Josef Weidendorfer | 62b339a | 2006-12-09 02:28:26 +0100 | [diff] [blame] | 625 | Specify multiple values to get an octopus merge. |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 626 | If you wish to setup 'git pull' so that it merges into <name> from |
Paolo Bonzini | 9debc32 | 2007-03-15 09:23:20 +0100 | [diff] [blame] | 627 | another branch in the local repository, you can point |
| 628 | branch.<name>.merge to the desired branch, and use the special setting |
| 629 | `.` (a period) for branch.<name>.remote. |
Santi Béjar | 5372806 | 2006-09-23 22:53:04 +0200 | [diff] [blame] | 630 | |
Lars Hjemli | aec7b36 | 2007-09-24 00:51:43 +0200 | [diff] [blame] | 631 | branch.<name>.mergeoptions:: |
| 632 | Sets default options for merging into branch <name>. The syntax and |
Jonathan Nieder | 25dcc0d | 2009-10-09 13:51:14 -0500 | [diff] [blame] | 633 | supported options are the same as those of linkgit:git-merge[1], but |
Lars Hjemli | aec7b36 | 2007-09-24 00:51:43 +0200 | [diff] [blame] | 634 | option values containing whitespace characters are currently not |
| 635 | supported. |
| 636 | |
Johannes Schindelin | cd67e4d | 2007-11-28 13:11:07 +0000 | [diff] [blame] | 637 | branch.<name>.rebase:: |
| 638 | When true, rebase the branch <name> on top of the fetched branch, |
Dustin Sallings | 15ddb6f | 2008-05-08 11:28:07 -0700 | [diff] [blame] | 639 | instead of merging the default branch from the default remote when |
| 640 | "git pull" is run. |
Johannes Schindelin | cd67e4d | 2007-11-28 13:11:07 +0000 | [diff] [blame] | 641 | *NOTE*: this is a possibly dangerous operation; do *not* use |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 642 | it unless you understand the implications (see linkgit:git-rebase[1] |
Johannes Schindelin | cd67e4d | 2007-11-28 13:11:07 +0000 | [diff] [blame] | 643 | for details). |
| 644 | |
Christian Couder | 1658c61 | 2008-03-14 05:56:53 +0100 | [diff] [blame] | 645 | browser.<tool>.cmd:: |
| 646 | Specify the command to invoke the specified browser. The |
| 647 | specified command is evaluated in shell with the URLs passed |
| 648 | as arguments. (See linkgit:git-web--browse[1].) |
| 649 | |
Christian Couder | 584627b | 2008-01-29 07:08:22 +0100 | [diff] [blame] | 650 | browser.<tool>.path:: |
| 651 | Override the path for the given tool that may be used to |
Christian Couder | ab989ad | 2008-01-29 07:08:44 +0100 | [diff] [blame] | 652 | browse HTML help (see '-w' option in linkgit:git-help[1]) or a |
| 653 | working repository in gitweb (see linkgit:git-instaweb[1]). |
Christian Couder | 584627b | 2008-01-29 07:08:22 +0100 | [diff] [blame] | 654 | |
Josh Triplett | 2122591 | 2007-04-23 17:18:16 -0700 | [diff] [blame] | 655 | clean.requireForce:: |
Junio C Hamano | 562ca19 | 2007-11-01 17:32:04 -0700 | [diff] [blame] | 656 | A boolean to make git-clean do nothing unless given -f |
| 657 | or -n. Defaults to true. |
Josh Triplett | 2122591 | 2007-04-23 17:18:16 -0700 | [diff] [blame] | 658 | |
Brian Gernhardt | f367398 | 2007-01-03 10:36:29 -0500 | [diff] [blame] | 659 | color.branch:: |
| 660 | A boolean to enable/disable color in the output of |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 661 | linkgit:git-branch[1]. May be set to `always`, |
Junio C Hamano | cec99d8 | 2007-12-05 17:05:17 -0800 | [diff] [blame] | 662 | `false` (or `never`) or `auto` (or `true`), in which case colors are used |
Brian Gernhardt | f367398 | 2007-01-03 10:36:29 -0500 | [diff] [blame] | 663 | only when the output is to a terminal. Defaults to false. |
| 664 | |
| 665 | color.branch.<slot>:: |
| 666 | Use customized color for branch coloration. `<slot>` is one of |
| 667 | `current` (the current branch), `local` (a local branch), |
| 668 | `remote` (a tracking branch in refs/remotes/), `plain` (other |
Mark Wooding | 4f193f2 | 2007-01-28 15:17:36 +0000 | [diff] [blame] | 669 | refs). |
| 670 | + |
| 671 | The value for these configuration variables is a list of colors (at most |
| 672 | two) and attributes (at most one), separated by spaces. The colors |
| 673 | accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, |
| 674 | `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, |
| 675 | `blink` and `reverse`. The first color given is the foreground; the |
| 676 | second is the background. The position of the attribute, if any, |
| 677 | doesn't matter. |
Brian Gernhardt | f367398 | 2007-01-03 10:36:29 -0500 | [diff] [blame] | 678 | |
Andy Parkins | a159ca0 | 2006-12-13 09:13:28 +0000 | [diff] [blame] | 679 | color.diff:: |
Junio C Hamano | cec99d8 | 2007-12-05 17:05:17 -0800 | [diff] [blame] | 680 | When set to `always`, always use colors in patch. |
| 681 | When false (or `never`), never. When set to `true` or `auto`, use |
| 682 | colors only when the output is to the terminal. Defaults to false. |
Junio C Hamano | b537664 | 2006-07-07 05:28:05 -0700 | [diff] [blame] | 683 | |
Andy Parkins | a159ca0 | 2006-12-13 09:13:28 +0000 | [diff] [blame] | 684 | color.diff.<slot>:: |
Mark Wooding | 4f193f2 | 2007-01-28 15:17:36 +0000 | [diff] [blame] | 685 | Use customized color for diff colorization. `<slot>` specifies |
| 686 | which part of the patch to use the specified color, and is one |
| 687 | of `plain` (context text), `meta` (metainformation), `frag` |
Bert Wesarg | 89cb73a | 2009-11-27 07:55:18 +0100 | [diff] [blame] | 688 | (hunk header), 'func' (function in hunk header), `old` (removed lines), |
| 689 | `new` (added lines), `commit` (commit headers), or `whitespace` |
| 690 | (highlighting whitespace errors). The values of these variables may be |
| 691 | specified as in color.branch.<slot>. |
Junio C Hamano | b537664 | 2006-07-07 05:28:05 -0700 | [diff] [blame] | 692 | |
Nazri Ramliy | 5e11bee | 2010-06-24 08:21:16 +0800 | [diff] [blame] | 693 | color.decorate.<slot>:: |
| 694 | Use customized color for 'git log --decorate' output. `<slot>` is one |
| 695 | of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local |
| 696 | branches, remote tracking branches, tags, stash and HEAD, respectively. |
| 697 | |
René Scharfe | 7e8f59d | 2009-03-07 13:32:32 +0100 | [diff] [blame] | 698 | color.grep:: |
| 699 | When set to `always`, always highlight matches. When `false` (or |
| 700 | `never`), never. When set to `true` or `auto`, use color only |
| 701 | when the output is written to the terminal. Defaults to `false`. |
| 702 | |
Mark Lodato | 55f638b | 2010-03-07 11:52:46 -0500 | [diff] [blame] | 703 | color.grep.<slot>:: |
| 704 | Use customized color for grep colorization. `<slot>` specifies which |
| 705 | part of the line to use the specified color, and is one of |
| 706 | + |
| 707 | -- |
Mark Lodato | 00588bb | 2010-03-07 11:52:47 -0500 | [diff] [blame] | 708 | `context`;; |
| 709 | non-matching text in context lines (when using `-A`, `-B`, or `-C`) |
Mark Lodato | 55f638b | 2010-03-07 11:52:46 -0500 | [diff] [blame] | 710 | `filename`;; |
| 711 | filename prefix (when not using `-h`) |
Mark Lodato | 00588bb | 2010-03-07 11:52:47 -0500 | [diff] [blame] | 712 | `function`;; |
| 713 | function name lines (when using `-p`) |
Mark Lodato | 55f638b | 2010-03-07 11:52:46 -0500 | [diff] [blame] | 714 | `linenumber`;; |
| 715 | line number prefix (when using `-n`) |
| 716 | `match`;; |
| 717 | matching text |
Mark Lodato | 00588bb | 2010-03-07 11:52:47 -0500 | [diff] [blame] | 718 | `selected`;; |
| 719 | non-matching text in selected lines |
Mark Lodato | 55f638b | 2010-03-07 11:52:46 -0500 | [diff] [blame] | 720 | `separator`;; |
| 721 | separators between fields on a line (`:`, `-`, and `=`) |
| 722 | and between hunks (`--`) |
| 723 | -- |
| 724 | + |
| 725 | The values of these variables may be specified as in color.branch.<slot>. |
René Scharfe | 7e8f59d | 2009-03-07 13:32:32 +0100 | [diff] [blame] | 726 | |
Junio C Hamano | b4c61ed | 2007-12-05 00:50:23 -0800 | [diff] [blame] | 727 | color.interactive:: |
Jeff King | 47ee06f | 2008-01-05 04:57:44 -0500 | [diff] [blame] | 728 | When set to `always`, always use colors for interactive prompts |
Jonathan Nieder | 467c019 | 2008-07-03 00:28:15 -0500 | [diff] [blame] | 729 | and displays (such as those used by "git-add --interactive"). |
Junio C Hamano | b4c61ed | 2007-12-05 00:50:23 -0800 | [diff] [blame] | 730 | When false (or `never`), never. When set to `true` or `auto`, use |
| 731 | colors only when the output is to the terminal. Defaults to false. |
| 732 | |
| 733 | color.interactive.<slot>:: |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 734 | Use customized color for 'git add --interactive' |
Thomas Rast | a301973 | 2009-02-05 09:28:27 +0100 | [diff] [blame] | 735 | output. `<slot>` may be `prompt`, `header`, `help` or `error`, for |
| 736 | four distinct types of normal output from interactive |
Ori Avtalion | 57f6ec0 | 2009-08-07 17:24:21 +0300 | [diff] [blame] | 737 | commands. The values of these variables may be specified as |
Junio C Hamano | b4c61ed | 2007-12-05 00:50:23 -0800 | [diff] [blame] | 738 | in color.branch.<slot>. |
| 739 | |
Junio C Hamano | 1d77043 | 2006-12-13 12:11:03 -0800 | [diff] [blame] | 740 | color.pager:: |
| 741 | A boolean to enable/disable colored output when the pager is in |
| 742 | use (default is true). |
| 743 | |
Markus Heidelberg | ab07ba2 | 2009-04-22 23:41:25 +0200 | [diff] [blame] | 744 | color.showbranch:: |
| 745 | A boolean to enable/disable color in the output of |
| 746 | linkgit:git-show-branch[1]. May be set to `always`, |
| 747 | `false` (or `never`) or `auto` (or `true`), in which case colors are used |
| 748 | only when the output is to a terminal. Defaults to false. |
| 749 | |
Junio C Hamano | 1d77043 | 2006-12-13 12:11:03 -0800 | [diff] [blame] | 750 | color.status:: |
| 751 | A boolean to enable/disable color in the output of |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 752 | linkgit:git-status[1]. May be set to `always`, |
Junio C Hamano | cec99d8 | 2007-12-05 17:05:17 -0800 | [diff] [blame] | 753 | `false` (or `never`) or `auto` (or `true`), in which case colors are used |
Junio C Hamano | 1d77043 | 2006-12-13 12:11:03 -0800 | [diff] [blame] | 754 | only when the output is to a terminal. Defaults to false. |
| 755 | |
| 756 | color.status.<slot>:: |
| 757 | Use customized color for status colorization. `<slot>` is |
| 758 | one of `header` (the header text of the status message), |
Shawn O. Pearce | 82dca84 | 2006-12-15 21:53:13 -0500 | [diff] [blame] | 759 | `added` or `updated` (files which are added but not committed), |
| 760 | `changed` (files which are changed but not added in the index), |
Chris Parsons | 950ce2e | 2008-05-22 08:50:02 -0400 | [diff] [blame] | 761 | `untracked` (files which are not tracked by git), or |
| 762 | `nobranch` (the color the 'no branch' warning is shown in, defaulting |
| 763 | to red). The values of these variables may be specified as in |
| 764 | color.branch.<slot>. |
Junio C Hamano | 1d77043 | 2006-12-13 12:11:03 -0800 | [diff] [blame] | 765 | |
Matthias Kestenholz | 6b2f2d9 | 2008-02-18 08:26:03 +0100 | [diff] [blame] | 766 | color.ui:: |
| 767 | When set to `always`, always use colors in all git commands which |
| 768 | are capable of colored output. When false (or `never`), never. When |
| 769 | set to `true` or `auto`, use colors only when the output is to the |
| 770 | terminal. When more specific variables of color.* are set, they always |
| 771 | take precedence over this setting. Defaults to false. |
| 772 | |
Thomas Rast | 88955ed | 2010-01-23 23:13:17 +0100 | [diff] [blame] | 773 | commit.status:: |
James P. Howard, II | bed575e | 2009-12-07 17:45:27 -0500 | [diff] [blame] | 774 | A boolean to enable/disable inclusion of status information in the |
| 775 | commit message template when using an editor to prepare the commit |
| 776 | message. Defaults to true. |
| 777 | |
Matt McCutchen | b0f34c3 | 2008-11-26 03:26:50 -0500 | [diff] [blame] | 778 | commit.template:: |
| 779 | Specify a file to use as the template for new commit messages. |
Junio C Hamano | 0f7fb21 | 2009-11-21 00:37:26 -0800 | [diff] [blame] | 780 | "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the |
Matthieu Moy | df2a79f | 2009-11-19 16:21:15 +0100 | [diff] [blame] | 781 | specified user's home directory. |
Matt McCutchen | b0f34c3 | 2008-11-26 03:26:50 -0500 | [diff] [blame] | 782 | |
Junio C Hamano | aecbf91 | 2007-08-31 13:13:42 -0700 | [diff] [blame] | 783 | diff.autorefreshindex:: |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 784 | When using 'git diff' to compare with work tree |
Junio C Hamano | aecbf91 | 2007-08-31 13:13:42 -0700 | [diff] [blame] | 785 | files, do not consider stat-only change as changed. |
| 786 | Instead, silently run `git update-index --refresh` to |
| 787 | update the cached stat information for paths whose |
| 788 | contents in the work tree match the contents in the |
| 789 | index. This option defaults to true. Note that this |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 790 | affects only 'git diff' Porcelain, and not lower level |
Junio C Hamano | add0951 | 2010-01-20 20:28:49 -0800 | [diff] [blame] | 791 | 'diff' commands such as 'git diff-files'. |
Junio C Hamano | aecbf91 | 2007-08-31 13:13:42 -0700 | [diff] [blame] | 792 | |
Johannes Schindelin | 77680ca | 2007-12-17 12:21:22 +0000 | [diff] [blame] | 793 | diff.external:: |
| 794 | If this config variable is set, diff generation is not |
| 795 | performed using the internal diff machinery, but using the |
Anders Melchiorsen | 6bb9e51 | 2008-07-27 13:12:15 +0200 | [diff] [blame] | 796 | given command. Can be overridden with the `GIT_EXTERNAL_DIFF' |
| 797 | environment variable. The command is called with parameters |
| 798 | as described under "git Diffs" in linkgit:git[1]. Note: if |
| 799 | you want to use an external diff program only on a subset of |
| 800 | your files, you might want to use linkgit:gitattributes[5] instead. |
Johannes Schindelin | 77680ca | 2007-12-17 12:21:22 +0000 | [diff] [blame] | 801 | |
Junio C Hamano | a5a818e | 2008-08-18 20:08:09 -0700 | [diff] [blame] | 802 | diff.mnemonicprefix:: |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 803 | If set, 'git diff' uses a prefix pair that is different from the |
Junio C Hamano | a5a818e | 2008-08-18 20:08:09 -0700 | [diff] [blame] | 804 | standard "a/" and "b/" depending on what is being compared. When |
| 805 | this configuration is in effect, reverse diff output also swaps |
| 806 | the order of the prefixes: |
Eli Collins | f89504d | 2010-05-02 19:03:41 -0700 | [diff] [blame] | 807 | diff.noprefix:: |
| 808 | If set, 'git diff' does not show any source or destination prefix. |
Thomas Rast | ca76828 | 2010-01-07 17:49:12 +0100 | [diff] [blame] | 809 | `git diff`;; |
Junio C Hamano | a5a818e | 2008-08-18 20:08:09 -0700 | [diff] [blame] | 810 | compares the (i)ndex and the (w)ork tree; |
Thomas Rast | ca76828 | 2010-01-07 17:49:12 +0100 | [diff] [blame] | 811 | `git diff HEAD`;; |
Junio C Hamano | a5a818e | 2008-08-18 20:08:09 -0700 | [diff] [blame] | 812 | compares a (c)ommit and the (w)ork tree; |
Thomas Rast | ca76828 | 2010-01-07 17:49:12 +0100 | [diff] [blame] | 813 | `git diff --cached`;; |
Junio C Hamano | a5a818e | 2008-08-18 20:08:09 -0700 | [diff] [blame] | 814 | compares a (c)ommit and the (i)ndex; |
Thomas Rast | ca76828 | 2010-01-07 17:49:12 +0100 | [diff] [blame] | 815 | `git diff HEAD:file1 file2`;; |
Junio C Hamano | a5a818e | 2008-08-18 20:08:09 -0700 | [diff] [blame] | 816 | compares an (o)bject and a (w)ork tree entity; |
Thomas Rast | ca76828 | 2010-01-07 17:49:12 +0100 | [diff] [blame] | 817 | `git diff --no-index a b`;; |
Junio C Hamano | a5a818e | 2008-08-18 20:08:09 -0700 | [diff] [blame] | 818 | compares two non-git things (1) and (2). |
| 819 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 820 | diff.renameLimit:: |
| 821 | The number of files to consider when performing the copy/rename |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 822 | detection; equivalent to the 'git diff' option '-l'. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 823 | |
Eric Wong | b68ea12 | 2006-07-07 04:01:23 -0700 | [diff] [blame] | 824 | diff.renames:: |
| 825 | Tells git to detect renames. If set to any boolean value, it |
| 826 | will enable basic rename detection. If set to "copies" or |
| 827 | "copy", it will detect copies, as well. |
| 828 | |
Johannes Schindelin | 950db87 | 2009-01-20 22:08:33 +0100 | [diff] [blame] | 829 | diff.suppressBlankEmpty:: |
Richard Hartmann | 5fdb709 | 2008-12-21 23:28:25 +0100 | [diff] [blame] | 830 | A boolean to inhibit the standard behavior of printing a space |
| 831 | before each empty output line. Defaults to false. |
| 832 | |
David Aguilar | afcbc8e | 2009-04-07 01:21:20 -0700 | [diff] [blame] | 833 | diff.tool:: |
| 834 | Controls which diff tool is used. `diff.tool` overrides |
| 835 | `merge.tool` when used by linkgit:git-difftool[1] and has |
| 836 | the same valid values as `merge.tool` minus "tortoisemerge" |
| 837 | and plus "kompare". |
| 838 | |
| 839 | difftool.<tool>.path:: |
| 840 | Override the path for the given tool. This is useful in case |
| 841 | your tool is not in the PATH. |
| 842 | |
| 843 | difftool.<tool>.cmd:: |
| 844 | Specify the command to invoke the specified diff tool. |
| 845 | The specified command is evaluated in shell with the following |
| 846 | variables available: 'LOCAL' is set to the name of the temporary |
| 847 | file containing the contents of the diff pre-image and 'REMOTE' |
| 848 | is set to the name of the temporary file containing the contents |
| 849 | of the diff post-image. |
| 850 | |
David Aguilar | a904392 | 2009-04-07 01:21:22 -0700 | [diff] [blame] | 851 | difftool.prompt:: |
| 852 | Prompt before each invocation of the diff tool. |
| 853 | |
Boyd Stephen Smith Jr | ae3b970 | 2009-01-20 22:59:54 -0600 | [diff] [blame] | 854 | diff.wordRegex:: |
Boyd Stephen Smith Jr | 98a4d87 | 2009-01-20 21:46:57 -0600 | [diff] [blame] | 855 | A POSIX Extended Regular Expression used to determine what is a "word" |
| 856 | when performing word-by-word difference calculations. Character |
| 857 | sequences that match the regular expression are "words", all other |
| 858 | characters are *ignorable* whitespace. |
| 859 | |
Junio C Hamano | af7cf26 | 2007-01-24 16:47:24 -0800 | [diff] [blame] | 860 | fetch.unpackLimit:: |
| 861 | If the number of objects fetched over the git native |
| 862 | transfer is below this |
| 863 | limit, then the objects will be unpacked into loose object |
| 864 | files. However if the number of received objects equals or |
| 865 | exceeds this limit then the received pack will be stored as |
| 866 | a pack, after adding any missing delta bases. Storing the |
| 867 | pack from a push can make the push operation complete faster, |
Michele Ballabio | 80cd9cf | 2008-01-11 22:11:13 +0100 | [diff] [blame] | 868 | especially on slow filesystems. If not set, the value of |
| 869 | `transfer.unpackLimit` is used instead. |
Junio C Hamano | af7cf26 | 2007-01-24 16:47:24 -0800 | [diff] [blame] | 870 | |
Stephen Boyd | 48d3448 | 2009-04-23 02:37:56 -0700 | [diff] [blame] | 871 | format.attach:: |
| 872 | Enable multipart/mixed attachments as the default for |
| 873 | 'format-patch'. The value can also be a double quoted string |
| 874 | which will enable attachments as the default and set the |
| 875 | value as the boundary. See the --attach option in |
| 876 | linkgit:git-format-patch[1]. |
| 877 | |
Brian Gernhardt | 49604a4 | 2007-11-03 23:38:24 -0400 | [diff] [blame] | 878 | format.numbered:: |
Brian Gernhardt | a567fdc | 2008-10-02 16:55:39 -0400 | [diff] [blame] | 879 | A boolean which can enable or disable sequence numbers in patch |
| 880 | subjects. It defaults to "auto" which enables it only if there |
| 881 | is more than one patch. It can be enabled or disabled for all |
| 882 | messages by setting it to "true" or "false". See --numbered |
| 883 | option in linkgit:git-format-patch[1]. |
Brian Gernhardt | 49604a4 | 2007-11-03 23:38:24 -0400 | [diff] [blame] | 884 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 885 | format.headers:: |
| 886 | Additional email headers to include in a patch to be submitted |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 887 | by mail. See linkgit:git-format-patch[1]. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 888 | |
Miklos Vajna | 312a30e | 2010-07-12 20:58:38 +0200 | [diff] [blame] | 889 | format.to:: |
Stephen Boyd | 48d3448 | 2009-04-23 02:37:56 -0700 | [diff] [blame] | 890 | format.cc:: |
Miklos Vajna | 312a30e | 2010-07-12 20:58:38 +0200 | [diff] [blame] | 891 | Additional recipients to include in a patch to be submitted |
| 892 | by mail. See the --to and --cc options in |
| 893 | linkgit:git-format-patch[1]. |
Stephen Boyd | 48d3448 | 2009-04-23 02:37:56 -0700 | [diff] [blame] | 894 | |
| 895 | format.subjectprefix:: |
| 896 | The default for format-patch is to output files with the '[PATCH]' |
| 897 | subject prefix. Use this variable to change that prefix. |
| 898 | |
Stephen Boyd | 6622d9c | 2010-06-15 22:59:25 -0700 | [diff] [blame] | 899 | format.signature:: |
| 900 | The default for format-patch is to output a signature containing |
| 901 | the git version number. Use this variable to change that default. |
| 902 | Set this variable to the empty string ("") to suppress |
| 903 | signature generation. |
| 904 | |
Johannes Schindelin | 78cb59c | 2007-03-04 00:17:23 +0100 | [diff] [blame] | 905 | format.suffix:: |
| 906 | The default for format-patch is to output files with the suffix |
| 907 | `.patch`. Use this variable to change that suffix (make sure to |
| 908 | include the dot if you want it). |
| 909 | |
Denis Cheng | 94c22a5 | 2008-03-02 17:05:53 +0800 | [diff] [blame] | 910 | format.pretty:: |
| 911 | The default pretty format for log/show/whatchanged command, |
| 912 | See linkgit:git-log[1], linkgit:git-show[1], |
| 913 | linkgit:git-whatchanged[1]. |
| 914 | |
Thomas Rast | 30984ed | 2009-02-19 22:26:33 +0100 | [diff] [blame] | 915 | format.thread:: |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 916 | The default threading style for 'git format-patch'. Can be |
Jonathan Nieder | 578b62b | 2010-01-09 21:01:21 -0600 | [diff] [blame] | 917 | a boolean value, or `shallow` or `deep`. `shallow` threading |
| 918 | makes every mail a reply to the head of the series, |
Thomas Rast | 30984ed | 2009-02-19 22:26:33 +0100 | [diff] [blame] | 919 | where the head is chosen from the cover letter, the |
| 920 | `\--in-reply-to`, and the first patch mail, in this order. |
Stephen Boyd | fd1ff30 | 2009-04-23 02:37:57 -0700 | [diff] [blame] | 921 | `deep` threading makes every mail a reply to the previous one. |
Thomas Rast | 30984ed | 2009-02-19 22:26:33 +0100 | [diff] [blame] | 922 | A true boolean value is the same as `shallow`, and a false |
| 923 | value disables threading. |
| 924 | |
Heiko Voigt | 1d1876e | 2009-04-01 19:51:54 +0200 | [diff] [blame] | 925 | format.signoff:: |
| 926 | A boolean value which lets you enable the `-s/--signoff` option of |
| 927 | format-patch by default. *Note:* Adding the Signed-off-by: line to a |
| 928 | patch should be a conscious act and means that you certify you have |
| 929 | the rights to submit this work under the same open source license. |
| 930 | Please see the 'SubmittingPatches' document for further discussion. |
| 931 | |
Theodore Tso | 0d7566a | 2007-05-09 15:48:39 -0400 | [diff] [blame] | 932 | gc.aggressiveWindow:: |
| 933 | The window size parameter used in the delta compression |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 934 | algorithm used by 'git gc --aggressive'. This defaults |
Jay Soffian | f78683f | 2010-04-13 12:52:55 -0400 | [diff] [blame] | 935 | to 250. |
Theodore Tso | 0d7566a | 2007-05-09 15:48:39 -0400 | [diff] [blame] | 936 | |
Junio C Hamano | e9831e8 | 2007-09-17 00:39:52 -0700 | [diff] [blame] | 937 | gc.auto:: |
| 938 | When there are approximately more than this many loose |
| 939 | objects in the repository, `git gc --auto` will pack them. |
| 940 | Some Porcelain commands use this command to perform a |
Michele Ballabio | 80cd9cf | 2008-01-11 22:11:13 +0100 | [diff] [blame] | 941 | light-weight garbage collection from time to time. The |
| 942 | default value is 6700. Setting this to 0 disables it. |
Junio C Hamano | e9831e8 | 2007-09-17 00:39:52 -0700 | [diff] [blame] | 943 | |
Junio C Hamano | 1781550 | 2007-09-17 00:55:13 -0700 | [diff] [blame] | 944 | gc.autopacklimit:: |
| 945 | When there are more than this many packs that are not |
| 946 | marked with `*.keep` file in the repository, `git gc |
Michele Ballabio | 80cd9cf | 2008-01-11 22:11:13 +0100 | [diff] [blame] | 947 | --auto` consolidates them into one larger pack. The |
Junio C Hamano | 9706397 | 2008-03-23 00:04:48 -0700 | [diff] [blame] | 948 | default value is 50. Setting this to 0 disables it. |
Junio C Hamano | 1781550 | 2007-09-17 00:55:13 -0700 | [diff] [blame] | 949 | |
Johannes Schindelin | c2120e5 | 2007-02-13 14:01:42 +0100 | [diff] [blame] | 950 | gc.packrefs:: |
Jonathan Nieder | efc266e | 2010-01-09 20:59:41 -0600 | [diff] [blame] | 951 | Running `git pack-refs` in a repository renders it |
| 952 | unclonable by Git versions prior to 1.5.1.2 over dumb |
| 953 | transports such as HTTP. This variable determines whether |
Junio C Hamano | add0951 | 2010-01-20 20:28:49 -0800 | [diff] [blame] | 954 | 'git gc' runs `git pack-refs`. This can be set to `nobare` |
Jonathan Nieder | efc266e | 2010-01-09 20:59:41 -0600 | [diff] [blame] | 955 | to enable it within all non-bare repos or it can be set to a |
| 956 | boolean value. The default is `true`. |
Johannes Schindelin | c2120e5 | 2007-02-13 14:01:42 +0100 | [diff] [blame] | 957 | |
Johannes Schindelin | 25ee973 | 2008-03-12 21:55:47 +0100 | [diff] [blame] | 958 | gc.pruneexpire:: |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 959 | When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'. |
Nicolas Pitre | 8e8daf3 | 2008-12-30 14:45:11 -0500 | [diff] [blame] | 960 | Override the grace period with this config variable. The value |
| 961 | "now" may be used to disable this grace period and always prune |
| 962 | unreachable objects immediately. |
Johannes Schindelin | 25ee973 | 2008-03-12 21:55:47 +0100 | [diff] [blame] | 963 | |
Junio C Hamano | 4aec56d | 2006-12-27 01:47:57 -0800 | [diff] [blame] | 964 | gc.reflogexpire:: |
Junio C Hamano | eb523a8 | 2010-04-14 13:12:34 -0700 | [diff] [blame] | 965 | gc.<pattern>.reflogexpire:: |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 966 | 'git reflog expire' removes reflog entries older than |
Junio C Hamano | eb523a8 | 2010-04-14 13:12:34 -0700 | [diff] [blame] | 967 | this time; defaults to 90 days. With "<pattern>" (e.g. |
| 968 | "refs/stash") in the middle the setting applies only to |
| 969 | the refs that match the <pattern>. |
Junio C Hamano | 4aec56d | 2006-12-27 01:47:57 -0800 | [diff] [blame] | 970 | |
| 971 | gc.reflogexpireunreachable:: |
Junio C Hamano | eb523a8 | 2010-04-14 13:12:34 -0700 | [diff] [blame] | 972 | gc.<ref>.reflogexpireunreachable:: |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 973 | 'git reflog expire' removes reflog entries older than |
Junio C Hamano | 4aec56d | 2006-12-27 01:47:57 -0800 | [diff] [blame] | 974 | this time and are not reachable from the current tip; |
Junio C Hamano | eb523a8 | 2010-04-14 13:12:34 -0700 | [diff] [blame] | 975 | defaults to 30 days. With "<pattern>" (e.g. "refs/stash") |
| 976 | in the middle, the setting applies only to the refs that |
| 977 | match the <pattern>. |
Junio C Hamano | 4aec56d | 2006-12-27 01:47:57 -0800 | [diff] [blame] | 978 | |
Junio C Hamano | 48c3242 | 2006-12-27 01:24:05 -0800 | [diff] [blame] | 979 | gc.rerereresolved:: |
| 980 | Records of conflicted merge you resolved earlier are |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 981 | kept for this many days when 'git rerere gc' is run. |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 982 | The default is 60 days. See linkgit:git-rerere[1]. |
Junio C Hamano | 48c3242 | 2006-12-27 01:24:05 -0800 | [diff] [blame] | 983 | |
| 984 | gc.rerereunresolved:: |
| 985 | Records of conflicted merge you have not resolved are |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 986 | kept for this many days when 'git rerere gc' is run. |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 987 | The default is 15 days. See linkgit:git-rerere[1]. |
Junio C Hamano | 48c3242 | 2006-12-27 01:24:05 -0800 | [diff] [blame] | 988 | |
Fabian Emmes | 280514e | 2009-01-02 16:40:13 +0100 | [diff] [blame] | 989 | gitcvs.commitmsgannotation:: |
| 990 | Append this string to each commit message. Set to empty string |
| 991 | to disable this feature. Defaults to "via git-CVS emulator". |
| 992 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 993 | gitcvs.enabled:: |
Brian Hetro | db21872 | 2007-08-23 20:40:08 -0400 | [diff] [blame] | 994 | Whether the CVS server interface is enabled for this repository. |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 995 | See linkgit:git-cvsserver[1]. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 996 | |
| 997 | gitcvs.logfile:: |
Brian Hetro | db21872 | 2007-08-23 20:40:08 -0400 | [diff] [blame] | 998 | Path to a log file where the CVS server interface well... logs |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 999 | various stuff. See linkgit:git-cvsserver[1]. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1000 | |
Teemu Likonen | 1707adb | 2008-08-29 10:29:42 +0300 | [diff] [blame] | 1001 | gitcvs.usecrlfattr:: |
Eyvind Bernhardsen | 5ec3e67 | 2010-05-19 22:43:11 +0200 | [diff] [blame] | 1002 | If true, the server will look up the end-of-line conversion |
| 1003 | attributes for files to determine the '-k' modes to use. If |
| 1004 | the attributes force git to treat a file as text, |
| 1005 | the '-k' mode will be left blank so cvs clients will |
| 1006 | treat it as text. If they suppress text conversion, the file |
Mike Ralphson | 1168d40 | 2008-08-05 17:12:05 +0100 | [diff] [blame] | 1007 | will be set with '-kb' mode, which suppresses any newline munging |
Eyvind Bernhardsen | 5ec3e67 | 2010-05-19 22:43:11 +0200 | [diff] [blame] | 1008 | the client might otherwise do. If the attributes do not allow |
| 1009 | the file type to be determined, then 'gitcvs.allbinary' is |
| 1010 | used. See linkgit:gitattributes[5]. |
Matthew Ogilvie | 8a06a63 | 2008-05-14 22:35:47 -0600 | [diff] [blame] | 1011 | |
Frank Lichtenheld | eabb0bf | 2007-04-13 18:02:30 +0200 | [diff] [blame] | 1012 | gitcvs.allbinary:: |
Matthew Ogilvie | 90948a4 | 2008-05-14 22:35:48 -0600 | [diff] [blame] | 1013 | This is used if 'gitcvs.usecrlfattr' does not resolve |
| 1014 | the correct '-kb' mode to use. If true, all |
| 1015 | unresolved files are sent to the client in |
| 1016 | mode '-kb'. This causes the client to treat them |
| 1017 | as binary files, which suppresses any newline munging it |
| 1018 | otherwise might do. Alternatively, if it is set to "guess", |
| 1019 | then the contents of the file are examined to decide if |
| 1020 | it is binary, similar to 'core.autocrlf'. |
Junio C Hamano | abbf594 | 2007-04-17 22:17:46 -0700 | [diff] [blame] | 1021 | |
Frank Lichtenheld | 0475286 | 2007-04-13 18:13:42 +0200 | [diff] [blame] | 1022 | gitcvs.dbname:: |
| 1023 | Database used by git-cvsserver to cache revision information |
| 1024 | derived from the git repository. The exact meaning depends on the |
| 1025 | used database driver, for SQLite (which is the default driver) this |
| 1026 | is a filename. Supports variable substitution (see |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1027 | linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`). |
Frank Lichtenheld | 0475286 | 2007-04-13 18:13:42 +0200 | [diff] [blame] | 1028 | Default: '%Ggitcvs.%m.sqlite' |
| 1029 | |
| 1030 | gitcvs.dbdriver:: |
| 1031 | Used Perl DBI driver. You can specify any available driver |
| 1032 | for this here, but it might not work. git-cvsserver is tested |
| 1033 | with 'DBD::SQLite', reported to work with 'DBD::Pg', and |
| 1034 | reported *not* to work with 'DBD::mysql'. Experimental feature. |
| 1035 | May not contain double colons (`:`). Default: 'SQLite'. |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1036 | See linkgit:git-cvsserver[1]. |
Frank Lichtenheld | eabb0bf | 2007-04-13 18:02:30 +0200 | [diff] [blame] | 1037 | |
Frank Lichtenheld | 0475286 | 2007-04-13 18:13:42 +0200 | [diff] [blame] | 1038 | gitcvs.dbuser, gitcvs.dbpass:: |
| 1039 | Database user and password. Only useful if setting 'gitcvs.dbdriver', |
| 1040 | since SQLite has no concept of database users and/or passwords. |
| 1041 | 'gitcvs.dbuser' supports variable substitution (see |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1042 | linkgit:git-cvsserver[1] for details). |
Frank Lichtenheld | 0475286 | 2007-04-13 18:13:42 +0200 | [diff] [blame] | 1043 | |
Josh Elsasser | 6aeeffd | 2008-03-27 14:02:14 -0700 | [diff] [blame] | 1044 | gitcvs.dbTableNamePrefix:: |
| 1045 | Database table name prefix. Prepended to the names of any |
| 1046 | database tables used, allowing a single database to be used |
| 1047 | for several repositories. Supports variable substitution (see |
| 1048 | linkgit:git-cvsserver[1] for details). Any non-alphabetic |
| 1049 | characters will be replaced with underscores. |
| 1050 | |
Matthew Ogilvie | 8a06a63 | 2008-05-14 22:35:47 -0600 | [diff] [blame] | 1051 | All gitcvs variables except for 'gitcvs.usecrlfattr' and |
| 1052 | 'gitcvs.allbinary' can also be specified as |
| 1053 | 'gitcvs.<access_method>.<varname>' (where 'access_method' |
Brian Hetro | 0278307 | 2007-08-23 20:44:13 -0400 | [diff] [blame] | 1054 | is one of "ext" and "pserver") to make them apply only for the given |
| 1055 | access method. |
Frank Lichtenheld | 0475286 | 2007-04-13 18:13:42 +0200 | [diff] [blame] | 1056 | |
Gustaf Hendeby | d84ae0d | 2008-05-08 10:55:02 +0200 | [diff] [blame] | 1057 | gui.commitmsgwidth:: |
| 1058 | Defines how wide the commit message window is in the |
| 1059 | linkgit:git-gui[1]. "75" is the default. |
| 1060 | |
| 1061 | gui.diffcontext:: |
| 1062 | Specifies how many context lines should be used in calls to diff |
| 1063 | made by the linkgit:git-gui[1]. The default is "5". |
| 1064 | |
Alexander Gavrilov | a2df1fb | 2008-11-13 20:28:49 +0300 | [diff] [blame] | 1065 | gui.encoding:: |
| 1066 | Specifies the default encoding to use for displaying of |
| 1067 | file contents in linkgit:git-gui[1] and linkgit:gitk[1]. |
| 1068 | It can be overridden by setting the 'encoding' attribute |
| 1069 | for relevant files (see linkgit:gitattributes[5]). |
| 1070 | If this option is not set, the tools default to the |
| 1071 | locale encoding. |
| 1072 | |
Gustaf Hendeby | d84ae0d | 2008-05-08 10:55:02 +0200 | [diff] [blame] | 1073 | gui.matchtrackingbranch:: |
| 1074 | Determines if new branches created with linkgit:git-gui[1] should |
| 1075 | default to tracking remote branches with matching names or |
| 1076 | not. Default: "false". |
| 1077 | |
| 1078 | gui.newbranchtemplate:: |
| 1079 | Is used as suggested name when creating new branches using the |
| 1080 | linkgit:git-gui[1]. |
| 1081 | |
| 1082 | gui.pruneduringfetch:: |
| 1083 | "true" if linkgit:git-gui[1] should prune tracking branches when |
| 1084 | performing a fetch. The default value is "false". |
| 1085 | |
| 1086 | gui.trustmtime:: |
| 1087 | Determines if linkgit:git-gui[1] should trust the file modification |
| 1088 | timestamp or not. By default the timestamps are not trusted. |
| 1089 | |
| 1090 | gui.spellingdictionary:: |
| 1091 | Specifies the dictionary used for spell checking commit messages in |
| 1092 | the linkgit:git-gui[1]. When set to "none" spell checking is turned |
| 1093 | off. |
| 1094 | |
Alexander Gavrilov | a2df1fb | 2008-11-13 20:28:49 +0300 | [diff] [blame] | 1095 | gui.fastcopyblame:: |
Thomas Rast | ca76828 | 2010-01-07 17:49:12 +0100 | [diff] [blame] | 1096 | If true, 'git gui blame' uses `-C` instead of `-C -C` for original |
Alexander Gavrilov | a2df1fb | 2008-11-13 20:28:49 +0300 | [diff] [blame] | 1097 | location detection. It makes blame significantly faster on huge |
| 1098 | repositories at the expense of less thorough copy detection. |
| 1099 | |
| 1100 | gui.copyblamethreshold:: |
Ralf Wildenhues | 76bac89 | 2008-11-27 08:32:01 +0100 | [diff] [blame] | 1101 | Specifies the threshold to use in 'git gui blame' original location |
Alexander Gavrilov | a2df1fb | 2008-11-13 20:28:49 +0300 | [diff] [blame] | 1102 | detection, measured in alphanumeric characters. See the |
| 1103 | linkgit:git-blame[1] manual for more information on copy detection. |
| 1104 | |
| 1105 | gui.blamehistoryctx:: |
| 1106 | Specifies the radius of history context in days to show in |
| 1107 | linkgit:gitk[1] for the selected commit, when the `Show History |
| 1108 | Context` menu item is invoked from 'git gui blame'. If this |
| 1109 | variable is set to zero, the whole history is shown. |
| 1110 | |
Alexander Gavrilov | 390c348 | 2008-12-14 22:44:32 +0300 | [diff] [blame] | 1111 | guitool.<name>.cmd:: |
| 1112 | Specifies the shell command line to execute when the corresponding item |
| 1113 | of the linkgit:git-gui[1] `Tools` menu is invoked. This option is |
| 1114 | mandatory for every tool. The command is executed from the root of |
| 1115 | the working directory, and in the environment it receives the name of |
| 1116 | the tool as 'GIT_GUITOOL', the name of the currently selected file as |
| 1117 | 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if |
| 1118 | the head is detached, 'CUR_BRANCH' is empty). |
| 1119 | |
| 1120 | guitool.<name>.needsfile:: |
| 1121 | Run the tool only if a diff is selected in the GUI. It guarantees |
| 1122 | that 'FILENAME' is not empty. |
| 1123 | |
| 1124 | guitool.<name>.noconsole:: |
| 1125 | Run the command silently, without creating a window to display its |
| 1126 | output. |
| 1127 | |
| 1128 | guitool.<name>.norescan:: |
| 1129 | Don't rescan the working directory for changes after the tool |
| 1130 | finishes execution. |
| 1131 | |
| 1132 | guitool.<name>.confirm:: |
| 1133 | Show a confirmation dialog before actually running the tool. |
| 1134 | |
| 1135 | guitool.<name>.argprompt:: |
| 1136 | Request a string argument from the user, and pass it to the tool |
| 1137 | through the 'ARGS' environment variable. Since requesting an |
| 1138 | argument implies confirmation, the 'confirm' option has no effect |
| 1139 | if this is enabled. If the option is set to 'true', 'yes', or '1', |
| 1140 | the dialog uses a built-in generic prompt; otherwise the exact |
| 1141 | value of the variable is used. |
| 1142 | |
| 1143 | guitool.<name>.revprompt:: |
| 1144 | Request a single valid revision from the user, and set the |
| 1145 | 'REVISION' environment variable. In other aspects this option |
| 1146 | is similar to 'argprompt', and can be used together with it. |
| 1147 | |
| 1148 | guitool.<name>.revunmerged:: |
| 1149 | Show only unmerged branches in the 'revprompt' subdialog. |
| 1150 | This is useful for tools similar to merge or rebase, but not |
| 1151 | for things like checkout or reset. |
| 1152 | |
| 1153 | guitool.<name>.title:: |
| 1154 | Specifies the title to use for the prompt dialog. The default |
| 1155 | is the tool name. |
| 1156 | |
| 1157 | guitool.<name>.prompt:: |
| 1158 | Specifies the general prompt string to display at the top of |
| 1159 | the dialog, before subsections for 'argprompt' and 'revprompt'. |
| 1160 | The default value includes the actual command. |
| 1161 | |
Christian Couder | 983a9ee | 2008-01-08 04:55:14 +0100 | [diff] [blame] | 1162 | help.browser:: |
| 1163 | Specify the browser that will be used to display help in the |
| 1164 | 'web' format. See linkgit:git-help[1]. |
| 1165 | |
| 1166 | help.format:: |
| 1167 | Override the default help format used by linkgit:git-help[1]. |
| 1168 | Values 'man', 'info', 'web' and 'html' are supported. 'man' is |
| 1169 | the default. 'web' and 'html' are the same. |
| 1170 | |
Alex Riesen | f0e9071 | 2008-08-31 15:54:58 +0200 | [diff] [blame] | 1171 | help.autocorrect:: |
| 1172 | Automatically correct and execute mistyped commands after |
| 1173 | waiting for the given number of deciseconds (0.1 sec). If more |
| 1174 | than one command can be deduced from the entered text, nothing |
| 1175 | will be executed. If the value of this option is negative, |
| 1176 | the corrected command will be executed immediately. If the |
| 1177 | value is 0 - the command will be just shown but not executed. |
| 1178 | This is the default. |
| 1179 | |
Sam Vilain | 9c5665a | 2007-11-23 13:07:00 +1300 | [diff] [blame] | 1180 | http.proxy:: |
| 1181 | Override the HTTP proxy, normally configured using the 'http_proxy' |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1182 | environment variable (see linkgit:curl[1]). This can be overridden |
Sam Vilain | 14c9821 | 2007-12-04 10:48:54 +1300 | [diff] [blame] | 1183 | on a per-remote basis; see remote.<name>.proxy |
Sam Vilain | 9c5665a | 2007-11-23 13:07:00 +1300 | [diff] [blame] | 1184 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1185 | http.sslVerify:: |
| 1186 | Whether to verify the SSL certificate when fetching or pushing |
Francis Daly | 3742506 | 2006-06-07 13:56:45 +0100 | [diff] [blame] | 1187 | over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1188 | variable. |
| 1189 | |
| 1190 | http.sslCert:: |
| 1191 | File containing the SSL certificate when fetching or pushing |
Francis Daly | 3742506 | 2006-06-07 13:56:45 +0100 | [diff] [blame] | 1192 | over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1193 | variable. |
| 1194 | |
| 1195 | http.sslKey:: |
| 1196 | File containing the SSL private key when fetching or pushing |
Horst H. von Brand | abda1ef | 2006-06-03 16:27:26 -0400 | [diff] [blame] | 1197 | over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1198 | variable. |
| 1199 | |
Mark Lodato | 754ae19 | 2009-05-27 23:16:03 -0400 | [diff] [blame] | 1200 | http.sslCertPasswordProtected:: |
| 1201 | Enable git's password prompt for the SSL certificate. Otherwise |
| 1202 | OpenSSL will prompt the user, possibly many times, if the |
| 1203 | certificate or private key is encrypted. Can be overridden by the |
| 1204 | 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable. |
| 1205 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1206 | http.sslCAInfo:: |
| 1207 | File containing the certificates to verify the peer with when |
Horst H. von Brand | abda1ef | 2006-06-03 16:27:26 -0400 | [diff] [blame] | 1208 | fetching or pushing over HTTPS. Can be overridden by the |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1209 | 'GIT_SSL_CAINFO' environment variable. |
| 1210 | |
| 1211 | http.sslCAPath:: |
| 1212 | Path containing files with the CA certificates to verify the peer |
Francis Daly | 3742506 | 2006-06-07 13:56:45 +0100 | [diff] [blame] | 1213 | with when fetching or pushing over HTTPS. Can be overridden |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1214 | by the 'GIT_SSL_CAPATH' environment variable. |
| 1215 | |
| 1216 | http.maxRequests:: |
Horst H. von Brand | abda1ef | 2006-06-03 16:27:26 -0400 | [diff] [blame] | 1217 | How many HTTP requests to launch in parallel. Can be overridden |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1218 | by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5. |
| 1219 | |
Tay Ray Chuan | ad75ebe | 2009-11-27 23:42:26 +0800 | [diff] [blame] | 1220 | http.minSessions:: |
| 1221 | The number of curl sessions (counted across slots) to be kept across |
| 1222 | requests. They will not be ended with curl_easy_cleanup() until |
| 1223 | http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this |
| 1224 | value will be capped at 1. Defaults to 1. |
| 1225 | |
Shawn O. Pearce | de1a2fd | 2009-10-30 17:47:41 -0700 | [diff] [blame] | 1226 | http.postBuffer:: |
| 1227 | Maximum size in bytes of the buffer used by smart HTTP |
| 1228 | transports when POSTing data to the remote system. |
| 1229 | For requests larger than this buffer size, HTTP/1.1 and |
| 1230 | Transfer-Encoding: chunked is used to avoid creating a |
| 1231 | massive pack file locally. Default is 1 MiB, which is |
| 1232 | sufficient for most requests. |
| 1233 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1234 | http.lowSpeedLimit, http.lowSpeedTime:: |
| 1235 | If the HTTP transfer speed is less than 'http.lowSpeedLimit' |
| 1236 | for longer than 'http.lowSpeedTime' seconds, the transfer is aborted. |
Horst H. von Brand | abda1ef | 2006-06-03 16:27:26 -0400 | [diff] [blame] | 1237 | Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1238 | 'GIT_HTTP_LOW_SPEED_TIME' environment variables. |
| 1239 | |
Sasha Khapyorsky | 3ea099d | 2006-09-29 03:10:44 +0300 | [diff] [blame] | 1240 | http.noEPSV:: |
| 1241 | A boolean which disables using of EPSV ftp command by curl. |
Frank Lichtenheld | befc9c4 | 2007-04-13 18:02:33 +0200 | [diff] [blame] | 1242 | This can helpful with some "poor" ftp servers which don't |
Sasha Khapyorsky | 3ea099d | 2006-09-29 03:10:44 +0300 | [diff] [blame] | 1243 | support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV' |
| 1244 | environment variable. Default is false (curl will use EPSV). |
| 1245 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1246 | i18n.commitEncoding:: |
| 1247 | Character encoding the commit messages are stored in; git itself |
| 1248 | does not care per se, but this information is necessary e.g. when |
| 1249 | importing commits from emails or in the gitk graphical history |
| 1250 | browser (and possibly at other places in the future or in other |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1251 | porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1252 | |
Junio C Hamano | d2c11a3 | 2006-12-27 16:41:33 -0800 | [diff] [blame] | 1253 | i18n.logOutputEncoding:: |
| 1254 | Character encoding the commit messages are converted to when |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 1255 | running 'git log' and friends. |
Junio C Hamano | d2c11a3 | 2006-12-27 16:41:33 -0800 | [diff] [blame] | 1256 | |
Matt McCutchen | b0f34c3 | 2008-11-26 03:26:50 -0500 | [diff] [blame] | 1257 | imap:: |
| 1258 | The configuration variables in the 'imap' section are described |
| 1259 | in linkgit:git-imap-send[1]. |
| 1260 | |
Steven Drake | d8a8488 | 2010-02-17 12:44:46 +1300 | [diff] [blame] | 1261 | init.templatedir:: |
| 1262 | Specify the directory from which templates will be copied. |
| 1263 | (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].) |
| 1264 | |
Christian Couder | 983a9ee | 2008-01-08 04:55:14 +0100 | [diff] [blame] | 1265 | instaweb.browser:: |
| 1266 | Specify the program that will be used to browse your working |
| 1267 | repository in gitweb. See linkgit:git-instaweb[1]. |
| 1268 | |
| 1269 | instaweb.httpd:: |
| 1270 | The HTTP daemon command-line to start gitweb on your working |
| 1271 | repository. See linkgit:git-instaweb[1]. |
| 1272 | |
| 1273 | instaweb.local:: |
| 1274 | If true the web server started by linkgit:git-instaweb[1] will |
| 1275 | be bound to the local IP (127.0.0.1). |
| 1276 | |
| 1277 | instaweb.modulepath:: |
| 1278 | The module path for an apache httpd used by linkgit:git-instaweb[1]. |
| 1279 | |
| 1280 | instaweb.port:: |
| 1281 | The port number to bind the gitweb httpd to. See |
| 1282 | linkgit:git-instaweb[1]. |
| 1283 | |
Thomas Rast | ca6ac7f | 2009-02-05 09:28:26 +0100 | [diff] [blame] | 1284 | interactive.singlekey:: |
Ori Avtalion | 57f6ec0 | 2009-08-07 17:24:21 +0300 | [diff] [blame] | 1285 | In interactive commands, allow the user to provide one-letter |
Thomas Rast | ca6ac7f | 2009-02-05 09:28:26 +0100 | [diff] [blame] | 1286 | input with a single key (i.e., without hitting enter). |
| 1287 | Currently this is used only by the `\--patch` mode of |
| 1288 | linkgit:git-add[1]. Note that this setting is silently |
| 1289 | ignored if portable keystroke input is not available. |
| 1290 | |
Heikki Orsila | dd0ffd5 | 2008-05-22 18:24:07 +0300 | [diff] [blame] | 1291 | log.date:: |
| 1292 | Set default date-time mode for the log command. Setting log.date |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 1293 | value is similar to using 'git log'\'s --date option. The value is one of the |
Heikki Orsila | dd0ffd5 | 2008-05-22 18:24:07 +0300 | [diff] [blame] | 1294 | following alternatives: {relative,local,default,iso,rfc,short}. |
| 1295 | See linkgit:git-log[1]. |
| 1296 | |
Steven Drake | eb73445 | 2010-02-17 12:39:52 +1300 | [diff] [blame] | 1297 | log.decorate:: |
| 1298 | Print out the ref names of any commits that are shown by the log |
| 1299 | command. If 'short' is specified, the ref name prefixes 'refs/heads/', |
| 1300 | 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is |
| 1301 | specified, the full ref name (including prefix) will be printed. |
| 1302 | This is the same as the log commands '--decorate' option. |
| 1303 | |
Peter Baumann | 0f03ca9 | 2006-11-23 10:36:33 +0100 | [diff] [blame] | 1304 | log.showroot:: |
| 1305 | If true, the initial commit will be shown as a big creation event. |
| 1306 | This is equivalent to a diff against an empty tree. |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1307 | Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which |
Peter Baumann | 0f03ca9 | 2006-11-23 10:36:33 +0100 | [diff] [blame] | 1308 | normally hide the root commit will now show it. True by default. |
| 1309 | |
Marius Storm-Olsen | d551a48 | 2009-02-08 15:34:27 +0100 | [diff] [blame] | 1310 | mailmap.file:: |
| 1311 | The location of an augmenting mailmap file. The default |
| 1312 | mailmap, located in the root of the repository, is loaded |
| 1313 | first, then the mailmap file pointed to by this variable. |
| 1314 | The location of the mailmap file may be in a repository |
| 1315 | subdirectory, or somewhere outside of the repository itself. |
| 1316 | See linkgit:git-shortlog[1] and linkgit:git-blame[1]. |
| 1317 | |
Christian Couder | b5578f3 | 2008-03-07 08:46:55 +0100 | [diff] [blame] | 1318 | man.viewer:: |
Christian Couder | b8322ea | 2008-03-13 06:48:46 +0100 | [diff] [blame] | 1319 | Specify the programs that may be used to display help in the |
Christian Couder | b5578f3 | 2008-03-07 08:46:55 +0100 | [diff] [blame] | 1320 | 'man' format. See linkgit:git-help[1]. |
| 1321 | |
Christian Couder | 0bb6400 | 2008-04-25 08:25:35 +0200 | [diff] [blame] | 1322 | man.<tool>.cmd:: |
| 1323 | Specify the command to invoke the specified man viewer. The |
| 1324 | specified command is evaluated in shell with the man page |
| 1325 | passed as argument. (See linkgit:git-help[1].) |
| 1326 | |
Christian Couder | 7e8114c | 2008-04-25 08:24:41 +0200 | [diff] [blame] | 1327 | man.<tool>.path:: |
| 1328 | Override the path for the given tool that may be used to |
| 1329 | display help in the 'man' format. See linkgit:git-help[1]. |
| 1330 | |
Matt McCutchen | b0f34c3 | 2008-11-26 03:26:50 -0500 | [diff] [blame] | 1331 | include::merge-config.txt[] |
Junio C Hamano | b541248 | 2008-08-29 10:49:56 -0700 | [diff] [blame] | 1332 | |
Johannes Schindelin | 77680ca | 2007-12-17 12:21:22 +0000 | [diff] [blame] | 1333 | mergetool.<tool>.path:: |
| 1334 | Override the path for the given tool. This is useful in case |
| 1335 | your tool is not in the PATH. |
| 1336 | |
Charles Bailey | 964473a | 2008-02-21 23:31:12 +0000 | [diff] [blame] | 1337 | mergetool.<tool>.cmd:: |
| 1338 | Specify the command to invoke the specified merge tool. The |
| 1339 | specified command is evaluated in shell with the following |
| 1340 | variables available: 'BASE' is the name of a temporary file |
| 1341 | containing the common base of the files to be merged, if available; |
| 1342 | 'LOCAL' is the name of a temporary file containing the contents of |
| 1343 | the file on the current branch; 'REMOTE' is the name of a temporary |
| 1344 | file containing the contents of the file from the branch being |
| 1345 | merged; 'MERGED' contains the name of the file to which the merge |
| 1346 | tool should write the results of a successful merge. |
| 1347 | |
| 1348 | mergetool.<tool>.trustExitCode:: |
| 1349 | For a custom merge command, specify whether the exit code of |
| 1350 | the merge command can be used to determine whether the merge was |
| 1351 | successful. If this is not set to true then the merge target file |
| 1352 | timestamp is checked and the merge assumed to have been successful |
| 1353 | if the file has been updated, otherwise the user is prompted to |
| 1354 | indicate the success of the merge. |
| 1355 | |
Charles Bailey | 44c36d1 | 2008-02-21 23:30:02 +0000 | [diff] [blame] | 1356 | mergetool.keepBackup:: |
| 1357 | After performing a merge, the original file with conflict markers |
| 1358 | can be saved as a file with a `.orig` extension. If this variable |
| 1359 | is set to `false` then this file is not preserved. Defaults to |
| 1360 | `true` (i.e. keep the backup files). |
| 1361 | |
Charles Bailey | 162eba8 | 2008-12-12 21:48:41 +0000 | [diff] [blame] | 1362 | mergetool.keepTemporaries:: |
| 1363 | When invoking a custom merge tool, git uses a set of temporary |
| 1364 | files to pass to the tool. If the tool returns an error and this |
| 1365 | variable is set to `true`, then these temporary files will be |
| 1366 | preserved, otherwise they will be removed after the tool has |
| 1367 | exited. Defaults to `false`. |
| 1368 | |
Charles Bailey | 682b451 | 2008-11-13 12:41:14 +0000 | [diff] [blame] | 1369 | mergetool.prompt:: |
| 1370 | Prompt before each invocation of the merge resolution program. |
| 1371 | |
Thomas Rast | 894a9d3 | 2010-03-12 18:04:26 +0100 | [diff] [blame] | 1372 | notes.displayRef:: |
| 1373 | The (fully qualified) refname from which to show notes when |
| 1374 | showing commit messages. The value of this variable can be set |
| 1375 | to a glob, in which case notes from all matching refs will be |
| 1376 | shown. You may also specify this configuration variable |
| 1377 | several times. A warning will be issued for refs that do not |
| 1378 | exist, but a glob that does not match any refs is silently |
| 1379 | ignored. |
| 1380 | + |
| 1381 | This setting can be overridden with the `GIT_NOTES_DISPLAY_REF` |
| 1382 | environment variable, which must be a colon separated list of refs or |
| 1383 | globs. |
| 1384 | + |
| 1385 | The effective value of "core.notesRef" (possibly overridden by |
| 1386 | GIT_NOTES_REF) is also implicitly added to the list of refs to be |
| 1387 | displayed. |
| 1388 | |
Thomas Rast | 6956f85 | 2010-03-12 18:04:32 +0100 | [diff] [blame] | 1389 | notes.rewrite.<command>:: |
| 1390 | When rewriting commits with <command> (currently `amend` or |
| 1391 | `rebase`) and this variable is set to `true`, git |
| 1392 | automatically copies your notes from the original to the |
| 1393 | rewritten commit. Defaults to `true`, but see |
| 1394 | "notes.rewriteRef" below. |
Thomas Rast | 6956f85 | 2010-03-12 18:04:32 +0100 | [diff] [blame] | 1395 | |
| 1396 | notes.rewriteMode:: |
| 1397 | When copying notes during a rewrite (see the |
| 1398 | "notes.rewrite.<command>" option), determines what to do if |
| 1399 | the target commit already has a note. Must be one of |
| 1400 | `overwrite`, `concatenate`, or `ignore`. Defaults to |
| 1401 | `concatenate`. |
| 1402 | + |
| 1403 | This setting can be overridden with the `GIT_NOTES_REWRITE_MODE` |
| 1404 | environment variable. |
| 1405 | |
| 1406 | notes.rewriteRef:: |
| 1407 | When copying notes during a rewrite, specifies the (fully |
| 1408 | qualified) ref whose notes should be copied. The ref may be a |
| 1409 | glob, in which case notes in all matching refs will be copied. |
| 1410 | You may also specify this configuration several times. |
| 1411 | + |
| 1412 | Does not have a default value; you must configure this variable to |
| 1413 | enable note rewriting. |
Leif Arne Storset | cfb88e9 | 2010-05-05 16:16:25 +0200 | [diff] [blame] | 1414 | + |
| 1415 | This setting can be overridden with the `GIT_NOTES_REWRITE_REF` |
| 1416 | environment variable, which must be a colon separated list of refs or |
| 1417 | globs. |
Thomas Rast | 6956f85 | 2010-03-12 18:04:32 +0100 | [diff] [blame] | 1418 | |
Jeff King | 4812a93 | 2006-07-23 01:50:30 -0400 | [diff] [blame] | 1419 | pack.window:: |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1420 | The size of the window used by linkgit:git-pack-objects[1] when no |
Jeff King | 4812a93 | 2006-07-23 01:50:30 -0400 | [diff] [blame] | 1421 | window size is given on the command line. Defaults to 10. |
| 1422 | |
Theodore Ts'o | 842aaf9 | 2007-05-08 09:28:26 -0400 | [diff] [blame] | 1423 | pack.depth:: |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1424 | The maximum delta depth used by linkgit:git-pack-objects[1] when no |
Theodore Ts'o | 618e613 | 2007-05-08 09:28:26 -0400 | [diff] [blame] | 1425 | maximum depth is given on the command line. Defaults to 50. |
Theodore Ts'o | 842aaf9 | 2007-05-08 09:28:26 -0400 | [diff] [blame] | 1426 | |
Brian Downing | e93b15c | 2007-07-12 07:55:52 -0500 | [diff] [blame] | 1427 | pack.windowMemory:: |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1428 | The window memory size limit used by linkgit:git-pack-objects[1] |
Brian Downing | e93b15c | 2007-07-12 07:55:52 -0500 | [diff] [blame] | 1429 | when no limit is given on the command line. The value can be |
| 1430 | suffixed with "k", "m", or "g". Defaults to 0, meaning no |
| 1431 | limit. |
| 1432 | |
Dana How | 960ccca | 2007-05-09 13:56:50 -0700 | [diff] [blame] | 1433 | pack.compression:: |
| 1434 | An integer -1..9, indicating the compression level for objects |
| 1435 | in a pack file. -1 is the zlib default. 0 means no |
| 1436 | compression, and 1..9 are various speed/size tradeoffs, 9 being |
| 1437 | slowest. If not set, defaults to core.compression. If that is |
Brian Downing | dec9230 | 2007-11-19 10:58:51 -0600 | [diff] [blame] | 1438 | not set, defaults to -1, the zlib default, which is "a default |
| 1439 | compromise between speed and compression (currently equivalent |
| 1440 | to level 6)." |
Dana How | 960ccca | 2007-05-09 13:56:50 -0700 | [diff] [blame] | 1441 | |
Martin Koegler | 074b2ee | 2007-05-28 23:20:58 +0200 | [diff] [blame] | 1442 | pack.deltaCacheSize:: |
Brian Hetro | 0278307 | 2007-08-23 20:44:13 -0400 | [diff] [blame] | 1443 | The maximum memory in bytes used for caching deltas in |
Nicolas Pitre | 5749b0b | 2009-08-05 16:55:07 -0400 | [diff] [blame] | 1444 | linkgit:git-pack-objects[1] before writing them out to a pack. |
| 1445 | This cache is used to speed up the writing object phase by not |
| 1446 | having to recompute the final delta result once the best match |
| 1447 | for all objects is found. Repacking large repositories on machines |
| 1448 | which are tight with memory might be badly impacted by this though, |
| 1449 | especially if this cache pushes the system into swapping. |
| 1450 | A value of 0 means no limit. The smallest size of 1 byte may be |
| 1451 | used to virtually disable this cache. Defaults to 256 MiB. |
Martin Koegler | 074b2ee | 2007-05-28 23:20:58 +0200 | [diff] [blame] | 1452 | |
Martin Koegler | e3dfddb | 2007-05-28 23:20:59 +0200 | [diff] [blame] | 1453 | pack.deltaCacheLimit:: |
Nicolas Pitre | 693b86f | 2007-09-10 11:51:34 -0400 | [diff] [blame] | 1454 | The maximum size of a delta, that is cached in |
Nicolas Pitre | 5749b0b | 2009-08-05 16:55:07 -0400 | [diff] [blame] | 1455 | linkgit:git-pack-objects[1]. This cache is used to speed up the |
| 1456 | writing object phase by not having to recompute the final delta |
| 1457 | result once the best match for all objects is found. Defaults to 1000. |
Martin Koegler | e3dfddb | 2007-05-28 23:20:59 +0200 | [diff] [blame] | 1458 | |
Nicolas Pitre | 693b86f | 2007-09-10 11:51:34 -0400 | [diff] [blame] | 1459 | pack.threads:: |
| 1460 | Specifies the number of threads to spawn when searching for best |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1461 | delta matches. This requires that linkgit:git-pack-objects[1] |
Nicolas Pitre | 693b86f | 2007-09-10 11:51:34 -0400 | [diff] [blame] | 1462 | be compiled with pthreads otherwise this option is ignored with a |
| 1463 | warning. This is meant to reduce packing time on multiprocessor |
| 1464 | machines. The required amount of memory for the delta search window |
| 1465 | is however multiplied by the number of threads. |
Andreas Ericsson | 833e3df | 2008-02-22 20:11:56 -0600 | [diff] [blame] | 1466 | Specifying 0 will cause git to auto-detect the number of CPU's |
| 1467 | and set the number of threads accordingly. |
Nicolas Pitre | 693b86f | 2007-09-10 11:51:34 -0400 | [diff] [blame] | 1468 | |
Nicolas Pitre | 4d00bda | 2007-11-01 23:26:04 -0400 | [diff] [blame] | 1469 | pack.indexVersion:: |
| 1470 | Specify the default pack index version. Valid values are 1 for |
| 1471 | legacy pack index used by Git versions prior to 1.5.2, and 2 for |
| 1472 | the new pack index with capabilities for packs larger than 4 GB |
| 1473 | as well as proper protection against the repacking of corrupted |
Nicolas Pitre | c0a5e2d | 2008-06-25 00:25:53 -0400 | [diff] [blame] | 1474 | packs. Version 2 is the default. Note that version 2 is enforced |
| 1475 | and this config option ignored whenever the corresponding pack is |
| 1476 | larger than 2 GB. |
| 1477 | + |
| 1478 | If you have an old git that does not understand the version 2 `{asterisk}.idx` file, |
| 1479 | cloning or fetching over a non native protocol (e.g. "http" and "rsync") |
| 1480 | that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the |
| 1481 | other side may give you a repository that cannot be accessed with your |
| 1482 | older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however, |
| 1483 | you can use linkgit:git-index-pack[1] on the *.pack file to regenerate |
| 1484 | the `{asterisk}.idx` file. |
Nicolas Pitre | 4d00bda | 2007-11-01 23:26:04 -0400 | [diff] [blame] | 1485 | |
Junio C Hamano | dbdbfec | 2008-03-12 23:11:15 -0700 | [diff] [blame] | 1486 | pack.packSizeLimit:: |
Nicolas Pitre | 07cf0f2 | 2010-02-03 22:48:28 -0500 | [diff] [blame] | 1487 | The maximum size of a pack. This setting only affects |
| 1488 | packing to a file when repacking, i.e. the git:// protocol |
| 1489 | is unaffected. It can be overridden by the `\--max-pack-size` |
| 1490 | option of linkgit:git-repack[1]. The minimum size allowed is |
| 1491 | limited to 1 MiB. The default is unlimited. |
| 1492 | Common unit suffixes of 'k', 'm', or 'g' are |
| 1493 | supported. |
Johannes Schindelin | 2b84b5a | 2008-02-05 14:25:04 +0000 | [diff] [blame] | 1494 | |
Miklos Vajna | 4370c2d | 2008-08-16 04:14:33 +0200 | [diff] [blame] | 1495 | pager.<cmd>:: |
Jonathan Nieder | 3281808 | 2008-08-24 00:38:06 -0500 | [diff] [blame] | 1496 | Allows turning on or off pagination of the output of a |
| 1497 | particular git subcommand when writing to a tty. If |
| 1498 | `\--paginate` or `\--no-pager` is specified on the command line, |
| 1499 | it takes precedence over this option. To disable pagination for |
Chris Johnsen | dcb1126 | 2009-03-15 06:30:52 -0500 | [diff] [blame] | 1500 | all commands, set `core.pager` or `GIT_PAGER` to `cat`. |
Miklos Vajna | 4370c2d | 2008-08-16 04:14:33 +0200 | [diff] [blame] | 1501 | |
Will Palmer | 8028184 | 2010-05-02 12:00:44 +0100 | [diff] [blame] | 1502 | pretty.<name>:: |
| 1503 | Alias for a --pretty= format string, as specified in |
| 1504 | linkgit:git-log[1]. Any aliases defined here can be used just |
| 1505 | as the built-in pretty formats could. For example, |
| 1506 | running `git config pretty.changelog "format:{asterisk} %H %s"` |
| 1507 | would cause the invocation `git log --pretty=changelog` |
| 1508 | to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`. |
| 1509 | Note that an alias with the same name as a built-in format |
| 1510 | will be silently ignored. |
| 1511 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1512 | pull.octopus:: |
| 1513 | The default merge strategy to use when pulling multiple branches |
| 1514 | at once. |
| 1515 | |
| 1516 | pull.twohead:: |
| 1517 | The default merge strategy to use when pulling a single branch. |
| 1518 | |
Finn Arne Gangstad | 5215374 | 2009-03-16 16:42:51 +0100 | [diff] [blame] | 1519 | push.default:: |
| 1520 | Defines the action git push should take if no refspec is given |
| 1521 | on the command line, no refspec is configured in the remote, and |
| 1522 | no refspec is implied by any of the options given on the command |
Santi Béjar | 01eadaf | 2009-03-30 12:11:41 +0200 | [diff] [blame] | 1523 | line. Possible values are: |
Finn Arne Gangstad | 5215374 | 2009-03-16 16:42:51 +0100 | [diff] [blame] | 1524 | + |
| 1525 | * `nothing` do not push anything. |
Santi Béjar | 01eadaf | 2009-03-30 12:11:41 +0200 | [diff] [blame] | 1526 | * `matching` push all matching branches. |
Finn Arne Gangstad | 5215374 | 2009-03-16 16:42:51 +0100 | [diff] [blame] | 1527 | All branches having the same name in both ends are considered to be |
Santi Béjar | 01eadaf | 2009-03-30 12:11:41 +0200 | [diff] [blame] | 1528 | matching. This is the default. |
Santi Béjar | e892dc7 | 2009-04-07 01:24:30 +0200 | [diff] [blame] | 1529 | * `tracking` push the current branch to its upstream branch. |
Santi Béjar | 01eadaf | 2009-03-30 12:11:41 +0200 | [diff] [blame] | 1530 | * `current` push the current branch to a branch of the same name. |
Finn Arne Gangstad | 5215374 | 2009-03-16 16:42:51 +0100 | [diff] [blame] | 1531 | |
Tor Arne Vestbø | a9c3821 | 2009-03-01 23:11:38 +0100 | [diff] [blame] | 1532 | rebase.stat:: |
| 1533 | Whether to show a diffstat of what changed upstream since the last |
| 1534 | rebase. False by default. |
| 1535 | |
Junio C Hamano | 77e3efb | 2009-10-20 14:56:40 -0700 | [diff] [blame] | 1536 | receive.autogc:: |
| 1537 | By default, git-receive-pack will run "git-gc --auto" after |
| 1538 | receiving data from git-push and updating refs. You can stop |
| 1539 | it by setting this variable to false. |
| 1540 | |
Matt McCutchen | b0f34c3 | 2008-11-26 03:26:50 -0500 | [diff] [blame] | 1541 | receive.fsckObjects:: |
| 1542 | If it is set to true, git-receive-pack will check all received |
| 1543 | objects. It will abort in the case of a malformed object or a |
| 1544 | broken link. The result of an abort are only dangling objects. |
| 1545 | Defaults to false. |
| 1546 | |
| 1547 | receive.unpackLimit:: |
| 1548 | If the number of objects received in a push is below this |
| 1549 | limit then the objects will be unpacked into loose object |
| 1550 | files. However if the number of received objects equals or |
| 1551 | exceeds this limit then the received pack will be stored as |
| 1552 | a pack, after adding any missing delta bases. Storing the |
| 1553 | pack from a push can make the push operation complete faster, |
| 1554 | especially on slow filesystems. If not set, the value of |
| 1555 | `transfer.unpackLimit` is used instead. |
| 1556 | |
Junio C Hamano | 42fc11c | 2008-11-26 11:11:18 -0800 | [diff] [blame] | 1557 | receive.denyDeletes:: |
| 1558 | If set to true, git-receive-pack will deny a ref update that deletes |
| 1559 | the ref. Use this to prevent such a ref deletion via a push. |
| 1560 | |
| 1561 | receive.denyCurrentBranch:: |
Michael J Gruber | f3838ce | 2010-05-13 14:51:38 +0200 | [diff] [blame] | 1562 | If set to true or "refuse", git-receive-pack will deny a ref update |
Junio C Hamano | 42fc11c | 2008-11-26 11:11:18 -0800 | [diff] [blame] | 1563 | to the currently checked out branch of a non-bare repository. |
| 1564 | Such a push is potentially dangerous because it brings the HEAD |
| 1565 | out of sync with the index and working tree. If set to "warn", |
| 1566 | print a warning of such a push to stderr, but allow the push to |
| 1567 | proceed. If set to false or "ignore", allow such pushes with no |
Thomas Rast | 7d182f5 | 2010-03-17 12:14:57 +0100 | [diff] [blame] | 1568 | message. Defaults to "refuse". |
Junio C Hamano | 42fc11c | 2008-11-26 11:11:18 -0800 | [diff] [blame] | 1569 | |
Matt McCutchen | b0f34c3 | 2008-11-26 03:26:50 -0500 | [diff] [blame] | 1570 | receive.denyNonFastForwards:: |
| 1571 | If set to true, git-receive-pack will deny a ref update which is |
Felipe Contreras | a75d7b5 | 2009-10-24 11:31:32 +0300 | [diff] [blame] | 1572 | not a fast-forward. Use this to prevent such an update via a push, |
Matt McCutchen | b0f34c3 | 2008-11-26 03:26:50 -0500 | [diff] [blame] | 1573 | even if that push is forced. This configuration variable is |
| 1574 | set when initializing a shared repository. |
| 1575 | |
Junio C Hamano | 77e3efb | 2009-10-20 14:56:40 -0700 | [diff] [blame] | 1576 | receive.updateserverinfo:: |
| 1577 | If set to true, git-receive-pack will run git-update-server-info |
| 1578 | after receiving data from git-push and updating refs. |
| 1579 | |
Santi Béjar | 0cc6d34 | 2006-10-23 18:42:14 +0200 | [diff] [blame] | 1580 | remote.<name>.url:: |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1581 | The URL of a remote repository. See linkgit:git-fetch[1] or |
| 1582 | linkgit:git-push[1]. |
Santi Béjar | 0cc6d34 | 2006-10-23 18:42:14 +0200 | [diff] [blame] | 1583 | |
Michael J Gruber | 2034623 | 2009-06-09 18:01:34 +0200 | [diff] [blame] | 1584 | remote.<name>.pushurl:: |
| 1585 | The push URL of a remote repository. See linkgit:git-push[1]. |
| 1586 | |
Sam Vilain | 14c9821 | 2007-12-04 10:48:54 +1300 | [diff] [blame] | 1587 | remote.<name>.proxy:: |
| 1588 | For remotes that require curl (http, https and ftp), the URL to |
| 1589 | the proxy to use for that remote. Set to the empty string to |
| 1590 | disable proxying for that remote. |
| 1591 | |
Santi Béjar | 0cc6d34 | 2006-10-23 18:42:14 +0200 | [diff] [blame] | 1592 | remote.<name>.fetch:: |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1593 | The default set of "refspec" for linkgit:git-fetch[1]. See |
| 1594 | linkgit:git-fetch[1]. |
Santi Béjar | 0cc6d34 | 2006-10-23 18:42:14 +0200 | [diff] [blame] | 1595 | |
| 1596 | remote.<name>.push:: |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1597 | The default set of "refspec" for linkgit:git-push[1]. See |
| 1598 | linkgit:git-push[1]. |
Santi Béjar | 0cc6d34 | 2006-10-23 18:42:14 +0200 | [diff] [blame] | 1599 | |
Paolo Bonzini | 84bb2df | 2008-04-17 13:17:20 +0200 | [diff] [blame] | 1600 | remote.<name>.mirror:: |
| 1601 | If true, pushing to this remote will automatically behave |
| 1602 | as if the `\--mirror` option was given on the command line. |
| 1603 | |
Theodore Ts'o | 1918278 | 2007-02-20 15:13:43 -0500 | [diff] [blame] | 1604 | remote.<name>.skipDefaultUpdate:: |
| 1605 | If true, this remote will be skipped by default when updating |
Björn Gustavsson | 7cc91a2 | 2009-11-09 21:11:06 +0100 | [diff] [blame] | 1606 | using linkgit:git-fetch[1] or the `update` subcommand of |
| 1607 | linkgit:git-remote[1]. |
| 1608 | |
| 1609 | remote.<name>.skipFetchAll:: |
| 1610 | If true, this remote will be skipped by default when updating |
| 1611 | using linkgit:git-fetch[1] or the `update` subcommand of |
| 1612 | linkgit:git-remote[1]. |
Theodore Ts'o | 1918278 | 2007-02-20 15:13:43 -0500 | [diff] [blame] | 1613 | |
Uwe Kleine-König | 060aafc | 2007-01-19 13:46:16 +0100 | [diff] [blame] | 1614 | remote.<name>.receivepack:: |
Uwe Kleine-König | 5dee29a | 2007-01-25 05:45:39 +0100 | [diff] [blame] | 1615 | The default program to execute on the remote side when pushing. See |
Uwe Kleine-König | 79f43f3 | 2008-03-06 21:28:07 +0100 | [diff] [blame] | 1616 | option \--receive-pack of linkgit:git-push[1]. |
Uwe Kleine-König | 060aafc | 2007-01-19 13:46:16 +0100 | [diff] [blame] | 1617 | |
Uwe Kleine-König | 5dee29a | 2007-01-25 05:45:39 +0100 | [diff] [blame] | 1618 | remote.<name>.uploadpack:: |
| 1619 | The default program to execute on the remote side when fetching. See |
Uwe Kleine-König | 79f43f3 | 2008-03-06 21:28:07 +0100 | [diff] [blame] | 1620 | option \--upload-pack of linkgit:git-fetch-pack[1]. |
Uwe Kleine-König | 5dee29a | 2007-01-25 05:45:39 +0100 | [diff] [blame] | 1621 | |
Aneesh Kumar K.V | 047f636 | 2007-02-24 21:02:56 +0530 | [diff] [blame] | 1622 | remote.<name>.tagopt:: |
Uwe Kleine-König | 79f43f3 | 2008-03-06 21:28:07 +0100 | [diff] [blame] | 1623 | Setting this value to \--no-tags disables automatic tag following when |
Samuel Tardieu | 944163a | 2010-04-20 01:31:25 +0200 | [diff] [blame] | 1624 | fetching from remote <name>. Setting it to \--tags will fetch every |
| 1625 | tag from remote <name>, even if they are not reachable from remote |
| 1626 | branch heads. |
Aneesh Kumar K.V | 047f636 | 2007-02-24 21:02:56 +0530 | [diff] [blame] | 1627 | |
Daniel Barkalow | c578f51 | 2009-11-18 02:42:25 +0100 | [diff] [blame] | 1628 | remote.<name>.vcs:: |
| 1629 | Setting this to a value <vcs> will cause git to interact with |
| 1630 | the remote with the git-remote-<vcs> helper. |
| 1631 | |
Theodore Ts'o | 1918278 | 2007-02-20 15:13:43 -0500 | [diff] [blame] | 1632 | remotes.<group>:: |
| 1633 | The list of remotes which are fetched by "git remote update |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1634 | <group>". See linkgit:git-remote[1]. |
Theodore Ts'o | 1918278 | 2007-02-20 15:13:43 -0500 | [diff] [blame] | 1635 | |
Junio C Hamano | b6945f5 | 2006-10-13 21:28:58 -0700 | [diff] [blame] | 1636 | repack.usedeltabaseoffset:: |
Nicolas Pitre | 22c79ea | 2008-06-25 00:24:53 -0400 | [diff] [blame] | 1637 | By default, linkgit:git-repack[1] creates packs that use |
| 1638 | delta-base offset. If you need to share your repository with |
| 1639 | git older than version 1.4.4, either directly or via a dumb |
| 1640 | protocol such as http, then you need to set this option to |
| 1641 | "false" and repack. Access from old git versions over the |
| 1642 | native protocol are unaffected by this option. |
Junio C Hamano | b6945f5 | 2006-10-13 21:28:58 -0700 | [diff] [blame] | 1643 | |
Matt McCutchen | b0f34c3 | 2008-11-26 03:26:50 -0500 | [diff] [blame] | 1644 | rerere.autoupdate:: |
| 1645 | When set to true, `git-rerere` updates the index with the |
| 1646 | resulting contents after it cleanly resolves conflicts using |
| 1647 | previously recorded resolution. Defaults to false. |
| 1648 | |
| 1649 | rerere.enabled:: |
| 1650 | Activate recording of resolved conflicts, so that identical |
| 1651 | conflict hunks can be resolved automatically, should they |
| 1652 | be encountered again. linkgit:git-rerere[1] command is by |
| 1653 | default enabled if you create `rr-cache` directory under |
| 1654 | `$GIT_DIR`, but can be disabled by setting this option to false. |
| 1655 | |
Yann Dirson | 65180c6 | 2009-07-22 23:39:30 +0200 | [diff] [blame] | 1656 | sendemail.identity:: |
| 1657 | A configuration identity. When given, causes values in the |
| 1658 | 'sendemail.<identity>' subsection to take precedence over |
| 1659 | values in the 'sendemail' section. The default identity is |
| 1660 | the value of 'sendemail.identity'. |
| 1661 | |
| 1662 | sendemail.smtpencryption:: |
| 1663 | See linkgit:git-send-email[1] for description. Note that this |
| 1664 | setting is not subject to the 'identity' mechanism. |
| 1665 | |
| 1666 | sendemail.smtpssl:: |
| 1667 | Deprecated alias for 'sendemail.smtpencryption = ssl'. |
| 1668 | |
| 1669 | sendemail.<identity>.*:: |
| 1670 | Identity-specific versions of the 'sendemail.*' parameters |
| 1671 | found below, taking precedence over those when the this |
| 1672 | identity is selected, through command-line or |
| 1673 | 'sendemail.identity'. |
| 1674 | |
| 1675 | sendemail.aliasesfile:: |
| 1676 | sendemail.aliasfiletype:: |
| 1677 | sendemail.bcc:: |
| 1678 | sendemail.cc:: |
| 1679 | sendemail.cccmd:: |
| 1680 | sendemail.chainreplyto:: |
| 1681 | sendemail.confirm:: |
| 1682 | sendemail.envelopesender:: |
| 1683 | sendemail.from:: |
| 1684 | sendemail.multiedit:: |
| 1685 | sendemail.signedoffbycc:: |
| 1686 | sendemail.smtppass:: |
| 1687 | sendemail.suppresscc:: |
| 1688 | sendemail.suppressfrom:: |
| 1689 | sendemail.to:: |
Brian Gernhardt | 69cf7bf | 2010-04-10 10:53:56 -0400 | [diff] [blame] | 1690 | sendemail.smtpdomain:: |
Yann Dirson | 65180c6 | 2009-07-22 23:39:30 +0200 | [diff] [blame] | 1691 | sendemail.smtpserver:: |
| 1692 | sendemail.smtpserverport:: |
| 1693 | sendemail.smtpuser:: |
| 1694 | sendemail.thread:: |
| 1695 | sendemail.validate:: |
| 1696 | See linkgit:git-send-email[1] for description. |
| 1697 | |
| 1698 | sendemail.signedoffcc:: |
| 1699 | Deprecated alias for 'sendemail.signedoffbycc'. |
| 1700 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1701 | showbranch.default:: |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1702 | The default set of branches for linkgit:git-show-branch[1]. |
| 1703 | See linkgit:git-show-branch[1]. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1704 | |
Jeff King | 46f721c | 2007-12-07 16:26:07 -0500 | [diff] [blame] | 1705 | status.relativePaths:: |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1706 | By default, linkgit:git-status[1] shows paths relative to the |
Jeff King | 46f721c | 2007-12-07 16:26:07 -0500 | [diff] [blame] | 1707 | current directory. Setting this variable to `false` shows paths |
| 1708 | relative to the repository root (this was the default for git |
| 1709 | prior to v1.5.4). |
| 1710 | |
Marius Storm-Olsen | d6293d1 | 2008-06-05 14:47:50 +0200 | [diff] [blame] | 1711 | status.showUntrackedFiles:: |
| 1712 | By default, linkgit:git-status[1] and linkgit:git-commit[1] show |
| 1713 | files which are not currently tracked by Git. Directories which |
| 1714 | contain only untracked files, are shown with the directory name |
| 1715 | only. Showing untracked files means that Git needs to lstat() all |
| 1716 | all the files in the whole repository, which might be slow on some |
| 1717 | systems. So, this variable controls how the commands displays |
| 1718 | the untracked files. Possible values are: |
| 1719 | + |
| 1720 | -- |
| 1721 | - 'no' - Show no untracked files |
| 1722 | - 'normal' - Shows untracked files and directories |
| 1723 | - 'all' - Shows also individual files in untracked directories. |
| 1724 | -- |
| 1725 | + |
| 1726 | If this variable is not specified, it defaults to 'normal'. |
| 1727 | This variable can be overridden with the -u|--untracked-files option |
| 1728 | of linkgit:git-status[1] and linkgit:git-commit[1]. |
| 1729 | |
Michael J Gruber | 4b2343f | 2010-05-20 17:55:42 +0200 | [diff] [blame] | 1730 | status.submodulesummary:: |
| 1731 | Defaults to false. |
| 1732 | If this is set to a non zero number or true (identical to -1 or an |
| 1733 | unlimited number), the submodule summary will be enabled and a |
| 1734 | summary of commits for modified submodules will be shown (see |
| 1735 | --summary-limit option of linkgit:git-submodule[1]). |
| 1736 | |
Jonathan Nieder | 0ad0a61 | 2010-07-15 02:51:19 -0500 | [diff] [blame] | 1737 | submodule.<name>.path:: |
| 1738 | submodule.<name>.url:: |
| 1739 | submodule.<name>.update:: |
| 1740 | The path within this project, URL, and the updating strategy |
| 1741 | for a submodule. These variables are initially populated |
| 1742 | by 'git submodule init'; edit them to override the |
| 1743 | URL and other values found in the `.gitmodules` file. See |
| 1744 | linkgit:git-submodule[1] and linkgit:gitmodules[5] for details. |
| 1745 | |
Jens Lehmann | aee9c7d | 2010-08-06 00:39:25 +0200 | [diff] [blame^] | 1746 | submodule.<name>.ignore:: |
| 1747 | Defines under what circumstances "git status" and the diff family show |
| 1748 | a submodule as modified. When set to "all", it will never be considered |
| 1749 | modified, "dirty" will ignore all changes to the submodules work tree and |
| 1750 | takes only differences between the HEAD of the submodule and the commit |
| 1751 | recorded in the superproject into account. "untracked" will additionally |
| 1752 | let submodules with modified tracked files in their work tree show up. |
| 1753 | Using "none" (the default when this option is not set) also shows |
| 1754 | submodules that have untracked files in their work tree as changed. |
| 1755 | |
Willy Tarreau | ce1a79b | 2006-07-20 11:30:44 +0200 | [diff] [blame] | 1756 | tar.umask:: |
René Scharfe | 687157c | 2007-08-21 20:01:16 +0200 | [diff] [blame] | 1757 | This variable can be used to restrict the permission bits of |
| 1758 | tar archive entries. The default is 0002, which turns off the |
| 1759 | world write bit. The special value "user" indicates that the |
| 1760 | archiving user's umask will be used instead. See umask(2) and |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1761 | linkgit:git-archive[1]. |
Willy Tarreau | ce1a79b | 2006-07-20 11:30:44 +0200 | [diff] [blame] | 1762 | |
Matt McCutchen | b0f34c3 | 2008-11-26 03:26:50 -0500 | [diff] [blame] | 1763 | transfer.unpackLimit:: |
| 1764 | When `fetch.unpackLimit` or `receive.unpackLimit` are |
| 1765 | not set, the value of this variable is used instead. |
| 1766 | The default value is 100. |
| 1767 | |
Daniel Barkalow | 55029ae | 2008-02-20 13:43:53 -0500 | [diff] [blame] | 1768 | url.<base>.insteadOf:: |
| 1769 | Any URL that starts with this value will be rewritten to |
| 1770 | start, instead, with <base>. In cases where some site serves a |
| 1771 | large number of repositories, and serves them with multiple |
| 1772 | access methods, and some users need to use different access |
| 1773 | methods, this feature allows people to specify any of the |
| 1774 | equivalent URLs and have git automatically rewrite the URL to |
| 1775 | the best alternative for the particular user, even for a |
Junio C Hamano | 844112c | 2008-02-24 22:25:04 -0800 | [diff] [blame] | 1776 | never-before-seen repository on the site. When more than one |
| 1777 | insteadOf strings match a given URL, the longest match is used. |
Daniel Barkalow | 55029ae | 2008-02-20 13:43:53 -0500 | [diff] [blame] | 1778 | |
Josh Triplett | 1c2eafb | 2009-09-07 01:56:33 -0700 | [diff] [blame] | 1779 | url.<base>.pushInsteadOf:: |
| 1780 | Any URL that starts with this value will not be pushed to; |
| 1781 | instead, it will be rewritten to start with <base>, and the |
| 1782 | resulting URL will be pushed to. In cases where some site serves |
| 1783 | a large number of repositories, and serves them with multiple |
| 1784 | access methods, some of which do not allow push, this feature |
| 1785 | allows people to specify a pull-only URL and have git |
| 1786 | automatically use an appropriate URL to push, even for a |
| 1787 | never-before-seen repository on the site. When more than one |
| 1788 | pushInsteadOf strings match a given URL, the longest match is |
| 1789 | used. If a remote has an explicit pushurl, git will ignore this |
| 1790 | setting for that remote. |
| 1791 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1792 | user.email:: |
| 1793 | Your email address to be recorded in any newly created commits. |
Josh Triplett | 28a94f8 | 2007-04-28 18:40:28 -0700 | [diff] [blame] | 1794 | Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1795 | 'EMAIL' environment variables. See linkgit:git-commit-tree[1]. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1796 | |
| 1797 | user.name:: |
| 1798 | Your full name to be recorded in any newly created commits. |
Horst H. von Brand | abda1ef | 2006-06-03 16:27:26 -0400 | [diff] [blame] | 1799 | Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME' |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1800 | environment variables. See linkgit:git-commit-tree[1]. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1801 | |
Andy Parkins | d67778e | 2007-01-26 14:13:46 +0000 | [diff] [blame] | 1802 | user.signingkey:: |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1803 | If linkgit:git-tag[1] is not selecting the key you want it to |
Andy Parkins | d67778e | 2007-01-26 14:13:46 +0000 | [diff] [blame] | 1804 | automatically when creating a signed tag, you can override the |
| 1805 | default selection with this variable. This option is passed |
| 1806 | unchanged to gpg's --local-user parameter, so you may specify a key |
| 1807 | using any method that gpg supports. |
| 1808 | |
Christian Couder | 983a9ee | 2008-01-08 04:55:14 +0100 | [diff] [blame] | 1809 | web.browser:: |
| 1810 | Specify a web browser that may be used by some commands. |
| 1811 | Currently only linkgit:git-instaweb[1] and linkgit:git-help[1] |
| 1812 | may use it. |