Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1 | CONFIGURATION FILE |
| 2 | ------------------ |
| 3 | |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 4 | The Git configuration file contains a number of variables that affect |
| 5 | the Git commands' 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 | |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 11 | The configuration variables are used by both the Git plumbing |
Stephen Boyd | b7ee226 | 2009-04-23 02:38:01 -0700 | [diff] [blame] | 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 |
Libor Pechacek | e0a4aae | 2012-03-01 11:59:45 +0100 | [diff] [blame] | 15 | dot. The variable names are case-insensitive, allow only alphanumeric |
| 16 | characters and `-`, and must start with an alphabetic character. Some |
| 17 | variables may appear multiple times. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 18 | |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [diff] [blame] | 19 | Syntax |
| 20 | ~~~~~~ |
| 21 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 22 | The syntax is fairly flexible and permissive; whitespaces are mostly |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [diff] [blame] | 23 | ignored. The '#' and ';' characters begin comments to the end of line, |
| 24 | blank lines are ignored. |
| 25 | |
| 26 | The file consists of sections and variables. A section begins with |
| 27 | the name of the section in square brackets and continues until the next |
| 28 | section begins. Section names are not case sensitive. Only alphanumeric |
Chris Johnsen | dcb1126 | 2009-03-15 06:30:52 -0500 | [diff] [blame] | 29 | characters, `-` and `.` are allowed in section names. Each variable |
Stephen Boyd | 773002a | 2009-04-23 02:38:00 -0700 | [diff] [blame] | 30 | must belong to some section, which means that there must be a section |
| 31 | header before the first setting of a variable. |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [diff] [blame] | 32 | |
| 33 | Sections can be further divided into subsections. To begin a subsection |
| 34 | 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] | 35 | in the section header, like in the example below: |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [diff] [blame] | 36 | |
| 37 | -------- |
| 38 | [section "subsection"] |
| 39 | |
| 40 | -------- |
| 41 | |
Stephen Boyd | b7ee226 | 2009-04-23 02:38:01 -0700 | [diff] [blame] | 42 | Subsection names are case sensitive and can contain any characters except |
| 43 | newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`, |
| 44 | respectively). Section headers cannot span multiple |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [diff] [blame] | 45 | lines. Variables may belong directly to a section or to a given subsection. |
| 46 | You can have `[section]` if you have `[section "subsection"]`, but you |
| 47 | don't need to. |
| 48 | |
Carlos Martín Nieto | f737632 | 2011-10-12 17:52:06 +0200 | [diff] [blame] | 49 | There is also a deprecated `[section.subsection]` syntax. With this |
| 50 | syntax, the subsection name is converted to lower-case and is also |
| 51 | compared case sensitively. These subsection names follow the same |
| 52 | restrictions as section names. |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [diff] [blame] | 53 | |
Nanako Shiraishi | 2ceb639 | 2009-07-25 09:28:50 +0900 | [diff] [blame] | 54 | All the other lines (and the remainder of the line after the section |
| 55 | header) are recognized as setting variables, in the form |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [diff] [blame] | 56 | 'name = value'. If there is no equal sign on the line, the entire line |
| 57 | is taken as 'name' and the variable is recognized as boolean "true". |
Libor Pechacek | e0a4aae | 2012-03-01 11:59:45 +0100 | [diff] [blame] | 58 | The variable names are case-insensitive, allow only alphanumeric characters |
| 59 | and `-`, and must start with an alphabetic character. There can be more |
| 60 | than one value for a given variable; we say then that the variable is |
| 61 | multivalued. |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [diff] [blame] | 62 | |
| 63 | Leading and trailing whitespace in a variable value is discarded. |
| 64 | Internal whitespace within a variable value is retained verbatim. |
| 65 | |
| 66 | The values following the equals sign in variable assign are all either |
| 67 | a string, an integer, or a boolean. Boolean values may be given as yes/no, |
Carlos Martín Nieto | 18b19e4 | 2011-03-30 12:22:32 +0200 | [diff] [blame] | 68 | 1/0, 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] | 69 | converting value to the canonical form using '--bool' type specifier; |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 70 | 'git config' will ensure that the output is "true" or "false". |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [diff] [blame] | 71 | |
| 72 | String values may be entirely or partially enclosed in double quotes. |
Stephen Boyd | 773002a | 2009-04-23 02:38:00 -0700 | [diff] [blame] | 73 | You need to enclose variable values in double quotes if you want to |
| 74 | preserve leading or trailing whitespace, or if the variable value contains |
| 75 | comment characters (i.e. it contains '#' or ';'). |
| 76 | Double quote `"` and backslash `\` characters in variable values must |
Chris Johnsen | dcb1126 | 2009-03-15 06:30:52 -0500 | [diff] [blame] | 77 | be escaped: use `\"` for `"` and `\\` for `\`. |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [diff] [blame] | 78 | |
Chris Johnsen | dcb1126 | 2009-03-15 06:30:52 -0500 | [diff] [blame] | 79 | The following escape sequences (beside `\"` and `\\`) are recognized: |
| 80 | `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) |
| 81 | and `\b` for backspace (BS). No other char escape sequence, nor octal |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [diff] [blame] | 82 | char sequences are valid. |
| 83 | |
Stephen Boyd | 773002a | 2009-04-23 02:38:00 -0700 | [diff] [blame] | 84 | 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] | 85 | customary UNIX fashion. |
| 86 | |
Stephen Boyd | 773002a | 2009-04-23 02:38:00 -0700 | [diff] [blame] | 87 | Some variables may require a special value format. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 88 | |
Jeff King | 9b25a0b | 2012-02-06 04:54:04 -0500 | [diff] [blame] | 89 | Includes |
| 90 | ~~~~~~~~ |
| 91 | |
| 92 | You can include one config file from another by setting the special |
| 93 | `include.path` variable to the name of the file to be included. The |
| 94 | included file is expanded immediately, as if its contents had been |
| 95 | found at the location of the include directive. If the value of the |
| 96 | `include.path` variable is a relative path, the path is considered to be |
| 97 | relative to the configuration file in which the include directive was |
Jeff King | 9a7b0bc | 2012-05-02 19:43:52 -0400 | [diff] [blame] | 98 | found. The value of `include.path` is subject to tilde expansion: `~/` |
| 99 | is expanded to the value of `$HOME`, and `~user/` to the specified |
Jeff King | 4c0a89f | 2012-04-25 08:00:36 -0400 | [diff] [blame] | 100 | user's home directory. See below for examples. |
Jeff King | 9b25a0b | 2012-02-06 04:54:04 -0500 | [diff] [blame] | 101 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 102 | Example |
| 103 | ~~~~~~~ |
| 104 | |
| 105 | # Core variables |
| 106 | [core] |
| 107 | ; Don't trust file modes |
| 108 | filemode = false |
| 109 | |
| 110 | # Our diff algorithm |
| 111 | [diff] |
Anders Melchiorsen | 6bb9e51 | 2008-07-27 13:12:15 +0200 | [diff] [blame] | 112 | external = /usr/local/bin/diff-wrapper |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 113 | renames = true |
| 114 | |
Aneesh Kumar K.V | 910c00c | 2006-12-07 12:06:55 +0530 | [diff] [blame] | 115 | [branch "devel"] |
| 116 | remote = origin |
| 117 | merge = refs/heads/devel |
| 118 | |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [diff] [blame] | 119 | # Proxy settings |
| 120 | [core] |
David Symonds | 29093c2 | 2007-08-03 08:45:56 +1000 | [diff] [blame] | 121 | gitProxy="ssh" for "kernel.org" |
Jakub Narebski | e136f33 | 2007-01-22 16:25:47 +0100 | [diff] [blame] | 122 | gitProxy=default-proxy ; for the rest |
Aneesh Kumar K.V | 910c00c | 2006-12-07 12:06:55 +0530 | [diff] [blame] | 123 | |
Jeff King | 9b25a0b | 2012-02-06 04:54:04 -0500 | [diff] [blame] | 124 | [include] |
| 125 | path = /path/to/foo.inc ; include by absolute path |
| 126 | path = foo ; expand "foo" relative to the current file |
Jeff King | 4c0a89f | 2012-04-25 08:00:36 -0400 | [diff] [blame] | 127 | path = ~/foo ; expand "foo" in your $HOME directory |
Jeff King | 9b25a0b | 2012-02-06 04:54:04 -0500 | [diff] [blame] | 128 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 129 | Variables |
| 130 | ~~~~~~~~~ |
| 131 | |
| 132 | Note that this list is non-comprehensive and not necessarily complete. |
Francis Daly | b8936cf | 2006-06-08 00:15:05 +0100 | [diff] [blame] | 133 | For command-specific variables, you will find a more detailed description |
| 134 | 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] | 135 | porcelain configuration variables in the respective porcelain documentation. |
| 136 | |
Jeff King | 7519443 | 2009-09-09 07:38:58 -0400 | [diff] [blame] | 137 | advice.*:: |
Junio C Hamano | 26e94af | 2011-12-18 21:35:01 -0800 | [diff] [blame] | 138 | These variables control various optional help messages designed to |
| 139 | aid new users. All 'advice.*' variables default to 'true', and you |
| 140 | can tell Git that you do not need help by setting these to 'false': |
Jeff King | 7519443 | 2009-09-09 07:38:58 -0400 | [diff] [blame] | 141 | + |
| 142 | -- |
Chris Rorvick | 1184564 | 2012-12-02 21:27:50 -0600 | [diff] [blame] | 143 | pushUpdateRejected:: |
Christopher Tiwald | f25950f | 2012-03-20 00:31:33 -0400 | [diff] [blame] | 144 | Set this variable to 'false' if you want to disable |
Chris Rorvick | b450568 | 2012-12-02 21:27:51 -0600 | [diff] [blame] | 145 | 'pushNonFFCurrent', 'pushNonFFDefault', |
Junio C Hamano | 75e5c0d | 2013-01-23 13:55:30 -0800 | [diff] [blame] | 146 | 'pushNonFFMatching', 'pushAlreadyExists', |
| 147 | 'pushFetchFirst', and 'pushNeedsForce' |
Chris Rorvick | b450568 | 2012-12-02 21:27:51 -0600 | [diff] [blame] | 148 | simultaneously. |
Christopher Tiwald | f25950f | 2012-03-20 00:31:33 -0400 | [diff] [blame] | 149 | pushNonFFCurrent:: |
| 150 | Advice shown when linkgit:git-push[1] fails due to a |
| 151 | non-fast-forward update to the current branch. |
| 152 | pushNonFFDefault:: |
| 153 | Advice to set 'push.default' to 'upstream' or 'current' |
| 154 | when you ran linkgit:git-push[1] and pushed 'matching |
| 155 | refs' by default (i.e. you did not provide an explicit |
| 156 | refspec, and no 'push.default' configuration was set) |
| 157 | and it resulted in a non-fast-forward error. |
| 158 | pushNonFFMatching:: |
| 159 | Advice shown when you ran linkgit:git-push[1] and pushed |
| 160 | 'matching refs' explicitly (i.e. you used ':', or |
| 161 | specified a refspec that isn't your current branch) and |
| 162 | it resulted in a non-fast-forward error. |
Chris Rorvick | b450568 | 2012-12-02 21:27:51 -0600 | [diff] [blame] | 163 | pushAlreadyExists:: |
| 164 | Shown when linkgit:git-push[1] rejects an update that |
| 165 | does not qualify for fast-forwarding (e.g., a tag.) |
Junio C Hamano | 75e5c0d | 2013-01-23 13:55:30 -0800 | [diff] [blame] | 166 | pushFetchFirst:: |
| 167 | Shown when linkgit:git-push[1] rejects an update that |
| 168 | tries to overwrite a remote ref that points at an |
| 169 | object we do not have. |
| 170 | pushNeedsForce:: |
| 171 | Shown when linkgit:git-push[1] rejects an update that |
| 172 | tries to overwrite a remote ref that points at an |
Richard Hansen | a8a5406 | 2013-09-04 15:04:31 -0400 | [diff] [blame] | 173 | object that is not a commit-ish, or make the remote |
| 174 | ref point at an object that is not a commit-ish. |
Jeff King | edf563f | 2009-09-09 07:43:03 -0400 | [diff] [blame] | 175 | statusHints:: |
Lucien Kong | 83c750a | 2012-06-05 22:21:24 +0200 | [diff] [blame] | 176 | Show directions on how to proceed from the current |
Matthieu Moy | 552755a | 2012-12-04 10:15:03 +0100 | [diff] [blame] | 177 | state in the output of linkgit:git-status[1], in |
Lucien Kong | 83c750a | 2012-06-05 22:21:24 +0200 | [diff] [blame] | 178 | the template shown when writing commit messages in |
Matthieu Moy | 552755a | 2012-12-04 10:15:03 +0100 | [diff] [blame] | 179 | linkgit:git-commit[1], and in the help message shown |
| 180 | by linkgit:git-checkout[1] when switching branch. |
Nguyễn Thái Ngọc Duy | 6a38ef2 | 2013-03-13 19:59:16 +0700 | [diff] [blame] | 181 | statusUoption:: |
| 182 | Advise to consider using the `-u` option to linkgit:git-status[1] |
| 183 | when the command takes more than 2 seconds to enumerate untracked |
| 184 | files. |
Matthieu Moy | 4c371f9 | 2009-11-22 23:26:17 +0100 | [diff] [blame] | 185 | commitBeforeMerge:: |
| 186 | Advice shown when linkgit:git-merge[1] refuses to |
Ville Skyttä | 6b677a2 | 2010-07-20 00:17:17 +0300 | [diff] [blame] | 187 | merge to avoid overwriting local changes. |
Matthieu Moy | d38a30d | 2010-01-12 10:54:44 +0100 | [diff] [blame] | 188 | resolveConflict:: |
Greg Price | 4f021b3 | 2013-02-25 00:27:20 -0500 | [diff] [blame] | 189 | Advice shown by various commands when conflicts |
Matthieu Moy | d38a30d | 2010-01-12 10:54:44 +0100 | [diff] [blame] | 190 | prevent the operation from being performed. |
Jeff King | b706fcf | 2010-01-13 15:17:08 -0500 | [diff] [blame] | 191 | implicitIdentity:: |
| 192 | Advice on how to set your identity configuration when |
| 193 | your information is guessed from the system username and |
Junio C Hamano | 26e94af | 2011-12-18 21:35:01 -0800 | [diff] [blame] | 194 | domain name. |
Junio C Hamano | 13be3e3 | 2010-01-29 22:03:24 -0800 | [diff] [blame] | 195 | detachedHead:: |
Junio C Hamano | 26e94af | 2011-12-18 21:35:01 -0800 | [diff] [blame] | 196 | Advice shown when you used linkgit:git-checkout[1] to |
Junio C Hamano | 13be3e3 | 2010-01-29 22:03:24 -0800 | [diff] [blame] | 197 | move to the detach HEAD state, to instruct how to create |
Junio C Hamano | 26e94af | 2011-12-18 21:35:01 -0800 | [diff] [blame] | 198 | a local branch after the fact. |
Paul Gortmaker | 14bf2d5 | 2012-07-13 11:51:30 -0400 | [diff] [blame] | 199 | amWorkDir:: |
| 200 | Advice that shows the location of the patch file when |
| 201 | linkgit:git-am[1] fails to apply it. |
Mathieu Lienard--Mayor | 7e30944 | 2013-06-12 10:06:44 +0200 | [diff] [blame] | 202 | rmHints:: |
| 203 | In case of failure in the output of linkgit:git-rm[1], |
| 204 | show directions on how to proceed from the current state. |
Jeff King | 7519443 | 2009-09-09 07:38:58 -0400 | [diff] [blame] | 205 | -- |
| 206 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 207 | core.fileMode:: |
| 208 | If false, the executable bit differences between the index and |
Carlos Martín Nieto | f7d650c | 2011-09-20 22:25:57 +0200 | [diff] [blame] | 209 | the working tree are ignored; useful on broken filesystems like FAT. |
Matthew Ogilvie | 7b35724 | 2009-11-22 19:07:30 -0700 | [diff] [blame] | 210 | See linkgit:git-update-index[1]. |
| 211 | + |
| 212 | The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] |
| 213 | will probe and set core.fileMode false if appropriate when the |
| 214 | repository is created. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 215 | |
Matthew Ogilvie | 7b35724 | 2009-11-22 19:07:30 -0700 | [diff] [blame] | 216 | core.ignorecase:: |
| 217 | If true, this option enables various workarounds to enable |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 218 | Git to work better on filesystems that are not case sensitive, |
Matthew Ogilvie | 7b35724 | 2009-11-22 19:07:30 -0700 | [diff] [blame] | 219 | like FAT. For example, if a directory listing finds |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 220 | "makefile" when Git expects "Makefile", Git will assume |
Matthew Ogilvie | 7b35724 | 2009-11-22 19:07:30 -0700 | [diff] [blame] | 221 | it is really the same file, and continue to remember it as |
| 222 | "Makefile". |
| 223 | + |
| 224 | The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] |
| 225 | will probe and set core.ignorecase true if appropriate when the repository |
| 226 | is created. |
| 227 | |
Torsten Bögershausen | 76759c7 | 2012-07-08 15:50:25 +0200 | [diff] [blame] | 228 | core.precomposeunicode:: |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 229 | This option is only used by Mac OS implementation of Git. |
| 230 | When core.precomposeunicode=true, Git reverts the unicode decomposition |
Torsten Bögershausen | 76759c7 | 2012-07-08 15:50:25 +0200 | [diff] [blame] | 231 | of filenames done by Mac OS. This is useful when sharing a repository |
| 232 | between Mac OS and Linux or Windows. |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 233 | (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). |
| 234 | When false, file names are handled fully transparent by Git, |
| 235 | which is backward compatible with older versions of Git. |
Torsten Bögershausen | 76759c7 | 2012-07-08 15:50:25 +0200 | [diff] [blame] | 236 | |
Alex Riesen | 1ce4790 | 2008-07-28 08:31:28 +0200 | [diff] [blame] | 237 | core.trustctime:: |
| 238 | If false, the ctime differences between the index and the |
Carlos Martín Nieto | f7d650c | 2011-09-20 22:25:57 +0200 | [diff] [blame] | 239 | working tree are ignored; useful when the inode change time |
Alex Riesen | 1ce4790 | 2008-07-28 08:31:28 +0200 | [diff] [blame] | 240 | is regularly modified by something outside Git (file system |
| 241 | crawlers and some backup systems). |
| 242 | See linkgit:git-update-index[1]. True by default. |
| 243 | |
Robin Rosenberg | c08e4d5 | 2013-01-22 08:49:22 +0100 | [diff] [blame] | 244 | core.checkstat:: |
| 245 | Determines which stat fields to match between the index |
| 246 | and work tree. The user can set this to 'default' or |
| 247 | 'minimal'. Default (or explicitly 'default'), is to check |
| 248 | all fields, including the sub-second part of mtime and ctime. |
| 249 | |
Junio C Hamano | 9378c16 | 2007-06-24 15:11:24 -0700 | [diff] [blame] | 250 | core.quotepath:: |
Jonathan Nieder | 5833d73 | 2008-07-03 00:59:09 -0500 | [diff] [blame] | 251 | The commands that output paths (e.g. 'ls-files', |
| 252 | 'diff'), when not given the `-z` option, will quote |
Junio C Hamano | 9378c16 | 2007-06-24 15:11:24 -0700 | [diff] [blame] | 253 | "unusual" characters in the pathname by enclosing the |
| 254 | pathname in a double-quote pair and with backslashes the |
| 255 | same way strings in C source code are quoted. If this |
| 256 | variable is set to false, the bytes higher than 0x80 are |
| 257 | not quoted but output as verbatim. Note that double |
| 258 | quote, backslash and control characters are always |
| 259 | quoted without `-z` regardless of the setting of this |
| 260 | variable. |
| 261 | |
Eyvind Bernhardsen | 942e774 | 2010-06-04 21:29:08 +0200 | [diff] [blame] | 262 | core.eol:: |
| 263 | Sets the line ending type to use in the working directory for |
| 264 | files that have the `text` property set. Alternatives are |
| 265 | 'lf', 'crlf' and 'native', which uses the platform's native |
| 266 | line ending. The default value is `native`. See |
| 267 | linkgit:gitattributes[5] for more information on end-of-line |
| 268 | conversion. |
Frank Lichtenheld | 5cb71f8 | 2007-04-13 18:02:31 +0200 | [diff] [blame] | 269 | |
Steffen Prohaska | 21e5ad5 | 2008-02-06 12:25:58 +0100 | [diff] [blame] | 270 | core.safecrlf:: |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 271 | If true, makes Git check if converting `CRLF` is reversible when |
Eyvind Bernhardsen | fd6cce9 | 2010-05-19 22:43:10 +0200 | [diff] [blame] | 272 | end-of-line conversion is active. Git will verify if a command |
Steffen Prohaska | 21e5ad5 | 2008-02-06 12:25:58 +0100 | [diff] [blame] | 273 | modifies a file in the work tree either directly or indirectly. |
| 274 | For example, committing a file followed by checking out the |
| 275 | same file should yield the original file in the work tree. If |
| 276 | this is not the case for the current setting of |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 277 | `core.autocrlf`, Git will reject the file. The variable can |
| 278 | be set to "warn", in which case Git will only warn about an |
Steffen Prohaska | 21e5ad5 | 2008-02-06 12:25:58 +0100 | [diff] [blame] | 279 | irreversible conversion but continue the operation. |
| 280 | + |
| 281 | CRLF conversion bears a slight chance of corrupting data. |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 282 | 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] | 283 | CRLF during checkout. A file that contains a mixture of LF and |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 284 | CRLF before the commit cannot be recreated by Git. For text |
Steffen Prohaska | 21e5ad5 | 2008-02-06 12:25:58 +0100 | [diff] [blame] | 285 | files this is the right thing to do: it corrects line endings |
| 286 | such that we have only LF line endings in the repository. |
| 287 | But for binary files that are accidentally classified as text the |
| 288 | conversion can corrupt data. |
| 289 | + |
| 290 | If you recognize such corruption early you can easily fix it by |
| 291 | setting the conversion type explicitly in .gitattributes. Right |
| 292 | after committing you still have the original file in your work |
| 293 | tree and this file is not yet corrupted. You can explicitly tell |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 294 | Git that this file is binary and Git will handle the file |
Steffen Prohaska | 21e5ad5 | 2008-02-06 12:25:58 +0100 | [diff] [blame] | 295 | appropriately. |
| 296 | + |
| 297 | Unfortunately, the desired effect of cleaning up text files with |
| 298 | mixed line endings and the undesired effect of corrupting binary |
| 299 | files cannot be distinguished. In both cases CRLFs are removed |
| 300 | in an irreversible way. For text files this is the right thing |
| 301 | to do because CRLFs are line endings, while for binary files |
| 302 | converting CRLFs corrupts data. |
| 303 | + |
| 304 | Note, this safety check does not mean that a checkout will generate a |
| 305 | file identical to the original file for a different setting of |
Eyvind Bernhardsen | 942e774 | 2010-06-04 21:29:08 +0200 | [diff] [blame] | 306 | `core.eol` and `core.autocrlf`, but only for the current one. For |
| 307 | example, a text file with `LF` would be accepted with `core.eol=lf` |
| 308 | 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] | 309 | resulting file would contain `CRLF`, although the original file |
| 310 | contained `LF`. However, in both work trees the line endings would be |
| 311 | consistent, that is either all `LF` or all `CRLF`, but never mixed. A |
| 312 | file with mixed line endings would be reported by the `core.safecrlf` |
| 313 | mechanism. |
| 314 | |
Eyvind Bernhardsen | 942e774 | 2010-06-04 21:29:08 +0200 | [diff] [blame] | 315 | core.autocrlf:: |
| 316 | Setting this variable to "true" is almost the same as setting |
| 317 | the `text` attribute to "auto" on all files except that text |
| 318 | files are not guaranteed to be normalized: files that contain |
| 319 | `CRLF` in the repository will not be touched. Use this |
| 320 | setting if you want to have `CRLF` line endings in your |
| 321 | working directory even though the repository does not have |
| 322 | normalized line endings. This variable can be set to 'input', |
| 323 | in which case no output conversion is performed. |
| 324 | |
Johannes Sixt | 78a8d64 | 2007-03-02 22:11:30 +0100 | [diff] [blame] | 325 | core.symlinks:: |
| 326 | If false, symbolic links are checked out as small plain files that |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 327 | contain the link text. linkgit:git-update-index[1] and |
| 328 | linkgit:git-add[1] will not change the recorded type to regular |
Johannes Sixt | 78a8d64 | 2007-03-02 22:11:30 +0100 | [diff] [blame] | 329 | file. Useful on filesystems like FAT that do not support |
Matthew Ogilvie | 7b35724 | 2009-11-22 19:07:30 -0700 | [diff] [blame] | 330 | symbolic links. |
| 331 | + |
| 332 | The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] |
| 333 | will probe and set core.symlinks false if appropriate when the repository |
| 334 | is created. |
Johannes Sixt | 78a8d64 | 2007-03-02 22:11:30 +0100 | [diff] [blame] | 335 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 336 | core.gitProxy:: |
| 337 | A "proxy command" to execute (as 'command host port') instead |
| 338 | of establishing direct connection to the remote server when |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 339 | using the Git protocol for fetching. If the variable value is |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 340 | in the "COMMAND for DOMAIN" format, the command is applied only |
| 341 | on hostnames ending with the specified domain string. This variable |
| 342 | may be set multiple times and is matched in the given order; |
| 343 | the first match wins. |
Francis Daly | b8936cf | 2006-06-08 00:15:05 +0100 | [diff] [blame] | 344 | + |
| 345 | Can be overridden by the 'GIT_PROXY_COMMAND' environment variable |
| 346 | (which always applies universally, without the special "for" |
| 347 | handling). |
Emil Sit | 642d084 | 2009-03-17 13:31:42 -0400 | [diff] [blame] | 348 | + |
| 349 | The special string `none` can be used as the proxy command to |
| 350 | specify that no proxy be used for a given domain pattern. |
| 351 | This is useful for excluding servers inside a firewall from |
| 352 | proxy use, while defaulting to a common proxy for external domains. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 353 | |
| 354 | core.ignoreStat:: |
Marius Storm-Olsen | b7f685a | 2008-05-30 13:14:24 +0200 | [diff] [blame] | 355 | If true, commands which modify both the working tree and the index |
| 356 | will mark the updated paths with the "assume unchanged" bit in the |
| 357 | index. These marked files are then assumed to stay unchanged in the |
Carlos Martín Nieto | f7d650c | 2011-09-20 22:25:57 +0200 | [diff] [blame] | 358 | working tree, until you mark them otherwise manually - Git will not |
Marius Storm-Olsen | b7f685a | 2008-05-30 13:14:24 +0200 | [diff] [blame] | 359 | detect the file changes by lstat() calls. This is useful on systems |
| 360 | where those are very slow, such as Microsoft Windows. |
| 361 | See linkgit:git-update-index[1]. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 362 | False by default. |
| 363 | |
Junio C Hamano | 9f0bb90 | 2006-05-02 00:40:24 -0700 | [diff] [blame] | 364 | core.preferSymlinkRefs:: |
| 365 | Instead of the default "symref" format for HEAD |
| 366 | and other symbolic reference files, use symbolic links. |
| 367 | This is sometimes needed to work with old scripts that |
| 368 | expect HEAD to be a symbolic link. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 369 | |
Shawn O. Pearce | e4a15f4 | 2007-02-21 17:59:08 -0500 | [diff] [blame] | 370 | core.bare:: |
| 371 | If true this repository is assumed to be 'bare' and has no |
| 372 | working directory associated with it. If this is the case a |
| 373 | number of commands that require a working directory will be |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 374 | 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] | 375 | + |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 376 | This setting is automatically guessed by linkgit:git-clone[1] or |
| 377 | 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] | 378 | repository that ends in "/.git" is assumed to be not bare (bare = |
| 379 | false), while all other repositories are assumed to be bare (bare |
| 380 | = true). |
| 381 | |
Matthias Lederhofer | 892c41b | 2007-06-06 09:10:42 +0200 | [diff] [blame] | 382 | core.worktree:: |
Junio C Hamano | ea472c1 | 2011-01-23 15:49:41 -0800 | [diff] [blame] | 383 | Set the path to the root of the working tree. |
Ralf Wildenhues | 06ada15 | 2007-10-09 23:00:03 +0200 | [diff] [blame] | 384 | This can be overridden by the GIT_WORK_TREE environment |
Junio C Hamano | ea472c1 | 2011-01-23 15:49:41 -0800 | [diff] [blame] | 385 | variable and the '--work-tree' command line option. |
SZEDER Gábor | d424a47 | 2011-04-04 16:59:25 +0200 | [diff] [blame] | 386 | The value can be an absolute path or relative to the path to |
Junio C Hamano | ea472c1 | 2011-01-23 15:49:41 -0800 | [diff] [blame] | 387 | the .git directory, which is either specified by --git-dir |
| 388 | or GIT_DIR, or automatically discovered. |
| 389 | If --git-dir or GIT_DIR is specified but none of |
Liu Yubao | 302cc11 | 2008-04-29 04:09:20 +0800 | [diff] [blame] | 390 | --work-tree, GIT_WORK_TREE and core.worktree is specified, |
Junio C Hamano | ea472c1 | 2011-01-23 15:49:41 -0800 | [diff] [blame] | 391 | the current working directory is regarded as the top level |
Nguyễn Thái Ngọc Duy | 98acf75 | 2010-11-26 22:32:42 +0700 | [diff] [blame] | 392 | of your working tree. |
Junio C Hamano | ea472c1 | 2011-01-23 15:49:41 -0800 | [diff] [blame] | 393 | + |
| 394 | Note that this variable is honored even when set in a configuration |
| 395 | file in a ".git" subdirectory of a directory and its value differs |
| 396 | from the latter directory (e.g. "/path/to/.git/config" has |
| 397 | core.worktree set to "/different/path"), which is most likely a |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 398 | misconfiguration. Running Git commands in the "/path/to" directory will |
Junio C Hamano | ea472c1 | 2011-01-23 15:49:41 -0800 | [diff] [blame] | 399 | still use "/different/path" as the root of the work tree and can cause |
| 400 | confusion unless you know what you are doing (e.g. you are creating a |
| 401 | read-only snapshot of the same index to a location different from the |
| 402 | repository's usual working tree). |
Matthias Lederhofer | 892c41b | 2007-06-06 09:10:42 +0200 | [diff] [blame] | 403 | |
Shawn Pearce | 6de08ae | 2006-05-17 05:55:40 -0400 | [diff] [blame] | 404 | core.logAllRefUpdates:: |
Lukas Sandström | 14cd560 | 2007-08-19 23:38:57 +0200 | [diff] [blame] | 405 | 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] | 406 | "$GIT_DIR/logs/<ref>", by appending the new and old |
Thomas Ackermann | d5fa1f1 | 2013-04-15 19:49:04 +0200 | [diff] [blame] | 407 | SHA-1, the date/time and the reason of the update, but |
Junio C Hamano | 4057deb | 2006-10-08 01:35:18 -0700 | [diff] [blame] | 408 | only when the file exists. If this configuration |
| 409 | variable is set to true, missing "$GIT_DIR/logs/<ref>" |
Bert Wesarg | cd8e371 | 2011-07-11 11:14:18 +0200 | [diff] [blame] | 410 | file is automatically created for branch heads (i.e. under |
| 411 | refs/heads/), remote refs (i.e. under refs/remotes/), |
| 412 | note refs (i.e. under refs/notes/), and the symbolic ref HEAD. |
Junio C Hamano | a862f97 | 2006-12-30 22:39:24 -0800 | [diff] [blame] | 413 | + |
| 414 | This information can be used to determine what commit |
| 415 | was the tip of a branch "2 days ago". |
| 416 | + |
| 417 | This value is true by default in a repository that has |
| 418 | a working directory associated with it, and false by |
| 419 | default in a bare repository. |
Shawn Pearce | 6de08ae | 2006-05-17 05:55:40 -0400 | [diff] [blame] | 420 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 421 | core.repositoryFormatVersion:: |
| 422 | Internal variable identifying the repository format and layout |
| 423 | version. |
| 424 | |
| 425 | core.sharedRepository:: |
Jonas Fonseca | d5dc6a7 | 2006-08-09 02:26:23 +0200 | [diff] [blame] | 426 | When 'group' (or 'true'), the repository is made shareable between |
| 427 | several users in a group (making sure all the files and objects are |
| 428 | group-writable). When 'all' (or 'world' or 'everybody'), the |
| 429 | repository will be readable by all users, additionally to being |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 430 | group-shareable. When 'umask' (or 'false'), Git will use permissions |
Heikki Orsila | 06cbe85 | 2008-04-16 11:34:24 +0300 | [diff] [blame] | 431 | reported by umask(2). When '0xxx', where '0xxx' is an octal number, |
| 432 | files in the repository will have this mode value. '0xxx' will override |
Johan Herland | 098082f | 2009-04-14 15:15:42 +0200 | [diff] [blame] | 433 | user's umask value (whereas the other options will only override |
| 434 | requested parts of the user's umask value). Examples: '0660' will make |
| 435 | the repo read/write-able for the owner and group, but inaccessible to |
| 436 | 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] | 437 | repository that is group-readable but not group-writable. |
| 438 | See linkgit:git-init[1]. False by default. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 439 | |
| 440 | core.warnAmbiguousRefs:: |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 441 | If true, Git will warn you if the ref name you passed it is ambiguous |
Greg Price | 48dfe96 | 2013-02-25 00:34:14 -0500 | [diff] [blame] | 442 | and might match multiple refs in the repository. True by default. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 443 | |
Joachim Berdal Haga | 3d3e95a | 2006-07-06 22:35:54 +0200 | [diff] [blame] | 444 | core.compression:: |
Dana How | 960ccca | 2007-05-09 13:56:50 -0700 | [diff] [blame] | 445 | An integer -1..9, indicating a default compression level. |
| 446 | -1 is the zlib default. 0 means no compression, |
| 447 | and 1..9 are various speed/size tradeoffs, 9 being slowest. |
Brian Downing | dec9230 | 2007-11-19 10:58:51 -0600 | [diff] [blame] | 448 | If set, this provides a default to other compression variables, |
| 449 | such as 'core.loosecompression' and 'pack.compression'. |
Dana How | 960ccca | 2007-05-09 13:56:50 -0700 | [diff] [blame] | 450 | |
| 451 | core.loosecompression:: |
Joachim B Haga | 12f6c30 | 2006-07-03 22:11:47 +0200 | [diff] [blame] | 452 | An integer -1..9, indicating the compression level for objects that |
Dana How | 960ccca | 2007-05-09 13:56:50 -0700 | [diff] [blame] | 453 | 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] | 454 | compression, and 1..9 are various speed/size tradeoffs, 9 being |
Dana How | 960ccca | 2007-05-09 13:56:50 -0700 | [diff] [blame] | 455 | slowest. If not set, defaults to core.compression. If that is |
Brian Downing | de1b246 | 2007-11-19 10:58:50 -0600 | [diff] [blame] | 456 | not set, defaults to 1 (best speed). |
Joachim B Haga | 12f6c30 | 2006-07-03 22:11:47 +0200 | [diff] [blame] | 457 | |
Shawn O. Pearce | 60bb8b1 | 2006-12-23 02:34:28 -0500 | [diff] [blame] | 458 | core.packedGitWindowSize:: |
| 459 | Number of bytes of a pack file to map into memory in a |
| 460 | single mapping operation. Larger window sizes may allow |
| 461 | your system to process a smaller number of large pack files |
| 462 | more quickly. Smaller window sizes will negatively affect |
Shawn O. Pearce | eb92242 | 2006-12-30 22:13:43 -0500 | [diff] [blame] | 463 | performance due to increased calls to the operating system's |
Shawn O. Pearce | 60bb8b1 | 2006-12-23 02:34:28 -0500 | [diff] [blame] | 464 | memory manager, but may improve performance when accessing |
Shawn O. Pearce | 22bac0e | 2007-01-04 22:28:08 -0500 | [diff] [blame] | 465 | a large number of large pack files. |
| 466 | + |
| 467 | Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 |
| 468 | MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should |
| 469 | be reasonable for all users/operating systems. You probably do |
| 470 | not need to adjust this value. |
Shawn O. Pearce | eb92242 | 2006-12-30 22:13:43 -0500 | [diff] [blame] | 471 | + |
| 472 | Common unit suffixes of 'k', 'm', or 'g' are supported. |
Shawn O. Pearce | 60bb8b1 | 2006-12-23 02:34:28 -0500 | [diff] [blame] | 473 | |
Shawn O. Pearce | 77ccc5b | 2006-12-23 02:33:35 -0500 | [diff] [blame] | 474 | core.packedGitLimit:: |
| 475 | Maximum number of bytes to map simultaneously into memory |
| 476 | from pack files. If Git needs to access more than this many |
| 477 | bytes at once to complete an operation it will unmap existing |
| 478 | regions to reclaim virtual address space within the process. |
Shawn O. Pearce | 22bac0e | 2007-01-04 22:28:08 -0500 | [diff] [blame] | 479 | + |
| 480 | Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. |
| 481 | This should be reasonable for all users/operating systems, except on |
| 482 | 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] | 483 | + |
| 484 | Common unit suffixes of 'k', 'm', or 'g' are supported. |
Shawn O. Pearce | 77ccc5b | 2006-12-23 02:33:35 -0500 | [diff] [blame] | 485 | |
Shawn O. Pearce | 18bdec1 | 2007-03-19 01:14:37 -0400 | [diff] [blame] | 486 | core.deltaBaseCacheLimit:: |
| 487 | Maximum number of bytes to reserve for caching base objects |
Ville Skyttä | 6b677a2 | 2010-07-20 00:17:17 +0300 | [diff] [blame] | 488 | that may be referenced by multiple deltified objects. By storing the |
Shawn O. Pearce | 18bdec1 | 2007-03-19 01:14:37 -0400 | [diff] [blame] | 489 | entire decompressed base objects in a cache Git is able |
| 490 | to avoid unpacking and decompressing frequently used base |
| 491 | objects multiple times. |
| 492 | + |
| 493 | Default is 16 MiB on all platforms. This should be reasonable |
| 494 | for all users/operating systems, except on the largest projects. |
| 495 | You probably do not need to adjust this value. |
| 496 | + |
| 497 | Common unit suffixes of 'k', 'm', or 'g' are supported. |
| 498 | |
Shawn O. Pearce | 5eef828 | 2010-02-01 09:27:35 -0800 | [diff] [blame] | 499 | core.bigFileThreshold:: |
| 500 | Files larger than this size are stored deflated, without |
| 501 | attempting delta compression. Storing large files without |
| 502 | delta compression avoids excessive memory usage, at the |
| 503 | slight expense of increased disk usage. |
| 504 | + |
| 505 | Default is 512 MiB on all platforms. This should be reasonable |
| 506 | for most projects as source code and other text files can still |
| 507 | be delta compressed, but larger binary media files won't be. |
| 508 | + |
| 509 | Common unit suffixes of 'k', 'm', or 'g' are supported. |
Shawn O. Pearce | 5eef828 | 2010-02-01 09:27:35 -0800 | [diff] [blame] | 510 | |
Michael Hendricks | e8964a5 | 2007-07-02 10:48:34 -0600 | [diff] [blame] | 511 | core.excludesfile:: |
Johannes Schindelin | 0ba956d | 2007-05-22 01:12:17 +0100 | [diff] [blame] | 512 | In addition to '.gitignore' (per-directory) and |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 513 | '.git/info/exclude', Git looks into this file for patterns |
Jeff King | 6cf378f | 2012-04-26 04:51:57 -0400 | [diff] [blame] | 514 | of files which are not meant to be tracked. "`~/`" is expanded |
| 515 | to the value of `$HOME` and "`~user/`" to the specified user's |
Huynh Khoi Nguyen Nguyen | dc79687 | 2012-06-22 11:03:24 +0200 | [diff] [blame] | 516 | home directory. Its default value is $XDG_CONFIG_HOME/git/ignore. |
| 517 | If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore |
| 518 | is used instead. See linkgit:gitignore[5]. |
Johannes Schindelin | 0ba956d | 2007-05-22 01:12:17 +0100 | [diff] [blame] | 519 | |
Anselm Kruis | d3e7da8 | 2010-08-30 15:38:38 +0200 | [diff] [blame] | 520 | core.askpass:: |
| 521 | Some commands (e.g. svn and http interfaces) that interactively |
| 522 | ask for a password can be told to use an external program given |
Knut Franke | 453842c | 2010-08-30 15:40:29 +0200 | [diff] [blame] | 523 | via the value of this variable. Can be overridden by the 'GIT_ASKPASS' |
| 524 | environment variable. If not set, fall back to the value of the |
| 525 | 'SSH_ASKPASS' environment variable or, failing that, a simple password |
| 526 | prompt. The external program shall be given a suitable prompt as |
| 527 | command line argument and write the password on its STDOUT. |
Anselm Kruis | d3e7da8 | 2010-08-30 15:38:38 +0200 | [diff] [blame] | 528 | |
Petr Onderka | 6df42ab | 2010-09-01 00:42:43 +0200 | [diff] [blame] | 529 | core.attributesfile:: |
| 530 | In addition to '.gitattributes' (per-directory) and |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 531 | '.git/info/attributes', Git looks into this file for attributes |
Petr Onderka | 6df42ab | 2010-09-01 00:42:43 +0200 | [diff] [blame] | 532 | (see linkgit:gitattributes[5]). Path expansions are made the same |
Huynh Khoi Nguyen Nguyen | 684e40f | 2012-06-22 11:03:25 +0200 | [diff] [blame] | 533 | way as for `core.excludesfile`. Its default value is |
| 534 | $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not |
| 535 | set or empty, $HOME/.config/git/attributes is used instead. |
Petr Onderka | 6df42ab | 2010-09-01 00:42:43 +0200 | [diff] [blame] | 536 | |
Adam Roben | ef0c2ab | 2007-07-19 22:09:35 -0700 | [diff] [blame] | 537 | core.editor:: |
| 538 | Commands such as `commit` and `tag` that lets you edit |
Brian Hetro | 0278307 | 2007-08-23 20:44:13 -0400 | [diff] [blame] | 539 | messages by launching an editor uses the value of this |
Adam Roben | ef0c2ab | 2007-07-19 22:09:35 -0700 | [diff] [blame] | 540 | variable when it is set, and the environment variable |
Jonathan Nieder | b4479f0 | 2009-10-30 20:42:34 -0500 | [diff] [blame] | 541 | `GIT_EDITOR` is not set. See linkgit:git-var[1]. |
Adam Roben | ef0c2ab | 2007-07-19 22:09:35 -0700 | [diff] [blame] | 542 | |
Junio C Hamano | eff80a9 | 2013-01-16 20:18:48 +0100 | [diff] [blame] | 543 | core.commentchar:: |
| 544 | Commands such as `commit` and `tag` that lets you edit |
| 545 | messages consider a line that begins with this character |
| 546 | commented, and removes them after the editor returns |
| 547 | (default '#'). |
| 548 | |
Peter Oberndorfer | 821881d | 2011-10-17 22:26:23 +0200 | [diff] [blame] | 549 | sequence.editor:: |
Matthias Krüger | 3322ad4 | 2013-03-27 23:53:50 +0100 | [diff] [blame] | 550 | Text editor used by `git rebase -i` for editing the rebase instruction file. |
Peter Oberndorfer | 821881d | 2011-10-17 22:26:23 +0200 | [diff] [blame] | 551 | The value is meant to be interpreted by the shell when it is used. |
| 552 | It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. |
| 553 | When not configured the default commit message editor is used instead. |
| 554 | |
Brian Gernhardt | 54adf37 | 2007-07-03 14:18:11 -0400 | [diff] [blame] | 555 | core.pager:: |
Junio C Hamano | 97d01f2 | 2013-08-28 13:26:12 -0700 | [diff] [blame] | 556 | Text viewer for use by Git commands (e.g., 'less'). The value |
| 557 | is meant to be interpreted by the shell. The order of preference |
| 558 | is the `$GIT_PAGER` environment variable, then `core.pager` |
| 559 | configuration, then `$PAGER`, and then the default chosen at |
| 560 | compile time (usually 'less'). |
| 561 | + |
| 562 | When the `LESS` environment variable is unset, Git sets it to `FRSX` |
| 563 | (if `LESS` environment variable is set, Git does not change it at |
| 564 | all). If you want to selectively override Git's default setting |
| 565 | for `LESS`, you can set `core.pager` to e.g. `less -+S`. This will |
| 566 | be passed to the shell by Git, which will translate the final |
| 567 | command to `LESS=FRSX less -+S`. The environment tells the command |
| 568 | to set the `S` option to chop long lines but the command line |
| 569 | resets it to the default to fold long lines. |
Jonathan Nieder | e54c1f2 | 2014-01-06 18:14:05 -0800 | [diff] [blame] | 570 | + |
| 571 | Likewise, when the `LV` environment variable is unset, Git sets it |
| 572 | to `-c`. You can override this setting by exporting `LV` with |
| 573 | another value or setting `core.pager` to `lv +c`. |
Brian Gernhardt | 54adf37 | 2007-07-03 14:18:11 -0400 | [diff] [blame] | 574 | |
Junio C Hamano | 91af7ae | 2007-11-24 11:57:41 -0800 | [diff] [blame] | 575 | core.whitespace:: |
| 576 | A comma separated list of common whitespace problems to |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 577 | notice. 'git diff' will use `color.diff.whitespace` to |
| 578 | highlight them, and 'git apply --whitespace=error' will |
Junio C Hamano | c921cc9 | 2008-07-25 00:34:47 -0700 | [diff] [blame] | 579 | consider them as errors. You can prefix `-` to disable |
| 580 | any of them (e.g. `-trailing-space`): |
Junio C Hamano | 91af7ae | 2007-11-24 11:57:41 -0800 | [diff] [blame] | 581 | + |
Junio C Hamano | aeb84b0 | 2009-09-05 22:21:17 -0700 | [diff] [blame] | 582 | * `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] | 583 | as an error (enabled by default). |
| 584 | * `space-before-tab` treats a space character that appears immediately |
| 585 | before a tab character in the initial indent part of the line as an |
| 586 | error (enabled by default). |
Wesley J. Landaker | 2ce4fee | 2012-09-17 08:22:15 -0600 | [diff] [blame] | 587 | * `indent-with-non-tab` treats a line that is indented with space |
| 588 | characters instead of the equivalent tabs as an error (not enabled by |
| 589 | default). |
Chris Webb | 3e3ec2a | 2010-04-03 00:37:08 +0100 | [diff] [blame] | 590 | * `tab-in-indent` treats a tab character in the initial indent part of |
| 591 | the line as an error (not enabled by default). |
Junio C Hamano | 77b15bb | 2009-09-03 16:02:32 -0700 | [diff] [blame] | 592 | * `blank-at-eof` treats blank lines added at the end of file as an error |
| 593 | (enabled by default). |
Junio C Hamano | aeb84b0 | 2009-09-05 22:21:17 -0700 | [diff] [blame] | 594 | * `trailing-space` is a short-hand to cover both `blank-at-eol` and |
| 595 | `blank-at-eof`. |
Junio C Hamano | b2979ff | 2008-01-15 00:59:05 -0800 | [diff] [blame] | 596 | * `cr-at-eol` treats a carriage-return at the end of line as |
| 597 | part of the line terminator, i.e. with it, `trailing-space` |
| 598 | does not trigger if the character before such a carriage-return |
| 599 | is not a whitespace (not enabled by default). |
Johannes Sixt | f4b05a4 | 2010-11-30 09:29:11 +0100 | [diff] [blame] | 600 | * `tabwidth=<n>` tells how many character positions a tab occupies; this |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 601 | is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` |
Johannes Sixt | f4b05a4 | 2010-11-30 09:29:11 +0100 | [diff] [blame] | 602 | errors. The default tab width is 8. Allowed values are 1 to 63. |
Junio C Hamano | 91af7ae | 2007-11-24 11:57:41 -0800 | [diff] [blame] | 603 | |
Linus Torvalds | aafe9fb | 2008-06-18 15:18:44 -0700 | [diff] [blame] | 604 | core.fsyncobjectfiles:: |
| 605 | This boolean will enable 'fsync()' when writing object files. |
| 606 | + |
| 607 | This is a total waste of time and effort on a filesystem that orders |
| 608 | data writes properly, but can be useful for filesystems that do not use |
| 609 | journalling (traditional UNIX filesystems) or that only journal metadata |
| 610 | and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). |
| 611 | |
Linus Torvalds | 671c9b7 | 2008-11-13 16:36:30 -0800 | [diff] [blame] | 612 | core.preloadindex:: |
| 613 | Enable parallel index preload for operations like 'git diff' |
| 614 | + |
| 615 | This can speed up operations like 'git diff' and 'git status' especially |
| 616 | on filesystems like NFS that have weak caching semantics and thus |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 617 | relatively high IO latencies. With this set to 'true', Git will do the |
Linus Torvalds | 671c9b7 | 2008-11-13 16:36:30 -0800 | [diff] [blame] | 618 | index comparison to the filesystem data in parallel, allowing |
| 619 | overlapping IO's. |
| 620 | |
Johannes Schindelin | 348df16 | 2009-04-28 00:32:25 +0200 | [diff] [blame] | 621 | core.createObject:: |
| 622 | You can set this to 'link', in which case a hardlink followed by |
| 623 | a delete of the source are used to make sure that object creation |
| 624 | will not overwrite existing objects. |
| 625 | + |
| 626 | On some file system/operating system combinations, this is unreliable. |
| 627 | Set this config setting to 'rename' there; However, This will remove the |
| 628 | check that makes sure that existing object files will not get overwritten. |
Johannes Schindelin | be66a6c | 2009-04-25 11:57:14 +0200 | [diff] [blame] | 629 | |
Johannes Schindelin | a97a746 | 2009-10-09 12:21:57 +0200 | [diff] [blame] | 630 | core.notesRef:: |
| 631 | When showing commit messages, also show notes which are stored in |
Jonathan Nieder | 9eb3f81 | 2010-05-08 22:19:35 -0500 | [diff] [blame] | 632 | the given ref. The ref must be fully qualified. If the given |
| 633 | ref does not exist, it is not an error but means that no |
| 634 | notes should be printed. |
Johannes Schindelin | a97a746 | 2009-10-09 12:21:57 +0200 | [diff] [blame] | 635 | + |
Jonathan Nieder | 9eb3f81 | 2010-05-08 22:19:35 -0500 | [diff] [blame] | 636 | This setting defaults to "refs/notes/commits", and it can be overridden by |
| 637 | the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. |
Johannes Schindelin | a97a746 | 2009-10-09 12:21:57 +0200 | [diff] [blame] | 638 | |
Nguyễn Thái Ngọc Duy | 08aefc9 | 2009-08-20 20:47:08 +0700 | [diff] [blame] | 639 | core.sparseCheckout:: |
| 640 | Enable "sparse checkout" feature. See section "Sparse checkout" in |
| 641 | linkgit:git-read-tree[1] for more information. |
| 642 | |
Junio C Hamano | a71f09f | 2011-03-20 22:26:24 -0700 | [diff] [blame] | 643 | core.abbrev:: |
Linus Torvalds | dce9648 | 2010-10-28 11:28:04 -0700 | [diff] [blame] | 644 | Set the length object names are abbreviated to. If unspecified, |
| 645 | many commands abbreviate to 7 hexdigits, which may not be enough |
| 646 | for abbreviated object names to stay unique for sufficiently long |
| 647 | time. |
| 648 | |
Stephen Boyd | 13bd213 | 2009-05-30 22:08:02 -0700 | [diff] [blame] | 649 | add.ignore-errors:: |
Jonathan Nieder | 6b3020a | 2010-12-01 12:36:15 -0600 | [diff] [blame] | 650 | add.ignoreErrors:: |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 651 | Tells 'git add' to continue adding files when some files cannot be |
Stephen Boyd | 13bd213 | 2009-05-30 22:08:02 -0700 | [diff] [blame] | 652 | added due to indexing errors. Equivalent to the '--ignore-errors' |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 653 | option of linkgit:git-add[1]. Older versions of Git accept only |
Jonathan Nieder | 6b3020a | 2010-12-01 12:36:15 -0600 | [diff] [blame] | 654 | `add.ignore-errors`, which does not follow the usual naming |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 655 | convention for configuration variables. Newer versions of Git |
Jonathan Nieder | 6b3020a | 2010-12-01 12:36:15 -0600 | [diff] [blame] | 656 | honor `add.ignoreErrors` as well. |
Stephen Boyd | 13bd213 | 2009-05-30 22:08:02 -0700 | [diff] [blame] | 657 | |
Petr Baudis | 4514ad4 | 2006-06-07 20:43:50 +0200 | [diff] [blame] | 658 | alias.*:: |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 659 | Command aliases for the linkgit:git[1] command wrapper - e.g. |
Petr Baudis | 4514ad4 | 2006-06-07 20:43:50 +0200 | [diff] [blame] | 660 | after defining "alias.last = cat-file commit HEAD", the invocation |
| 661 | "git last" is equivalent to "git cat-file commit HEAD". To avoid |
Petr Baudis | 99b41c8 | 2006-06-07 17:25:21 -0700 | [diff] [blame] | 662 | confusion and troubles with script usage, aliases that |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 663 | hide existing Git commands are ignored. Arguments are split by |
Petr Baudis | 99b41c8 | 2006-06-07 17:25:21 -0700 | [diff] [blame] | 664 | spaces, the usual shell quoting and escaping is supported. |
| 665 | quote pair and a backslash can be used to quote them. |
Junio C Hamano | f368f5a | 2007-09-01 04:01:54 -0700 | [diff] [blame] | 666 | + |
| 667 | If the alias expansion is prefixed with an exclamation point, |
| 668 | it will be treated as a shell command. For example, defining |
| 669 | "alias.new = !gitk --all --not ORIG_HEAD", the invocation |
| 670 | "git new" is equivalent to running the shell command |
Sitaram Chamarty | 595b8db | 2009-07-01 21:30:31 +0530 | [diff] [blame] | 671 | "gitk --all --not ORIG_HEAD". Note that shell commands will be |
| 672 | executed from the top-level directory of a repository, which may |
| 673 | not necessarily be the current directory. |
Michael J Gruber | 7cf16a1 | 2011-04-27 10:36:27 +0200 | [diff] [blame] | 674 | 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix' |
| 675 | from the original current directory. See linkgit:git-rev-parse[1]. |
Theodore Ts'o | dfd42a3 | 2007-02-10 19:33:58 -0500 | [diff] [blame] | 676 | |
Stefan-W. Hahn | e80d4cb | 2010-02-27 15:20:27 +0100 | [diff] [blame] | 677 | am.keepcr:: |
| 678 | If true, git-am will call git-mailsplit for patches in mbox format |
| 679 | with parameter '--keep-cr'. In this case git-mailsplit will |
Ville Skyttä | 6b677a2 | 2010-07-20 00:17:17 +0300 | [diff] [blame] | 680 | not remove `\r` from lines ending with `\r\n`. Can be overridden |
Stefan-W. Hahn | e80d4cb | 2010-02-27 15:20:27 +0100 | [diff] [blame] | 681 | by giving '--no-keep-cr' from the command line. |
| 682 | See linkgit:git-am[1], linkgit:git-mailsplit[1]. |
| 683 | |
Giuseppe Bilotta | 86c91f9 | 2009-08-04 13:16:49 +0200 | [diff] [blame] | 684 | apply.ignorewhitespace:: |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 685 | When set to 'change', tells 'git apply' to ignore changes in |
Giuseppe Bilotta | 86c91f9 | 2009-08-04 13:16:49 +0200 | [diff] [blame] | 686 | whitespace, in the same way as the '--ignore-space-change' |
| 687 | option. |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 688 | 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] | 689 | respect all whitespace differences. |
| 690 | See linkgit:git-apply[1]. |
| 691 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 692 | apply.whitespace:: |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 693 | Tells 'git apply' how to handle whitespaces, in the same way |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 694 | as the '--whitespace' option. See linkgit:git-apply[1]. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 695 | |
Paolo Bonzini | 9902387 | 2007-05-23 07:07:54 +0200 | [diff] [blame] | 696 | branch.autosetupmerge:: |
Junio C Hamano | add0951 | 2010-01-20 20:28:49 -0800 | [diff] [blame] | 697 | Tells 'git branch' and 'git checkout' to set up new branches |
Jay Soffian | 572fc81 | 2008-02-19 11:24:38 -0500 | [diff] [blame] | 698 | so that linkgit:git-pull[1] will appropriately merge from the |
| 699 | starting point branch. Note that even if this option is not set, |
Paolo Bonzini | 9902387 | 2007-05-23 07:07:54 +0200 | [diff] [blame] | 700 | this behavior can be chosen per-branch using the `--track` |
Jay Soffian | 572fc81 | 2008-02-19 11:24:38 -0500 | [diff] [blame] | 701 | and `--no-track` options. The valid settings are: `false` -- no |
| 702 | automatic setup is done; `true` -- automatic setup is done when the |
Matthieu Moy | 29b9a66 | 2010-11-02 16:31:24 +0100 | [diff] [blame] | 703 | starting point is a remote-tracking branch; `always` -- |
| 704 | automatic setup is done when the starting point is either a |
| 705 | local branch or remote-tracking |
Jay Soffian | 572fc81 | 2008-02-19 11:24:38 -0500 | [diff] [blame] | 706 | branch. This option defaults to true. |
Paolo Bonzini | 9902387 | 2007-05-23 07:07:54 +0200 | [diff] [blame] | 707 | |
Dustin Sallings | c998ae9 | 2008-05-10 15:36:29 -0700 | [diff] [blame] | 708 | branch.autosetuprebase:: |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 709 | When a new branch is created with 'git branch' or 'git checkout' |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 710 | that tracks another branch, this variable tells Git to set |
Dustin Sallings | c998ae9 | 2008-05-10 15:36:29 -0700 | [diff] [blame] | 711 | up pull to rebase instead of merge (see "branch.<name>.rebase"). |
| 712 | When `never`, rebase is never automatically set to true. |
| 713 | When `local`, rebase is set to true for tracked branches of |
| 714 | other local branches. |
| 715 | When `remote`, rebase is set to true for tracked branches of |
Matthieu Moy | 29b9a66 | 2010-11-02 16:31:24 +0100 | [diff] [blame] | 716 | remote-tracking branches. |
Dustin Sallings | c998ae9 | 2008-05-10 15:36:29 -0700 | [diff] [blame] | 717 | When `always`, rebase will be set to true for all tracking |
| 718 | branches. |
| 719 | See "branch.autosetupmerge" for details on how to set up a |
| 720 | branch to track another branch. |
| 721 | This option defaults to never. |
| 722 | |
Santi Béjar | 648ad18 | 2006-09-23 12:05:43 +0200 | [diff] [blame] | 723 | branch.<name>.remote:: |
Ramkumar Ramachandra | 224c217 | 2013-04-02 13:10:33 +0530 | [diff] [blame] | 724 | When on branch <name>, it tells 'git fetch' and 'git push' |
| 725 | which remote to fetch from/push to. The remote to push to |
| 726 | may be overridden with `remote.pushdefault` (for all branches). |
Ramkumar Ramachandra | 9f765ce | 2013-04-02 13:10:34 +0530 | [diff] [blame] | 727 | The remote to push to, for the current branch, may be further |
| 728 | overridden by `branch.<name>.pushremote`. If no remote is |
| 729 | configured, or if you are not on any branch, it defaults to |
| 730 | `origin` for fetching and `remote.pushdefault` for pushing. |
Philip Oakley | b85ecea | 2013-09-13 22:23:16 +0100 | [diff] [blame] | 731 | Additionally, `.` (a period) is the current local repository |
| 732 | (a dot-repository), see `branch.<name>.merge`'s final note below. |
Ramkumar Ramachandra | 9f765ce | 2013-04-02 13:10:34 +0530 | [diff] [blame] | 733 | |
| 734 | branch.<name>.pushremote:: |
| 735 | When on branch <name>, it overrides `branch.<name>.remote` for |
| 736 | pushing. It also overrides `remote.pushdefault` for pushing |
| 737 | from branch <name>. When you pull from one place (e.g. your |
| 738 | upstream) and push to another place (e.g. your own publishing |
| 739 | repository), you would want to set `remote.pushdefault` to |
| 740 | specify the remote to push to for all branches, and use this |
| 741 | option to override it for a specific branch. |
Santi Béjar | 648ad18 | 2006-09-23 12:05:43 +0200 | [diff] [blame] | 742 | |
Santi Béjar | 5372806 | 2006-09-23 22:53:04 +0200 | [diff] [blame] | 743 | branch.<name>.merge:: |
Santi Béjar | 76d3cc5 | 2009-03-30 12:11:40 +0200 | [diff] [blame] | 744 | Defines, together with branch.<name>.remote, the upstream branch |
Martin von Zweigbergk | 15a147e | 2011-02-09 20:54:02 -0500 | [diff] [blame] | 745 | for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 746 | branch to merge and can also affect 'git push' (see push.default). |
| 747 | When in branch <name>, it tells 'git fetch' the default |
Daniel Barkalow | b888d61 | 2007-09-10 23:03:25 -0400 | [diff] [blame] | 748 | refspec to be marked for merging in FETCH_HEAD. The value is |
| 749 | handled like the remote part of a refspec, and must match a |
| 750 | ref which is fetched from the remote given by |
| 751 | "branch.<name>.remote". |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 752 | The merge information is used by 'git pull' (which at first calls |
| 753 | 'git fetch') to lookup the default branch for merging. Without |
| 754 | this option, 'git pull' defaults to merge the first refspec fetched. |
Josef Weidendorfer | 62b339a | 2006-12-09 02:28:26 +0100 | [diff] [blame] | 755 | Specify multiple values to get an octopus merge. |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 756 | 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] | 757 | another branch in the local repository, you can point |
Philip Oakley | b85ecea | 2013-09-13 22:23:16 +0100 | [diff] [blame] | 758 | branch.<name>.merge to the desired branch, and use the relative path |
| 759 | setting `.` (a period) for branch.<name>.remote. |
Santi Béjar | 5372806 | 2006-09-23 22:53:04 +0200 | [diff] [blame] | 760 | |
Lars Hjemli | aec7b36 | 2007-09-24 00:51:43 +0200 | [diff] [blame] | 761 | branch.<name>.mergeoptions:: |
| 762 | Sets default options for merging into branch <name>. The syntax and |
Jonathan Nieder | 25dcc0d | 2009-10-09 13:51:14 -0500 | [diff] [blame] | 763 | 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] | 764 | option values containing whitespace characters are currently not |
| 765 | supported. |
| 766 | |
Johannes Schindelin | cd67e4d | 2007-11-28 13:11:07 +0000 | [diff] [blame] | 767 | branch.<name>.rebase:: |
| 768 | When true, rebase the branch <name> on top of the fetched branch, |
Dustin Sallings | 15ddb6f | 2008-05-08 11:28:07 -0700 | [diff] [blame] | 769 | instead of merging the default branch from the default remote when |
Ævar Arnfjörð Bjarmason | 6b37dff | 2011-11-06 10:50:10 +0100 | [diff] [blame] | 770 | "git pull" is run. See "pull.rebase" for doing this in a non |
| 771 | branch-specific manner. |
| 772 | + |
Stephen Haberman | 66713ef | 2013-08-12 22:43:42 -0500 | [diff] [blame] | 773 | When preserve, also pass `--preserve-merges` along to 'git rebase' |
| 774 | so that locally committed merge commits will not be flattened |
| 775 | by running 'git pull'. |
| 776 | + |
Ævar Arnfjörð Bjarmason | 6b37dff | 2011-11-06 10:50:10 +0100 | [diff] [blame] | 777 | *NOTE*: this is a possibly dangerous operation; do *not* use |
| 778 | it unless you understand the implications (see linkgit:git-rebase[1] |
| 779 | for details). |
Johannes Schindelin | cd67e4d | 2007-11-28 13:11:07 +0000 | [diff] [blame] | 780 | |
Nguyễn Thái Ngọc Duy | a5ba2cb | 2013-01-01 16:30:53 +0700 | [diff] [blame] | 781 | branch.<name>.description:: |
| 782 | Branch description, can be edited with |
| 783 | `git branch --edit-description`. Branch description is |
| 784 | automatically added in the format-patch cover letter or |
| 785 | request-pull summary. |
| 786 | |
Christian Couder | 1658c61 | 2008-03-14 05:56:53 +0100 | [diff] [blame] | 787 | browser.<tool>.cmd:: |
| 788 | Specify the command to invoke the specified browser. The |
| 789 | specified command is evaluated in shell with the URLs passed |
Jonathan Nieder | 565e135 | 2011-06-29 00:35:10 -0500 | [diff] [blame] | 790 | as arguments. (See linkgit:git-web{litdd}browse[1].) |
Christian Couder | 1658c61 | 2008-03-14 05:56:53 +0100 | [diff] [blame] | 791 | |
Christian Couder | 584627b | 2008-01-29 07:08:22 +0100 | [diff] [blame] | 792 | browser.<tool>.path:: |
| 793 | Override the path for the given tool that may be used to |
Christian Couder | ab989ad | 2008-01-29 07:08:44 +0100 | [diff] [blame] | 794 | browse HTML help (see '-w' option in linkgit:git-help[1]) or a |
| 795 | working repository in gitweb (see linkgit:git-instaweb[1]). |
Christian Couder | 584627b | 2008-01-29 07:08:22 +0100 | [diff] [blame] | 796 | |
Josh Triplett | 2122591 | 2007-04-23 17:18:16 -0700 | [diff] [blame] | 797 | clean.requireForce:: |
Jiang Xin | f85f794 | 2013-08-28 09:28:32 +0800 | [diff] [blame] | 798 | A boolean to make git-clean do nothing unless given -f, |
| 799 | -i or -n. Defaults to true. |
Josh Triplett | 2122591 | 2007-04-23 17:18:16 -0700 | [diff] [blame] | 800 | |
Brian Gernhardt | f367398 | 2007-01-03 10:36:29 -0500 | [diff] [blame] | 801 | color.branch:: |
| 802 | A boolean to enable/disable color in the output of |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 803 | linkgit:git-branch[1]. May be set to `always`, |
Junio C Hamano | cec99d8 | 2007-12-05 17:05:17 -0800 | [diff] [blame] | 804 | `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] | 805 | only when the output is to a terminal. Defaults to false. |
| 806 | |
| 807 | color.branch.<slot>:: |
| 808 | Use customized color for branch coloration. `<slot>` is one of |
| 809 | `current` (the current branch), `local` (a local branch), |
Felipe Contreras | dbda21f | 2013-04-14 21:37:49 -0500 | [diff] [blame] | 810 | `remote` (a remote-tracking branch in refs/remotes/), |
| 811 | `upstream` (upstream tracking branch), `plain` (other |
Mark Wooding | 4f193f2 | 2007-01-28 15:17:36 +0000 | [diff] [blame] | 812 | refs). |
| 813 | + |
| 814 | The value for these configuration variables is a list of colors (at most |
| 815 | two) and attributes (at most one), separated by spaces. The colors |
| 816 | accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, |
| 817 | `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, |
| 818 | `blink` and `reverse`. The first color given is the foreground; the |
| 819 | second is the background. The position of the attribute, if any, |
| 820 | doesn't matter. |
Brian Gernhardt | f367398 | 2007-01-03 10:36:29 -0500 | [diff] [blame] | 821 | |
Andy Parkins | a159ca0 | 2006-12-13 09:13:28 +0000 | [diff] [blame] | 822 | color.diff:: |
Michael J Gruber | 6999c54 | 2011-04-27 09:38:27 +0200 | [diff] [blame] | 823 | Whether to use ANSI escape sequences to add color to patches. |
| 824 | If this is set to `always`, linkgit:git-diff[1], |
| 825 | linkgit:git-log[1], and linkgit:git-show[1] will use color |
| 826 | for all patches. If it is set to `true` or `auto`, those |
| 827 | commands will only use color when output is to the terminal. |
| 828 | Defaults to false. |
| 829 | + |
| 830 | This does not affect linkgit:git-format-patch[1] nor the |
| 831 | 'git-diff-{asterisk}' plumbing commands. Can be overridden on the |
| 832 | command line with the `--color[=<when>]` option. |
Junio C Hamano | b537664 | 2006-07-07 05:28:05 -0700 | [diff] [blame] | 833 | |
Andy Parkins | a159ca0 | 2006-12-13 09:13:28 +0000 | [diff] [blame] | 834 | color.diff.<slot>:: |
Mark Wooding | 4f193f2 | 2007-01-28 15:17:36 +0000 | [diff] [blame] | 835 | Use customized color for diff colorization. `<slot>` specifies |
| 836 | which part of the patch to use the specified color, and is one |
| 837 | of `plain` (context text), `meta` (metainformation), `frag` |
Bert Wesarg | 89cb73a | 2009-11-27 07:55:18 +0100 | [diff] [blame] | 838 | (hunk header), 'func' (function in hunk header), `old` (removed lines), |
| 839 | `new` (added lines), `commit` (commit headers), or `whitespace` |
| 840 | (highlighting whitespace errors). The values of these variables may be |
| 841 | specified as in color.branch.<slot>. |
Junio C Hamano | b537664 | 2006-07-07 05:28:05 -0700 | [diff] [blame] | 842 | |
Nazri Ramliy | 5e11bee | 2010-06-24 08:21:16 +0800 | [diff] [blame] | 843 | color.decorate.<slot>:: |
| 844 | Use customized color for 'git log --decorate' output. `<slot>` is one |
| 845 | of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local |
Matthieu Moy | 0e615b2 | 2010-11-02 16:31:20 +0100 | [diff] [blame] | 846 | branches, remote-tracking branches, tags, stash and HEAD, respectively. |
Nazri Ramliy | 5e11bee | 2010-06-24 08:21:16 +0800 | [diff] [blame] | 847 | |
René Scharfe | 7e8f59d | 2009-03-07 13:32:32 +0100 | [diff] [blame] | 848 | color.grep:: |
| 849 | When set to `always`, always highlight matches. When `false` (or |
| 850 | `never`), never. When set to `true` or `auto`, use color only |
| 851 | when the output is written to the terminal. Defaults to `false`. |
| 852 | |
Mark Lodato | 55f638b | 2010-03-07 11:52:46 -0500 | [diff] [blame] | 853 | color.grep.<slot>:: |
| 854 | Use customized color for grep colorization. `<slot>` specifies which |
| 855 | part of the line to use the specified color, and is one of |
| 856 | + |
| 857 | -- |
Mark Lodato | 00588bb | 2010-03-07 11:52:47 -0500 | [diff] [blame] | 858 | `context`;; |
| 859 | non-matching text in context lines (when using `-A`, `-B`, or `-C`) |
Mark Lodato | 55f638b | 2010-03-07 11:52:46 -0500 | [diff] [blame] | 860 | `filename`;; |
| 861 | filename prefix (when not using `-h`) |
Mark Lodato | 00588bb | 2010-03-07 11:52:47 -0500 | [diff] [blame] | 862 | `function`;; |
| 863 | function name lines (when using `-p`) |
Mark Lodato | 55f638b | 2010-03-07 11:52:46 -0500 | [diff] [blame] | 864 | `linenumber`;; |
| 865 | line number prefix (when using `-n`) |
| 866 | `match`;; |
| 867 | matching text |
Mark Lodato | 00588bb | 2010-03-07 11:52:47 -0500 | [diff] [blame] | 868 | `selected`;; |
| 869 | non-matching text in selected lines |
Mark Lodato | 55f638b | 2010-03-07 11:52:46 -0500 | [diff] [blame] | 870 | `separator`;; |
| 871 | separators between fields on a line (`:`, `-`, and `=`) |
| 872 | and between hunks (`--`) |
| 873 | -- |
| 874 | + |
| 875 | 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] | 876 | |
Junio C Hamano | b4c61ed | 2007-12-05 00:50:23 -0800 | [diff] [blame] | 877 | color.interactive:: |
Jeff King | 47ee06f | 2008-01-05 04:57:44 -0500 | [diff] [blame] | 878 | When set to `always`, always use colors for interactive prompts |
Jiang Xin | 7a9b0b8 | 2013-06-25 23:53:50 +0800 | [diff] [blame] | 879 | and displays (such as those used by "git-add --interactive" and |
| 880 | "git-clean --interactive"). When false (or `never`), never. |
| 881 | When set to `true` or `auto`, use colors only when the output is |
| 882 | to the terminal. Defaults to false. |
Junio C Hamano | b4c61ed | 2007-12-05 00:50:23 -0800 | [diff] [blame] | 883 | |
| 884 | color.interactive.<slot>:: |
Jiang Xin | 7a9b0b8 | 2013-06-25 23:53:50 +0800 | [diff] [blame] | 885 | Use customized color for 'git add --interactive' and 'git clean |
| 886 | --interactive' output. `<slot>` may be `prompt`, `header`, `help` |
| 887 | or `error`, for four distinct types of normal output from |
| 888 | interactive commands. The values of these variables may be |
| 889 | specified as in color.branch.<slot>. |
Junio C Hamano | b4c61ed | 2007-12-05 00:50:23 -0800 | [diff] [blame] | 890 | |
Junio C Hamano | 1d77043 | 2006-12-13 12:11:03 -0800 | [diff] [blame] | 891 | color.pager:: |
| 892 | A boolean to enable/disable colored output when the pager is in |
| 893 | use (default is true). |
| 894 | |
Markus Heidelberg | ab07ba2 | 2009-04-22 23:41:25 +0200 | [diff] [blame] | 895 | color.showbranch:: |
| 896 | A boolean to enable/disable color in the output of |
| 897 | linkgit:git-show-branch[1]. May be set to `always`, |
| 898 | `false` (or `never`) or `auto` (or `true`), in which case colors are used |
| 899 | only when the output is to a terminal. Defaults to false. |
| 900 | |
Junio C Hamano | 1d77043 | 2006-12-13 12:11:03 -0800 | [diff] [blame] | 901 | color.status:: |
| 902 | A boolean to enable/disable color in the output of |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 903 | linkgit:git-status[1]. May be set to `always`, |
Junio C Hamano | cec99d8 | 2007-12-05 17:05:17 -0800 | [diff] [blame] | 904 | `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] | 905 | only when the output is to a terminal. Defaults to false. |
| 906 | |
| 907 | color.status.<slot>:: |
| 908 | Use customized color for status colorization. `<slot>` is |
| 909 | one of `header` (the header text of the status message), |
Shawn O. Pearce | 82dca84 | 2006-12-15 21:53:13 -0500 | [diff] [blame] | 910 | `added` or `updated` (files which are added but not committed), |
| 911 | `changed` (files which are changed but not added in the index), |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 912 | `untracked` (files which are not tracked by Git), |
Aleksi Aalto | 1d28232 | 2010-11-18 01:40:05 +0200 | [diff] [blame] | 913 | `branch` (the current branch), or |
Chris Parsons | 950ce2e | 2008-05-22 08:50:02 -0400 | [diff] [blame] | 914 | `nobranch` (the color the 'no branch' warning is shown in, defaulting |
| 915 | to red). The values of these variables may be specified as in |
| 916 | color.branch.<slot>. |
Junio C Hamano | 1d77043 | 2006-12-13 12:11:03 -0800 | [diff] [blame] | 917 | |
Matthias Kestenholz | 6b2f2d9 | 2008-02-18 08:26:03 +0100 | [diff] [blame] | 918 | color.ui:: |
Michael J Gruber | 6999c54 | 2011-04-27 09:38:27 +0200 | [diff] [blame] | 919 | This variable determines the default value for variables such |
| 920 | as `color.diff` and `color.grep` that control the use of color |
| 921 | per command family. Its scope will expand as more commands learn |
| 922 | configuration to set a default for the `--color` option. Set it |
Matthieu Moy | 4c7f181 | 2013-06-10 16:26:09 +0200 | [diff] [blame] | 923 | to `false` or `never` if you prefer Git commands not to use |
| 924 | color unless enabled explicitly with some other configuration |
| 925 | or the `--color` option. Set it to `always` if you want all |
| 926 | output not intended for machine consumption to use color, to |
| 927 | `true` or `auto` (this is the default since Git 1.8.4) if you |
| 928 | want such output to use color when written to the terminal. |
Matthias Kestenholz | 6b2f2d9 | 2008-02-18 08:26:03 +0100 | [diff] [blame] | 929 | |
Nguyễn Thái Ngọc Duy | 7e29b82 | 2012-04-21 11:44:32 +0700 | [diff] [blame] | 930 | column.ui:: |
| 931 | Specify whether supported commands should output in columns. |
| 932 | This variable consists of a list of tokens separated by spaces |
| 933 | or commas: |
| 934 | + |
Ramkumar Ramachandra | 5e62cc1 | 2013-06-25 21:24:36 +0530 | [diff] [blame] | 935 | These options control when the feature should be enabled |
| 936 | (defaults to 'never'): |
| 937 | + |
Nguyễn Thái Ngọc Duy | 7e29b82 | 2012-04-21 11:44:32 +0700 | [diff] [blame] | 938 | -- |
| 939 | `always`;; |
| 940 | always show in columns |
| 941 | `never`;; |
| 942 | never show in columns |
| 943 | `auto`;; |
| 944 | show in columns if the output is to the terminal |
Ramkumar Ramachandra | 5e62cc1 | 2013-06-25 21:24:36 +0530 | [diff] [blame] | 945 | -- |
| 946 | + |
| 947 | These options control layout (defaults to 'column'). Setting any |
| 948 | of these implies 'always' if none of 'always', 'never', or 'auto' are |
| 949 | specified. |
| 950 | + |
| 951 | -- |
Nguyễn Thái Ngọc Duy | 077539d | 2012-04-13 17:54:35 +0700 | [diff] [blame] | 952 | `column`;; |
Ramkumar Ramachandra | 5e62cc1 | 2013-06-25 21:24:36 +0530 | [diff] [blame] | 953 | fill columns before rows |
Nguyễn Thái Ngọc Duy | 077539d | 2012-04-13 17:54:35 +0700 | [diff] [blame] | 954 | `row`;; |
| 955 | fill rows before columns |
Nguyễn Thái Ngọc Duy | 7e29b82 | 2012-04-21 11:44:32 +0700 | [diff] [blame] | 956 | `plain`;; |
| 957 | show in one column |
Ramkumar Ramachandra | 5e62cc1 | 2013-06-25 21:24:36 +0530 | [diff] [blame] | 958 | -- |
| 959 | + |
| 960 | Finally, these options can be combined with a layout option (defaults |
| 961 | to 'nodense'): |
| 962 | + |
| 963 | -- |
Nguyễn Thái Ngọc Duy | 3f8eccb | 2012-04-13 17:54:36 +0700 | [diff] [blame] | 964 | `dense`;; |
| 965 | make unequal size columns to utilize more space |
| 966 | `nodense`;; |
| 967 | make equal size columns |
Nguyễn Thái Ngọc Duy | 7e29b82 | 2012-04-21 11:44:32 +0700 | [diff] [blame] | 968 | -- |
Nguyễn Thái Ngọc Duy | 7e29b82 | 2012-04-21 11:44:32 +0700 | [diff] [blame] | 969 | |
Nguyễn Thái Ngọc Duy | ebe31ef | 2012-04-13 17:54:38 +0700 | [diff] [blame] | 970 | column.branch:: |
| 971 | Specify whether to output branch listing in `git branch` in columns. |
| 972 | See `column.ui` for details. |
| 973 | |
Jiang Xin | 1b8fd46 | 2013-06-25 23:53:49 +0800 | [diff] [blame] | 974 | column.clean:: |
| 975 | Specify the layout when list items in `git clean -i`, which always |
| 976 | shows files and directories in columns. See `column.ui` for details. |
| 977 | |
Nguyễn Thái Ngọc Duy | 323d053 | 2012-04-13 17:54:39 +0700 | [diff] [blame] | 978 | column.status:: |
| 979 | Specify whether to output untracked files in `git status` in columns. |
| 980 | See `column.ui` for details. |
| 981 | |
Nguyễn Thái Ngọc Duy | d96e3c1 | 2012-04-13 17:54:41 +0700 | [diff] [blame] | 982 | column.tag:: |
| 983 | Specify whether to output tag listing in `git tag` in columns. |
| 984 | See `column.ui` for details. |
| 985 | |
Ralf Thielow | 51fb3a3 | 2013-01-10 18:45:59 +0100 | [diff] [blame] | 986 | commit.cleanup:: |
| 987 | This setting overrides the default of the `--cleanup` option in |
| 988 | `git commit`. See linkgit:git-commit[1] for details. Changing the |
| 989 | default can be useful when you always want to keep lines that begin |
| 990 | with comment character `#` in your log message, in which case you |
| 991 | would do `git config commit.cleanup whitespace` (note that you will |
| 992 | have to remove the help lines that begin with `#` in the commit log |
| 993 | template yourself, if you do this). |
| 994 | |
Thomas Rast | 88955ed | 2010-01-23 23:13:17 +0100 | [diff] [blame] | 995 | commit.status:: |
James P. Howard, II | bed575e | 2009-12-07 17:45:27 -0500 | [diff] [blame] | 996 | A boolean to enable/disable inclusion of status information in the |
| 997 | commit message template when using an editor to prepare the commit |
| 998 | message. Defaults to true. |
| 999 | |
Matt McCutchen | b0f34c3 | 2008-11-26 03:26:50 -0500 | [diff] [blame] | 1000 | commit.template:: |
| 1001 | Specify a file to use as the template for new commit messages. |
Jeff King | 6cf378f | 2012-04-26 04:51:57 -0400 | [diff] [blame] | 1002 | "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the |
Matthieu Moy | df2a79f | 2009-11-19 16:21:15 +0100 | [diff] [blame] | 1003 | specified user's home directory. |
Matt McCutchen | b0f34c3 | 2008-11-26 03:26:50 -0500 | [diff] [blame] | 1004 | |
Jeff King | a6fc9fd | 2011-12-10 05:31:38 -0500 | [diff] [blame] | 1005 | credential.helper:: |
| 1006 | Specify an external helper to be called when a username or |
| 1007 | password credential is needed; the helper may consult external |
| 1008 | storage to avoid prompting the user for the credentials. See |
| 1009 | linkgit:gitcredentials[7] for details. |
| 1010 | |
| 1011 | credential.useHttpPath:: |
| 1012 | When acquiring credentials, consider the "path" component of an http |
| 1013 | or https URL to be important. Defaults to false. See |
| 1014 | linkgit:gitcredentials[7] for more information. |
| 1015 | |
| 1016 | credential.username:: |
| 1017 | If no username is set for a network authentication, use this username |
| 1018 | by default. See credential.<context>.* below, and |
| 1019 | linkgit:gitcredentials[7]. |
| 1020 | |
| 1021 | credential.<url>.*:: |
| 1022 | Any of the credential.* options above can be applied selectively to |
| 1023 | some credentials. For example "credential.https://example.com.username" |
| 1024 | would set the default username only for https connections to |
| 1025 | example.com. See linkgit:gitcredentials[7] for details on how URLs are |
| 1026 | matched. |
| 1027 | |
Ramkumar Ramachandra | 19299a8 | 2011-04-07 00:16:49 +0530 | [diff] [blame] | 1028 | include::diff-config.txt[] |
David Aguilar | afcbc8e | 2009-04-07 01:21:20 -0700 | [diff] [blame] | 1029 | |
| 1030 | difftool.<tool>.path:: |
| 1031 | Override the path for the given tool. This is useful in case |
| 1032 | your tool is not in the PATH. |
| 1033 | |
| 1034 | difftool.<tool>.cmd:: |
| 1035 | Specify the command to invoke the specified diff tool. |
| 1036 | The specified command is evaluated in shell with the following |
| 1037 | variables available: 'LOCAL' is set to the name of the temporary |
| 1038 | file containing the contents of the diff pre-image and 'REMOTE' |
| 1039 | is set to the name of the temporary file containing the contents |
| 1040 | of the diff post-image. |
| 1041 | |
David Aguilar | a904392 | 2009-04-07 01:21:22 -0700 | [diff] [blame] | 1042 | difftool.prompt:: |
| 1043 | Prompt before each invocation of the diff tool. |
| 1044 | |
Jens Lehmann | be254a0 | 2010-11-11 00:55:02 +0100 | [diff] [blame] | 1045 | fetch.recurseSubmodules:: |
Jens Lehmann | 1fb2550 | 2011-03-06 23:11:48 +0100 | [diff] [blame] | 1046 | This option can be either set to a boolean value or to 'on-demand'. |
| 1047 | Setting it to a boolean changes the behavior of fetch and pull to |
| 1048 | unconditionally recurse into submodules when set to true or to not |
| 1049 | recurse at all when set to false. When set to 'on-demand' (the default |
| 1050 | value), fetch and pull will only recurse into a populated submodule |
| 1051 | when its superproject retrieves a commit that updates the submodule's |
| 1052 | reference. |
Jens Lehmann | be254a0 | 2010-11-11 00:55:02 +0100 | [diff] [blame] | 1053 | |
Junio C Hamano | 5e838ea | 2011-09-04 12:26:14 -0700 | [diff] [blame] | 1054 | fetch.fsckObjects:: |
| 1055 | If it is set to true, git-fetch-pack will check all fetched |
| 1056 | objects. It will abort in the case of a malformed object or a |
| 1057 | broken link. The result of an abort are only dangling objects. |
Junio C Hamano | dab76d3 | 2011-09-04 12:37:45 -0700 | [diff] [blame] | 1058 | Defaults to false. If not set, the value of `transfer.fsckObjects` |
| 1059 | is used instead. |
Junio C Hamano | 5e838ea | 2011-09-04 12:26:14 -0700 | [diff] [blame] | 1060 | |
Junio C Hamano | af7cf26 | 2007-01-24 16:47:24 -0800 | [diff] [blame] | 1061 | fetch.unpackLimit:: |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 1062 | If the number of objects fetched over the Git native |
Junio C Hamano | af7cf26 | 2007-01-24 16:47:24 -0800 | [diff] [blame] | 1063 | transfer is below this |
| 1064 | limit, then the objects will be unpacked into loose object |
| 1065 | files. However if the number of received objects equals or |
| 1066 | exceeds this limit then the received pack will be stored as |
| 1067 | a pack, after adding any missing delta bases. Storing the |
| 1068 | pack from a push can make the push operation complete faster, |
Michele Ballabio | 80cd9cf | 2008-01-11 22:11:13 +0100 | [diff] [blame] | 1069 | especially on slow filesystems. If not set, the value of |
| 1070 | `transfer.unpackLimit` is used instead. |
Junio C Hamano | af7cf26 | 2007-01-24 16:47:24 -0800 | [diff] [blame] | 1071 | |
Michael Schubert | 737c5a9 | 2013-07-13 11:36:24 +0200 | [diff] [blame] | 1072 | fetch.prune:: |
| 1073 | If true, fetch will automatically behave as if the `--prune` |
| 1074 | option was given on the command line. See also `remote.<name>.prune`. |
| 1075 | |
Stephen Boyd | 48d3448 | 2009-04-23 02:37:56 -0700 | [diff] [blame] | 1076 | format.attach:: |
| 1077 | Enable multipart/mixed attachments as the default for |
| 1078 | 'format-patch'. The value can also be a double quoted string |
| 1079 | which will enable attachments as the default and set the |
| 1080 | value as the boundary. See the --attach option in |
| 1081 | linkgit:git-format-patch[1]. |
| 1082 | |
Brian Gernhardt | 49604a4 | 2007-11-03 23:38:24 -0400 | [diff] [blame] | 1083 | format.numbered:: |
Brian Gernhardt | a567fdc | 2008-10-02 16:55:39 -0400 | [diff] [blame] | 1084 | A boolean which can enable or disable sequence numbers in patch |
| 1085 | subjects. It defaults to "auto" which enables it only if there |
| 1086 | is more than one patch. It can be enabled or disabled for all |
| 1087 | messages by setting it to "true" or "false". See --numbered |
| 1088 | option in linkgit:git-format-patch[1]. |
Brian Gernhardt | 49604a4 | 2007-11-03 23:38:24 -0400 | [diff] [blame] | 1089 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1090 | format.headers:: |
| 1091 | Additional email headers to include in a patch to be submitted |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1092 | by mail. See linkgit:git-format-patch[1]. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1093 | |
Miklos Vajna | 312a30e | 2010-07-12 20:58:38 +0200 | [diff] [blame] | 1094 | format.to:: |
Stephen Boyd | 48d3448 | 2009-04-23 02:37:56 -0700 | [diff] [blame] | 1095 | format.cc:: |
Miklos Vajna | 312a30e | 2010-07-12 20:58:38 +0200 | [diff] [blame] | 1096 | Additional recipients to include in a patch to be submitted |
| 1097 | by mail. See the --to and --cc options in |
| 1098 | linkgit:git-format-patch[1]. |
Stephen Boyd | 48d3448 | 2009-04-23 02:37:56 -0700 | [diff] [blame] | 1099 | |
| 1100 | format.subjectprefix:: |
| 1101 | The default for format-patch is to output files with the '[PATCH]' |
| 1102 | subject prefix. Use this variable to change that prefix. |
| 1103 | |
Stephen Boyd | 6622d9c | 2010-06-15 22:59:25 -0700 | [diff] [blame] | 1104 | format.signature:: |
| 1105 | The default for format-patch is to output a signature containing |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 1106 | the Git version number. Use this variable to change that default. |
Stephen Boyd | 6622d9c | 2010-06-15 22:59:25 -0700 | [diff] [blame] | 1107 | Set this variable to the empty string ("") to suppress |
| 1108 | signature generation. |
| 1109 | |
Johannes Schindelin | 78cb59c | 2007-03-04 00:17:23 +0100 | [diff] [blame] | 1110 | format.suffix:: |
| 1111 | The default for format-patch is to output files with the suffix |
| 1112 | `.patch`. Use this variable to change that suffix (make sure to |
| 1113 | include the dot if you want it). |
| 1114 | |
Denis Cheng | 94c22a5 | 2008-03-02 17:05:53 +0800 | [diff] [blame] | 1115 | format.pretty:: |
| 1116 | The default pretty format for log/show/whatchanged command, |
| 1117 | See linkgit:git-log[1], linkgit:git-show[1], |
| 1118 | linkgit:git-whatchanged[1]. |
| 1119 | |
Thomas Rast | 30984ed | 2009-02-19 22:26:33 +0100 | [diff] [blame] | 1120 | format.thread:: |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 1121 | The default threading style for 'git format-patch'. Can be |
Jonathan Nieder | 578b62b | 2010-01-09 21:01:21 -0600 | [diff] [blame] | 1122 | a boolean value, or `shallow` or `deep`. `shallow` threading |
| 1123 | makes every mail a reply to the head of the series, |
Thomas Rast | 30984ed | 2009-02-19 22:26:33 +0100 | [diff] [blame] | 1124 | where the head is chosen from the cover letter, the |
Jeff King | 6cf378f | 2012-04-26 04:51:57 -0400 | [diff] [blame] | 1125 | `--in-reply-to`, and the first patch mail, in this order. |
Stephen Boyd | fd1ff30 | 2009-04-23 02:37:57 -0700 | [diff] [blame] | 1126 | `deep` threading makes every mail a reply to the previous one. |
Thomas Rast | 30984ed | 2009-02-19 22:26:33 +0100 | [diff] [blame] | 1127 | A true boolean value is the same as `shallow`, and a false |
| 1128 | value disables threading. |
| 1129 | |
Heiko Voigt | 1d1876e | 2009-04-01 19:51:54 +0200 | [diff] [blame] | 1130 | format.signoff:: |
Felipe Contreras | 240ae2b | 2013-04-27 17:00:07 -0500 | [diff] [blame] | 1131 | A boolean value which lets you enable the `-s/--signoff` option of |
| 1132 | format-patch by default. *Note:* Adding the Signed-off-by: line to a |
| 1133 | patch should be a conscious act and means that you certify you have |
| 1134 | the rights to submit this work under the same open source license. |
| 1135 | Please see the 'SubmittingPatches' document for further discussion. |
Heiko Voigt | 1d1876e | 2009-04-01 19:51:54 +0200 | [diff] [blame] | 1136 | |
Felipe Contreras | 2a4c260 | 2013-04-07 12:46:23 -0500 | [diff] [blame] | 1137 | format.coverLetter:: |
| 1138 | A boolean that controls whether to generate a cover-letter when |
| 1139 | format-patch is invoked, but in addition can be set to "auto", to |
| 1140 | generate a cover-letter only when there's more than one patch. |
| 1141 | |
Ramkumar Ramachandra | 26488f5 | 2011-04-07 00:16:48 +0530 | [diff] [blame] | 1142 | filter.<driver>.clean:: |
| 1143 | The command which is used to convert the content of a worktree |
| 1144 | file to a blob upon checkin. See linkgit:gitattributes[5] for |
| 1145 | details. |
| 1146 | |
| 1147 | filter.<driver>.smudge:: |
| 1148 | The command which is used to convert the content of a blob |
| 1149 | object to a worktree file upon checkout. See |
| 1150 | linkgit:gitattributes[5] for details. |
| 1151 | |
Theodore Tso | 0d7566a | 2007-05-09 15:48:39 -0400 | [diff] [blame] | 1152 | gc.aggressiveWindow:: |
| 1153 | The window size parameter used in the delta compression |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 1154 | algorithm used by 'git gc --aggressive'. This defaults |
Jay Soffian | f78683f | 2010-04-13 12:52:55 -0400 | [diff] [blame] | 1155 | to 250. |
Theodore Tso | 0d7566a | 2007-05-09 15:48:39 -0400 | [diff] [blame] | 1156 | |
Junio C Hamano | e9831e8 | 2007-09-17 00:39:52 -0700 | [diff] [blame] | 1157 | gc.auto:: |
| 1158 | When there are approximately more than this many loose |
| 1159 | objects in the repository, `git gc --auto` will pack them. |
| 1160 | Some Porcelain commands use this command to perform a |
Michele Ballabio | 80cd9cf | 2008-01-11 22:11:13 +0100 | [diff] [blame] | 1161 | light-weight garbage collection from time to time. The |
| 1162 | default value is 6700. Setting this to 0 disables it. |
Junio C Hamano | e9831e8 | 2007-09-17 00:39:52 -0700 | [diff] [blame] | 1163 | |
Junio C Hamano | 1781550 | 2007-09-17 00:55:13 -0700 | [diff] [blame] | 1164 | gc.autopacklimit:: |
| 1165 | When there are more than this many packs that are not |
| 1166 | marked with `*.keep` file in the repository, `git gc |
Michele Ballabio | 80cd9cf | 2008-01-11 22:11:13 +0100 | [diff] [blame] | 1167 | --auto` consolidates them into one larger pack. The |
Junio C Hamano | 9706397 | 2008-03-23 00:04:48 -0700 | [diff] [blame] | 1168 | default value is 50. Setting this to 0 disables it. |
Junio C Hamano | 1781550 | 2007-09-17 00:55:13 -0700 | [diff] [blame] | 1169 | |
Nguyễn Thái Ngọc Duy | 9f673f9 | 2014-02-08 14:08:52 +0700 | [diff] [blame^] | 1170 | gc.autodetach:: |
| 1171 | Make `git gc --auto` return immediately andrun in background |
| 1172 | if the system supports it. Default is true. |
| 1173 | |
Johannes Schindelin | c2120e5 | 2007-02-13 14:01:42 +0100 | [diff] [blame] | 1174 | gc.packrefs:: |
Jonathan Nieder | efc266e | 2010-01-09 20:59:41 -0600 | [diff] [blame] | 1175 | Running `git pack-refs` in a repository renders it |
| 1176 | unclonable by Git versions prior to 1.5.1.2 over dumb |
| 1177 | transports such as HTTP. This variable determines whether |
Jiang Xin | 4be0c35 | 2010-12-16 15:16:49 +0800 | [diff] [blame] | 1178 | 'git gc' runs `git pack-refs`. This can be set to `notbare` |
Jonathan Nieder | efc266e | 2010-01-09 20:59:41 -0600 | [diff] [blame] | 1179 | to enable it within all non-bare repos or it can be set to a |
| 1180 | boolean value. The default is `true`. |
Johannes Schindelin | c2120e5 | 2007-02-13 14:01:42 +0100 | [diff] [blame] | 1181 | |
Johannes Schindelin | 25ee973 | 2008-03-12 21:55:47 +0100 | [diff] [blame] | 1182 | gc.pruneexpire:: |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 1183 | 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] | 1184 | Override the grace period with this config variable. The value |
| 1185 | "now" may be used to disable this grace period and always prune |
| 1186 | unreachable objects immediately. |
Johannes Schindelin | 25ee973 | 2008-03-12 21:55:47 +0100 | [diff] [blame] | 1187 | |
Junio C Hamano | 4aec56d | 2006-12-27 01:47:57 -0800 | [diff] [blame] | 1188 | gc.reflogexpire:: |
Junio C Hamano | eb523a8 | 2010-04-14 13:12:34 -0700 | [diff] [blame] | 1189 | gc.<pattern>.reflogexpire:: |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 1190 | 'git reflog expire' removes reflog entries older than |
Junio C Hamano | eb523a8 | 2010-04-14 13:12:34 -0700 | [diff] [blame] | 1191 | this time; defaults to 90 days. With "<pattern>" (e.g. |
| 1192 | "refs/stash") in the middle the setting applies only to |
| 1193 | the refs that match the <pattern>. |
Junio C Hamano | 4aec56d | 2006-12-27 01:47:57 -0800 | [diff] [blame] | 1194 | |
| 1195 | gc.reflogexpireunreachable:: |
Junio C Hamano | eb523a8 | 2010-04-14 13:12:34 -0700 | [diff] [blame] | 1196 | gc.<ref>.reflogexpireunreachable:: |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 1197 | 'git reflog expire' removes reflog entries older than |
Junio C Hamano | 4aec56d | 2006-12-27 01:47:57 -0800 | [diff] [blame] | 1198 | this time and are not reachable from the current tip; |
Junio C Hamano | eb523a8 | 2010-04-14 13:12:34 -0700 | [diff] [blame] | 1199 | defaults to 30 days. With "<pattern>" (e.g. "refs/stash") |
| 1200 | in the middle, the setting applies only to the refs that |
| 1201 | match the <pattern>. |
Junio C Hamano | 4aec56d | 2006-12-27 01:47:57 -0800 | [diff] [blame] | 1202 | |
Junio C Hamano | 48c3242 | 2006-12-27 01:24:05 -0800 | [diff] [blame] | 1203 | gc.rerereresolved:: |
| 1204 | Records of conflicted merge you resolved earlier are |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 1205 | kept for this many days when 'git rerere gc' is run. |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1206 | The default is 60 days. See linkgit:git-rerere[1]. |
Junio C Hamano | 48c3242 | 2006-12-27 01:24:05 -0800 | [diff] [blame] | 1207 | |
| 1208 | gc.rerereunresolved:: |
| 1209 | Records of conflicted merge you have not resolved are |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 1210 | kept for this many days when 'git rerere gc' is run. |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1211 | The default is 15 days. See linkgit:git-rerere[1]. |
Junio C Hamano | 48c3242 | 2006-12-27 01:24:05 -0800 | [diff] [blame] | 1212 | |
Fabian Emmes | 280514e | 2009-01-02 16:40:13 +0100 | [diff] [blame] | 1213 | gitcvs.commitmsgannotation:: |
| 1214 | Append this string to each commit message. Set to empty string |
| 1215 | to disable this feature. Defaults to "via git-CVS emulator". |
| 1216 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1217 | gitcvs.enabled:: |
Brian Hetro | db21872 | 2007-08-23 20:40:08 -0400 | [diff] [blame] | 1218 | Whether the CVS server interface is enabled for this repository. |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1219 | See linkgit:git-cvsserver[1]. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1220 | |
| 1221 | gitcvs.logfile:: |
Brian Hetro | db21872 | 2007-08-23 20:40:08 -0400 | [diff] [blame] | 1222 | Path to a log file where the CVS server interface well... logs |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1223 | various stuff. See linkgit:git-cvsserver[1]. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1224 | |
Teemu Likonen | 1707adb | 2008-08-29 10:29:42 +0300 | [diff] [blame] | 1225 | gitcvs.usecrlfattr:: |
Eyvind Bernhardsen | 5ec3e67 | 2010-05-19 22:43:11 +0200 | [diff] [blame] | 1226 | If true, the server will look up the end-of-line conversion |
| 1227 | attributes for files to determine the '-k' modes to use. If |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 1228 | the attributes force Git to treat a file as text, |
Ville Skyttä | 6b677a2 | 2010-07-20 00:17:17 +0300 | [diff] [blame] | 1229 | the '-k' mode will be left blank so CVS clients will |
Eyvind Bernhardsen | 5ec3e67 | 2010-05-19 22:43:11 +0200 | [diff] [blame] | 1230 | treat it as text. If they suppress text conversion, the file |
Mike Ralphson | 1168d40 | 2008-08-05 17:12:05 +0100 | [diff] [blame] | 1231 | will be set with '-kb' mode, which suppresses any newline munging |
Eyvind Bernhardsen | 5ec3e67 | 2010-05-19 22:43:11 +0200 | [diff] [blame] | 1232 | the client might otherwise do. If the attributes do not allow |
| 1233 | the file type to be determined, then 'gitcvs.allbinary' is |
| 1234 | used. See linkgit:gitattributes[5]. |
Matthew Ogilvie | 8a06a63 | 2008-05-14 22:35:47 -0600 | [diff] [blame] | 1235 | |
Frank Lichtenheld | eabb0bf | 2007-04-13 18:02:30 +0200 | [diff] [blame] | 1236 | gitcvs.allbinary:: |
Matthew Ogilvie | 90948a4 | 2008-05-14 22:35:48 -0600 | [diff] [blame] | 1237 | This is used if 'gitcvs.usecrlfattr' does not resolve |
| 1238 | the correct '-kb' mode to use. If true, all |
| 1239 | unresolved files are sent to the client in |
| 1240 | mode '-kb'. This causes the client to treat them |
| 1241 | as binary files, which suppresses any newline munging it |
| 1242 | otherwise might do. Alternatively, if it is set to "guess", |
| 1243 | then the contents of the file are examined to decide if |
| 1244 | it is binary, similar to 'core.autocrlf'. |
Junio C Hamano | abbf594 | 2007-04-17 22:17:46 -0700 | [diff] [blame] | 1245 | |
Frank Lichtenheld | 0475286 | 2007-04-13 18:13:42 +0200 | [diff] [blame] | 1246 | gitcvs.dbname:: |
| 1247 | Database used by git-cvsserver to cache revision information |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 1248 | derived from the Git repository. The exact meaning depends on the |
Frank Lichtenheld | 0475286 | 2007-04-13 18:13:42 +0200 | [diff] [blame] | 1249 | used database driver, for SQLite (which is the default driver) this |
| 1250 | is a filename. Supports variable substitution (see |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1251 | linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`). |
Frank Lichtenheld | 0475286 | 2007-04-13 18:13:42 +0200 | [diff] [blame] | 1252 | Default: '%Ggitcvs.%m.sqlite' |
| 1253 | |
| 1254 | gitcvs.dbdriver:: |
| 1255 | Used Perl DBI driver. You can specify any available driver |
Felipe Contreras | 240ae2b | 2013-04-27 17:00:07 -0500 | [diff] [blame] | 1256 | for this here, but it might not work. git-cvsserver is tested |
Frank Lichtenheld | 0475286 | 2007-04-13 18:13:42 +0200 | [diff] [blame] | 1257 | with 'DBD::SQLite', reported to work with 'DBD::Pg', and |
| 1258 | reported *not* to work with 'DBD::mysql'. Experimental feature. |
| 1259 | May not contain double colons (`:`). Default: 'SQLite'. |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1260 | See linkgit:git-cvsserver[1]. |
Frank Lichtenheld | eabb0bf | 2007-04-13 18:02:30 +0200 | [diff] [blame] | 1261 | |
Frank Lichtenheld | 0475286 | 2007-04-13 18:13:42 +0200 | [diff] [blame] | 1262 | gitcvs.dbuser, gitcvs.dbpass:: |
| 1263 | Database user and password. Only useful if setting 'gitcvs.dbdriver', |
| 1264 | since SQLite has no concept of database users and/or passwords. |
| 1265 | 'gitcvs.dbuser' supports variable substitution (see |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1266 | linkgit:git-cvsserver[1] for details). |
Frank Lichtenheld | 0475286 | 2007-04-13 18:13:42 +0200 | [diff] [blame] | 1267 | |
Josh Elsasser | 6aeeffd | 2008-03-27 14:02:14 -0700 | [diff] [blame] | 1268 | gitcvs.dbTableNamePrefix:: |
| 1269 | Database table name prefix. Prepended to the names of any |
| 1270 | database tables used, allowing a single database to be used |
| 1271 | for several repositories. Supports variable substitution (see |
| 1272 | linkgit:git-cvsserver[1] for details). Any non-alphabetic |
| 1273 | characters will be replaced with underscores. |
| 1274 | |
Matthew Ogilvie | 8a06a63 | 2008-05-14 22:35:47 -0600 | [diff] [blame] | 1275 | All gitcvs variables except for 'gitcvs.usecrlfattr' and |
| 1276 | 'gitcvs.allbinary' can also be specified as |
| 1277 | 'gitcvs.<access_method>.<varname>' (where 'access_method' |
Brian Hetro | 0278307 | 2007-08-23 20:44:13 -0400 | [diff] [blame] | 1278 | is one of "ext" and "pserver") to make them apply only for the given |
| 1279 | access method. |
Frank Lichtenheld | 0475286 | 2007-04-13 18:13:42 +0200 | [diff] [blame] | 1280 | |
Jakub Narebski | cd82323 | 2011-10-16 13:07:34 +0200 | [diff] [blame] | 1281 | gitweb.category:: |
| 1282 | gitweb.description:: |
| 1283 | gitweb.owner:: |
| 1284 | gitweb.url:: |
| 1285 | See linkgit:gitweb[1] for description. |
| 1286 | |
| 1287 | gitweb.avatar:: |
| 1288 | gitweb.blame:: |
| 1289 | gitweb.grep:: |
| 1290 | gitweb.highlight:: |
| 1291 | gitweb.patches:: |
| 1292 | gitweb.pickaxe:: |
| 1293 | gitweb.remote_heads:: |
| 1294 | gitweb.showsizes:: |
| 1295 | gitweb.snapshot:: |
| 1296 | See linkgit:gitweb.conf[5] for description. |
| 1297 | |
Joe Ratterman | b22520a | 2011-03-30 14:31:05 -0500 | [diff] [blame] | 1298 | grep.lineNumber:: |
| 1299 | If set to true, enable '-n' option by default. |
| 1300 | |
J Smith | 84befcd | 2012-08-03 10:53:50 -0400 | [diff] [blame] | 1301 | grep.patternType:: |
| 1302 | Set the default matching behavior. Using a value of 'basic', 'extended', |
| 1303 | 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp', |
| 1304 | '--fixed-strings', or '--perl-regexp' option accordingly, while the |
| 1305 | value 'default' will return to the default matching behavior. |
| 1306 | |
Joe Ratterman | b22520a | 2011-03-30 14:31:05 -0500 | [diff] [blame] | 1307 | grep.extendedRegexp:: |
J Smith | 84befcd | 2012-08-03 10:53:50 -0400 | [diff] [blame] | 1308 | If set to true, enable '--extended-regexp' option by default. This |
| 1309 | option is ignored when the 'grep.patternType' option is set to a value |
| 1310 | other than 'default'. |
Joe Ratterman | b22520a | 2011-03-30 14:31:05 -0500 | [diff] [blame] | 1311 | |
Junio C Hamano | 0c5e70f | 2011-11-29 12:29:48 -0800 | [diff] [blame] | 1312 | gpg.program:: |
| 1313 | Use this custom program instead of "gpg" found on $PATH when |
| 1314 | making or verifying a PGP signature. The program must support the |
| 1315 | same command line interface as GPG, namely, to verify a detached |
| 1316 | signature, "gpg --verify $file - <$signature" is run, and the |
| 1317 | program is expected to signal a good signature by exiting with |
| 1318 | code 0, and to generate an ascii-armored detached signature, the |
| 1319 | standard input of "gpg -bsau $key" is fed with the contents to be |
| 1320 | signed, and the program is expected to send the result to its |
| 1321 | standard output. |
| 1322 | |
Gustaf Hendeby | d84ae0d | 2008-05-08 10:55:02 +0200 | [diff] [blame] | 1323 | gui.commitmsgwidth:: |
| 1324 | Defines how wide the commit message window is in the |
| 1325 | linkgit:git-gui[1]. "75" is the default. |
| 1326 | |
| 1327 | gui.diffcontext:: |
| 1328 | Specifies how many context lines should be used in calls to diff |
| 1329 | made by the linkgit:git-gui[1]. The default is "5". |
| 1330 | |
Alexander Gavrilov | a2df1fb | 2008-11-13 20:28:49 +0300 | [diff] [blame] | 1331 | gui.encoding:: |
| 1332 | Specifies the default encoding to use for displaying of |
| 1333 | file contents in linkgit:git-gui[1] and linkgit:gitk[1]. |
| 1334 | It can be overridden by setting the 'encoding' attribute |
| 1335 | for relevant files (see linkgit:gitattributes[5]). |
| 1336 | If this option is not set, the tools default to the |
| 1337 | locale encoding. |
| 1338 | |
Gustaf Hendeby | d84ae0d | 2008-05-08 10:55:02 +0200 | [diff] [blame] | 1339 | gui.matchtrackingbranch:: |
| 1340 | Determines if new branches created with linkgit:git-gui[1] should |
| 1341 | default to tracking remote branches with matching names or |
| 1342 | not. Default: "false". |
| 1343 | |
| 1344 | gui.newbranchtemplate:: |
| 1345 | Is used as suggested name when creating new branches using the |
| 1346 | linkgit:git-gui[1]. |
| 1347 | |
| 1348 | gui.pruneduringfetch:: |
Matthieu Moy | 8b3f3f8 | 2010-11-02 16:31:23 +0100 | [diff] [blame] | 1349 | "true" if linkgit:git-gui[1] should prune remote-tracking branches when |
Gustaf Hendeby | d84ae0d | 2008-05-08 10:55:02 +0200 | [diff] [blame] | 1350 | performing a fetch. The default value is "false". |
| 1351 | |
| 1352 | gui.trustmtime:: |
| 1353 | Determines if linkgit:git-gui[1] should trust the file modification |
| 1354 | timestamp or not. By default the timestamps are not trusted. |
| 1355 | |
| 1356 | gui.spellingdictionary:: |
| 1357 | Specifies the dictionary used for spell checking commit messages in |
| 1358 | the linkgit:git-gui[1]. When set to "none" spell checking is turned |
| 1359 | off. |
| 1360 | |
Alexander Gavrilov | a2df1fb | 2008-11-13 20:28:49 +0300 | [diff] [blame] | 1361 | gui.fastcopyblame:: |
Thomas Rast | ca76828 | 2010-01-07 17:49:12 +0100 | [diff] [blame] | 1362 | 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] | 1363 | location detection. It makes blame significantly faster on huge |
| 1364 | repositories at the expense of less thorough copy detection. |
| 1365 | |
| 1366 | gui.copyblamethreshold:: |
Ralf Wildenhues | 76bac89 | 2008-11-27 08:32:01 +0100 | [diff] [blame] | 1367 | Specifies the threshold to use in 'git gui blame' original location |
Alexander Gavrilov | a2df1fb | 2008-11-13 20:28:49 +0300 | [diff] [blame] | 1368 | detection, measured in alphanumeric characters. See the |
| 1369 | linkgit:git-blame[1] manual for more information on copy detection. |
| 1370 | |
| 1371 | gui.blamehistoryctx:: |
| 1372 | Specifies the radius of history context in days to show in |
| 1373 | linkgit:gitk[1] for the selected commit, when the `Show History |
| 1374 | Context` menu item is invoked from 'git gui blame'. If this |
| 1375 | variable is set to zero, the whole history is shown. |
| 1376 | |
Alexander Gavrilov | 390c348 | 2008-12-14 22:44:32 +0300 | [diff] [blame] | 1377 | guitool.<name>.cmd:: |
| 1378 | Specifies the shell command line to execute when the corresponding item |
| 1379 | of the linkgit:git-gui[1] `Tools` menu is invoked. This option is |
| 1380 | mandatory for every tool. The command is executed from the root of |
| 1381 | the working directory, and in the environment it receives the name of |
| 1382 | the tool as 'GIT_GUITOOL', the name of the currently selected file as |
| 1383 | 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if |
| 1384 | the head is detached, 'CUR_BRANCH' is empty). |
| 1385 | |
| 1386 | guitool.<name>.needsfile:: |
| 1387 | Run the tool only if a diff is selected in the GUI. It guarantees |
| 1388 | that 'FILENAME' is not empty. |
| 1389 | |
| 1390 | guitool.<name>.noconsole:: |
| 1391 | Run the command silently, without creating a window to display its |
| 1392 | output. |
| 1393 | |
| 1394 | guitool.<name>.norescan:: |
| 1395 | Don't rescan the working directory for changes after the tool |
| 1396 | finishes execution. |
| 1397 | |
| 1398 | guitool.<name>.confirm:: |
| 1399 | Show a confirmation dialog before actually running the tool. |
| 1400 | |
| 1401 | guitool.<name>.argprompt:: |
| 1402 | Request a string argument from the user, and pass it to the tool |
| 1403 | through the 'ARGS' environment variable. Since requesting an |
| 1404 | argument implies confirmation, the 'confirm' option has no effect |
| 1405 | if this is enabled. If the option is set to 'true', 'yes', or '1', |
| 1406 | the dialog uses a built-in generic prompt; otherwise the exact |
| 1407 | value of the variable is used. |
| 1408 | |
| 1409 | guitool.<name>.revprompt:: |
| 1410 | Request a single valid revision from the user, and set the |
| 1411 | 'REVISION' environment variable. In other aspects this option |
| 1412 | is similar to 'argprompt', and can be used together with it. |
| 1413 | |
| 1414 | guitool.<name>.revunmerged:: |
| 1415 | Show only unmerged branches in the 'revprompt' subdialog. |
| 1416 | This is useful for tools similar to merge or rebase, but not |
| 1417 | for things like checkout or reset. |
| 1418 | |
| 1419 | guitool.<name>.title:: |
| 1420 | Specifies the title to use for the prompt dialog. The default |
| 1421 | is the tool name. |
| 1422 | |
| 1423 | guitool.<name>.prompt:: |
| 1424 | Specifies the general prompt string to display at the top of |
| 1425 | the dialog, before subsections for 'argprompt' and 'revprompt'. |
| 1426 | The default value includes the actual command. |
| 1427 | |
Christian Couder | 983a9ee | 2008-01-08 04:55:14 +0100 | [diff] [blame] | 1428 | help.browser:: |
| 1429 | Specify the browser that will be used to display help in the |
| 1430 | 'web' format. See linkgit:git-help[1]. |
| 1431 | |
| 1432 | help.format:: |
| 1433 | Override the default help format used by linkgit:git-help[1]. |
| 1434 | Values 'man', 'info', 'web' and 'html' are supported. 'man' is |
| 1435 | the default. 'web' and 'html' are the same. |
| 1436 | |
Alex Riesen | f0e9071 | 2008-08-31 15:54:58 +0200 | [diff] [blame] | 1437 | help.autocorrect:: |
| 1438 | Automatically correct and execute mistyped commands after |
| 1439 | waiting for the given number of deciseconds (0.1 sec). If more |
| 1440 | than one command can be deduced from the entered text, nothing |
| 1441 | will be executed. If the value of this option is negative, |
| 1442 | the corrected command will be executed immediately. If the |
| 1443 | value is 0 - the command will be just shown but not executed. |
| 1444 | This is the default. |
| 1445 | |
Sebastian Staudt | b1f809d | 2013-01-15 21:56:21 +0100 | [diff] [blame] | 1446 | help.htmlpath:: |
| 1447 | Specify the path where the HTML documentation resides. File system paths |
| 1448 | and URLs are supported. HTML pages will be prefixed with this path when |
| 1449 | help is displayed in the 'web' format. This defaults to the documentation |
| 1450 | path of your Git installation. |
| 1451 | |
Sam Vilain | 9c5665a | 2007-11-23 13:07:00 +1300 | [diff] [blame] | 1452 | http.proxy:: |
Clemens Buchacher | b2c8c6d | 2012-03-04 17:50:43 +0100 | [diff] [blame] | 1453 | Override the HTTP proxy, normally configured using the 'http_proxy', |
| 1454 | 'https_proxy', and 'all_proxy' environment variables (see |
| 1455 | `curl(1)`). This can be overridden on a per-remote basis; see |
| 1456 | remote.<name>.proxy |
Sam Vilain | 9c5665a | 2007-11-23 13:07:00 +1300 | [diff] [blame] | 1457 | |
Duncan Brown | bcfb95d | 2011-06-02 16:31:25 -0400 | [diff] [blame] | 1458 | http.cookiefile:: |
| 1459 | File containing previously stored cookie lines which should be used |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 1460 | in the Git http session, if they match the server. The file format |
Duncan Brown | bcfb95d | 2011-06-02 16:31:25 -0400 | [diff] [blame] | 1461 | of the file to read cookies from should be plain HTTP headers or |
| 1462 | the Netscape/Mozilla cookie file format (see linkgit:curl[1]). |
| 1463 | NOTE that the file specified with http.cookiefile is only used as |
Dave Borowitz | 912b2ac | 2013-07-23 15:40:17 -0700 | [diff] [blame] | 1464 | input unless http.saveCookies is set. |
| 1465 | |
| 1466 | http.savecookies:: |
| 1467 | If set, store cookies received during requests to the file specified by |
| 1468 | http.cookiefile. Has no effect if http.cookiefile is unset. |
Duncan Brown | bcfb95d | 2011-06-02 16:31:25 -0400 | [diff] [blame] | 1469 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1470 | http.sslVerify:: |
| 1471 | Whether to verify the SSL certificate when fetching or pushing |
Francis Daly | 3742506 | 2006-06-07 13:56:45 +0100 | [diff] [blame] | 1472 | over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1473 | variable. |
| 1474 | |
| 1475 | http.sslCert:: |
| 1476 | File containing the SSL certificate when fetching or pushing |
Francis Daly | 3742506 | 2006-06-07 13:56:45 +0100 | [diff] [blame] | 1477 | over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1478 | variable. |
| 1479 | |
| 1480 | http.sslKey:: |
| 1481 | File containing the SSL private key when fetching or pushing |
Horst H. von Brand | abda1ef | 2006-06-03 16:27:26 -0400 | [diff] [blame] | 1482 | over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1483 | variable. |
| 1484 | |
Mark Lodato | 754ae19 | 2009-05-27 23:16:03 -0400 | [diff] [blame] | 1485 | http.sslCertPasswordProtected:: |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 1486 | Enable Git's password prompt for the SSL certificate. Otherwise |
Mark Lodato | 754ae19 | 2009-05-27 23:16:03 -0400 | [diff] [blame] | 1487 | OpenSSL will prompt the user, possibly many times, if the |
| 1488 | certificate or private key is encrypted. Can be overridden by the |
| 1489 | 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable. |
| 1490 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1491 | http.sslCAInfo:: |
| 1492 | File containing the certificates to verify the peer with when |
Horst H. von Brand | abda1ef | 2006-06-03 16:27:26 -0400 | [diff] [blame] | 1493 | fetching or pushing over HTTPS. Can be overridden by the |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1494 | 'GIT_SSL_CAINFO' environment variable. |
| 1495 | |
| 1496 | http.sslCAPath:: |
| 1497 | Path containing files with the CA certificates to verify the peer |
Francis Daly | 3742506 | 2006-06-07 13:56:45 +0100 | [diff] [blame] | 1498 | with when fetching or pushing over HTTPS. Can be overridden |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1499 | by the 'GIT_SSL_CAPATH' environment variable. |
| 1500 | |
Modestas Vainius | 4bc444e | 2013-04-07 22:10:39 +0300 | [diff] [blame] | 1501 | http.sslTry:: |
| 1502 | Attempt to use AUTH SSL/TLS and encrypted data transfers |
| 1503 | when connecting via regular FTP protocol. This might be needed |
| 1504 | if the FTP server requires it for security reasons or you wish |
| 1505 | to connect securely whenever remote FTP server supports it. |
| 1506 | Default is false since it might trigger certificate verification |
| 1507 | errors on misconfigured servers. |
| 1508 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1509 | http.maxRequests:: |
Horst H. von Brand | abda1ef | 2006-06-03 16:27:26 -0400 | [diff] [blame] | 1510 | How many HTTP requests to launch in parallel. Can be overridden |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1511 | by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5. |
| 1512 | |
Tay Ray Chuan | ad75ebe | 2009-11-27 23:42:26 +0800 | [diff] [blame] | 1513 | http.minSessions:: |
| 1514 | The number of curl sessions (counted across slots) to be kept across |
| 1515 | requests. They will not be ended with curl_easy_cleanup() until |
| 1516 | http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this |
| 1517 | value will be capped at 1. Defaults to 1. |
| 1518 | |
Shawn O. Pearce | de1a2fd | 2009-10-30 17:47:41 -0700 | [diff] [blame] | 1519 | http.postBuffer:: |
| 1520 | Maximum size in bytes of the buffer used by smart HTTP |
| 1521 | transports when POSTing data to the remote system. |
| 1522 | For requests larger than this buffer size, HTTP/1.1 and |
| 1523 | Transfer-Encoding: chunked is used to avoid creating a |
| 1524 | massive pack file locally. Default is 1 MiB, which is |
| 1525 | sufficient for most requests. |
| 1526 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1527 | http.lowSpeedLimit, http.lowSpeedTime:: |
| 1528 | If the HTTP transfer speed is less than 'http.lowSpeedLimit' |
| 1529 | for longer than 'http.lowSpeedTime' seconds, the transfer is aborted. |
Horst H. von Brand | abda1ef | 2006-06-03 16:27:26 -0400 | [diff] [blame] | 1530 | Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1531 | 'GIT_HTTP_LOW_SPEED_TIME' environment variables. |
| 1532 | |
Sasha Khapyorsky | 3ea099d | 2006-09-29 03:10:44 +0300 | [diff] [blame] | 1533 | http.noEPSV:: |
| 1534 | A boolean which disables using of EPSV ftp command by curl. |
Frank Lichtenheld | befc9c4 | 2007-04-13 18:02:33 +0200 | [diff] [blame] | 1535 | This can helpful with some "poor" ftp servers which don't |
Sasha Khapyorsky | 3ea099d | 2006-09-29 03:10:44 +0300 | [diff] [blame] | 1536 | support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV' |
| 1537 | environment variable. Default is false (curl will use EPSV). |
| 1538 | |
Spencer E. Olson | b1d1058 | 2010-08-11 14:40:38 -0600 | [diff] [blame] | 1539 | http.useragent:: |
| 1540 | The HTTP USER_AGENT string presented to an HTTP server. The default |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 1541 | value represents the version of the client Git such as git/1.7.1. |
Spencer E. Olson | b1d1058 | 2010-08-11 14:40:38 -0600 | [diff] [blame] | 1542 | This option allows you to override this value to a more common value |
| 1543 | such as Mozilla/4.0. This may be necessary, for instance, if |
| 1544 | connecting through a firewall that restricts HTTP connections to a set |
| 1545 | of common USER_AGENT strings (but not including those like git/1.7.1). |
| 1546 | Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable. |
| 1547 | |
Kyle J. McKay | 6a56993 | 2013-08-05 13:20:36 -0700 | [diff] [blame] | 1548 | http.<url>.*:: |
| 1549 | Any of the http.* options above can be applied selectively to some urls. |
| 1550 | For a config key to match a URL, each element of the config key is |
| 1551 | compared to that of the URL, in the following order: |
| 1552 | + |
| 1553 | -- |
| 1554 | . Scheme (e.g., `https` in `https://example.com/`). This field |
| 1555 | must match exactly between the config key and the URL. |
| 1556 | |
| 1557 | . Host/domain name (e.g., `example.com` in `https://example.com/`). |
| 1558 | This field must match exactly between the config key and the URL. |
| 1559 | |
| 1560 | . Port number (e.g., `8080` in `http://example.com:8080/`). |
| 1561 | This field must match exactly between the config key and the URL. |
| 1562 | Omitted port numbers are automatically converted to the correct |
| 1563 | default for the scheme before matching. |
| 1564 | |
| 1565 | . Path (e.g., `repo.git` in `https://example.com/repo.git`). The |
| 1566 | path field of the config key must match the path field of the URL |
| 1567 | either exactly or as a prefix of slash-delimited path elements. This means |
| 1568 | a config key with path `foo/` matches URL path `foo/bar`. A prefix can only |
| 1569 | match on a slash (`/`) boundary. Longer matches take precedence (so a config |
| 1570 | key with path `foo/bar` is a better match to URL path `foo/bar` than a config |
| 1571 | key with just path `foo/`). |
| 1572 | |
| 1573 | . User name (e.g., `user` in `https://user@example.com/repo.git`). If |
| 1574 | the config key has a user name it must match the user name in the |
| 1575 | URL exactly. If the config key does not have a user name, that |
| 1576 | config key will match a URL with any user name (including none), |
| 1577 | but at a lower precedence than a config key with a user name. |
| 1578 | -- |
| 1579 | + |
| 1580 | The list above is ordered by decreasing precedence; a URL that matches |
| 1581 | a config key's path is preferred to one that matches its user name. For example, |
| 1582 | if the URL is `https://user@example.com/foo/bar` a config key match of |
| 1583 | `https://example.com/foo` will be preferred over a config key match of |
| 1584 | `https://user@example.com`. |
| 1585 | + |
| 1586 | All URLs are normalized before attempting any matching (the password part, |
| 1587 | if embedded in the URL, is always ignored for matching purposes) so that |
| 1588 | equivalent urls that are simply spelled differently will match properly. |
| 1589 | Environment variable settings always override any matches. The urls that are |
| 1590 | matched against are those given directly to Git commands. This means any URLs |
| 1591 | visited as a result of a redirection do not participate in matching. |
| 1592 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1593 | i18n.commitEncoding:: |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 1594 | Character encoding the commit messages are stored in; Git itself |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1595 | does not care per se, but this information is necessary e.g. when |
| 1596 | importing commits from emails or in the gitk graphical history |
| 1597 | browser (and possibly at other places in the future or in other |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1598 | porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1599 | |
Junio C Hamano | d2c11a3 | 2006-12-27 16:41:33 -0800 | [diff] [blame] | 1600 | i18n.logOutputEncoding:: |
| 1601 | Character encoding the commit messages are converted to when |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 1602 | running 'git log' and friends. |
Junio C Hamano | d2c11a3 | 2006-12-27 16:41:33 -0800 | [diff] [blame] | 1603 | |
Matt McCutchen | b0f34c3 | 2008-11-26 03:26:50 -0500 | [diff] [blame] | 1604 | imap:: |
| 1605 | The configuration variables in the 'imap' section are described |
| 1606 | in linkgit:git-imap-send[1]. |
| 1607 | |
Steven Drake | d8a8488 | 2010-02-17 12:44:46 +1300 | [diff] [blame] | 1608 | init.templatedir:: |
| 1609 | Specify the directory from which templates will be copied. |
| 1610 | (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].) |
| 1611 | |
Christian Couder | 983a9ee | 2008-01-08 04:55:14 +0100 | [diff] [blame] | 1612 | instaweb.browser:: |
| 1613 | Specify the program that will be used to browse your working |
| 1614 | repository in gitweb. See linkgit:git-instaweb[1]. |
| 1615 | |
| 1616 | instaweb.httpd:: |
| 1617 | The HTTP daemon command-line to start gitweb on your working |
| 1618 | repository. See linkgit:git-instaweb[1]. |
| 1619 | |
| 1620 | instaweb.local:: |
| 1621 | If true the web server started by linkgit:git-instaweb[1] will |
| 1622 | be bound to the local IP (127.0.0.1). |
| 1623 | |
| 1624 | instaweb.modulepath:: |
Ville Skyttä | 6b677a2 | 2010-07-20 00:17:17 +0300 | [diff] [blame] | 1625 | The default module path for linkgit:git-instaweb[1] to use |
| 1626 | instead of /usr/lib/apache2/modules. Only used if httpd |
| 1627 | is Apache. |
Christian Couder | 983a9ee | 2008-01-08 04:55:14 +0100 | [diff] [blame] | 1628 | |
| 1629 | instaweb.port:: |
| 1630 | The port number to bind the gitweb httpd to. See |
| 1631 | linkgit:git-instaweb[1]. |
| 1632 | |
Thomas Rast | ca6ac7f | 2009-02-05 09:28:26 +0100 | [diff] [blame] | 1633 | interactive.singlekey:: |
Ori Avtalion | 57f6ec0 | 2009-08-07 17:24:21 +0300 | [diff] [blame] | 1634 | In interactive commands, allow the user to provide one-letter |
Thomas Rast | ca6ac7f | 2009-02-05 09:28:26 +0100 | [diff] [blame] | 1635 | input with a single key (i.e., without hitting enter). |
Jeff King | 6cf378f | 2012-04-26 04:51:57 -0400 | [diff] [blame] | 1636 | Currently this is used by the `--patch` mode of |
Conrad Irwin | e6b57a8 | 2011-05-07 10:59:04 -0700 | [diff] [blame] | 1637 | linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1], |
| 1638 | linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this |
| 1639 | setting is silently ignored if portable keystroke input |
| 1640 | is not available. |
Thomas Rast | ca6ac7f | 2009-02-05 09:28:26 +0100 | [diff] [blame] | 1641 | |
Jay Soffian | 0c47695 | 2011-05-18 13:56:04 -0400 | [diff] [blame] | 1642 | log.abbrevCommit:: |
| 1643 | If true, makes linkgit:git-log[1], linkgit:git-show[1], and |
Jeff King | 6cf378f | 2012-04-26 04:51:57 -0400 | [diff] [blame] | 1644 | linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may |
| 1645 | override this option with `--no-abbrev-commit`. |
Jay Soffian | 0c47695 | 2011-05-18 13:56:04 -0400 | [diff] [blame] | 1646 | |
Heikki Orsila | dd0ffd5 | 2008-05-22 18:24:07 +0300 | [diff] [blame] | 1647 | log.date:: |
Jonathan Nieder | e860795 | 2010-08-20 05:20:36 -0500 | [diff] [blame] | 1648 | Set the default date-time mode for the 'log' command. |
| 1649 | Setting a value for log.date is similar to using 'git log''s |
Jeff King | 6cf378f | 2012-04-26 04:51:57 -0400 | [diff] [blame] | 1650 | `--date` option. Possible values are `relative`, `local`, |
Jonathan Nieder | e860795 | 2010-08-20 05:20:36 -0500 | [diff] [blame] | 1651 | `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1] |
| 1652 | for details. |
Heikki Orsila | dd0ffd5 | 2008-05-22 18:24:07 +0300 | [diff] [blame] | 1653 | |
Steven Drake | eb73445 | 2010-02-17 12:39:52 +1300 | [diff] [blame] | 1654 | log.decorate:: |
| 1655 | Print out the ref names of any commits that are shown by the log |
| 1656 | command. If 'short' is specified, the ref name prefixes 'refs/heads/', |
| 1657 | 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is |
| 1658 | specified, the full ref name (including prefix) will be printed. |
| 1659 | This is the same as the log commands '--decorate' option. |
| 1660 | |
Peter Baumann | 0f03ca9 | 2006-11-23 10:36:33 +0100 | [diff] [blame] | 1661 | log.showroot:: |
| 1662 | If true, the initial commit will be shown as a big creation event. |
| 1663 | This is equivalent to a diff against an empty tree. |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1664 | Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which |
Peter Baumann | 0f03ca9 | 2006-11-23 10:36:33 +0100 | [diff] [blame] | 1665 | normally hide the root commit will now show it. True by default. |
| 1666 | |
Antoine Pelisse | e6bb5f7 | 2013-01-05 22:26:46 +0100 | [diff] [blame] | 1667 | log.mailmap:: |
| 1668 | If true, makes linkgit:git-log[1], linkgit:git-show[1], and |
| 1669 | linkgit:git-whatchanged[1] assume `--use-mailmap`. |
| 1670 | |
Marius Storm-Olsen | d551a48 | 2009-02-08 15:34:27 +0100 | [diff] [blame] | 1671 | mailmap.file:: |
| 1672 | The location of an augmenting mailmap file. The default |
| 1673 | mailmap, located in the root of the repository, is loaded |
| 1674 | first, then the mailmap file pointed to by this variable. |
| 1675 | The location of the mailmap file may be in a repository |
| 1676 | subdirectory, or somewhere outside of the repository itself. |
| 1677 | See linkgit:git-shortlog[1] and linkgit:git-blame[1]. |
| 1678 | |
Jeff King | 0861090 | 2012-12-12 06:04:04 -0500 | [diff] [blame] | 1679 | mailmap.blob:: |
| 1680 | Like `mailmap.file`, but consider the value as a reference to a |
Jeff King | 8c473ce | 2012-12-13 08:04:47 -0500 | [diff] [blame] | 1681 | blob in the repository. If both `mailmap.file` and |
| 1682 | `mailmap.blob` are given, both are parsed, with entries from |
| 1683 | `mailmap.file` taking precedence. In a bare repository, this |
| 1684 | defaults to `HEAD:.mailmap`. In a non-bare repository, it |
| 1685 | defaults to empty. |
Jeff King | 0861090 | 2012-12-12 06:04:04 -0500 | [diff] [blame] | 1686 | |
Christian Couder | b5578f3 | 2008-03-07 08:46:55 +0100 | [diff] [blame] | 1687 | man.viewer:: |
Christian Couder | b8322ea | 2008-03-13 06:48:46 +0100 | [diff] [blame] | 1688 | Specify the programs that may be used to display help in the |
Christian Couder | b5578f3 | 2008-03-07 08:46:55 +0100 | [diff] [blame] | 1689 | 'man' format. See linkgit:git-help[1]. |
| 1690 | |
Christian Couder | 0bb6400 | 2008-04-25 08:25:35 +0200 | [diff] [blame] | 1691 | man.<tool>.cmd:: |
| 1692 | Specify the command to invoke the specified man viewer. The |
| 1693 | specified command is evaluated in shell with the man page |
| 1694 | passed as argument. (See linkgit:git-help[1].) |
| 1695 | |
Christian Couder | 7e8114c | 2008-04-25 08:24:41 +0200 | [diff] [blame] | 1696 | man.<tool>.path:: |
| 1697 | Override the path for the given tool that may be used to |
| 1698 | display help in the 'man' format. See linkgit:git-help[1]. |
| 1699 | |
Matt McCutchen | b0f34c3 | 2008-11-26 03:26:50 -0500 | [diff] [blame] | 1700 | include::merge-config.txt[] |
Junio C Hamano | b541248 | 2008-08-29 10:49:56 -0700 | [diff] [blame] | 1701 | |
Johannes Schindelin | 77680ca | 2007-12-17 12:21:22 +0000 | [diff] [blame] | 1702 | mergetool.<tool>.path:: |
| 1703 | Override the path for the given tool. This is useful in case |
| 1704 | your tool is not in the PATH. |
| 1705 | |
Charles Bailey | 964473a | 2008-02-21 23:31:12 +0000 | [diff] [blame] | 1706 | mergetool.<tool>.cmd:: |
| 1707 | Specify the command to invoke the specified merge tool. The |
| 1708 | specified command is evaluated in shell with the following |
| 1709 | variables available: 'BASE' is the name of a temporary file |
| 1710 | containing the common base of the files to be merged, if available; |
| 1711 | 'LOCAL' is the name of a temporary file containing the contents of |
| 1712 | the file on the current branch; 'REMOTE' is the name of a temporary |
| 1713 | file containing the contents of the file from the branch being |
| 1714 | merged; 'MERGED' contains the name of the file to which the merge |
| 1715 | tool should write the results of a successful merge. |
| 1716 | |
| 1717 | mergetool.<tool>.trustExitCode:: |
| 1718 | For a custom merge command, specify whether the exit code of |
| 1719 | the merge command can be used to determine whether the merge was |
| 1720 | successful. If this is not set to true then the merge target file |
| 1721 | timestamp is checked and the merge assumed to have been successful |
| 1722 | if the file has been updated, otherwise the user is prompted to |
| 1723 | indicate the success of the merge. |
| 1724 | |
Charles Bailey | 44c36d1 | 2008-02-21 23:30:02 +0000 | [diff] [blame] | 1725 | mergetool.keepBackup:: |
| 1726 | After performing a merge, the original file with conflict markers |
| 1727 | can be saved as a file with a `.orig` extension. If this variable |
| 1728 | is set to `false` then this file is not preserved. Defaults to |
| 1729 | `true` (i.e. keep the backup files). |
| 1730 | |
Charles Bailey | 162eba8 | 2008-12-12 21:48:41 +0000 | [diff] [blame] | 1731 | mergetool.keepTemporaries:: |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 1732 | When invoking a custom merge tool, Git uses a set of temporary |
Charles Bailey | 162eba8 | 2008-12-12 21:48:41 +0000 | [diff] [blame] | 1733 | files to pass to the tool. If the tool returns an error and this |
| 1734 | variable is set to `true`, then these temporary files will be |
| 1735 | preserved, otherwise they will be removed after the tool has |
| 1736 | exited. Defaults to `false`. |
| 1737 | |
Charles Bailey | 682b451 | 2008-11-13 12:41:14 +0000 | [diff] [blame] | 1738 | mergetool.prompt:: |
| 1739 | Prompt before each invocation of the merge resolution program. |
| 1740 | |
Thomas Rast | 894a9d3 | 2010-03-12 18:04:26 +0100 | [diff] [blame] | 1741 | notes.displayRef:: |
| 1742 | The (fully qualified) refname from which to show notes when |
| 1743 | showing commit messages. The value of this variable can be set |
| 1744 | to a glob, in which case notes from all matching refs will be |
| 1745 | shown. You may also specify this configuration variable |
| 1746 | several times. A warning will be issued for refs that do not |
| 1747 | exist, but a glob that does not match any refs is silently |
| 1748 | ignored. |
| 1749 | + |
| 1750 | This setting can be overridden with the `GIT_NOTES_DISPLAY_REF` |
| 1751 | environment variable, which must be a colon separated list of refs or |
| 1752 | globs. |
| 1753 | + |
| 1754 | The effective value of "core.notesRef" (possibly overridden by |
| 1755 | GIT_NOTES_REF) is also implicitly added to the list of refs to be |
| 1756 | displayed. |
| 1757 | |
Thomas Rast | 6956f85 | 2010-03-12 18:04:32 +0100 | [diff] [blame] | 1758 | notes.rewrite.<command>:: |
| 1759 | When rewriting commits with <command> (currently `amend` or |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 1760 | `rebase`) and this variable is set to `true`, Git |
Thomas Rast | 6956f85 | 2010-03-12 18:04:32 +0100 | [diff] [blame] | 1761 | automatically copies your notes from the original to the |
| 1762 | rewritten commit. Defaults to `true`, but see |
| 1763 | "notes.rewriteRef" below. |
Thomas Rast | 6956f85 | 2010-03-12 18:04:32 +0100 | [diff] [blame] | 1764 | |
| 1765 | notes.rewriteMode:: |
| 1766 | When copying notes during a rewrite (see the |
| 1767 | "notes.rewrite.<command>" option), determines what to do if |
| 1768 | the target commit already has a note. Must be one of |
| 1769 | `overwrite`, `concatenate`, or `ignore`. Defaults to |
| 1770 | `concatenate`. |
| 1771 | + |
| 1772 | This setting can be overridden with the `GIT_NOTES_REWRITE_MODE` |
| 1773 | environment variable. |
| 1774 | |
| 1775 | notes.rewriteRef:: |
| 1776 | When copying notes during a rewrite, specifies the (fully |
| 1777 | qualified) ref whose notes should be copied. The ref may be a |
| 1778 | glob, in which case notes in all matching refs will be copied. |
| 1779 | You may also specify this configuration several times. |
| 1780 | + |
| 1781 | Does not have a default value; you must configure this variable to |
Thomas Rast | 2b4aa89 | 2011-09-13 09:32:42 +0200 | [diff] [blame] | 1782 | enable note rewriting. Set it to `refs/notes/commits` to enable |
| 1783 | rewriting for the default commit notes. |
Leif Arne Storset | cfb88e9 | 2010-05-05 16:16:25 +0200 | [diff] [blame] | 1784 | + |
| 1785 | This setting can be overridden with the `GIT_NOTES_REWRITE_REF` |
| 1786 | environment variable, which must be a colon separated list of refs or |
| 1787 | globs. |
Thomas Rast | 6956f85 | 2010-03-12 18:04:32 +0100 | [diff] [blame] | 1788 | |
Jeff King | 4812a93 | 2006-07-23 01:50:30 -0400 | [diff] [blame] | 1789 | pack.window:: |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1790 | 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] | 1791 | window size is given on the command line. Defaults to 10. |
| 1792 | |
Theodore Ts'o | 842aaf9 | 2007-05-08 09:28:26 -0400 | [diff] [blame] | 1793 | pack.depth:: |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1794 | 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] | 1795 | maximum depth is given on the command line. Defaults to 50. |
Theodore Ts'o | 842aaf9 | 2007-05-08 09:28:26 -0400 | [diff] [blame] | 1796 | |
Brian Downing | e93b15c | 2007-07-12 07:55:52 -0500 | [diff] [blame] | 1797 | pack.windowMemory:: |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1798 | The window memory size limit used by linkgit:git-pack-objects[1] |
Brian Downing | e93b15c | 2007-07-12 07:55:52 -0500 | [diff] [blame] | 1799 | when no limit is given on the command line. The value can be |
| 1800 | suffixed with "k", "m", or "g". Defaults to 0, meaning no |
| 1801 | limit. |
| 1802 | |
Dana How | 960ccca | 2007-05-09 13:56:50 -0700 | [diff] [blame] | 1803 | pack.compression:: |
| 1804 | An integer -1..9, indicating the compression level for objects |
| 1805 | in a pack file. -1 is the zlib default. 0 means no |
| 1806 | compression, and 1..9 are various speed/size tradeoffs, 9 being |
| 1807 | slowest. If not set, defaults to core.compression. If that is |
Brian Downing | dec9230 | 2007-11-19 10:58:51 -0600 | [diff] [blame] | 1808 | not set, defaults to -1, the zlib default, which is "a default |
| 1809 | compromise between speed and compression (currently equivalent |
| 1810 | to level 6)." |
Jan Krüger | 89d71f7 | 2010-09-27 14:21:58 +0200 | [diff] [blame] | 1811 | + |
| 1812 | Note that changing the compression level will not automatically recompress |
| 1813 | all existing objects. You can force recompression by passing the -F option |
| 1814 | to linkgit:git-repack[1]. |
Dana How | 960ccca | 2007-05-09 13:56:50 -0700 | [diff] [blame] | 1815 | |
Martin Koegler | 074b2ee | 2007-05-28 23:20:58 +0200 | [diff] [blame] | 1816 | pack.deltaCacheSize:: |
Brian Hetro | 0278307 | 2007-08-23 20:44:13 -0400 | [diff] [blame] | 1817 | The maximum memory in bytes used for caching deltas in |
Nicolas Pitre | 5749b0b | 2009-08-05 16:55:07 -0400 | [diff] [blame] | 1818 | linkgit:git-pack-objects[1] before writing them out to a pack. |
| 1819 | This cache is used to speed up the writing object phase by not |
| 1820 | having to recompute the final delta result once the best match |
| 1821 | for all objects is found. Repacking large repositories on machines |
| 1822 | which are tight with memory might be badly impacted by this though, |
| 1823 | especially if this cache pushes the system into swapping. |
| 1824 | A value of 0 means no limit. The smallest size of 1 byte may be |
| 1825 | used to virtually disable this cache. Defaults to 256 MiB. |
Martin Koegler | 074b2ee | 2007-05-28 23:20:58 +0200 | [diff] [blame] | 1826 | |
Martin Koegler | e3dfddb | 2007-05-28 23:20:59 +0200 | [diff] [blame] | 1827 | pack.deltaCacheLimit:: |
Nicolas Pitre | 693b86f | 2007-09-10 11:51:34 -0400 | [diff] [blame] | 1828 | The maximum size of a delta, that is cached in |
Nicolas Pitre | 5749b0b | 2009-08-05 16:55:07 -0400 | [diff] [blame] | 1829 | linkgit:git-pack-objects[1]. This cache is used to speed up the |
| 1830 | writing object phase by not having to recompute the final delta |
| 1831 | 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] | 1832 | |
Nicolas Pitre | 693b86f | 2007-09-10 11:51:34 -0400 | [diff] [blame] | 1833 | pack.threads:: |
| 1834 | Specifies the number of threads to spawn when searching for best |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 1835 | delta matches. This requires that linkgit:git-pack-objects[1] |
Nicolas Pitre | 693b86f | 2007-09-10 11:51:34 -0400 | [diff] [blame] | 1836 | be compiled with pthreads otherwise this option is ignored with a |
| 1837 | warning. This is meant to reduce packing time on multiprocessor |
| 1838 | machines. The required amount of memory for the delta search window |
| 1839 | is however multiplied by the number of threads. |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 1840 | Specifying 0 will cause Git to auto-detect the number of CPU's |
Andreas Ericsson | 833e3df | 2008-02-22 20:11:56 -0600 | [diff] [blame] | 1841 | and set the number of threads accordingly. |
Nicolas Pitre | 693b86f | 2007-09-10 11:51:34 -0400 | [diff] [blame] | 1842 | |
Nicolas Pitre | 4d00bda | 2007-11-01 23:26:04 -0400 | [diff] [blame] | 1843 | pack.indexVersion:: |
| 1844 | Specify the default pack index version. Valid values are 1 for |
| 1845 | legacy pack index used by Git versions prior to 1.5.2, and 2 for |
| 1846 | the new pack index with capabilities for packs larger than 4 GB |
| 1847 | as well as proper protection against the repacking of corrupted |
Nicolas Pitre | c0a5e2d | 2008-06-25 00:25:53 -0400 | [diff] [blame] | 1848 | packs. Version 2 is the default. Note that version 2 is enforced |
| 1849 | and this config option ignored whenever the corresponding pack is |
| 1850 | larger than 2 GB. |
| 1851 | + |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 1852 | If you have an old Git that does not understand the version 2 `*.idx` file, |
Nicolas Pitre | c0a5e2d | 2008-06-25 00:25:53 -0400 | [diff] [blame] | 1853 | cloning or fetching over a non native protocol (e.g. "http" and "rsync") |
Jeff King | 6cf378f | 2012-04-26 04:51:57 -0400 | [diff] [blame] | 1854 | that will copy both `*.pack` file and corresponding `*.idx` file from the |
Nicolas Pitre | c0a5e2d | 2008-06-25 00:25:53 -0400 | [diff] [blame] | 1855 | other side may give you a repository that cannot be accessed with your |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 1856 | older version of Git. If the `*.pack` file is smaller than 2 GB, however, |
Nicolas Pitre | c0a5e2d | 2008-06-25 00:25:53 -0400 | [diff] [blame] | 1857 | you can use linkgit:git-index-pack[1] on the *.pack file to regenerate |
Jeff King | 6cf378f | 2012-04-26 04:51:57 -0400 | [diff] [blame] | 1858 | the `*.idx` file. |
Nicolas Pitre | 4d00bda | 2007-11-01 23:26:04 -0400 | [diff] [blame] | 1859 | |
Junio C Hamano | dbdbfec | 2008-03-12 23:11:15 -0700 | [diff] [blame] | 1860 | pack.packSizeLimit:: |
Nicolas Pitre | 07cf0f2 | 2010-02-03 22:48:28 -0500 | [diff] [blame] | 1861 | The maximum size of a pack. This setting only affects |
| 1862 | packing to a file when repacking, i.e. the git:// protocol |
Jeff King | 6cf378f | 2012-04-26 04:51:57 -0400 | [diff] [blame] | 1863 | is unaffected. It can be overridden by the `--max-pack-size` |
Nicolas Pitre | 07cf0f2 | 2010-02-03 22:48:28 -0500 | [diff] [blame] | 1864 | option of linkgit:git-repack[1]. The minimum size allowed is |
| 1865 | limited to 1 MiB. The default is unlimited. |
| 1866 | Common unit suffixes of 'k', 'm', or 'g' are |
| 1867 | supported. |
Johannes Schindelin | 2b84b5a | 2008-02-05 14:25:04 +0000 | [diff] [blame] | 1868 | |
Miklos Vajna | 4370c2d | 2008-08-16 04:14:33 +0200 | [diff] [blame] | 1869 | pager.<cmd>:: |
Jeff King | 9bad723 | 2010-11-17 12:04:12 -0500 | [diff] [blame] | 1870 | If the value is boolean, turns on or off pagination of the |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 1871 | output of a particular Git subcommand when writing to a tty. |
Jeff King | 9bad723 | 2010-11-17 12:04:12 -0500 | [diff] [blame] | 1872 | Otherwise, turns on pagination for the subcommand using the |
Jeff King | 6cf378f | 2012-04-26 04:51:57 -0400 | [diff] [blame] | 1873 | pager specified by the value of `pager.<cmd>`. If `--paginate` |
| 1874 | or `--no-pager` is specified on the command line, it takes |
Jeff King | 9bad723 | 2010-11-17 12:04:12 -0500 | [diff] [blame] | 1875 | precedence over this option. To disable pagination for all |
| 1876 | commands, set `core.pager` or `GIT_PAGER` to `cat`. |
Miklos Vajna | 4370c2d | 2008-08-16 04:14:33 +0200 | [diff] [blame] | 1877 | |
Will Palmer | 8028184 | 2010-05-02 12:00:44 +0100 | [diff] [blame] | 1878 | pretty.<name>:: |
| 1879 | Alias for a --pretty= format string, as specified in |
| 1880 | linkgit:git-log[1]. Any aliases defined here can be used just |
| 1881 | as the built-in pretty formats could. For example, |
Jeff King | 6cf378f | 2012-04-26 04:51:57 -0400 | [diff] [blame] | 1882 | running `git config pretty.changelog "format:* %H %s"` |
Will Palmer | 8028184 | 2010-05-02 12:00:44 +0100 | [diff] [blame] | 1883 | would cause the invocation `git log --pretty=changelog` |
Jeff King | 6cf378f | 2012-04-26 04:51:57 -0400 | [diff] [blame] | 1884 | to be equivalent to running `git log "--pretty=format:* %H %s"`. |
Will Palmer | 8028184 | 2010-05-02 12:00:44 +0100 | [diff] [blame] | 1885 | Note that an alias with the same name as a built-in format |
| 1886 | will be silently ignored. |
| 1887 | |
Ævar Arnfjörð Bjarmason | 6b37dff | 2011-11-06 10:50:10 +0100 | [diff] [blame] | 1888 | pull.rebase:: |
| 1889 | When true, rebase branches on top of the fetched branch, instead |
| 1890 | of merging the default branch from the default remote when "git |
| 1891 | pull" is run. See "branch.<name>.rebase" for setting this on a |
| 1892 | per-branch basis. |
| 1893 | + |
Stephen Haberman | 66713ef | 2013-08-12 22:43:42 -0500 | [diff] [blame] | 1894 | When preserve, also pass `--preserve-merges` along to 'git rebase' |
| 1895 | so that locally committed merge commits will not be flattened |
| 1896 | by running 'git pull'. |
| 1897 | + |
Ævar Arnfjörð Bjarmason | 6b37dff | 2011-11-06 10:50:10 +0100 | [diff] [blame] | 1898 | *NOTE*: this is a possibly dangerous operation; do *not* use |
| 1899 | it unless you understand the implications (see linkgit:git-rebase[1] |
| 1900 | for details). |
| 1901 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 1902 | pull.octopus:: |
| 1903 | The default merge strategy to use when pulling multiple branches |
| 1904 | at once. |
| 1905 | |
| 1906 | pull.twohead:: |
| 1907 | The default merge strategy to use when pulling a single branch. |
| 1908 | |
Finn Arne Gangstad | 5215374 | 2009-03-16 16:42:51 +0100 | [diff] [blame] | 1909 | push.default:: |
Ramkumar Ramachandra | 87a70e4 | 2013-06-19 16:41:40 +0530 | [diff] [blame] | 1910 | Defines the action `git push` should take if no refspec is |
| 1911 | explicitly given. Different values are well-suited for |
| 1912 | specific workflows; for instance, in a purely central workflow |
| 1913 | (i.e. the fetch source is equal to the push destination), |
| 1914 | `upstream` is probably what you want. Possible values are: |
Finn Arne Gangstad | 5215374 | 2009-03-16 16:42:51 +0100 | [diff] [blame] | 1915 | + |
Andreas Schwab | b129051 | 2012-06-23 15:18:00 +0200 | [diff] [blame] | 1916 | -- |
Ramkumar Ramachandra | 87a70e4 | 2013-06-19 16:41:40 +0530 | [diff] [blame] | 1917 | |
| 1918 | * `nothing` - do not push anything (error out) unless a refspec is |
| 1919 | explicitly given. This is primarily meant for people who want to |
| 1920 | avoid mistakes by always being explicit. |
| 1921 | |
| 1922 | * `current` - push the current branch to update a branch with the same |
| 1923 | name on the receiving end. Works in both central and non-central |
| 1924 | workflows. |
| 1925 | |
| 1926 | * `upstream` - push the current branch back to the branch whose |
| 1927 | changes are usually integrated into the current branch (which is |
| 1928 | called `@{upstream}`). This mode only makes sense if you are |
| 1929 | pushing to the same repository you would normally pull from |
| 1930 | (i.e. central workflow). |
| 1931 | |
Ramkumar Ramachandra | ed2b182 | 2013-06-19 16:41:41 +0530 | [diff] [blame] | 1932 | * `simple` - in centralized workflow, work like `upstream` with an |
| 1933 | added safety to refuse to push if the upstream branch's name is |
| 1934 | different from the local one. |
Andreas Schwab | b129051 | 2012-06-23 15:18:00 +0200 | [diff] [blame] | 1935 | + |
Ramkumar Ramachandra | ed2b182 | 2013-06-19 16:41:41 +0530 | [diff] [blame] | 1936 | When pushing to a remote that is different from the remote you normally |
| 1937 | pull from, work as `current`. This is the safest option and is suited |
| 1938 | for beginners. |
Andreas Schwab | b129051 | 2012-06-23 15:18:00 +0200 | [diff] [blame] | 1939 | + |
Ramkumar Ramachandra | 87a70e4 | 2013-06-19 16:41:40 +0530 | [diff] [blame] | 1940 | This mode will become the default in Git 2.0. |
| 1941 | |
| 1942 | * `matching` - push all branches having the same name on both ends. |
| 1943 | This makes the repository you are pushing to remember the set of |
| 1944 | branches that will be pushed out (e.g. if you always push 'maint' |
| 1945 | and 'master' there and no other branches, the repository you push |
| 1946 | to will have these two branches, and your local 'maint' and |
| 1947 | 'master' will be pushed there). |
| 1948 | + |
| 1949 | To use this mode effectively, you have to make sure _all_ the |
| 1950 | branches you would push out are ready to be pushed out before |
| 1951 | running 'git push', as the whole point of this mode is to allow you |
| 1952 | to push all of the branches in one go. If you usually finish work |
| 1953 | on only one branch and push out the result, while other branches are |
| 1954 | unfinished, this mode is not for you. Also this mode is not |
| 1955 | suitable for pushing into a shared central repository, as other |
| 1956 | people may add new branches there, or update the tip of existing |
| 1957 | branches outside your control. |
| 1958 | + |
| 1959 | This is currently the default, but Git 2.0 will change the default |
| 1960 | to `simple`. |
| 1961 | |
| 1962 | -- |
Finn Arne Gangstad | 5215374 | 2009-03-16 16:42:51 +0100 | [diff] [blame] | 1963 | |
Tor Arne Vestbø | a9c3821 | 2009-03-01 23:11:38 +0100 | [diff] [blame] | 1964 | rebase.stat:: |
| 1965 | Whether to show a diffstat of what changed upstream since the last |
| 1966 | rebase. False by default. |
| 1967 | |
Heiko Voigt | dd1e5b3 | 2010-07-14 13:59:57 +0200 | [diff] [blame] | 1968 | rebase.autosquash:: |
| 1969 | If set to true enable '--autosquash' option by default. |
| 1970 | |
Ramkumar Ramachandra | 5879477 | 2013-05-12 17:26:41 +0530 | [diff] [blame] | 1971 | rebase.autostash:: |
| 1972 | When set to true, automatically create a temporary stash |
| 1973 | before the operation begins, and apply it after the operation |
| 1974 | ends. This means that you can run rebase on a dirty worktree. |
| 1975 | However, use with care: the final stash application after a |
| 1976 | successful rebase might result in non-trivial conflicts. |
| 1977 | Defaults to false. |
| 1978 | |
Junio C Hamano | 77e3efb | 2009-10-20 14:56:40 -0700 | [diff] [blame] | 1979 | receive.autogc:: |
| 1980 | By default, git-receive-pack will run "git-gc --auto" after |
| 1981 | receiving data from git-push and updating refs. You can stop |
| 1982 | it by setting this variable to false. |
| 1983 | |
Matt McCutchen | b0f34c3 | 2008-11-26 03:26:50 -0500 | [diff] [blame] | 1984 | receive.fsckObjects:: |
| 1985 | If it is set to true, git-receive-pack will check all received |
| 1986 | objects. It will abort in the case of a malformed object or a |
| 1987 | broken link. The result of an abort are only dangling objects. |
Junio C Hamano | dab76d3 | 2011-09-04 12:37:45 -0700 | [diff] [blame] | 1988 | Defaults to false. If not set, the value of `transfer.fsckObjects` |
| 1989 | is used instead. |
Matt McCutchen | b0f34c3 | 2008-11-26 03:26:50 -0500 | [diff] [blame] | 1990 | |
| 1991 | receive.unpackLimit:: |
| 1992 | If the number of objects received in a push is below this |
| 1993 | limit then the objects will be unpacked into loose object |
| 1994 | files. However if the number of received objects equals or |
| 1995 | exceeds this limit then the received pack will be stored as |
| 1996 | a pack, after adding any missing delta bases. Storing the |
| 1997 | pack from a push can make the push operation complete faster, |
| 1998 | especially on slow filesystems. If not set, the value of |
| 1999 | `transfer.unpackLimit` is used instead. |
| 2000 | |
Junio C Hamano | 42fc11c | 2008-11-26 11:11:18 -0800 | [diff] [blame] | 2001 | receive.denyDeletes:: |
| 2002 | If set to true, git-receive-pack will deny a ref update that deletes |
| 2003 | the ref. Use this to prevent such a ref deletion via a push. |
| 2004 | |
Thomas Rast | 662c83f | 2010-07-24 18:07:53 +0200 | [diff] [blame] | 2005 | receive.denyDeleteCurrent:: |
| 2006 | If set to true, git-receive-pack will deny a ref update that |
| 2007 | deletes the currently checked out branch of a non-bare repository. |
| 2008 | |
Junio C Hamano | 42fc11c | 2008-11-26 11:11:18 -0800 | [diff] [blame] | 2009 | receive.denyCurrentBranch:: |
Michael J Gruber | f3838ce | 2010-05-13 14:51:38 +0200 | [diff] [blame] | 2010 | 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] | 2011 | to the currently checked out branch of a non-bare repository. |
| 2012 | Such a push is potentially dangerous because it brings the HEAD |
| 2013 | out of sync with the index and working tree. If set to "warn", |
| 2014 | print a warning of such a push to stderr, but allow the push to |
| 2015 | proceed. If set to false or "ignore", allow such pushes with no |
Thomas Rast | 7d182f5 | 2010-03-17 12:14:57 +0100 | [diff] [blame] | 2016 | message. Defaults to "refuse". |
Junio C Hamano | 42fc11c | 2008-11-26 11:11:18 -0800 | [diff] [blame] | 2017 | |
Matt McCutchen | b0f34c3 | 2008-11-26 03:26:50 -0500 | [diff] [blame] | 2018 | receive.denyNonFastForwards:: |
| 2019 | 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] | 2020 | 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] | 2021 | even if that push is forced. This configuration variable is |
| 2022 | set when initializing a shared repository. |
| 2023 | |
Junio C Hamano | daebaa7 | 2013-01-18 16:08:30 -0800 | [diff] [blame] | 2024 | receive.hiderefs:: |
| 2025 | String(s) `receive-pack` uses to decide which refs to omit |
| 2026 | from its initial advertisement. Use more than one |
| 2027 | definitions to specify multiple prefix strings. A ref that |
| 2028 | are under the hierarchies listed on the value of this |
| 2029 | variable is excluded, and is hidden when responding to `git |
| 2030 | push`, and an attempt to update or delete a hidden ref by |
| 2031 | `git push` is rejected. |
| 2032 | |
Junio C Hamano | 77e3efb | 2009-10-20 14:56:40 -0700 | [diff] [blame] | 2033 | receive.updateserverinfo:: |
| 2034 | If set to true, git-receive-pack will run git-update-server-info |
| 2035 | after receiving data from git-push and updating refs. |
| 2036 | |
Nguyễn Thái Ngọc Duy | 0a1bc12 | 2013-12-05 20:02:47 +0700 | [diff] [blame] | 2037 | receive.shallowupdate:: |
| 2038 | If set to true, .git/shallow can be updated when new refs |
| 2039 | require new shallow roots. Otherwise those refs are rejected. |
| 2040 | |
Ramkumar Ramachandra | 224c217 | 2013-04-02 13:10:33 +0530 | [diff] [blame] | 2041 | remote.pushdefault:: |
| 2042 | The remote to push to by default. Overrides |
Ramkumar Ramachandra | 9f765ce | 2013-04-02 13:10:34 +0530 | [diff] [blame] | 2043 | `branch.<name>.remote` for all branches, and is overridden by |
| 2044 | `branch.<name>.pushremote` for specific branches. |
Ramkumar Ramachandra | 224c217 | 2013-04-02 13:10:33 +0530 | [diff] [blame] | 2045 | |
Santi Béjar | 0cc6d34 | 2006-10-23 18:42:14 +0200 | [diff] [blame] | 2046 | remote.<name>.url:: |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 2047 | The URL of a remote repository. See linkgit:git-fetch[1] or |
| 2048 | linkgit:git-push[1]. |
Santi Béjar | 0cc6d34 | 2006-10-23 18:42:14 +0200 | [diff] [blame] | 2049 | |
Michael J Gruber | 2034623 | 2009-06-09 18:01:34 +0200 | [diff] [blame] | 2050 | remote.<name>.pushurl:: |
| 2051 | The push URL of a remote repository. See linkgit:git-push[1]. |
| 2052 | |
Sam Vilain | 14c9821 | 2007-12-04 10:48:54 +1300 | [diff] [blame] | 2053 | remote.<name>.proxy:: |
| 2054 | For remotes that require curl (http, https and ftp), the URL to |
| 2055 | the proxy to use for that remote. Set to the empty string to |
| 2056 | disable proxying for that remote. |
| 2057 | |
Santi Béjar | 0cc6d34 | 2006-10-23 18:42:14 +0200 | [diff] [blame] | 2058 | remote.<name>.fetch:: |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 2059 | The default set of "refspec" for linkgit:git-fetch[1]. See |
| 2060 | linkgit:git-fetch[1]. |
Santi Béjar | 0cc6d34 | 2006-10-23 18:42:14 +0200 | [diff] [blame] | 2061 | |
| 2062 | remote.<name>.push:: |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 2063 | The default set of "refspec" for linkgit:git-push[1]. See |
| 2064 | linkgit:git-push[1]. |
Santi Béjar | 0cc6d34 | 2006-10-23 18:42:14 +0200 | [diff] [blame] | 2065 | |
Paolo Bonzini | 84bb2df | 2008-04-17 13:17:20 +0200 | [diff] [blame] | 2066 | remote.<name>.mirror:: |
| 2067 | If true, pushing to this remote will automatically behave |
Jeff King | 6cf378f | 2012-04-26 04:51:57 -0400 | [diff] [blame] | 2068 | as if the `--mirror` option was given on the command line. |
Paolo Bonzini | 84bb2df | 2008-04-17 13:17:20 +0200 | [diff] [blame] | 2069 | |
Theodore Ts'o | 1918278 | 2007-02-20 15:13:43 -0500 | [diff] [blame] | 2070 | remote.<name>.skipDefaultUpdate:: |
| 2071 | If true, this remote will be skipped by default when updating |
Björn Gustavsson | 7cc91a2 | 2009-11-09 21:11:06 +0100 | [diff] [blame] | 2072 | using linkgit:git-fetch[1] or the `update` subcommand of |
| 2073 | linkgit:git-remote[1]. |
| 2074 | |
| 2075 | remote.<name>.skipFetchAll:: |
| 2076 | If true, this remote will be skipped by default when updating |
| 2077 | using linkgit:git-fetch[1] or the `update` subcommand of |
| 2078 | linkgit:git-remote[1]. |
Theodore Ts'o | 1918278 | 2007-02-20 15:13:43 -0500 | [diff] [blame] | 2079 | |
Uwe Kleine-König | 060aafc | 2007-01-19 13:46:16 +0100 | [diff] [blame] | 2080 | remote.<name>.receivepack:: |
Uwe Kleine-König | 5dee29a | 2007-01-25 05:45:39 +0100 | [diff] [blame] | 2081 | 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] | 2082 | option \--receive-pack of linkgit:git-push[1]. |
Uwe Kleine-König | 060aafc | 2007-01-19 13:46:16 +0100 | [diff] [blame] | 2083 | |
Uwe Kleine-König | 5dee29a | 2007-01-25 05:45:39 +0100 | [diff] [blame] | 2084 | remote.<name>.uploadpack:: |
| 2085 | 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] | 2086 | option \--upload-pack of linkgit:git-fetch-pack[1]. |
Uwe Kleine-König | 5dee29a | 2007-01-25 05:45:39 +0100 | [diff] [blame] | 2087 | |
Aneesh Kumar K.V | 047f636 | 2007-02-24 21:02:56 +0530 | [diff] [blame] | 2088 | remote.<name>.tagopt:: |
Uwe Kleine-König | 79f43f3 | 2008-03-06 21:28:07 +0100 | [diff] [blame] | 2089 | Setting this value to \--no-tags disables automatic tag following when |
Samuel Tardieu | 944163a | 2010-04-20 01:31:25 +0200 | [diff] [blame] | 2090 | fetching from remote <name>. Setting it to \--tags will fetch every |
| 2091 | tag from remote <name>, even if they are not reachable from remote |
Daniel Johnson | ed36854 | 2010-08-11 18:57:20 -0400 | [diff] [blame] | 2092 | branch heads. Passing these flags directly to linkgit:git-fetch[1] can |
| 2093 | override this setting. See options \--tags and \--no-tags of |
| 2094 | linkgit:git-fetch[1]. |
Aneesh Kumar K.V | 047f636 | 2007-02-24 21:02:56 +0530 | [diff] [blame] | 2095 | |
Daniel Barkalow | c578f51 | 2009-11-18 02:42:25 +0100 | [diff] [blame] | 2096 | remote.<name>.vcs:: |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 2097 | Setting this to a value <vcs> will cause Git to interact with |
Daniel Barkalow | c578f51 | 2009-11-18 02:42:25 +0100 | [diff] [blame] | 2098 | the remote with the git-remote-<vcs> helper. |
| 2099 | |
Michael Schubert | 737c5a9 | 2013-07-13 11:36:24 +0200 | [diff] [blame] | 2100 | remote.<name>.prune:: |
| 2101 | When set to true, fetching from this remote by default will also |
Michael Haggerty | 0838bf4 | 2013-10-30 06:33:00 +0100 | [diff] [blame] | 2102 | remove any remote-tracking references that no longer exist on the |
| 2103 | remote (as if the `--prune` option was given on the command line). |
Michael Schubert | 737c5a9 | 2013-07-13 11:36:24 +0200 | [diff] [blame] | 2104 | Overrides `fetch.prune` settings, if any. |
| 2105 | |
Theodore Ts'o | 1918278 | 2007-02-20 15:13:43 -0500 | [diff] [blame] | 2106 | remotes.<group>:: |
| 2107 | The list of remotes which are fetched by "git remote update |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 2108 | <group>". See linkgit:git-remote[1]. |
Theodore Ts'o | 1918278 | 2007-02-20 15:13:43 -0500 | [diff] [blame] | 2109 | |
Junio C Hamano | b6945f5 | 2006-10-13 21:28:58 -0700 | [diff] [blame] | 2110 | repack.usedeltabaseoffset:: |
Nicolas Pitre | 22c79ea | 2008-06-25 00:24:53 -0400 | [diff] [blame] | 2111 | By default, linkgit:git-repack[1] creates packs that use |
| 2112 | delta-base offset. If you need to share your repository with |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 2113 | Git older than version 1.4.4, either directly or via a dumb |
Nicolas Pitre | 22c79ea | 2008-06-25 00:24:53 -0400 | [diff] [blame] | 2114 | protocol such as http, then you need to set this option to |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 2115 | "false" and repack. Access from old Git versions over the |
Nicolas Pitre | 22c79ea | 2008-06-25 00:24:53 -0400 | [diff] [blame] | 2116 | native protocol are unaffected by this option. |
Junio C Hamano | b6945f5 | 2006-10-13 21:28:58 -0700 | [diff] [blame] | 2117 | |
Matt McCutchen | b0f34c3 | 2008-11-26 03:26:50 -0500 | [diff] [blame] | 2118 | rerere.autoupdate:: |
| 2119 | When set to true, `git-rerere` updates the index with the |
| 2120 | resulting contents after it cleanly resolves conflicts using |
| 2121 | previously recorded resolution. Defaults to false. |
| 2122 | |
| 2123 | rerere.enabled:: |
| 2124 | Activate recording of resolved conflicts, so that identical |
Thomas Rast | 07b88a0 | 2012-01-06 14:08:02 +0100 | [diff] [blame] | 2125 | conflict hunks can be resolved automatically, should they be |
| 2126 | encountered again. By default, linkgit:git-rerere[1] is |
| 2127 | enabled if there is an `rr-cache` directory under the |
Junio C Hamano | b6fb7fe | 2012-01-10 15:57:27 +0100 | [diff] [blame] | 2128 | `$GIT_DIR`, e.g. if "rerere" was previously used in the |
| 2129 | repository. |
Matt McCutchen | b0f34c3 | 2008-11-26 03:26:50 -0500 | [diff] [blame] | 2130 | |
Yann Dirson | 65180c6 | 2009-07-22 23:39:30 +0200 | [diff] [blame] | 2131 | sendemail.identity:: |
| 2132 | A configuration identity. When given, causes values in the |
| 2133 | 'sendemail.<identity>' subsection to take precedence over |
| 2134 | values in the 'sendemail' section. The default identity is |
| 2135 | the value of 'sendemail.identity'. |
| 2136 | |
| 2137 | sendemail.smtpencryption:: |
| 2138 | See linkgit:git-send-email[1] for description. Note that this |
| 2139 | setting is not subject to the 'identity' mechanism. |
| 2140 | |
| 2141 | sendemail.smtpssl:: |
| 2142 | Deprecated alias for 'sendemail.smtpencryption = ssl'. |
| 2143 | |
Ramkumar Ramachandra | 35035bb | 2013-07-18 09:53:11 -0700 | [diff] [blame] | 2144 | sendemail.smtpsslcertpath:: |
| 2145 | Path to ca-certificates (either a directory or a single file). |
| 2146 | Set it to an empty string to disable certificate verification. |
| 2147 | |
Yann Dirson | 65180c6 | 2009-07-22 23:39:30 +0200 | [diff] [blame] | 2148 | sendemail.<identity>.*:: |
| 2149 | Identity-specific versions of the 'sendemail.*' parameters |
| 2150 | found below, taking precedence over those when the this |
| 2151 | identity is selected, through command-line or |
| 2152 | 'sendemail.identity'. |
| 2153 | |
| 2154 | sendemail.aliasesfile:: |
| 2155 | sendemail.aliasfiletype:: |
Felipe Contreras | 402596a | 2013-04-07 01:10:27 -0600 | [diff] [blame] | 2156 | sendemail.annotate:: |
Yann Dirson | 65180c6 | 2009-07-22 23:39:30 +0200 | [diff] [blame] | 2157 | sendemail.bcc:: |
| 2158 | sendemail.cc:: |
| 2159 | sendemail.cccmd:: |
| 2160 | sendemail.chainreplyto:: |
| 2161 | sendemail.confirm:: |
| 2162 | sendemail.envelopesender:: |
| 2163 | sendemail.from:: |
| 2164 | sendemail.multiedit:: |
| 2165 | sendemail.signedoffbycc:: |
| 2166 | sendemail.smtppass:: |
| 2167 | sendemail.suppresscc:: |
| 2168 | sendemail.suppressfrom:: |
| 2169 | sendemail.to:: |
Brian Gernhardt | 69cf7bf | 2010-04-10 10:53:56 -0400 | [diff] [blame] | 2170 | sendemail.smtpdomain:: |
Yann Dirson | 65180c6 | 2009-07-22 23:39:30 +0200 | [diff] [blame] | 2171 | sendemail.smtpserver:: |
| 2172 | sendemail.smtpserverport:: |
Pascal Obry | 052fbea | 2010-09-06 20:12:11 +0200 | [diff] [blame] | 2173 | sendemail.smtpserveroption:: |
Yann Dirson | 65180c6 | 2009-07-22 23:39:30 +0200 | [diff] [blame] | 2174 | sendemail.smtpuser:: |
| 2175 | sendemail.thread:: |
| 2176 | sendemail.validate:: |
| 2177 | See linkgit:git-send-email[1] for description. |
| 2178 | |
| 2179 | sendemail.signedoffcc:: |
| 2180 | Deprecated alias for 'sendemail.signedoffbycc'. |
| 2181 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 2182 | showbranch.default:: |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 2183 | The default set of branches for linkgit:git-show-branch[1]. |
| 2184 | See linkgit:git-show-branch[1]. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 2185 | |
Jeff King | 46f721c | 2007-12-07 16:26:07 -0500 | [diff] [blame] | 2186 | status.relativePaths:: |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 2187 | By default, linkgit:git-status[1] shows paths relative to the |
Jeff King | 46f721c | 2007-12-07 16:26:07 -0500 | [diff] [blame] | 2188 | current directory. Setting this variable to `false` shows paths |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 2189 | relative to the repository root (this was the default for Git |
Jeff King | 46f721c | 2007-12-07 16:26:07 -0500 | [diff] [blame] | 2190 | prior to v1.5.4). |
| 2191 | |
Jorge Juan Garcia Garcia | 4fb5166 | 2013-06-11 15:34:04 +0200 | [diff] [blame] | 2192 | status.short:: |
| 2193 | Set to true to enable --short by default in linkgit:git-status[1]. |
| 2194 | The option --no-short takes precedence over this variable. |
| 2195 | |
Jorge Juan Garcia Garcia | ec85d07 | 2013-06-11 15:34:05 +0200 | [diff] [blame] | 2196 | status.branch:: |
| 2197 | Set to true to enable --branch by default in linkgit:git-status[1]. |
| 2198 | The option --no-branch takes precedence over this variable. |
| 2199 | |
Matthieu Moy | 2556b99 | 2013-09-06 19:43:07 +0200 | [diff] [blame] | 2200 | status.displayCommentPrefix:: |
| 2201 | If set to true, linkgit:git-status[1] will insert a comment |
| 2202 | prefix before each output line (starting with |
| 2203 | `core.commentChar`, i.e. `#` by default). This was the |
| 2204 | behavior of linkgit:git-status[1] in Git 1.8.4 and previous. |
| 2205 | Defaults to false. |
| 2206 | |
Marius Storm-Olsen | d6293d1 | 2008-06-05 14:47:50 +0200 | [diff] [blame] | 2207 | status.showUntrackedFiles:: |
| 2208 | By default, linkgit:git-status[1] and linkgit:git-commit[1] show |
| 2209 | files which are not currently tracked by Git. Directories which |
| 2210 | contain only untracked files, are shown with the directory name |
| 2211 | only. Showing untracked files means that Git needs to lstat() all |
| 2212 | all the files in the whole repository, which might be slow on some |
| 2213 | systems. So, this variable controls how the commands displays |
| 2214 | the untracked files. Possible values are: |
| 2215 | + |
| 2216 | -- |
Cliff Frey | 9373bdc | 2010-10-17 20:10:45 -0700 | [diff] [blame] | 2217 | * `no` - Show no untracked files. |
| 2218 | * `normal` - Show untracked files and directories. |
| 2219 | * `all` - Show also individual files in untracked directories. |
Marius Storm-Olsen | d6293d1 | 2008-06-05 14:47:50 +0200 | [diff] [blame] | 2220 | -- |
| 2221 | + |
| 2222 | If this variable is not specified, it defaults to 'normal'. |
| 2223 | This variable can be overridden with the -u|--untracked-files option |
| 2224 | of linkgit:git-status[1] and linkgit:git-commit[1]. |
| 2225 | |
Michael J Gruber | 4b2343f | 2010-05-20 17:55:42 +0200 | [diff] [blame] | 2226 | status.submodulesummary:: |
| 2227 | Defaults to false. |
| 2228 | If this is set to a non zero number or true (identical to -1 or an |
| 2229 | unlimited number), the submodule summary will be enabled and a |
| 2230 | summary of commits for modified submodules will be shown (see |
Jens Lehmann | bb58b69 | 2013-09-11 21:07:15 +0200 | [diff] [blame] | 2231 | --summary-limit option of linkgit:git-submodule[1]). Please note |
| 2232 | that the summary output command will be suppressed for all |
| 2233 | submodules when `diff.ignoreSubmodules` is set to 'all' or only |
| 2234 | for those submodules where `submodule.<name>.ignore=all`. To |
| 2235 | also view the summary for ignored submodules you can either use |
| 2236 | the --ignore-submodules=dirty command line option or the 'git |
| 2237 | submodule summary' command, which shows a similar output but does |
| 2238 | not honor these settings. |
Michael J Gruber | 4b2343f | 2010-05-20 17:55:42 +0200 | [diff] [blame] | 2239 | |
Jonathan Nieder | 0ad0a61 | 2010-07-15 02:51:19 -0500 | [diff] [blame] | 2240 | submodule.<name>.path:: |
| 2241 | submodule.<name>.url:: |
| 2242 | submodule.<name>.update:: |
| 2243 | The path within this project, URL, and the updating strategy |
| 2244 | for a submodule. These variables are initially populated |
| 2245 | by 'git submodule init'; edit them to override the |
| 2246 | URL and other values found in the `.gitmodules` file. See |
| 2247 | linkgit:git-submodule[1] and linkgit:gitmodules[5] for details. |
| 2248 | |
W. Trevor King | 06b1abb | 2012-12-19 11:03:32 -0500 | [diff] [blame] | 2249 | submodule.<name>.branch:: |
| 2250 | The remote branch name for a submodule, used by `git submodule |
| 2251 | update --remote`. Set this option to override the value found in |
| 2252 | the `.gitmodules` file. See linkgit:git-submodule[1] and |
| 2253 | linkgit:gitmodules[5] for details. |
| 2254 | |
Jens Lehmann | c1a3c36 | 2010-11-11 00:55:41 +0100 | [diff] [blame] | 2255 | submodule.<name>.fetchRecurseSubmodules:: |
Jens Lehmann | bf42b38 | 2011-03-06 23:12:19 +0100 | [diff] [blame] | 2256 | This option can be used to control recursive fetching of this |
Ralf Wildenhues | 469bfc9 | 2011-01-03 20:03:34 +0100 | [diff] [blame] | 2257 | submodule. It can be overridden by using the --[no-]recurse-submodules |
Jens Lehmann | c1a3c36 | 2010-11-11 00:55:41 +0100 | [diff] [blame] | 2258 | command line option to "git fetch" and "git pull". |
| 2259 | This setting will override that from in the linkgit:gitmodules[5] |
| 2260 | file. |
| 2261 | |
Jens Lehmann | aee9c7d | 2010-08-06 00:39:25 +0200 | [diff] [blame] | 2262 | submodule.<name>.ignore:: |
| 2263 | Defines under what circumstances "git status" and the diff family show |
| 2264 | a submodule as modified. When set to "all", it will never be considered |
| 2265 | modified, "dirty" will ignore all changes to the submodules work tree and |
| 2266 | takes only differences between the HEAD of the submodule and the commit |
| 2267 | recorded in the superproject into account. "untracked" will additionally |
| 2268 | let submodules with modified tracked files in their work tree show up. |
| 2269 | Using "none" (the default when this option is not set) also shows |
| 2270 | submodules that have untracked files in their work tree as changed. |
Jens Lehmann | 302ad7a | 2010-08-06 00:40:48 +0200 | [diff] [blame] | 2271 | This setting overrides any setting made in .gitmodules for this submodule, |
Ralf Wildenhues | 3776ea9 | 2010-08-22 13:12:12 +0200 | [diff] [blame] | 2272 | both settings can be overridden on the command line by using the |
Jens Lehmann | bb58b69 | 2013-09-11 21:07:15 +0200 | [diff] [blame] | 2273 | "--ignore-submodules" option. The 'git submodule' commands are not |
| 2274 | affected by this setting. |
Jens Lehmann | aee9c7d | 2010-08-06 00:39:25 +0200 | [diff] [blame] | 2275 | |
Willy Tarreau | ce1a79b | 2006-07-20 11:30:44 +0200 | [diff] [blame] | 2276 | tar.umask:: |
René Scharfe | 687157c | 2007-08-21 20:01:16 +0200 | [diff] [blame] | 2277 | This variable can be used to restrict the permission bits of |
| 2278 | tar archive entries. The default is 0002, which turns off the |
| 2279 | world write bit. The special value "user" indicates that the |
| 2280 | archiving user's umask will be used instead. See umask(2) and |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 2281 | linkgit:git-archive[1]. |
Willy Tarreau | ce1a79b | 2006-07-20 11:30:44 +0200 | [diff] [blame] | 2282 | |
Junio C Hamano | dab76d3 | 2011-09-04 12:37:45 -0700 | [diff] [blame] | 2283 | transfer.fsckObjects:: |
| 2284 | When `fetch.fsckObjects` or `receive.fsckObjects` are |
| 2285 | not set, the value of this variable is used instead. |
| 2286 | Defaults to false. |
| 2287 | |
Junio C Hamano | daebaa7 | 2013-01-18 16:08:30 -0800 | [diff] [blame] | 2288 | transfer.hiderefs:: |
| 2289 | This variable can be used to set both `receive.hiderefs` |
| 2290 | and `uploadpack.hiderefs` at the same time to the same |
| 2291 | values. See entries for these other variables. |
| 2292 | |
Matt McCutchen | b0f34c3 | 2008-11-26 03:26:50 -0500 | [diff] [blame] | 2293 | transfer.unpackLimit:: |
| 2294 | When `fetch.unpackLimit` or `receive.unpackLimit` are |
| 2295 | not set, the value of this variable is used instead. |
| 2296 | The default value is 100. |
| 2297 | |
Junio C Hamano | daebaa7 | 2013-01-18 16:08:30 -0800 | [diff] [blame] | 2298 | uploadpack.hiderefs:: |
| 2299 | String(s) `upload-pack` uses to decide which refs to omit |
| 2300 | from its initial advertisement. Use more than one |
| 2301 | definitions to specify multiple prefix strings. A ref that |
| 2302 | are under the hierarchies listed on the value of this |
| 2303 | variable is excluded, and is hidden from `git ls-remote`, |
| 2304 | `git fetch`, etc. An attempt to fetch a hidden ref by `git |
Junio C Hamano | 390eb36 | 2013-01-28 21:49:57 -0800 | [diff] [blame] | 2305 | fetch` will fail. See also `uploadpack.allowtipsha1inwant`. |
| 2306 | |
| 2307 | uploadpack.allowtipsha1inwant:: |
| 2308 | When `uploadpack.hiderefs` is in effect, allow `upload-pack` |
| 2309 | to accept a fetch request that asks for an object at the tip |
| 2310 | of a hidden ref (by default, such a request is rejected). |
| 2311 | see also `uploadpack.hiderefs`. |
Junio C Hamano | daebaa7 | 2013-01-18 16:08:30 -0800 | [diff] [blame] | 2312 | |
Jeff King | 05e9515 | 2013-09-08 05:01:31 -0400 | [diff] [blame] | 2313 | uploadpack.keepalive:: |
| 2314 | When `upload-pack` has started `pack-objects`, there may be a |
| 2315 | quiet period while `pack-objects` prepares the pack. Normally |
| 2316 | it would output progress information, but if `--quiet` was used |
| 2317 | for the fetch, `pack-objects` will output nothing at all until |
| 2318 | the pack data begins. Some clients and networks may consider |
| 2319 | the server to be hung and give up. Setting this option instructs |
| 2320 | `upload-pack` to send an empty keepalive packet every |
| 2321 | `uploadpack.keepalive` seconds. Setting this option to 0 |
Jeff King | 115dedd | 2013-09-08 05:02:06 -0400 | [diff] [blame] | 2322 | disables keepalive packets entirely. The default is 5 seconds. |
Jeff King | 05e9515 | 2013-09-08 05:01:31 -0400 | [diff] [blame] | 2323 | |
Daniel Barkalow | 55029ae | 2008-02-20 13:43:53 -0500 | [diff] [blame] | 2324 | url.<base>.insteadOf:: |
| 2325 | Any URL that starts with this value will be rewritten to |
| 2326 | start, instead, with <base>. In cases where some site serves a |
| 2327 | large number of repositories, and serves them with multiple |
| 2328 | access methods, and some users need to use different access |
| 2329 | methods, this feature allows people to specify any of the |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 2330 | equivalent URLs and have Git automatically rewrite the URL to |
Daniel Barkalow | 55029ae | 2008-02-20 13:43:53 -0500 | [diff] [blame] | 2331 | the best alternative for the particular user, even for a |
Junio C Hamano | 844112c | 2008-02-24 22:25:04 -0800 | [diff] [blame] | 2332 | never-before-seen repository on the site. When more than one |
| 2333 | insteadOf strings match a given URL, the longest match is used. |
Daniel Barkalow | 55029ae | 2008-02-20 13:43:53 -0500 | [diff] [blame] | 2334 | |
Josh Triplett | 1c2eafb | 2009-09-07 01:56:33 -0700 | [diff] [blame] | 2335 | url.<base>.pushInsteadOf:: |
| 2336 | Any URL that starts with this value will not be pushed to; |
| 2337 | instead, it will be rewritten to start with <base>, and the |
| 2338 | resulting URL will be pushed to. In cases where some site serves |
| 2339 | a large number of repositories, and serves them with multiple |
| 2340 | access methods, some of which do not allow push, this feature |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 2341 | allows people to specify a pull-only URL and have Git |
Josh Triplett | 1c2eafb | 2009-09-07 01:56:33 -0700 | [diff] [blame] | 2342 | automatically use an appropriate URL to push, even for a |
| 2343 | never-before-seen repository on the site. When more than one |
| 2344 | pushInsteadOf strings match a given URL, the longest match is |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 2345 | used. If a remote has an explicit pushurl, Git will ignore this |
Josh Triplett | 1c2eafb | 2009-09-07 01:56:33 -0700 | [diff] [blame] | 2346 | setting for that remote. |
| 2347 | |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 2348 | user.email:: |
| 2349 | Your email address to be recorded in any newly created commits. |
Josh Triplett | 28a94f8 | 2007-04-28 18:40:28 -0700 | [diff] [blame] | 2350 | Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 2351 | 'EMAIL' environment variables. See linkgit:git-commit-tree[1]. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 2352 | |
| 2353 | user.name:: |
| 2354 | 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] | 2355 | Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME' |
Dan McGee | 5162e69 | 2007-12-29 00:20:38 -0600 | [diff] [blame] | 2356 | environment variables. See linkgit:git-commit-tree[1]. |
Petr Baudis | 1ab661d | 2006-04-25 00:59:33 +0200 | [diff] [blame] | 2357 | |
Andy Parkins | d67778e | 2007-01-26 14:13:46 +0000 | [diff] [blame] | 2358 | user.signingkey:: |
Nicolas Vigier | f055169 | 2013-10-14 19:04:36 +0200 | [diff] [blame] | 2359 | If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the |
| 2360 | key you want it to automatically when creating a signed tag or |
| 2361 | commit, you can override the default selection with this variable. |
| 2362 | This option is passed unchanged to gpg's --local-user parameter, |
| 2363 | so you may specify a key using any method that gpg supports. |
Andy Parkins | d67778e | 2007-01-26 14:13:46 +0000 | [diff] [blame] | 2364 | |
Christian Couder | 983a9ee | 2008-01-08 04:55:14 +0100 | [diff] [blame] | 2365 | web.browser:: |
| 2366 | Specify a web browser that may be used by some commands. |
| 2367 | Currently only linkgit:git-instaweb[1] and linkgit:git-help[1] |
| 2368 | may use it. |