| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1 | CONFIGURATION FILE |
| 2 | ------------------ |
| 3 | |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [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 |
| Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [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 |
| 8 | fallback values for the `.git/config` file. The file `/etc/gitconfig` |
| 9 | can be used to store a system-wide default configuration. |
| Junio C Hamano | 8f76dc6 | 2007-01-17 07:24:25 | [diff] [blame] | 10 | |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 11 | The configuration variables are used by both the Git plumbing |
| Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [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 |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 14 | dot-separated segment and the section name is everything before the last |
| Junio C Hamano | 81d540a | 2012-03-02 19:52:47 | [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. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 18 | |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 19 | Syntax |
| 20 | ~~~~~~ |
| 21 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 22 | The syntax is fairly flexible and permissive; whitespaces are mostly |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [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 |
| Junio C Hamano | ea82cff | 2009-03-18 01:54:48 | [diff] [blame] | 29 | characters, `-` and `.` are allowed in section names. Each variable |
| Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [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. |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [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, |
| Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 35 | in the section header, like in the example below: |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 36 | |
| 37 | -------- |
| 38 | [section "subsection"] |
| 39 | |
| 40 | -------- |
| 41 | |
| Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [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 |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [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 | |
| Junio C Hamano | 6231f82 | 2011-10-24 05:18:52 | [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. |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 53 | |
| Junio C Hamano | aa2cd76 | 2009-07-26 08:14:01 | [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 |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [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". |
| Junio C Hamano | 81d540a | 2012-03-02 19:52:47 | [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. |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [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, |
| Junio C Hamano | 059bca5 | 2011-03-30 22:47:46 | [diff] [blame] | 68 | 1/0, true/false or on/off. Case is not significant in boolean values, when |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 69 | converting value to the canonical form using '--bool' type specifier; |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 70 | 'git config' will ensure that the output is "true" or "false". |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 71 | |
| 72 | String values may be entirely or partially enclosed in double quotes. |
| Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [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 |
| Junio C Hamano | ea82cff | 2009-03-18 01:54:48 | [diff] [blame] | 77 | be escaped: use `\"` for `"` and `\\` for `\`. |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 78 | |
| Junio C Hamano | ea82cff | 2009-03-18 01:54:48 | [diff] [blame] | 79 | The following escape sequences (beside `\"` and `\\`) are recognized: |
| 80 | `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) |
| Junio C Hamano | d75148a | 2014-04-08 19:48:38 | [diff] [blame] | 81 | and `\b` for backspace (BS). Other char escape sequences (including octal |
| 82 | escape sequences) are invalid. |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 83 | |
| Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 84 | Variable values ending in a `\` are continued on the next line in the |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 85 | customary UNIX fashion. |
| 86 | |
| Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 87 | Some variables may require a special value format. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 88 | |
| Junio C Hamano | e0238c2 | 2012-02-23 22:45:50 | [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 |
| Junio C Hamano | 22700fb | 2012-05-03 23:07:25 | [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 |
| Junio C Hamano | 4d61c4a | 2012-04-30 01:10:22 | [diff] [blame] | 100 | user's home directory. See below for examples. |
| Junio C Hamano | e0238c2 | 2012-02-23 22:45:50 | [diff] [blame] | 101 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [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] |
| Junio C Hamano | 85c7157 | 2008-07-28 00:03:31 | [diff] [blame] | 112 | external = /usr/local/bin/diff-wrapper |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 113 | renames = true |
| 114 | |
| Junio C Hamano | 52401ef | 2006-12-19 00:54:38 | [diff] [blame] | 115 | [branch "devel"] |
| 116 | remote = origin |
| 117 | merge = refs/heads/devel |
| 118 | |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 119 | # Proxy settings |
| 120 | [core] |
| Junio C Hamano | c71a873 | 2007-08-04 00:27:26 | [diff] [blame] | 121 | gitProxy="ssh" for "kernel.org" |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 122 | gitProxy=default-proxy ; for the rest |
| Junio C Hamano | 52401ef | 2006-12-19 00:54:38 | [diff] [blame] | 123 | |
| Junio C Hamano | e0238c2 | 2012-02-23 22:45:50 | [diff] [blame] | 124 | [include] |
| 125 | path = /path/to/foo.inc ; include by absolute path |
| 126 | path = foo ; expand "foo" relative to the current file |
| Junio C Hamano | 4d61c4a | 2012-04-30 01:10:22 | [diff] [blame] | 127 | path = ~/foo ; expand "foo" in your $HOME directory |
| Junio C Hamano | e0238c2 | 2012-02-23 22:45:50 | [diff] [blame] | 128 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 129 | Variables |
| 130 | ~~~~~~~~~ |
| 131 | |
| 132 | Note that this list is non-comprehensive and not necessarily complete. |
| Junio C Hamano | f1d1480 | 2006-06-08 00:48:17 | [diff] [blame] | 133 | For command-specific variables, you will find a more detailed description |
| Junio C Hamano | 52b6ba3 | 2014-04-01 00:26:48 | [diff] [blame] | 134 | in the appropriate manual page. |
| 135 | |
| 136 | Other git-related tools may and do use their own variables. When |
| 137 | inventing new variables for use in your own tool, make sure their |
| 138 | names do not conflict with those that are used by Git itself and |
| 139 | other popular tools, and describe them in your documentation. |
| 140 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 141 | |
| Junio C Hamano | 7df6dcf | 2009-09-13 09:51:17 | [diff] [blame] | 142 | advice.*:: |
| Junio C Hamano | 0df9271 | 2011-12-21 22:30:44 | [diff] [blame] | 143 | These variables control various optional help messages designed to |
| 144 | aid new users. All 'advice.*' variables default to 'true', and you |
| 145 | can tell Git that you do not need help by setting these to 'false': |
| Junio C Hamano | 7df6dcf | 2009-09-13 09:51:17 | [diff] [blame] | 146 | + |
| 147 | -- |
| Junio C Hamano | abad6da | 2013-01-06 09:06:32 | [diff] [blame] | 148 | pushUpdateRejected:: |
| Junio C Hamano | 0c1b64e | 2012-04-20 23:50:49 | [diff] [blame] | 149 | Set this variable to 'false' if you want to disable |
| Junio C Hamano | 1d669b8 | 2014-03-11 21:36:00 | [diff] [blame] | 150 | 'pushNonFFCurrent', |
| Junio C Hamano | 3f2ed6f | 2013-02-04 19:24:09 | [diff] [blame] | 151 | 'pushNonFFMatching', 'pushAlreadyExists', |
| 152 | 'pushFetchFirst', and 'pushNeedsForce' |
| Junio C Hamano | abad6da | 2013-01-06 09:06:32 | [diff] [blame] | 153 | simultaneously. |
| Junio C Hamano | 0c1b64e | 2012-04-20 23:50:49 | [diff] [blame] | 154 | pushNonFFCurrent:: |
| 155 | Advice shown when linkgit:git-push[1] fails due to a |
| 156 | non-fast-forward update to the current branch. |
| Junio C Hamano | 0c1b64e | 2012-04-20 23:50:49 | [diff] [blame] | 157 | pushNonFFMatching:: |
| 158 | Advice shown when you ran linkgit:git-push[1] and pushed |
| 159 | 'matching refs' explicitly (i.e. you used ':', or |
| 160 | specified a refspec that isn't your current branch) and |
| 161 | it resulted in a non-fast-forward error. |
| Junio C Hamano | abad6da | 2013-01-06 09:06:32 | [diff] [blame] | 162 | pushAlreadyExists:: |
| 163 | Shown when linkgit:git-push[1] rejects an update that |
| 164 | does not qualify for fast-forwarding (e.g., a tag.) |
| Junio C Hamano | 3f2ed6f | 2013-02-04 19:24:09 | [diff] [blame] | 165 | pushFetchFirst:: |
| 166 | Shown when linkgit:git-push[1] rejects an update that |
| 167 | tries to overwrite a remote ref that points at an |
| 168 | object we do not have. |
| 169 | pushNeedsForce:: |
| 170 | Shown when linkgit:git-push[1] rejects an update that |
| 171 | tries to overwrite a remote ref that points at an |
| Junio C Hamano | e6f28d0 | 2013-09-17 21:34:00 | [diff] [blame] | 172 | object that is not a commit-ish, or make the remote |
| 173 | ref point at an object that is not a commit-ish. |
| Junio C Hamano | 7df6dcf | 2009-09-13 09:51:17 | [diff] [blame] | 174 | statusHints:: |
| Junio C Hamano | 644936c | 2012-06-28 23:05:14 | [diff] [blame] | 175 | Show directions on how to proceed from the current |
| Junio C Hamano | 917cd4f | 2012-12-04 23:41:10 | [diff] [blame] | 176 | state in the output of linkgit:git-status[1], in |
| Junio C Hamano | 644936c | 2012-06-28 23:05:14 | [diff] [blame] | 177 | the template shown when writing commit messages in |
| Junio C Hamano | 917cd4f | 2012-12-04 23:41:10 | [diff] [blame] | 178 | linkgit:git-commit[1], and in the help message shown |
| 179 | by linkgit:git-checkout[1] when switching branch. |
| Junio C Hamano | 5e7f131 | 2013-03-21 22:49:01 | [diff] [blame] | 180 | statusUoption:: |
| 181 | Advise to consider using the `-u` option to linkgit:git-status[1] |
| 182 | when the command takes more than 2 seconds to enumerate untracked |
| 183 | files. |
| Junio C Hamano | 5706e0b | 2009-11-24 10:54:16 | [diff] [blame] | 184 | commitBeforeMerge:: |
| 185 | Advice shown when linkgit:git-merge[1] refuses to |
| Junio C Hamano | 619596a | 2010-08-18 22:15:35 | [diff] [blame] | 186 | merge to avoid overwriting local changes. |
| Junio C Hamano | a9701f0 | 2010-01-21 00:42:16 | [diff] [blame] | 187 | resolveConflict:: |
| Junio C Hamano | 5dab5a9 | 2013-02-25 18:51:24 | [diff] [blame] | 188 | Advice shown by various commands when conflicts |
| Junio C Hamano | a9701f0 | 2010-01-21 00:42:16 | [diff] [blame] | 189 | prevent the operation from being performed. |
| Junio C Hamano | a9701f0 | 2010-01-21 00:42:16 | [diff] [blame] | 190 | implicitIdentity:: |
| 191 | Advice on how to set your identity configuration when |
| 192 | your information is guessed from the system username and |
| Junio C Hamano | 0df9271 | 2011-12-21 22:30:44 | [diff] [blame] | 193 | domain name. |
| Junio C Hamano | 74a198f | 2010-02-22 00:13:31 | [diff] [blame] | 194 | detachedHead:: |
| Junio C Hamano | 0df9271 | 2011-12-21 22:30:44 | [diff] [blame] | 195 | Advice shown when you used linkgit:git-checkout[1] to |
| Junio C Hamano | 74a198f | 2010-02-22 00:13:31 | [diff] [blame] | 196 | move to the detach HEAD state, to instruct how to create |
| Junio C Hamano | 0df9271 | 2011-12-21 22:30:44 | [diff] [blame] | 197 | a local branch after the fact. |
| Junio C Hamano | bb30064 | 2012-07-22 21:09:14 | [diff] [blame] | 198 | amWorkDir:: |
| 199 | Advice that shows the location of the patch file when |
| 200 | linkgit:git-am[1] fails to apply it. |
| Junio C Hamano | 8ab9494 | 2013-06-24 21:55:30 | [diff] [blame] | 201 | rmHints:: |
| 202 | In case of failure in the output of linkgit:git-rm[1], |
| 203 | show directions on how to proceed from the current state. |
| Junio C Hamano | 7df6dcf | 2009-09-13 09:51:17 | [diff] [blame] | 204 | -- |
| 205 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 206 | core.fileMode:: |
| Junio C Hamano | d2c2848 | 2014-10-24 22:28:25 | [diff] [blame] | 207 | Tells Git if the executable bit of files in the working tree |
| 208 | is to be honored. |
| Junio C Hamano | 9df0c66 | 2009-11-23 11:09:27 | [diff] [blame] | 209 | + |
| Junio C Hamano | d2c2848 | 2014-10-24 22:28:25 | [diff] [blame] | 210 | Some filesystems lose the executable bit when a file that is |
| 211 | marked as executable is checked out, or checks out an |
| 212 | non-executable file with executable bit on. |
| 213 | linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem |
| 214 | to see if it handles the executable bit correctly |
| 215 | and this variable is automatically set as necessary. |
| 216 | + |
| 217 | A repository, however, may be on a filesystem that handles |
| 218 | the filemode correctly, and this variable is set to 'true' |
| 219 | when created, but later may be made accessible from another |
| 220 | environment that loses the filemode (e.g. exporting ext4 via |
| 221 | CIFS mount, visiting a Cygwin created repository with |
| 222 | Git for Windows or Eclipse). |
| 223 | In such a case it may be necessary to set this variable to 'false'. |
| 224 | See linkgit:git-update-index[1]. |
| 225 | + |
| 226 | The default is true (when core.filemode is not specified in the config file). |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 227 | |
| Junio C Hamano | 9df0c66 | 2009-11-23 11:09:27 | [diff] [blame] | 228 | core.ignorecase:: |
| 229 | If true, this option enables various workarounds to enable |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 230 | Git to work better on filesystems that are not case sensitive, |
| Junio C Hamano | 9df0c66 | 2009-11-23 11:09:27 | [diff] [blame] | 231 | like FAT. For example, if a directory listing finds |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 232 | "makefile" when Git expects "Makefile", Git will assume |
| Junio C Hamano | 9df0c66 | 2009-11-23 11:09:27 | [diff] [blame] | 233 | it is really the same file, and continue to remember it as |
| 234 | "Makefile". |
| 235 | + |
| 236 | The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] |
| 237 | will probe and set core.ignorecase true if appropriate when the repository |
| 238 | is created. |
| 239 | |
| Junio C Hamano | b61a777 | 2012-07-13 23:34:48 | [diff] [blame] | 240 | core.precomposeunicode:: |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 241 | This option is only used by Mac OS implementation of Git. |
| 242 | When core.precomposeunicode=true, Git reverts the unicode decomposition |
| Junio C Hamano | b61a777 | 2012-07-13 23:34:48 | [diff] [blame] | 243 | of filenames done by Mac OS. This is useful when sharing a repository |
| 244 | between Mac OS and Linux or Windows. |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 245 | (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). |
| 246 | When false, file names are handled fully transparent by Git, |
| 247 | which is backward compatible with older versions of Git. |
| Junio C Hamano | b61a777 | 2012-07-13 23:34:48 | [diff] [blame] | 248 | |
| Junio C Hamano | 30758bd | 2014-12-18 20:44:14 | [diff] [blame] | 249 | core.protectHFS:: |
| 250 | If set to true, do not allow checkout of paths that would |
| 251 | be considered equivalent to `.git` on an HFS+ filesystem. |
| 252 | Defaults to `true` on Mac OS, and `false` elsewhere. |
| 253 | |
| 254 | core.protectNTFS:: |
| 255 | If set to true, do not allow checkout of paths that would |
| 256 | cause problems with the NTFS filesystem, e.g. conflict with |
| 257 | 8.3 "short" names. |
| 258 | Defaults to `true` on Windows, and `false` elsewhere. |
| 259 | |
| Junio C Hamano | 90ccff3 | 2008-07-29 08:17:24 | [diff] [blame] | 260 | core.trustctime:: |
| 261 | If false, the ctime differences between the index and the |
| Junio C Hamano | 8fb66e5 | 2011-10-05 20:59:51 | [diff] [blame] | 262 | working tree are ignored; useful when the inode change time |
| Junio C Hamano | 90ccff3 | 2008-07-29 08:17:24 | [diff] [blame] | 263 | is regularly modified by something outside Git (file system |
| 264 | crawlers and some backup systems). |
| 265 | See linkgit:git-update-index[1]. True by default. |
| 266 | |
| Junio C Hamano | 4cfed0c | 2013-01-30 17:58:54 | [diff] [blame] | 267 | core.checkstat:: |
| 268 | Determines which stat fields to match between the index |
| 269 | and work tree. The user can set this to 'default' or |
| 270 | 'minimal'. Default (or explicitly 'default'), is to check |
| 271 | all fields, including the sub-second part of mtime and ctime. |
| 272 | |
| Junio C Hamano | d526ba9 | 2007-07-02 00:17:42 | [diff] [blame] | 273 | core.quotepath:: |
| Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 274 | The commands that output paths (e.g. 'ls-files', |
| 275 | 'diff'), when not given the `-z` option, will quote |
| Junio C Hamano | d526ba9 | 2007-07-02 00:17:42 | [diff] [blame] | 276 | "unusual" characters in the pathname by enclosing the |
| 277 | pathname in a double-quote pair and with backslashes the |
| 278 | same way strings in C source code are quoted. If this |
| 279 | variable is set to false, the bytes higher than 0x80 are |
| 280 | not quoted but output as verbatim. Note that double |
| 281 | quote, backslash and control characters are always |
| 282 | quoted without `-z` regardless of the setting of this |
| 283 | variable. |
| 284 | |
| Junio C Hamano | bb88cf4 | 2010-06-21 15:23:55 | [diff] [blame] | 285 | core.eol:: |
| 286 | Sets the line ending type to use in the working directory for |
| 287 | files that have the `text` property set. Alternatives are |
| 288 | 'lf', 'crlf' and 'native', which uses the platform's native |
| 289 | line ending. The default value is `native`. See |
| 290 | linkgit:gitattributes[5] for more information on end-of-line |
| 291 | conversion. |
| Junio C Hamano | d9e0e5d | 2007-04-14 16:22:04 | [diff] [blame] | 292 | |
| Junio C Hamano | 26e590a | 2008-02-17 03:53:51 | [diff] [blame] | 293 | core.safecrlf:: |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 294 | If true, makes Git check if converting `CRLF` is reversible when |
| Junio C Hamano | bb88cf4 | 2010-06-21 15:23:55 | [diff] [blame] | 295 | end-of-line conversion is active. Git will verify if a command |
| Junio C Hamano | 26e590a | 2008-02-17 03:53:51 | [diff] [blame] | 296 | modifies a file in the work tree either directly or indirectly. |
| 297 | For example, committing a file followed by checking out the |
| 298 | same file should yield the original file in the work tree. If |
| 299 | this is not the case for the current setting of |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 300 | `core.autocrlf`, Git will reject the file. The variable can |
| 301 | be set to "warn", in which case Git will only warn about an |
| Junio C Hamano | 26e590a | 2008-02-17 03:53:51 | [diff] [blame] | 302 | irreversible conversion but continue the operation. |
| 303 | + |
| 304 | CRLF conversion bears a slight chance of corrupting data. |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 305 | When it is enabled, Git will convert CRLF to LF during commit and LF to |
| Junio C Hamano | 26e590a | 2008-02-17 03:53:51 | [diff] [blame] | 306 | CRLF during checkout. A file that contains a mixture of LF and |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 307 | CRLF before the commit cannot be recreated by Git. For text |
| Junio C Hamano | 26e590a | 2008-02-17 03:53:51 | [diff] [blame] | 308 | files this is the right thing to do: it corrects line endings |
| 309 | such that we have only LF line endings in the repository. |
| 310 | But for binary files that are accidentally classified as text the |
| 311 | conversion can corrupt data. |
| 312 | + |
| 313 | If you recognize such corruption early you can easily fix it by |
| 314 | setting the conversion type explicitly in .gitattributes. Right |
| 315 | after committing you still have the original file in your work |
| 316 | tree and this file is not yet corrupted. You can explicitly tell |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 317 | Git that this file is binary and Git will handle the file |
| Junio C Hamano | 26e590a | 2008-02-17 03:53:51 | [diff] [blame] | 318 | appropriately. |
| 319 | + |
| 320 | Unfortunately, the desired effect of cleaning up text files with |
| 321 | mixed line endings and the undesired effect of corrupting binary |
| 322 | files cannot be distinguished. In both cases CRLFs are removed |
| 323 | in an irreversible way. For text files this is the right thing |
| 324 | to do because CRLFs are line endings, while for binary files |
| 325 | converting CRLFs corrupts data. |
| 326 | + |
| 327 | Note, this safety check does not mean that a checkout will generate a |
| 328 | file identical to the original file for a different setting of |
| Junio C Hamano | bb88cf4 | 2010-06-21 15:23:55 | [diff] [blame] | 329 | `core.eol` and `core.autocrlf`, but only for the current one. For |
| 330 | example, a text file with `LF` would be accepted with `core.eol=lf` |
| 331 | and could later be checked out with `core.eol=crlf`, in which case the |
| Junio C Hamano | 26e590a | 2008-02-17 03:53:51 | [diff] [blame] | 332 | resulting file would contain `CRLF`, although the original file |
| 333 | contained `LF`. However, in both work trees the line endings would be |
| 334 | consistent, that is either all `LF` or all `CRLF`, but never mixed. A |
| 335 | file with mixed line endings would be reported by the `core.safecrlf` |
| 336 | mechanism. |
| 337 | |
| Junio C Hamano | bb88cf4 | 2010-06-21 15:23:55 | [diff] [blame] | 338 | core.autocrlf:: |
| 339 | Setting this variable to "true" is almost the same as setting |
| 340 | the `text` attribute to "auto" on all files except that text |
| 341 | files are not guaranteed to be normalized: files that contain |
| 342 | `CRLF` in the repository will not be touched. Use this |
| 343 | setting if you want to have `CRLF` line endings in your |
| 344 | working directory even though the repository does not have |
| 345 | normalized line endings. This variable can be set to 'input', |
| 346 | in which case no output conversion is performed. |
| 347 | |
| Junio C Hamano | aa83a7d | 2007-03-05 02:37:29 | [diff] [blame] | 348 | core.symlinks:: |
| 349 | If false, symbolic links are checked out as small plain files that |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 350 | contain the link text. linkgit:git-update-index[1] and |
| 351 | linkgit:git-add[1] will not change the recorded type to regular |
| Junio C Hamano | aa83a7d | 2007-03-05 02:37:29 | [diff] [blame] | 352 | file. Useful on filesystems like FAT that do not support |
| Junio C Hamano | 9df0c66 | 2009-11-23 11:09:27 | [diff] [blame] | 353 | symbolic links. |
| 354 | + |
| 355 | The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] |
| 356 | will probe and set core.symlinks false if appropriate when the repository |
| 357 | is created. |
| Junio C Hamano | aa83a7d | 2007-03-05 02:37:29 | [diff] [blame] | 358 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 359 | core.gitProxy:: |
| 360 | A "proxy command" to execute (as 'command host port') instead |
| 361 | of establishing direct connection to the remote server when |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 362 | using the Git protocol for fetching. If the variable value is |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 363 | in the "COMMAND for DOMAIN" format, the command is applied only |
| 364 | on hostnames ending with the specified domain string. This variable |
| 365 | may be set multiple times and is matched in the given order; |
| 366 | the first match wins. |
| Junio C Hamano | f1d1480 | 2006-06-08 00:48:17 | [diff] [blame] | 367 | + |
| 368 | Can be overridden by the 'GIT_PROXY_COMMAND' environment variable |
| 369 | (which always applies universally, without the special "for" |
| 370 | handling). |
| Junio C Hamano | ea82cff | 2009-03-18 01:54:48 | [diff] [blame] | 371 | + |
| 372 | The special string `none` can be used as the proxy command to |
| 373 | specify that no proxy be used for a given domain pattern. |
| 374 | This is useful for excluding servers inside a firewall from |
| 375 | proxy use, while defaulting to a common proxy for external domains. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 376 | |
| 377 | core.ignoreStat:: |
| Junio C Hamano | 054ea08 | 2008-06-01 08:26:34 | [diff] [blame] | 378 | If true, commands which modify both the working tree and the index |
| 379 | will mark the updated paths with the "assume unchanged" bit in the |
| 380 | index. These marked files are then assumed to stay unchanged in the |
| Junio C Hamano | 8fb66e5 | 2011-10-05 20:59:51 | [diff] [blame] | 381 | working tree, until you mark them otherwise manually - Git will not |
| Junio C Hamano | 054ea08 | 2008-06-01 08:26:34 | [diff] [blame] | 382 | detect the file changes by lstat() calls. This is useful on systems |
| 383 | where those are very slow, such as Microsoft Windows. |
| 384 | See linkgit:git-update-index[1]. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 385 | False by default. |
| 386 | |
| Junio C Hamano | 88a3a07 | 2006-05-04 08:01:43 | [diff] [blame] | 387 | core.preferSymlinkRefs:: |
| 388 | Instead of the default "symref" format for HEAD |
| 389 | and other symbolic reference files, use symbolic links. |
| 390 | This is sometimes needed to work with old scripts that |
| 391 | expect HEAD to be a symbolic link. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 392 | |
| Junio C Hamano | 1025e75 | 2007-02-23 07:21:26 | [diff] [blame] | 393 | core.bare:: |
| 394 | If true this repository is assumed to be 'bare' and has no |
| 395 | working directory associated with it. If this is the case a |
| 396 | number of commands that require a working directory will be |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 397 | disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. |
| Junio C Hamano | 1025e75 | 2007-02-23 07:21:26 | [diff] [blame] | 398 | + |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 399 | This setting is automatically guessed by linkgit:git-clone[1] or |
| 400 | linkgit:git-init[1] when the repository was created. By default a |
| Junio C Hamano | 1025e75 | 2007-02-23 07:21:26 | [diff] [blame] | 401 | repository that ends in "/.git" is assumed to be not bare (bare = |
| 402 | false), while all other repositories are assumed to be bare (bare |
| 403 | = true). |
| 404 | |
| Junio C Hamano | d526ba9 | 2007-07-02 00:17:42 | [diff] [blame] | 405 | core.worktree:: |
| Junio C Hamano | 80d5846 | 2011-01-24 22:52:52 | [diff] [blame] | 406 | Set the path to the root of the working tree. |
| Junio C Hamano | 764a667 | 2007-10-23 01:23:31 | [diff] [blame] | 407 | This can be overridden by the GIT_WORK_TREE environment |
| Junio C Hamano | e1aeb5e | 2014-06-06 19:16:29 | [diff] [blame] | 408 | variable and the '--work-tree' command-line option. |
| Junio C Hamano | 5cd1518 | 2011-04-05 00:21:10 | [diff] [blame] | 409 | The value can be an absolute path or relative to the path to |
| Junio C Hamano | 80d5846 | 2011-01-24 22:52:52 | [diff] [blame] | 410 | the .git directory, which is either specified by --git-dir |
| 411 | or GIT_DIR, or automatically discovered. |
| 412 | If --git-dir or GIT_DIR is specified but none of |
| Junio C Hamano | 7d575a5 | 2008-04-30 08:45:27 | [diff] [blame] | 413 | --work-tree, GIT_WORK_TREE and core.worktree is specified, |
| Junio C Hamano | 80d5846 | 2011-01-24 22:52:52 | [diff] [blame] | 414 | the current working directory is regarded as the top level |
| Junio C Hamano | 3609b33 | 2010-12-29 01:34:52 | [diff] [blame] | 415 | of your working tree. |
| Junio C Hamano | 80d5846 | 2011-01-24 22:52:52 | [diff] [blame] | 416 | + |
| 417 | Note that this variable is honored even when set in a configuration |
| 418 | file in a ".git" subdirectory of a directory and its value differs |
| 419 | from the latter directory (e.g. "/path/to/.git/config" has |
| 420 | core.worktree set to "/different/path"), which is most likely a |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 421 | misconfiguration. Running Git commands in the "/path/to" directory will |
| Junio C Hamano | 80d5846 | 2011-01-24 22:52:52 | [diff] [blame] | 422 | still use "/different/path" as the root of the work tree and can cause |
| 423 | confusion unless you know what you are doing (e.g. you are creating a |
| 424 | read-only snapshot of the same index to a location different from the |
| 425 | repository's usual working tree). |
| Junio C Hamano | d526ba9 | 2007-07-02 00:17:42 | [diff] [blame] | 426 | |
| Junio C Hamano | 341071d | 2006-06-04 07:24:48 | [diff] [blame] | 427 | core.logAllRefUpdates:: |
| Junio C Hamano | cae8627 | 2007-08-21 02:20:49 | [diff] [blame] | 428 | Enable the reflog. Updates to a ref <ref> is logged to the file |
| Junio C Hamano | a2ec14f | 2006-11-02 00:22:48 | [diff] [blame] | 429 | "$GIT_DIR/logs/<ref>", by appending the new and old |
| Junio C Hamano | e3f080d | 2013-04-22 02:27:13 | [diff] [blame] | 430 | SHA-1, the date/time and the reason of the update, but |
| Junio C Hamano | a2ec14f | 2006-11-02 00:22:48 | [diff] [blame] | 431 | only when the file exists. If this configuration |
| 432 | variable is set to true, missing "$GIT_DIR/logs/<ref>" |
| Junio C Hamano | 15567bc | 2011-07-23 00:51:59 | [diff] [blame] | 433 | file is automatically created for branch heads (i.e. under |
| 434 | refs/heads/), remote refs (i.e. under refs/remotes/), |
| 435 | note refs (i.e. under refs/notes/), and the symbolic ref HEAD. |
| Junio C Hamano | 1caaf47 | 2006-12-31 08:29:35 | [diff] [blame] | 436 | + |
| 437 | This information can be used to determine what commit |
| 438 | was the tip of a branch "2 days ago". |
| 439 | + |
| 440 | This value is true by default in a repository that has |
| 441 | a working directory associated with it, and false by |
| 442 | default in a bare repository. |
| Junio C Hamano | 341071d | 2006-06-04 07:24:48 | [diff] [blame] | 443 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 444 | core.repositoryFormatVersion:: |
| 445 | Internal variable identifying the repository format and layout |
| 446 | version. |
| 447 | |
| 448 | core.sharedRepository:: |
| Junio C Hamano | 0ab78ae | 2006-08-09 01:00:42 | [diff] [blame] | 449 | When 'group' (or 'true'), the repository is made shareable between |
| 450 | several users in a group (making sure all the files and objects are |
| 451 | group-writable). When 'all' (or 'world' or 'everybody'), the |
| 452 | repository will be readable by all users, additionally to being |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 453 | group-shareable. When 'umask' (or 'false'), Git will use permissions |
| Junio C Hamano | 2f102bb | 2008-04-26 02:23:37 | [diff] [blame] | 454 | reported by umask(2). When '0xxx', where '0xxx' is an octal number, |
| 455 | files in the repository will have this mode value. '0xxx' will override |
| Junio C Hamano | 83eded1 | 2009-04-20 08:18:00 | [diff] [blame] | 456 | user's umask value (whereas the other options will only override |
| 457 | requested parts of the user's umask value). Examples: '0660' will make |
| 458 | the repo read/write-able for the owner and group, but inaccessible to |
| 459 | others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a |
| Junio C Hamano | 2f102bb | 2008-04-26 02:23:37 | [diff] [blame] | 460 | repository that is group-readable but not group-writable. |
| 461 | See linkgit:git-init[1]. False by default. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 462 | |
| 463 | core.warnAmbiguousRefs:: |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 464 | If true, Git will warn you if the ref name you passed it is ambiguous |
| Junio C Hamano | 947ab82 | 2013-03-19 23:07:29 | [diff] [blame] | 465 | and might match multiple refs in the repository. True by default. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 466 | |
| Junio C Hamano | 7ec1572 | 2006-07-07 02:03:59 | [diff] [blame] | 467 | core.compression:: |
| Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 468 | An integer -1..9, indicating a default compression level. |
| 469 | -1 is the zlib default. 0 means no compression, |
| 470 | and 1..9 are various speed/size tradeoffs, 9 being slowest. |
| Junio C Hamano | 2e72a94 | 2007-11-21 08:54:42 | [diff] [blame] | 471 | If set, this provides a default to other compression variables, |
| 472 | such as 'core.loosecompression' and 'pack.compression'. |
| Junio C Hamano | a126a3b | 2006-07-04 04:55:26 | [diff] [blame] | 473 | |
| Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 474 | core.loosecompression:: |
| 475 | An integer -1..9, indicating the compression level for objects that |
| 476 | are not in a pack file. -1 is the zlib default. 0 means no |
| 477 | compression, and 1..9 are various speed/size tradeoffs, 9 being |
| 478 | slowest. If not set, defaults to core.compression. If that is |
| Junio C Hamano | 2e72a94 | 2007-11-21 08:54:42 | [diff] [blame] | 479 | not set, defaults to 1 (best speed). |
| Junio C Hamano | 28d9dfe | 2006-07-25 03:50:49 | [diff] [blame] | 480 | |
| Junio C Hamano | fc4d38c | 2007-01-08 06:53:32 | [diff] [blame] | 481 | core.packedGitWindowSize:: |
| 482 | Number of bytes of a pack file to map into memory in a |
| 483 | single mapping operation. Larger window sizes may allow |
| 484 | your system to process a smaller number of large pack files |
| 485 | more quickly. Smaller window sizes will negatively affect |
| 486 | performance due to increased calls to the operating system's |
| 487 | memory manager, but may improve performance when accessing |
| 488 | a large number of large pack files. |
| 489 | + |
| 490 | Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 |
| 491 | MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should |
| 492 | be reasonable for all users/operating systems. You probably do |
| 493 | not need to adjust this value. |
| 494 | + |
| 495 | Common unit suffixes of 'k', 'm', or 'g' are supported. |
| 496 | |
| 497 | core.packedGitLimit:: |
| 498 | Maximum number of bytes to map simultaneously into memory |
| 499 | from pack files. If Git needs to access more than this many |
| 500 | bytes at once to complete an operation it will unmap existing |
| 501 | regions to reclaim virtual address space within the process. |
| 502 | + |
| 503 | Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. |
| 504 | This should be reasonable for all users/operating systems, except on |
| 505 | the largest projects. You probably do not need to adjust this value. |
| 506 | + |
| 507 | Common unit suffixes of 'k', 'm', or 'g' are supported. |
| 508 | |
| Junio C Hamano | b8c5128 | 2007-03-19 10:43:30 | [diff] [blame] | 509 | core.deltaBaseCacheLimit:: |
| 510 | Maximum number of bytes to reserve for caching base objects |
| Junio C Hamano | 619596a | 2010-08-18 22:15:35 | [diff] [blame] | 511 | that may be referenced by multiple deltified objects. By storing the |
| Junio C Hamano | b8c5128 | 2007-03-19 10:43:30 | [diff] [blame] | 512 | entire decompressed base objects in a cache Git is able |
| 513 | to avoid unpacking and decompressing frequently used base |
| 514 | objects multiple times. |
| 515 | + |
| Junio C Hamano | e1aeb5e | 2014-06-06 19:16:29 | [diff] [blame] | 516 | Default is 96 MiB on all platforms. This should be reasonable |
| Junio C Hamano | b8c5128 | 2007-03-19 10:43:30 | [diff] [blame] | 517 | for all users/operating systems, except on the largest projects. |
| 518 | You probably do not need to adjust this value. |
| 519 | + |
| 520 | Common unit suffixes of 'k', 'm', or 'g' are supported. |
| 521 | |
| Junio C Hamano | 5c246f2 | 2010-02-03 07:34:53 | [diff] [blame] | 522 | core.bigFileThreshold:: |
| 523 | Files larger than this size are stored deflated, without |
| 524 | attempting delta compression. Storing large files without |
| 525 | delta compression avoids excessive memory usage, at the |
| Junio C Hamano | 8e61f1f | 2014-09-11 21:53:45 | [diff] [blame] | 526 | slight expense of increased disk usage. Additionally files |
| 527 | larger than this size are always treated as binary. |
| Junio C Hamano | 5c246f2 | 2010-02-03 07:34:53 | [diff] [blame] | 528 | + |
| 529 | Default is 512 MiB on all platforms. This should be reasonable |
| 530 | for most projects as source code and other text files can still |
| 531 | be delta compressed, but larger binary media files won't be. |
| 532 | + |
| 533 | Common unit suffixes of 'k', 'm', or 'g' are supported. |
| Junio C Hamano | 5c246f2 | 2010-02-03 07:34:53 | [diff] [blame] | 534 | |
| Junio C Hamano | 1d90cb0 | 2007-07-03 07:05:31 | [diff] [blame] | 535 | core.excludesfile:: |
| Junio C Hamano | 5e284b4 | 2007-05-22 07:23:37 | [diff] [blame] | 536 | In addition to '.gitignore' (per-directory) and |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 537 | '.git/info/exclude', Git looks into this file for patterns |
| Junio C Hamano | b76a686 | 2012-05-02 22:02:46 | [diff] [blame] | 538 | of files which are not meant to be tracked. "`~/`" is expanded |
| 539 | to the value of `$HOME` and "`~user/`" to the specified user's |
| Junio C Hamano | 8edb4c7 | 2012-07-09 20:33:55 | [diff] [blame] | 540 | home directory. Its default value is $XDG_CONFIG_HOME/git/ignore. |
| 541 | If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore |
| 542 | is used instead. See linkgit:gitignore[5]. |
| Junio C Hamano | 5e284b4 | 2007-05-22 07:23:37 | [diff] [blame] | 543 | |
| Junio C Hamano | 3fd7b26 | 2010-09-08 22:44:20 | [diff] [blame] | 544 | core.askpass:: |
| 545 | Some commands (e.g. svn and http interfaces) that interactively |
| 546 | ask for a password can be told to use an external program given |
| 547 | via the value of this variable. Can be overridden by the 'GIT_ASKPASS' |
| 548 | environment variable. If not set, fall back to the value of the |
| 549 | 'SSH_ASKPASS' environment variable or, failing that, a simple password |
| 550 | prompt. The external program shall be given a suitable prompt as |
| Junio C Hamano | e1aeb5e | 2014-06-06 19:16:29 | [diff] [blame] | 551 | command-line argument and write the password on its STDOUT. |
| Junio C Hamano | 3fd7b26 | 2010-09-08 22:44:20 | [diff] [blame] | 552 | |
| Junio C Hamano | 3b4609d | 2010-09-30 00:04:34 | [diff] [blame] | 553 | core.attributesfile:: |
| 554 | In addition to '.gitattributes' (per-directory) and |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 555 | '.git/info/attributes', Git looks into this file for attributes |
| Junio C Hamano | 3b4609d | 2010-09-30 00:04:34 | [diff] [blame] | 556 | (see linkgit:gitattributes[5]). Path expansions are made the same |
| Junio C Hamano | 8edb4c7 | 2012-07-09 20:33:55 | [diff] [blame] | 557 | way as for `core.excludesfile`. Its default value is |
| 558 | $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not |
| 559 | set or empty, $HOME/.config/git/attributes is used instead. |
| Junio C Hamano | 3b4609d | 2010-09-30 00:04:34 | [diff] [blame] | 560 | |
| Junio C Hamano | f6002a9 | 2007-07-20 10:28:22 | [diff] [blame] | 561 | core.editor:: |
| 562 | Commands such as `commit` and `tag` that lets you edit |
| Junio C Hamano | a638742 | 2007-08-25 03:54:27 | [diff] [blame] | 563 | messages by launching an editor uses the value of this |
| Junio C Hamano | f6002a9 | 2007-07-20 10:28:22 | [diff] [blame] | 564 | variable when it is set, and the environment variable |
| Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 565 | `GIT_EDITOR` is not set. See linkgit:git-var[1]. |
| Junio C Hamano | f6002a9 | 2007-07-20 10:28:22 | [diff] [blame] | 566 | |
| Junio C Hamano | 3f2ed6f | 2013-02-04 19:24:09 | [diff] [blame] | 567 | core.commentchar:: |
| 568 | Commands such as `commit` and `tag` that lets you edit |
| 569 | messages consider a line that begins with this character |
| 570 | commented, and removes them after the editor returns |
| 571 | (default '#'). |
| Junio C Hamano | e1aeb5e | 2014-06-06 19:16:29 | [diff] [blame] | 572 | + |
| 573 | If set to "auto", `git-commit` would select a character that is not |
| 574 | the beginning character of any line in existing commit messages. |
| Junio C Hamano | 3f2ed6f | 2013-02-04 19:24:09 | [diff] [blame] | 575 | |
| Junio C Hamano | 6231f82 | 2011-10-24 05:18:52 | [diff] [blame] | 576 | sequence.editor:: |
| Junio C Hamano | 778a341 | 2013-03-28 23:24:30 | [diff] [blame] | 577 | Text editor used by `git rebase -i` for editing the rebase instruction file. |
| Junio C Hamano | 6231f82 | 2011-10-24 05:18:52 | [diff] [blame] | 578 | The value is meant to be interpreted by the shell when it is used. |
| 579 | It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. |
| 580 | When not configured the default commit message editor is used instead. |
| 581 | |
| Junio C Hamano | 28d8ede | 2007-07-05 05:51:38 | [diff] [blame] | 582 | core.pager:: |
| Junio C Hamano | 0e0e0d2 | 2013-09-12 23:25:03 | [diff] [blame] | 583 | Text viewer for use by Git commands (e.g., 'less'). The value |
| 584 | is meant to be interpreted by the shell. The order of preference |
| 585 | is the `$GIT_PAGER` environment variable, then `core.pager` |
| 586 | configuration, then `$PAGER`, and then the default chosen at |
| 587 | compile time (usually 'less'). |
| 588 | + |
| Junio C Hamano | e1aeb5e | 2014-06-06 19:16:29 | [diff] [blame] | 589 | When the `LESS` environment variable is unset, Git sets it to `FRX` |
| Junio C Hamano | 0e0e0d2 | 2013-09-12 23:25:03 | [diff] [blame] | 590 | (if `LESS` environment variable is set, Git does not change it at |
| 591 | all). If you want to selectively override Git's default setting |
| Junio C Hamano | e1aeb5e | 2014-06-06 19:16:29 | [diff] [blame] | 592 | for `LESS`, you can set `core.pager` to e.g. `less -S`. This will |
| Junio C Hamano | 0e0e0d2 | 2013-09-12 23:25:03 | [diff] [blame] | 593 | be passed to the shell by Git, which will translate the final |
| Junio C Hamano | e1aeb5e | 2014-06-06 19:16:29 | [diff] [blame] | 594 | command to `LESS=FRX less -S`. The environment does not set the |
| 595 | `S` option but the command line does, instructing less to truncate |
| 596 | long lines. Similarly, setting `core.pager` to `less -+F` will |
| 597 | deactivate the `F` option specified by the environment from the |
| 598 | command-line, deactivating the "quit if one screen" behavior of |
| 599 | `less`. One can specifically activate some flags for particular |
| 600 | commands: for example, setting `pager.blame` to `less -S` enables |
| 601 | line truncation only for `git blame`. |
| Junio C Hamano | bc8d478 | 2014-01-13 23:35:50 | [diff] [blame] | 602 | + |
| 603 | Likewise, when the `LV` environment variable is unset, Git sets it |
| 604 | to `-c`. You can override this setting by exporting `LV` with |
| 605 | another value or setting `core.pager` to `lv +c`. |
| Junio C Hamano | 28d8ede | 2007-07-05 05:51:38 | [diff] [blame] | 606 | |
| Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 607 | core.whitespace:: |
| 608 | A comma separated list of common whitespace problems to |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 609 | notice. 'git diff' will use `color.diff.whitespace` to |
| 610 | highlight them, and 'git apply --whitespace=error' will |
| Junio C Hamano | 3db8b41 | 2008-07-26 06:45:59 | [diff] [blame] | 611 | consider them as errors. You can prefix `-` to disable |
| 612 | any of them (e.g. `-trailing-space`): |
| Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 613 | + |
| Junio C Hamano | b71a22d | 2009-10-17 08:23:47 | [diff] [blame] | 614 | * `blank-at-eol` treats trailing whitespaces at the end of the line |
| Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 615 | as an error (enabled by default). |
| 616 | * `space-before-tab` treats a space character that appears immediately |
| 617 | before a tab character in the initial indent part of the line as an |
| 618 | error (enabled by default). |
| Junio C Hamano | 281fd39 | 2012-09-17 23:57:41 | [diff] [blame] | 619 | * `indent-with-non-tab` treats a line that is indented with space |
| 620 | characters instead of the equivalent tabs as an error (not enabled by |
| 621 | default). |
| Junio C Hamano | cb39aea | 2010-05-09 07:24:48 | [diff] [blame] | 622 | * `tab-in-indent` treats a tab character in the initial indent part of |
| 623 | the line as an error (not enabled by default). |
| Junio C Hamano | b71a22d | 2009-10-17 08:23:47 | [diff] [blame] | 624 | * `blank-at-eof` treats blank lines added at the end of file as an error |
| 625 | (enabled by default). |
| 626 | * `trailing-space` is a short-hand to cover both `blank-at-eol` and |
| 627 | `blank-at-eof`. |
| Junio C Hamano | 601f3e5 | 2008-02-25 08:40:42 | [diff] [blame] | 628 | * `cr-at-eol` treats a carriage-return at the end of line as |
| 629 | part of the line terminator, i.e. with it, `trailing-space` |
| 630 | does not trigger if the character before such a carriage-return |
| 631 | is not a whitespace (not enabled by default). |
| Junio C Hamano | eef01fe | 2010-12-13 08:31:58 | [diff] [blame] | 632 | * `tabwidth=<n>` tells how many character positions a tab occupies; this |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 633 | is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` |
| Junio C Hamano | eef01fe | 2010-12-13 08:31:58 | [diff] [blame] | 634 | errors. The default tab width is 8. Allowed values are 1 to 63. |
| Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 635 | |
| Junio C Hamano | 9eb5753 | 2008-06-26 06:33:46 | [diff] [blame] | 636 | core.fsyncobjectfiles:: |
| 637 | This boolean will enable 'fsync()' when writing object files. |
| 638 | + |
| 639 | This is a total waste of time and effort on a filesystem that orders |
| 640 | data writes properly, but can be useful for filesystems that do not use |
| 641 | journalling (traditional UNIX filesystems) or that only journal metadata |
| 642 | and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). |
| 643 | |
| Junio C Hamano | 610d176 | 2008-11-28 06:27:13 | [diff] [blame] | 644 | core.preloadindex:: |
| 645 | Enable parallel index preload for operations like 'git diff' |
| 646 | + |
| 647 | This can speed up operations like 'git diff' and 'git status' especially |
| 648 | on filesystems like NFS that have weak caching semantics and thus |
| Junio C Hamano | c8c398a | 2014-06-16 21:14:05 | [diff] [blame] | 649 | relatively high IO latencies. When enabled, Git will do the |
| Junio C Hamano | 610d176 | 2008-11-28 06:27:13 | [diff] [blame] | 650 | index comparison to the filesystem data in parallel, allowing |
| Junio C Hamano | c8c398a | 2014-06-16 21:14:05 | [diff] [blame] | 651 | overlapping IO's. Defaults to true. |
| Junio C Hamano | 610d176 | 2008-11-28 06:27:13 | [diff] [blame] | 652 | |
| Junio C Hamano | a9499de | 2009-04-30 03:38:48 | [diff] [blame] | 653 | core.createObject:: |
| 654 | You can set this to 'link', in which case a hardlink followed by |
| 655 | a delete of the source are used to make sure that object creation |
| 656 | will not overwrite existing objects. |
| 657 | + |
| 658 | On some file system/operating system combinations, this is unreliable. |
| 659 | Set this config setting to 'rename' there; However, This will remove the |
| 660 | check that makes sure that existing object files will not get overwritten. |
| Junio C Hamano | e91ea77 | 2009-04-26 01:41:41 | [diff] [blame] | 661 | |
| Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 662 | core.notesRef:: |
| 663 | When showing commit messages, also show notes which are stored in |
| Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 664 | the given ref. The ref must be fully qualified. If the given |
| 665 | ref does not exist, it is not an error but means that no |
| 666 | notes should be printed. |
| Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 667 | + |
| Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 668 | This setting defaults to "refs/notes/commits", and it can be overridden by |
| 669 | the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. |
| Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 670 | |
| Junio C Hamano | 3c8d670 | 2010-01-13 23:09:03 | [diff] [blame] | 671 | core.sparseCheckout:: |
| 672 | Enable "sparse checkout" feature. See section "Sparse checkout" in |
| 673 | linkgit:git-read-tree[1] for more information. |
| 674 | |
| Junio C Hamano | 6371b0e | 2011-03-23 23:36:21 | [diff] [blame] | 675 | core.abbrev:: |
| 676 | Set the length object names are abbreviated to. If unspecified, |
| 677 | many commands abbreviate to 7 hexdigits, which may not be enough |
| 678 | for abbreviated object names to stay unique for sufficiently long |
| 679 | time. |
| 680 | |
| Junio C Hamano | 3d14151 | 2009-06-01 01:22:40 | [diff] [blame] | 681 | add.ignore-errors:: |
| Junio C Hamano | 6018664 | 2010-12-02 14:18:26 | [diff] [blame] | 682 | add.ignoreErrors:: |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 683 | Tells 'git add' to continue adding files when some files cannot be |
| Junio C Hamano | 3d14151 | 2009-06-01 01:22:40 | [diff] [blame] | 684 | added due to indexing errors. Equivalent to the '--ignore-errors' |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 685 | option of linkgit:git-add[1]. Older versions of Git accept only |
| Junio C Hamano | 6018664 | 2010-12-02 14:18:26 | [diff] [blame] | 686 | `add.ignore-errors`, which does not follow the usual naming |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 687 | convention for configuration variables. Newer versions of Git |
| Junio C Hamano | 6018664 | 2010-12-02 14:18:26 | [diff] [blame] | 688 | honor `add.ignoreErrors` as well. |
| Junio C Hamano | 3d14151 | 2009-06-01 01:22:40 | [diff] [blame] | 689 | |
| Junio C Hamano | 33db437 | 2006-06-07 19:51:45 | [diff] [blame] | 690 | alias.*:: |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 691 | Command aliases for the linkgit:git[1] command wrapper - e.g. |
| Junio C Hamano | 33db437 | 2006-06-07 19:51:45 | [diff] [blame] | 692 | after defining "alias.last = cat-file commit HEAD", the invocation |
| 693 | "git last" is equivalent to "git cat-file commit HEAD". To avoid |
| Junio C Hamano | f1d1480 | 2006-06-08 00:48:17 | [diff] [blame] | 694 | confusion and troubles with script usage, aliases that |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 695 | hide existing Git commands are ignored. Arguments are split by |
| Junio C Hamano | f1d1480 | 2006-06-08 00:48:17 | [diff] [blame] | 696 | spaces, the usual shell quoting and escaping is supported. |
| Junio C Hamano | 2efd5e4 | 2014-11-10 22:38:52 | [diff] [blame] | 697 | A quote pair or a backslash can be used to quote them. |
| Junio C Hamano | dbb6459 | 2007-09-01 11:17:39 | [diff] [blame] | 698 | + |
| 699 | If the alias expansion is prefixed with an exclamation point, |
| 700 | it will be treated as a shell command. For example, defining |
| 701 | "alias.new = !gitk --all --not ORIG_HEAD", the invocation |
| 702 | "git new" is equivalent to running the shell command |
| Junio C Hamano | 48bc1ce | 2009-07-09 16:49:19 | [diff] [blame] | 703 | "gitk --all --not ORIG_HEAD". Note that shell commands will be |
| 704 | executed from the top-level directory of a repository, which may |
| 705 | not necessarily be the current directory. |
| Junio C Hamano | 5f2627d | 2011-05-06 20:23:48 | [diff] [blame] | 706 | 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix' |
| 707 | from the original current directory. See linkgit:git-rev-parse[1]. |
| Junio C Hamano | 9cb74f2 | 2007-02-12 04:15:05 | [diff] [blame] | 708 | |
| Junio C Hamano | caa712a | 2010-03-11 01:17:35 | [diff] [blame] | 709 | am.keepcr:: |
| 710 | If true, git-am will call git-mailsplit for patches in mbox format |
| 711 | with parameter '--keep-cr'. In this case git-mailsplit will |
| Junio C Hamano | 619596a | 2010-08-18 22:15:35 | [diff] [blame] | 712 | not remove `\r` from lines ending with `\r\n`. Can be overridden |
| Junio C Hamano | caa712a | 2010-03-11 01:17:35 | [diff] [blame] | 713 | by giving '--no-keep-cr' from the command line. |
| 714 | See linkgit:git-am[1], linkgit:git-mailsplit[1]. |
| 715 | |
| Junio C Hamano | fe24db0 | 2009-08-22 05:10:47 | [diff] [blame] | 716 | apply.ignorewhitespace:: |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 717 | When set to 'change', tells 'git apply' to ignore changes in |
| Junio C Hamano | fe24db0 | 2009-08-22 05:10:47 | [diff] [blame] | 718 | whitespace, in the same way as the '--ignore-space-change' |
| 719 | option. |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 720 | When set to one of: no, none, never, false tells 'git apply' to |
| Junio C Hamano | fe24db0 | 2009-08-22 05:10:47 | [diff] [blame] | 721 | respect all whitespace differences. |
| 722 | See linkgit:git-apply[1]. |
| 723 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 724 | apply.whitespace:: |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 725 | Tells 'git apply' how to handle whitespaces, in the same way |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 726 | as the '--whitespace' option. See linkgit:git-apply[1]. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 727 | |
| Junio C Hamano | 7fd8417 | 2007-05-24 07:00:32 | [diff] [blame] | 728 | branch.autosetupmerge:: |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 729 | Tells 'git branch' and 'git checkout' to set up new branches |
| Junio C Hamano | 24bc09a | 2008-02-28 00:27:44 | [diff] [blame] | 730 | so that linkgit:git-pull[1] will appropriately merge from the |
| 731 | starting point branch. Note that even if this option is not set, |
| Junio C Hamano | 7fd8417 | 2007-05-24 07:00:32 | [diff] [blame] | 732 | this behavior can be chosen per-branch using the `--track` |
| Junio C Hamano | 24bc09a | 2008-02-28 00:27:44 | [diff] [blame] | 733 | and `--no-track` options. The valid settings are: `false` -- no |
| 734 | automatic setup is done; `true` -- automatic setup is done when the |
| Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 735 | starting point is a remote-tracking branch; `always` -- |
| 736 | automatic setup is done when the starting point is either a |
| 737 | local branch or remote-tracking |
| Junio C Hamano | 24bc09a | 2008-02-28 00:27:44 | [diff] [blame] | 738 | branch. This option defaults to true. |
| Junio C Hamano | 7fd8417 | 2007-05-24 07:00:32 | [diff] [blame] | 739 | |
| Junio C Hamano | 869bb80 | 2008-05-12 00:29:47 | [diff] [blame] | 740 | branch.autosetuprebase:: |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 741 | When a new branch is created with 'git branch' or 'git checkout' |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 742 | that tracks another branch, this variable tells Git to set |
| Junio C Hamano | 869bb80 | 2008-05-12 00:29:47 | [diff] [blame] | 743 | up pull to rebase instead of merge (see "branch.<name>.rebase"). |
| 744 | When `never`, rebase is never automatically set to true. |
| 745 | When `local`, rebase is set to true for tracked branches of |
| 746 | other local branches. |
| 747 | When `remote`, rebase is set to true for tracked branches of |
| Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 748 | remote-tracking branches. |
| Junio C Hamano | 869bb80 | 2008-05-12 00:29:47 | [diff] [blame] | 749 | When `always`, rebase will be set to true for all tracking |
| 750 | branches. |
| 751 | See "branch.autosetupmerge" for details on how to set up a |
| 752 | branch to track another branch. |
| 753 | This option defaults to never. |
| 754 | |
| Junio C Hamano | 47c1e3c | 2006-09-25 04:45:55 | [diff] [blame] | 755 | branch.<name>.remote:: |
| Junio C Hamano | 63b6fdb | 2013-04-07 23:37:13 | [diff] [blame] | 756 | When on branch <name>, it tells 'git fetch' and 'git push' |
| 757 | which remote to fetch from/push to. The remote to push to |
| 758 | may be overridden with `remote.pushdefault` (for all branches). |
| 759 | The remote to push to, for the current branch, may be further |
| 760 | overridden by `branch.<name>.pushremote`. If no remote is |
| 761 | configured, or if you are not on any branch, it defaults to |
| 762 | `origin` for fetching and `remote.pushdefault` for pushing. |
| Junio C Hamano | 238ce9c | 2013-10-23 21:56:38 | [diff] [blame] | 763 | Additionally, `.` (a period) is the current local repository |
| 764 | (a dot-repository), see `branch.<name>.merge`'s final note below. |
| Junio C Hamano | 63b6fdb | 2013-04-07 23:37:13 | [diff] [blame] | 765 | |
| 766 | branch.<name>.pushremote:: |
| 767 | When on branch <name>, it overrides `branch.<name>.remote` for |
| 768 | pushing. It also overrides `remote.pushdefault` for pushing |
| 769 | from branch <name>. When you pull from one place (e.g. your |
| 770 | upstream) and push to another place (e.g. your own publishing |
| 771 | repository), you would want to set `remote.pushdefault` to |
| 772 | specify the remote to push to for all branches, and use this |
| 773 | option to override it for a specific branch. |
| Junio C Hamano | 47c1e3c | 2006-09-25 04:45:55 | [diff] [blame] | 774 | |
| 775 | branch.<name>.merge:: |
| Junio C Hamano | 0706c80 | 2009-03-30 22:34:19 | [diff] [blame] | 776 | Defines, together with branch.<name>.remote, the upstream branch |
| Junio C Hamano | b02377c | 2011-04-28 22:26:02 | [diff] [blame] | 777 | for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 778 | branch to merge and can also affect 'git push' (see push.default). |
| 779 | When in branch <name>, it tells 'git fetch' the default |
| Junio C Hamano | c2b4709 | 2007-10-25 06:50:31 | [diff] [blame] | 780 | refspec to be marked for merging in FETCH_HEAD. The value is |
| 781 | handled like the remote part of a refspec, and must match a |
| 782 | ref which is fetched from the remote given by |
| 783 | "branch.<name>.remote". |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 784 | The merge information is used by 'git pull' (which at first calls |
| 785 | 'git fetch') to lookup the default branch for merging. Without |
| 786 | this option, 'git pull' defaults to merge the first refspec fetched. |
| Junio C Hamano | 96010b2 | 2006-12-09 21:15:46 | [diff] [blame] | 787 | Specify multiple values to get an octopus merge. |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 788 | If you wish to setup 'git pull' so that it merges into <name> from |
| Junio C Hamano | 6e149c0 | 2007-03-16 10:21:07 | [diff] [blame] | 789 | another branch in the local repository, you can point |
| Junio C Hamano | 238ce9c | 2013-10-23 21:56:38 | [diff] [blame] | 790 | branch.<name>.merge to the desired branch, and use the relative path |
| 791 | setting `.` (a period) for branch.<name>.remote. |
| Junio C Hamano | 47c1e3c | 2006-09-25 04:45:55 | [diff] [blame] | 792 | |
| Junio C Hamano | 1b50ce9 | 2007-10-03 12:05:53 | [diff] [blame] | 793 | branch.<name>.mergeoptions:: |
| 794 | Sets default options for merging into branch <name>. The syntax and |
| Junio C Hamano | c0e55e7 | 2009-10-10 00:56:29 | [diff] [blame] | 795 | supported options are the same as those of linkgit:git-merge[1], but |
| Junio C Hamano | 1b50ce9 | 2007-10-03 12:05:53 | [diff] [blame] | 796 | option values containing whitespace characters are currently not |
| 797 | supported. |
| 798 | |
| Junio C Hamano | 0c99970 | 2007-12-03 09:57:55 | [diff] [blame] | 799 | branch.<name>.rebase:: |
| 800 | When true, rebase the branch <name> on top of the fetched branch, |
| Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 801 | instead of merging the default branch from the default remote when |
| Junio C Hamano | 515ab1d | 2011-12-09 23:41:20 | [diff] [blame] | 802 | "git pull" is run. See "pull.rebase" for doing this in a non |
| 803 | branch-specific manner. |
| 804 | + |
| Junio C Hamano | cf4a174 | 2013-09-11 22:57:50 | [diff] [blame] | 805 | When preserve, also pass `--preserve-merges` along to 'git rebase' |
| 806 | so that locally committed merge commits will not be flattened |
| 807 | by running 'git pull'. |
| 808 | + |
| Junio C Hamano | 515ab1d | 2011-12-09 23:41:20 | [diff] [blame] | 809 | *NOTE*: this is a possibly dangerous operation; do *not* use |
| 810 | it unless you understand the implications (see linkgit:git-rebase[1] |
| 811 | for details). |
| Junio C Hamano | 0c99970 | 2007-12-03 09:57:55 | [diff] [blame] | 812 | |
| Junio C Hamano | 4624718 | 2013-01-09 20:50:28 | [diff] [blame] | 813 | branch.<name>.description:: |
| 814 | Branch description, can be edited with |
| 815 | `git branch --edit-description`. Branch description is |
| 816 | automatically added in the format-patch cover letter or |
| 817 | request-pull summary. |
| 818 | |
| Junio C Hamano | 8760ea6 | 2008-03-14 08:58:45 | [diff] [blame] | 819 | browser.<tool>.cmd:: |
| 820 | Specify the command to invoke the specified browser. The |
| 821 | specified command is evaluated in shell with the URLs passed |
| Junio C Hamano | 360e3a1 | 2011-07-13 23:51:56 | [diff] [blame] | 822 | as arguments. (See linkgit:git-web{litdd}browse[1].) |
| Junio C Hamano | 8760ea6 | 2008-03-14 08:58:45 | [diff] [blame] | 823 | |
| Junio C Hamano | e35a6fc | 2008-01-29 09:46:27 | [diff] [blame] | 824 | browser.<tool>.path:: |
| 825 | Override the path for the given tool that may be used to |
| 826 | browse HTML help (see '-w' option in linkgit:git-help[1]) or a |
| 827 | working repository in gitweb (see linkgit:git-instaweb[1]). |
| 828 | |
| Junio C Hamano | 47b9acd | 2007-04-24 07:34:34 | [diff] [blame] | 829 | clean.requireForce:: |
| Junio C Hamano | e6f28d0 | 2013-09-17 21:34:00 | [diff] [blame] | 830 | A boolean to make git-clean do nothing unless given -f, |
| 831 | -i or -n. Defaults to true. |
| Junio C Hamano | 47b9acd | 2007-04-24 07:34:34 | [diff] [blame] | 832 | |
| Junio C Hamano | eb69295 | 2007-01-03 22:02:12 | [diff] [blame] | 833 | color.branch:: |
| 834 | A boolean to enable/disable color in the output of |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 835 | linkgit:git-branch[1]. May be set to `always`, |
| Junio C Hamano | 0fc8cd9 | 2007-12-06 03:26:21 | [diff] [blame] | 836 | `false` (or `never`) or `auto` (or `true`), in which case colors are used |
| Junio C Hamano | eb69295 | 2007-01-03 22:02:12 | [diff] [blame] | 837 | only when the output is to a terminal. Defaults to false. |
| 838 | |
| 839 | color.branch.<slot>:: |
| 840 | Use customized color for branch coloration. `<slot>` is one of |
| 841 | `current` (the current branch), `local` (a local branch), |
| Junio C Hamano | 7692782 | 2013-04-19 21:26:57 | [diff] [blame] | 842 | `remote` (a remote-tracking branch in refs/remotes/), |
| 843 | `upstream` (upstream tracking branch), `plain` (other |
| Junio C Hamano | 5a70233 | 2007-01-28 20:55:22 | [diff] [blame] | 844 | refs). |
| 845 | + |
| 846 | The value for these configuration variables is a list of colors (at most |
| 847 | two) and attributes (at most one), separated by spaces. The colors |
| 848 | accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, |
| 849 | `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, |
| 850 | `blink` and `reverse`. The first color given is the foreground; the |
| 851 | second is the background. The position of the attribute, if any, |
| Junio C Hamano | 6df93d9 | 2014-12-22 22:48:09 | [diff] [blame] | 852 | doesn't matter. Attributes may be turned off specifically by prefixing |
| 853 | them with `no` (e.g., `noreverse`, `noul`, etc). |
| Junio C Hamano | e3b2b33 | 2014-12-12 23:34:53 | [diff] [blame] | 854 | + |
| 855 | Colors (foreground and background) may also be given as numbers between |
| 856 | 0 and 255; these use ANSI 256-color mode (but note that not all |
| Junio C Hamano | 6df93d9 | 2014-12-22 22:48:09 | [diff] [blame] | 857 | terminals may support this). If your terminal supports it, you may also |
| 858 | specify 24-bit RGB values as hex, like `#ff0ab3`. |
| Junio C Hamano | eb69295 | 2007-01-03 22:02:12 | [diff] [blame] | 859 | |
| Junio C Hamano | 3f403b0 | 2006-12-13 10:14:13 | [diff] [blame] | 860 | color.diff:: |
| Junio C Hamano | 5f2627d | 2011-05-06 20:23:48 | [diff] [blame] | 861 | Whether to use ANSI escape sequences to add color to patches. |
| 862 | If this is set to `always`, linkgit:git-diff[1], |
| 863 | linkgit:git-log[1], and linkgit:git-show[1] will use color |
| 864 | for all patches. If it is set to `true` or `auto`, those |
| 865 | commands will only use color when output is to the terminal. |
| 866 | Defaults to false. |
| 867 | + |
| Junio C Hamano | d75148a | 2014-04-08 19:48:38 | [diff] [blame] | 868 | This does not affect linkgit:git-format-patch[1] or the |
| Junio C Hamano | 5f2627d | 2011-05-06 20:23:48 | [diff] [blame] | 869 | 'git-diff-{asterisk}' plumbing commands. Can be overridden on the |
| 870 | command line with the `--color[=<when>]` option. |
| Junio C Hamano | 9ae1a06 | 2006-07-10 08:12:34 | [diff] [blame] | 871 | |
| Junio C Hamano | 3f403b0 | 2006-12-13 10:14:13 | [diff] [blame] | 872 | color.diff.<slot>:: |
| Junio C Hamano | 5a70233 | 2007-01-28 20:55:22 | [diff] [blame] | 873 | Use customized color for diff colorization. `<slot>` specifies |
| 874 | which part of the patch to use the specified color, and is one |
| 875 | of `plain` (context text), `meta` (metainformation), `frag` |
| Junio C Hamano | 2bd8a74 | 2009-12-01 21:16:59 | [diff] [blame] | 876 | (hunk header), 'func' (function in hunk header), `old` (removed lines), |
| 877 | `new` (added lines), `commit` (commit headers), or `whitespace` |
| 878 | (highlighting whitespace errors). The values of these variables may be |
| 879 | specified as in color.branch.<slot>. |
| Junio C Hamano | 9ae1a06 | 2006-07-10 08:12:34 | [diff] [blame] | 880 | |
| Junio C Hamano | 7d44952 | 2010-07-01 00:08:51 | [diff] [blame] | 881 | color.decorate.<slot>:: |
| 882 | Use customized color for 'git log --decorate' output. `<slot>` is one |
| 883 | of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local |
| Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 884 | branches, remote-tracking branches, tags, stash and HEAD, respectively. |
| Junio C Hamano | 7d44952 | 2010-07-01 00:08:51 | [diff] [blame] | 885 | |
| Junio C Hamano | d257cff | 2009-03-18 05:27:16 | [diff] [blame] | 886 | color.grep:: |
| 887 | When set to `always`, always highlight matches. When `false` (or |
| 888 | `never`), never. When set to `true` or `auto`, use color only |
| 889 | when the output is written to the terminal. Defaults to `false`. |
| 890 | |
| Junio C Hamano | 0299d92 | 2010-03-20 20:59:31 | [diff] [blame] | 891 | color.grep.<slot>:: |
| 892 | Use customized color for grep colorization. `<slot>` specifies which |
| 893 | part of the line to use the specified color, and is one of |
| 894 | + |
| 895 | -- |
| 896 | `context`;; |
| 897 | non-matching text in context lines (when using `-A`, `-B`, or `-C`) |
| 898 | `filename`;; |
| 899 | filename prefix (when not using `-h`) |
| 900 | `function`;; |
| 901 | function name lines (when using `-p`) |
| 902 | `linenumber`;; |
| 903 | line number prefix (when using `-n`) |
| 904 | `match`;; |
| Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 905 | matching text (same as setting `matchContext` and `matchSelected`) |
| 906 | `matchContext`;; |
| 907 | matching text in context lines |
| 908 | `matchSelected`;; |
| 909 | matching text in selected lines |
| Junio C Hamano | 0299d92 | 2010-03-20 20:59:31 | [diff] [blame] | 910 | `selected`;; |
| 911 | non-matching text in selected lines |
| 912 | `separator`;; |
| 913 | separators between fields on a line (`:`, `-`, and `=`) |
| 914 | and between hunks (`--`) |
| 915 | -- |
| 916 | + |
| 917 | The values of these variables may be specified as in color.branch.<slot>. |
| Junio C Hamano | d257cff | 2009-03-18 05:27:16 | [diff] [blame] | 918 | |
| Junio C Hamano | 00b8b63 | 2007-12-07 09:50:49 | [diff] [blame] | 919 | color.interactive:: |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 920 | When set to `always`, always use colors for interactive prompts |
| Junio C Hamano | 58f587a | 2013-07-22 19:20:59 | [diff] [blame] | 921 | and displays (such as those used by "git-add --interactive" and |
| 922 | "git-clean --interactive"). When false (or `never`), never. |
| 923 | When set to `true` or `auto`, use colors only when the output is |
| 924 | to the terminal. Defaults to false. |
| Junio C Hamano | 00b8b63 | 2007-12-07 09:50:49 | [diff] [blame] | 925 | |
| 926 | color.interactive.<slot>:: |
| Junio C Hamano | 58f587a | 2013-07-22 19:20:59 | [diff] [blame] | 927 | Use customized color for 'git add --interactive' and 'git clean |
| 928 | --interactive' output. `<slot>` may be `prompt`, `header`, `help` |
| 929 | or `error`, for four distinct types of normal output from |
| 930 | interactive commands. The values of these variables may be |
| 931 | specified as in color.branch.<slot>. |
| Junio C Hamano | 00b8b63 | 2007-12-07 09:50:49 | [diff] [blame] | 932 | |
| Junio C Hamano | e7935c4 | 2006-12-13 21:32:17 | [diff] [blame] | 933 | color.pager:: |
| 934 | A boolean to enable/disable colored output when the pager is in |
| 935 | use (default is true). |
| 936 | |
| Junio C Hamano | 52ba295 | 2009-05-18 17:43:02 | [diff] [blame] | 937 | color.showbranch:: |
| 938 | A boolean to enable/disable color in the output of |
| 939 | linkgit:git-show-branch[1]. May be set to `always`, |
| 940 | `false` (or `never`) or `auto` (or `true`), in which case colors are used |
| 941 | only when the output is to a terminal. Defaults to false. |
| 942 | |
| Junio C Hamano | e7935c4 | 2006-12-13 21:32:17 | [diff] [blame] | 943 | color.status:: |
| 944 | A boolean to enable/disable color in the output of |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 945 | linkgit:git-status[1]. May be set to `always`, |
| Junio C Hamano | 0fc8cd9 | 2007-12-06 03:26:21 | [diff] [blame] | 946 | `false` (or `never`) or `auto` (or `true`), in which case colors are used |
| Junio C Hamano | e7935c4 | 2006-12-13 21:32:17 | [diff] [blame] | 947 | only when the output is to a terminal. Defaults to false. |
| 948 | |
| 949 | color.status.<slot>:: |
| 950 | Use customized color for status colorization. `<slot>` is |
| 951 | one of `header` (the header text of the status message), |
| Junio C Hamano | 7d23f5e | 2006-12-16 07:44:04 | [diff] [blame] | 952 | `added` or `updated` (files which are added but not committed), |
| 953 | `changed` (files which are changed but not added in the index), |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 954 | `untracked` (files which are not tracked by Git), |
| Junio C Hamano | 0d75e87 | 2010-12-17 06:57:26 | [diff] [blame] | 955 | `branch` (the current branch), or |
| Junio C Hamano | b713ff1 | 2008-05-24 01:12:30 | [diff] [blame] | 956 | `nobranch` (the color the 'no branch' warning is shown in, defaulting |
| 957 | to red). The values of these variables may be specified as in |
| 958 | color.branch.<slot>. |
| Junio C Hamano | e7935c4 | 2006-12-13 21:32:17 | [diff] [blame] | 959 | |
| Junio C Hamano | 83d46a2 | 2008-02-21 02:29:42 | [diff] [blame] | 960 | color.ui:: |
| Junio C Hamano | 5f2627d | 2011-05-06 20:23:48 | [diff] [blame] | 961 | This variable determines the default value for variables such |
| 962 | as `color.diff` and `color.grep` that control the use of color |
| 963 | per command family. Its scope will expand as more commands learn |
| 964 | configuration to set a default for the `--color` option. Set it |
| Junio C Hamano | fa1d349 | 2013-06-20 23:39:43 | [diff] [blame] | 965 | to `false` or `never` if you prefer Git commands not to use |
| 966 | color unless enabled explicitly with some other configuration |
| 967 | or the `--color` option. Set it to `always` if you want all |
| 968 | output not intended for machine consumption to use color, to |
| 969 | `true` or `auto` (this is the default since Git 1.8.4) if you |
| 970 | want such output to use color when written to the terminal. |
| Junio C Hamano | 83d46a2 | 2008-02-21 02:29:42 | [diff] [blame] | 971 | |
| Junio C Hamano | 22700fb | 2012-05-03 23:07:25 | [diff] [blame] | 972 | column.ui:: |
| 973 | Specify whether supported commands should output in columns. |
| 974 | This variable consists of a list of tokens separated by spaces |
| 975 | or commas: |
| 976 | + |
| Junio C Hamano | a195230 | 2013-07-01 21:31:18 | [diff] [blame] | 977 | These options control when the feature should be enabled |
| 978 | (defaults to 'never'): |
| 979 | + |
| Junio C Hamano | 22700fb | 2012-05-03 23:07:25 | [diff] [blame] | 980 | -- |
| 981 | `always`;; |
| 982 | always show in columns |
| 983 | `never`;; |
| 984 | never show in columns |
| 985 | `auto`;; |
| 986 | show in columns if the output is to the terminal |
| Junio C Hamano | a195230 | 2013-07-01 21:31:18 | [diff] [blame] | 987 | -- |
| 988 | + |
| 989 | These options control layout (defaults to 'column'). Setting any |
| 990 | of these implies 'always' if none of 'always', 'never', or 'auto' are |
| 991 | specified. |
| 992 | + |
| 993 | -- |
| Junio C Hamano | 22700fb | 2012-05-03 23:07:25 | [diff] [blame] | 994 | `column`;; |
| Junio C Hamano | a195230 | 2013-07-01 21:31:18 | [diff] [blame] | 995 | fill columns before rows |
| Junio C Hamano | 22700fb | 2012-05-03 23:07:25 | [diff] [blame] | 996 | `row`;; |
| 997 | fill rows before columns |
| 998 | `plain`;; |
| 999 | show in one column |
| Junio C Hamano | a195230 | 2013-07-01 21:31:18 | [diff] [blame] | 1000 | -- |
| 1001 | + |
| 1002 | Finally, these options can be combined with a layout option (defaults |
| 1003 | to 'nodense'): |
| 1004 | + |
| 1005 | -- |
| Junio C Hamano | 22700fb | 2012-05-03 23:07:25 | [diff] [blame] | 1006 | `dense`;; |
| 1007 | make unequal size columns to utilize more space |
| 1008 | `nodense`;; |
| 1009 | make equal size columns |
| 1010 | -- |
| Junio C Hamano | 22700fb | 2012-05-03 23:07:25 | [diff] [blame] | 1011 | |
| 1012 | column.branch:: |
| 1013 | Specify whether to output branch listing in `git branch` in columns. |
| 1014 | See `column.ui` for details. |
| 1015 | |
| Junio C Hamano | 58f587a | 2013-07-22 19:20:59 | [diff] [blame] | 1016 | column.clean:: |
| 1017 | Specify the layout when list items in `git clean -i`, which always |
| 1018 | shows files and directories in columns. See `column.ui` for details. |
| 1019 | |
| Junio C Hamano | 22700fb | 2012-05-03 23:07:25 | [diff] [blame] | 1020 | column.status:: |
| 1021 | Specify whether to output untracked files in `git status` in columns. |
| 1022 | See `column.ui` for details. |
| 1023 | |
| 1024 | column.tag:: |
| 1025 | Specify whether to output tag listing in `git tag` in columns. |
| 1026 | See `column.ui` for details. |
| 1027 | |
| Junio C Hamano | ce836cc | 2013-01-21 02:01:53 | [diff] [blame] | 1028 | commit.cleanup:: |
| 1029 | This setting overrides the default of the `--cleanup` option in |
| 1030 | `git commit`. See linkgit:git-commit[1] for details. Changing the |
| 1031 | default can be useful when you always want to keep lines that begin |
| 1032 | with comment character `#` in your log message, in which case you |
| 1033 | would do `git config commit.cleanup whitespace` (note that you will |
| 1034 | have to remove the help lines that begin with `#` in the commit log |
| 1035 | template yourself, if you do this). |
| 1036 | |
| Junio C Hamano | 5b3533d | 2014-02-27 23:07:15 | [diff] [blame] | 1037 | commit.gpgsign:: |
| 1038 | |
| 1039 | A boolean to specify whether all commits should be GPG signed. |
| 1040 | Use of this option when doing operations such as rebase can |
| 1041 | result in a large number of commits being signed. It may be |
| 1042 | convenient to use an agent to avoid typing your GPG passphrase |
| 1043 | several times. |
| 1044 | |
| Junio C Hamano | d0d892c | 2010-01-24 20:06:29 | [diff] [blame] | 1045 | commit.status:: |
| Junio C Hamano | 6ce6b6c | 2010-01-18 01:25:50 | [diff] [blame] | 1046 | A boolean to enable/disable inclusion of status information in the |
| 1047 | commit message template when using an editor to prepare the commit |
| 1048 | message. Defaults to true. |
| 1049 | |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 1050 | commit.template:: |
| 1051 | Specify a file to use as the template for new commit messages. |
| Junio C Hamano | b76a686 | 2012-05-02 22:02:46 | [diff] [blame] | 1052 | "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the |
| Junio C Hamano | bf984de | 2009-11-23 06:11:19 | [diff] [blame] | 1053 | specified user's home directory. |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 1054 | |
| Junio C Hamano | 0df9271 | 2011-12-21 22:30:44 | [diff] [blame] | 1055 | credential.helper:: |
| 1056 | Specify an external helper to be called when a username or |
| 1057 | password credential is needed; the helper may consult external |
| 1058 | storage to avoid prompting the user for the credentials. See |
| 1059 | linkgit:gitcredentials[7] for details. |
| 1060 | |
| 1061 | credential.useHttpPath:: |
| 1062 | When acquiring credentials, consider the "path" component of an http |
| 1063 | or https URL to be important. Defaults to false. See |
| 1064 | linkgit:gitcredentials[7] for more information. |
| 1065 | |
| 1066 | credential.username:: |
| 1067 | If no username is set for a network authentication, use this username |
| 1068 | by default. See credential.<context>.* below, and |
| 1069 | linkgit:gitcredentials[7]. |
| 1070 | |
| 1071 | credential.<url>.*:: |
| 1072 | Any of the credential.* options above can be applied selectively to |
| 1073 | some credentials. For example "credential.https://example.com.username" |
| 1074 | would set the default username only for https connections to |
| 1075 | example.com. See linkgit:gitcredentials[7] for details on how URLs are |
| 1076 | matched. |
| 1077 | |
| Junio C Hamano | 209ebe8 | 2011-04-27 21:09:59 | [diff] [blame] | 1078 | include::diff-config.txt[] |
| Junio C Hamano | 3bd66e9 | 2009-04-18 06:17:56 | [diff] [blame] | 1079 | |
| 1080 | difftool.<tool>.path:: |
| 1081 | Override the path for the given tool. This is useful in case |
| 1082 | your tool is not in the PATH. |
| 1083 | |
| 1084 | difftool.<tool>.cmd:: |
| 1085 | Specify the command to invoke the specified diff tool. |
| 1086 | The specified command is evaluated in shell with the following |
| 1087 | variables available: 'LOCAL' is set to the name of the temporary |
| 1088 | file containing the contents of the diff pre-image and 'REMOTE' |
| 1089 | is set to the name of the temporary file containing the contents |
| 1090 | of the diff post-image. |
| 1091 | |
| 1092 | difftool.prompt:: |
| 1093 | Prompt before each invocation of the diff tool. |
| 1094 | |
| Junio C Hamano | 0d75e87 | 2010-12-17 06:57:26 | [diff] [blame] | 1095 | fetch.recurseSubmodules:: |
| Junio C Hamano | 5cd1518 | 2011-04-05 00:21:10 | [diff] [blame] | 1096 | This option can be either set to a boolean value or to 'on-demand'. |
| 1097 | Setting it to a boolean changes the behavior of fetch and pull to |
| 1098 | unconditionally recurse into submodules when set to true or to not |
| 1099 | recurse at all when set to false. When set to 'on-demand' (the default |
| 1100 | value), fetch and pull will only recurse into a populated submodule |
| 1101 | when its superproject retrieves a commit that updates the submodule's |
| 1102 | reference. |
| Junio C Hamano | 0d75e87 | 2010-12-17 06:57:26 | [diff] [blame] | 1103 | |
| Junio C Hamano | 8fb66e5 | 2011-10-05 20:59:51 | [diff] [blame] | 1104 | fetch.fsckObjects:: |
| 1105 | If it is set to true, git-fetch-pack will check all fetched |
| 1106 | objects. It will abort in the case of a malformed object or a |
| 1107 | broken link. The result of an abort are only dangling objects. |
| 1108 | Defaults to false. If not set, the value of `transfer.fsckObjects` |
| 1109 | is used instead. |
| 1110 | |
| Junio C Hamano | 54ea8d3 | 2007-01-25 07:59:48 | [diff] [blame] | 1111 | fetch.unpackLimit:: |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 1112 | If the number of objects fetched over the Git native |
| Junio C Hamano | 54ea8d3 | 2007-01-25 07:59:48 | [diff] [blame] | 1113 | transfer is below this |
| 1114 | limit, then the objects will be unpacked into loose object |
| 1115 | files. However if the number of received objects equals or |
| 1116 | exceeds this limit then the received pack will be stored as |
| 1117 | a pack, after adding any missing delta bases. Storing the |
| 1118 | pack from a push can make the push operation complete faster, |
| Junio C Hamano | e77b015 | 2008-01-12 06:44:17 | [diff] [blame] | 1119 | especially on slow filesystems. If not set, the value of |
| 1120 | `transfer.unpackLimit` is used instead. |
| Junio C Hamano | 54ea8d3 | 2007-01-25 07:59:48 | [diff] [blame] | 1121 | |
| Junio C Hamano | 8eac268 | 2013-09-09 22:35:20 | [diff] [blame] | 1122 | fetch.prune:: |
| 1123 | If true, fetch will automatically behave as if the `--prune` |
| 1124 | option was given on the command line. See also `remote.<name>.prune`. |
| 1125 | |
| Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 1126 | format.attach:: |
| 1127 | Enable multipart/mixed attachments as the default for |
| 1128 | 'format-patch'. The value can also be a double quoted string |
| 1129 | which will enable attachments as the default and set the |
| 1130 | value as the boundary. See the --attach option in |
| 1131 | linkgit:git-format-patch[1]. |
| 1132 | |
| Junio C Hamano | 8c5802d | 2007-11-15 00:13:36 | [diff] [blame] | 1133 | format.numbered:: |
| Junio C Hamano | 7d06a8a | 2008-10-20 05:42:33 | [diff] [blame] | 1134 | A boolean which can enable or disable sequence numbers in patch |
| 1135 | subjects. It defaults to "auto" which enables it only if there |
| 1136 | is more than one patch. It can be enabled or disabled for all |
| 1137 | messages by setting it to "true" or "false". See --numbered |
| 1138 | option in linkgit:git-format-patch[1]. |
| Junio C Hamano | 8c5802d | 2007-11-15 00:13:36 | [diff] [blame] | 1139 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1140 | format.headers:: |
| 1141 | Additional email headers to include in a patch to be submitted |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1142 | by mail. See linkgit:git-format-patch[1]. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1143 | |
| Junio C Hamano | 70664a0 | 2010-07-13 22:48:05 | [diff] [blame] | 1144 | format.to:: |
| Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 1145 | format.cc:: |
| Junio C Hamano | 70664a0 | 2010-07-13 22:48:05 | [diff] [blame] | 1146 | Additional recipients to include in a patch to be submitted |
| 1147 | by mail. See the --to and --cc options in |
| 1148 | linkgit:git-format-patch[1]. |
| Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 1149 | |
| 1150 | format.subjectprefix:: |
| 1151 | The default for format-patch is to output files with the '[PATCH]' |
| 1152 | subject prefix. Use this variable to change that prefix. |
| 1153 | |
| Junio C Hamano | 89a5734 | 2010-06-22 23:22:55 | [diff] [blame] | 1154 | format.signature:: |
| 1155 | The default for format-patch is to output a signature containing |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 1156 | the Git version number. Use this variable to change that default. |
| Junio C Hamano | 89a5734 | 2010-06-22 23:22:55 | [diff] [blame] | 1157 | Set this variable to the empty string ("") to suppress |
| 1158 | signature generation. |
| 1159 | |
| Junio C Hamano | c8c398a | 2014-06-16 21:14:05 | [diff] [blame] | 1160 | format.signaturefile:: |
| 1161 | Works just like format.signature except the contents of the |
| 1162 | file specified by this variable will be used as the signature. |
| 1163 | |
| Junio C Hamano | d4c8e11 | 2007-03-04 10:32:38 | [diff] [blame] | 1164 | format.suffix:: |
| 1165 | The default for format-patch is to output files with the suffix |
| 1166 | `.patch`. Use this variable to change that suffix (make sure to |
| 1167 | include the dot if you want it). |
| 1168 | |
| Junio C Hamano | 86bcccc | 2008-03-08 09:33:55 | [diff] [blame] | 1169 | format.pretty:: |
| 1170 | The default pretty format for log/show/whatchanged command, |
| 1171 | See linkgit:git-log[1], linkgit:git-show[1], |
| 1172 | linkgit:git-whatchanged[1]. |
| 1173 | |
| Junio C Hamano | ea6a764 | 2009-03-11 23:56:19 | [diff] [blame] | 1174 | format.thread:: |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 1175 | The default threading style for 'git format-patch'. Can be |
| Junio C Hamano | b141a92 | 2010-01-10 19:55:14 | [diff] [blame] | 1176 | a boolean value, or `shallow` or `deep`. `shallow` threading |
| 1177 | makes every mail a reply to the head of the series, |
| Junio C Hamano | ea6a764 | 2009-03-11 23:56:19 | [diff] [blame] | 1178 | where the head is chosen from the cover letter, the |
| Junio C Hamano | b76a686 | 2012-05-02 22:02:46 | [diff] [blame] | 1179 | `--in-reply-to`, and the first patch mail, in this order. |
| Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 1180 | `deep` threading makes every mail a reply to the previous one. |
| Junio C Hamano | ea6a764 | 2009-03-11 23:56:19 | [diff] [blame] | 1181 | A true boolean value is the same as `shallow`, and a false |
| 1182 | value disables threading. |
| 1183 | |
| Junio C Hamano | 5f9a6f0 | 2009-04-06 08:26:56 | [diff] [blame] | 1184 | format.signoff:: |
| Junio C Hamano | 804a974 | 2013-04-28 23:10:31 | [diff] [blame] | 1185 | A boolean value which lets you enable the `-s/--signoff` option of |
| 1186 | format-patch by default. *Note:* Adding the Signed-off-by: line to a |
| 1187 | patch should be a conscious act and means that you certify you have |
| 1188 | the rights to submit this work under the same open source license. |
| 1189 | Please see the 'SubmittingPatches' document for further discussion. |
| Junio C Hamano | 5f9a6f0 | 2009-04-06 08:26:56 | [diff] [blame] | 1190 | |
| Junio C Hamano | ea3b752 | 2013-04-18 19:37:53 | [diff] [blame] | 1191 | format.coverLetter:: |
| 1192 | A boolean that controls whether to generate a cover-letter when |
| 1193 | format-patch is invoked, but in addition can be set to "auto", to |
| 1194 | generate a cover-letter only when there's more than one patch. |
| 1195 | |
| Junio C Hamano | 209ebe8 | 2011-04-27 21:09:59 | [diff] [blame] | 1196 | filter.<driver>.clean:: |
| 1197 | The command which is used to convert the content of a worktree |
| 1198 | file to a blob upon checkin. See linkgit:gitattributes[5] for |
| 1199 | details. |
| 1200 | |
| 1201 | filter.<driver>.smudge:: |
| 1202 | The command which is used to convert the content of a blob |
| 1203 | object to a worktree file upon checkout. See |
| 1204 | linkgit:gitattributes[5] for details. |
| 1205 | |
| Junio C Hamano | 624dd4c | 2014-04-03 21:56:30 | [diff] [blame] | 1206 | gc.aggressiveDepth:: |
| 1207 | The depth parameter used in the delta compression |
| 1208 | algorithm used by 'git gc --aggressive'. This defaults |
| 1209 | to 250. |
| 1210 | |
| Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 1211 | gc.aggressiveWindow:: |
| 1212 | The window size parameter used in the delta compression |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 1213 | algorithm used by 'git gc --aggressive'. This defaults |
| Junio C Hamano | b04bb3f | 2010-04-14 14:07:36 | [diff] [blame] | 1214 | to 250. |
| Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 1215 | |
| Junio C Hamano | 1b50ce9 | 2007-10-03 12:05:53 | [diff] [blame] | 1216 | gc.auto:: |
| 1217 | When there are approximately more than this many loose |
| 1218 | objects in the repository, `git gc --auto` will pack them. |
| 1219 | Some Porcelain commands use this command to perform a |
| Junio C Hamano | e77b015 | 2008-01-12 06:44:17 | [diff] [blame] | 1220 | light-weight garbage collection from time to time. The |
| 1221 | default value is 6700. Setting this to 0 disables it. |
| Junio C Hamano | 1b50ce9 | 2007-10-03 12:05:53 | [diff] [blame] | 1222 | |
| 1223 | gc.autopacklimit:: |
| 1224 | When there are more than this many packs that are not |
| 1225 | marked with `*.keep` file in the repository, `git gc |
| Junio C Hamano | e77b015 | 2008-01-12 06:44:17 | [diff] [blame] | 1226 | --auto` consolidates them into one larger pack. The |
| Junio C Hamano | 25c0b70 | 2008-03-23 09:41:37 | [diff] [blame] | 1227 | default value is 50. Setting this to 0 disables it. |
| Junio C Hamano | 1b50ce9 | 2007-10-03 12:05:53 | [diff] [blame] | 1228 | |
| Junio C Hamano | 08ef8c2 | 2014-03-10 14:53:44 | [diff] [blame] | 1229 | gc.autodetach:: |
| Junio C Hamano | fb5ffde | 2014-11-04 22:38:56 | [diff] [blame] | 1230 | Make `git gc --auto` return immediately and run in background |
| Junio C Hamano | 08ef8c2 | 2014-03-10 14:53:44 | [diff] [blame] | 1231 | if the system supports it. Default is true. |
| 1232 | |
| Junio C Hamano | 9d52e57 | 2007-02-13 23:48:20 | [diff] [blame] | 1233 | gc.packrefs:: |
| Junio C Hamano | b141a92 | 2010-01-10 19:55:14 | [diff] [blame] | 1234 | Running `git pack-refs` in a repository renders it |
| 1235 | unclonable by Git versions prior to 1.5.1.2 over dumb |
| 1236 | transports such as HTTP. This variable determines whether |
| Junio C Hamano | cdd1c33 | 2010-12-20 10:08:00 | [diff] [blame] | 1237 | 'git gc' runs `git pack-refs`. This can be set to `notbare` |
| Junio C Hamano | b141a92 | 2010-01-10 19:55:14 | [diff] [blame] | 1238 | to enable it within all non-bare repos or it can be set to a |
| 1239 | boolean value. The default is `true`. |
| Junio C Hamano | 9d52e57 | 2007-02-13 23:48:20 | [diff] [blame] | 1240 | |
| Junio C Hamano | 09a926d | 2008-03-13 07:55:29 | [diff] [blame] | 1241 | gc.pruneexpire:: |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 1242 | When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'. |
| Junio C Hamano | a3148f5 | 2009-01-14 08:49:57 | [diff] [blame] | 1243 | Override the grace period with this config variable. The value |
| 1244 | "now" may be used to disable this grace period and always prune |
| 1245 | unreachable objects immediately. |
| Junio C Hamano | 09a926d | 2008-03-13 07:55:29 | [diff] [blame] | 1246 | |
| Junio C Hamano | 7464064 | 2006-12-27 10:59:55 | [diff] [blame] | 1247 | gc.reflogexpire:: |
| Junio C Hamano | cc7636a | 2010-05-21 14:57:53 | [diff] [blame] | 1248 | gc.<pattern>.reflogexpire:: |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 1249 | 'git reflog expire' removes reflog entries older than |
| Junio C Hamano | cc7636a | 2010-05-21 14:57:53 | [diff] [blame] | 1250 | this time; defaults to 90 days. With "<pattern>" (e.g. |
| 1251 | "refs/stash") in the middle the setting applies only to |
| 1252 | the refs that match the <pattern>. |
| Junio C Hamano | 7464064 | 2006-12-27 10:59:55 | [diff] [blame] | 1253 | |
| 1254 | gc.reflogexpireunreachable:: |
| Junio C Hamano | cc7636a | 2010-05-21 14:57:53 | [diff] [blame] | 1255 | gc.<ref>.reflogexpireunreachable:: |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 1256 | 'git reflog expire' removes reflog entries older than |
| Junio C Hamano | 7464064 | 2006-12-27 10:59:55 | [diff] [blame] | 1257 | this time and are not reachable from the current tip; |
| Junio C Hamano | cc7636a | 2010-05-21 14:57:53 | [diff] [blame] | 1258 | defaults to 30 days. With "<pattern>" (e.g. "refs/stash") |
| 1259 | in the middle, the setting applies only to the refs that |
| 1260 | match the <pattern>. |
| Junio C Hamano | 7464064 | 2006-12-27 10:59:55 | [diff] [blame] | 1261 | |
| 1262 | gc.rerereresolved:: |
| 1263 | Records of conflicted merge you resolved earlier are |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 1264 | kept for this many days when 'git rerere gc' is run. |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1265 | The default is 60 days. See linkgit:git-rerere[1]. |
| Junio C Hamano | 7464064 | 2006-12-27 10:59:55 | [diff] [blame] | 1266 | |
| 1267 | gc.rerereunresolved:: |
| 1268 | Records of conflicted merge you have not resolved are |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 1269 | kept for this many days when 'git rerere gc' is run. |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1270 | The default is 15 days. See linkgit:git-rerere[1]. |
| Junio C Hamano | 7464064 | 2006-12-27 10:59:55 | [diff] [blame] | 1271 | |
| Junio C Hamano | a3148f5 | 2009-01-14 08:49:57 | [diff] [blame] | 1272 | gitcvs.commitmsgannotation:: |
| 1273 | Append this string to each commit message. Set to empty string |
| 1274 | to disable this feature. Defaults to "via git-CVS emulator". |
| 1275 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1276 | gitcvs.enabled:: |
| Junio C Hamano | a638742 | 2007-08-25 03:54:27 | [diff] [blame] | 1277 | Whether the CVS server interface is enabled for this repository. |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1278 | See linkgit:git-cvsserver[1]. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1279 | |
| 1280 | gitcvs.logfile:: |
| Junio C Hamano | a638742 | 2007-08-25 03:54:27 | [diff] [blame] | 1281 | Path to a log file where the CVS server interface well... logs |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1282 | various stuff. See linkgit:git-cvsserver[1]. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1283 | |
| Junio C Hamano | 17bd227 | 2008-09-01 06:11:17 | [diff] [blame] | 1284 | gitcvs.usecrlfattr:: |
| Junio C Hamano | bb88cf4 | 2010-06-21 15:23:55 | [diff] [blame] | 1285 | If true, the server will look up the end-of-line conversion |
| 1286 | attributes for files to determine the '-k' modes to use. If |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 1287 | the attributes force Git to treat a file as text, |
| Junio C Hamano | 619596a | 2010-08-18 22:15:35 | [diff] [blame] | 1288 | the '-k' mode will be left blank so CVS clients will |
| Junio C Hamano | bb88cf4 | 2010-06-21 15:23:55 | [diff] [blame] | 1289 | treat it as text. If they suppress text conversion, the file |
| Junio C Hamano | cb1c44f | 2008-08-06 06:19:33 | [diff] [blame] | 1290 | will be set with '-kb' mode, which suppresses any newline munging |
| Junio C Hamano | bb88cf4 | 2010-06-21 15:23:55 | [diff] [blame] | 1291 | the client might otherwise do. If the attributes do not allow |
| 1292 | the file type to be determined, then 'gitcvs.allbinary' is |
| 1293 | used. See linkgit:gitattributes[5]. |
| Junio C Hamano | dfccbb0 | 2008-05-26 01:16:14 | [diff] [blame] | 1294 | |
| Junio C Hamano | d9e0e5d | 2007-04-14 16:22:04 | [diff] [blame] | 1295 | gitcvs.allbinary:: |
| Junio C Hamano | dfccbb0 | 2008-05-26 01:16:14 | [diff] [blame] | 1296 | This is used if 'gitcvs.usecrlfattr' does not resolve |
| 1297 | the correct '-kb' mode to use. If true, all |
| 1298 | unresolved files are sent to the client in |
| 1299 | mode '-kb'. This causes the client to treat them |
| 1300 | as binary files, which suppresses any newline munging it |
| 1301 | otherwise might do. Alternatively, if it is set to "guess", |
| 1302 | then the contents of the file are examined to decide if |
| 1303 | it is binary, similar to 'core.autocrlf'. |
| Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 1304 | |
| 1305 | gitcvs.dbname:: |
| 1306 | Database used by git-cvsserver to cache revision information |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 1307 | derived from the Git repository. The exact meaning depends on the |
| Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 1308 | used database driver, for SQLite (which is the default driver) this |
| 1309 | is a filename. Supports variable substitution (see |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1310 | linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`). |
| Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 1311 | Default: '%Ggitcvs.%m.sqlite' |
| 1312 | |
| 1313 | gitcvs.dbdriver:: |
| 1314 | Used Perl DBI driver. You can specify any available driver |
| Junio C Hamano | 804a974 | 2013-04-28 23:10:31 | [diff] [blame] | 1315 | for this here, but it might not work. git-cvsserver is tested |
| Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 1316 | with 'DBD::SQLite', reported to work with 'DBD::Pg', and |
| 1317 | reported *not* to work with 'DBD::mysql'. Experimental feature. |
| 1318 | May not contain double colons (`:`). Default: 'SQLite'. |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1319 | See linkgit:git-cvsserver[1]. |
| Junio C Hamano | d9e0e5d | 2007-04-14 16:22:04 | [diff] [blame] | 1320 | |
| Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 1321 | gitcvs.dbuser, gitcvs.dbpass:: |
| 1322 | Database user and password. Only useful if setting 'gitcvs.dbdriver', |
| 1323 | since SQLite has no concept of database users and/or passwords. |
| 1324 | 'gitcvs.dbuser' supports variable substitution (see |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1325 | linkgit:git-cvsserver[1] for details). |
| Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 1326 | |
| Junio C Hamano | a74efce | 2008-04-02 08:39:08 | [diff] [blame] | 1327 | gitcvs.dbTableNamePrefix:: |
| 1328 | Database table name prefix. Prepended to the names of any |
| 1329 | database tables used, allowing a single database to be used |
| 1330 | for several repositories. Supports variable substitution (see |
| 1331 | linkgit:git-cvsserver[1] for details). Any non-alphabetic |
| 1332 | characters will be replaced with underscores. |
| 1333 | |
| Junio C Hamano | dfccbb0 | 2008-05-26 01:16:14 | [diff] [blame] | 1334 | All gitcvs variables except for 'gitcvs.usecrlfattr' and |
| 1335 | 'gitcvs.allbinary' can also be specified as |
| 1336 | 'gitcvs.<access_method>.<varname>' (where 'access_method' |
| Junio C Hamano | a638742 | 2007-08-25 03:54:27 | [diff] [blame] | 1337 | is one of "ext" and "pserver") to make them apply only for the given |
| 1338 | access method. |
| Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 1339 | |
| Junio C Hamano | 11821ed | 2011-10-19 18:42:09 | [diff] [blame] | 1340 | gitweb.category:: |
| 1341 | gitweb.description:: |
| 1342 | gitweb.owner:: |
| 1343 | gitweb.url:: |
| 1344 | See linkgit:gitweb[1] for description. |
| 1345 | |
| 1346 | gitweb.avatar:: |
| 1347 | gitweb.blame:: |
| 1348 | gitweb.grep:: |
| 1349 | gitweb.highlight:: |
| 1350 | gitweb.patches:: |
| 1351 | gitweb.pickaxe:: |
| 1352 | gitweb.remote_heads:: |
| 1353 | gitweb.showsizes:: |
| 1354 | gitweb.snapshot:: |
| 1355 | See linkgit:gitweb.conf[5] for description. |
| 1356 | |
| Junio C Hamano | a03ac86 | 2011-04-02 04:32:29 | [diff] [blame] | 1357 | grep.lineNumber:: |
| 1358 | If set to true, enable '-n' option by default. |
| 1359 | |
| Junio C Hamano | a00504d | 2012-08-27 21:11:23 | [diff] [blame] | 1360 | grep.patternType:: |
| 1361 | Set the default matching behavior. Using a value of 'basic', 'extended', |
| 1362 | 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp', |
| 1363 | '--fixed-strings', or '--perl-regexp' option accordingly, while the |
| 1364 | value 'default' will return to the default matching behavior. |
| 1365 | |
| Junio C Hamano | a03ac86 | 2011-04-02 04:32:29 | [diff] [blame] | 1366 | grep.extendedRegexp:: |
| Junio C Hamano | a00504d | 2012-08-27 21:11:23 | [diff] [blame] | 1367 | If set to true, enable '--extended-regexp' option by default. This |
| 1368 | option is ignored when the 'grep.patternType' option is set to a value |
| 1369 | other than 'default'. |
| Junio C Hamano | a03ac86 | 2011-04-02 04:32:29 | [diff] [blame] | 1370 | |
| Junio C Hamano | 4fd2442 | 2012-01-06 21:52:43 | [diff] [blame] | 1371 | gpg.program:: |
| 1372 | Use this custom program instead of "gpg" found on $PATH when |
| 1373 | making or verifying a PGP signature. The program must support the |
| Junio C Hamano | e1aeb5e | 2014-06-06 19:16:29 | [diff] [blame] | 1374 | same command-line interface as GPG, namely, to verify a detached |
| Junio C Hamano | 4fd2442 | 2012-01-06 21:52:43 | [diff] [blame] | 1375 | signature, "gpg --verify $file - <$signature" is run, and the |
| 1376 | program is expected to signal a good signature by exiting with |
| Junio C Hamano | fb5ffde | 2014-11-04 22:38:56 | [diff] [blame] | 1377 | code 0, and to generate an ASCII-armored detached signature, the |
| Junio C Hamano | 4fd2442 | 2012-01-06 21:52:43 | [diff] [blame] | 1378 | standard input of "gpg -bsau $key" is fed with the contents to be |
| 1379 | signed, and the program is expected to send the result to its |
| 1380 | standard output. |
| 1381 | |
| Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 1382 | gui.commitmsgwidth:: |
| 1383 | Defines how wide the commit message window is in the |
| 1384 | linkgit:git-gui[1]. "75" is the default. |
| 1385 | |
| 1386 | gui.diffcontext:: |
| 1387 | Specifies how many context lines should be used in calls to diff |
| 1388 | made by the linkgit:git-gui[1]. The default is "5". |
| 1389 | |
| Junio C Hamano | 796c55f | 2014-05-02 21:45:15 | [diff] [blame] | 1390 | gui.displayuntracked:: |
| 1391 | Determines if linkgit::git-gui[1] shows untracked files |
| 1392 | in the file list. The default is "true". |
| 1393 | |
| Junio C Hamano | d3452a0 | 2008-11-15 08:07:55 | [diff] [blame] | 1394 | gui.encoding:: |
| 1395 | Specifies the default encoding to use for displaying of |
| 1396 | file contents in linkgit:git-gui[1] and linkgit:gitk[1]. |
| 1397 | It can be overridden by setting the 'encoding' attribute |
| 1398 | for relevant files (see linkgit:gitattributes[5]). |
| 1399 | If this option is not set, the tools default to the |
| 1400 | locale encoding. |
| 1401 | |
| Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 1402 | gui.matchtrackingbranch:: |
| 1403 | Determines if new branches created with linkgit:git-gui[1] should |
| 1404 | default to tracking remote branches with matching names or |
| 1405 | not. Default: "false". |
| 1406 | |
| 1407 | gui.newbranchtemplate:: |
| 1408 | Is used as suggested name when creating new branches using the |
| 1409 | linkgit:git-gui[1]. |
| 1410 | |
| 1411 | gui.pruneduringfetch:: |
| Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1412 | "true" if linkgit:git-gui[1] should prune remote-tracking branches when |
| Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 1413 | performing a fetch. The default value is "false". |
| 1414 | |
| 1415 | gui.trustmtime:: |
| 1416 | Determines if linkgit:git-gui[1] should trust the file modification |
| 1417 | timestamp or not. By default the timestamps are not trusted. |
| 1418 | |
| 1419 | gui.spellingdictionary:: |
| 1420 | Specifies the dictionary used for spell checking commit messages in |
| 1421 | the linkgit:git-gui[1]. When set to "none" spell checking is turned |
| 1422 | off. |
| 1423 | |
| Junio C Hamano | d3452a0 | 2008-11-15 08:07:55 | [diff] [blame] | 1424 | gui.fastcopyblame:: |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 1425 | If true, 'git gui blame' uses `-C` instead of `-C -C` for original |
| Junio C Hamano | d3452a0 | 2008-11-15 08:07:55 | [diff] [blame] | 1426 | location detection. It makes blame significantly faster on huge |
| 1427 | repositories at the expense of less thorough copy detection. |
| 1428 | |
| 1429 | gui.copyblamethreshold:: |
| Junio C Hamano | 610d176 | 2008-11-28 06:27:13 | [diff] [blame] | 1430 | Specifies the threshold to use in 'git gui blame' original location |
| Junio C Hamano | d3452a0 | 2008-11-15 08:07:55 | [diff] [blame] | 1431 | detection, measured in alphanumeric characters. See the |
| 1432 | linkgit:git-blame[1] manual for more information on copy detection. |
| 1433 | |
| 1434 | gui.blamehistoryctx:: |
| 1435 | Specifies the radius of history context in days to show in |
| 1436 | linkgit:gitk[1] for the selected commit, when the `Show History |
| 1437 | Context` menu item is invoked from 'git gui blame'. If this |
| 1438 | variable is set to zero, the whole history is shown. |
| 1439 | |
| Junio C Hamano | 92d312a | 2008-12-15 07:22:20 | [diff] [blame] | 1440 | guitool.<name>.cmd:: |
| 1441 | Specifies the shell command line to execute when the corresponding item |
| 1442 | of the linkgit:git-gui[1] `Tools` menu is invoked. This option is |
| 1443 | mandatory for every tool. The command is executed from the root of |
| 1444 | the working directory, and in the environment it receives the name of |
| 1445 | the tool as 'GIT_GUITOOL', the name of the currently selected file as |
| 1446 | 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if |
| 1447 | the head is detached, 'CUR_BRANCH' is empty). |
| 1448 | |
| 1449 | guitool.<name>.needsfile:: |
| 1450 | Run the tool only if a diff is selected in the GUI. It guarantees |
| 1451 | that 'FILENAME' is not empty. |
| 1452 | |
| 1453 | guitool.<name>.noconsole:: |
| 1454 | Run the command silently, without creating a window to display its |
| 1455 | output. |
| 1456 | |
| 1457 | guitool.<name>.norescan:: |
| 1458 | Don't rescan the working directory for changes after the tool |
| 1459 | finishes execution. |
| 1460 | |
| 1461 | guitool.<name>.confirm:: |
| 1462 | Show a confirmation dialog before actually running the tool. |
| 1463 | |
| 1464 | guitool.<name>.argprompt:: |
| 1465 | Request a string argument from the user, and pass it to the tool |
| 1466 | through the 'ARGS' environment variable. Since requesting an |
| 1467 | argument implies confirmation, the 'confirm' option has no effect |
| 1468 | if this is enabled. If the option is set to 'true', 'yes', or '1', |
| 1469 | the dialog uses a built-in generic prompt; otherwise the exact |
| 1470 | value of the variable is used. |
| 1471 | |
| 1472 | guitool.<name>.revprompt:: |
| 1473 | Request a single valid revision from the user, and set the |
| 1474 | 'REVISION' environment variable. In other aspects this option |
| 1475 | is similar to 'argprompt', and can be used together with it. |
| 1476 | |
| 1477 | guitool.<name>.revunmerged:: |
| 1478 | Show only unmerged branches in the 'revprompt' subdialog. |
| 1479 | This is useful for tools similar to merge or rebase, but not |
| 1480 | for things like checkout or reset. |
| 1481 | |
| 1482 | guitool.<name>.title:: |
| 1483 | Specifies the title to use for the prompt dialog. The default |
| 1484 | is the tool name. |
| 1485 | |
| 1486 | guitool.<name>.prompt:: |
| 1487 | Specifies the general prompt string to display at the top of |
| 1488 | the dialog, before subsections for 'argprompt' and 'revprompt'. |
| 1489 | The default value includes the actual command. |
| 1490 | |
| Junio C Hamano | 4e27231 | 2008-01-08 09:13:21 | [diff] [blame] | 1491 | help.browser:: |
| 1492 | Specify the browser that will be used to display help in the |
| 1493 | 'web' format. See linkgit:git-help[1]. |
| 1494 | |
| 1495 | help.format:: |
| 1496 | Override the default help format used by linkgit:git-help[1]. |
| 1497 | Values 'man', 'info', 'web' and 'html' are supported. 'man' is |
| 1498 | the default. 'web' and 'html' are the same. |
| 1499 | |
| Junio C Hamano | f24b806 | 2008-09-09 01:34:39 | [diff] [blame] | 1500 | help.autocorrect:: |
| 1501 | Automatically correct and execute mistyped commands after |
| 1502 | waiting for the given number of deciseconds (0.1 sec). If more |
| 1503 | than one command can be deduced from the entered text, nothing |
| 1504 | will be executed. If the value of this option is negative, |
| 1505 | the corrected command will be executed immediately. If the |
| 1506 | value is 0 - the command will be just shown but not executed. |
| 1507 | This is the default. |
| 1508 | |
| Junio C Hamano | 5dd5fae | 2013-01-18 21:06:49 | [diff] [blame] | 1509 | help.htmlpath:: |
| 1510 | Specify the path where the HTML documentation resides. File system paths |
| 1511 | and URLs are supported. HTML pages will be prefixed with this path when |
| 1512 | help is displayed in the 'web' format. This defaults to the documentation |
| 1513 | path of your Git installation. |
| 1514 | |
| Junio C Hamano | 5825687 | 2007-12-04 08:31:13 | [diff] [blame] | 1515 | http.proxy:: |
| Junio C Hamano | 3dd9392 | 2012-03-05 07:49:11 | [diff] [blame] | 1516 | Override the HTTP proxy, normally configured using the 'http_proxy', |
| 1517 | 'https_proxy', and 'all_proxy' environment variables (see |
| 1518 | `curl(1)`). This can be overridden on a per-remote basis; see |
| 1519 | remote.<name>.proxy |
| Junio C Hamano | 5825687 | 2007-12-04 08:31:13 | [diff] [blame] | 1520 | |
| Junio C Hamano | 4c4b012 | 2011-06-30 01:19:32 | [diff] [blame] | 1521 | http.cookiefile:: |
| 1522 | File containing previously stored cookie lines which should be used |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 1523 | in the Git http session, if they match the server. The file format |
| Junio C Hamano | 4c4b012 | 2011-06-30 01:19:32 | [diff] [blame] | 1524 | of the file to read cookies from should be plain HTTP headers or |
| 1525 | the Netscape/Mozilla cookie file format (see linkgit:curl[1]). |
| 1526 | NOTE that the file specified with http.cookiefile is only used as |
| Junio C Hamano | 8eac268 | 2013-09-09 22:35:20 | [diff] [blame] | 1527 | input unless http.saveCookies is set. |
| 1528 | |
| 1529 | http.savecookies:: |
| 1530 | If set, store cookies received during requests to the file specified by |
| 1531 | http.cookiefile. Has no effect if http.cookiefile is unset. |
| Junio C Hamano | 4c4b012 | 2011-06-30 01:19:32 | [diff] [blame] | 1532 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1533 | http.sslVerify:: |
| 1534 | Whether to verify the SSL certificate when fetching or pushing |
| Junio C Hamano | 33db437 | 2006-06-07 19:51:45 | [diff] [blame] | 1535 | over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1536 | variable. |
| 1537 | |
| 1538 | http.sslCert:: |
| 1539 | File containing the SSL certificate when fetching or pushing |
| Junio C Hamano | 33db437 | 2006-06-07 19:51:45 | [diff] [blame] | 1540 | over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1541 | variable. |
| 1542 | |
| 1543 | http.sslKey:: |
| 1544 | File containing the SSL private key when fetching or pushing |
| Junio C Hamano | 341071d | 2006-06-04 07:24:48 | [diff] [blame] | 1545 | over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1546 | variable. |
| 1547 | |
| Junio C Hamano | 48bc1ce | 2009-07-09 16:49:19 | [diff] [blame] | 1548 | http.sslCertPasswordProtected:: |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 1549 | Enable Git's password prompt for the SSL certificate. Otherwise |
| Junio C Hamano | 48bc1ce | 2009-07-09 16:49:19 | [diff] [blame] | 1550 | OpenSSL will prompt the user, possibly many times, if the |
| 1551 | certificate or private key is encrypted. Can be overridden by the |
| 1552 | 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable. |
| 1553 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1554 | http.sslCAInfo:: |
| 1555 | File containing the certificates to verify the peer with when |
| Junio C Hamano | 341071d | 2006-06-04 07:24:48 | [diff] [blame] | 1556 | fetching or pushing over HTTPS. Can be overridden by the |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1557 | 'GIT_SSL_CAINFO' environment variable. |
| 1558 | |
| 1559 | http.sslCAPath:: |
| 1560 | Path containing files with the CA certificates to verify the peer |
| Junio C Hamano | 33db437 | 2006-06-07 19:51:45 | [diff] [blame] | 1561 | with when fetching or pushing over HTTPS. Can be overridden |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1562 | by the 'GIT_SSL_CAPATH' environment variable. |
| 1563 | |
| Junio C Hamano | 7692782 | 2013-04-19 21:26:57 | [diff] [blame] | 1564 | http.sslTry:: |
| 1565 | Attempt to use AUTH SSL/TLS and encrypted data transfers |
| 1566 | when connecting via regular FTP protocol. This might be needed |
| 1567 | if the FTP server requires it for security reasons or you wish |
| 1568 | to connect securely whenever remote FTP server supports it. |
| 1569 | Default is false since it might trigger certificate verification |
| 1570 | errors on misconfigured servers. |
| 1571 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1572 | http.maxRequests:: |
| Junio C Hamano | 341071d | 2006-06-04 07:24:48 | [diff] [blame] | 1573 | How many HTTP requests to launch in parallel. Can be overridden |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1574 | by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5. |
| 1575 | |
| Junio C Hamano | b141a92 | 2010-01-10 19:55:14 | [diff] [blame] | 1576 | http.minSessions:: |
| 1577 | The number of curl sessions (counted across slots) to be kept across |
| 1578 | requests. They will not be ended with curl_easy_cleanup() until |
| 1579 | http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this |
| 1580 | value will be capped at 1. Defaults to 1. |
| 1581 | |
| Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 1582 | http.postBuffer:: |
| 1583 | Maximum size in bytes of the buffer used by smart HTTP |
| 1584 | transports when POSTing data to the remote system. |
| 1585 | For requests larger than this buffer size, HTTP/1.1 and |
| 1586 | Transfer-Encoding: chunked is used to avoid creating a |
| 1587 | massive pack file locally. Default is 1 MiB, which is |
| 1588 | sufficient for most requests. |
| 1589 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1590 | http.lowSpeedLimit, http.lowSpeedTime:: |
| 1591 | If the HTTP transfer speed is less than 'http.lowSpeedLimit' |
| 1592 | for longer than 'http.lowSpeedTime' seconds, the transfer is aborted. |
| Junio C Hamano | 341071d | 2006-06-04 07:24:48 | [diff] [blame] | 1593 | Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1594 | 'GIT_HTTP_LOW_SPEED_TIME' environment variables. |
| 1595 | |
| Junio C Hamano | f1dcdfe | 2006-09-29 08:10:51 | [diff] [blame] | 1596 | http.noEPSV:: |
| 1597 | A boolean which disables using of EPSV ftp command by curl. |
| Junio C Hamano | d9e0e5d | 2007-04-14 16:22:04 | [diff] [blame] | 1598 | This can helpful with some "poor" ftp servers which don't |
| Junio C Hamano | f1dcdfe | 2006-09-29 08:10:51 | [diff] [blame] | 1599 | support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV' |
| 1600 | environment variable. Default is false (curl will use EPSV). |
| 1601 | |
| Junio C Hamano | 53ba6d0 | 2010-08-22 07:25:12 | [diff] [blame] | 1602 | http.useragent:: |
| 1603 | The HTTP USER_AGENT string presented to an HTTP server. The default |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 1604 | value represents the version of the client Git such as git/1.7.1. |
| Junio C Hamano | 53ba6d0 | 2010-08-22 07:25:12 | [diff] [blame] | 1605 | This option allows you to override this value to a more common value |
| 1606 | such as Mozilla/4.0. This may be necessary, for instance, if |
| 1607 | connecting through a firewall that restricts HTTP connections to a set |
| 1608 | of common USER_AGENT strings (but not including those like git/1.7.1). |
| 1609 | Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable. |
| 1610 | |
| Junio C Hamano | 8eac268 | 2013-09-09 22:35:20 | [diff] [blame] | 1611 | http.<url>.*:: |
| Junio C Hamano | fb5ffde | 2014-11-04 22:38:56 | [diff] [blame] | 1612 | Any of the http.* options above can be applied selectively to some URLs. |
| Junio C Hamano | 8eac268 | 2013-09-09 22:35:20 | [diff] [blame] | 1613 | For a config key to match a URL, each element of the config key is |
| 1614 | compared to that of the URL, in the following order: |
| 1615 | + |
| 1616 | -- |
| 1617 | . Scheme (e.g., `https` in `https://example.com/`). This field |
| 1618 | must match exactly between the config key and the URL. |
| 1619 | |
| 1620 | . Host/domain name (e.g., `example.com` in `https://example.com/`). |
| 1621 | This field must match exactly between the config key and the URL. |
| 1622 | |
| 1623 | . Port number (e.g., `8080` in `http://example.com:8080/`). |
| 1624 | This field must match exactly between the config key and the URL. |
| 1625 | Omitted port numbers are automatically converted to the correct |
| 1626 | default for the scheme before matching. |
| 1627 | |
| 1628 | . Path (e.g., `repo.git` in `https://example.com/repo.git`). The |
| 1629 | path field of the config key must match the path field of the URL |
| 1630 | either exactly or as a prefix of slash-delimited path elements. This means |
| 1631 | a config key with path `foo/` matches URL path `foo/bar`. A prefix can only |
| 1632 | match on a slash (`/`) boundary. Longer matches take precedence (so a config |
| 1633 | key with path `foo/bar` is a better match to URL path `foo/bar` than a config |
| 1634 | key with just path `foo/`). |
| 1635 | |
| 1636 | . User name (e.g., `user` in `https://user@example.com/repo.git`). If |
| 1637 | the config key has a user name it must match the user name in the |
| 1638 | URL exactly. If the config key does not have a user name, that |
| 1639 | config key will match a URL with any user name (including none), |
| 1640 | but at a lower precedence than a config key with a user name. |
| 1641 | -- |
| 1642 | + |
| 1643 | The list above is ordered by decreasing precedence; a URL that matches |
| 1644 | a config key's path is preferred to one that matches its user name. For example, |
| 1645 | if the URL is `https://user@example.com/foo/bar` a config key match of |
| 1646 | `https://example.com/foo` will be preferred over a config key match of |
| 1647 | `https://user@example.com`. |
| 1648 | + |
| 1649 | All URLs are normalized before attempting any matching (the password part, |
| 1650 | if embedded in the URL, is always ignored for matching purposes) so that |
| Junio C Hamano | fb5ffde | 2014-11-04 22:38:56 | [diff] [blame] | 1651 | equivalent URLs that are simply spelled differently will match properly. |
| 1652 | Environment variable settings always override any matches. The URLs that are |
| Junio C Hamano | 8eac268 | 2013-09-09 22:35:20 | [diff] [blame] | 1653 | matched against are those given directly to Git commands. This means any URLs |
| 1654 | visited as a result of a redirection do not participate in matching. |
| 1655 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1656 | i18n.commitEncoding:: |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 1657 | Character encoding the commit messages are stored in; Git itself |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1658 | does not care per se, but this information is necessary e.g. when |
| 1659 | importing commits from emails or in the gitk graphical history |
| 1660 | browser (and possibly at other places in the future or in other |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1661 | porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1662 | |
| Junio C Hamano | 51f92e2 | 2006-12-29 05:18:28 | [diff] [blame] | 1663 | i18n.logOutputEncoding:: |
| 1664 | Character encoding the commit messages are converted to when |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 1665 | running 'git log' and friends. |
| Junio C Hamano | 51f92e2 | 2006-12-29 05:18:28 | [diff] [blame] | 1666 | |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 1667 | imap:: |
| 1668 | The configuration variables in the 'imap' section are described |
| 1669 | in linkgit:git-imap-send[1]. |
| 1670 | |
| Junio C Hamano | 81703b2 | 2014-03-14 22:00:27 | [diff] [blame] | 1671 | index.version:: |
| 1672 | Specify the version with which new index files should be |
| 1673 | initialized. This does not affect existing repositories. |
| 1674 | |
| Junio C Hamano | caa712a | 2010-03-11 01:17:35 | [diff] [blame] | 1675 | init.templatedir:: |
| 1676 | Specify the directory from which templates will be copied. |
| 1677 | (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].) |
| 1678 | |
| Junio C Hamano | 4e27231 | 2008-01-08 09:13:21 | [diff] [blame] | 1679 | instaweb.browser:: |
| 1680 | Specify the program that will be used to browse your working |
| 1681 | repository in gitweb. See linkgit:git-instaweb[1]. |
| 1682 | |
| 1683 | instaweb.httpd:: |
| 1684 | The HTTP daemon command-line to start gitweb on your working |
| 1685 | repository. See linkgit:git-instaweb[1]. |
| 1686 | |
| 1687 | instaweb.local:: |
| 1688 | If true the web server started by linkgit:git-instaweb[1] will |
| 1689 | be bound to the local IP (127.0.0.1). |
| 1690 | |
| 1691 | instaweb.modulepath:: |
| Junio C Hamano | 619596a | 2010-08-18 22:15:35 | [diff] [blame] | 1692 | The default module path for linkgit:git-instaweb[1] to use |
| 1693 | instead of /usr/lib/apache2/modules. Only used if httpd |
| 1694 | is Apache. |
| Junio C Hamano | 4e27231 | 2008-01-08 09:13:21 | [diff] [blame] | 1695 | |
| 1696 | instaweb.port:: |
| 1697 | The port number to bind the gitweb httpd to. See |
| 1698 | linkgit:git-instaweb[1]. |
| 1699 | |
| Junio C Hamano | e5bf6c1 | 2009-02-07 21:43:10 | [diff] [blame] | 1700 | interactive.singlekey:: |
| Junio C Hamano | 27a128b | 2009-08-13 01:23:00 | [diff] [blame] | 1701 | In interactive commands, allow the user to provide one-letter |
| Junio C Hamano | e5bf6c1 | 2009-02-07 21:43:10 | [diff] [blame] | 1702 | input with a single key (i.e., without hitting enter). |
| Junio C Hamano | b76a686 | 2012-05-02 22:02:46 | [diff] [blame] | 1703 | Currently this is used by the `--patch` mode of |
| Junio C Hamano | 3d050d6 | 2011-05-17 06:43:34 | [diff] [blame] | 1704 | linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1], |
| 1705 | linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this |
| 1706 | setting is silently ignored if portable keystroke input |
| Junio C Hamano | 81703b2 | 2014-03-14 22:00:27 | [diff] [blame] | 1707 | is not available; requires the Perl module Term::ReadKey. |
| Junio C Hamano | e5bf6c1 | 2009-02-07 21:43:10 | [diff] [blame] | 1708 | |
| Junio C Hamano | f93530e | 2011-05-25 23:59:59 | [diff] [blame] | 1709 | log.abbrevCommit:: |
| 1710 | If true, makes linkgit:git-log[1], linkgit:git-show[1], and |
| Junio C Hamano | b76a686 | 2012-05-02 22:02:46 | [diff] [blame] | 1711 | linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may |
| 1712 | override this option with `--no-abbrev-commit`. |
| Junio C Hamano | f93530e | 2011-05-25 23:59:59 | [diff] [blame] | 1713 | |
| Junio C Hamano | b713ff1 | 2008-05-24 01:12:30 | [diff] [blame] | 1714 | log.date:: |
| Junio C Hamano | 2db3e75 | 2010-09-03 21:33:06 | [diff] [blame] | 1715 | Set the default date-time mode for the 'log' command. |
| 1716 | Setting a value for log.date is similar to using 'git log''s |
| Junio C Hamano | b76a686 | 2012-05-02 22:02:46 | [diff] [blame] | 1717 | `--date` option. Possible values are `relative`, `local`, |
| Junio C Hamano | 2db3e75 | 2010-09-03 21:33:06 | [diff] [blame] | 1718 | `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1] |
| 1719 | for details. |
| Junio C Hamano | b713ff1 | 2008-05-24 01:12:30 | [diff] [blame] | 1720 | |
| Junio C Hamano | cb39aea | 2010-05-09 07:24:48 | [diff] [blame] | 1721 | log.decorate:: |
| 1722 | Print out the ref names of any commits that are shown by the log |
| 1723 | command. If 'short' is specified, the ref name prefixes 'refs/heads/', |
| 1724 | 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is |
| 1725 | specified, the full ref name (including prefix) will be printed. |
| 1726 | This is the same as the log commands '--decorate' option. |
| 1727 | |
| Junio C Hamano | fe9acab | 2006-11-24 12:10:55 | [diff] [blame] | 1728 | log.showroot:: |
| 1729 | If true, the initial commit will be shown as a big creation event. |
| 1730 | This is equivalent to a diff against an empty tree. |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1731 | Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which |
| Junio C Hamano | fe9acab | 2006-11-24 12:10:55 | [diff] [blame] | 1732 | normally hide the root commit will now show it. True by default. |
| 1733 | |
| Junio C Hamano | ce836cc | 2013-01-21 02:01:53 | [diff] [blame] | 1734 | log.mailmap:: |
| 1735 | If true, makes linkgit:git-log[1], linkgit:git-show[1], and |
| 1736 | linkgit:git-whatchanged[1] assume `--use-mailmap`. |
| 1737 | |
| Junio C Hamano | 8bc410e | 2009-02-15 10:38:19 | [diff] [blame] | 1738 | mailmap.file:: |
| 1739 | The location of an augmenting mailmap file. The default |
| 1740 | mailmap, located in the root of the repository, is loaded |
| 1741 | first, then the mailmap file pointed to by this variable. |
| 1742 | The location of the mailmap file may be in a repository |
| 1743 | subdirectory, or somewhere outside of the repository itself. |
| 1744 | See linkgit:git-shortlog[1] and linkgit:git-blame[1]. |
| 1745 | |
| Junio C Hamano | abad6da | 2013-01-06 09:06:32 | [diff] [blame] | 1746 | mailmap.blob:: |
| 1747 | Like `mailmap.file`, but consider the value as a reference to a |
| 1748 | blob in the repository. If both `mailmap.file` and |
| 1749 | `mailmap.blob` are given, both are parsed, with entries from |
| 1750 | `mailmap.file` taking precedence. In a bare repository, this |
| 1751 | defaults to `HEAD:.mailmap`. In a non-bare repository, it |
| 1752 | defaults to empty. |
| 1753 | |
| Junio C Hamano | 8b588d5 | 2008-03-15 09:48:37 | [diff] [blame] | 1754 | man.viewer:: |
| 1755 | Specify the programs that may be used to display help in the |
| 1756 | 'man' format. See linkgit:git-help[1]. |
| 1757 | |
| Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 1758 | man.<tool>.cmd:: |
| 1759 | Specify the command to invoke the specified man viewer. The |
| 1760 | specified command is evaluated in shell with the man page |
| 1761 | passed as argument. (See linkgit:git-help[1].) |
| Junio C Hamano | 103ad7f | 2007-03-14 11:19:26 | [diff] [blame] | 1762 | |
| Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 1763 | man.<tool>.path:: |
| 1764 | Override the path for the given tool that may be used to |
| 1765 | display help in the 'man' format. See linkgit:git-help[1]. |
| Junio C Hamano | e90436a | 2007-04-22 07:22:13 | [diff] [blame] | 1766 | |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 1767 | include::merge-config.txt[] |
| Junio C Hamano | a476efa | 2008-10-10 15:31:42 | [diff] [blame] | 1768 | |
| Junio C Hamano | 1fbbbc1 | 2007-12-18 07:01:27 | [diff] [blame] | 1769 | mergetool.<tool>.path:: |
| 1770 | Override the path for the given tool. This is useful in case |
| 1771 | your tool is not in the PATH. |
| 1772 | |
| Junio C Hamano | 86bcccc | 2008-03-08 09:33:55 | [diff] [blame] | 1773 | mergetool.<tool>.cmd:: |
| 1774 | Specify the command to invoke the specified merge tool. The |
| 1775 | specified command is evaluated in shell with the following |
| 1776 | variables available: 'BASE' is the name of a temporary file |
| 1777 | containing the common base of the files to be merged, if available; |
| 1778 | 'LOCAL' is the name of a temporary file containing the contents of |
| 1779 | the file on the current branch; 'REMOTE' is the name of a temporary |
| 1780 | file containing the contents of the file from the branch being |
| 1781 | merged; 'MERGED' contains the name of the file to which the merge |
| 1782 | tool should write the results of a successful merge. |
| 1783 | |
| 1784 | mergetool.<tool>.trustExitCode:: |
| 1785 | For a custom merge command, specify whether the exit code of |
| 1786 | the merge command can be used to determine whether the merge was |
| 1787 | successful. If this is not set to true then the merge target file |
| 1788 | timestamp is checked and the merge assumed to have been successful |
| 1789 | if the file has been updated, otherwise the user is prompted to |
| 1790 | indicate the success of the merge. |
| 1791 | |
| Junio C Hamano | e478e40 | 2014-10-21 22:14:45 | [diff] [blame] | 1792 | mergetool.meld.hasOutput:: |
| 1793 | Older versions of `meld` do not support the `--output` option. |
| 1794 | Git will attempt to detect whether `meld` supports `--output` |
| 1795 | by inspecting the output of `meld --help`. Configuring |
| 1796 | `mergetool.meld.hasOutput` will make Git skip these checks and |
| 1797 | use the configured value instead. Setting `mergetool.meld.hasOutput` |
| 1798 | to `true` tells Git to unconditionally use the `--output` option, |
| 1799 | and `false` avoids using `--output`. |
| 1800 | |
| Junio C Hamano | 86bcccc | 2008-03-08 09:33:55 | [diff] [blame] | 1801 | mergetool.keepBackup:: |
| 1802 | After performing a merge, the original file with conflict markers |
| 1803 | can be saved as a file with a `.orig` extension. If this variable |
| 1804 | is set to `false` then this file is not preserved. Defaults to |
| 1805 | `true` (i.e. keep the backup files). |
| 1806 | |
| Junio C Hamano | 10b7a34 | 2009-01-01 22:05:17 | [diff] [blame] | 1807 | mergetool.keepTemporaries:: |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 1808 | When invoking a custom merge tool, Git uses a set of temporary |
| Junio C Hamano | 10b7a34 | 2009-01-01 22:05:17 | [diff] [blame] | 1809 | files to pass to the tool. If the tool returns an error and this |
| 1810 | variable is set to `true`, then these temporary files will be |
| 1811 | preserved, otherwise they will be removed after the tool has |
| 1812 | exited. Defaults to `false`. |
| 1813 | |
| Junio C Hamano | e478e40 | 2014-10-21 22:14:45 | [diff] [blame] | 1814 | mergetool.writeToTemp:: |
| 1815 | Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of |
| 1816 | conflicting files in the worktree by default. Git will attempt |
| 1817 | to use a temporary directory for these files when set `true`. |
| 1818 | Defaults to `false`. |
| 1819 | |
| Junio C Hamano | 10b7a34 | 2009-01-01 22:05:17 | [diff] [blame] | 1820 | mergetool.prompt:: |
| 1821 | Prompt before each invocation of the merge resolution program. |
| 1822 | |
| Junio C Hamano | 3166736 | 2010-03-25 00:38:53 | [diff] [blame] | 1823 | notes.displayRef:: |
| 1824 | The (fully qualified) refname from which to show notes when |
| 1825 | showing commit messages. The value of this variable can be set |
| 1826 | to a glob, in which case notes from all matching refs will be |
| 1827 | shown. You may also specify this configuration variable |
| 1828 | several times. A warning will be issued for refs that do not |
| 1829 | exist, but a glob that does not match any refs is silently |
| 1830 | ignored. |
| 1831 | + |
| 1832 | This setting can be overridden with the `GIT_NOTES_DISPLAY_REF` |
| 1833 | environment variable, which must be a colon separated list of refs or |
| 1834 | globs. |
| 1835 | + |
| 1836 | The effective value of "core.notesRef" (possibly overridden by |
| 1837 | GIT_NOTES_REF) is also implicitly added to the list of refs to be |
| 1838 | displayed. |
| 1839 | |
| 1840 | notes.rewrite.<command>:: |
| 1841 | When rewriting commits with <command> (currently `amend` or |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 1842 | `rebase`) and this variable is set to `true`, Git |
| Junio C Hamano | 3166736 | 2010-03-25 00:38:53 | [diff] [blame] | 1843 | automatically copies your notes from the original to the |
| 1844 | rewritten commit. Defaults to `true`, but see |
| 1845 | "notes.rewriteRef" below. |
| Junio C Hamano | 3166736 | 2010-03-25 00:38:53 | [diff] [blame] | 1846 | |
| 1847 | notes.rewriteMode:: |
| 1848 | When copying notes during a rewrite (see the |
| 1849 | "notes.rewrite.<command>" option), determines what to do if |
| 1850 | the target commit already has a note. Must be one of |
| 1851 | `overwrite`, `concatenate`, or `ignore`. Defaults to |
| 1852 | `concatenate`. |
| 1853 | + |
| 1854 | This setting can be overridden with the `GIT_NOTES_REWRITE_MODE` |
| 1855 | environment variable. |
| 1856 | |
| 1857 | notes.rewriteRef:: |
| 1858 | When copying notes during a rewrite, specifies the (fully |
| 1859 | qualified) ref whose notes should be copied. The ref may be a |
| 1860 | glob, in which case notes in all matching refs will be copied. |
| 1861 | You may also specify this configuration several times. |
| 1862 | + |
| 1863 | Does not have a default value; you must configure this variable to |
| Junio C Hamano | 8fb66e5 | 2011-10-05 20:59:51 | [diff] [blame] | 1864 | enable note rewriting. Set it to `refs/notes/commits` to enable |
| 1865 | rewriting for the default commit notes. |
| Junio C Hamano | 2b3ee5d | 2010-05-08 05:41:18 | [diff] [blame] | 1866 | + |
| 1867 | This setting can be overridden with the `GIT_NOTES_REWRITE_REF` |
| 1868 | environment variable, which must be a colon separated list of refs or |
| 1869 | globs. |
| Junio C Hamano | 3166736 | 2010-03-25 00:38:53 | [diff] [blame] | 1870 | |
| Junio C Hamano | 75cc4c9 | 2006-07-24 08:25:03 | [diff] [blame] | 1871 | pack.window:: |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1872 | The size of the window used by linkgit:git-pack-objects[1] when no |
| Junio C Hamano | 75cc4c9 | 2006-07-24 08:25:03 | [diff] [blame] | 1873 | window size is given on the command line. Defaults to 10. |
| 1874 | |
| Junio C Hamano | 91d44c5 | 2007-05-09 07:16:07 | [diff] [blame] | 1875 | pack.depth:: |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1876 | The maximum delta depth used by linkgit:git-pack-objects[1] when no |
| Junio C Hamano | 91d44c5 | 2007-05-09 07:16:07 | [diff] [blame] | 1877 | maximum depth is given on the command line. Defaults to 50. |
| 1878 | |
| Junio C Hamano | 235d53f | 2007-07-13 00:25:15 | [diff] [blame] | 1879 | pack.windowMemory:: |
| Junio C Hamano | 2a4bcbc | 2014-10-29 20:07:39 | [diff] [blame] | 1880 | The maximum size of memory that is consumed by each thread |
| 1881 | in linkgit:git-pack-objects[1] for pack window memory when |
| 1882 | no limit is given on the command line. The value can be |
| 1883 | suffixed with "k", "m", or "g". When left unconfigured (or |
| 1884 | set explicitly to 0), there will be no limit. |
| Junio C Hamano | 235d53f | 2007-07-13 00:25:15 | [diff] [blame] | 1885 | |
| Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 1886 | pack.compression:: |
| 1887 | An integer -1..9, indicating the compression level for objects |
| 1888 | in a pack file. -1 is the zlib default. 0 means no |
| 1889 | compression, and 1..9 are various speed/size tradeoffs, 9 being |
| 1890 | slowest. If not set, defaults to core.compression. If that is |
| Junio C Hamano | 2e72a94 | 2007-11-21 08:54:42 | [diff] [blame] | 1891 | not set, defaults to -1, the zlib default, which is "a default |
| 1892 | compromise between speed and compression (currently equivalent |
| 1893 | to level 6)." |
| Junio C Hamano | 657fd8a | 2010-10-07 00:01:24 | [diff] [blame] | 1894 | + |
| 1895 | Note that changing the compression level will not automatically recompress |
| 1896 | all existing objects. You can force recompression by passing the -F option |
| 1897 | to linkgit:git-repack[1]. |
| Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 1898 | |
| Junio C Hamano | 679d22d | 2007-06-02 21:13:44 | [diff] [blame] | 1899 | pack.deltaCacheSize:: |
| Junio C Hamano | a638742 | 2007-08-25 03:54:27 | [diff] [blame] | 1900 | The maximum memory in bytes used for caching deltas in |
| Junio C Hamano | 9f88386 | 2009-08-11 06:23:52 | [diff] [blame] | 1901 | linkgit:git-pack-objects[1] before writing them out to a pack. |
| 1902 | This cache is used to speed up the writing object phase by not |
| 1903 | having to recompute the final delta result once the best match |
| 1904 | for all objects is found. Repacking large repositories on machines |
| 1905 | which are tight with memory might be badly impacted by this though, |
| 1906 | especially if this cache pushes the system into swapping. |
| 1907 | A value of 0 means no limit. The smallest size of 1 byte may be |
| 1908 | used to virtually disable this cache. Defaults to 256 MiB. |
| Junio C Hamano | 679d22d | 2007-06-02 21:13:44 | [diff] [blame] | 1909 | |
| 1910 | pack.deltaCacheLimit:: |
| Junio C Hamano | 58155b4 | 2007-09-15 07:46:14 | [diff] [blame] | 1911 | The maximum size of a delta, that is cached in |
| Junio C Hamano | 9f88386 | 2009-08-11 06:23:52 | [diff] [blame] | 1912 | linkgit:git-pack-objects[1]. This cache is used to speed up the |
| 1913 | writing object phase by not having to recompute the final delta |
| 1914 | result once the best match for all objects is found. Defaults to 1000. |
| Junio C Hamano | 679d22d | 2007-06-02 21:13:44 | [diff] [blame] | 1915 | |
| Junio C Hamano | 58155b4 | 2007-09-15 07:46:14 | [diff] [blame] | 1916 | pack.threads:: |
| 1917 | Specifies the number of threads to spawn when searching for best |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1918 | delta matches. This requires that linkgit:git-pack-objects[1] |
| Junio C Hamano | 58155b4 | 2007-09-15 07:46:14 | [diff] [blame] | 1919 | be compiled with pthreads otherwise this option is ignored with a |
| 1920 | warning. This is meant to reduce packing time on multiprocessor |
| 1921 | machines. The required amount of memory for the delta search window |
| 1922 | is however multiplied by the number of threads. |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 1923 | Specifying 0 will cause Git to auto-detect the number of CPU's |
| Junio C Hamano | 24bc09a | 2008-02-28 00:27:44 | [diff] [blame] | 1924 | and set the number of threads accordingly. |
| Junio C Hamano | 58155b4 | 2007-09-15 07:46:14 | [diff] [blame] | 1925 | |
| Junio C Hamano | d814b6d | 2007-11-04 11:13:49 | [diff] [blame] | 1926 | pack.indexVersion:: |
| 1927 | Specify the default pack index version. Valid values are 1 for |
| 1928 | legacy pack index used by Git versions prior to 1.5.2, and 2 for |
| 1929 | the new pack index with capabilities for packs larger than 4 GB |
| 1930 | as well as proper protection against the repacking of corrupted |
| Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame] | 1931 | packs. Version 2 is the default. Note that version 2 is enforced |
| 1932 | and this config option ignored whenever the corresponding pack is |
| 1933 | larger than 2 GB. |
| 1934 | + |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 1935 | If you have an old Git that does not understand the version 2 `*.idx` file, |
| Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame] | 1936 | cloning or fetching over a non native protocol (e.g. "http" and "rsync") |
| Junio C Hamano | b76a686 | 2012-05-02 22:02:46 | [diff] [blame] | 1937 | that will copy both `*.pack` file and corresponding `*.idx` file from the |
| Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame] | 1938 | other side may give you a repository that cannot be accessed with your |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 1939 | older version of Git. If the `*.pack` file is smaller than 2 GB, however, |
| Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame] | 1940 | you can use linkgit:git-index-pack[1] on the *.pack file to regenerate |
| Junio C Hamano | b76a686 | 2012-05-02 22:02:46 | [diff] [blame] | 1941 | the `*.idx` file. |
| Junio C Hamano | d814b6d | 2007-11-04 11:13:49 | [diff] [blame] | 1942 | |
| Junio C Hamano | 09a926d | 2008-03-13 07:55:29 | [diff] [blame] | 1943 | pack.packSizeLimit:: |
| Junio C Hamano | 4d97958 | 2010-02-04 06:27:29 | [diff] [blame] | 1944 | The maximum size of a pack. This setting only affects |
| 1945 | packing to a file when repacking, i.e. the git:// protocol |
| Junio C Hamano | b76a686 | 2012-05-02 22:02:46 | [diff] [blame] | 1946 | is unaffected. It can be overridden by the `--max-pack-size` |
| Junio C Hamano | 4d97958 | 2010-02-04 06:27:29 | [diff] [blame] | 1947 | option of linkgit:git-repack[1]. The minimum size allowed is |
| 1948 | limited to 1 MiB. The default is unlimited. |
| 1949 | Common unit suffixes of 'k', 'm', or 'g' are |
| 1950 | supported. |
| Junio C Hamano | 49dccaf | 2008-02-10 10:48:01 | [diff] [blame] | 1951 | |
| Junio C Hamano | 5b3533d | 2014-02-27 23:07:15 | [diff] [blame] | 1952 | pack.useBitmaps:: |
| 1953 | When true, git will use pack bitmaps (if available) when packing |
| 1954 | to stdout (e.g., during the server side of a fetch). Defaults to |
| 1955 | true. You should not generally need to turn this off unless |
| 1956 | you are debugging pack bitmaps. |
| 1957 | |
| 1958 | pack.writebitmaps:: |
| Junio C Hamano | 38d0253 | 2014-06-26 21:48:50 | [diff] [blame] | 1959 | This is a deprecated synonym for `repack.writeBitmaps`. |
| Junio C Hamano | 5b3533d | 2014-02-27 23:07:15 | [diff] [blame] | 1960 | |
| 1961 | pack.writeBitmapHashCache:: |
| 1962 | When true, git will include a "hash cache" section in the bitmap |
| 1963 | index (if one is written). This cache can be used to feed git's |
| 1964 | delta heuristics, potentially leading to better deltas between |
| 1965 | bitmapped and non-bitmapped objects (e.g., when serving a fetch |
| 1966 | between an older, bitmapped pack and objects that have been |
| 1967 | pushed since the last gc). The downside is that it consumes 4 |
| 1968 | bytes per object of disk space, and that JGit's bitmap |
| 1969 | implementation does not understand it, causing it to complain if |
| 1970 | Git and JGit are used on the same repository. Defaults to false. |
| 1971 | |
| Junio C Hamano | 9e96a1a | 2008-08-16 10:23:18 | [diff] [blame] | 1972 | pager.<cmd>:: |
| Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1973 | If the value is boolean, turns on or off pagination of the |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 1974 | output of a particular Git subcommand when writing to a tty. |
| Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1975 | Otherwise, turns on pagination for the subcommand using the |
| Junio C Hamano | b76a686 | 2012-05-02 22:02:46 | [diff] [blame] | 1976 | pager specified by the value of `pager.<cmd>`. If `--paginate` |
| 1977 | or `--no-pager` is specified on the command line, it takes |
| Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1978 | precedence over this option. To disable pagination for all |
| 1979 | commands, set `core.pager` or `GIT_PAGER` to `cat`. |
| Junio C Hamano | 9e96a1a | 2008-08-16 10:23:18 | [diff] [blame] | 1980 | |
| Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1981 | pretty.<name>:: |
| 1982 | Alias for a --pretty= format string, as specified in |
| 1983 | linkgit:git-log[1]. Any aliases defined here can be used just |
| 1984 | as the built-in pretty formats could. For example, |
| Junio C Hamano | b76a686 | 2012-05-02 22:02:46 | [diff] [blame] | 1985 | running `git config pretty.changelog "format:* %H %s"` |
| Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1986 | would cause the invocation `git log --pretty=changelog` |
| Junio C Hamano | b76a686 | 2012-05-02 22:02:46 | [diff] [blame] | 1987 | to be equivalent to running `git log "--pretty=format:* %H %s"`. |
| Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1988 | Note that an alias with the same name as a built-in format |
| 1989 | will be silently ignored. |
| 1990 | |
| Junio C Hamano | 5b3533d | 2014-02-27 23:07:15 | [diff] [blame] | 1991 | pull.ff:: |
| 1992 | By default, Git does not create an extra merge commit when merging |
| 1993 | a commit that is a descendant of the current commit. Instead, the |
| 1994 | tip of the current branch is fast-forwarded. When set to `false`, |
| 1995 | this variable tells Git to create an extra merge commit in such |
| 1996 | a case (equivalent to giving the `--no-ff` option from the command |
| 1997 | line). When set to `only`, only such fast-forward merges are |
| 1998 | allowed (equivalent to giving the `--ff-only` option from the |
| 1999 | command line). |
| 2000 | |
| Junio C Hamano | 515ab1d | 2011-12-09 23:41:20 | [diff] [blame] | 2001 | pull.rebase:: |
| 2002 | When true, rebase branches on top of the fetched branch, instead |
| 2003 | of merging the default branch from the default remote when "git |
| 2004 | pull" is run. See "branch.<name>.rebase" for setting this on a |
| 2005 | per-branch basis. |
| 2006 | + |
| Junio C Hamano | cf4a174 | 2013-09-11 22:57:50 | [diff] [blame] | 2007 | When preserve, also pass `--preserve-merges` along to 'git rebase' |
| 2008 | so that locally committed merge commits will not be flattened |
| 2009 | by running 'git pull'. |
| 2010 | + |
| Junio C Hamano | 515ab1d | 2011-12-09 23:41:20 | [diff] [blame] | 2011 | *NOTE*: this is a possibly dangerous operation; do *not* use |
| 2012 | it unless you understand the implications (see linkgit:git-rebase[1] |
| 2013 | for details). |
| 2014 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 2015 | pull.octopus:: |
| 2016 | The default merge strategy to use when pulling multiple branches |
| 2017 | at once. |
| 2018 | |
| 2019 | pull.twohead:: |
| 2020 | The default merge strategy to use when pulling a single branch. |
| 2021 | |
| Junio C Hamano | 1de7572 | 2009-03-26 08:39:38 | [diff] [blame] | 2022 | push.default:: |
| Junio C Hamano | 5865559 | 2013-07-11 20:52:33 | [diff] [blame] | 2023 | Defines the action `git push` should take if no refspec is |
| 2024 | explicitly given. Different values are well-suited for |
| 2025 | specific workflows; for instance, in a purely central workflow |
| 2026 | (i.e. the fetch source is equal to the push destination), |
| 2027 | `upstream` is probably what you want. Possible values are: |
| Junio C Hamano | 1de7572 | 2009-03-26 08:39:38 | [diff] [blame] | 2028 | + |
| Junio C Hamano | bcaa8bc | 2012-07-03 22:17:20 | [diff] [blame] | 2029 | -- |
| Junio C Hamano | 5865559 | 2013-07-11 20:52:33 | [diff] [blame] | 2030 | |
| 2031 | * `nothing` - do not push anything (error out) unless a refspec is |
| 2032 | explicitly given. This is primarily meant for people who want to |
| 2033 | avoid mistakes by always being explicit. |
| 2034 | |
| 2035 | * `current` - push the current branch to update a branch with the same |
| 2036 | name on the receiving end. Works in both central and non-central |
| 2037 | workflows. |
| 2038 | |
| 2039 | * `upstream` - push the current branch back to the branch whose |
| 2040 | changes are usually integrated into the current branch (which is |
| 2041 | called `@{upstream}`). This mode only makes sense if you are |
| 2042 | pushing to the same repository you would normally pull from |
| 2043 | (i.e. central workflow). |
| 2044 | |
| 2045 | * `simple` - in centralized workflow, work like `upstream` with an |
| 2046 | added safety to refuse to push if the upstream branch's name is |
| 2047 | different from the local one. |
| Junio C Hamano | bcaa8bc | 2012-07-03 22:17:20 | [diff] [blame] | 2048 | + |
| Junio C Hamano | 5865559 | 2013-07-11 20:52:33 | [diff] [blame] | 2049 | When pushing to a remote that is different from the remote you normally |
| 2050 | pull from, work as `current`. This is the safest option and is suited |
| 2051 | for beginners. |
| 2052 | + |
| Junio C Hamano | 1d669b8 | 2014-03-11 21:36:00 | [diff] [blame] | 2053 | This mode has become the default in Git 2.0. |
| Junio C Hamano | 5865559 | 2013-07-11 20:52:33 | [diff] [blame] | 2054 | |
| 2055 | * `matching` - push all branches having the same name on both ends. |
| 2056 | This makes the repository you are pushing to remember the set of |
| 2057 | branches that will be pushed out (e.g. if you always push 'maint' |
| 2058 | and 'master' there and no other branches, the repository you push |
| 2059 | to will have these two branches, and your local 'maint' and |
| 2060 | 'master' will be pushed there). |
| 2061 | + |
| 2062 | To use this mode effectively, you have to make sure _all_ the |
| 2063 | branches you would push out are ready to be pushed out before |
| 2064 | running 'git push', as the whole point of this mode is to allow you |
| 2065 | to push all of the branches in one go. If you usually finish work |
| 2066 | on only one branch and push out the result, while other branches are |
| 2067 | unfinished, this mode is not for you. Also this mode is not |
| 2068 | suitable for pushing into a shared central repository, as other |
| 2069 | people may add new branches there, or update the tip of existing |
| 2070 | branches outside your control. |
| 2071 | + |
| Junio C Hamano | 1d669b8 | 2014-03-11 21:36:00 | [diff] [blame] | 2072 | This used to be the default, but not since Git 2.0 (`simple` is the |
| 2073 | new default). |
| Junio C Hamano | 5865559 | 2013-07-11 20:52:33 | [diff] [blame] | 2074 | |
| 2075 | -- |
| Junio C Hamano | 1de7572 | 2009-03-26 08:39:38 | [diff] [blame] | 2076 | |
| Junio C Hamano | ea6a764 | 2009-03-11 23:56:19 | [diff] [blame] | 2077 | rebase.stat:: |
| 2078 | Whether to show a diffstat of what changed upstream since the last |
| 2079 | rebase. False by default. |
| 2080 | |
| Junio C Hamano | 075ae87 | 2010-09-01 18:43:07 | [diff] [blame] | 2081 | rebase.autosquash:: |
| 2082 | If set to true enable '--autosquash' option by default. |
| 2083 | |
| Junio C Hamano | f1f5a7b | 2013-06-11 22:23:52 | [diff] [blame] | 2084 | rebase.autostash:: |
| 2085 | When set to true, automatically create a temporary stash |
| 2086 | before the operation begins, and apply it after the operation |
| 2087 | ends. This means that you can run rebase on a dirty worktree. |
| 2088 | However, use with care: the final stash application after a |
| 2089 | successful rebase might result in non-trivial conflicts. |
| 2090 | Defaults to false. |
| 2091 | |
| Junio C Hamano | 621e123 | 2009-10-26 05:16:47 | [diff] [blame] | 2092 | receive.autogc:: |
| 2093 | By default, git-receive-pack will run "git-gc --auto" after |
| 2094 | receiving data from git-push and updating refs. You can stop |
| 2095 | it by setting this variable to false. |
| 2096 | |
| Junio C Hamano | 9236fea | 2014-10-14 22:28:09 | [diff] [blame] | 2097 | receive.certnonceseed:: |
| 2098 | By setting this variable to a string, `git receive-pack` |
| 2099 | will accept a `git push --signed` and verifies it by using |
| 2100 | a "nonce" protected by HMAC using this string as a secret |
| 2101 | key. |
| 2102 | |
| 2103 | receive.certnonceslop:: |
| 2104 | When a `git push --signed` sent a push certificate with a |
| 2105 | "nonce" that was issued by a receive-pack serving the same |
| 2106 | repository within this many seconds, export the "nonce" |
| 2107 | found in the certificate to `GIT_PUSH_CERT_NONCE` to the |
| 2108 | hooks (instead of what the receive-pack asked the sending |
| 2109 | side to include). This may allow writing checks in |
| 2110 | `pre-receive` and `post-receive` a bit easier. Instead of |
| 2111 | checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable |
| 2112 | that records by how many seconds the nonce is stale to |
| 2113 | decide if they want to accept the certificate, they only |
| 2114 | can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`. |
| 2115 | |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 2116 | receive.fsckObjects:: |
| 2117 | If it is set to true, git-receive-pack will check all received |
| 2118 | objects. It will abort in the case of a malformed object or a |
| 2119 | broken link. The result of an abort are only dangling objects. |
| Junio C Hamano | 8fb66e5 | 2011-10-05 20:59:51 | [diff] [blame] | 2120 | Defaults to false. If not set, the value of `transfer.fsckObjects` |
| 2121 | is used instead. |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 2122 | |
| 2123 | receive.unpackLimit:: |
| 2124 | If the number of objects received in a push is below this |
| 2125 | limit then the objects will be unpacked into loose object |
| 2126 | files. However if the number of received objects equals or |
| 2127 | exceeds this limit then the received pack will be stored as |
| 2128 | a pack, after adding any missing delta bases. Storing the |
| 2129 | pack from a push can make the push operation complete faster, |
| 2130 | especially on slow filesystems. If not set, the value of |
| 2131 | `transfer.unpackLimit` is used instead. |
| 2132 | |
| 2133 | receive.denyDeletes:: |
| 2134 | If set to true, git-receive-pack will deny a ref update that deletes |
| 2135 | the ref. Use this to prevent such a ref deletion via a push. |
| 2136 | |
| Junio C Hamano | b4448a8 | 2010-07-26 09:02:32 | [diff] [blame] | 2137 | receive.denyDeleteCurrent:: |
| 2138 | If set to true, git-receive-pack will deny a ref update that |
| 2139 | deletes the currently checked out branch of a non-bare repository. |
| 2140 | |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 2141 | receive.denyCurrentBranch:: |
| Junio C Hamano | e97d577 | 2010-05-19 08:13:58 | [diff] [blame] | 2142 | If set to true or "refuse", git-receive-pack will deny a ref update |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 2143 | to the currently checked out branch of a non-bare repository. |
| 2144 | Such a push is potentially dangerous because it brings the HEAD |
| 2145 | out of sync with the index and working tree. If set to "warn", |
| 2146 | print a warning of such a push to stderr, but allow the push to |
| 2147 | proceed. If set to false or "ignore", allow such pushes with no |
| Junio C Hamano | afb395b | 2010-03-17 22:16:15 | [diff] [blame] | 2148 | message. Defaults to "refuse". |
| Junio C Hamano | 6df93d9 | 2014-12-22 22:48:09 | [diff] [blame] | 2149 | + |
| 2150 | Another option is "updateInstead" which will update the working |
| 2151 | directory (must be clean) if pushing into the current branch. This option is |
| 2152 | intended for synchronizing working directories when one side is not easily |
| 2153 | accessible via interactive ssh (e.g. a live web site, hence the requirement |
| 2154 | that the working directory be clean). This mode also comes in handy when |
| 2155 | developing inside a VM to test and fix code on different Operating Systems. |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 2156 | |
| 2157 | receive.denyNonFastForwards:: |
| 2158 | If set to true, git-receive-pack will deny a ref update which is |
| Junio C Hamano | 3f680f3 | 2009-11-16 02:10:54 | [diff] [blame] | 2159 | not a fast-forward. Use this to prevent such an update via a push, |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 2160 | even if that push is forced. This configuration variable is |
| 2161 | set when initializing a shared repository. |
| 2162 | |
| Junio C Hamano | 80ad00d | 2013-02-18 00:19:03 | [diff] [blame] | 2163 | receive.hiderefs:: |
| 2164 | String(s) `receive-pack` uses to decide which refs to omit |
| 2165 | from its initial advertisement. Use more than one |
| 2166 | definitions to specify multiple prefix strings. A ref that |
| 2167 | are under the hierarchies listed on the value of this |
| 2168 | variable is excluded, and is hidden when responding to `git |
| 2169 | push`, and an attempt to update or delete a hidden ref by |
| 2170 | `git push` is rejected. |
| 2171 | |
| Junio C Hamano | 621e123 | 2009-10-26 05:16:47 | [diff] [blame] | 2172 | receive.updateserverinfo:: |
| 2173 | If set to true, git-receive-pack will run git-update-server-info |
| 2174 | after receiving data from git-push and updating refs. |
| 2175 | |
| Junio C Hamano | 61525f9 | 2014-01-17 22:46:49 | [diff] [blame] | 2176 | receive.shallowupdate:: |
| 2177 | If set to true, .git/shallow can be updated when new refs |
| 2178 | require new shallow roots. Otherwise those refs are rejected. |
| 2179 | |
| Junio C Hamano | 63b6fdb | 2013-04-07 23:37:13 | [diff] [blame] | 2180 | remote.pushdefault:: |
| 2181 | The remote to push to by default. Overrides |
| 2182 | `branch.<name>.remote` for all branches, and is overridden by |
| 2183 | `branch.<name>.pushremote` for specific branches. |
| 2184 | |
| Junio C Hamano | 249572f | 2006-10-24 05:44:08 | [diff] [blame] | 2185 | remote.<name>.url:: |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 2186 | The URL of a remote repository. See linkgit:git-fetch[1] or |
| 2187 | linkgit:git-push[1]. |
| Junio C Hamano | 249572f | 2006-10-24 05:44:08 | [diff] [blame] | 2188 | |
| Junio C Hamano | 0e88f3e | 2009-06-21 08:03:25 | [diff] [blame] | 2189 | remote.<name>.pushurl:: |
| 2190 | The push URL of a remote repository. See linkgit:git-push[1]. |
| 2191 | |
| Junio C Hamano | 5825687 | 2007-12-04 08:31:13 | [diff] [blame] | 2192 | remote.<name>.proxy:: |
| 2193 | For remotes that require curl (http, https and ftp), the URL to |
| 2194 | the proxy to use for that remote. Set to the empty string to |
| 2195 | disable proxying for that remote. |
| 2196 | |
| Junio C Hamano | 249572f | 2006-10-24 05:44:08 | [diff] [blame] | 2197 | remote.<name>.fetch:: |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 2198 | The default set of "refspec" for linkgit:git-fetch[1]. See |
| 2199 | linkgit:git-fetch[1]. |
| Junio C Hamano | 249572f | 2006-10-24 05:44:08 | [diff] [blame] | 2200 | |
| 2201 | remote.<name>.push:: |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 2202 | The default set of "refspec" for linkgit:git-push[1]. See |
| 2203 | linkgit:git-push[1]. |
| Junio C Hamano | 249572f | 2006-10-24 05:44:08 | [diff] [blame] | 2204 | |
| Junio C Hamano | 47d68a5 | 2008-05-06 06:35:40 | [diff] [blame] | 2205 | remote.<name>.mirror:: |
| 2206 | If true, pushing to this remote will automatically behave |
| Junio C Hamano | b76a686 | 2012-05-02 22:02:46 | [diff] [blame] | 2207 | as if the `--mirror` option was given on the command line. |
| Junio C Hamano | 47d68a5 | 2008-05-06 06:35:40 | [diff] [blame] | 2208 | |
| Junio C Hamano | 118d277 | 2007-02-21 20:24:10 | [diff] [blame] | 2209 | remote.<name>.skipDefaultUpdate:: |
| 2210 | If true, this remote will be skipped by default when updating |
| Junio C Hamano | 9df0c66 | 2009-11-23 11:09:27 | [diff] [blame] | 2211 | using linkgit:git-fetch[1] or the `update` subcommand of |
| 2212 | linkgit:git-remote[1]. |
| 2213 | |
| 2214 | remote.<name>.skipFetchAll:: |
| 2215 | If true, this remote will be skipped by default when updating |
| 2216 | using linkgit:git-fetch[1] or the `update` subcommand of |
| 2217 | linkgit:git-remote[1]. |
| Junio C Hamano | 118d277 | 2007-02-21 20:24:10 | [diff] [blame] | 2218 | |
| Junio C Hamano | 4ad294b | 2007-01-20 02:22:50 | [diff] [blame] | 2219 | remote.<name>.receivepack:: |
| Junio C Hamano | 54ea8d3 | 2007-01-25 07:59:48 | [diff] [blame] | 2220 | The default program to execute on the remote side when pushing. See |
| Junio C Hamano | 86bcccc | 2008-03-08 09:33:55 | [diff] [blame] | 2221 | option \--receive-pack of linkgit:git-push[1]. |
| Junio C Hamano | 4ad294b | 2007-01-20 02:22:50 | [diff] [blame] | 2222 | |
| Junio C Hamano | 54ea8d3 | 2007-01-25 07:59:48 | [diff] [blame] | 2223 | remote.<name>.uploadpack:: |
| 2224 | The default program to execute on the remote side when fetching. See |
| Junio C Hamano | 86bcccc | 2008-03-08 09:33:55 | [diff] [blame] | 2225 | option \--upload-pack of linkgit:git-fetch-pack[1]. |
| Junio C Hamano | 54ea8d3 | 2007-01-25 07:59:48 | [diff] [blame] | 2226 | |
| Junio C Hamano | 17dde0e | 2007-02-26 09:50:21 | [diff] [blame] | 2227 | remote.<name>.tagopt:: |
| Junio C Hamano | 86bcccc | 2008-03-08 09:33:55 | [diff] [blame] | 2228 | Setting this value to \--no-tags disables automatic tag following when |
| Junio C Hamano | cc7636a | 2010-05-21 14:57:53 | [diff] [blame] | 2229 | fetching from remote <name>. Setting it to \--tags will fetch every |
| 2230 | tag from remote <name>, even if they are not reachable from remote |
| Junio C Hamano | 075ae87 | 2010-09-01 18:43:07 | [diff] [blame] | 2231 | branch heads. Passing these flags directly to linkgit:git-fetch[1] can |
| 2232 | override this setting. See options \--tags and \--no-tags of |
| 2233 | linkgit:git-fetch[1]. |
| Junio C Hamano | 17dde0e | 2007-02-26 09:50:21 | [diff] [blame] | 2234 | |
| Junio C Hamano | 096dde2 | 2009-12-26 23:14:11 | [diff] [blame] | 2235 | remote.<name>.vcs:: |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 2236 | Setting this to a value <vcs> will cause Git to interact with |
| Junio C Hamano | 096dde2 | 2009-12-26 23:14:11 | [diff] [blame] | 2237 | the remote with the git-remote-<vcs> helper. |
| 2238 | |
| Junio C Hamano | 8eac268 | 2013-09-09 22:35:20 | [diff] [blame] | 2239 | remote.<name>.prune:: |
| 2240 | When set to true, fetching from this remote by default will also |
| Junio C Hamano | 4c8f2d9 | 2013-12-13 00:55:42 | [diff] [blame] | 2241 | remove any remote-tracking references that no longer exist on the |
| 2242 | remote (as if the `--prune` option was given on the command line). |
| Junio C Hamano | 8eac268 | 2013-09-09 22:35:20 | [diff] [blame] | 2243 | Overrides `fetch.prune` settings, if any. |
| 2244 | |
| Junio C Hamano | 118d277 | 2007-02-21 20:24:10 | [diff] [blame] | 2245 | remotes.<group>:: |
| 2246 | The list of remotes which are fetched by "git remote update |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 2247 | <group>". See linkgit:git-remote[1]. |
| Junio C Hamano | 118d277 | 2007-02-21 20:24:10 | [diff] [blame] | 2248 | |
| Junio C Hamano | 77b7e90 | 2006-10-23 07:18:50 | [diff] [blame] | 2249 | repack.usedeltabaseoffset:: |
| Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame] | 2250 | By default, linkgit:git-repack[1] creates packs that use |
| 2251 | delta-base offset. If you need to share your repository with |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 2252 | Git older than version 1.4.4, either directly or via a dumb |
| Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame] | 2253 | protocol such as http, then you need to set this option to |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 2254 | "false" and repack. Access from old Git versions over the |
| Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame] | 2255 | native protocol are unaffected by this option. |
| Junio C Hamano | 77b7e90 | 2006-10-23 07:18:50 | [diff] [blame] | 2256 | |
| Junio C Hamano | 3b0cdc2 | 2014-03-18 22:06:16 | [diff] [blame] | 2257 | repack.packKeptObjects:: |
| 2258 | If set to true, makes `git repack` act as if |
| 2259 | `--pack-kept-objects` was passed. See linkgit:git-repack[1] for |
| 2260 | details. Defaults to `false` normally, but `true` if a bitmap |
| 2261 | index is being written (either via `--write-bitmap-index` or |
| Junio C Hamano | 38d0253 | 2014-06-26 21:48:50 | [diff] [blame] | 2262 | `repack.writeBitmaps`). |
| 2263 | |
| 2264 | repack.writeBitmaps:: |
| 2265 | When true, git will write a bitmap index when packing all |
| 2266 | objects to disk (e.g., when `git repack -a` is run). This |
| 2267 | index can speed up the "counting objects" phase of subsequent |
| 2268 | packs created for clones and fetches, at the cost of some disk |
| 2269 | space and extra time spent on the initial repack. Defaults to |
| 2270 | false. |
| Junio C Hamano | 3b0cdc2 | 2014-03-18 22:06:16 | [diff] [blame] | 2271 | |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 2272 | rerere.autoupdate:: |
| 2273 | When set to true, `git-rerere` updates the index with the |
| 2274 | resulting contents after it cleanly resolves conflicts using |
| 2275 | previously recorded resolution. Defaults to false. |
| 2276 | |
| 2277 | rerere.enabled:: |
| 2278 | Activate recording of resolved conflicts, so that identical |
| Junio C Hamano | 4fd2442 | 2012-01-06 21:52:43 | [diff] [blame] | 2279 | conflict hunks can be resolved automatically, should they be |
| 2280 | encountered again. By default, linkgit:git-rerere[1] is |
| 2281 | enabled if there is an `rr-cache` directory under the |
| Junio C Hamano | 864ba89 | 2012-01-13 17:42:05 | [diff] [blame] | 2282 | `$GIT_DIR`, e.g. if "rerere" was previously used in the |
| 2283 | repository. |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 2284 | |
| Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 2285 | sendemail.identity:: |
| 2286 | A configuration identity. When given, causes values in the |
| 2287 | 'sendemail.<identity>' subsection to take precedence over |
| 2288 | values in the 'sendemail' section. The default identity is |
| 2289 | the value of 'sendemail.identity'. |
| 2290 | |
| 2291 | sendemail.smtpencryption:: |
| 2292 | See linkgit:git-send-email[1] for description. Note that this |
| 2293 | setting is not subject to the 'identity' mechanism. |
| 2294 | |
| 2295 | sendemail.smtpssl:: |
| 2296 | Deprecated alias for 'sendemail.smtpencryption = ssl'. |
| 2297 | |
| Junio C Hamano | 58f587a | 2013-07-22 19:20:59 | [diff] [blame] | 2298 | sendemail.smtpsslcertpath:: |
| 2299 | Path to ca-certificates (either a directory or a single file). |
| 2300 | Set it to an empty string to disable certificate verification. |
| 2301 | |
| Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 2302 | sendemail.<identity>.*:: |
| 2303 | Identity-specific versions of the 'sendemail.*' parameters |
| 2304 | found below, taking precedence over those when the this |
| 2305 | identity is selected, through command-line or |
| 2306 | 'sendemail.identity'. |
| 2307 | |
| 2308 | sendemail.aliasesfile:: |
| 2309 | sendemail.aliasfiletype:: |
| Junio C Hamano | ea3b752 | 2013-04-18 19:37:53 | [diff] [blame] | 2310 | sendemail.annotate:: |
| Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 2311 | sendemail.bcc:: |
| 2312 | sendemail.cc:: |
| 2313 | sendemail.cccmd:: |
| 2314 | sendemail.chainreplyto:: |
| 2315 | sendemail.confirm:: |
| 2316 | sendemail.envelopesender:: |
| 2317 | sendemail.from:: |
| 2318 | sendemail.multiedit:: |
| 2319 | sendemail.signedoffbycc:: |
| 2320 | sendemail.smtppass:: |
| 2321 | sendemail.suppresscc:: |
| 2322 | sendemail.suppressfrom:: |
| 2323 | sendemail.to:: |
| Junio C Hamano | cb39aea | 2010-05-09 07:24:48 | [diff] [blame] | 2324 | sendemail.smtpdomain:: |
| Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 2325 | sendemail.smtpserver:: |
| 2326 | sendemail.smtpserverport:: |
| Junio C Hamano | 39c7a69 | 2010-10-27 06:08:54 | [diff] [blame] | 2327 | sendemail.smtpserveroption:: |
| Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 2328 | sendemail.smtpuser:: |
| 2329 | sendemail.thread:: |
| Junio C Hamano | 6df93d9 | 2014-12-22 22:48:09 | [diff] [blame] | 2330 | sendemail.transferencoding:: |
| Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 2331 | sendemail.validate:: |
| Junio C Hamano | c9394b2 | 2015-01-07 22:45:48 | [diff] [blame^] | 2332 | sendemail.xmailer:: |
| Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 2333 | See linkgit:git-send-email[1] for description. |
| 2334 | |
| 2335 | sendemail.signedoffcc:: |
| 2336 | Deprecated alias for 'sendemail.signedoffbycc'. |
| 2337 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 2338 | showbranch.default:: |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 2339 | The default set of branches for linkgit:git-show-branch[1]. |
| 2340 | See linkgit:git-show-branch[1]. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 2341 | |
| Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 2342 | status.relativePaths:: |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 2343 | By default, linkgit:git-status[1] shows paths relative to the |
| Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 2344 | current directory. Setting this variable to `false` shows paths |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 2345 | relative to the repository root (this was the default for Git |
| Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 2346 | prior to v1.5.4). |
| 2347 | |
| Junio C Hamano | 5865559 | 2013-07-11 20:52:33 | [diff] [blame] | 2348 | status.short:: |
| 2349 | Set to true to enable --short by default in linkgit:git-status[1]. |
| 2350 | The option --no-short takes precedence over this variable. |
| 2351 | |
| 2352 | status.branch:: |
| 2353 | Set to true to enable --branch by default in linkgit:git-status[1]. |
| 2354 | The option --no-branch takes precedence over this variable. |
| 2355 | |
| Junio C Hamano | 79f4c7c | 2013-09-20 21:03:37 | [diff] [blame] | 2356 | status.displayCommentPrefix:: |
| 2357 | If set to true, linkgit:git-status[1] will insert a comment |
| 2358 | prefix before each output line (starting with |
| 2359 | `core.commentChar`, i.e. `#` by default). This was the |
| 2360 | behavior of linkgit:git-status[1] in Git 1.8.4 and previous. |
| 2361 | Defaults to false. |
| 2362 | |
| Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 2363 | status.showUntrackedFiles:: |
| 2364 | By default, linkgit:git-status[1] and linkgit:git-commit[1] show |
| 2365 | files which are not currently tracked by Git. Directories which |
| 2366 | contain only untracked files, are shown with the directory name |
| 2367 | only. Showing untracked files means that Git needs to lstat() all |
| Junio C Hamano | 2efd5e4 | 2014-11-10 22:38:52 | [diff] [blame] | 2368 | the files in the whole repository, which might be slow on some |
| Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 2369 | systems. So, this variable controls how the commands displays |
| 2370 | the untracked files. Possible values are: |
| 2371 | + |
| 2372 | -- |
| Junio C Hamano | 7f9fa86 | 2010-10-19 23:51:14 | [diff] [blame] | 2373 | * `no` - Show no untracked files. |
| 2374 | * `normal` - Show untracked files and directories. |
| 2375 | * `all` - Show also individual files in untracked directories. |
| Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 2376 | -- |
| 2377 | + |
| 2378 | If this variable is not specified, it defaults to 'normal'. |
| 2379 | This variable can be overridden with the -u|--untracked-files option |
| 2380 | of linkgit:git-status[1] and linkgit:git-commit[1]. |
| 2381 | |
| Junio C Hamano | b671fb5 | 2010-06-01 05:06:14 | [diff] [blame] | 2382 | status.submodulesummary:: |
| 2383 | Defaults to false. |
| 2384 | If this is set to a non zero number or true (identical to -1 or an |
| 2385 | unlimited number), the submodule summary will be enabled and a |
| 2386 | summary of commits for modified submodules will be shown (see |
| Junio C Hamano | 369e340 | 2013-10-15 18:40:25 | [diff] [blame] | 2387 | --summary-limit option of linkgit:git-submodule[1]). Please note |
| 2388 | that the summary output command will be suppressed for all |
| 2389 | submodules when `diff.ignoreSubmodules` is set to 'all' or only |
| Junio C Hamano | c8c398a | 2014-06-16 21:14:05 | [diff] [blame] | 2390 | for those submodules where `submodule.<name>.ignore=all`. The only |
| 2391 | exception to that rule is that status and commit will show staged |
| 2392 | submodule changes. To |
| Junio C Hamano | 369e340 | 2013-10-15 18:40:25 | [diff] [blame] | 2393 | also view the summary for ignored submodules you can either use |
| Junio C Hamano | e1aeb5e | 2014-06-06 19:16:29 | [diff] [blame] | 2394 | the --ignore-submodules=dirty command-line option or the 'git |
| Junio C Hamano | 369e340 | 2013-10-15 18:40:25 | [diff] [blame] | 2395 | submodule summary' command, which shows a similar output but does |
| 2396 | not honor these settings. |
| Junio C Hamano | b671fb5 | 2010-06-01 05:06:14 | [diff] [blame] | 2397 | |
| Junio C Hamano | 78e3a78 | 2010-07-15 22:24:45 | [diff] [blame] | 2398 | submodule.<name>.path:: |
| 2399 | submodule.<name>.url:: |
| 2400 | submodule.<name>.update:: |
| 2401 | The path within this project, URL, and the updating strategy |
| 2402 | for a submodule. These variables are initially populated |
| 2403 | by 'git submodule init'; edit them to override the |
| 2404 | URL and other values found in the `.gitmodules` file. See |
| 2405 | linkgit:git-submodule[1] and linkgit:gitmodules[5] for details. |
| 2406 | |
| Junio C Hamano | abad6da | 2013-01-06 09:06:32 | [diff] [blame] | 2407 | submodule.<name>.branch:: |
| 2408 | The remote branch name for a submodule, used by `git submodule |
| 2409 | update --remote`. Set this option to override the value found in |
| 2410 | the `.gitmodules` file. See linkgit:git-submodule[1] and |
| 2411 | linkgit:gitmodules[5] for details. |
| 2412 | |
| Junio C Hamano | 0d75e87 | 2010-12-17 06:57:26 | [diff] [blame] | 2413 | submodule.<name>.fetchRecurseSubmodules:: |
| Junio C Hamano | 5cd1518 | 2011-04-05 00:21:10 | [diff] [blame] | 2414 | This option can be used to control recursive fetching of this |
| Junio C Hamano | 7165bf7 | 2011-01-04 22:06:18 | [diff] [blame] | 2415 | submodule. It can be overridden by using the --[no-]recurse-submodules |
| Junio C Hamano | e1aeb5e | 2014-06-06 19:16:29 | [diff] [blame] | 2416 | command-line option to "git fetch" and "git pull". |
| Junio C Hamano | 0d75e87 | 2010-12-17 06:57:26 | [diff] [blame] | 2417 | This setting will override that from in the linkgit:gitmodules[5] |
| 2418 | file. |
| 2419 | |
| Junio C Hamano | 619596a | 2010-08-18 22:15:35 | [diff] [blame] | 2420 | submodule.<name>.ignore:: |
| 2421 | Defines under what circumstances "git status" and the diff family show |
| 2422 | a submodule as modified. When set to "all", it will never be considered |
| Junio C Hamano | c8c398a | 2014-06-16 21:14:05 | [diff] [blame] | 2423 | modified (but it will nonetheless show up in the output of status and |
| 2424 | commit when it has been staged), "dirty" will ignore all changes |
| 2425 | to the submodules work tree and |
| Junio C Hamano | 619596a | 2010-08-18 22:15:35 | [diff] [blame] | 2426 | takes only differences between the HEAD of the submodule and the commit |
| 2427 | recorded in the superproject into account. "untracked" will additionally |
| 2428 | let submodules with modified tracked files in their work tree show up. |
| 2429 | Using "none" (the default when this option is not set) also shows |
| 2430 | submodules that have untracked files in their work tree as changed. |
| 2431 | This setting overrides any setting made in .gitmodules for this submodule, |
| Junio C Hamano | de9745c | 2010-08-23 17:10:18 | [diff] [blame] | 2432 | both settings can be overridden on the command line by using the |
| Junio C Hamano | 369e340 | 2013-10-15 18:40:25 | [diff] [blame] | 2433 | "--ignore-submodules" option. The 'git submodule' commands are not |
| 2434 | affected by this setting. |
| Junio C Hamano | 619596a | 2010-08-18 22:15:35 | [diff] [blame] | 2435 | |
| Junio C Hamano | 7b43d41 | 2014-07-23 23:09:44 | [diff] [blame] | 2436 | tag.sort:: |
| 2437 | This variable controls the sort ordering of tags when displayed by |
| 2438 | linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the |
| 2439 | value of this variable will be used as the default. |
| 2440 | |
| Junio C Hamano | 75cc4c9 | 2006-07-24 08:25:03 | [diff] [blame] | 2441 | tar.umask:: |
| Junio C Hamano | bdebabb | 2007-08-23 00:25:09 | [diff] [blame] | 2442 | This variable can be used to restrict the permission bits of |
| 2443 | tar archive entries. The default is 0002, which turns off the |
| 2444 | world write bit. The special value "user" indicates that the |
| 2445 | archiving user's umask will be used instead. See umask(2) and |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 2446 | linkgit:git-archive[1]. |
| Junio C Hamano | 75cc4c9 | 2006-07-24 08:25:03 | [diff] [blame] | 2447 | |
| Junio C Hamano | 8fb66e5 | 2011-10-05 20:59:51 | [diff] [blame] | 2448 | transfer.fsckObjects:: |
| 2449 | When `fetch.fsckObjects` or `receive.fsckObjects` are |
| 2450 | not set, the value of this variable is used instead. |
| 2451 | Defaults to false. |
| 2452 | |
| Junio C Hamano | 80ad00d | 2013-02-18 00:19:03 | [diff] [blame] | 2453 | transfer.hiderefs:: |
| 2454 | This variable can be used to set both `receive.hiderefs` |
| 2455 | and `uploadpack.hiderefs` at the same time to the same |
| 2456 | values. See entries for these other variables. |
| 2457 | |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 2458 | transfer.unpackLimit:: |
| 2459 | When `fetch.unpackLimit` or `receive.unpackLimit` are |
| 2460 | not set, the value of this variable is used instead. |
| 2461 | The default value is 100. |
| 2462 | |
| Junio C Hamano | 81703b2 | 2014-03-14 22:00:27 | [diff] [blame] | 2463 | uploadarchive.allowUnreachable:: |
| 2464 | If true, allow clients to use `git archive --remote` to request |
| 2465 | any tree, whether reachable from the ref tips or not. See the |
| 2466 | discussion in the `SECURITY` section of |
| 2467 | linkgit:git-upload-archive[1] for more details. Defaults to |
| 2468 | `false`. |
| 2469 | |
| Junio C Hamano | 80ad00d | 2013-02-18 00:19:03 | [diff] [blame] | 2470 | uploadpack.hiderefs:: |
| 2471 | String(s) `upload-pack` uses to decide which refs to omit |
| 2472 | from its initial advertisement. Use more than one |
| 2473 | definitions to specify multiple prefix strings. A ref that |
| 2474 | are under the hierarchies listed on the value of this |
| 2475 | variable is excluded, and is hidden from `git ls-remote`, |
| 2476 | `git fetch`, etc. An attempt to fetch a hidden ref by `git |
| Junio C Hamano | 5e7f131 | 2013-03-21 22:49:01 | [diff] [blame] | 2477 | fetch` will fail. See also `uploadpack.allowtipsha1inwant`. |
| 2478 | |
| 2479 | uploadpack.allowtipsha1inwant:: |
| 2480 | When `uploadpack.hiderefs` is in effect, allow `upload-pack` |
| 2481 | to accept a fetch request that asks for an object at the tip |
| 2482 | of a hidden ref (by default, such a request is rejected). |
| 2483 | see also `uploadpack.hiderefs`. |
| Junio C Hamano | 80ad00d | 2013-02-18 00:19:03 | [diff] [blame] | 2484 | |
| Junio C Hamano | 79f4c7c | 2013-09-20 21:03:37 | [diff] [blame] | 2485 | uploadpack.keepalive:: |
| 2486 | When `upload-pack` has started `pack-objects`, there may be a |
| 2487 | quiet period while `pack-objects` prepares the pack. Normally |
| 2488 | it would output progress information, but if `--quiet` was used |
| 2489 | for the fetch, `pack-objects` will output nothing at all until |
| 2490 | the pack data begins. Some clients and networks may consider |
| 2491 | the server to be hung and give up. Setting this option instructs |
| 2492 | `upload-pack` to send an empty keepalive packet every |
| 2493 | `uploadpack.keepalive` seconds. Setting this option to 0 |
| 2494 | disables keepalive packets entirely. The default is 5 seconds. |
| 2495 | |
| Junio C Hamano | 24bc09a | 2008-02-28 00:27:44 | [diff] [blame] | 2496 | url.<base>.insteadOf:: |
| 2497 | Any URL that starts with this value will be rewritten to |
| 2498 | start, instead, with <base>. In cases where some site serves a |
| 2499 | large number of repositories, and serves them with multiple |
| 2500 | access methods, and some users need to use different access |
| 2501 | methods, this feature allows people to specify any of the |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 2502 | equivalent URLs and have Git automatically rewrite the URL to |
| Junio C Hamano | 24bc09a | 2008-02-28 00:27:44 | [diff] [blame] | 2503 | the best alternative for the particular user, even for a |
| 2504 | never-before-seen repository on the site. When more than one |
| 2505 | insteadOf strings match a given URL, the longest match is used. |
| 2506 | |
| Junio C Hamano | 7df6dcf | 2009-09-13 09:51:17 | [diff] [blame] | 2507 | url.<base>.pushInsteadOf:: |
| 2508 | Any URL that starts with this value will not be pushed to; |
| 2509 | instead, it will be rewritten to start with <base>, and the |
| 2510 | resulting URL will be pushed to. In cases where some site serves |
| 2511 | a large number of repositories, and serves them with multiple |
| 2512 | access methods, some of which do not allow push, this feature |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 2513 | allows people to specify a pull-only URL and have Git |
| Junio C Hamano | 7df6dcf | 2009-09-13 09:51:17 | [diff] [blame] | 2514 | automatically use an appropriate URL to push, even for a |
| 2515 | never-before-seen repository on the site. When more than one |
| 2516 | pushInsteadOf strings match a given URL, the longest match is |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 2517 | used. If a remote has an explicit pushurl, Git will ignore this |
| Junio C Hamano | 7df6dcf | 2009-09-13 09:51:17 | [diff] [blame] | 2518 | setting for that remote. |
| 2519 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 2520 | user.email:: |
| 2521 | Your email address to be recorded in any newly created commits. |
| Junio C Hamano | 469d60e | 2007-04-29 18:30:34 | [diff] [blame] | 2522 | Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 2523 | 'EMAIL' environment variables. See linkgit:git-commit-tree[1]. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 2524 | |
| 2525 | user.name:: |
| 2526 | Your full name to be recorded in any newly created commits. |
| Junio C Hamano | 341071d | 2006-06-04 07:24:48 | [diff] [blame] | 2527 | Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME' |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 2528 | environment variables. See linkgit:git-commit-tree[1]. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 2529 | |
| Junio C Hamano | a890c4f | 2007-01-28 10:29:21 | [diff] [blame] | 2530 | user.signingkey:: |
| Junio C Hamano | 369e340 | 2013-10-15 18:40:25 | [diff] [blame] | 2531 | If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the |
| 2532 | key you want it to automatically when creating a signed tag or |
| 2533 | commit, you can override the default selection with this variable. |
| 2534 | This option is passed unchanged to gpg's --local-user parameter, |
| 2535 | so you may specify a key using any method that gpg supports. |
| Junio C Hamano | a890c4f | 2007-01-28 10:29:21 | [diff] [blame] | 2536 | |
| Junio C Hamano | 4e27231 | 2008-01-08 09:13:21 | [diff] [blame] | 2537 | web.browser:: |
| 2538 | Specify a web browser that may be used by some commands. |
| 2539 | Currently only linkgit:git-instaweb[1] and linkgit:git-help[1] |
| 2540 | may use it. |