| 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 |
| Junio C Hamano | 0762262 | 2015-03-20 21:47:26 | [diff] [blame] | 17 | variables may appear multiple times; we say then that the variable is |
| 18 | multivalued. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 19 | |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 20 | Syntax |
| 21 | ~~~~~~ |
| 22 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 23 | The syntax is fairly flexible and permissive; whitespaces are mostly |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 24 | ignored. The '#' and ';' characters begin comments to the end of line, |
| 25 | blank lines are ignored. |
| 26 | |
| 27 | The file consists of sections and variables. A section begins with |
| 28 | the name of the section in square brackets and continues until the next |
| Junio C Hamano | 0762262 | 2015-03-20 21:47:26 | [diff] [blame] | 29 | section begins. Section names are case-insensitive. Only alphanumeric |
| Junio C Hamano | ea82cff | 2009-03-18 01:54:48 | [diff] [blame] | 30 | characters, `-` and `.` are allowed in section names. Each variable |
| Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 31 | must belong to some section, which means that there must be a section |
| 32 | header before the first setting of a variable. |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 33 | |
| 34 | Sections can be further divided into subsections. To begin a subsection |
| 35 | 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] | 36 | in the section header, like in the example below: |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 37 | |
| 38 | -------- |
| 39 | [section "subsection"] |
| 40 | |
| 41 | -------- |
| 42 | |
| Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 43 | Subsection names are case sensitive and can contain any characters except |
| Junio C Hamano | 0762262 | 2015-03-20 21:47:26 | [diff] [blame] | 44 | newline (doublequote `"` and backslash can be included by escaping them |
| 45 | as `\"` and `\\`, respectively). Section headers cannot span multiple |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 46 | lines. Variables may belong directly to a section or to a given subsection. |
| 47 | You can have `[section]` if you have `[section "subsection"]`, but you |
| 48 | don't need to. |
| 49 | |
| Junio C Hamano | 6231f82 | 2011-10-24 05:18:52 | [diff] [blame] | 50 | There is also a deprecated `[section.subsection]` syntax. With this |
| 51 | syntax, the subsection name is converted to lower-case and is also |
| 52 | compared case sensitively. These subsection names follow the same |
| 53 | restrictions as section names. |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 54 | |
| Junio C Hamano | aa2cd76 | 2009-07-26 08:14:01 | [diff] [blame] | 55 | All the other lines (and the remainder of the line after the section |
| 56 | header) are recognized as setting variables, in the form |
| Junio C Hamano | 0762262 | 2015-03-20 21:47:26 | [diff] [blame] | 57 | 'name = value' (or just 'name', which is a short-hand to say that |
| 58 | the variable is the boolean "true"). |
| Junio C Hamano | 81d540a | 2012-03-02 19:52:47 | [diff] [blame] | 59 | The variable names are case-insensitive, allow only alphanumeric characters |
| Junio C Hamano | 0762262 | 2015-03-20 21:47:26 | [diff] [blame] | 60 | and `-`, and must start with an alphabetic character. |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 61 | |
| Junio C Hamano | 0762262 | 2015-03-20 21:47:26 | [diff] [blame] | 62 | A line that defines a value can be continued to the next line by |
| 63 | ending it with a `\`; the backquote and the end-of-line are |
| 64 | stripped. Leading whitespaces after 'name =', the remainder of the |
| 65 | line after the first comment character '#' or ';', and trailing |
| 66 | whitespaces of the line are discarded unless they are enclosed in |
| 67 | double quotes. Internal whitespaces within the value are retained |
| 68 | verbatim. |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 69 | |
| Junio C Hamano | 0762262 | 2015-03-20 21:47:26 | [diff] [blame] | 70 | Inside double quotes, double quote `"` and backslash `\` characters |
| 71 | must be escaped: use `\"` for `"` and `\\` for `\`. |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 72 | |
| Junio C Hamano | ea82cff | 2009-03-18 01:54:48 | [diff] [blame] | 73 | The following escape sequences (beside `\"` and `\\`) are recognized: |
| 74 | `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) |
| Junio C Hamano | d75148a | 2014-04-08 19:48:38 | [diff] [blame] | 75 | and `\b` for backspace (BS). Other char escape sequences (including octal |
| 76 | escape sequences) are invalid. |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 77 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 78 | |
| Junio C Hamano | e0238c2 | 2012-02-23 22:45:50 | [diff] [blame] | 79 | Includes |
| 80 | ~~~~~~~~ |
| 81 | |
| Junio C Hamano | 6b6144f | 2017-05-29 06:20:15 | [diff] [blame] | 82 | The `include` and `includeIf` sections allow you to include config |
| 83 | directives from another source. These sections behave identically to |
| 84 | each other with the exception that `includeIf` sections may be ignored |
| 85 | if their condition does not evaluate to true; see "Conditional includes" |
| 86 | below. |
| Junio C Hamano | 198b1f1 | 2016-05-17 22:27:24 | [diff] [blame] | 87 | |
| Junio C Hamano | 6b6144f | 2017-05-29 06:20:15 | [diff] [blame] | 88 | You can include a config file from another by setting the special |
| 89 | `include.path` (or `includeIf.*.path`) variable to the name of the file |
| 90 | to be included. The variable takes a pathname as its value, and is |
| 91 | subject to tilde expansion. These variables can be given multiple times. |
| 92 | |
| 93 | The contents of the included file are inserted immediately, as if they |
| 94 | had been found at the location of the include directive. If the value of the |
| 95 | variable is a relative path, the path is considered to |
| Junio C Hamano | cb06ef9 | 2017-03-21 22:40:14 | [diff] [blame] | 96 | be relative to the configuration file in which the include directive |
| 97 | was found. See below for examples. |
| Junio C Hamano | 198b1f1 | 2016-05-17 22:27:24 | [diff] [blame] | 98 | |
| Junio C Hamano | cb06ef9 | 2017-03-21 22:40:14 | [diff] [blame] | 99 | Conditional includes |
| 100 | ~~~~~~~~~~~~~~~~~~~~ |
| 101 | |
| 102 | You can include a config file from another conditionally by setting a |
| 103 | `includeIf.<condition>.path` variable to the name of the file to be |
| Junio C Hamano | 6b6144f | 2017-05-29 06:20:15 | [diff] [blame] | 104 | included. |
| Junio C Hamano | cb06ef9 | 2017-03-21 22:40:14 | [diff] [blame] | 105 | |
| 106 | The condition starts with a keyword followed by a colon and some data |
| 107 | whose format and meaning depends on the keyword. Supported keywords |
| 108 | are: |
| 109 | |
| 110 | `gitdir`:: |
| 111 | |
| 112 | The data that follows the keyword `gitdir:` is used as a glob |
| 113 | pattern. If the location of the .git directory matches the |
| 114 | pattern, the include condition is met. |
| 115 | + |
| 116 | The .git location may be auto-discovered, or come from `$GIT_DIR` |
| 117 | environment variable. If the repository is auto discovered via a .git |
| 118 | file (e.g. from submodules, or a linked worktree), the .git location |
| 119 | would be the final location where the .git directory is, not where the |
| 120 | .git file is. |
| 121 | + |
| 122 | The pattern can contain standard globbing wildcards and two additional |
| 123 | ones, `**/` and `/**`, that can match multiple path components. Please |
| 124 | refer to linkgit:gitignore[5] for details. For convenience: |
| 125 | |
| 126 | * If the pattern starts with `~/`, `~` will be substituted with the |
| 127 | content of the environment variable `HOME`. |
| 128 | |
| 129 | * If the pattern starts with `./`, it is replaced with the directory |
| 130 | containing the current config file. |
| 131 | |
| 132 | * If the pattern does not start with either `~/`, `./` or `/`, `**/` |
| 133 | will be automatically prepended. For example, the pattern `foo/bar` |
| 134 | becomes `**/foo/bar` and would match `/any/path/to/foo/bar`. |
| 135 | |
| 136 | * If the pattern ends with `/`, `**` will be automatically added. For |
| 137 | example, the pattern `foo/` becomes `foo/**`. In other words, it |
| 138 | matches "foo" and everything inside, recursively. |
| 139 | |
| 140 | `gitdir/i`:: |
| 141 | This is the same as `gitdir` except that matching is done |
| 142 | case-insensitively (e.g. on case-insensitive file sytems) |
| 143 | |
| 144 | A few more notes on matching via `gitdir` and `gitdir/i`: |
| 145 | |
| 146 | * Symlinks in `$GIT_DIR` are not resolved before matching. |
| 147 | |
| Junio C Hamano | d88ba73 | 2017-05-30 04:14:20 | [diff] [blame] | 148 | * Both the symlink & realpath versions of paths will be matched |
| 149 | outside of `$GIT_DIR`. E.g. if ~/git is a symlink to |
| 150 | /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git` |
| 151 | will match. |
| 152 | + |
| 153 | This was not the case in the initial release of this feature in |
| 154 | v2.13.0, which only matched the realpath version. Configuration that |
| 155 | wants to be compatible with the initial release of this feature needs |
| 156 | to either specify only the realpath version, or both versions. |
| 157 | |
| Junio C Hamano | cb06ef9 | 2017-03-21 22:40:14 | [diff] [blame] | 158 | * Note that "../" is not special and will match literally, which is |
| 159 | unlikely what you want. |
| Junio C Hamano | e0238c2 | 2012-02-23 22:45:50 | [diff] [blame] | 160 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 161 | Example |
| 162 | ~~~~~~~ |
| 163 | |
| 164 | # Core variables |
| 165 | [core] |
| 166 | ; Don't trust file modes |
| 167 | filemode = false |
| 168 | |
| 169 | # Our diff algorithm |
| 170 | [diff] |
| Junio C Hamano | 85c7157 | 2008-07-28 00:03:31 | [diff] [blame] | 171 | external = /usr/local/bin/diff-wrapper |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 172 | renames = true |
| 173 | |
| Junio C Hamano | 52401ef | 2006-12-19 00:54:38 | [diff] [blame] | 174 | [branch "devel"] |
| 175 | remote = origin |
| 176 | merge = refs/heads/devel |
| 177 | |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 178 | # Proxy settings |
| 179 | [core] |
| Junio C Hamano | c71a873 | 2007-08-04 00:27:26 | [diff] [blame] | 180 | gitProxy="ssh" for "kernel.org" |
| Junio C Hamano | bee172f | 2007-01-23 08:44:18 | [diff] [blame] | 181 | gitProxy=default-proxy ; for the rest |
| Junio C Hamano | 52401ef | 2006-12-19 00:54:38 | [diff] [blame] | 182 | |
| Junio C Hamano | e0238c2 | 2012-02-23 22:45:50 | [diff] [blame] | 183 | [include] |
| 184 | path = /path/to/foo.inc ; include by absolute path |
| Junio C Hamano | 6b6144f | 2017-05-29 06:20:15 | [diff] [blame] | 185 | path = foo.inc ; find "foo.inc" relative to the current file |
| 186 | path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory |
| Junio C Hamano | e0238c2 | 2012-02-23 22:45:50 | [diff] [blame] | 187 | |
| Junio C Hamano | cb06ef9 | 2017-03-21 22:40:14 | [diff] [blame] | 188 | ; include if $GIT_DIR is /path/to/foo/.git |
| 189 | [includeIf "gitdir:/path/to/foo/.git"] |
| 190 | path = /path/to/foo.inc |
| 191 | |
| 192 | ; include for all repositories inside /path/to/group |
| 193 | [includeIf "gitdir:/path/to/group/"] |
| 194 | path = /path/to/foo.inc |
| 195 | |
| 196 | ; include for all repositories inside $HOME/to/group |
| 197 | [includeIf "gitdir:~/to/group/"] |
| 198 | path = /path/to/foo.inc |
| Junio C Hamano | 0762262 | 2015-03-20 21:47:26 | [diff] [blame] | 199 | |
| Junio C Hamano | 6b6144f | 2017-05-29 06:20:15 | [diff] [blame] | 200 | ; relative paths are always relative to the including |
| 201 | ; file (if the condition is true); their location is not |
| 202 | ; affected by the condition |
| 203 | [includeIf "gitdir:/path/to/group/"] |
| 204 | path = foo.inc |
| 205 | |
| Junio C Hamano | 0762262 | 2015-03-20 21:47:26 | [diff] [blame] | 206 | Values |
| 207 | ~~~~~~ |
| 208 | |
| 209 | Values of many variables are treated as a simple string, but there |
| 210 | are variables that take values of specific types and there are rules |
| 211 | as to how to spell them. |
| 212 | |
| 213 | boolean:: |
| 214 | |
| 215 | When a variable is said to take a boolean value, many |
| 216 | synonyms are accepted for 'true' and 'false'; these are all |
| 217 | case-insensitive. |
| 218 | |
| Junio C Hamano | a4ff729 | 2017-08-23 21:56:43 | [diff] [blame] | 219 | true;; Boolean true literals are `yes`, `on`, `true`, |
| 220 | and `1`. Also, a variable defined without `= <value>` |
| Junio C Hamano | 0762262 | 2015-03-20 21:47:26 | [diff] [blame] | 221 | is taken as true. |
| 222 | |
| Junio C Hamano | a4ff729 | 2017-08-23 21:56:43 | [diff] [blame] | 223 | false;; Boolean false literals are `no`, `off`, `false`, |
| 224 | `0` and the empty string. |
| Junio C Hamano | 0762262 | 2015-03-20 21:47:26 | [diff] [blame] | 225 | + |
| Junio C Hamano | 92d8037 | 2016-07-13 22:00:05 | [diff] [blame] | 226 | When converting value to the canonical form using `--bool` type |
| Junio C Hamano | a4ff729 | 2017-08-23 21:56:43 | [diff] [blame] | 227 | specifier, 'git config' will ensure that the output is "true" or |
| Junio C Hamano | 0762262 | 2015-03-20 21:47:26 | [diff] [blame] | 228 | "false" (spelled in lowercase). |
| 229 | |
| 230 | integer:: |
| 231 | The value for many variables that specify various sizes can |
| 232 | be suffixed with `k`, `M`,... to mean "scale the number by |
| 233 | 1024", "by 1024x1024", etc. |
| 234 | |
| 235 | color:: |
| Junio C Hamano | 48931e2 | 2016-07-11 20:08:47 | [diff] [blame] | 236 | The value for a variable that takes a color is a list of |
| 237 | colors (at most two, one for foreground and one for background) |
| 238 | and attributes (as many as you want), separated by spaces. |
| Junio C Hamano | 0762262 | 2015-03-20 21:47:26 | [diff] [blame] | 239 | + |
| Junio C Hamano | 48931e2 | 2016-07-11 20:08:47 | [diff] [blame] | 240 | The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`, |
| 241 | `blue`, `magenta`, `cyan` and `white`. The first color given is the |
| 242 | foreground; the second is the background. |
| Junio C Hamano | 0762262 | 2015-03-20 21:47:26 | [diff] [blame] | 243 | + |
| Junio C Hamano | 48931e2 | 2016-07-11 20:08:47 | [diff] [blame] | 244 | Colors may also be given as numbers between 0 and 255; these use ANSI |
| 245 | 256-color mode (but note that not all terminals may support this). If |
| 246 | your terminal supports it, you may also specify 24-bit RGB values as |
| 247 | hex, like `#ff0ab3`. |
| 248 | + |
| 249 | The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`, |
| 250 | `italic`, and `strike` (for crossed-out or "strikethrough" letters). |
| 251 | The position of any attributes with respect to the colors |
| 252 | (before, after, or in between), doesn't matter. Specific attributes may |
| 253 | be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`, |
| 254 | `no-ul`, etc). |
| 255 | + |
| Junio C Hamano | b86c803 | 2017-02-02 21:50:19 | [diff] [blame] | 256 | An empty color string produces no color effect at all. This can be used |
| 257 | to avoid coloring specific elements without disabling color entirely. |
| 258 | + |
| Junio C Hamano | 48931e2 | 2016-07-11 20:08:47 | [diff] [blame] | 259 | For git's pre-defined color slots, the attributes are meant to be reset |
| 260 | at the beginning of each item in the colored output. So setting |
| 261 | `color.decorate.branch` to `black` will paint that branch name in a |
| 262 | plain `black`, even if the previous thing on the same output line (e.g. |
| 263 | opening parenthesis before the list of branch names in `log --decorate` |
| 264 | output) is set to be painted with `bold` or some other attribute. |
| 265 | However, custom log formats may do more complicated and layered |
| 266 | coloring, and the negated forms may be useful there. |
| Junio C Hamano | 0762262 | 2015-03-20 21:47:26 | [diff] [blame] | 267 | |
| Junio C Hamano | 198b1f1 | 2016-05-17 22:27:24 | [diff] [blame] | 268 | pathname:: |
| 269 | A variable that takes a pathname value can be given a |
| 270 | string that begins with "`~/`" or "`~user/`", and the usual |
| 271 | tilde expansion happens to such a string: `~/` |
| 272 | is expanded to the value of `$HOME`, and `~user/` to the |
| 273 | specified user's home directory. |
| 274 | |
| Junio C Hamano | 0762262 | 2015-03-20 21:47:26 | [diff] [blame] | 275 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 276 | Variables |
| 277 | ~~~~~~~~~ |
| 278 | |
| 279 | Note that this list is non-comprehensive and not necessarily complete. |
| Junio C Hamano | f1d1480 | 2006-06-08 00:48:17 | [diff] [blame] | 280 | For command-specific variables, you will find a more detailed description |
| Junio C Hamano | 52b6ba3 | 2014-04-01 00:26:48 | [diff] [blame] | 281 | in the appropriate manual page. |
| 282 | |
| 283 | Other git-related tools may and do use their own variables. When |
| 284 | inventing new variables for use in your own tool, make sure their |
| 285 | names do not conflict with those that are used by Git itself and |
| 286 | other popular tools, and describe them in your documentation. |
| 287 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 288 | |
| Junio C Hamano | 7df6dcf | 2009-09-13 09:51:17 | [diff] [blame] | 289 | advice.*:: |
| Junio C Hamano | 0df9271 | 2011-12-21 22:30:44 | [diff] [blame] | 290 | These variables control various optional help messages designed to |
| 291 | aid new users. All 'advice.*' variables default to 'true', and you |
| 292 | 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] | 293 | + |
| 294 | -- |
| Junio C Hamano | abad6da | 2013-01-06 09:06:32 | [diff] [blame] | 295 | pushUpdateRejected:: |
| Junio C Hamano | 0c1b64e | 2012-04-20 23:50:49 | [diff] [blame] | 296 | Set this variable to 'false' if you want to disable |
| Junio C Hamano | 1d669b8 | 2014-03-11 21:36:00 | [diff] [blame] | 297 | 'pushNonFFCurrent', |
| Junio C Hamano | 3f2ed6f | 2013-02-04 19:24:09 | [diff] [blame] | 298 | 'pushNonFFMatching', 'pushAlreadyExists', |
| 299 | 'pushFetchFirst', and 'pushNeedsForce' |
| Junio C Hamano | abad6da | 2013-01-06 09:06:32 | [diff] [blame] | 300 | simultaneously. |
| Junio C Hamano | 0c1b64e | 2012-04-20 23:50:49 | [diff] [blame] | 301 | pushNonFFCurrent:: |
| 302 | Advice shown when linkgit:git-push[1] fails due to a |
| 303 | non-fast-forward update to the current branch. |
| Junio C Hamano | 0c1b64e | 2012-04-20 23:50:49 | [diff] [blame] | 304 | pushNonFFMatching:: |
| 305 | Advice shown when you ran linkgit:git-push[1] and pushed |
| 306 | 'matching refs' explicitly (i.e. you used ':', or |
| 307 | specified a refspec that isn't your current branch) and |
| 308 | it resulted in a non-fast-forward error. |
| Junio C Hamano | abad6da | 2013-01-06 09:06:32 | [diff] [blame] | 309 | pushAlreadyExists:: |
| 310 | Shown when linkgit:git-push[1] rejects an update that |
| 311 | does not qualify for fast-forwarding (e.g., a tag.) |
| Junio C Hamano | 3f2ed6f | 2013-02-04 19:24:09 | [diff] [blame] | 312 | pushFetchFirst:: |
| 313 | Shown when linkgit:git-push[1] rejects an update that |
| 314 | tries to overwrite a remote ref that points at an |
| 315 | object we do not have. |
| 316 | pushNeedsForce:: |
| 317 | Shown when linkgit:git-push[1] rejects an update that |
| 318 | tries to overwrite a remote ref that points at an |
| Junio C Hamano | e6f28d0 | 2013-09-17 21:34:00 | [diff] [blame] | 319 | object that is not a commit-ish, or make the remote |
| 320 | ref point at an object that is not a commit-ish. |
| Junio C Hamano | 7df6dcf | 2009-09-13 09:51:17 | [diff] [blame] | 321 | statusHints:: |
| Junio C Hamano | 644936c | 2012-06-28 23:05:14 | [diff] [blame] | 322 | Show directions on how to proceed from the current |
| Junio C Hamano | 917cd4f | 2012-12-04 23:41:10 | [diff] [blame] | 323 | state in the output of linkgit:git-status[1], in |
| Junio C Hamano | 644936c | 2012-06-28 23:05:14 | [diff] [blame] | 324 | the template shown when writing commit messages in |
| Junio C Hamano | 917cd4f | 2012-12-04 23:41:10 | [diff] [blame] | 325 | linkgit:git-commit[1], and in the help message shown |
| 326 | by linkgit:git-checkout[1] when switching branch. |
| Junio C Hamano | 5e7f131 | 2013-03-21 22:49:01 | [diff] [blame] | 327 | statusUoption:: |
| 328 | Advise to consider using the `-u` option to linkgit:git-status[1] |
| 329 | when the command takes more than 2 seconds to enumerate untracked |
| 330 | files. |
| Junio C Hamano | 5706e0b | 2009-11-24 10:54:16 | [diff] [blame] | 331 | commitBeforeMerge:: |
| 332 | Advice shown when linkgit:git-merge[1] refuses to |
| Junio C Hamano | 619596a | 2010-08-18 22:15:35 | [diff] [blame] | 333 | merge to avoid overwriting local changes. |
| Junio C Hamano | a9701f0 | 2010-01-21 00:42:16 | [diff] [blame] | 334 | resolveConflict:: |
| Junio C Hamano | 5dab5a9 | 2013-02-25 18:51:24 | [diff] [blame] | 335 | Advice shown by various commands when conflicts |
| Junio C Hamano | a9701f0 | 2010-01-21 00:42:16 | [diff] [blame] | 336 | prevent the operation from being performed. |
| Junio C Hamano | a9701f0 | 2010-01-21 00:42:16 | [diff] [blame] | 337 | implicitIdentity:: |
| 338 | Advice on how to set your identity configuration when |
| 339 | your information is guessed from the system username and |
| Junio C Hamano | 0df9271 | 2011-12-21 22:30:44 | [diff] [blame] | 340 | domain name. |
| Junio C Hamano | 74a198f | 2010-02-22 00:13:31 | [diff] [blame] | 341 | detachedHead:: |
| Junio C Hamano | 0df9271 | 2011-12-21 22:30:44 | [diff] [blame] | 342 | Advice shown when you used linkgit:git-checkout[1] to |
| Junio C Hamano | 74a198f | 2010-02-22 00:13:31 | [diff] [blame] | 343 | move to the detach HEAD state, to instruct how to create |
| Junio C Hamano | 0df9271 | 2011-12-21 22:30:44 | [diff] [blame] | 344 | a local branch after the fact. |
| Junio C Hamano | bb30064 | 2012-07-22 21:09:14 | [diff] [blame] | 345 | amWorkDir:: |
| 346 | Advice that shows the location of the patch file when |
| 347 | linkgit:git-am[1] fails to apply it. |
| Junio C Hamano | 8ab9494 | 2013-06-24 21:55:30 | [diff] [blame] | 348 | rmHints:: |
| 349 | In case of failure in the output of linkgit:git-rm[1], |
| 350 | show directions on how to proceed from the current state. |
| Junio C Hamano | 535c65c | 2017-06-24 22:51:58 | [diff] [blame] | 351 | addEmbeddedRepo:: |
| 352 | Advice on what to do when you've accidentally added one |
| 353 | git repo inside of another. |
| Junio C Hamano | 3a9c034 | 2017-11-10 06:01:12 | [diff] [blame] | 354 | ignoredHook:: |
| 355 | Advice shown if an hook is ignored because the hook is not |
| 356 | set as executable. |
| Junio C Hamano | 047135e | 2017-12-19 21:57:54 | [diff] [blame^] | 357 | waitingForEditor:: |
| 358 | Print a message to the terminal whenever Git is waiting for |
| 359 | editor input from the user. |
| Junio C Hamano | 7df6dcf | 2009-09-13 09:51:17 | [diff] [blame] | 360 | -- |
| 361 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 362 | core.fileMode:: |
| Junio C Hamano | d2c2848 | 2014-10-24 22:28:25 | [diff] [blame] | 363 | Tells Git if the executable bit of files in the working tree |
| 364 | is to be honored. |
| Junio C Hamano | 9df0c66 | 2009-11-23 11:09:27 | [diff] [blame] | 365 | + |
| Junio C Hamano | d2c2848 | 2014-10-24 22:28:25 | [diff] [blame] | 366 | Some filesystems lose the executable bit when a file that is |
| Junio C Hamano | 6b6144f | 2017-05-29 06:20:15 | [diff] [blame] | 367 | marked as executable is checked out, or checks out a |
| Junio C Hamano | d2c2848 | 2014-10-24 22:28:25 | [diff] [blame] | 368 | non-executable file with executable bit on. |
| 369 | linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem |
| 370 | to see if it handles the executable bit correctly |
| 371 | and this variable is automatically set as necessary. |
| 372 | + |
| 373 | A repository, however, may be on a filesystem that handles |
| 374 | the filemode correctly, and this variable is set to 'true' |
| 375 | when created, but later may be made accessible from another |
| 376 | environment that loses the filemode (e.g. exporting ext4 via |
| 377 | CIFS mount, visiting a Cygwin created repository with |
| 378 | Git for Windows or Eclipse). |
| 379 | In such a case it may be necessary to set this variable to 'false'. |
| 380 | See linkgit:git-update-index[1]. |
| 381 | + |
| 382 | 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] | 383 | |
| Junio C Hamano | 198b1f1 | 2016-05-17 22:27:24 | [diff] [blame] | 384 | core.hideDotFiles:: |
| 385 | (Windows-only) If true, mark newly-created directories and files whose |
| 386 | name starts with a dot as hidden. If 'dotGitOnly', only the `.git/` |
| 387 | directory is hidden, but no other files starting with a dot. The |
| 388 | default mode is 'dotGitOnly'. |
| 389 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 390 | core.ignoreCase:: |
| Junio C Hamano | 9df0c66 | 2009-11-23 11:09:27 | [diff] [blame] | 391 | If true, this option enables various workarounds to enable |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 392 | Git to work better on filesystems that are not case sensitive, |
| Junio C Hamano | 9df0c66 | 2009-11-23 11:09:27 | [diff] [blame] | 393 | like FAT. For example, if a directory listing finds |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 394 | "makefile" when Git expects "Makefile", Git will assume |
| Junio C Hamano | 9df0c66 | 2009-11-23 11:09:27 | [diff] [blame] | 395 | it is really the same file, and continue to remember it as |
| 396 | "Makefile". |
| 397 | + |
| 398 | The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 399 | will probe and set core.ignoreCase true if appropriate when the repository |
| Junio C Hamano | 9df0c66 | 2009-11-23 11:09:27 | [diff] [blame] | 400 | is created. |
| 401 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 402 | core.precomposeUnicode:: |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 403 | This option is only used by Mac OS implementation of Git. |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 404 | When core.precomposeUnicode=true, Git reverts the unicode decomposition |
| Junio C Hamano | b61a777 | 2012-07-13 23:34:48 | [diff] [blame] | 405 | of filenames done by Mac OS. This is useful when sharing a repository |
| 406 | between Mac OS and Linux or Windows. |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 407 | (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). |
| 408 | When false, file names are handled fully transparent by Git, |
| 409 | which is backward compatible with older versions of Git. |
| Junio C Hamano | b61a777 | 2012-07-13 23:34:48 | [diff] [blame] | 410 | |
| Junio C Hamano | 30758bd | 2014-12-18 20:44:14 | [diff] [blame] | 411 | core.protectHFS:: |
| 412 | If set to true, do not allow checkout of paths that would |
| 413 | be considered equivalent to `.git` on an HFS+ filesystem. |
| 414 | Defaults to `true` on Mac OS, and `false` elsewhere. |
| 415 | |
| 416 | core.protectNTFS:: |
| 417 | If set to true, do not allow checkout of paths that would |
| 418 | cause problems with the NTFS filesystem, e.g. conflict with |
| 419 | 8.3 "short" names. |
| 420 | Defaults to `true` on Windows, and `false` elsewhere. |
| 421 | |
| Junio C Hamano | d710560 | 2017-11-21 05:32:50 | [diff] [blame] | 422 | core.fsmonitor:: |
| 423 | If set, the value of this variable is used as a command which |
| 424 | will identify all files that may have changed since the |
| 425 | requested date/time. This information is used to speed up git by |
| 426 | avoiding unnecessary processing of files that have not changed. |
| 427 | See the "fsmonitor-watchman" section of linkgit:githooks[5]. |
| 428 | |
| Junio C Hamano | 90ccff3 | 2008-07-29 08:17:24 | [diff] [blame] | 429 | core.trustctime:: |
| 430 | If false, the ctime differences between the index and the |
| Junio C Hamano | 8fb66e5 | 2011-10-05 20:59:51 | [diff] [blame] | 431 | working tree are ignored; useful when the inode change time |
| Junio C Hamano | 90ccff3 | 2008-07-29 08:17:24 | [diff] [blame] | 432 | is regularly modified by something outside Git (file system |
| 433 | crawlers and some backup systems). |
| 434 | See linkgit:git-update-index[1]. True by default. |
| 435 | |
| Junio C Hamano | 3d4a66d | 2017-03-17 21:07:26 | [diff] [blame] | 436 | core.splitIndex:: |
| 437 | If true, the split-index feature of the index will be used. |
| 438 | See linkgit:git-update-index[1]. False by default. |
| 439 | |
| Junio C Hamano | 9099a7c | 2016-02-10 23:42:05 | [diff] [blame] | 440 | core.untrackedCache:: |
| 441 | Determines what to do about the untracked cache feature of the |
| 442 | index. It will be kept, if this variable is unset or set to |
| 443 | `keep`. It will automatically be added if set to `true`. And |
| 444 | it will automatically be removed, if set to `false`. Before |
| 445 | setting it to `true`, you should check that mtime is working |
| 446 | properly on your system. |
| 447 | See linkgit:git-update-index[1]. `keep` by default. |
| 448 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 449 | core.checkStat:: |
| Junio C Hamano | 4cfed0c | 2013-01-30 17:58:54 | [diff] [blame] | 450 | Determines which stat fields to match between the index |
| 451 | and work tree. The user can set this to 'default' or |
| 452 | 'minimal'. Default (or explicitly 'default'), is to check |
| 453 | all fields, including the sub-second part of mtime and ctime. |
| 454 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 455 | core.quotePath:: |
| Junio C Hamano | 0f6f3bf | 2017-03-13 07:01:53 | [diff] [blame] | 456 | Commands that output paths (e.g. 'ls-files', 'diff'), will |
| 457 | quote "unusual" characters in the pathname by enclosing the |
| 458 | pathname in double-quotes and escaping those characters with |
| 459 | backslashes in the same way C escapes control characters (e.g. |
| 460 | `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with |
| 461 | values larger than 0x80 (e.g. octal `\302\265` for "micro" in |
| 462 | UTF-8). If this variable is set to false, bytes higher than |
| 463 | 0x80 are not considered "unusual" any more. Double-quotes, |
| 464 | backslash and control characters are always escaped regardless |
| 465 | of the setting of this variable. A simple space character is |
| 466 | not considered "unusual". Many commands can output pathnames |
| 467 | completely verbatim using the `-z` option. The default value |
| 468 | is true. |
| Junio C Hamano | d526ba9 | 2007-07-02 00:17:42 | [diff] [blame] | 469 | |
| Junio C Hamano | bb88cf4 | 2010-06-21 15:23:55 | [diff] [blame] | 470 | core.eol:: |
| 471 | Sets the line ending type to use in the working directory for |
| Junio C Hamano | f2a3a75 | 2016-05-23 22:54:39 | [diff] [blame] | 472 | files that have the `text` property set when core.autocrlf is false. |
| 473 | Alternatives are 'lf', 'crlf' and 'native', which uses the platform's |
| 474 | native line ending. The default value is `native`. See |
| Junio C Hamano | bb88cf4 | 2010-06-21 15:23:55 | [diff] [blame] | 475 | linkgit:gitattributes[5] for more information on end-of-line |
| 476 | conversion. |
| Junio C Hamano | d9e0e5d | 2007-04-14 16:22:04 | [diff] [blame] | 477 | |
| Junio C Hamano | 26e590a | 2008-02-17 03:53:51 | [diff] [blame] | 478 | core.safecrlf:: |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 479 | If true, makes Git check if converting `CRLF` is reversible when |
| Junio C Hamano | bb88cf4 | 2010-06-21 15:23:55 | [diff] [blame] | 480 | end-of-line conversion is active. Git will verify if a command |
| Junio C Hamano | 26e590a | 2008-02-17 03:53:51 | [diff] [blame] | 481 | modifies a file in the work tree either directly or indirectly. |
| 482 | For example, committing a file followed by checking out the |
| 483 | same file should yield the original file in the work tree. If |
| 484 | this is not the case for the current setting of |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 485 | `core.autocrlf`, Git will reject the file. The variable can |
| 486 | 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] | 487 | irreversible conversion but continue the operation. |
| 488 | + |
| 489 | CRLF conversion bears a slight chance of corrupting data. |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 490 | 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] | 491 | CRLF during checkout. A file that contains a mixture of LF and |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 492 | CRLF before the commit cannot be recreated by Git. For text |
| Junio C Hamano | 26e590a | 2008-02-17 03:53:51 | [diff] [blame] | 493 | files this is the right thing to do: it corrects line endings |
| 494 | such that we have only LF line endings in the repository. |
| 495 | But for binary files that are accidentally classified as text the |
| 496 | conversion can corrupt data. |
| 497 | + |
| 498 | If you recognize such corruption early you can easily fix it by |
| 499 | setting the conversion type explicitly in .gitattributes. Right |
| 500 | after committing you still have the original file in your work |
| 501 | tree and this file is not yet corrupted. You can explicitly tell |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 502 | Git that this file is binary and Git will handle the file |
| Junio C Hamano | 26e590a | 2008-02-17 03:53:51 | [diff] [blame] | 503 | appropriately. |
| 504 | + |
| 505 | Unfortunately, the desired effect of cleaning up text files with |
| 506 | mixed line endings and the undesired effect of corrupting binary |
| 507 | files cannot be distinguished. In both cases CRLFs are removed |
| 508 | in an irreversible way. For text files this is the right thing |
| 509 | to do because CRLFs are line endings, while for binary files |
| 510 | converting CRLFs corrupts data. |
| 511 | + |
| 512 | Note, this safety check does not mean that a checkout will generate a |
| 513 | file identical to the original file for a different setting of |
| Junio C Hamano | bb88cf4 | 2010-06-21 15:23:55 | [diff] [blame] | 514 | `core.eol` and `core.autocrlf`, but only for the current one. For |
| 515 | example, a text file with `LF` would be accepted with `core.eol=lf` |
| 516 | 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] | 517 | resulting file would contain `CRLF`, although the original file |
| 518 | contained `LF`. However, in both work trees the line endings would be |
| 519 | consistent, that is either all `LF` or all `CRLF`, but never mixed. A |
| 520 | file with mixed line endings would be reported by the `core.safecrlf` |
| 521 | mechanism. |
| 522 | |
| Junio C Hamano | bb88cf4 | 2010-06-21 15:23:55 | [diff] [blame] | 523 | core.autocrlf:: |
| Junio C Hamano | eed15af | 2016-07-25 22:49:42 | [diff] [blame] | 524 | Setting this variable to "true" is the same as setting |
| 525 | the `text` attribute to "auto" on all files and core.eol to "crlf". |
| 526 | Set to true if you want to have `CRLF` line endings in your |
| 527 | working directory and the repository has LF line endings. |
| 528 | This variable can be set to 'input', |
| Junio C Hamano | bb88cf4 | 2010-06-21 15:23:55 | [diff] [blame] | 529 | in which case no output conversion is performed. |
| 530 | |
| Junio C Hamano | aa83a7d | 2007-03-05 02:37:29 | [diff] [blame] | 531 | core.symlinks:: |
| 532 | If false, symbolic links are checked out as small plain files that |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 533 | contain the link text. linkgit:git-update-index[1] and |
| 534 | linkgit:git-add[1] will not change the recorded type to regular |
| Junio C Hamano | aa83a7d | 2007-03-05 02:37:29 | [diff] [blame] | 535 | file. Useful on filesystems like FAT that do not support |
| Junio C Hamano | 9df0c66 | 2009-11-23 11:09:27 | [diff] [blame] | 536 | symbolic links. |
| 537 | + |
| 538 | The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] |
| 539 | will probe and set core.symlinks false if appropriate when the repository |
| 540 | is created. |
| Junio C Hamano | aa83a7d | 2007-03-05 02:37:29 | [diff] [blame] | 541 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 542 | core.gitProxy:: |
| 543 | A "proxy command" to execute (as 'command host port') instead |
| 544 | of establishing direct connection to the remote server when |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 545 | using the Git protocol for fetching. If the variable value is |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 546 | in the "COMMAND for DOMAIN" format, the command is applied only |
| 547 | on hostnames ending with the specified domain string. This variable |
| 548 | may be set multiple times and is matched in the given order; |
| 549 | the first match wins. |
| Junio C Hamano | f1d1480 | 2006-06-08 00:48:17 | [diff] [blame] | 550 | + |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 551 | Can be overridden by the `GIT_PROXY_COMMAND` environment variable |
| Junio C Hamano | f1d1480 | 2006-06-08 00:48:17 | [diff] [blame] | 552 | (which always applies universally, without the special "for" |
| 553 | handling). |
| Junio C Hamano | ea82cff | 2009-03-18 01:54:48 | [diff] [blame] | 554 | + |
| 555 | The special string `none` can be used as the proxy command to |
| 556 | specify that no proxy be used for a given domain pattern. |
| 557 | This is useful for excluding servers inside a firewall from |
| 558 | proxy use, while defaulting to a common proxy for external domains. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 559 | |
| Junio C Hamano | 1a1b847 | 2016-07-19 21:37:13 | [diff] [blame] | 560 | core.sshCommand:: |
| 561 | If this variable is set, `git fetch` and `git push` will |
| 562 | use the specified command instead of `ssh` when they need to |
| 563 | connect to a remote system. The command is in the same form as |
| 564 | the `GIT_SSH_COMMAND` environment variable and is overridden |
| 565 | when the environment variable is set. |
| 566 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 567 | core.ignoreStat:: |
| Junio C Hamano | e8acc8e | 2015-01-14 22:01:34 | [diff] [blame] | 568 | If true, Git will avoid using lstat() calls to detect if files have |
| 569 | changed by setting the "assume-unchanged" bit for those tracked files |
| 570 | which it has updated identically in both the index and working tree. |
| 571 | + |
| 572 | When files are modified outside of Git, the user will need to stage |
| 573 | the modified files explicitly (e.g. see 'Examples' section in |
| 574 | linkgit:git-update-index[1]). |
| 575 | Git will not normally detect changes to those files. |
| 576 | + |
| 577 | This is useful on systems where lstat() calls are very slow, such as |
| 578 | CIFS/Microsoft Windows. |
| 579 | + |
| 580 | False by default. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 581 | |
| Junio C Hamano | 88a3a07 | 2006-05-04 08:01:43 | [diff] [blame] | 582 | core.preferSymlinkRefs:: |
| 583 | Instead of the default "symref" format for HEAD |
| 584 | and other symbolic reference files, use symbolic links. |
| 585 | This is sometimes needed to work with old scripts that |
| 586 | expect HEAD to be a symbolic link. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 587 | |
| Junio C Hamano | 1025e75 | 2007-02-23 07:21:26 | [diff] [blame] | 588 | core.bare:: |
| 589 | If true this repository is assumed to be 'bare' and has no |
| 590 | working directory associated with it. If this is the case a |
| 591 | number of commands that require a working directory will be |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 592 | disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. |
| Junio C Hamano | 1025e75 | 2007-02-23 07:21:26 | [diff] [blame] | 593 | + |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 594 | This setting is automatically guessed by linkgit:git-clone[1] or |
| 595 | linkgit:git-init[1] when the repository was created. By default a |
| Junio C Hamano | 1025e75 | 2007-02-23 07:21:26 | [diff] [blame] | 596 | repository that ends in "/.git" is assumed to be not bare (bare = |
| 597 | false), while all other repositories are assumed to be bare (bare |
| 598 | = true). |
| 599 | |
| Junio C Hamano | d526ba9 | 2007-07-02 00:17:42 | [diff] [blame] | 600 | core.worktree:: |
| Junio C Hamano | 80d5846 | 2011-01-24 22:52:52 | [diff] [blame] | 601 | Set the path to the root of the working tree. |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 602 | If `GIT_COMMON_DIR` environment variable is set, core.worktree |
| Junio C Hamano | 4cc4a84 | 2015-05-11 22:41:02 | [diff] [blame] | 603 | is ignored and not used for determining the root of working tree. |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 604 | This can be overridden by the `GIT_WORK_TREE` environment |
| Junio C Hamano | 92d8037 | 2016-07-13 22:00:05 | [diff] [blame] | 605 | variable and the `--work-tree` command-line option. |
| Junio C Hamano | 5cd1518 | 2011-04-05 00:21:10 | [diff] [blame] | 606 | 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] | 607 | the .git directory, which is either specified by --git-dir |
| 608 | or GIT_DIR, or automatically discovered. |
| 609 | If --git-dir or GIT_DIR is specified but none of |
| Junio C Hamano | 7d575a5 | 2008-04-30 08:45:27 | [diff] [blame] | 610 | --work-tree, GIT_WORK_TREE and core.worktree is specified, |
| Junio C Hamano | 80d5846 | 2011-01-24 22:52:52 | [diff] [blame] | 611 | the current working directory is regarded as the top level |
| Junio C Hamano | 3609b33 | 2010-12-29 01:34:52 | [diff] [blame] | 612 | of your working tree. |
| Junio C Hamano | 80d5846 | 2011-01-24 22:52:52 | [diff] [blame] | 613 | + |
| 614 | Note that this variable is honored even when set in a configuration |
| 615 | file in a ".git" subdirectory of a directory and its value differs |
| 616 | from the latter directory (e.g. "/path/to/.git/config" has |
| 617 | core.worktree set to "/different/path"), which is most likely a |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 618 | misconfiguration. Running Git commands in the "/path/to" directory will |
| Junio C Hamano | 80d5846 | 2011-01-24 22:52:52 | [diff] [blame] | 619 | still use "/different/path" as the root of the work tree and can cause |
| 620 | confusion unless you know what you are doing (e.g. you are creating a |
| 621 | read-only snapshot of the same index to a location different from the |
| 622 | repository's usual working tree). |
| Junio C Hamano | d526ba9 | 2007-07-02 00:17:42 | [diff] [blame] | 623 | |
| Junio C Hamano | 341071d | 2006-06-04 07:24:48 | [diff] [blame] | 624 | core.logAllRefUpdates:: |
| Junio C Hamano | cae8627 | 2007-08-21 02:20:49 | [diff] [blame] | 625 | Enable the reflog. Updates to a ref <ref> is logged to the file |
| Junio C Hamano | 198b1f1 | 2016-05-17 22:27:24 | [diff] [blame] | 626 | "`$GIT_DIR/logs/<ref>`", by appending the new and old |
| Junio C Hamano | e3f080d | 2013-04-22 02:27:13 | [diff] [blame] | 627 | SHA-1, the date/time and the reason of the update, but |
| Junio C Hamano | a2ec14f | 2006-11-02 00:22:48 | [diff] [blame] | 628 | only when the file exists. If this configuration |
| Junio C Hamano | a8e4261 | 2017-02-03 21:44:07 | [diff] [blame] | 629 | variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`" |
| Junio C Hamano | 15567bc | 2011-07-23 00:51:59 | [diff] [blame] | 630 | file is automatically created for branch heads (i.e. under |
| Junio C Hamano | a8e4261 | 2017-02-03 21:44:07 | [diff] [blame] | 631 | `refs/heads/`), remote refs (i.e. under `refs/remotes/`), |
| 632 | note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`. |
| 633 | If it is set to `always`, then a missing reflog is automatically |
| 634 | created for any ref under `refs/`. |
| Junio C Hamano | 1caaf47 | 2006-12-31 08:29:35 | [diff] [blame] | 635 | + |
| 636 | This information can be used to determine what commit |
| 637 | was the tip of a branch "2 days ago". |
| 638 | + |
| 639 | This value is true by default in a repository that has |
| 640 | a working directory associated with it, and false by |
| 641 | default in a bare repository. |
| Junio C Hamano | 341071d | 2006-06-04 07:24:48 | [diff] [blame] | 642 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 643 | core.repositoryFormatVersion:: |
| 644 | Internal variable identifying the repository format and layout |
| 645 | version. |
| 646 | |
| 647 | core.sharedRepository:: |
| Junio C Hamano | 0ab78ae | 2006-08-09 01:00:42 | [diff] [blame] | 648 | When 'group' (or 'true'), the repository is made shareable between |
| 649 | several users in a group (making sure all the files and objects are |
| 650 | group-writable). When 'all' (or 'world' or 'everybody'), the |
| 651 | repository will be readable by all users, additionally to being |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 652 | group-shareable. When 'umask' (or 'false'), Git will use permissions |
| Junio C Hamano | 2f102bb | 2008-04-26 02:23:37 | [diff] [blame] | 653 | reported by umask(2). When '0xxx', where '0xxx' is an octal number, |
| 654 | files in the repository will have this mode value. '0xxx' will override |
| Junio C Hamano | 83eded1 | 2009-04-20 08:18:00 | [diff] [blame] | 655 | user's umask value (whereas the other options will only override |
| 656 | requested parts of the user's umask value). Examples: '0660' will make |
| 657 | the repo read/write-able for the owner and group, but inaccessible to |
| 658 | 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] | 659 | repository that is group-readable but not group-writable. |
| 660 | See linkgit:git-init[1]. False by default. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 661 | |
| 662 | core.warnAmbiguousRefs:: |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 663 | 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] | 664 | and might match multiple refs in the repository. True by default. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 665 | |
| Junio C Hamano | 7ec1572 | 2006-07-07 02:03:59 | [diff] [blame] | 666 | core.compression:: |
| Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 667 | An integer -1..9, indicating a default compression level. |
| 668 | -1 is the zlib default. 0 means no compression, |
| 669 | and 1..9 are various speed/size tradeoffs, 9 being slowest. |
| Junio C Hamano | 2e72a94 | 2007-11-21 08:54:42 | [diff] [blame] | 670 | If set, this provides a default to other compression variables, |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 671 | such as `core.looseCompression` and `pack.compression`. |
| Junio C Hamano | a126a3b | 2006-07-04 04:55:26 | [diff] [blame] | 672 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 673 | core.looseCompression:: |
| Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 674 | An integer -1..9, indicating the compression level for objects that |
| 675 | are not in a pack file. -1 is the zlib default. 0 means no |
| 676 | compression, and 1..9 are various speed/size tradeoffs, 9 being |
| 677 | slowest. If not set, defaults to core.compression. If that is |
| Junio C Hamano | 2e72a94 | 2007-11-21 08:54:42 | [diff] [blame] | 678 | not set, defaults to 1 (best speed). |
| Junio C Hamano | 28d9dfe | 2006-07-25 03:50:49 | [diff] [blame] | 679 | |
| Junio C Hamano | fc4d38c | 2007-01-08 06:53:32 | [diff] [blame] | 680 | core.packedGitWindowSize:: |
| 681 | Number of bytes of a pack file to map into memory in a |
| 682 | single mapping operation. Larger window sizes may allow |
| 683 | your system to process a smaller number of large pack files |
| 684 | more quickly. Smaller window sizes will negatively affect |
| 685 | performance due to increased calls to the operating system's |
| 686 | memory manager, but may improve performance when accessing |
| 687 | a large number of large pack files. |
| 688 | + |
| 689 | Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 |
| 690 | MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should |
| 691 | be reasonable for all users/operating systems. You probably do |
| 692 | not need to adjust this value. |
| 693 | + |
| 694 | Common unit suffixes of 'k', 'm', or 'g' are supported. |
| 695 | |
| 696 | core.packedGitLimit:: |
| 697 | Maximum number of bytes to map simultaneously into memory |
| 698 | from pack files. If Git needs to access more than this many |
| 699 | bytes at once to complete an operation it will unmap existing |
| 700 | regions to reclaim virtual address space within the process. |
| 701 | + |
| Junio C Hamano | 967cda7 | 2017-06-30 21:49:53 | [diff] [blame] | 702 | Default is 256 MiB on 32 bit platforms and 32 TiB (effectively |
| 703 | unlimited) on 64 bit platforms. |
| Junio C Hamano | fc4d38c | 2007-01-08 06:53:32 | [diff] [blame] | 704 | This should be reasonable for all users/operating systems, except on |
| 705 | the largest projects. You probably do not need to adjust this value. |
| 706 | + |
| 707 | Common unit suffixes of 'k', 'm', or 'g' are supported. |
| 708 | |
| Junio C Hamano | b8c5128 | 2007-03-19 10:43:30 | [diff] [blame] | 709 | core.deltaBaseCacheLimit:: |
| 710 | Maximum number of bytes to reserve for caching base objects |
| Junio C Hamano | 619596a | 2010-08-18 22:15:35 | [diff] [blame] | 711 | that may be referenced by multiple deltified objects. By storing the |
| Junio C Hamano | b8c5128 | 2007-03-19 10:43:30 | [diff] [blame] | 712 | entire decompressed base objects in a cache Git is able |
| 713 | to avoid unpacking and decompressing frequently used base |
| 714 | objects multiple times. |
| 715 | + |
| Junio C Hamano | e1aeb5e | 2014-06-06 19:16:29 | [diff] [blame] | 716 | Default is 96 MiB on all platforms. This should be reasonable |
| Junio C Hamano | b8c5128 | 2007-03-19 10:43:30 | [diff] [blame] | 717 | for all users/operating systems, except on the largest projects. |
| 718 | You probably do not need to adjust this value. |
| 719 | + |
| 720 | Common unit suffixes of 'k', 'm', or 'g' are supported. |
| 721 | |
| Junio C Hamano | 5c246f2 | 2010-02-03 07:34:53 | [diff] [blame] | 722 | core.bigFileThreshold:: |
| 723 | Files larger than this size are stored deflated, without |
| 724 | attempting delta compression. Storing large files without |
| 725 | delta compression avoids excessive memory usage, at the |
| Junio C Hamano | 8e61f1f | 2014-09-11 21:53:45 | [diff] [blame] | 726 | slight expense of increased disk usage. Additionally files |
| 727 | larger than this size are always treated as binary. |
| Junio C Hamano | 5c246f2 | 2010-02-03 07:34:53 | [diff] [blame] | 728 | + |
| 729 | Default is 512 MiB on all platforms. This should be reasonable |
| 730 | for most projects as source code and other text files can still |
| 731 | be delta compressed, but larger binary media files won't be. |
| 732 | + |
| 733 | Common unit suffixes of 'k', 'm', or 'g' are supported. |
| Junio C Hamano | 5c246f2 | 2010-02-03 07:34:53 | [diff] [blame] | 734 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 735 | core.excludesFile:: |
| Junio C Hamano | 198b1f1 | 2016-05-17 22:27:24 | [diff] [blame] | 736 | Specifies the pathname to the file that contains patterns to |
| 737 | describe paths that are not meant to be tracked, in addition |
| 738 | to '.gitignore' (per-directory) and '.git/info/exclude'. |
| 739 | Defaults to `$XDG_CONFIG_HOME/git/ignore`. |
| 740 | If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore` |
| Junio C Hamano | 8edb4c7 | 2012-07-09 20:33:55 | [diff] [blame] | 741 | is used instead. See linkgit:gitignore[5]. |
| Junio C Hamano | 5e284b4 | 2007-05-22 07:23:37 | [diff] [blame] | 742 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 743 | core.askPass:: |
| Junio C Hamano | 3fd7b26 | 2010-09-08 22:44:20 | [diff] [blame] | 744 | Some commands (e.g. svn and http interfaces) that interactively |
| 745 | ask for a password can be told to use an external program given |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 746 | via the value of this variable. Can be overridden by the `GIT_ASKPASS` |
| Junio C Hamano | 3fd7b26 | 2010-09-08 22:44:20 | [diff] [blame] | 747 | environment variable. If not set, fall back to the value of the |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 748 | `SSH_ASKPASS` environment variable or, failing that, a simple password |
| Junio C Hamano | 3fd7b26 | 2010-09-08 22:44:20 | [diff] [blame] | 749 | prompt. The external program shall be given a suitable prompt as |
| Junio C Hamano | e1aeb5e | 2014-06-06 19:16:29 | [diff] [blame] | 750 | command-line argument and write the password on its STDOUT. |
| Junio C Hamano | 3fd7b26 | 2010-09-08 22:44:20 | [diff] [blame] | 751 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 752 | core.attributesFile:: |
| Junio C Hamano | 3b4609d | 2010-09-30 00:04:34 | [diff] [blame] | 753 | In addition to '.gitattributes' (per-directory) and |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 754 | '.git/info/attributes', Git looks into this file for attributes |
| Junio C Hamano | 3b4609d | 2010-09-30 00:04:34 | [diff] [blame] | 755 | (see linkgit:gitattributes[5]). Path expansions are made the same |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 756 | way as for `core.excludesFile`. Its default value is |
| Junio C Hamano | 198b1f1 | 2016-05-17 22:27:24 | [diff] [blame] | 757 | `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not |
| 758 | set or empty, `$HOME/.config/git/attributes` is used instead. |
| 759 | |
| 760 | core.hooksPath:: |
| 761 | By default Git will look for your hooks in the |
| 762 | '$GIT_DIR/hooks' directory. Set this to different path, |
| 763 | e.g. '/etc/git/hooks', and Git will try to find your hooks in |
| 764 | that directory, e.g. '/etc/git/hooks/pre-receive' instead of |
| 765 | in '$GIT_DIR/hooks/pre-receive'. |
| 766 | + |
| 767 | The path can be either absolute or relative. A relative path is |
| 768 | taken as relative to the directory where the hooks are run (see |
| 769 | the "DESCRIPTION" section of linkgit:githooks[5]). |
| 770 | + |
| 771 | This configuration variable is useful in cases where you'd like to |
| 772 | centrally configure your Git hooks instead of configuring them on a |
| 773 | per-repository basis, or as a more flexible and centralized |
| 774 | alternative to having an `init.templateDir` where you've changed |
| 775 | default hooks. |
| Junio C Hamano | 3b4609d | 2010-09-30 00:04:34 | [diff] [blame] | 776 | |
| Junio C Hamano | f6002a9 | 2007-07-20 10:28:22 | [diff] [blame] | 777 | core.editor:: |
| Junio C Hamano | 7ab74c4 | 2017-03-27 18:23:59 | [diff] [blame] | 778 | Commands such as `commit` and `tag` that let you edit |
| 779 | messages by launching an editor use the value of this |
| Junio C Hamano | f6002a9 | 2007-07-20 10:28:22 | [diff] [blame] | 780 | variable when it is set, and the environment variable |
| Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 781 | `GIT_EDITOR` is not set. See linkgit:git-var[1]. |
| Junio C Hamano | f6002a9 | 2007-07-20 10:28:22 | [diff] [blame] | 782 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 783 | core.commentChar:: |
| Junio C Hamano | 7ab74c4 | 2017-03-27 18:23:59 | [diff] [blame] | 784 | Commands such as `commit` and `tag` that let you edit |
| Junio C Hamano | 3f2ed6f | 2013-02-04 19:24:09 | [diff] [blame] | 785 | messages consider a line that begins with this character |
| 786 | commented, and removes them after the editor returns |
| 787 | (default '#'). |
| Junio C Hamano | e1aeb5e | 2014-06-06 19:16:29 | [diff] [blame] | 788 | + |
| 789 | If set to "auto", `git-commit` would select a character that is not |
| 790 | the beginning character of any line in existing commit messages. |
| Junio C Hamano | 3f2ed6f | 2013-02-04 19:24:09 | [diff] [blame] | 791 | |
| Junio C Hamano | fb1fdf1 | 2017-08-27 06:14:59 | [diff] [blame] | 792 | core.filesRefLockTimeout:: |
| 793 | The length of time, in milliseconds, to retry when trying to |
| 794 | lock an individual reference. Value 0 means not to retry at |
| 795 | all; -1 means to try indefinitely. Default is 100 (i.e., |
| 796 | retry for 100ms). |
| 797 | |
| Junio C Hamano | 1dbca52 | 2015-05-22 20:48:55 | [diff] [blame] | 798 | core.packedRefsTimeout:: |
| 799 | The length of time, in milliseconds, to retry when trying to |
| 800 | lock the `packed-refs` file. Value 0 means not to retry at |
| 801 | all; -1 means to try indefinitely. Default is 1000 (i.e., |
| 802 | retry for 1 second). |
| 803 | |
| Junio C Hamano | 6231f82 | 2011-10-24 05:18:52 | [diff] [blame] | 804 | sequence.editor:: |
| Junio C Hamano | 778a341 | 2013-03-28 23:24:30 | [diff] [blame] | 805 | 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] | 806 | The value is meant to be interpreted by the shell when it is used. |
| 807 | It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. |
| 808 | When not configured the default commit message editor is used instead. |
| 809 | |
| Junio C Hamano | 28d8ede | 2007-07-05 05:51:38 | [diff] [blame] | 810 | core.pager:: |
| Junio C Hamano | 0e0e0d2 | 2013-09-12 23:25:03 | [diff] [blame] | 811 | Text viewer for use by Git commands (e.g., 'less'). The value |
| 812 | is meant to be interpreted by the shell. The order of preference |
| 813 | is the `$GIT_PAGER` environment variable, then `core.pager` |
| 814 | configuration, then `$PAGER`, and then the default chosen at |
| 815 | compile time (usually 'less'). |
| 816 | + |
| Junio C Hamano | e1aeb5e | 2014-06-06 19:16:29 | [diff] [blame] | 817 | When the `LESS` environment variable is unset, Git sets it to `FRX` |
| Junio C Hamano | 0e0e0d2 | 2013-09-12 23:25:03 | [diff] [blame] | 818 | (if `LESS` environment variable is set, Git does not change it at |
| 819 | all). If you want to selectively override Git's default setting |
| Junio C Hamano | e1aeb5e | 2014-06-06 19:16:29 | [diff] [blame] | 820 | 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] | 821 | be passed to the shell by Git, which will translate the final |
| Junio C Hamano | e1aeb5e | 2014-06-06 19:16:29 | [diff] [blame] | 822 | command to `LESS=FRX less -S`. The environment does not set the |
| 823 | `S` option but the command line does, instructing less to truncate |
| 824 | long lines. Similarly, setting `core.pager` to `less -+F` will |
| 825 | deactivate the `F` option specified by the environment from the |
| 826 | command-line, deactivating the "quit if one screen" behavior of |
| 827 | `less`. One can specifically activate some flags for particular |
| 828 | commands: for example, setting `pager.blame` to `less -S` enables |
| 829 | line truncation only for `git blame`. |
| Junio C Hamano | bc8d478 | 2014-01-13 23:35:50 | [diff] [blame] | 830 | + |
| 831 | Likewise, when the `LV` environment variable is unset, Git sets it |
| 832 | to `-c`. You can override this setting by exporting `LV` with |
| 833 | another value or setting `core.pager` to `lv +c`. |
| Junio C Hamano | 28d8ede | 2007-07-05 05:51:38 | [diff] [blame] | 834 | |
| Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 835 | core.whitespace:: |
| 836 | A comma separated list of common whitespace problems to |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 837 | notice. 'git diff' will use `color.diff.whitespace` to |
| 838 | highlight them, and 'git apply --whitespace=error' will |
| Junio C Hamano | 3db8b41 | 2008-07-26 06:45:59 | [diff] [blame] | 839 | consider them as errors. You can prefix `-` to disable |
| 840 | any of them (e.g. `-trailing-space`): |
| Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 841 | + |
| Junio C Hamano | b71a22d | 2009-10-17 08:23:47 | [diff] [blame] | 842 | * `blank-at-eol` treats trailing whitespaces at the end of the line |
| Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 843 | as an error (enabled by default). |
| 844 | * `space-before-tab` treats a space character that appears immediately |
| 845 | before a tab character in the initial indent part of the line as an |
| 846 | error (enabled by default). |
| Junio C Hamano | 281fd39 | 2012-09-17 23:57:41 | [diff] [blame] | 847 | * `indent-with-non-tab` treats a line that is indented with space |
| 848 | characters instead of the equivalent tabs as an error (not enabled by |
| 849 | default). |
| Junio C Hamano | cb39aea | 2010-05-09 07:24:48 | [diff] [blame] | 850 | * `tab-in-indent` treats a tab character in the initial indent part of |
| 851 | the line as an error (not enabled by default). |
| Junio C Hamano | b71a22d | 2009-10-17 08:23:47 | [diff] [blame] | 852 | * `blank-at-eof` treats blank lines added at the end of file as an error |
| 853 | (enabled by default). |
| 854 | * `trailing-space` is a short-hand to cover both `blank-at-eol` and |
| 855 | `blank-at-eof`. |
| Junio C Hamano | 601f3e5 | 2008-02-25 08:40:42 | [diff] [blame] | 856 | * `cr-at-eol` treats a carriage-return at the end of line as |
| 857 | part of the line terminator, i.e. with it, `trailing-space` |
| 858 | does not trigger if the character before such a carriage-return |
| 859 | is not a whitespace (not enabled by default). |
| Junio C Hamano | eef01fe | 2010-12-13 08:31:58 | [diff] [blame] | 860 | * `tabwidth=<n>` tells how many character positions a tab occupies; this |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 861 | 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] | 862 | 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] | 863 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 864 | core.fsyncObjectFiles:: |
| Junio C Hamano | 9eb5753 | 2008-06-26 06:33:46 | [diff] [blame] | 865 | This boolean will enable 'fsync()' when writing object files. |
| 866 | + |
| 867 | This is a total waste of time and effort on a filesystem that orders |
| 868 | data writes properly, but can be useful for filesystems that do not use |
| 869 | journalling (traditional UNIX filesystems) or that only journal metadata |
| 870 | and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). |
| 871 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 872 | core.preloadIndex:: |
| Junio C Hamano | 610d176 | 2008-11-28 06:27:13 | [diff] [blame] | 873 | Enable parallel index preload for operations like 'git diff' |
| 874 | + |
| 875 | This can speed up operations like 'git diff' and 'git status' especially |
| 876 | on filesystems like NFS that have weak caching semantics and thus |
| Junio C Hamano | c8c398a | 2014-06-16 21:14:05 | [diff] [blame] | 877 | relatively high IO latencies. When enabled, Git will do the |
| Junio C Hamano | 610d176 | 2008-11-28 06:27:13 | [diff] [blame] | 878 | index comparison to the filesystem data in parallel, allowing |
| Junio C Hamano | c8c398a | 2014-06-16 21:14:05 | [diff] [blame] | 879 | overlapping IO's. Defaults to true. |
| Junio C Hamano | 610d176 | 2008-11-28 06:27:13 | [diff] [blame] | 880 | |
| Junio C Hamano | a9499de | 2009-04-30 03:38:48 | [diff] [blame] | 881 | core.createObject:: |
| 882 | You can set this to 'link', in which case a hardlink followed by |
| 883 | a delete of the source are used to make sure that object creation |
| 884 | will not overwrite existing objects. |
| 885 | + |
| 886 | On some file system/operating system combinations, this is unreliable. |
| 887 | Set this config setting to 'rename' there; However, This will remove the |
| 888 | check that makes sure that existing object files will not get overwritten. |
| Junio C Hamano | e91ea77 | 2009-04-26 01:41:41 | [diff] [blame] | 889 | |
| Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 890 | core.notesRef:: |
| 891 | When showing commit messages, also show notes which are stored in |
| Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 892 | the given ref. The ref must be fully qualified. If the given |
| 893 | ref does not exist, it is not an error but means that no |
| 894 | notes should be printed. |
| Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 895 | + |
| Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 896 | This setting defaults to "refs/notes/commits", and it can be overridden by |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 897 | the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. |
| Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 898 | |
| Junio C Hamano | 3c8d670 | 2010-01-13 23:09:03 | [diff] [blame] | 899 | core.sparseCheckout:: |
| 900 | Enable "sparse checkout" feature. See section "Sparse checkout" in |
| 901 | linkgit:git-read-tree[1] for more information. |
| 902 | |
| Junio C Hamano | 6371b0e | 2011-03-23 23:36:21 | [diff] [blame] | 903 | core.abbrev:: |
| Junio C Hamano | 56ace3d | 2017-01-10 23:43:41 | [diff] [blame] | 904 | Set the length object names are abbreviated to. If |
| 905 | unspecified or set to "auto", an appropriate value is |
| 906 | computed based on the approximate number of packed objects |
| 907 | in your repository, which hopefully is enough for |
| 908 | abbreviated object names to stay unique for some time. |
| Junio C Hamano | e0e20df | 2017-06-04 02:10:21 | [diff] [blame] | 909 | The minimum length is 4. |
| Junio C Hamano | 6371b0e | 2011-03-23 23:36:21 | [diff] [blame] | 910 | |
| Junio C Hamano | 6018664 | 2010-12-02 14:18:26 | [diff] [blame] | 911 | add.ignoreErrors:: |
| Junio C Hamano | be08798 | 2015-02-22 21:29:39 | [diff] [blame] | 912 | add.ignore-errors (deprecated):: |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 913 | Tells 'git add' to continue adding files when some files cannot be |
| Junio C Hamano | 92d8037 | 2016-07-13 22:00:05 | [diff] [blame] | 914 | added due to indexing errors. Equivalent to the `--ignore-errors` |
| Junio C Hamano | be08798 | 2015-02-22 21:29:39 | [diff] [blame] | 915 | option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, |
| 916 | as it does not follow the usual naming convention for configuration |
| 917 | variables. |
| Junio C Hamano | 3d14151 | 2009-06-01 01:22:40 | [diff] [blame] | 918 | |
| Junio C Hamano | 33db437 | 2006-06-07 19:51:45 | [diff] [blame] | 919 | alias.*:: |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 920 | Command aliases for the linkgit:git[1] command wrapper - e.g. |
| Junio C Hamano | 33db437 | 2006-06-07 19:51:45 | [diff] [blame] | 921 | after defining "alias.last = cat-file commit HEAD", the invocation |
| 922 | "git last" is equivalent to "git cat-file commit HEAD". To avoid |
| Junio C Hamano | f1d1480 | 2006-06-08 00:48:17 | [diff] [blame] | 923 | confusion and troubles with script usage, aliases that |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 924 | hide existing Git commands are ignored. Arguments are split by |
| Junio C Hamano | f1d1480 | 2006-06-08 00:48:17 | [diff] [blame] | 925 | spaces, the usual shell quoting and escaping is supported. |
| Junio C Hamano | 2efd5e4 | 2014-11-10 22:38:52 | [diff] [blame] | 926 | A quote pair or a backslash can be used to quote them. |
| Junio C Hamano | dbb6459 | 2007-09-01 11:17:39 | [diff] [blame] | 927 | + |
| 928 | If the alias expansion is prefixed with an exclamation point, |
| 929 | it will be treated as a shell command. For example, defining |
| 930 | "alias.new = !gitk --all --not ORIG_HEAD", the invocation |
| 931 | "git new" is equivalent to running the shell command |
| Junio C Hamano | 48bc1ce | 2009-07-09 16:49:19 | [diff] [blame] | 932 | "gitk --all --not ORIG_HEAD". Note that shell commands will be |
| 933 | executed from the top-level directory of a repository, which may |
| 934 | not necessarily be the current directory. |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 935 | `GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix' |
| Junio C Hamano | 5f2627d | 2011-05-06 20:23:48 | [diff] [blame] | 936 | from the original current directory. See linkgit:git-rev-parse[1]. |
| Junio C Hamano | 9cb74f2 | 2007-02-12 04:15:05 | [diff] [blame] | 937 | |
| Junio C Hamano | caa712a | 2010-03-11 01:17:35 | [diff] [blame] | 938 | am.keepcr:: |
| 939 | If true, git-am will call git-mailsplit for patches in mbox format |
| Junio C Hamano | 92d8037 | 2016-07-13 22:00:05 | [diff] [blame] | 940 | with parameter `--keep-cr`. In this case git-mailsplit will |
| Junio C Hamano | 619596a | 2010-08-18 22:15:35 | [diff] [blame] | 941 | not remove `\r` from lines ending with `\r\n`. Can be overridden |
| Junio C Hamano | 92d8037 | 2016-07-13 22:00:05 | [diff] [blame] | 942 | by giving `--no-keep-cr` from the command line. |
| Junio C Hamano | caa712a | 2010-03-11 01:17:35 | [diff] [blame] | 943 | See linkgit:git-am[1], linkgit:git-mailsplit[1]. |
| 944 | |
| Junio C Hamano | 9c51287 | 2015-08-12 21:59:25 | [diff] [blame] | 945 | am.threeWay:: |
| 946 | By default, `git am` will fail if the patch does not apply cleanly. When |
| 947 | set to true, this setting tells `git am` to fall back on 3-way merge if |
| 948 | the patch records the identity of blobs it is supposed to apply to and |
| 949 | we have those blobs available locally (equivalent to giving the `--3way` |
| 950 | option from the command line). Defaults to `false`. |
| 951 | See linkgit:git-am[1]. |
| 952 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 953 | apply.ignoreWhitespace:: |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 954 | When set to 'change', tells 'git apply' to ignore changes in |
| Junio C Hamano | 92d8037 | 2016-07-13 22:00:05 | [diff] [blame] | 955 | whitespace, in the same way as the `--ignore-space-change` |
| Junio C Hamano | fe24db0 | 2009-08-22 05:10:47 | [diff] [blame] | 956 | option. |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 957 | 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] | 958 | respect all whitespace differences. |
| 959 | See linkgit:git-apply[1]. |
| 960 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 961 | apply.whitespace:: |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 962 | Tells 'git apply' how to handle whitespaces, in the same way |
| Junio C Hamano | 92d8037 | 2016-07-13 22:00:05 | [diff] [blame] | 963 | as the `--whitespace` option. See linkgit:git-apply[1]. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 964 | |
| Junio C Hamano | 3a9c034 | 2017-11-10 06:01:12 | [diff] [blame] | 965 | blame.showRoot:: |
| 966 | Do not treat root commits as boundaries in linkgit:git-blame[1]. |
| 967 | This option defaults to false. |
| 968 | |
| 969 | blame.blankBoundary:: |
| 970 | Show blank commit object name for boundary commits in |
| 971 | linkgit:git-blame[1]. This option defaults to false. |
| 972 | |
| 973 | blame.showEmail:: |
| 974 | Show the author email instead of author name in linkgit:git-blame[1]. |
| 975 | This option defaults to false. |
| 976 | |
| 977 | blame.date:: |
| 978 | Specifies the format used to output dates in linkgit:git-blame[1]. |
| 979 | If unset the iso format is used. For supported values, |
| 980 | see the discussion of the `--date` option at linkgit:git-log[1]. |
| 981 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 982 | branch.autoSetupMerge:: |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 983 | Tells 'git branch' and 'git checkout' to set up new branches |
| Junio C Hamano | 24bc09a | 2008-02-28 00:27:44 | [diff] [blame] | 984 | so that linkgit:git-pull[1] will appropriately merge from the |
| 985 | starting point branch. Note that even if this option is not set, |
| Junio C Hamano | 7fd8417 | 2007-05-24 07:00:32 | [diff] [blame] | 986 | this behavior can be chosen per-branch using the `--track` |
| Junio C Hamano | 24bc09a | 2008-02-28 00:27:44 | [diff] [blame] | 987 | and `--no-track` options. The valid settings are: `false` -- no |
| 988 | automatic setup is done; `true` -- automatic setup is done when the |
| Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 989 | starting point is a remote-tracking branch; `always` -- |
| 990 | automatic setup is done when the starting point is either a |
| 991 | local branch or remote-tracking |
| Junio C Hamano | 24bc09a | 2008-02-28 00:27:44 | [diff] [blame] | 992 | branch. This option defaults to true. |
| Junio C Hamano | 7fd8417 | 2007-05-24 07:00:32 | [diff] [blame] | 993 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 994 | branch.autoSetupRebase:: |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 995 | When a new branch is created with 'git branch' or 'git checkout' |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 996 | that tracks another branch, this variable tells Git to set |
| Junio C Hamano | 869bb80 | 2008-05-12 00:29:47 | [diff] [blame] | 997 | up pull to rebase instead of merge (see "branch.<name>.rebase"). |
| 998 | When `never`, rebase is never automatically set to true. |
| 999 | When `local`, rebase is set to true for tracked branches of |
| 1000 | other local branches. |
| 1001 | When `remote`, rebase is set to true for tracked branches of |
| Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1002 | remote-tracking branches. |
| Junio C Hamano | 869bb80 | 2008-05-12 00:29:47 | [diff] [blame] | 1003 | When `always`, rebase will be set to true for all tracking |
| 1004 | branches. |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1005 | See "branch.autoSetupMerge" for details on how to set up a |
| Junio C Hamano | 869bb80 | 2008-05-12 00:29:47 | [diff] [blame] | 1006 | branch to track another branch. |
| 1007 | This option defaults to never. |
| 1008 | |
| Junio C Hamano | 47c1e3c | 2006-09-25 04:45:55 | [diff] [blame] | 1009 | branch.<name>.remote:: |
| Junio C Hamano | 63b6fdb | 2013-04-07 23:37:13 | [diff] [blame] | 1010 | When on branch <name>, it tells 'git fetch' and 'git push' |
| 1011 | which remote to fetch from/push to. The remote to push to |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1012 | may be overridden with `remote.pushDefault` (for all branches). |
| Junio C Hamano | 63b6fdb | 2013-04-07 23:37:13 | [diff] [blame] | 1013 | The remote to push to, for the current branch, may be further |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1014 | overridden by `branch.<name>.pushRemote`. If no remote is |
| Junio C Hamano | 63b6fdb | 2013-04-07 23:37:13 | [diff] [blame] | 1015 | configured, or if you are not on any branch, it defaults to |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1016 | `origin` for fetching and `remote.pushDefault` for pushing. |
| Junio C Hamano | 238ce9c | 2013-10-23 21:56:38 | [diff] [blame] | 1017 | Additionally, `.` (a period) is the current local repository |
| 1018 | (a dot-repository), see `branch.<name>.merge`'s final note below. |
| Junio C Hamano | 63b6fdb | 2013-04-07 23:37:13 | [diff] [blame] | 1019 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1020 | branch.<name>.pushRemote:: |
| Junio C Hamano | 63b6fdb | 2013-04-07 23:37:13 | [diff] [blame] | 1021 | When on branch <name>, it overrides `branch.<name>.remote` for |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1022 | pushing. It also overrides `remote.pushDefault` for pushing |
| Junio C Hamano | 63b6fdb | 2013-04-07 23:37:13 | [diff] [blame] | 1023 | from branch <name>. When you pull from one place (e.g. your |
| 1024 | upstream) and push to another place (e.g. your own publishing |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1025 | repository), you would want to set `remote.pushDefault` to |
| Junio C Hamano | 63b6fdb | 2013-04-07 23:37:13 | [diff] [blame] | 1026 | specify the remote to push to for all branches, and use this |
| 1027 | option to override it for a specific branch. |
| Junio C Hamano | 47c1e3c | 2006-09-25 04:45:55 | [diff] [blame] | 1028 | |
| 1029 | branch.<name>.merge:: |
| Junio C Hamano | 0706c80 | 2009-03-30 22:34:19 | [diff] [blame] | 1030 | Defines, together with branch.<name>.remote, the upstream branch |
| Junio C Hamano | b02377c | 2011-04-28 22:26:02 | [diff] [blame] | 1031 | 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] | 1032 | branch to merge and can also affect 'git push' (see push.default). |
| 1033 | When in branch <name>, it tells 'git fetch' the default |
| Junio C Hamano | c2b4709 | 2007-10-25 06:50:31 | [diff] [blame] | 1034 | refspec to be marked for merging in FETCH_HEAD. The value is |
| 1035 | handled like the remote part of a refspec, and must match a |
| 1036 | ref which is fetched from the remote given by |
| 1037 | "branch.<name>.remote". |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 1038 | The merge information is used by 'git pull' (which at first calls |
| 1039 | 'git fetch') to lookup the default branch for merging. Without |
| 1040 | this option, 'git pull' defaults to merge the first refspec fetched. |
| Junio C Hamano | 96010b2 | 2006-12-09 21:15:46 | [diff] [blame] | 1041 | Specify multiple values to get an octopus merge. |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 1042 | 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] | 1043 | another branch in the local repository, you can point |
| Junio C Hamano | 238ce9c | 2013-10-23 21:56:38 | [diff] [blame] | 1044 | branch.<name>.merge to the desired branch, and use the relative path |
| 1045 | setting `.` (a period) for branch.<name>.remote. |
| Junio C Hamano | 47c1e3c | 2006-09-25 04:45:55 | [diff] [blame] | 1046 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1047 | branch.<name>.mergeOptions:: |
| Junio C Hamano | 1b50ce9 | 2007-10-03 12:05:53 | [diff] [blame] | 1048 | Sets default options for merging into branch <name>. The syntax and |
| Junio C Hamano | c0e55e7 | 2009-10-10 00:56:29 | [diff] [blame] | 1049 | 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] | 1050 | option values containing whitespace characters are currently not |
| 1051 | supported. |
| 1052 | |
| Junio C Hamano | 0c99970 | 2007-12-03 09:57:55 | [diff] [blame] | 1053 | branch.<name>.rebase:: |
| 1054 | When true, rebase the branch <name> on top of the fetched branch, |
| Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 1055 | instead of merging the default branch from the default remote when |
| Junio C Hamano | 515ab1d | 2011-12-09 23:41:20 | [diff] [blame] | 1056 | "git pull" is run. See "pull.rebase" for doing this in a non |
| 1057 | branch-specific manner. |
| 1058 | + |
| Junio C Hamano | 7db630e | 2015-09-17 20:26:22 | [diff] [blame] | 1059 | When preserve, also pass `--preserve-merges` along to 'git rebase' |
| 1060 | so that locally committed merge commits will not be flattened |
| 1061 | by running 'git pull'. |
| Junio C Hamano | cf4a174 | 2013-09-11 22:57:50 | [diff] [blame] | 1062 | + |
| Junio C Hamano | 289d7e8 | 2016-01-27 00:20:38 | [diff] [blame] | 1063 | When the value is `interactive`, the rebase is run in interactive mode. |
| 1064 | + |
| Junio C Hamano | 515ab1d | 2011-12-09 23:41:20 | [diff] [blame] | 1065 | *NOTE*: this is a possibly dangerous operation; do *not* use |
| 1066 | it unless you understand the implications (see linkgit:git-rebase[1] |
| 1067 | for details). |
| Junio C Hamano | 0c99970 | 2007-12-03 09:57:55 | [diff] [blame] | 1068 | |
| Junio C Hamano | 4624718 | 2013-01-09 20:50:28 | [diff] [blame] | 1069 | branch.<name>.description:: |
| 1070 | Branch description, can be edited with |
| 1071 | `git branch --edit-description`. Branch description is |
| 1072 | automatically added in the format-patch cover letter or |
| 1073 | request-pull summary. |
| 1074 | |
| Junio C Hamano | 8760ea6 | 2008-03-14 08:58:45 | [diff] [blame] | 1075 | browser.<tool>.cmd:: |
| 1076 | Specify the command to invoke the specified browser. The |
| 1077 | specified command is evaluated in shell with the URLs passed |
| Junio C Hamano | 360e3a1 | 2011-07-13 23:51:56 | [diff] [blame] | 1078 | as arguments. (See linkgit:git-web{litdd}browse[1].) |
| Junio C Hamano | 8760ea6 | 2008-03-14 08:58:45 | [diff] [blame] | 1079 | |
| Junio C Hamano | e35a6fc | 2008-01-29 09:46:27 | [diff] [blame] | 1080 | browser.<tool>.path:: |
| 1081 | Override the path for the given tool that may be used to |
| Junio C Hamano | 92d8037 | 2016-07-13 22:00:05 | [diff] [blame] | 1082 | browse HTML help (see `-w` option in linkgit:git-help[1]) or a |
| Junio C Hamano | e35a6fc | 2008-01-29 09:46:27 | [diff] [blame] | 1083 | working repository in gitweb (see linkgit:git-instaweb[1]). |
| 1084 | |
| Junio C Hamano | 47b9acd | 2007-04-24 07:34:34 | [diff] [blame] | 1085 | clean.requireForce:: |
| Junio C Hamano | e6f28d0 | 2013-09-17 21:34:00 | [diff] [blame] | 1086 | A boolean to make git-clean do nothing unless given -f, |
| 1087 | -i or -n. Defaults to true. |
| Junio C Hamano | 47b9acd | 2007-04-24 07:34:34 | [diff] [blame] | 1088 | |
| Junio C Hamano | eb69295 | 2007-01-03 22:02:12 | [diff] [blame] | 1089 | color.branch:: |
| 1090 | A boolean to enable/disable color in the output of |
| Junio C Hamano | 5d4238d | 2017-10-18 03:01:15 | [diff] [blame] | 1091 | linkgit:git-branch[1]. May be set to `always`, |
| 1092 | `false` (or `never`) or `auto` (or `true`), in which case colors are used |
| 1093 | only when the output is to a terminal. If unset, then the |
| 1094 | value of `color.ui` is used (`auto` by default). |
| Junio C Hamano | eb69295 | 2007-01-03 22:02:12 | [diff] [blame] | 1095 | |
| 1096 | color.branch.<slot>:: |
| 1097 | Use customized color for branch coloration. `<slot>` is one of |
| 1098 | `current` (the current branch), `local` (a local branch), |
| Junio C Hamano | 7692782 | 2013-04-19 21:26:57 | [diff] [blame] | 1099 | `remote` (a remote-tracking branch in refs/remotes/), |
| 1100 | `upstream` (upstream tracking branch), `plain` (other |
| Junio C Hamano | 5a70233 | 2007-01-28 20:55:22 | [diff] [blame] | 1101 | refs). |
| Junio C Hamano | eb69295 | 2007-01-03 22:02:12 | [diff] [blame] | 1102 | |
| Junio C Hamano | 3f403b0 | 2006-12-13 10:14:13 | [diff] [blame] | 1103 | color.diff:: |
| Junio C Hamano | 5f2627d | 2011-05-06 20:23:48 | [diff] [blame] | 1104 | Whether to use ANSI escape sequences to add color to patches. |
| Junio C Hamano | 5d4238d | 2017-10-18 03:01:15 | [diff] [blame] | 1105 | If this is set to `always`, linkgit:git-diff[1], |
| Junio C Hamano | 5f2627d | 2011-05-06 20:23:48 | [diff] [blame] | 1106 | linkgit:git-log[1], and linkgit:git-show[1] will use color |
| Junio C Hamano | 5d4238d | 2017-10-18 03:01:15 | [diff] [blame] | 1107 | for all patches. If it is set to `true` or `auto`, those |
| 1108 | commands will only use color when output is to the terminal. |
| 1109 | If unset, then the value of `color.ui` is used (`auto` by |
| 1110 | default). |
| Junio C Hamano | 5f2627d | 2011-05-06 20:23:48 | [diff] [blame] | 1111 | + |
| Junio C Hamano | d75148a | 2014-04-08 19:48:38 | [diff] [blame] | 1112 | This does not affect linkgit:git-format-patch[1] or the |
| Junio C Hamano | 5f2627d | 2011-05-06 20:23:48 | [diff] [blame] | 1113 | 'git-diff-{asterisk}' plumbing commands. Can be overridden on the |
| 1114 | command line with the `--color[=<when>]` option. |
| Junio C Hamano | 9ae1a06 | 2006-07-10 08:12:34 | [diff] [blame] | 1115 | |
| Junio C Hamano | fb1fdf1 | 2017-08-27 06:14:59 | [diff] [blame] | 1116 | diff.colorMoved:: |
| 1117 | If set to either a valid `<mode>` or a true value, moved lines |
| 1118 | in a diff are colored differently, for details of valid modes |
| 1119 | see '--color-moved' in linkgit:git-diff[1]. If simply set to |
| 1120 | true the default color mode will be used. When set to false, |
| 1121 | moved lines are not colored. |
| 1122 | |
| Junio C Hamano | 3f403b0 | 2006-12-13 10:14:13 | [diff] [blame] | 1123 | color.diff.<slot>:: |
| Junio C Hamano | 5a70233 | 2007-01-28 20:55:22 | [diff] [blame] | 1124 | Use customized color for diff colorization. `<slot>` specifies |
| 1125 | which part of the patch to use the specified color, and is one |
| Junio C Hamano | 8c5d594 | 2015-06-11 19:37:48 | [diff] [blame] | 1126 | of `context` (context text - `plain` is a historical synonym), |
| 1127 | `meta` (metainformation), `frag` |
| Junio C Hamano | 2bd8a74 | 2009-12-01 21:16:59 | [diff] [blame] | 1128 | (hunk header), 'func' (function in hunk header), `old` (removed lines), |
| Junio C Hamano | fb1fdf1 | 2017-08-27 06:14:59 | [diff] [blame] | 1129 | `new` (added lines), `commit` (commit headers), `whitespace` |
| 1130 | (highlighting whitespace errors), `oldMoved` (deleted lines), |
| 1131 | `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`, |
| 1132 | `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative` |
| 1133 | and `newMovedAlternativeDimmed` (See the '<mode>' |
| 1134 | setting of '--color-moved' in linkgit:git-diff[1] for details). |
| Junio C Hamano | 9ae1a06 | 2006-07-10 08:12:34 | [diff] [blame] | 1135 | |
| Junio C Hamano | 7d44952 | 2010-07-01 00:08:51 | [diff] [blame] | 1136 | color.decorate.<slot>:: |
| 1137 | Use customized color for 'git log --decorate' output. `<slot>` is one |
| 1138 | of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local |
| Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1139 | branches, remote-tracking branches, tags, stash and HEAD, respectively. |
| Junio C Hamano | 7d44952 | 2010-07-01 00:08:51 | [diff] [blame] | 1140 | |
| Junio C Hamano | d257cff | 2009-03-18 05:27:16 | [diff] [blame] | 1141 | color.grep:: |
| 1142 | When set to `always`, always highlight matches. When `false` (or |
| 1143 | `never`), never. When set to `true` or `auto`, use color only |
| Junio C Hamano | ad70bf0 | 2016-09-26 23:44:27 | [diff] [blame] | 1144 | when the output is written to the terminal. If unset, then the |
| 1145 | value of `color.ui` is used (`auto` by default). |
| Junio C Hamano | d257cff | 2009-03-18 05:27:16 | [diff] [blame] | 1146 | |
| Junio C Hamano | 0299d92 | 2010-03-20 20:59:31 | [diff] [blame] | 1147 | color.grep.<slot>:: |
| 1148 | Use customized color for grep colorization. `<slot>` specifies which |
| 1149 | part of the line to use the specified color, and is one of |
| 1150 | + |
| 1151 | -- |
| 1152 | `context`;; |
| 1153 | non-matching text in context lines (when using `-A`, `-B`, or `-C`) |
| 1154 | `filename`;; |
| 1155 | filename prefix (when not using `-h`) |
| 1156 | `function`;; |
| 1157 | function name lines (when using `-p`) |
| 1158 | `linenumber`;; |
| 1159 | line number prefix (when using `-n`) |
| 1160 | `match`;; |
| Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1161 | matching text (same as setting `matchContext` and `matchSelected`) |
| 1162 | `matchContext`;; |
| 1163 | matching text in context lines |
| 1164 | `matchSelected`;; |
| 1165 | matching text in selected lines |
| Junio C Hamano | 0299d92 | 2010-03-20 20:59:31 | [diff] [blame] | 1166 | `selected`;; |
| 1167 | non-matching text in selected lines |
| 1168 | `separator`;; |
| 1169 | separators between fields on a line (`:`, `-`, and `=`) |
| 1170 | and between hunks (`--`) |
| 1171 | -- |
| Junio C Hamano | d257cff | 2009-03-18 05:27:16 | [diff] [blame] | 1172 | |
| Junio C Hamano | 00b8b63 | 2007-12-07 09:50:49 | [diff] [blame] | 1173 | color.interactive:: |
| Junio C Hamano | 5d4238d | 2017-10-18 03:01:15 | [diff] [blame] | 1174 | When set to `always`, always use colors for interactive prompts |
| Junio C Hamano | 58f587a | 2013-07-22 19:20:59 | [diff] [blame] | 1175 | and displays (such as those used by "git-add --interactive" and |
| Junio C Hamano | 5d4238d | 2017-10-18 03:01:15 | [diff] [blame] | 1176 | "git-clean --interactive"). When false (or `never`), never. |
| 1177 | When set to `true` or `auto`, use colors only when the output is |
| 1178 | to the terminal. If unset, then the value of `color.ui` is |
| 1179 | used (`auto` by default). |
| Junio C Hamano | 00b8b63 | 2007-12-07 09:50:49 | [diff] [blame] | 1180 | |
| 1181 | color.interactive.<slot>:: |
| Junio C Hamano | 58f587a | 2013-07-22 19:20:59 | [diff] [blame] | 1182 | Use customized color for 'git add --interactive' and 'git clean |
| 1183 | --interactive' output. `<slot>` may be `prompt`, `header`, `help` |
| 1184 | or `error`, for four distinct types of normal output from |
| Junio C Hamano | 0762262 | 2015-03-20 21:47:26 | [diff] [blame] | 1185 | interactive commands. |
| Junio C Hamano | 00b8b63 | 2007-12-07 09:50:49 | [diff] [blame] | 1186 | |
| Junio C Hamano | e7935c4 | 2006-12-13 21:32:17 | [diff] [blame] | 1187 | color.pager:: |
| 1188 | A boolean to enable/disable colored output when the pager is in |
| 1189 | use (default is true). |
| 1190 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1191 | color.showBranch:: |
| Junio C Hamano | 52ba295 | 2009-05-18 17:43:02 | [diff] [blame] | 1192 | A boolean to enable/disable color in the output of |
| 1193 | linkgit:git-show-branch[1]. May be set to `always`, |
| 1194 | `false` (or `never`) or `auto` (or `true`), in which case colors are used |
| Junio C Hamano | ad70bf0 | 2016-09-26 23:44:27 | [diff] [blame] | 1195 | only when the output is to a terminal. If unset, then the |
| 1196 | value of `color.ui` is used (`auto` by default). |
| Junio C Hamano | 52ba295 | 2009-05-18 17:43:02 | [diff] [blame] | 1197 | |
| Junio C Hamano | e7935c4 | 2006-12-13 21:32:17 | [diff] [blame] | 1198 | color.status:: |
| 1199 | A boolean to enable/disable color in the output of |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1200 | linkgit:git-status[1]. May be set to `always`, |
| Junio C Hamano | 0fc8cd9 | 2007-12-06 03:26:21 | [diff] [blame] | 1201 | `false` (or `never`) or `auto` (or `true`), in which case colors are used |
| Junio C Hamano | ad70bf0 | 2016-09-26 23:44:27 | [diff] [blame] | 1202 | only when the output is to a terminal. If unset, then the |
| 1203 | value of `color.ui` is used (`auto` by default). |
| Junio C Hamano | e7935c4 | 2006-12-13 21:32:17 | [diff] [blame] | 1204 | |
| 1205 | color.status.<slot>:: |
| 1206 | Use customized color for status colorization. `<slot>` is |
| 1207 | one of `header` (the header text of the status message), |
| Junio C Hamano | 7d23f5e | 2006-12-16 07:44:04 | [diff] [blame] | 1208 | `added` or `updated` (files which are added but not committed), |
| 1209 | `changed` (files which are changed but not added in the index), |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 1210 | `untracked` (files which are not tracked by Git), |
| Junio C Hamano | 5992a25 | 2015-03-17 23:39:30 | [diff] [blame] | 1211 | `branch` (the current branch), |
| Junio C Hamano | b713ff1 | 2008-05-24 01:12:30 | [diff] [blame] | 1212 | `nobranch` (the color the 'no branch' warning is shown in, defaulting |
| Junio C Hamano | d517690 | 2017-05-16 04:30:56 | [diff] [blame] | 1213 | to red), |
| 1214 | `localBranch` or `remoteBranch` (the local and remote branch names, |
| 1215 | respectively, when branch and tracking information is displayed in the |
| 1216 | status short-format), or |
| Junio C Hamano | 5992a25 | 2015-03-17 23:39:30 | [diff] [blame] | 1217 | `unmerged` (files which have unmerged changes). |
| Junio C Hamano | e7935c4 | 2006-12-13 21:32:17 | [diff] [blame] | 1218 | |
| Junio C Hamano | 83d46a2 | 2008-02-21 02:29:42 | [diff] [blame] | 1219 | color.ui:: |
| Junio C Hamano | 5f2627d | 2011-05-06 20:23:48 | [diff] [blame] | 1220 | This variable determines the default value for variables such |
| 1221 | as `color.diff` and `color.grep` that control the use of color |
| 1222 | per command family. Its scope will expand as more commands learn |
| 1223 | configuration to set a default for the `--color` option. Set it |
| Junio C Hamano | fa1d349 | 2013-06-20 23:39:43 | [diff] [blame] | 1224 | to `false` or `never` if you prefer Git commands not to use |
| 1225 | color unless enabled explicitly with some other configuration |
| Junio C Hamano | 5d4238d | 2017-10-18 03:01:15 | [diff] [blame] | 1226 | or the `--color` option. Set it to `always` if you want all |
| 1227 | output not intended for machine consumption to use color, to |
| 1228 | `true` or `auto` (this is the default since Git 1.8.4) if you |
| 1229 | want such output to use color when written to the terminal. |
| Junio C Hamano | 83d46a2 | 2008-02-21 02:29:42 | [diff] [blame] | 1230 | |
| Junio C Hamano | 22700fb | 2012-05-03 23:07:25 | [diff] [blame] | 1231 | column.ui:: |
| 1232 | Specify whether supported commands should output in columns. |
| 1233 | This variable consists of a list of tokens separated by spaces |
| 1234 | or commas: |
| 1235 | + |
| Junio C Hamano | a195230 | 2013-07-01 21:31:18 | [diff] [blame] | 1236 | These options control when the feature should be enabled |
| 1237 | (defaults to 'never'): |
| 1238 | + |
| Junio C Hamano | 22700fb | 2012-05-03 23:07:25 | [diff] [blame] | 1239 | -- |
| 1240 | `always`;; |
| 1241 | always show in columns |
| 1242 | `never`;; |
| 1243 | never show in columns |
| 1244 | `auto`;; |
| 1245 | show in columns if the output is to the terminal |
| Junio C Hamano | a195230 | 2013-07-01 21:31:18 | [diff] [blame] | 1246 | -- |
| 1247 | + |
| 1248 | These options control layout (defaults to 'column'). Setting any |
| 1249 | of these implies 'always' if none of 'always', 'never', or 'auto' are |
| 1250 | specified. |
| 1251 | + |
| 1252 | -- |
| Junio C Hamano | 22700fb | 2012-05-03 23:07:25 | [diff] [blame] | 1253 | `column`;; |
| Junio C Hamano | a195230 | 2013-07-01 21:31:18 | [diff] [blame] | 1254 | fill columns before rows |
| Junio C Hamano | 22700fb | 2012-05-03 23:07:25 | [diff] [blame] | 1255 | `row`;; |
| 1256 | fill rows before columns |
| 1257 | `plain`;; |
| 1258 | show in one column |
| Junio C Hamano | a195230 | 2013-07-01 21:31:18 | [diff] [blame] | 1259 | -- |
| 1260 | + |
| 1261 | Finally, these options can be combined with a layout option (defaults |
| 1262 | to 'nodense'): |
| 1263 | + |
| 1264 | -- |
| Junio C Hamano | 22700fb | 2012-05-03 23:07:25 | [diff] [blame] | 1265 | `dense`;; |
| 1266 | make unequal size columns to utilize more space |
| 1267 | `nodense`;; |
| 1268 | make equal size columns |
| 1269 | -- |
| Junio C Hamano | 22700fb | 2012-05-03 23:07:25 | [diff] [blame] | 1270 | |
| 1271 | column.branch:: |
| 1272 | Specify whether to output branch listing in `git branch` in columns. |
| 1273 | See `column.ui` for details. |
| 1274 | |
| Junio C Hamano | 58f587a | 2013-07-22 19:20:59 | [diff] [blame] | 1275 | column.clean:: |
| 1276 | Specify the layout when list items in `git clean -i`, which always |
| 1277 | shows files and directories in columns. See `column.ui` for details. |
| 1278 | |
| Junio C Hamano | 22700fb | 2012-05-03 23:07:25 | [diff] [blame] | 1279 | column.status:: |
| 1280 | Specify whether to output untracked files in `git status` in columns. |
| 1281 | See `column.ui` for details. |
| 1282 | |
| 1283 | column.tag:: |
| 1284 | Specify whether to output tag listing in `git tag` in columns. |
| 1285 | See `column.ui` for details. |
| 1286 | |
| Junio C Hamano | ce836cc | 2013-01-21 02:01:53 | [diff] [blame] | 1287 | commit.cleanup:: |
| 1288 | This setting overrides the default of the `--cleanup` option in |
| 1289 | `git commit`. See linkgit:git-commit[1] for details. Changing the |
| 1290 | default can be useful when you always want to keep lines that begin |
| 1291 | with comment character `#` in your log message, in which case you |
| 1292 | would do `git config commit.cleanup whitespace` (note that you will |
| 1293 | have to remove the help lines that begin with `#` in the commit log |
| 1294 | template yourself, if you do this). |
| 1295 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1296 | commit.gpgSign:: |
| Junio C Hamano | 5b3533d | 2014-02-27 23:07:15 | [diff] [blame] | 1297 | |
| 1298 | A boolean to specify whether all commits should be GPG signed. |
| 1299 | Use of this option when doing operations such as rebase can |
| 1300 | result in a large number of commits being signed. It may be |
| 1301 | convenient to use an agent to avoid typing your GPG passphrase |
| 1302 | several times. |
| 1303 | |
| Junio C Hamano | d0d892c | 2010-01-24 20:06:29 | [diff] [blame] | 1304 | commit.status:: |
| Junio C Hamano | 6ce6b6c | 2010-01-18 01:25:50 | [diff] [blame] | 1305 | A boolean to enable/disable inclusion of status information in the |
| 1306 | commit message template when using an editor to prepare the commit |
| 1307 | message. Defaults to true. |
| 1308 | |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 1309 | commit.template:: |
| Junio C Hamano | 198b1f1 | 2016-05-17 22:27:24 | [diff] [blame] | 1310 | Specify the pathname of a file to use as the template for |
| 1311 | new commit messages. |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 1312 | |
| Junio C Hamano | f2a3a75 | 2016-05-23 22:54:39 | [diff] [blame] | 1313 | commit.verbose:: |
| 1314 | A boolean or int to specify the level of verbose with `git commit`. |
| 1315 | See linkgit:git-commit[1]. |
| 1316 | |
| Junio C Hamano | 0df9271 | 2011-12-21 22:30:44 | [diff] [blame] | 1317 | credential.helper:: |
| 1318 | Specify an external helper to be called when a username or |
| 1319 | password credential is needed; the helper may consult external |
| Junio C Hamano | 4ba4a78 | 2016-04-03 19:11:32 | [diff] [blame] | 1320 | storage to avoid prompting the user for the credentials. Note |
| 1321 | that multiple helpers may be defined. See linkgit:gitcredentials[7] |
| 1322 | for details. |
| Junio C Hamano | 0df9271 | 2011-12-21 22:30:44 | [diff] [blame] | 1323 | |
| 1324 | credential.useHttpPath:: |
| 1325 | When acquiring credentials, consider the "path" component of an http |
| 1326 | or https URL to be important. Defaults to false. See |
| 1327 | linkgit:gitcredentials[7] for more information. |
| 1328 | |
| 1329 | credential.username:: |
| 1330 | If no username is set for a network authentication, use this username |
| 1331 | by default. See credential.<context>.* below, and |
| 1332 | linkgit:gitcredentials[7]. |
| 1333 | |
| 1334 | credential.<url>.*:: |
| 1335 | Any of the credential.* options above can be applied selectively to |
| 1336 | some credentials. For example "credential.https://example.com.username" |
| 1337 | would set the default username only for https connections to |
| 1338 | example.com. See linkgit:gitcredentials[7] for details on how URLs are |
| 1339 | matched. |
| 1340 | |
| Junio C Hamano | abb8a05 | 2015-12-04 22:43:11 | [diff] [blame] | 1341 | credentialCache.ignoreSIGHUP:: |
| 1342 | Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting. |
| 1343 | |
| Junio C Hamano | 209ebe8 | 2011-04-27 21:09:59 | [diff] [blame] | 1344 | include::diff-config.txt[] |
| Junio C Hamano | 3bd66e9 | 2009-04-18 06:17:56 | [diff] [blame] | 1345 | |
| 1346 | difftool.<tool>.path:: |
| 1347 | Override the path for the given tool. This is useful in case |
| 1348 | your tool is not in the PATH. |
| 1349 | |
| 1350 | difftool.<tool>.cmd:: |
| 1351 | Specify the command to invoke the specified diff tool. |
| 1352 | The specified command is evaluated in shell with the following |
| 1353 | variables available: 'LOCAL' is set to the name of the temporary |
| 1354 | file containing the contents of the diff pre-image and 'REMOTE' |
| 1355 | is set to the name of the temporary file containing the contents |
| 1356 | of the diff post-image. |
| 1357 | |
| 1358 | difftool.prompt:: |
| 1359 | Prompt before each invocation of the diff tool. |
| 1360 | |
| Junio C Hamano | fedb1b4 | 2016-06-20 21:23:40 | [diff] [blame] | 1361 | fastimport.unpackLimit:: |
| 1362 | If the number of objects imported by linkgit:git-fast-import[1] |
| 1363 | is below this limit, then the objects will be unpacked into |
| 1364 | loose object files. However if the number of imported objects |
| 1365 | equals or exceeds this limit then the pack will be stored as a |
| 1366 | pack. Storing the pack from a fast-import can make the import |
| 1367 | operation complete faster, especially on slow filesystems. If |
| 1368 | not set, the value of `transfer.unpackLimit` is used instead. |
| 1369 | |
| Junio C Hamano | 0d75e87 | 2010-12-17 06:57:26 | [diff] [blame] | 1370 | fetch.recurseSubmodules:: |
| Junio C Hamano | 5cd1518 | 2011-04-05 00:21:10 | [diff] [blame] | 1371 | This option can be either set to a boolean value or to 'on-demand'. |
| 1372 | Setting it to a boolean changes the behavior of fetch and pull to |
| 1373 | unconditionally recurse into submodules when set to true or to not |
| 1374 | recurse at all when set to false. When set to 'on-demand' (the default |
| 1375 | value), fetch and pull will only recurse into a populated submodule |
| 1376 | when its superproject retrieves a commit that updates the submodule's |
| 1377 | reference. |
| Junio C Hamano | 0d75e87 | 2010-12-17 06:57:26 | [diff] [blame] | 1378 | |
| Junio C Hamano | 8fb66e5 | 2011-10-05 20:59:51 | [diff] [blame] | 1379 | fetch.fsckObjects:: |
| 1380 | If it is set to true, git-fetch-pack will check all fetched |
| 1381 | objects. It will abort in the case of a malformed object or a |
| 1382 | broken link. The result of an abort are only dangling objects. |
| 1383 | Defaults to false. If not set, the value of `transfer.fsckObjects` |
| 1384 | is used instead. |
| 1385 | |
| Junio C Hamano | 54ea8d3 | 2007-01-25 07:59:48 | [diff] [blame] | 1386 | fetch.unpackLimit:: |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 1387 | If the number of objects fetched over the Git native |
| Junio C Hamano | 54ea8d3 | 2007-01-25 07:59:48 | [diff] [blame] | 1388 | transfer is below this |
| 1389 | limit, then the objects will be unpacked into loose object |
| 1390 | files. However if the number of received objects equals or |
| 1391 | exceeds this limit then the received pack will be stored as |
| 1392 | a pack, after adding any missing delta bases. Storing the |
| 1393 | pack from a push can make the push operation complete faster, |
| Junio C Hamano | e77b015 | 2008-01-12 06:44:17 | [diff] [blame] | 1394 | especially on slow filesystems. If not set, the value of |
| 1395 | `transfer.unpackLimit` is used instead. |
| Junio C Hamano | 54ea8d3 | 2007-01-25 07:59:48 | [diff] [blame] | 1396 | |
| Junio C Hamano | 8eac268 | 2013-09-09 22:35:20 | [diff] [blame] | 1397 | fetch.prune:: |
| 1398 | If true, fetch will automatically behave as if the `--prune` |
| 1399 | option was given on the command line. See also `remote.<name>.prune`. |
| 1400 | |
| Junio C Hamano | 1a1b847 | 2016-07-19 21:37:13 | [diff] [blame] | 1401 | fetch.output:: |
| 1402 | Control how ref update status is printed. Valid values are |
| 1403 | `full` and `compact`. Default value is `full`. See section |
| 1404 | OUTPUT in linkgit:git-fetch[1] for detail. |
| 1405 | |
| Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 1406 | format.attach:: |
| 1407 | Enable multipart/mixed attachments as the default for |
| 1408 | 'format-patch'. The value can also be a double quoted string |
| 1409 | which will enable attachments as the default and set the |
| 1410 | value as the boundary. See the --attach option in |
| 1411 | linkgit:git-format-patch[1]. |
| 1412 | |
| Junio C Hamano | af18294 | 2016-08-10 20:46:26 | [diff] [blame] | 1413 | format.from:: |
| 1414 | Provides the default value for the `--from` option to format-patch. |
| 1415 | Accepts a boolean value, or a name and email address. If false, |
| 1416 | format-patch defaults to `--no-from`, using commit authors directly in |
| 1417 | the "From:" field of patch mails. If true, format-patch defaults to |
| 1418 | `--from`, using your committer identity in the "From:" field of patch |
| 1419 | mails and including a "From:" field in the body of the patch mail if |
| 1420 | different. If set to a non-boolean value, format-patch uses that |
| 1421 | value instead of your committer identity. Defaults to false. |
| 1422 | |
| Junio C Hamano | 8c5802d | 2007-11-15 00:13:36 | [diff] [blame] | 1423 | format.numbered:: |
| Junio C Hamano | 7d06a8a | 2008-10-20 05:42:33 | [diff] [blame] | 1424 | A boolean which can enable or disable sequence numbers in patch |
| 1425 | subjects. It defaults to "auto" which enables it only if there |
| 1426 | is more than one patch. It can be enabled or disabled for all |
| 1427 | messages by setting it to "true" or "false". See --numbered |
| 1428 | option in linkgit:git-format-patch[1]. |
| Junio C Hamano | 8c5802d | 2007-11-15 00:13:36 | [diff] [blame] | 1429 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1430 | format.headers:: |
| 1431 | Additional email headers to include in a patch to be submitted |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1432 | by mail. See linkgit:git-format-patch[1]. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1433 | |
| Junio C Hamano | 70664a0 | 2010-07-13 22:48:05 | [diff] [blame] | 1434 | format.to:: |
| Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 1435 | format.cc:: |
| Junio C Hamano | 70664a0 | 2010-07-13 22:48:05 | [diff] [blame] | 1436 | Additional recipients to include in a patch to be submitted |
| 1437 | by mail. See the --to and --cc options in |
| 1438 | linkgit:git-format-patch[1]. |
| Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 1439 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1440 | format.subjectPrefix:: |
| Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 1441 | The default for format-patch is to output files with the '[PATCH]' |
| 1442 | subject prefix. Use this variable to change that prefix. |
| 1443 | |
| Junio C Hamano | 89a5734 | 2010-06-22 23:22:55 | [diff] [blame] | 1444 | format.signature:: |
| 1445 | The default for format-patch is to output a signature containing |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 1446 | the Git version number. Use this variable to change that default. |
| Junio C Hamano | 89a5734 | 2010-06-22 23:22:55 | [diff] [blame] | 1447 | Set this variable to the empty string ("") to suppress |
| 1448 | signature generation. |
| 1449 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1450 | format.signatureFile:: |
| Junio C Hamano | c8c398a | 2014-06-16 21:14:05 | [diff] [blame] | 1451 | Works just like format.signature except the contents of the |
| 1452 | file specified by this variable will be used as the signature. |
| 1453 | |
| Junio C Hamano | d4c8e11 | 2007-03-04 10:32:38 | [diff] [blame] | 1454 | format.suffix:: |
| 1455 | The default for format-patch is to output files with the suffix |
| 1456 | `.patch`. Use this variable to change that suffix (make sure to |
| 1457 | include the dot if you want it). |
| 1458 | |
| Junio C Hamano | 86bcccc | 2008-03-08 09:33:55 | [diff] [blame] | 1459 | format.pretty:: |
| 1460 | The default pretty format for log/show/whatchanged command, |
| 1461 | See linkgit:git-log[1], linkgit:git-show[1], |
| 1462 | linkgit:git-whatchanged[1]. |
| 1463 | |
| Junio C Hamano | ea6a764 | 2009-03-11 23:56:19 | [diff] [blame] | 1464 | format.thread:: |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 1465 | The default threading style for 'git format-patch'. Can be |
| Junio C Hamano | b141a92 | 2010-01-10 19:55:14 | [diff] [blame] | 1466 | a boolean value, or `shallow` or `deep`. `shallow` threading |
| 1467 | makes every mail a reply to the head of the series, |
| Junio C Hamano | ea6a764 | 2009-03-11 23:56:19 | [diff] [blame] | 1468 | where the head is chosen from the cover letter, the |
| Junio C Hamano | b76a686 | 2012-05-02 22:02:46 | [diff] [blame] | 1469 | `--in-reply-to`, and the first patch mail, in this order. |
| Junio C Hamano | f458110 | 2009-04-25 08:29:59 | [diff] [blame] | 1470 | `deep` threading makes every mail a reply to the previous one. |
| Junio C Hamano | ea6a764 | 2009-03-11 23:56:19 | [diff] [blame] | 1471 | A true boolean value is the same as `shallow`, and a false |
| 1472 | value disables threading. |
| 1473 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1474 | format.signOff:: |
| Junio C Hamano | 804a974 | 2013-04-28 23:10:31 | [diff] [blame] | 1475 | A boolean value which lets you enable the `-s/--signoff` option of |
| 1476 | format-patch by default. *Note:* Adding the Signed-off-by: line to a |
| 1477 | patch should be a conscious act and means that you certify you have |
| 1478 | the rights to submit this work under the same open source license. |
| 1479 | Please see the 'SubmittingPatches' document for further discussion. |
| Junio C Hamano | 5f9a6f0 | 2009-04-06 08:26:56 | [diff] [blame] | 1480 | |
| Junio C Hamano | ea3b752 | 2013-04-18 19:37:53 | [diff] [blame] | 1481 | format.coverLetter:: |
| 1482 | A boolean that controls whether to generate a cover-letter when |
| 1483 | format-patch is invoked, but in addition can be set to "auto", to |
| 1484 | generate a cover-letter only when there's more than one patch. |
| 1485 | |
| Junio C Hamano | 289d7e8 | 2016-01-27 00:20:38 | [diff] [blame] | 1486 | format.outputDirectory:: |
| 1487 | Set a custom directory to store the resulting files instead of the |
| 1488 | current working directory. |
| 1489 | |
| Junio C Hamano | f2a3a75 | 2016-05-23 22:54:39 | [diff] [blame] | 1490 | format.useAutoBase:: |
| 1491 | A boolean value which lets you enable the `--base=auto` option of |
| 1492 | format-patch by default. |
| 1493 | |
| Junio C Hamano | 209ebe8 | 2011-04-27 21:09:59 | [diff] [blame] | 1494 | filter.<driver>.clean:: |
| 1495 | The command which is used to convert the content of a worktree |
| 1496 | file to a blob upon checkin. See linkgit:gitattributes[5] for |
| 1497 | details. |
| 1498 | |
| 1499 | filter.<driver>.smudge:: |
| 1500 | The command which is used to convert the content of a blob |
| 1501 | object to a worktree file upon checkout. See |
| 1502 | linkgit:gitattributes[5] for details. |
| 1503 | |
| Junio C Hamano | d7ed404 | 2015-08-03 19:43:00 | [diff] [blame] | 1504 | fsck.<msg-id>:: |
| 1505 | Allows overriding the message type (error, warn or ignore) of a |
| 1506 | specific message ID such as `missingEmail`. |
| 1507 | + |
| 1508 | For convenience, fsck prefixes the error/warning with the message ID, |
| 1509 | e.g. "missingEmail: invalid author/committer line - missing email" means |
| 1510 | that setting `fsck.missingEmail = ignore` will hide that issue. |
| 1511 | + |
| 1512 | This feature is intended to support working with legacy repositories |
| 1513 | which cannot be repaired without disruptive changes. |
| 1514 | |
| 1515 | fsck.skipList:: |
| 1516 | The path to a sorted list of object names (i.e. one SHA-1 per |
| 1517 | line) that are known to be broken in a non-fatal way and should |
| 1518 | be ignored. This feature is useful when an established project |
| 1519 | should be accepted despite early commits containing errors that |
| 1520 | can be safely ignored such as invalid committer email addresses. |
| 1521 | Note: corrupt objects cannot be skipped with this setting. |
| 1522 | |
| Junio C Hamano | 624dd4c | 2014-04-03 21:56:30 | [diff] [blame] | 1523 | gc.aggressiveDepth:: |
| 1524 | The depth parameter used in the delta compression |
| 1525 | algorithm used by 'git gc --aggressive'. This defaults |
| Junio C Hamano | 5380048 | 2016-09-21 23:26:43 | [diff] [blame] | 1526 | to 50. |
| Junio C Hamano | 624dd4c | 2014-04-03 21:56:30 | [diff] [blame] | 1527 | |
| Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 1528 | gc.aggressiveWindow:: |
| 1529 | The window size parameter used in the delta compression |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 1530 | algorithm used by 'git gc --aggressive'. This defaults |
| Junio C Hamano | b04bb3f | 2010-04-14 14:07:36 | [diff] [blame] | 1531 | to 250. |
| Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 1532 | |
| Junio C Hamano | 1b50ce9 | 2007-10-03 12:05:53 | [diff] [blame] | 1533 | gc.auto:: |
| 1534 | When there are approximately more than this many loose |
| 1535 | objects in the repository, `git gc --auto` will pack them. |
| 1536 | Some Porcelain commands use this command to perform a |
| Junio C Hamano | e77b015 | 2008-01-12 06:44:17 | [diff] [blame] | 1537 | light-weight garbage collection from time to time. The |
| 1538 | default value is 6700. Setting this to 0 disables it. |
| Junio C Hamano | 1b50ce9 | 2007-10-03 12:05:53 | [diff] [blame] | 1539 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1540 | gc.autoPackLimit:: |
| Junio C Hamano | 1b50ce9 | 2007-10-03 12:05:53 | [diff] [blame] | 1541 | When there are more than this many packs that are not |
| 1542 | marked with `*.keep` file in the repository, `git gc |
| Junio C Hamano | e77b015 | 2008-01-12 06:44:17 | [diff] [blame] | 1543 | --auto` consolidates them into one larger pack. The |
| Junio C Hamano | 25c0b70 | 2008-03-23 09:41:37 | [diff] [blame] | 1544 | default value is 50. Setting this to 0 disables it. |
| Junio C Hamano | 1b50ce9 | 2007-10-03 12:05:53 | [diff] [blame] | 1545 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1546 | gc.autoDetach:: |
| Junio C Hamano | fb5ffde | 2014-11-04 22:38:56 | [diff] [blame] | 1547 | Make `git gc --auto` return immediately and run in background |
| Junio C Hamano | 08ef8c2 | 2014-03-10 14:53:44 | [diff] [blame] | 1548 | if the system supports it. Default is true. |
| 1549 | |
| Junio C Hamano | cbe0eb2 | 2017-02-27 23:37:49 | [diff] [blame] | 1550 | gc.logExpiry:: |
| 1551 | If the file gc.log exists, then `git gc --auto` won't run |
| 1552 | unless that file is more than 'gc.logExpiry' old. Default is |
| 1553 | "1.day". See `gc.pruneExpire` for more ways to specify its |
| 1554 | value. |
| 1555 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1556 | gc.packRefs:: |
| Junio C Hamano | b141a92 | 2010-01-10 19:55:14 | [diff] [blame] | 1557 | Running `git pack-refs` in a repository renders it |
| 1558 | unclonable by Git versions prior to 1.5.1.2 over dumb |
| 1559 | transports such as HTTP. This variable determines whether |
| Junio C Hamano | cdd1c33 | 2010-12-20 10:08:00 | [diff] [blame] | 1560 | 'git gc' runs `git pack-refs`. This can be set to `notbare` |
| Junio C Hamano | b141a92 | 2010-01-10 19:55:14 | [diff] [blame] | 1561 | to enable it within all non-bare repos or it can be set to a |
| 1562 | boolean value. The default is `true`. |
| Junio C Hamano | 9d52e57 | 2007-02-13 23:48:20 | [diff] [blame] | 1563 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1564 | gc.pruneExpire:: |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 1565 | 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] | 1566 | Override the grace period with this config variable. The value |
| Junio C Hamano | 9c51287 | 2015-08-12 21:59:25 | [diff] [blame] | 1567 | "now" may be used to disable this grace period and always prune |
| 1568 | unreachable objects immediately, or "never" may be used to |
| Junio C Hamano | 56ace3d | 2017-01-10 23:43:41 | [diff] [blame] | 1569 | suppress pruning. This feature helps prevent corruption when |
| 1570 | 'git gc' runs concurrently with another process writing to the |
| 1571 | repository; see the "NOTES" section of linkgit:git-gc[1]. |
| Junio C Hamano | 09a926d | 2008-03-13 07:55:29 | [diff] [blame] | 1572 | |
| Junio C Hamano | 9c51287 | 2015-08-12 21:59:25 | [diff] [blame] | 1573 | gc.worktreePruneExpire:: |
| 1574 | When 'git gc' is run, it calls |
| 1575 | 'git worktree prune --expire 3.months.ago'. |
| 1576 | This config variable can be used to set a different grace |
| 1577 | period. The value "now" may be used to disable the grace |
| Junio C Hamano | 198b1f1 | 2016-05-17 22:27:24 | [diff] [blame] | 1578 | period and prune `$GIT_DIR/worktrees` immediately, or "never" |
| Junio C Hamano | 9c51287 | 2015-08-12 21:59:25 | [diff] [blame] | 1579 | may be used to suppress pruning. |
| Junio C Hamano | 4cc4a84 | 2015-05-11 22:41:02 | [diff] [blame] | 1580 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1581 | gc.reflogExpire:: |
| 1582 | gc.<pattern>.reflogExpire:: |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 1583 | 'git reflog expire' removes reflog entries older than |
| Junio C Hamano | 9c51287 | 2015-08-12 21:59:25 | [diff] [blame] | 1584 | this time; defaults to 90 days. The value "now" expires all |
| 1585 | entries immediately, and "never" suppresses expiration |
| 1586 | altogether. With "<pattern>" (e.g. |
| Junio C Hamano | cc7636a | 2010-05-21 14:57:53 | [diff] [blame] | 1587 | "refs/stash") in the middle the setting applies only to |
| 1588 | the refs that match the <pattern>. |
| Junio C Hamano | 7464064 | 2006-12-27 10:59:55 | [diff] [blame] | 1589 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1590 | gc.reflogExpireUnreachable:: |
| Junio C Hamano | a1746be | 2015-08-26 23:07:07 | [diff] [blame] | 1591 | gc.<pattern>.reflogExpireUnreachable:: |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 1592 | 'git reflog expire' removes reflog entries older than |
| Junio C Hamano | 7464064 | 2006-12-27 10:59:55 | [diff] [blame] | 1593 | this time and are not reachable from the current tip; |
| Junio C Hamano | 9c51287 | 2015-08-12 21:59:25 | [diff] [blame] | 1594 | defaults to 30 days. The value "now" expires all entries |
| 1595 | immediately, and "never" suppresses expiration altogether. |
| 1596 | With "<pattern>" (e.g. "refs/stash") |
| Junio C Hamano | cc7636a | 2010-05-21 14:57:53 | [diff] [blame] | 1597 | in the middle, the setting applies only to the refs that |
| 1598 | match the <pattern>. |
| Junio C Hamano | 7464064 | 2006-12-27 10:59:55 | [diff] [blame] | 1599 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1600 | gc.rerereResolved:: |
| Junio C Hamano | 7464064 | 2006-12-27 10:59:55 | [diff] [blame] | 1601 | Records of conflicted merge you resolved earlier are |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 1602 | kept for this many days when 'git rerere gc' is run. |
| Junio C Hamano | fb1fdf1 | 2017-08-27 06:14:59 | [diff] [blame] | 1603 | You can also use more human-readable "1.month.ago", etc. |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1604 | The default is 60 days. See linkgit:git-rerere[1]. |
| Junio C Hamano | 7464064 | 2006-12-27 10:59:55 | [diff] [blame] | 1605 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1606 | gc.rerereUnresolved:: |
| Junio C Hamano | 7464064 | 2006-12-27 10:59:55 | [diff] [blame] | 1607 | Records of conflicted merge you have not resolved are |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 1608 | kept for this many days when 'git rerere gc' is run. |
| Junio C Hamano | fb1fdf1 | 2017-08-27 06:14:59 | [diff] [blame] | 1609 | You can also use more human-readable "1.month.ago", etc. |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1610 | The default is 15 days. See linkgit:git-rerere[1]. |
| Junio C Hamano | 7464064 | 2006-12-27 10:59:55 | [diff] [blame] | 1611 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1612 | gitcvs.commitMsgAnnotation:: |
| Junio C Hamano | a3148f5 | 2009-01-14 08:49:57 | [diff] [blame] | 1613 | Append this string to each commit message. Set to empty string |
| 1614 | to disable this feature. Defaults to "via git-CVS emulator". |
| 1615 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1616 | gitcvs.enabled:: |
| Junio C Hamano | a638742 | 2007-08-25 03:54:27 | [diff] [blame] | 1617 | Whether the CVS server interface is enabled for this repository. |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1618 | See linkgit:git-cvsserver[1]. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1619 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1620 | gitcvs.logFile:: |
| Junio C Hamano | a638742 | 2007-08-25 03:54:27 | [diff] [blame] | 1621 | Path to a log file where the CVS server interface well... logs |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1622 | various stuff. See linkgit:git-cvsserver[1]. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1623 | |
| Junio C Hamano | 17bd227 | 2008-09-01 06:11:17 | [diff] [blame] | 1624 | gitcvs.usecrlfattr:: |
| Junio C Hamano | bb88cf4 | 2010-06-21 15:23:55 | [diff] [blame] | 1625 | If true, the server will look up the end-of-line conversion |
| Junio C Hamano | 92d8037 | 2016-07-13 22:00:05 | [diff] [blame] | 1626 | attributes for files to determine the `-k` modes to use. If |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 1627 | the attributes force Git to treat a file as text, |
| Junio C Hamano | 92d8037 | 2016-07-13 22:00:05 | [diff] [blame] | 1628 | the `-k` mode will be left blank so CVS clients will |
| Junio C Hamano | bb88cf4 | 2010-06-21 15:23:55 | [diff] [blame] | 1629 | treat it as text. If they suppress text conversion, the file |
| Junio C Hamano | cb1c44f | 2008-08-06 06:19:33 | [diff] [blame] | 1630 | will be set with '-kb' mode, which suppresses any newline munging |
| Junio C Hamano | bb88cf4 | 2010-06-21 15:23:55 | [diff] [blame] | 1631 | the client might otherwise do. If the attributes do not allow |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1632 | the file type to be determined, then `gitcvs.allBinary` is |
| Junio C Hamano | bb88cf4 | 2010-06-21 15:23:55 | [diff] [blame] | 1633 | used. See linkgit:gitattributes[5]. |
| Junio C Hamano | dfccbb0 | 2008-05-26 01:16:14 | [diff] [blame] | 1634 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1635 | gitcvs.allBinary:: |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1636 | This is used if `gitcvs.usecrlfattr` does not resolve |
| Junio C Hamano | dfccbb0 | 2008-05-26 01:16:14 | [diff] [blame] | 1637 | the correct '-kb' mode to use. If true, all |
| 1638 | unresolved files are sent to the client in |
| 1639 | mode '-kb'. This causes the client to treat them |
| 1640 | as binary files, which suppresses any newline munging it |
| 1641 | otherwise might do. Alternatively, if it is set to "guess", |
| 1642 | then the contents of the file are examined to decide if |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1643 | it is binary, similar to `core.autocrlf`. |
| Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 1644 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1645 | gitcvs.dbName:: |
| Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 1646 | Database used by git-cvsserver to cache revision information |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 1647 | derived from the Git repository. The exact meaning depends on the |
| Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 1648 | used database driver, for SQLite (which is the default driver) this |
| 1649 | is a filename. Supports variable substitution (see |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1650 | linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`). |
| Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 1651 | Default: '%Ggitcvs.%m.sqlite' |
| 1652 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1653 | gitcvs.dbDriver:: |
| Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 1654 | Used Perl DBI driver. You can specify any available driver |
| Junio C Hamano | 804a974 | 2013-04-28 23:10:31 | [diff] [blame] | 1655 | for this here, but it might not work. git-cvsserver is tested |
| Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 1656 | with 'DBD::SQLite', reported to work with 'DBD::Pg', and |
| 1657 | reported *not* to work with 'DBD::mysql'. Experimental feature. |
| 1658 | May not contain double colons (`:`). Default: 'SQLite'. |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1659 | See linkgit:git-cvsserver[1]. |
| Junio C Hamano | d9e0e5d | 2007-04-14 16:22:04 | [diff] [blame] | 1660 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1661 | gitcvs.dbUser, gitcvs.dbPass:: |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1662 | Database user and password. Only useful if setting `gitcvs.dbDriver`, |
| Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 1663 | since SQLite has no concept of database users and/or passwords. |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1664 | 'gitcvs.dbUser' supports variable substitution (see |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 1665 | linkgit:git-cvsserver[1] for details). |
| Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 1666 | |
| Junio C Hamano | a74efce | 2008-04-02 08:39:08 | [diff] [blame] | 1667 | gitcvs.dbTableNamePrefix:: |
| 1668 | Database table name prefix. Prepended to the names of any |
| 1669 | database tables used, allowing a single database to be used |
| 1670 | for several repositories. Supports variable substitution (see |
| 1671 | linkgit:git-cvsserver[1] for details). Any non-alphabetic |
| 1672 | characters will be replaced with underscores. |
| 1673 | |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1674 | All gitcvs variables except for `gitcvs.usecrlfattr` and |
| 1675 | `gitcvs.allBinary` can also be specified as |
| Junio C Hamano | dfccbb0 | 2008-05-26 01:16:14 | [diff] [blame] | 1676 | 'gitcvs.<access_method>.<varname>' (where 'access_method' |
| Junio C Hamano | a638742 | 2007-08-25 03:54:27 | [diff] [blame] | 1677 | is one of "ext" and "pserver") to make them apply only for the given |
| 1678 | access method. |
| Junio C Hamano | a2ad99e | 2007-04-18 09:57:04 | [diff] [blame] | 1679 | |
| Junio C Hamano | 11821ed | 2011-10-19 18:42:09 | [diff] [blame] | 1680 | gitweb.category:: |
| 1681 | gitweb.description:: |
| 1682 | gitweb.owner:: |
| 1683 | gitweb.url:: |
| 1684 | See linkgit:gitweb[1] for description. |
| 1685 | |
| 1686 | gitweb.avatar:: |
| 1687 | gitweb.blame:: |
| 1688 | gitweb.grep:: |
| 1689 | gitweb.highlight:: |
| 1690 | gitweb.patches:: |
| 1691 | gitweb.pickaxe:: |
| 1692 | gitweb.remote_heads:: |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1693 | gitweb.showSizes:: |
| Junio C Hamano | 11821ed | 2011-10-19 18:42:09 | [diff] [blame] | 1694 | gitweb.snapshot:: |
| 1695 | See linkgit:gitweb.conf[5] for description. |
| 1696 | |
| Junio C Hamano | a03ac86 | 2011-04-02 04:32:29 | [diff] [blame] | 1697 | grep.lineNumber:: |
| Junio C Hamano | 92d8037 | 2016-07-13 22:00:05 | [diff] [blame] | 1698 | If set to true, enable `-n` option by default. |
| Junio C Hamano | a03ac86 | 2011-04-02 04:32:29 | [diff] [blame] | 1699 | |
| Junio C Hamano | a00504d | 2012-08-27 21:11:23 | [diff] [blame] | 1700 | grep.patternType:: |
| 1701 | Set the default matching behavior. Using a value of 'basic', 'extended', |
| Junio C Hamano | 92d8037 | 2016-07-13 22:00:05 | [diff] [blame] | 1702 | 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`, |
| 1703 | `--fixed-strings`, or `--perl-regexp` option accordingly, while the |
| Junio C Hamano | a00504d | 2012-08-27 21:11:23 | [diff] [blame] | 1704 | value 'default' will return to the default matching behavior. |
| 1705 | |
| Junio C Hamano | a03ac86 | 2011-04-02 04:32:29 | [diff] [blame] | 1706 | grep.extendedRegexp:: |
| Junio C Hamano | 92d8037 | 2016-07-13 22:00:05 | [diff] [blame] | 1707 | If set to true, enable `--extended-regexp` option by default. This |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1708 | option is ignored when the `grep.patternType` option is set to a value |
| Junio C Hamano | a00504d | 2012-08-27 21:11:23 | [diff] [blame] | 1709 | other than 'default'. |
| Junio C Hamano | a03ac86 | 2011-04-02 04:32:29 | [diff] [blame] | 1710 | |
| Junio C Hamano | a7da1ba | 2016-01-13 00:19:45 | [diff] [blame] | 1711 | grep.threads:: |
| 1712 | Number of grep worker threads to use. |
| 1713 | See `grep.threads` in linkgit:git-grep[1] for more information. |
| 1714 | |
| Junio C Hamano | 4e6ba27 | 2016-01-20 23:23:19 | [diff] [blame] | 1715 | grep.fallbackToNoIndex:: |
| 1716 | If set to true, fall back to git grep --no-index if git grep |
| 1717 | is executed outside of a git repository. Defaults to false. |
| 1718 | |
| Junio C Hamano | 4fd2442 | 2012-01-06 21:52:43 | [diff] [blame] | 1719 | gpg.program:: |
| Junio C Hamano | 198b1f1 | 2016-05-17 22:27:24 | [diff] [blame] | 1720 | Use this custom program instead of "`gpg`" found on `$PATH` when |
| Junio C Hamano | 4fd2442 | 2012-01-06 21:52:43 | [diff] [blame] | 1721 | making or verifying a PGP signature. The program must support the |
| Junio C Hamano | e1aeb5e | 2014-06-06 19:16:29 | [diff] [blame] | 1722 | same command-line interface as GPG, namely, to verify a detached |
| Junio C Hamano | 198b1f1 | 2016-05-17 22:27:24 | [diff] [blame] | 1723 | signature, "`gpg --verify $file - <$signature`" is run, and the |
| Junio C Hamano | 4fd2442 | 2012-01-06 21:52:43 | [diff] [blame] | 1724 | program is expected to signal a good signature by exiting with |
| Junio C Hamano | fb5ffde | 2014-11-04 22:38:56 | [diff] [blame] | 1725 | code 0, and to generate an ASCII-armored detached signature, the |
| Junio C Hamano | 198b1f1 | 2016-05-17 22:27:24 | [diff] [blame] | 1726 | standard input of "`gpg -bsau $key`" is fed with the contents to be |
| Junio C Hamano | 4fd2442 | 2012-01-06 21:52:43 | [diff] [blame] | 1727 | signed, and the program is expected to send the result to its |
| 1728 | standard output. |
| 1729 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1730 | gui.commitMsgWidth:: |
| Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 1731 | Defines how wide the commit message window is in the |
| 1732 | linkgit:git-gui[1]. "75" is the default. |
| 1733 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1734 | gui.diffContext:: |
| Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 1735 | Specifies how many context lines should be used in calls to diff |
| 1736 | made by the linkgit:git-gui[1]. The default is "5". |
| 1737 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1738 | gui.displayUntracked:: |
| Junio C Hamano | 198b1f1 | 2016-05-17 22:27:24 | [diff] [blame] | 1739 | Determines if linkgit:git-gui[1] shows untracked files |
| Junio C Hamano | 796c55f | 2014-05-02 21:45:15 | [diff] [blame] | 1740 | in the file list. The default is "true". |
| 1741 | |
| Junio C Hamano | d3452a0 | 2008-11-15 08:07:55 | [diff] [blame] | 1742 | gui.encoding:: |
| 1743 | Specifies the default encoding to use for displaying of |
| 1744 | file contents in linkgit:git-gui[1] and linkgit:gitk[1]. |
| 1745 | It can be overridden by setting the 'encoding' attribute |
| 1746 | for relevant files (see linkgit:gitattributes[5]). |
| 1747 | If this option is not set, the tools default to the |
| 1748 | locale encoding. |
| 1749 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1750 | gui.matchTrackingBranch:: |
| Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 1751 | Determines if new branches created with linkgit:git-gui[1] should |
| 1752 | default to tracking remote branches with matching names or |
| 1753 | not. Default: "false". |
| 1754 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1755 | gui.newBranchTemplate:: |
| Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 1756 | Is used as suggested name when creating new branches using the |
| 1757 | linkgit:git-gui[1]. |
| 1758 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1759 | gui.pruneDuringFetch:: |
| Junio C Hamano | 97bcb48 | 2010-11-25 03:16:07 | [diff] [blame] | 1760 | "true" if linkgit:git-gui[1] should prune remote-tracking branches when |
| Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 1761 | performing a fetch. The default value is "false". |
| 1762 | |
| 1763 | gui.trustmtime:: |
| 1764 | Determines if linkgit:git-gui[1] should trust the file modification |
| 1765 | timestamp or not. By default the timestamps are not trusted. |
| 1766 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1767 | gui.spellingDictionary:: |
| Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 1768 | Specifies the dictionary used for spell checking commit messages in |
| 1769 | the linkgit:git-gui[1]. When set to "none" spell checking is turned |
| 1770 | off. |
| 1771 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1772 | gui.fastCopyBlame:: |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 1773 | 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] | 1774 | location detection. It makes blame significantly faster on huge |
| 1775 | repositories at the expense of less thorough copy detection. |
| 1776 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1777 | gui.copyBlameThreshold:: |
| Junio C Hamano | 610d176 | 2008-11-28 06:27:13 | [diff] [blame] | 1778 | Specifies the threshold to use in 'git gui blame' original location |
| Junio C Hamano | d3452a0 | 2008-11-15 08:07:55 | [diff] [blame] | 1779 | detection, measured in alphanumeric characters. See the |
| 1780 | linkgit:git-blame[1] manual for more information on copy detection. |
| 1781 | |
| 1782 | gui.blamehistoryctx:: |
| 1783 | Specifies the radius of history context in days to show in |
| 1784 | linkgit:gitk[1] for the selected commit, when the `Show History |
| 1785 | Context` menu item is invoked from 'git gui blame'. If this |
| 1786 | variable is set to zero, the whole history is shown. |
| 1787 | |
| Junio C Hamano | 92d312a | 2008-12-15 07:22:20 | [diff] [blame] | 1788 | guitool.<name>.cmd:: |
| 1789 | Specifies the shell command line to execute when the corresponding item |
| 1790 | of the linkgit:git-gui[1] `Tools` menu is invoked. This option is |
| 1791 | mandatory for every tool. The command is executed from the root of |
| 1792 | the working directory, and in the environment it receives the name of |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1793 | the tool as `GIT_GUITOOL`, the name of the currently selected file as |
| Junio C Hamano | 92d312a | 2008-12-15 07:22:20 | [diff] [blame] | 1794 | 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if |
| 1795 | the head is detached, 'CUR_BRANCH' is empty). |
| 1796 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1797 | guitool.<name>.needsFile:: |
| Junio C Hamano | 92d312a | 2008-12-15 07:22:20 | [diff] [blame] | 1798 | Run the tool only if a diff is selected in the GUI. It guarantees |
| 1799 | that 'FILENAME' is not empty. |
| 1800 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1801 | guitool.<name>.noConsole:: |
| Junio C Hamano | 92d312a | 2008-12-15 07:22:20 | [diff] [blame] | 1802 | Run the command silently, without creating a window to display its |
| 1803 | output. |
| 1804 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1805 | guitool.<name>.noRescan:: |
| Junio C Hamano | 92d312a | 2008-12-15 07:22:20 | [diff] [blame] | 1806 | Don't rescan the working directory for changes after the tool |
| 1807 | finishes execution. |
| 1808 | |
| 1809 | guitool.<name>.confirm:: |
| 1810 | Show a confirmation dialog before actually running the tool. |
| 1811 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1812 | guitool.<name>.argPrompt:: |
| Junio C Hamano | 92d312a | 2008-12-15 07:22:20 | [diff] [blame] | 1813 | Request a string argument from the user, and pass it to the tool |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1814 | through the `ARGS` environment variable. Since requesting an |
| Junio C Hamano | 92d312a | 2008-12-15 07:22:20 | [diff] [blame] | 1815 | argument implies confirmation, the 'confirm' option has no effect |
| 1816 | if this is enabled. If the option is set to 'true', 'yes', or '1', |
| 1817 | the dialog uses a built-in generic prompt; otherwise the exact |
| 1818 | value of the variable is used. |
| 1819 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1820 | guitool.<name>.revPrompt:: |
| Junio C Hamano | 92d312a | 2008-12-15 07:22:20 | [diff] [blame] | 1821 | Request a single valid revision from the user, and set the |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1822 | `REVISION` environment variable. In other aspects this option |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1823 | is similar to 'argPrompt', and can be used together with it. |
| Junio C Hamano | 92d312a | 2008-12-15 07:22:20 | [diff] [blame] | 1824 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1825 | guitool.<name>.revUnmerged:: |
| 1826 | Show only unmerged branches in the 'revPrompt' subdialog. |
| Junio C Hamano | 92d312a | 2008-12-15 07:22:20 | [diff] [blame] | 1827 | This is useful for tools similar to merge or rebase, but not |
| 1828 | for things like checkout or reset. |
| 1829 | |
| 1830 | guitool.<name>.title:: |
| 1831 | Specifies the title to use for the prompt dialog. The default |
| 1832 | is the tool name. |
| 1833 | |
| 1834 | guitool.<name>.prompt:: |
| 1835 | Specifies the general prompt string to display at the top of |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1836 | the dialog, before subsections for 'argPrompt' and 'revPrompt'. |
| Junio C Hamano | 92d312a | 2008-12-15 07:22:20 | [diff] [blame] | 1837 | The default value includes the actual command. |
| 1838 | |
| Junio C Hamano | 4e27231 | 2008-01-08 09:13:21 | [diff] [blame] | 1839 | help.browser:: |
| 1840 | Specify the browser that will be used to display help in the |
| 1841 | 'web' format. See linkgit:git-help[1]. |
| 1842 | |
| 1843 | help.format:: |
| 1844 | Override the default help format used by linkgit:git-help[1]. |
| 1845 | Values 'man', 'info', 'web' and 'html' are supported. 'man' is |
| 1846 | the default. 'web' and 'html' are the same. |
| 1847 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1848 | help.autoCorrect:: |
| Junio C Hamano | f24b806 | 2008-09-09 01:34:39 | [diff] [blame] | 1849 | Automatically correct and execute mistyped commands after |
| 1850 | waiting for the given number of deciseconds (0.1 sec). If more |
| 1851 | than one command can be deduced from the entered text, nothing |
| 1852 | will be executed. If the value of this option is negative, |
| 1853 | the corrected command will be executed immediately. If the |
| 1854 | value is 0 - the command will be just shown but not executed. |
| 1855 | This is the default. |
| 1856 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1857 | help.htmlPath:: |
| Junio C Hamano | 5dd5fae | 2013-01-18 21:06:49 | [diff] [blame] | 1858 | Specify the path where the HTML documentation resides. File system paths |
| 1859 | and URLs are supported. HTML pages will be prefixed with this path when |
| 1860 | help is displayed in the 'web' format. This defaults to the documentation |
| 1861 | path of your Git installation. |
| 1862 | |
| Junio C Hamano | 5825687 | 2007-12-04 08:31:13 | [diff] [blame] | 1863 | http.proxy:: |
| Junio C Hamano | 3dd9392 | 2012-03-05 07:49:11 | [diff] [blame] | 1864 | Override the HTTP proxy, normally configured using the 'http_proxy', |
| Junio C Hamano | ffe10ca | 2016-02-04 00:44:23 | [diff] [blame] | 1865 | 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In |
| 1866 | addition to the syntax understood by curl, it is possible to specify a |
| 1867 | proxy string with a user name but no password, in which case git will |
| 1868 | attempt to acquire one in the same way it does for other credentials. See |
| 1869 | linkgit:gitcredentials[7] for more information. The syntax thus is |
| 1870 | '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden |
| 1871 | on a per-remote basis; see remote.<name>.proxy |
| 1872 | |
| 1873 | http.proxyAuthMethod:: |
| 1874 | Set the method with which to authenticate against the HTTP proxy. This |
| 1875 | only takes effect if the configured proxy string contains a user name part |
| 1876 | (i.e. is of the form 'user@host' or 'user@host:port'). This can be |
| 1877 | overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`. |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1878 | Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment |
| Junio C Hamano | ffe10ca | 2016-02-04 00:44:23 | [diff] [blame] | 1879 | variable. Possible values are: |
| 1880 | + |
| 1881 | -- |
| 1882 | * `anyauth` - Automatically pick a suitable authentication method. It is |
| 1883 | assumed that the proxy answers an unauthenticated request with a 407 |
| 1884 | status code and one or more Proxy-authenticate headers with supported |
| 1885 | authentication methods. This is the default. |
| 1886 | * `basic` - HTTP Basic authentication |
| 1887 | * `digest` - HTTP Digest authentication; this prevents the password from being |
| 1888 | transmitted to the proxy in clear text |
| 1889 | * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option |
| 1890 | of `curl(1)`) |
| 1891 | * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`) |
| 1892 | -- |
| Junio C Hamano | 5825687 | 2007-12-04 08:31:13 | [diff] [blame] | 1893 | |
| Junio C Hamano | 3fcdd07 | 2016-02-24 23:41:08 | [diff] [blame] | 1894 | http.emptyAuth:: |
| 1895 | Attempt authentication without seeking a username or password. This |
| 1896 | can be used to attempt GSS-Negotiate authentication without specifying |
| 1897 | a username in the URL, as libcurl normally requires a username for |
| 1898 | authentication. |
| 1899 | |
| Junio C Hamano | 34afdb2 | 2016-10-06 22:16:39 | [diff] [blame] | 1900 | http.delegation:: |
| 1901 | Control GSSAPI credential delegation. The delegation is disabled |
| 1902 | by default in libcurl since version 7.21.7. Set parameter to tell |
| 1903 | the server what it is allowed to delegate when it comes to user |
| 1904 | credentials. Used with GSS/kerberos. Possible values are: |
| 1905 | + |
| 1906 | -- |
| 1907 | * `none` - Don't allow any delegation. |
| 1908 | * `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the |
| 1909 | Kerberos service ticket, which is a matter of realm policy. |
| 1910 | * `always` - Unconditionally allow the server to delegate. |
| 1911 | -- |
| 1912 | |
| 1913 | |
| Junio C Hamano | ccdabca | 2016-05-06 22:27:09 | [diff] [blame] | 1914 | http.extraHeader:: |
| 1915 | Pass an additional HTTP header when communicating with a server. If |
| 1916 | more than one such entry exists, all of them are added as extra |
| 1917 | headers. To allow overriding the settings inherited from the system |
| 1918 | config, an empty value will reset the extra headers to the empty list. |
| 1919 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1920 | http.cookieFile:: |
| Junio C Hamano | 198b1f1 | 2016-05-17 22:27:24 | [diff] [blame] | 1921 | The pathname of a file containing previously stored cookie lines, |
| 1922 | which should be used |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 1923 | 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] | 1924 | of the file to read cookies from should be plain HTTP headers or |
| Junio C Hamano | 198b1f1 | 2016-05-17 22:27:24 | [diff] [blame] | 1925 | the Netscape/Mozilla cookie file format (see `curl(1)`). |
| 1926 | NOTE that the file specified with http.cookieFile is used only as |
| Junio C Hamano | 8eac268 | 2013-09-09 22:35:20 | [diff] [blame] | 1927 | input unless http.saveCookies is set. |
| 1928 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1929 | http.saveCookies:: |
| Junio C Hamano | 8eac268 | 2013-09-09 22:35:20 | [diff] [blame] | 1930 | If set, store cookies received during requests to the file specified by |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 1931 | http.cookieFile. Has no effect if http.cookieFile is unset. |
| Junio C Hamano | 4c4b012 | 2011-06-30 01:19:32 | [diff] [blame] | 1932 | |
| Junio C Hamano | a1746be | 2015-08-26 23:07:07 | [diff] [blame] | 1933 | http.sslVersion:: |
| 1934 | The SSL version to use when negotiating an SSL connection, if you |
| 1935 | want to force the default. The available and default version |
| 1936 | depend on whether libcurl was built against NSS or OpenSSL and the |
| 1937 | particular configuration of the crypto library in use. Internally |
| 1938 | this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl |
| 1939 | documentation for more details on the format of this option and |
| 1940 | for the ssl version supported. Actually the possible values of |
| 1941 | this option are: |
| 1942 | |
| 1943 | - sslv2 |
| 1944 | - sslv3 |
| 1945 | - tlsv1 |
| 1946 | - tlsv1.0 |
| 1947 | - tlsv1.1 |
| 1948 | - tlsv1.2 |
| 1949 | |
| 1950 | + |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1951 | Can be overridden by the `GIT_SSL_VERSION` environment variable. |
| Junio C Hamano | a1746be | 2015-08-26 23:07:07 | [diff] [blame] | 1952 | To force git to use libcurl's default ssl version and ignore any |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1953 | explicit http.sslversion option, set `GIT_SSL_VERSION` to the |
| Junio C Hamano | a1746be | 2015-08-26 23:07:07 | [diff] [blame] | 1954 | empty string. |
| 1955 | |
| Junio C Hamano | 1dbca52 | 2015-05-22 20:48:55 | [diff] [blame] | 1956 | http.sslCipherList:: |
| 1957 | A list of SSL ciphers to use when negotiating an SSL connection. |
| 1958 | The available ciphers depend on whether libcurl was built against |
| 1959 | NSS or OpenSSL and the particular configuration of the crypto |
| 1960 | library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST' |
| 1961 | option; see the libcurl documentation for more details on the format |
| 1962 | of this list. |
| 1963 | + |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1964 | Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable. |
| Junio C Hamano | 1dbca52 | 2015-05-22 20:48:55 | [diff] [blame] | 1965 | To force git to use libcurl's default cipher list and ignore any |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1966 | explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the |
| Junio C Hamano | 1dbca52 | 2015-05-22 20:48:55 | [diff] [blame] | 1967 | empty string. |
| 1968 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1969 | http.sslVerify:: |
| 1970 | Whether to verify the SSL certificate when fetching or pushing |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1971 | over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1972 | variable. |
| 1973 | |
| 1974 | http.sslCert:: |
| 1975 | File containing the SSL certificate when fetching or pushing |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1976 | over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1977 | variable. |
| 1978 | |
| 1979 | http.sslKey:: |
| 1980 | File containing the SSL private key when fetching or pushing |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1981 | over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1982 | variable. |
| 1983 | |
| Junio C Hamano | 48bc1ce | 2009-07-09 16:49:19 | [diff] [blame] | 1984 | http.sslCertPasswordProtected:: |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 1985 | Enable Git's password prompt for the SSL certificate. Otherwise |
| Junio C Hamano | 48bc1ce | 2009-07-09 16:49:19 | [diff] [blame] | 1986 | OpenSSL will prompt the user, possibly many times, if the |
| 1987 | certificate or private key is encrypted. Can be overridden by the |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1988 | `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable. |
| Junio C Hamano | 48bc1ce | 2009-07-09 16:49:19 | [diff] [blame] | 1989 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1990 | http.sslCAInfo:: |
| 1991 | File containing the certificates to verify the peer with when |
| Junio C Hamano | 341071d | 2006-06-04 07:24:48 | [diff] [blame] | 1992 | fetching or pushing over HTTPS. Can be overridden by the |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1993 | `GIT_SSL_CAINFO` environment variable. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1994 | |
| 1995 | http.sslCAPath:: |
| 1996 | Path containing files with the CA certificates to verify the peer |
| Junio C Hamano | 33db437 | 2006-06-07 19:51:45 | [diff] [blame] | 1997 | with when fetching or pushing over HTTPS. Can be overridden |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1998 | by the `GIT_SSL_CAPATH` environment variable. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 1999 | |
| Junio C Hamano | 3fcdd07 | 2016-02-24 23:41:08 | [diff] [blame] | 2000 | http.pinnedpubkey:: |
| 2001 | Public key of the https service. It may either be the filename of |
| 2002 | a PEM or DER encoded public key file or a string starting with |
| 2003 | 'sha256//' followed by the base64 encoded sha256 hash of the |
| 2004 | public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will |
| 2005 | exit with an error if this option is set but not supported by |
| 2006 | cURL. |
| 2007 | |
| Junio C Hamano | 7692782 | 2013-04-19 21:26:57 | [diff] [blame] | 2008 | http.sslTry:: |
| 2009 | Attempt to use AUTH SSL/TLS and encrypted data transfers |
| 2010 | when connecting via regular FTP protocol. This might be needed |
| 2011 | if the FTP server requires it for security reasons or you wish |
| 2012 | to connect securely whenever remote FTP server supports it. |
| 2013 | Default is false since it might trigger certificate verification |
| 2014 | errors on misconfigured servers. |
| 2015 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 2016 | http.maxRequests:: |
| Junio C Hamano | 341071d | 2006-06-04 07:24:48 | [diff] [blame] | 2017 | How many HTTP requests to launch in parallel. Can be overridden |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 2018 | by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 2019 | |
| Junio C Hamano | b141a92 | 2010-01-10 19:55:14 | [diff] [blame] | 2020 | http.minSessions:: |
| 2021 | The number of curl sessions (counted across slots) to be kept across |
| 2022 | requests. They will not be ended with curl_easy_cleanup() until |
| 2023 | http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this |
| 2024 | value will be capped at 1. Defaults to 1. |
| 2025 | |
| Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 2026 | http.postBuffer:: |
| 2027 | Maximum size in bytes of the buffer used by smart HTTP |
| 2028 | transports when POSTing data to the remote system. |
| 2029 | For requests larger than this buffer size, HTTP/1.1 and |
| 2030 | Transfer-Encoding: chunked is used to avoid creating a |
| 2031 | massive pack file locally. Default is 1 MiB, which is |
| 2032 | sufficient for most requests. |
| 2033 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 2034 | http.lowSpeedLimit, http.lowSpeedTime:: |
| 2035 | If the HTTP transfer speed is less than 'http.lowSpeedLimit' |
| 2036 | for longer than 'http.lowSpeedTime' seconds, the transfer is aborted. |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 2037 | Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and |
| 2038 | `GIT_HTTP_LOW_SPEED_TIME` environment variables. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 2039 | |
| Junio C Hamano | f1dcdfe | 2006-09-29 08:10:51 | [diff] [blame] | 2040 | http.noEPSV:: |
| 2041 | A boolean which disables using of EPSV ftp command by curl. |
| Junio C Hamano | d9e0e5d | 2007-04-14 16:22:04 | [diff] [blame] | 2042 | This can helpful with some "poor" ftp servers which don't |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 2043 | support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV` |
| Junio C Hamano | f1dcdfe | 2006-09-29 08:10:51 | [diff] [blame] | 2044 | environment variable. Default is false (curl will use EPSV). |
| 2045 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 2046 | http.userAgent:: |
| Junio C Hamano | 53ba6d0 | 2010-08-22 07:25:12 | [diff] [blame] | 2047 | The HTTP USER_AGENT string presented to an HTTP server. The default |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 2048 | 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] | 2049 | This option allows you to override this value to a more common value |
| 2050 | such as Mozilla/4.0. This may be necessary, for instance, if |
| 2051 | connecting through a firewall that restricts HTTP connections to a set |
| 2052 | of common USER_AGENT strings (but not including those like git/1.7.1). |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 2053 | Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable. |
| Junio C Hamano | 53ba6d0 | 2010-08-22 07:25:12 | [diff] [blame] | 2054 | |
| Junio C Hamano | 52b1cfb | 2016-12-20 00:18:36 | [diff] [blame] | 2055 | http.followRedirects:: |
| 2056 | Whether git should follow HTTP redirects. If set to `true`, git |
| 2057 | will transparently follow any redirect issued by a server it |
| 2058 | encounters. If set to `false`, git will treat all redirects as |
| 2059 | errors. If set to `initial`, git will follow redirects only for |
| 2060 | the initial request to a remote, but not for subsequent |
| 2061 | follow-up HTTP requests. Since git uses the redirected URL as |
| 2062 | the base for the follow-up requests, this is generally |
| 2063 | sufficient. The default is `initial`. |
| 2064 | |
| Junio C Hamano | 8eac268 | 2013-09-09 22:35:20 | [diff] [blame] | 2065 | http.<url>.*:: |
| Junio C Hamano | fb5ffde | 2014-11-04 22:38:56 | [diff] [blame] | 2066 | 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] | 2067 | For a config key to match a URL, each element of the config key is |
| 2068 | compared to that of the URL, in the following order: |
| 2069 | + |
| 2070 | -- |
| 2071 | . Scheme (e.g., `https` in `https://example.com/`). This field |
| 2072 | must match exactly between the config key and the URL. |
| 2073 | |
| 2074 | . Host/domain name (e.g., `example.com` in `https://example.com/`). |
| Junio C Hamano | cbe0eb2 | 2017-02-27 23:37:49 | [diff] [blame] | 2075 | This field must match between the config key and the URL. It is |
| 2076 | possible to specify a `*` as part of the host name to match all subdomains |
| 2077 | at this level. `https://*.example.com/` for example would match |
| 2078 | `https://foo.example.com/`, but not `https://foo.bar.example.com/`. |
| Junio C Hamano | 8eac268 | 2013-09-09 22:35:20 | [diff] [blame] | 2079 | |
| 2080 | . Port number (e.g., `8080` in `http://example.com:8080/`). |
| 2081 | This field must match exactly between the config key and the URL. |
| 2082 | Omitted port numbers are automatically converted to the correct |
| 2083 | default for the scheme before matching. |
| 2084 | |
| 2085 | . Path (e.g., `repo.git` in `https://example.com/repo.git`). The |
| 2086 | path field of the config key must match the path field of the URL |
| 2087 | either exactly or as a prefix of slash-delimited path elements. This means |
| 2088 | a config key with path `foo/` matches URL path `foo/bar`. A prefix can only |
| 2089 | match on a slash (`/`) boundary. Longer matches take precedence (so a config |
| 2090 | key with path `foo/bar` is a better match to URL path `foo/bar` than a config |
| 2091 | key with just path `foo/`). |
| 2092 | |
| 2093 | . User name (e.g., `user` in `https://user@example.com/repo.git`). If |
| 2094 | the config key has a user name it must match the user name in the |
| 2095 | URL exactly. If the config key does not have a user name, that |
| 2096 | config key will match a URL with any user name (including none), |
| 2097 | but at a lower precedence than a config key with a user name. |
| 2098 | -- |
| 2099 | + |
| 2100 | The list above is ordered by decreasing precedence; a URL that matches |
| 2101 | a config key's path is preferred to one that matches its user name. For example, |
| 2102 | if the URL is `https://user@example.com/foo/bar` a config key match of |
| 2103 | `https://example.com/foo` will be preferred over a config key match of |
| 2104 | `https://user@example.com`. |
| 2105 | + |
| 2106 | All URLs are normalized before attempting any matching (the password part, |
| 2107 | 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] | 2108 | equivalent URLs that are simply spelled differently will match properly. |
| 2109 | Environment variable settings always override any matches. The URLs that are |
| Junio C Hamano | 8eac268 | 2013-09-09 22:35:20 | [diff] [blame] | 2110 | matched against are those given directly to Git commands. This means any URLs |
| 2111 | visited as a result of a redirection do not participate in matching. |
| 2112 | |
| Junio C Hamano | cbe0eb2 | 2017-02-27 23:37:49 | [diff] [blame] | 2113 | ssh.variant:: |
| Junio C Hamano | 912712b | 2017-12-06 18:04:01 | [diff] [blame] | 2114 | By default, Git determines the command line arguments to use |
| 2115 | based on the basename of the configured SSH command (configured |
| 2116 | using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or |
| 2117 | the config setting `core.sshCommand`). If the basename is |
| 2118 | unrecognized, Git will attempt to detect support of OpenSSH |
| 2119 | options by first invoking the configured SSH command with the |
| 2120 | `-G` (print configuration) option and will subsequently use |
| 2121 | OpenSSH options (if that is successful) or no options besides |
| 2122 | the host and remote command (if it fails). |
| Junio C Hamano | cbe0eb2 | 2017-02-27 23:37:49 | [diff] [blame] | 2123 | + |
| Junio C Hamano | 912712b | 2017-12-06 18:04:01 | [diff] [blame] | 2124 | The config variable `ssh.variant` can be set to override this detection. |
| 2125 | Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`, |
| 2126 | `tortoiseplink`, `simple` (no options except the host and remote command). |
| 2127 | The default auto-detection can be explicitly requested using the value |
| 2128 | `auto`. Any other value is treated as `ssh`. This setting can also be |
| 2129 | overridden via the environment variable `GIT_SSH_VARIANT`. |
| 2130 | + |
| 2131 | The current command-line parameters used for each variant are as |
| 2132 | follows: |
| 2133 | + |
| 2134 | -- |
| 2135 | |
| 2136 | * `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command |
| 2137 | |
| 2138 | * `simple` - [username@]host command |
| 2139 | |
| 2140 | * `plink` or `putty` - [-P port] [-4] [-6] [username@]host command |
| 2141 | |
| 2142 | * `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command |
| 2143 | |
| 2144 | -- |
| 2145 | + |
| 2146 | Except for the `simple` variant, command-line parameters are likely to |
| 2147 | change as git gains new features. |
| Junio C Hamano | cbe0eb2 | 2017-02-27 23:37:49 | [diff] [blame] | 2148 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 2149 | i18n.commitEncoding:: |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 2150 | Character encoding the commit messages are stored in; Git itself |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 2151 | does not care per se, but this information is necessary e.g. when |
| 2152 | importing commits from emails or in the gitk graphical history |
| 2153 | browser (and possibly at other places in the future or in other |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 2154 | porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 2155 | |
| Junio C Hamano | 51f92e2 | 2006-12-29 05:18:28 | [diff] [blame] | 2156 | i18n.logOutputEncoding:: |
| 2157 | Character encoding the commit messages are converted to when |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 2158 | running 'git log' and friends. |
| Junio C Hamano | 51f92e2 | 2006-12-29 05:18:28 | [diff] [blame] | 2159 | |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 2160 | imap:: |
| 2161 | The configuration variables in the 'imap' section are described |
| 2162 | in linkgit:git-imap-send[1]. |
| 2163 | |
| Junio C Hamano | 81703b2 | 2014-03-14 22:00:27 | [diff] [blame] | 2164 | index.version:: |
| 2165 | Specify the version with which new index files should be |
| 2166 | initialized. This does not affect existing repositories. |
| 2167 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 2168 | init.templateDir:: |
| Junio C Hamano | caa712a | 2010-03-11 01:17:35 | [diff] [blame] | 2169 | Specify the directory from which templates will be copied. |
| 2170 | (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].) |
| 2171 | |
| Junio C Hamano | 4e27231 | 2008-01-08 09:13:21 | [diff] [blame] | 2172 | instaweb.browser:: |
| 2173 | Specify the program that will be used to browse your working |
| 2174 | repository in gitweb. See linkgit:git-instaweb[1]. |
| 2175 | |
| 2176 | instaweb.httpd:: |
| 2177 | The HTTP daemon command-line to start gitweb on your working |
| 2178 | repository. See linkgit:git-instaweb[1]. |
| 2179 | |
| 2180 | instaweb.local:: |
| 2181 | If true the web server started by linkgit:git-instaweb[1] will |
| 2182 | be bound to the local IP (127.0.0.1). |
| 2183 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 2184 | instaweb.modulePath:: |
| Junio C Hamano | 619596a | 2010-08-18 22:15:35 | [diff] [blame] | 2185 | The default module path for linkgit:git-instaweb[1] to use |
| 2186 | instead of /usr/lib/apache2/modules. Only used if httpd |
| 2187 | is Apache. |
| Junio C Hamano | 4e27231 | 2008-01-08 09:13:21 | [diff] [blame] | 2188 | |
| 2189 | instaweb.port:: |
| 2190 | The port number to bind the gitweb httpd to. See |
| 2191 | linkgit:git-instaweb[1]. |
| 2192 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 2193 | interactive.singleKey:: |
| Junio C Hamano | 27a128b | 2009-08-13 01:23:00 | [diff] [blame] | 2194 | In interactive commands, allow the user to provide one-letter |
| Junio C Hamano | e5bf6c1 | 2009-02-07 21:43:10 | [diff] [blame] | 2195 | input with a single key (i.e., without hitting enter). |
| Junio C Hamano | b76a686 | 2012-05-02 22:02:46 | [diff] [blame] | 2196 | Currently this is used by the `--patch` mode of |
| Junio C Hamano | 3d050d6 | 2011-05-17 06:43:34 | [diff] [blame] | 2197 | linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1], |
| 2198 | linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this |
| 2199 | setting is silently ignored if portable keystroke input |
| Junio C Hamano | 81703b2 | 2014-03-14 22:00:27 | [diff] [blame] | 2200 | is not available; requires the Perl module Term::ReadKey. |
| Junio C Hamano | e5bf6c1 | 2009-02-07 21:43:10 | [diff] [blame] | 2201 | |
| Junio C Hamano | 4ba4a78 | 2016-04-03 19:11:32 | [diff] [blame] | 2202 | interactive.diffFilter:: |
| 2203 | When an interactive command (such as `git add --patch`) shows |
| 2204 | a colorized diff, git will pipe the diff through the shell |
| 2205 | command defined by this configuration variable. The command may |
| 2206 | mark up the diff further for human consumption, provided that it |
| 2207 | retains a one-to-one correspondence with the lines in the |
| 2208 | original diff. Defaults to disabled (no filtering). |
| 2209 | |
| Junio C Hamano | f93530e | 2011-05-25 23:59:59 | [diff] [blame] | 2210 | log.abbrevCommit:: |
| 2211 | If true, makes linkgit:git-log[1], linkgit:git-show[1], and |
| Junio C Hamano | b76a686 | 2012-05-02 22:02:46 | [diff] [blame] | 2212 | linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may |
| 2213 | override this option with `--no-abbrev-commit`. |
| Junio C Hamano | f93530e | 2011-05-25 23:59:59 | [diff] [blame] | 2214 | |
| Junio C Hamano | b713ff1 | 2008-05-24 01:12:30 | [diff] [blame] | 2215 | log.date:: |
| Junio C Hamano | 2db3e75 | 2010-09-03 21:33:06 | [diff] [blame] | 2216 | Set the default date-time mode for the 'log' command. |
| 2217 | Setting a value for log.date is similar to using 'git log''s |
| Junio C Hamano | 1eb5609 | 2015-10-05 20:39:53 | [diff] [blame] | 2218 | `--date` option. See linkgit:git-log[1] for details. |
| Junio C Hamano | b713ff1 | 2008-05-24 01:12:30 | [diff] [blame] | 2219 | |
| Junio C Hamano | cb39aea | 2010-05-09 07:24:48 | [diff] [blame] | 2220 | log.decorate:: |
| 2221 | Print out the ref names of any commits that are shown by the log |
| 2222 | command. If 'short' is specified, the ref name prefixes 'refs/heads/', |
| 2223 | 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is |
| 2224 | specified, the full ref name (including prefix) will be printed. |
| Junio C Hamano | 37cf408 | 2016-05-30 01:22:14 | [diff] [blame] | 2225 | If 'auto' is specified, then if the output is going to a terminal, |
| 2226 | the ref names are shown as if 'short' were given, otherwise no ref |
| Junio C Hamano | 92d8037 | 2016-07-13 22:00:05 | [diff] [blame] | 2227 | names are shown. This is the same as the `--decorate` option |
| Junio C Hamano | 37cf408 | 2016-05-30 01:22:14 | [diff] [blame] | 2228 | of the `git log`. |
| Junio C Hamano | cb39aea | 2010-05-09 07:24:48 | [diff] [blame] | 2229 | |
| Junio C Hamano | b0a1e83 | 2015-10-15 23:08:31 | [diff] [blame] | 2230 | log.follow:: |
| 2231 | If `true`, `git log` will act as if the `--follow` option was used when |
| 2232 | a single <path> is given. This has the same limitations as `--follow`, |
| 2233 | i.e. it cannot be used to follow multiple files and does not work well |
| 2234 | on non-linear history. |
| 2235 | |
| Junio C Hamano | b86c803 | 2017-02-02 21:50:19 | [diff] [blame] | 2236 | log.graphColors:: |
| 2237 | A list of colors, separated by commas, that can be used to draw |
| 2238 | history lines in `git log --graph`. |
| 2239 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 2240 | log.showRoot:: |
| Junio C Hamano | fe9acab | 2006-11-24 12:10:55 | [diff] [blame] | 2241 | If true, the initial commit will be shown as a big creation event. |
| 2242 | This is equivalent to a diff against an empty tree. |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 2243 | Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which |
| Junio C Hamano | fe9acab | 2006-11-24 12:10:55 | [diff] [blame] | 2244 | normally hide the root commit will now show it. True by default. |
| 2245 | |
| Junio C Hamano | 6b6144f | 2017-05-29 06:20:15 | [diff] [blame] | 2246 | log.showSignature:: |
| 2247 | If true, makes linkgit:git-log[1], linkgit:git-show[1], and |
| 2248 | linkgit:git-whatchanged[1] assume `--show-signature`. |
| 2249 | |
| Junio C Hamano | ce836cc | 2013-01-21 02:01:53 | [diff] [blame] | 2250 | log.mailmap:: |
| 2251 | If true, makes linkgit:git-log[1], linkgit:git-show[1], and |
| 2252 | linkgit:git-whatchanged[1] assume `--use-mailmap`. |
| 2253 | |
| Junio C Hamano | 7f1bc9d | 2015-03-05 22:38:26 | [diff] [blame] | 2254 | mailinfo.scissors:: |
| 2255 | If true, makes linkgit:git-mailinfo[1] (and therefore |
| 2256 | linkgit:git-am[1]) act by default as if the --scissors option |
| 2257 | was provided on the command-line. When active, this features |
| 2258 | removes everything from the message body before a scissors |
| 2259 | line (i.e. consisting mainly of ">8", "8<" and "-"). |
| 2260 | |
| Junio C Hamano | 8bc410e | 2009-02-15 10:38:19 | [diff] [blame] | 2261 | mailmap.file:: |
| 2262 | The location of an augmenting mailmap file. The default |
| 2263 | mailmap, located in the root of the repository, is loaded |
| 2264 | first, then the mailmap file pointed to by this variable. |
| 2265 | The location of the mailmap file may be in a repository |
| 2266 | subdirectory, or somewhere outside of the repository itself. |
| 2267 | See linkgit:git-shortlog[1] and linkgit:git-blame[1]. |
| 2268 | |
| Junio C Hamano | abad6da | 2013-01-06 09:06:32 | [diff] [blame] | 2269 | mailmap.blob:: |
| 2270 | Like `mailmap.file`, but consider the value as a reference to a |
| 2271 | blob in the repository. If both `mailmap.file` and |
| 2272 | `mailmap.blob` are given, both are parsed, with entries from |
| 2273 | `mailmap.file` taking precedence. In a bare repository, this |
| 2274 | defaults to `HEAD:.mailmap`. In a non-bare repository, it |
| 2275 | defaults to empty. |
| 2276 | |
| Junio C Hamano | 8b588d5 | 2008-03-15 09:48:37 | [diff] [blame] | 2277 | man.viewer:: |
| 2278 | Specify the programs that may be used to display help in the |
| 2279 | 'man' format. See linkgit:git-help[1]. |
| 2280 | |
| Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 2281 | man.<tool>.cmd:: |
| 2282 | Specify the command to invoke the specified man viewer. The |
| 2283 | specified command is evaluated in shell with the man page |
| 2284 | passed as argument. (See linkgit:git-help[1].) |
| Junio C Hamano | 103ad7f | 2007-03-14 11:19:26 | [diff] [blame] | 2285 | |
| Junio C Hamano | 6d76d61 | 2008-05-09 05:46:08 | [diff] [blame] | 2286 | man.<tool>.path:: |
| 2287 | Override the path for the given tool that may be used to |
| 2288 | display help in the 'man' format. See linkgit:git-help[1]. |
| Junio C Hamano | e90436a | 2007-04-22 07:22:13 | [diff] [blame] | 2289 | |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 2290 | include::merge-config.txt[] |
| Junio C Hamano | a476efa | 2008-10-10 15:31:42 | [diff] [blame] | 2291 | |
| Junio C Hamano | 1fbbbc1 | 2007-12-18 07:01:27 | [diff] [blame] | 2292 | mergetool.<tool>.path:: |
| 2293 | Override the path for the given tool. This is useful in case |
| 2294 | your tool is not in the PATH. |
| 2295 | |
| Junio C Hamano | 86bcccc | 2008-03-08 09:33:55 | [diff] [blame] | 2296 | mergetool.<tool>.cmd:: |
| 2297 | Specify the command to invoke the specified merge tool. The |
| 2298 | specified command is evaluated in shell with the following |
| 2299 | variables available: 'BASE' is the name of a temporary file |
| 2300 | containing the common base of the files to be merged, if available; |
| 2301 | 'LOCAL' is the name of a temporary file containing the contents of |
| 2302 | the file on the current branch; 'REMOTE' is the name of a temporary |
| 2303 | file containing the contents of the file from the branch being |
| 2304 | merged; 'MERGED' contains the name of the file to which the merge |
| 2305 | tool should write the results of a successful merge. |
| 2306 | |
| 2307 | mergetool.<tool>.trustExitCode:: |
| 2308 | For a custom merge command, specify whether the exit code of |
| 2309 | the merge command can be used to determine whether the merge was |
| 2310 | successful. If this is not set to true then the merge target file |
| 2311 | timestamp is checked and the merge assumed to have been successful |
| 2312 | if the file has been updated, otherwise the user is prompted to |
| 2313 | indicate the success of the merge. |
| 2314 | |
| Junio C Hamano | e478e40 | 2014-10-21 22:14:45 | [diff] [blame] | 2315 | mergetool.meld.hasOutput:: |
| 2316 | Older versions of `meld` do not support the `--output` option. |
| 2317 | Git will attempt to detect whether `meld` supports `--output` |
| 2318 | by inspecting the output of `meld --help`. Configuring |
| 2319 | `mergetool.meld.hasOutput` will make Git skip these checks and |
| 2320 | use the configured value instead. Setting `mergetool.meld.hasOutput` |
| 2321 | to `true` tells Git to unconditionally use the `--output` option, |
| 2322 | and `false` avoids using `--output`. |
| 2323 | |
| Junio C Hamano | 86bcccc | 2008-03-08 09:33:55 | [diff] [blame] | 2324 | mergetool.keepBackup:: |
| 2325 | After performing a merge, the original file with conflict markers |
| 2326 | can be saved as a file with a `.orig` extension. If this variable |
| 2327 | is set to `false` then this file is not preserved. Defaults to |
| 2328 | `true` (i.e. keep the backup files). |
| 2329 | |
| Junio C Hamano | 10b7a34 | 2009-01-01 22:05:17 | [diff] [blame] | 2330 | mergetool.keepTemporaries:: |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 2331 | When invoking a custom merge tool, Git uses a set of temporary |
| Junio C Hamano | 10b7a34 | 2009-01-01 22:05:17 | [diff] [blame] | 2332 | files to pass to the tool. If the tool returns an error and this |
| 2333 | variable is set to `true`, then these temporary files will be |
| 2334 | preserved, otherwise they will be removed after the tool has |
| 2335 | exited. Defaults to `false`. |
| 2336 | |
| Junio C Hamano | e478e40 | 2014-10-21 22:14:45 | [diff] [blame] | 2337 | mergetool.writeToTemp:: |
| 2338 | Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of |
| 2339 | conflicting files in the worktree by default. Git will attempt |
| 2340 | to use a temporary directory for these files when set `true`. |
| 2341 | Defaults to `false`. |
| 2342 | |
| Junio C Hamano | 10b7a34 | 2009-01-01 22:05:17 | [diff] [blame] | 2343 | mergetool.prompt:: |
| 2344 | Prompt before each invocation of the merge resolution program. |
| 2345 | |
| Junio C Hamano | 3891e25 | 2015-08-31 23:06:13 | [diff] [blame] | 2346 | notes.mergeStrategy:: |
| 2347 | Which merge strategy to choose by default when resolving notes |
| 2348 | conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or |
| 2349 | `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES" |
| 2350 | section of linkgit:git-notes[1] for more information on each strategy. |
| 2351 | |
| 2352 | notes.<name>.mergeStrategy:: |
| 2353 | Which merge strategy to choose when doing a notes merge into |
| 2354 | refs/notes/<name>. This overrides the more general |
| 2355 | "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in |
| 2356 | linkgit:git-notes[1] for more information on the available strategies. |
| 2357 | |
| Junio C Hamano | 3166736 | 2010-03-25 00:38:53 | [diff] [blame] | 2358 | notes.displayRef:: |
| 2359 | The (fully qualified) refname from which to show notes when |
| 2360 | showing commit messages. The value of this variable can be set |
| 2361 | to a glob, in which case notes from all matching refs will be |
| 2362 | shown. You may also specify this configuration variable |
| 2363 | several times. A warning will be issued for refs that do not |
| 2364 | exist, but a glob that does not match any refs is silently |
| 2365 | ignored. |
| 2366 | + |
| 2367 | This setting can be overridden with the `GIT_NOTES_DISPLAY_REF` |
| 2368 | environment variable, which must be a colon separated list of refs or |
| 2369 | globs. |
| 2370 | + |
| 2371 | The effective value of "core.notesRef" (possibly overridden by |
| 2372 | GIT_NOTES_REF) is also implicitly added to the list of refs to be |
| 2373 | displayed. |
| 2374 | |
| 2375 | notes.rewrite.<command>:: |
| 2376 | When rewriting commits with <command> (currently `amend` or |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 2377 | `rebase`) and this variable is set to `true`, Git |
| Junio C Hamano | 3166736 | 2010-03-25 00:38:53 | [diff] [blame] | 2378 | automatically copies your notes from the original to the |
| 2379 | rewritten commit. Defaults to `true`, but see |
| 2380 | "notes.rewriteRef" below. |
| Junio C Hamano | 3166736 | 2010-03-25 00:38:53 | [diff] [blame] | 2381 | |
| 2382 | notes.rewriteMode:: |
| 2383 | When copying notes during a rewrite (see the |
| 2384 | "notes.rewrite.<command>" option), determines what to do if |
| 2385 | the target commit already has a note. Must be one of |
| Junio C Hamano | 3891e25 | 2015-08-31 23:06:13 | [diff] [blame] | 2386 | `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`. |
| 2387 | Defaults to `concatenate`. |
| Junio C Hamano | 3166736 | 2010-03-25 00:38:53 | [diff] [blame] | 2388 | + |
| 2389 | This setting can be overridden with the `GIT_NOTES_REWRITE_MODE` |
| 2390 | environment variable. |
| 2391 | |
| 2392 | notes.rewriteRef:: |
| 2393 | When copying notes during a rewrite, specifies the (fully |
| 2394 | qualified) ref whose notes should be copied. The ref may be a |
| 2395 | glob, in which case notes in all matching refs will be copied. |
| 2396 | You may also specify this configuration several times. |
| 2397 | + |
| 2398 | Does not have a default value; you must configure this variable to |
| Junio C Hamano | 8fb66e5 | 2011-10-05 20:59:51 | [diff] [blame] | 2399 | enable note rewriting. Set it to `refs/notes/commits` to enable |
| 2400 | rewriting for the default commit notes. |
| Junio C Hamano | 2b3ee5d | 2010-05-08 05:41:18 | [diff] [blame] | 2401 | + |
| 2402 | This setting can be overridden with the `GIT_NOTES_REWRITE_REF` |
| 2403 | environment variable, which must be a colon separated list of refs or |
| 2404 | globs. |
| Junio C Hamano | 3166736 | 2010-03-25 00:38:53 | [diff] [blame] | 2405 | |
| Junio C Hamano | 75cc4c9 | 2006-07-24 08:25:03 | [diff] [blame] | 2406 | pack.window:: |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 2407 | 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] | 2408 | window size is given on the command line. Defaults to 10. |
| 2409 | |
| Junio C Hamano | 91d44c5 | 2007-05-09 07:16:07 | [diff] [blame] | 2410 | pack.depth:: |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 2411 | 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] | 2412 | maximum depth is given on the command line. Defaults to 50. |
| 2413 | |
| Junio C Hamano | 235d53f | 2007-07-13 00:25:15 | [diff] [blame] | 2414 | pack.windowMemory:: |
| Junio C Hamano | 2a4bcbc | 2014-10-29 20:07:39 | [diff] [blame] | 2415 | The maximum size of memory that is consumed by each thread |
| 2416 | in linkgit:git-pack-objects[1] for pack window memory when |
| 2417 | no limit is given on the command line. The value can be |
| 2418 | suffixed with "k", "m", or "g". When left unconfigured (or |
| 2419 | set explicitly to 0), there will be no limit. |
| Junio C Hamano | 235d53f | 2007-07-13 00:25:15 | [diff] [blame] | 2420 | |
| Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 2421 | pack.compression:: |
| 2422 | An integer -1..9, indicating the compression level for objects |
| 2423 | in a pack file. -1 is the zlib default. 0 means no |
| 2424 | compression, and 1..9 are various speed/size tradeoffs, 9 being |
| 2425 | slowest. If not set, defaults to core.compression. If that is |
| Junio C Hamano | 2e72a94 | 2007-11-21 08:54:42 | [diff] [blame] | 2426 | not set, defaults to -1, the zlib default, which is "a default |
| 2427 | compromise between speed and compression (currently equivalent |
| 2428 | to level 6)." |
| Junio C Hamano | 657fd8a | 2010-10-07 00:01:24 | [diff] [blame] | 2429 | + |
| 2430 | Note that changing the compression level will not automatically recompress |
| 2431 | all existing objects. You can force recompression by passing the -F option |
| 2432 | to linkgit:git-repack[1]. |
| Junio C Hamano | f2ce297 | 2007-05-20 19:12:09 | [diff] [blame] | 2433 | |
| Junio C Hamano | 679d22d | 2007-06-02 21:13:44 | [diff] [blame] | 2434 | pack.deltaCacheSize:: |
| Junio C Hamano | a638742 | 2007-08-25 03:54:27 | [diff] [blame] | 2435 | The maximum memory in bytes used for caching deltas in |
| Junio C Hamano | 9f88386 | 2009-08-11 06:23:52 | [diff] [blame] | 2436 | linkgit:git-pack-objects[1] before writing them out to a pack. |
| 2437 | This cache is used to speed up the writing object phase by not |
| 2438 | having to recompute the final delta result once the best match |
| 2439 | for all objects is found. Repacking large repositories on machines |
| 2440 | which are tight with memory might be badly impacted by this though, |
| 2441 | especially if this cache pushes the system into swapping. |
| 2442 | A value of 0 means no limit. The smallest size of 1 byte may be |
| 2443 | used to virtually disable this cache. Defaults to 256 MiB. |
| Junio C Hamano | 679d22d | 2007-06-02 21:13:44 | [diff] [blame] | 2444 | |
| 2445 | pack.deltaCacheLimit:: |
| Junio C Hamano | 58155b4 | 2007-09-15 07:46:14 | [diff] [blame] | 2446 | The maximum size of a delta, that is cached in |
| Junio C Hamano | 9f88386 | 2009-08-11 06:23:52 | [diff] [blame] | 2447 | linkgit:git-pack-objects[1]. This cache is used to speed up the |
| 2448 | writing object phase by not having to recompute the final delta |
| 2449 | 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] | 2450 | |
| Junio C Hamano | 58155b4 | 2007-09-15 07:46:14 | [diff] [blame] | 2451 | pack.threads:: |
| 2452 | Specifies the number of threads to spawn when searching for best |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 2453 | delta matches. This requires that linkgit:git-pack-objects[1] |
| Junio C Hamano | 58155b4 | 2007-09-15 07:46:14 | [diff] [blame] | 2454 | be compiled with pthreads otherwise this option is ignored with a |
| 2455 | warning. This is meant to reduce packing time on multiprocessor |
| 2456 | machines. The required amount of memory for the delta search window |
| 2457 | is however multiplied by the number of threads. |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 2458 | 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] | 2459 | and set the number of threads accordingly. |
| Junio C Hamano | 58155b4 | 2007-09-15 07:46:14 | [diff] [blame] | 2460 | |
| Junio C Hamano | d814b6d | 2007-11-04 11:13:49 | [diff] [blame] | 2461 | pack.indexVersion:: |
| 2462 | Specify the default pack index version. Valid values are 1 for |
| 2463 | legacy pack index used by Git versions prior to 1.5.2, and 2 for |
| 2464 | the new pack index with capabilities for packs larger than 4 GB |
| 2465 | as well as proper protection against the repacking of corrupted |
| Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame] | 2466 | packs. Version 2 is the default. Note that version 2 is enforced |
| 2467 | and this config option ignored whenever the corresponding pack is |
| 2468 | larger than 2 GB. |
| 2469 | + |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 2470 | If you have an old Git that does not understand the version 2 `*.idx` file, |
| Junio C Hamano | f85ef63 | 2016-02-17 22:31:06 | [diff] [blame] | 2471 | cloning or fetching over a non native protocol (e.g. "http") |
| Junio C Hamano | b76a686 | 2012-05-02 22:02:46 | [diff] [blame] | 2472 | that will copy both `*.pack` file and corresponding `*.idx` file from the |
| Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame] | 2473 | 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] | 2474 | 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] | 2475 | 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] | 2476 | the `*.idx` file. |
| Junio C Hamano | d814b6d | 2007-11-04 11:13:49 | [diff] [blame] | 2477 | |
| Junio C Hamano | 09a926d | 2008-03-13 07:55:29 | [diff] [blame] | 2478 | pack.packSizeLimit:: |
| Junio C Hamano | 4d97958 | 2010-02-04 06:27:29 | [diff] [blame] | 2479 | The maximum size of a pack. This setting only affects |
| 2480 | packing to a file when repacking, i.e. the git:// protocol |
| Junio C Hamano | b76a686 | 2012-05-02 22:02:46 | [diff] [blame] | 2481 | is unaffected. It can be overridden by the `--max-pack-size` |
| Junio C Hamano | 74fd0fc | 2016-05-10 21:23:56 | [diff] [blame] | 2482 | option of linkgit:git-repack[1]. Reaching this limit results |
| 2483 | in the creation of multiple packfiles; which in turn prevents |
| 2484 | bitmaps from being created. |
| 2485 | The minimum size allowed is limited to 1 MiB. |
| 2486 | The default is unlimited. |
| Junio C Hamano | 4d97958 | 2010-02-04 06:27:29 | [diff] [blame] | 2487 | Common unit suffixes of 'k', 'm', or 'g' are |
| 2488 | supported. |
| Junio C Hamano | 49dccaf | 2008-02-10 10:48:01 | [diff] [blame] | 2489 | |
| Junio C Hamano | 5b3533d | 2014-02-27 23:07:15 | [diff] [blame] | 2490 | pack.useBitmaps:: |
| 2491 | When true, git will use pack bitmaps (if available) when packing |
| 2492 | to stdout (e.g., during the server side of a fetch). Defaults to |
| 2493 | true. You should not generally need to turn this off unless |
| 2494 | you are debugging pack bitmaps. |
| 2495 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 2496 | pack.writeBitmaps (deprecated):: |
| Junio C Hamano | 38d0253 | 2014-06-26 21:48:50 | [diff] [blame] | 2497 | This is a deprecated synonym for `repack.writeBitmaps`. |
| Junio C Hamano | 5b3533d | 2014-02-27 23:07:15 | [diff] [blame] | 2498 | |
| 2499 | pack.writeBitmapHashCache:: |
| 2500 | When true, git will include a "hash cache" section in the bitmap |
| 2501 | index (if one is written). This cache can be used to feed git's |
| 2502 | delta heuristics, potentially leading to better deltas between |
| 2503 | bitmapped and non-bitmapped objects (e.g., when serving a fetch |
| 2504 | between an older, bitmapped pack and objects that have been |
| 2505 | pushed since the last gc). The downside is that it consumes 4 |
| 2506 | bytes per object of disk space, and that JGit's bitmap |
| 2507 | implementation does not understand it, causing it to complain if |
| 2508 | Git and JGit are used on the same repository. Defaults to false. |
| 2509 | |
| Junio C Hamano | 9e96a1a | 2008-08-16 10:23:18 | [diff] [blame] | 2510 | pager.<cmd>:: |
| Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 2511 | If the value is boolean, turns on or off pagination of the |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 2512 | output of a particular Git subcommand when writing to a tty. |
| Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 2513 | Otherwise, turns on pagination for the subcommand using the |
| Junio C Hamano | b76a686 | 2012-05-02 22:02:46 | [diff] [blame] | 2514 | pager specified by the value of `pager.<cmd>`. If `--paginate` |
| 2515 | or `--no-pager` is specified on the command line, it takes |
| Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 2516 | precedence over this option. To disable pagination for all |
| 2517 | commands, set `core.pager` or `GIT_PAGER` to `cat`. |
| Junio C Hamano | 9e96a1a | 2008-08-16 10:23:18 | [diff] [blame] | 2518 | |
| Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 2519 | pretty.<name>:: |
| 2520 | Alias for a --pretty= format string, as specified in |
| 2521 | linkgit:git-log[1]. Any aliases defined here can be used just |
| 2522 | as the built-in pretty formats could. For example, |
| Junio C Hamano | b76a686 | 2012-05-02 22:02:46 | [diff] [blame] | 2523 | running `git config pretty.changelog "format:* %H %s"` |
| Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 2524 | would cause the invocation `git log --pretty=changelog` |
| Junio C Hamano | b76a686 | 2012-05-02 22:02:46 | [diff] [blame] | 2525 | to be equivalent to running `git log "--pretty=format:* %H %s"`. |
| Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 2526 | Note that an alias with the same name as a built-in format |
| 2527 | will be silently ignored. |
| 2528 | |
| Junio C Hamano | 9e35abf | 2016-12-27 22:37:27 | [diff] [blame] | 2529 | protocol.allow:: |
| 2530 | If set, provide a user defined default policy for all protocols which |
| 2531 | don't explicitly have a policy (`protocol.<name>.allow`). By default, |
| 2532 | if unset, known-safe protocols (http, https, git, ssh, file) have a |
| 2533 | default policy of `always`, known-dangerous protocols (ext) have a |
| 2534 | default policy of `never`, and all other protocols have a default |
| 2535 | policy of `user`. Supported policies: |
| 2536 | + |
| 2537 | -- |
| 2538 | |
| 2539 | * `always` - protocol is always able to be used. |
| 2540 | |
| 2541 | * `never` - protocol is never able to be used. |
| 2542 | |
| 2543 | * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is |
| 2544 | either unset or has a value of 1. This policy should be used when you want a |
| 2545 | protocol to be directly usable by the user but don't want it used by commands which |
| 2546 | execute clone/fetch/push commands without user input, e.g. recursive |
| 2547 | submodule initialization. |
| 2548 | |
| 2549 | -- |
| 2550 | |
| 2551 | protocol.<name>.allow:: |
| 2552 | Set a policy to be used by protocol `<name>` with clone/fetch/push |
| 2553 | commands. See `protocol.allow` above for the available policies. |
| 2554 | + |
| 2555 | The protocol names currently used by git are: |
| 2556 | + |
| 2557 | -- |
| 2558 | - `file`: any local file-based path (including `file://` URLs, |
| 2559 | or local paths) |
| 2560 | |
| 2561 | - `git`: the anonymous git protocol over a direct TCP |
| 2562 | connection (or proxy, if configured) |
| 2563 | |
| 2564 | - `ssh`: git over ssh (including `host:path` syntax, |
| 2565 | `ssh://`, etc). |
| 2566 | |
| 2567 | - `http`: git over http, both "smart http" and "dumb http". |
| 2568 | Note that this does _not_ include `https`; if you want to configure |
| 2569 | both, you must do so individually. |
| 2570 | |
| 2571 | - any external helpers are named by their protocol (e.g., use |
| 2572 | `hg` to allow the `git-remote-hg` helper) |
| 2573 | -- |
| 2574 | |
| Junio C Hamano | 912712b | 2017-12-06 18:04:01 | [diff] [blame] | 2575 | protocol.version:: |
| 2576 | Experimental. If set, clients will attempt to communicate with a |
| 2577 | server using the specified protocol version. If unset, no |
| 2578 | attempt will be made by the client to communicate using a |
| 2579 | particular protocol version, this results in protocol version 0 |
| 2580 | being used. |
| 2581 | Supported versions: |
| 2582 | + |
| 2583 | -- |
| 2584 | |
| 2585 | * `0` - the original wire protocol. |
| 2586 | |
| 2587 | * `1` - the original wire protocol with the addition of a version string |
| 2588 | in the initial response from the server. |
| 2589 | |
| 2590 | -- |
| 2591 | |
| Junio C Hamano | 5b3533d | 2014-02-27 23:07:15 | [diff] [blame] | 2592 | pull.ff:: |
| 2593 | By default, Git does not create an extra merge commit when merging |
| 2594 | a commit that is a descendant of the current commit. Instead, the |
| 2595 | tip of the current branch is fast-forwarded. When set to `false`, |
| 2596 | this variable tells Git to create an extra merge commit in such |
| 2597 | a case (equivalent to giving the `--no-ff` option from the command |
| 2598 | line). When set to `only`, only such fast-forward merges are |
| 2599 | allowed (equivalent to giving the `--ff-only` option from the |
| Junio C Hamano | c4e2a20 | 2015-05-26 21:38:47 | [diff] [blame] | 2600 | command line). This setting overrides `merge.ff` when pulling. |
| Junio C Hamano | 5b3533d | 2014-02-27 23:07:15 | [diff] [blame] | 2601 | |
| Junio C Hamano | 515ab1d | 2011-12-09 23:41:20 | [diff] [blame] | 2602 | pull.rebase:: |
| 2603 | When true, rebase branches on top of the fetched branch, instead |
| 2604 | of merging the default branch from the default remote when "git |
| 2605 | pull" is run. See "branch.<name>.rebase" for setting this on a |
| 2606 | per-branch basis. |
| 2607 | + |
| Junio C Hamano | 7db630e | 2015-09-17 20:26:22 | [diff] [blame] | 2608 | When preserve, also pass `--preserve-merges` along to 'git rebase' |
| 2609 | so that locally committed merge commits will not be flattened |
| 2610 | by running 'git pull'. |
| Junio C Hamano | cf4a174 | 2013-09-11 22:57:50 | [diff] [blame] | 2611 | + |
| Junio C Hamano | 289d7e8 | 2016-01-27 00:20:38 | [diff] [blame] | 2612 | When the value is `interactive`, the rebase is run in interactive mode. |
| 2613 | + |
| Junio C Hamano | 515ab1d | 2011-12-09 23:41:20 | [diff] [blame] | 2614 | *NOTE*: this is a possibly dangerous operation; do *not* use |
| 2615 | it unless you understand the implications (see linkgit:git-rebase[1] |
| 2616 | for details). |
| 2617 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 2618 | pull.octopus:: |
| 2619 | The default merge strategy to use when pulling multiple branches |
| 2620 | at once. |
| 2621 | |
| 2622 | pull.twohead:: |
| 2623 | The default merge strategy to use when pulling a single branch. |
| 2624 | |
| Junio C Hamano | 1de7572 | 2009-03-26 08:39:38 | [diff] [blame] | 2625 | push.default:: |
| Junio C Hamano | 5865559 | 2013-07-11 20:52:33 | [diff] [blame] | 2626 | Defines the action `git push` should take if no refspec is |
| 2627 | explicitly given. Different values are well-suited for |
| 2628 | specific workflows; for instance, in a purely central workflow |
| 2629 | (i.e. the fetch source is equal to the push destination), |
| 2630 | `upstream` is probably what you want. Possible values are: |
| Junio C Hamano | 1de7572 | 2009-03-26 08:39:38 | [diff] [blame] | 2631 | + |
| Junio C Hamano | bcaa8bc | 2012-07-03 22:17:20 | [diff] [blame] | 2632 | -- |
| Junio C Hamano | 5865559 | 2013-07-11 20:52:33 | [diff] [blame] | 2633 | |
| 2634 | * `nothing` - do not push anything (error out) unless a refspec is |
| 2635 | explicitly given. This is primarily meant for people who want to |
| 2636 | avoid mistakes by always being explicit. |
| 2637 | |
| 2638 | * `current` - push the current branch to update a branch with the same |
| 2639 | name on the receiving end. Works in both central and non-central |
| 2640 | workflows. |
| 2641 | |
| 2642 | * `upstream` - push the current branch back to the branch whose |
| 2643 | changes are usually integrated into the current branch (which is |
| 2644 | called `@{upstream}`). This mode only makes sense if you are |
| 2645 | pushing to the same repository you would normally pull from |
| 2646 | (i.e. central workflow). |
| 2647 | |
| Junio C Hamano | cb06ef9 | 2017-03-21 22:40:14 | [diff] [blame] | 2648 | * `tracking` - This is a deprecated synonym for `upstream`. |
| 2649 | |
| Junio C Hamano | 5865559 | 2013-07-11 20:52:33 | [diff] [blame] | 2650 | * `simple` - in centralized workflow, work like `upstream` with an |
| 2651 | added safety to refuse to push if the upstream branch's name is |
| 2652 | different from the local one. |
| Junio C Hamano | bcaa8bc | 2012-07-03 22:17:20 | [diff] [blame] | 2653 | + |
| Junio C Hamano | 5865559 | 2013-07-11 20:52:33 | [diff] [blame] | 2654 | When pushing to a remote that is different from the remote you normally |
| 2655 | pull from, work as `current`. This is the safest option and is suited |
| 2656 | for beginners. |
| 2657 | + |
| Junio C Hamano | 1d669b8 | 2014-03-11 21:36:00 | [diff] [blame] | 2658 | This mode has become the default in Git 2.0. |
| Junio C Hamano | 5865559 | 2013-07-11 20:52:33 | [diff] [blame] | 2659 | |
| 2660 | * `matching` - push all branches having the same name on both ends. |
| 2661 | This makes the repository you are pushing to remember the set of |
| 2662 | branches that will be pushed out (e.g. if you always push 'maint' |
| 2663 | and 'master' there and no other branches, the repository you push |
| 2664 | to will have these two branches, and your local 'maint' and |
| 2665 | 'master' will be pushed there). |
| 2666 | + |
| 2667 | To use this mode effectively, you have to make sure _all_ the |
| 2668 | branches you would push out are ready to be pushed out before |
| 2669 | running 'git push', as the whole point of this mode is to allow you |
| 2670 | to push all of the branches in one go. If you usually finish work |
| 2671 | on only one branch and push out the result, while other branches are |
| 2672 | unfinished, this mode is not for you. Also this mode is not |
| 2673 | suitable for pushing into a shared central repository, as other |
| 2674 | people may add new branches there, or update the tip of existing |
| 2675 | branches outside your control. |
| 2676 | + |
| Junio C Hamano | 1d669b8 | 2014-03-11 21:36:00 | [diff] [blame] | 2677 | This used to be the default, but not since Git 2.0 (`simple` is the |
| 2678 | new default). |
| Junio C Hamano | 5865559 | 2013-07-11 20:52:33 | [diff] [blame] | 2679 | |
| 2680 | -- |
| Junio C Hamano | 1de7572 | 2009-03-26 08:39:38 | [diff] [blame] | 2681 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 2682 | push.followTags:: |
| Junio C Hamano | 92d8037 | 2016-07-13 22:00:05 | [diff] [blame] | 2683 | If set to true enable `--follow-tags` option by default. You |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 2684 | may override this configuration at time of push by specifying |
| Junio C Hamano | 92d8037 | 2016-07-13 22:00:05 | [diff] [blame] | 2685 | `--no-follow-tags`. |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 2686 | |
| Junio C Hamano | 3891e25 | 2015-08-31 23:06:13 | [diff] [blame] | 2687 | push.gpgSign:: |
| 2688 | May be set to a boolean value, or the string 'if-asked'. A true |
| Junio C Hamano | 92d8037 | 2016-07-13 22:00:05 | [diff] [blame] | 2689 | value causes all pushes to be GPG signed, as if `--signed` is |
| Junio C Hamano | 3891e25 | 2015-08-31 23:06:13 | [diff] [blame] | 2690 | passed to linkgit:git-push[1]. The string 'if-asked' causes |
| 2691 | pushes to be signed if the server supports it, as if |
| Junio C Hamano | 92d8037 | 2016-07-13 22:00:05 | [diff] [blame] | 2692 | `--signed=if-asked` is passed to 'git push'. A false value may |
| Junio C Hamano | 3891e25 | 2015-08-31 23:06:13 | [diff] [blame] | 2693 | override a value from a lower-priority config file. An explicit |
| 2694 | command-line flag always overrides this config option. |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 2695 | |
| Junio C Hamano | 3a9c034 | 2017-11-10 06:01:12 | [diff] [blame] | 2696 | push.pushOption:: |
| 2697 | When no `--push-option=<option>` argument is given from the |
| 2698 | command line, `git push` behaves as if each <value> of |
| 2699 | this variable is given as `--push-option=<value>`. |
| 2700 | + |
| 2701 | This is a multi-valued variable, and an empty value can be used in a |
| 2702 | higher priority configuration file (e.g. `.git/config` in a |
| 2703 | repository) to clear the values inherited from a lower priority |
| 2704 | configuration files (e.g. `$HOME/.gitconfig`). |
| 2705 | + |
| 2706 | -- |
| 2707 | |
| 2708 | Example: |
| 2709 | |
| 2710 | /etc/gitconfig |
| 2711 | push.pushoption = a |
| 2712 | push.pushoption = b |
| 2713 | |
| 2714 | ~/.gitconfig |
| 2715 | push.pushoption = c |
| 2716 | |
| 2717 | repo/.git/config |
| 2718 | push.pushoption = |
| 2719 | push.pushoption = b |
| 2720 | |
| 2721 | This will result in only b (a and c are cleared). |
| 2722 | |
| 2723 | -- |
| 2724 | |
| Junio C Hamano | 409a33a | 2015-12-22 23:45:23 | [diff] [blame] | 2725 | push.recurseSubmodules:: |
| 2726 | Make sure all submodule commits used by the revisions to be pushed |
| 2727 | are available on a remote-tracking branch. If the value is 'check' |
| 2728 | then Git will verify that all submodule commits that changed in the |
| 2729 | revisions to be pushed are available on at least one remote of the |
| 2730 | submodule. If any commits are missing, the push will be aborted and |
| 2731 | exit with non-zero status. If the value is 'on-demand' then all |
| 2732 | submodules that changed in the revisions to be pushed will be |
| 2733 | pushed. If on-demand was not able to push all necessary revisions |
| 2734 | it will also be aborted and exit with non-zero status. If the value |
| 2735 | is 'no' then default behavior of ignoring submodules when pushing |
| 2736 | is retained. You may override this configuration at time of push by |
| 2737 | specifying '--recurse-submodules=check|on-demand|no'. |
| 2738 | |
| Junio C Hamano | ea6a764 | 2009-03-11 23:56:19 | [diff] [blame] | 2739 | rebase.stat:: |
| 2740 | Whether to show a diffstat of what changed upstream since the last |
| 2741 | rebase. False by default. |
| 2742 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 2743 | rebase.autoSquash:: |
| Junio C Hamano | 92d8037 | 2016-07-13 22:00:05 | [diff] [blame] | 2744 | If set to true enable `--autosquash` option by default. |
| Junio C Hamano | 075ae87 | 2010-09-01 18:43:07 | [diff] [blame] | 2745 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 2746 | rebase.autoStash:: |
| Junio C Hamano | 967cda7 | 2017-06-30 21:49:53 | [diff] [blame] | 2747 | When set to true, automatically create a temporary stash entry |
| Junio C Hamano | f1f5a7b | 2013-06-11 22:23:52 | [diff] [blame] | 2748 | before the operation begins, and apply it after the operation |
| 2749 | ends. This means that you can run rebase on a dirty worktree. |
| 2750 | However, use with care: the final stash application after a |
| 2751 | successful rebase might result in non-trivial conflicts. |
| 2752 | Defaults to false. |
| 2753 | |
| Junio C Hamano | d7ed404 | 2015-08-03 19:43:00 | [diff] [blame] | 2754 | rebase.missingCommitsCheck:: |
| 2755 | If set to "warn", git rebase -i will print a warning if some |
| 2756 | commits are removed (e.g. a line was deleted), however the |
| 2757 | rebase will still proceed. If set to "error", it will print |
| 2758 | the previous warning and stop the rebase, 'git rebase |
| 2759 | --edit-todo' can then be used to correct the error. If set to |
| 2760 | "ignore", no checking is done. |
| 2761 | To drop a commit without warning or error, use the `drop` |
| 2762 | command in the todo-list. |
| 2763 | Defaults to "ignore". |
| 2764 | |
| Junio C Hamano | f2f28b1 | 2016-10-31 21:41:58 | [diff] [blame] | 2765 | rebase.instructionFormat:: |
| Junio C Hamano | d7ed404 | 2015-08-03 19:43:00 | [diff] [blame] | 2766 | A format string, as specified in linkgit:git-log[1], to be used for |
| 2767 | the instruction list during an interactive rebase. The format will automatically |
| 2768 | have the long commit hash prepended to the format. |
| 2769 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 2770 | receive.advertiseAtomic:: |
| Junio C Hamano | 6bb32e6 | 2015-02-17 22:11:26 | [diff] [blame] | 2771 | By default, git-receive-pack will advertise the atomic push |
| Junio C Hamano | e48a113 | 2016-08-03 22:40:21 | [diff] [blame] | 2772 | capability to its clients. If you don't want to advertise this |
| 2773 | capability, set this variable to false. |
| 2774 | |
| 2775 | receive.advertisePushOptions:: |
| Junio C Hamano | d3ab1ad | 2017-05-23 06:52:18 | [diff] [blame] | 2776 | When set to true, git-receive-pack will advertise the push options |
| 2777 | capability to its clients. False by default. |
| Junio C Hamano | 6bb32e6 | 2015-02-17 22:11:26 | [diff] [blame] | 2778 | |
| Junio C Hamano | 621e123 | 2009-10-26 05:16:47 | [diff] [blame] | 2779 | receive.autogc:: |
| 2780 | By default, git-receive-pack will run "git-gc --auto" after |
| 2781 | receiving data from git-push and updating refs. You can stop |
| 2782 | it by setting this variable to false. |
| 2783 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 2784 | receive.certNonceSeed:: |
| Junio C Hamano | 9236fea | 2014-10-14 22:28:09 | [diff] [blame] | 2785 | By setting this variable to a string, `git receive-pack` |
| 2786 | will accept a `git push --signed` and verifies it by using |
| 2787 | a "nonce" protected by HMAC using this string as a secret |
| 2788 | key. |
| 2789 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 2790 | receive.certNonceSlop:: |
| Junio C Hamano | 9236fea | 2014-10-14 22:28:09 | [diff] [blame] | 2791 | When a `git push --signed` sent a push certificate with a |
| 2792 | "nonce" that was issued by a receive-pack serving the same |
| 2793 | repository within this many seconds, export the "nonce" |
| 2794 | found in the certificate to `GIT_PUSH_CERT_NONCE` to the |
| 2795 | hooks (instead of what the receive-pack asked the sending |
| 2796 | side to include). This may allow writing checks in |
| 2797 | `pre-receive` and `post-receive` a bit easier. Instead of |
| 2798 | checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable |
| 2799 | that records by how many seconds the nonce is stale to |
| 2800 | decide if they want to accept the certificate, they only |
| 2801 | can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`. |
| 2802 | |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 2803 | receive.fsckObjects:: |
| 2804 | If it is set to true, git-receive-pack will check all received |
| 2805 | objects. It will abort in the case of a malformed object or a |
| 2806 | broken link. The result of an abort are only dangling objects. |
| Junio C Hamano | 8fb66e5 | 2011-10-05 20:59:51 | [diff] [blame] | 2807 | Defaults to false. If not set, the value of `transfer.fsckObjects` |
| 2808 | is used instead. |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 2809 | |
| Junio C Hamano | d7ed404 | 2015-08-03 19:43:00 | [diff] [blame] | 2810 | receive.fsck.<msg-id>:: |
| 2811 | When `receive.fsckObjects` is set to true, errors can be switched |
| 2812 | to warnings and vice versa by configuring the `receive.fsck.<msg-id>` |
| 2813 | setting where the `<msg-id>` is the fsck message ID and the value |
| 2814 | is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes |
| 2815 | the error/warning with the message ID, e.g. "missingEmail: invalid |
| 2816 | author/committer line - missing email" means that setting |
| 2817 | `receive.fsck.missingEmail = ignore` will hide that issue. |
| 2818 | + |
| 2819 | This feature is intended to support working with legacy repositories |
| 2820 | which would not pass pushing when `receive.fsckObjects = true`, allowing |
| 2821 | the host to accept repositories with certain known issues but still catch |
| 2822 | other issues. |
| 2823 | |
| 2824 | receive.fsck.skipList:: |
| 2825 | The path to a sorted list of object names (i.e. one SHA-1 per |
| 2826 | line) that are known to be broken in a non-fatal way and should |
| 2827 | be ignored. This feature is useful when an established project |
| 2828 | should be accepted despite early commits containing errors that |
| 2829 | can be safely ignored such as invalid committer email addresses. |
| 2830 | Note: corrupt objects cannot be skipped with this setting. |
| 2831 | |
| Junio C Hamano | e48a113 | 2016-08-03 22:40:21 | [diff] [blame] | 2832 | receive.keepAlive:: |
| 2833 | After receiving the pack from the client, `receive-pack` may |
| 2834 | produce no output (if `--quiet` was specified) while processing |
| 2835 | the pack, causing some networks to drop the TCP connection. |
| 2836 | With this option set, if `receive-pack` does not transmit |
| 2837 | any data in this phase for `receive.keepAlive` seconds, it will |
| 2838 | send a short keepalive packet. The default is 5 seconds; set |
| 2839 | to 0 to disable keepalives entirely. |
| 2840 | |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 2841 | receive.unpackLimit:: |
| 2842 | If the number of objects received in a push is below this |
| 2843 | limit then the objects will be unpacked into loose object |
| 2844 | files. However if the number of received objects equals or |
| 2845 | exceeds this limit then the received pack will be stored as |
| 2846 | a pack, after adding any missing delta bases. Storing the |
| 2847 | pack from a push can make the push operation complete faster, |
| 2848 | especially on slow filesystems. If not set, the value of |
| 2849 | `transfer.unpackLimit` is used instead. |
| 2850 | |
| Junio C Hamano | cd45166 | 2016-09-13 00:54:09 | [diff] [blame] | 2851 | receive.maxInputSize:: |
| 2852 | If the size of the incoming pack stream is larger than this |
| 2853 | limit, then git-receive-pack will error out, instead of |
| 2854 | accepting the pack file. If not set or set to 0, then the size |
| 2855 | is unlimited. |
| 2856 | |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 2857 | receive.denyDeletes:: |
| 2858 | If set to true, git-receive-pack will deny a ref update that deletes |
| 2859 | the ref. Use this to prevent such a ref deletion via a push. |
| 2860 | |
| Junio C Hamano | b4448a8 | 2010-07-26 09:02:32 | [diff] [blame] | 2861 | receive.denyDeleteCurrent:: |
| 2862 | If set to true, git-receive-pack will deny a ref update that |
| 2863 | deletes the currently checked out branch of a non-bare repository. |
| 2864 | |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 2865 | receive.denyCurrentBranch:: |
| Junio C Hamano | e97d577 | 2010-05-19 08:13:58 | [diff] [blame] | 2866 | 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] | 2867 | to the currently checked out branch of a non-bare repository. |
| 2868 | Such a push is potentially dangerous because it brings the HEAD |
| 2869 | out of sync with the index and working tree. If set to "warn", |
| 2870 | print a warning of such a push to stderr, but allow the push to |
| 2871 | proceed. If set to false or "ignore", allow such pushes with no |
| Junio C Hamano | afb395b | 2010-03-17 22:16:15 | [diff] [blame] | 2872 | message. Defaults to "refuse". |
| Junio C Hamano | 6df93d9 | 2014-12-22 22:48:09 | [diff] [blame] | 2873 | + |
| 2874 | Another option is "updateInstead" which will update the working |
| Junio C Hamano | 6bb32e6 | 2015-02-17 22:11:26 | [diff] [blame] | 2875 | tree if pushing into the current branch. This option is |
| Junio C Hamano | 6df93d9 | 2014-12-22 22:48:09 | [diff] [blame] | 2876 | intended for synchronizing working directories when one side is not easily |
| 2877 | accessible via interactive ssh (e.g. a live web site, hence the requirement |
| 2878 | that the working directory be clean). This mode also comes in handy when |
| 2879 | developing inside a VM to test and fix code on different Operating Systems. |
| Junio C Hamano | 6bb32e6 | 2015-02-17 22:11:26 | [diff] [blame] | 2880 | + |
| 2881 | By default, "updateInstead" will refuse the push if the working tree or |
| 2882 | the index have any difference from the HEAD, but the `push-to-checkout` |
| 2883 | hook can be used to customize this. See linkgit:githooks[5]. |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 2884 | |
| 2885 | receive.denyNonFastForwards:: |
| 2886 | 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] | 2887 | 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] | 2888 | even if that push is forced. This configuration variable is |
| 2889 | set when initializing a shared repository. |
| 2890 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 2891 | receive.hideRefs:: |
| Junio C Hamano | b6aa12e | 2015-08-19 22:40:17 | [diff] [blame] | 2892 | This variable is the same as `transfer.hideRefs`, but applies |
| 2893 | only to `receive-pack` (and so affects pushes, but not fetches). |
| 2894 | An attempt to update or delete a hidden ref by `git push` is |
| 2895 | rejected. |
| Junio C Hamano | 80ad00d | 2013-02-18 00:19:03 | [diff] [blame] | 2896 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 2897 | receive.updateServerInfo:: |
| Junio C Hamano | 621e123 | 2009-10-26 05:16:47 | [diff] [blame] | 2898 | If set to true, git-receive-pack will run git-update-server-info |
| 2899 | after receiving data from git-push and updating refs. |
| 2900 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 2901 | receive.shallowUpdate:: |
| Junio C Hamano | 61525f9 | 2014-01-17 22:46:49 | [diff] [blame] | 2902 | If set to true, .git/shallow can be updated when new refs |
| 2903 | require new shallow roots. Otherwise those refs are rejected. |
| 2904 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 2905 | remote.pushDefault:: |
| Junio C Hamano | 63b6fdb | 2013-04-07 23:37:13 | [diff] [blame] | 2906 | The remote to push to by default. Overrides |
| 2907 | `branch.<name>.remote` for all branches, and is overridden by |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 2908 | `branch.<name>.pushRemote` for specific branches. |
| Junio C Hamano | 63b6fdb | 2013-04-07 23:37:13 | [diff] [blame] | 2909 | |
| Junio C Hamano | 249572f | 2006-10-24 05:44:08 | [diff] [blame] | 2910 | remote.<name>.url:: |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 2911 | The URL of a remote repository. See linkgit:git-fetch[1] or |
| 2912 | linkgit:git-push[1]. |
| Junio C Hamano | 249572f | 2006-10-24 05:44:08 | [diff] [blame] | 2913 | |
| Junio C Hamano | 0e88f3e | 2009-06-21 08:03:25 | [diff] [blame] | 2914 | remote.<name>.pushurl:: |
| 2915 | The push URL of a remote repository. See linkgit:git-push[1]. |
| 2916 | |
| Junio C Hamano | 5825687 | 2007-12-04 08:31:13 | [diff] [blame] | 2917 | remote.<name>.proxy:: |
| 2918 | For remotes that require curl (http, https and ftp), the URL to |
| 2919 | the proxy to use for that remote. Set to the empty string to |
| 2920 | disable proxying for that remote. |
| 2921 | |
| Junio C Hamano | ffe10ca | 2016-02-04 00:44:23 | [diff] [blame] | 2922 | remote.<name>.proxyAuthMethod:: |
| 2923 | For remotes that require curl (http, https and ftp), the method to use for |
| 2924 | authenticating against the proxy in use (probably set in |
| 2925 | `remote.<name>.proxy`). See `http.proxyAuthMethod`. |
| 2926 | |
| Junio C Hamano | 249572f | 2006-10-24 05:44:08 | [diff] [blame] | 2927 | remote.<name>.fetch:: |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 2928 | The default set of "refspec" for linkgit:git-fetch[1]. See |
| 2929 | linkgit:git-fetch[1]. |
| Junio C Hamano | 249572f | 2006-10-24 05:44:08 | [diff] [blame] | 2930 | |
| 2931 | remote.<name>.push:: |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 2932 | The default set of "refspec" for linkgit:git-push[1]. See |
| 2933 | linkgit:git-push[1]. |
| Junio C Hamano | 249572f | 2006-10-24 05:44:08 | [diff] [blame] | 2934 | |
| Junio C Hamano | 47d68a5 | 2008-05-06 06:35:40 | [diff] [blame] | 2935 | remote.<name>.mirror:: |
| 2936 | If true, pushing to this remote will automatically behave |
| Junio C Hamano | b76a686 | 2012-05-02 22:02:46 | [diff] [blame] | 2937 | as if the `--mirror` option was given on the command line. |
| Junio C Hamano | 47d68a5 | 2008-05-06 06:35:40 | [diff] [blame] | 2938 | |
| Junio C Hamano | 118d277 | 2007-02-21 20:24:10 | [diff] [blame] | 2939 | remote.<name>.skipDefaultUpdate:: |
| 2940 | If true, this remote will be skipped by default when updating |
| Junio C Hamano | 9df0c66 | 2009-11-23 11:09:27 | [diff] [blame] | 2941 | using linkgit:git-fetch[1] or the `update` subcommand of |
| 2942 | linkgit:git-remote[1]. |
| 2943 | |
| 2944 | remote.<name>.skipFetchAll:: |
| 2945 | If true, this remote will be skipped by default when updating |
| 2946 | using linkgit:git-fetch[1] or the `update` subcommand of |
| 2947 | linkgit:git-remote[1]. |
| Junio C Hamano | 118d277 | 2007-02-21 20:24:10 | [diff] [blame] | 2948 | |
| Junio C Hamano | 4ad294b | 2007-01-20 02:22:50 | [diff] [blame] | 2949 | remote.<name>.receivepack:: |
| Junio C Hamano | 54ea8d3 | 2007-01-25 07:59:48 | [diff] [blame] | 2950 | The default program to execute on the remote side when pushing. See |
| Junio C Hamano | 1dbca52 | 2015-05-22 20:48:55 | [diff] [blame] | 2951 | option --receive-pack of linkgit:git-push[1]. |
| Junio C Hamano | 4ad294b | 2007-01-20 02:22:50 | [diff] [blame] | 2952 | |
| Junio C Hamano | 54ea8d3 | 2007-01-25 07:59:48 | [diff] [blame] | 2953 | remote.<name>.uploadpack:: |
| 2954 | The default program to execute on the remote side when fetching. See |
| Junio C Hamano | 1dbca52 | 2015-05-22 20:48:55 | [diff] [blame] | 2955 | option --upload-pack of linkgit:git-fetch-pack[1]. |
| Junio C Hamano | 54ea8d3 | 2007-01-25 07:59:48 | [diff] [blame] | 2956 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 2957 | remote.<name>.tagOpt:: |
| Junio C Hamano | 1dbca52 | 2015-05-22 20:48:55 | [diff] [blame] | 2958 | Setting this value to --no-tags disables automatic tag following when |
| 2959 | fetching from remote <name>. Setting it to --tags will fetch every |
| Junio C Hamano | cc7636a | 2010-05-21 14:57:53 | [diff] [blame] | 2960 | tag from remote <name>, even if they are not reachable from remote |
| Junio C Hamano | 075ae87 | 2010-09-01 18:43:07 | [diff] [blame] | 2961 | branch heads. Passing these flags directly to linkgit:git-fetch[1] can |
| Junio C Hamano | 1dbca52 | 2015-05-22 20:48:55 | [diff] [blame] | 2962 | override this setting. See options --tags and --no-tags of |
| Junio C Hamano | 075ae87 | 2010-09-01 18:43:07 | [diff] [blame] | 2963 | linkgit:git-fetch[1]. |
| Junio C Hamano | 17dde0e | 2007-02-26 09:50:21 | [diff] [blame] | 2964 | |
| Junio C Hamano | 096dde2 | 2009-12-26 23:14:11 | [diff] [blame] | 2965 | remote.<name>.vcs:: |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 2966 | Setting this to a value <vcs> will cause Git to interact with |
| Junio C Hamano | 096dde2 | 2009-12-26 23:14:11 | [diff] [blame] | 2967 | the remote with the git-remote-<vcs> helper. |
| 2968 | |
| Junio C Hamano | 8eac268 | 2013-09-09 22:35:20 | [diff] [blame] | 2969 | remote.<name>.prune:: |
| 2970 | When set to true, fetching from this remote by default will also |
| Junio C Hamano | 4c8f2d9 | 2013-12-13 00:55:42 | [diff] [blame] | 2971 | remove any remote-tracking references that no longer exist on the |
| 2972 | remote (as if the `--prune` option was given on the command line). |
| Junio C Hamano | 8eac268 | 2013-09-09 22:35:20 | [diff] [blame] | 2973 | Overrides `fetch.prune` settings, if any. |
| 2974 | |
| Junio C Hamano | 118d277 | 2007-02-21 20:24:10 | [diff] [blame] | 2975 | remotes.<group>:: |
| 2976 | The list of remotes which are fetched by "git remote update |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 2977 | <group>". See linkgit:git-remote[1]. |
| Junio C Hamano | 118d277 | 2007-02-21 20:24:10 | [diff] [blame] | 2978 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 2979 | repack.useDeltaBaseOffset:: |
| Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame] | 2980 | By default, linkgit:git-repack[1] creates packs that use |
| 2981 | delta-base offset. If you need to share your repository with |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 2982 | 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] | 2983 | protocol such as http, then you need to set this option to |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 2984 | "false" and repack. Access from old Git versions over the |
| Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame] | 2985 | native protocol are unaffected by this option. |
| Junio C Hamano | 77b7e90 | 2006-10-23 07:18:50 | [diff] [blame] | 2986 | |
| Junio C Hamano | 3b0cdc2 | 2014-03-18 22:06:16 | [diff] [blame] | 2987 | repack.packKeptObjects:: |
| 2988 | If set to true, makes `git repack` act as if |
| 2989 | `--pack-kept-objects` was passed. See linkgit:git-repack[1] for |
| 2990 | details. Defaults to `false` normally, but `true` if a bitmap |
| 2991 | index is being written (either via `--write-bitmap-index` or |
| Junio C Hamano | 38d0253 | 2014-06-26 21:48:50 | [diff] [blame] | 2992 | `repack.writeBitmaps`). |
| 2993 | |
| 2994 | repack.writeBitmaps:: |
| 2995 | When true, git will write a bitmap index when packing all |
| 2996 | objects to disk (e.g., when `git repack -a` is run). This |
| 2997 | index can speed up the "counting objects" phase of subsequent |
| 2998 | packs created for clones and fetches, at the cost of some disk |
| Junio C Hamano | 74fd0fc | 2016-05-10 21:23:56 | [diff] [blame] | 2999 | space and extra time spent on the initial repack. This has |
| 3000 | no effect if multiple packfiles are created. |
| 3001 | Defaults to false. |
| Junio C Hamano | 3b0cdc2 | 2014-03-18 22:06:16 | [diff] [blame] | 3002 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 3003 | rerere.autoUpdate:: |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 3004 | When set to true, `git-rerere` updates the index with the |
| 3005 | resulting contents after it cleanly resolves conflicts using |
| 3006 | previously recorded resolution. Defaults to false. |
| 3007 | |
| 3008 | rerere.enabled:: |
| 3009 | Activate recording of resolved conflicts, so that identical |
| Junio C Hamano | 4fd2442 | 2012-01-06 21:52:43 | [diff] [blame] | 3010 | conflict hunks can be resolved automatically, should they be |
| 3011 | encountered again. By default, linkgit:git-rerere[1] is |
| 3012 | enabled if there is an `rr-cache` directory under the |
| Junio C Hamano | 864ba89 | 2012-01-13 17:42:05 | [diff] [blame] | 3013 | `$GIT_DIR`, e.g. if "rerere" was previously used in the |
| 3014 | repository. |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 3015 | |
| Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 3016 | sendemail.identity:: |
| 3017 | A configuration identity. When given, causes values in the |
| 3018 | 'sendemail.<identity>' subsection to take precedence over |
| 3019 | values in the 'sendemail' section. The default identity is |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 3020 | the value of `sendemail.identity`. |
| Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 3021 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 3022 | sendemail.smtpEncryption:: |
| Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 3023 | See linkgit:git-send-email[1] for description. Note that this |
| 3024 | setting is not subject to the 'identity' mechanism. |
| 3025 | |
| Junio C Hamano | be08798 | 2015-02-22 21:29:39 | [diff] [blame] | 3026 | sendemail.smtpssl (deprecated):: |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 3027 | Deprecated alias for 'sendemail.smtpEncryption = ssl'. |
| Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 3028 | |
| Junio C Hamano | 58f587a | 2013-07-22 19:20:59 | [diff] [blame] | 3029 | sendemail.smtpsslcertpath:: |
| 3030 | Path to ca-certificates (either a directory or a single file). |
| 3031 | Set it to an empty string to disable certificate verification. |
| 3032 | |
| Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 3033 | sendemail.<identity>.*:: |
| 3034 | Identity-specific versions of the 'sendemail.*' parameters |
| Junio C Hamano | 7526f0a | 2017-08-24 18:09:35 | [diff] [blame] | 3035 | found below, taking precedence over those when this |
| 3036 | identity is selected, through either the command-line or |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 3037 | `sendemail.identity`. |
| Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 3038 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 3039 | sendemail.aliasesFile:: |
| 3040 | sendemail.aliasFileType:: |
| Junio C Hamano | ea3b752 | 2013-04-18 19:37:53 | [diff] [blame] | 3041 | sendemail.annotate:: |
| Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 3042 | sendemail.bcc:: |
| 3043 | sendemail.cc:: |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 3044 | sendemail.ccCmd:: |
| 3045 | sendemail.chainReplyTo:: |
| Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 3046 | sendemail.confirm:: |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 3047 | sendemail.envelopeSender:: |
| Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 3048 | sendemail.from:: |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 3049 | sendemail.multiEdit:: |
| Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 3050 | sendemail.signedoffbycc:: |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 3051 | sendemail.smtpPass:: |
| Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 3052 | sendemail.suppresscc:: |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 3053 | sendemail.suppressFrom:: |
| Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 3054 | sendemail.to:: |
| Junio C Hamano | 4886c77 | 2017-11-27 03:33:28 | [diff] [blame] | 3055 | sendemail.tocmd:: |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 3056 | sendemail.smtpDomain:: |
| 3057 | sendemail.smtpServer:: |
| 3058 | sendemail.smtpServerPort:: |
| 3059 | sendemail.smtpServerOption:: |
| 3060 | sendemail.smtpUser:: |
| Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 3061 | sendemail.thread:: |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 3062 | sendemail.transferEncoding:: |
| Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 3063 | sendemail.validate:: |
| Junio C Hamano | c9394b2 | 2015-01-07 22:45:48 | [diff] [blame] | 3064 | sendemail.xmailer:: |
| Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 3065 | See linkgit:git-send-email[1] for description. |
| 3066 | |
| Junio C Hamano | be08798 | 2015-02-22 21:29:39 | [diff] [blame] | 3067 | sendemail.signedoffcc (deprecated):: |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 3068 | Deprecated alias for `sendemail.signedoffbycc`. |
| Junio C Hamano | 1bbd0f4 | 2009-07-23 06:20:29 | [diff] [blame] | 3069 | |
| Junio C Hamano | 08a3a23 | 2017-07-07 02:28:44 | [diff] [blame] | 3070 | sendemail.smtpBatchSize:: |
| 3071 | Number of messages to be sent per connection, after that a relogin |
| 3072 | will happen. If the value is 0 or undefined, send all messages in |
| 3073 | one connection. |
| 3074 | See also the `--batch-size` option of linkgit:git-send-email[1]. |
| 3075 | |
| 3076 | sendemail.smtpReloginDelay:: |
| 3077 | Seconds wait before reconnecting to smtp server. |
| 3078 | See also the `--relogin-delay` option of linkgit:git-send-email[1]. |
| 3079 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 3080 | showbranch.default:: |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 3081 | The default set of branches for linkgit:git-show-branch[1]. |
| 3082 | See linkgit:git-show-branch[1]. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 3083 | |
| Junio C Hamano | 3d4a66d | 2017-03-17 21:07:26 | [diff] [blame] | 3084 | splitIndex.maxPercentChange:: |
| 3085 | When the split index feature is used, this specifies the |
| 3086 | percent of entries the split index can contain compared to the |
| 3087 | total number of entries in both the split index and the shared |
| 3088 | index before a new shared index is written. |
| 3089 | The value should be between 0 and 100. If the value is 0 then |
| 3090 | a new shared index is always written, if it is 100 a new |
| 3091 | shared index is never written. |
| 3092 | By default the value is 20, so a new shared index is written |
| 3093 | if the number of entries in the split index would be greater |
| 3094 | than 20 percent of the total number of entries. |
| 3095 | See linkgit:git-update-index[1]. |
| 3096 | |
| 3097 | splitIndex.sharedIndexExpire:: |
| 3098 | When the split index feature is used, shared index files that |
| 3099 | were not modified since the time this variable specifies will |
| 3100 | be removed when a new shared index file is created. The value |
| 3101 | "now" expires all entries immediately, and "never" suppresses |
| 3102 | expiration altogether. |
| 3103 | The default value is "2.weeks.ago". |
| 3104 | Note that a shared index file is considered modified (for the |
| 3105 | purpose of expiration) each time a new split-index file is |
| 3106 | either created based on it or read from it. |
| 3107 | See linkgit:git-update-index[1]. |
| 3108 | |
| Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 3109 | status.relativePaths:: |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 3110 | By default, linkgit:git-status[1] shows paths relative to the |
| Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 3111 | current directory. Setting this variable to `false` shows paths |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 3112 | relative to the repository root (this was the default for Git |
| Junio C Hamano | 942b35e | 2007-12-09 10:19:33 | [diff] [blame] | 3113 | prior to v1.5.4). |
| 3114 | |
| Junio C Hamano | 5865559 | 2013-07-11 20:52:33 | [diff] [blame] | 3115 | status.short:: |
| 3116 | Set to true to enable --short by default in linkgit:git-status[1]. |
| 3117 | The option --no-short takes precedence over this variable. |
| 3118 | |
| 3119 | status.branch:: |
| 3120 | Set to true to enable --branch by default in linkgit:git-status[1]. |
| 3121 | The option --no-branch takes precedence over this variable. |
| 3122 | |
| Junio C Hamano | 79f4c7c | 2013-09-20 21:03:37 | [diff] [blame] | 3123 | status.displayCommentPrefix:: |
| 3124 | If set to true, linkgit:git-status[1] will insert a comment |
| 3125 | prefix before each output line (starting with |
| 3126 | `core.commentChar`, i.e. `#` by default). This was the |
| 3127 | behavior of linkgit:git-status[1] in Git 1.8.4 and previous. |
| 3128 | Defaults to false. |
| 3129 | |
| Junio C Hamano | 967cda7 | 2017-06-30 21:49:53 | [diff] [blame] | 3130 | status.showStash:: |
| 3131 | If set to true, linkgit:git-status[1] will display the number of |
| 3132 | entries currently stashed away. |
| 3133 | Defaults to false. |
| 3134 | |
| Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 3135 | status.showUntrackedFiles:: |
| 3136 | By default, linkgit:git-status[1] and linkgit:git-commit[1] show |
| 3137 | files which are not currently tracked by Git. Directories which |
| 3138 | contain only untracked files, are shown with the directory name |
| 3139 | only. Showing untracked files means that Git needs to lstat() all |
| Junio C Hamano | 2efd5e4 | 2014-11-10 22:38:52 | [diff] [blame] | 3140 | the files in the whole repository, which might be slow on some |
| Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 3141 | systems. So, this variable controls how the commands displays |
| 3142 | the untracked files. Possible values are: |
| 3143 | + |
| 3144 | -- |
| Junio C Hamano | 7f9fa86 | 2010-10-19 23:51:14 | [diff] [blame] | 3145 | * `no` - Show no untracked files. |
| 3146 | * `normal` - Show untracked files and directories. |
| 3147 | * `all` - Show also individual files in untracked directories. |
| Junio C Hamano | 4224f99 | 2008-06-23 07:14:08 | [diff] [blame] | 3148 | -- |
| 3149 | + |
| 3150 | If this variable is not specified, it defaults to 'normal'. |
| 3151 | This variable can be overridden with the -u|--untracked-files option |
| 3152 | of linkgit:git-status[1] and linkgit:git-commit[1]. |
| 3153 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 3154 | status.submoduleSummary:: |
| Junio C Hamano | b671fb5 | 2010-06-01 05:06:14 | [diff] [blame] | 3155 | Defaults to false. |
| 3156 | If this is set to a non zero number or true (identical to -1 or an |
| 3157 | unlimited number), the submodule summary will be enabled and a |
| 3158 | summary of commits for modified submodules will be shown (see |
| Junio C Hamano | 369e340 | 2013-10-15 18:40:25 | [diff] [blame] | 3159 | --summary-limit option of linkgit:git-submodule[1]). Please note |
| 3160 | that the summary output command will be suppressed for all |
| 3161 | submodules when `diff.ignoreSubmodules` is set to 'all' or only |
| Junio C Hamano | c8c398a | 2014-06-16 21:14:05 | [diff] [blame] | 3162 | for those submodules where `submodule.<name>.ignore=all`. The only |
| 3163 | exception to that rule is that status and commit will show staged |
| 3164 | submodule changes. To |
| Junio C Hamano | 369e340 | 2013-10-15 18:40:25 | [diff] [blame] | 3165 | also view the summary for ignored submodules you can either use |
| Junio C Hamano | e1aeb5e | 2014-06-06 19:16:29 | [diff] [blame] | 3166 | the --ignore-submodules=dirty command-line option or the 'git |
| Junio C Hamano | 369e340 | 2013-10-15 18:40:25 | [diff] [blame] | 3167 | submodule summary' command, which shows a similar output but does |
| 3168 | not honor these settings. |
| Junio C Hamano | b671fb5 | 2010-06-01 05:06:14 | [diff] [blame] | 3169 | |
| Junio C Hamano | 1eb5609 | 2015-10-05 20:39:53 | [diff] [blame] | 3170 | stash.showPatch:: |
| 3171 | If this is set to true, the `git stash show` command without an |
| Junio C Hamano | 967cda7 | 2017-06-30 21:49:53 | [diff] [blame] | 3172 | option will show the stash entry in patch form. Defaults to false. |
| Junio C Hamano | 1eb5609 | 2015-10-05 20:39:53 | [diff] [blame] | 3173 | See description of 'show' command in linkgit:git-stash[1]. |
| 3174 | |
| 3175 | stash.showStat:: |
| 3176 | If this is set to true, the `git stash show` command without an |
| Junio C Hamano | 967cda7 | 2017-06-30 21:49:53 | [diff] [blame] | 3177 | option will show diffstat of the stash entry. Defaults to true. |
| Junio C Hamano | 1eb5609 | 2015-10-05 20:39:53 | [diff] [blame] | 3178 | See description of 'show' command in linkgit:git-stash[1]. |
| 3179 | |
| Junio C Hamano | 78e3a78 | 2010-07-15 22:24:45 | [diff] [blame] | 3180 | submodule.<name>.url:: |
| Junio C Hamano | c0859f7 | 2016-10-17 22:22:57 | [diff] [blame] | 3181 | The URL for a submodule. This variable is copied from the .gitmodules |
| 3182 | file to the git config via 'git submodule init'. The user can change |
| 3183 | the configured URL before obtaining the submodule via 'git submodule |
| Junio C Hamano | dc8d0c3 | 2017-03-30 23:00:21 | [diff] [blame] | 3184 | update'. If neither submodule.<name>.active or submodule.active are |
| 3185 | set, the presence of this variable is used as a fallback to indicate |
| 3186 | whether the submodule is of interest to git commands. |
| Junio C Hamano | c0859f7 | 2016-10-17 22:22:57 | [diff] [blame] | 3187 | See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details. |
| Junio C Hamano | 6bf68cf | 2015-03-06 23:46:29 | [diff] [blame] | 3188 | |
| Junio C Hamano | 78e3a78 | 2010-07-15 22:24:45 | [diff] [blame] | 3189 | submodule.<name>.update:: |
| Junio C Hamano | ef75f37 | 2017-09-29 04:22:33 | [diff] [blame] | 3190 | The method by which a submodule is updated by 'git submodule update', |
| 3191 | which is the only affected command, others such as |
| 3192 | 'git checkout --recurse-submodules' are unaffected. It exists for |
| 3193 | historical reasons, when 'git submodule' was the only command to |
| 3194 | interact with submodules; settings like `submodule.active` |
| 3195 | and `pull.rebase` are more specific. It is populated by |
| 3196 | `git submodule init` from the linkgit:gitmodules[5] file. |
| 3197 | See description of 'update' command in linkgit:git-submodule[1]. |
| Junio C Hamano | 78e3a78 | 2010-07-15 22:24:45 | [diff] [blame] | 3198 | |
| Junio C Hamano | abad6da | 2013-01-06 09:06:32 | [diff] [blame] | 3199 | submodule.<name>.branch:: |
| 3200 | The remote branch name for a submodule, used by `git submodule |
| 3201 | update --remote`. Set this option to override the value found in |
| 3202 | the `.gitmodules` file. See linkgit:git-submodule[1] and |
| 3203 | linkgit:gitmodules[5] for details. |
| 3204 | |
| Junio C Hamano | 0d75e87 | 2010-12-17 06:57:26 | [diff] [blame] | 3205 | submodule.<name>.fetchRecurseSubmodules:: |
| Junio C Hamano | 5cd1518 | 2011-04-05 00:21:10 | [diff] [blame] | 3206 | This option can be used to control recursive fetching of this |
| Junio C Hamano | 7165bf7 | 2011-01-04 22:06:18 | [diff] [blame] | 3207 | submodule. It can be overridden by using the --[no-]recurse-submodules |
| Junio C Hamano | e1aeb5e | 2014-06-06 19:16:29 | [diff] [blame] | 3208 | command-line option to "git fetch" and "git pull". |
| Junio C Hamano | 0d75e87 | 2010-12-17 06:57:26 | [diff] [blame] | 3209 | This setting will override that from in the linkgit:gitmodules[5] |
| 3210 | file. |
| 3211 | |
| Junio C Hamano | 619596a | 2010-08-18 22:15:35 | [diff] [blame] | 3212 | submodule.<name>.ignore:: |
| 3213 | Defines under what circumstances "git status" and the diff family show |
| 3214 | 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] | 3215 | modified (but it will nonetheless show up in the output of status and |
| 3216 | commit when it has been staged), "dirty" will ignore all changes |
| 3217 | to the submodules work tree and |
| Junio C Hamano | 619596a | 2010-08-18 22:15:35 | [diff] [blame] | 3218 | takes only differences between the HEAD of the submodule and the commit |
| 3219 | recorded in the superproject into account. "untracked" will additionally |
| 3220 | let submodules with modified tracked files in their work tree show up. |
| 3221 | Using "none" (the default when this option is not set) also shows |
| 3222 | submodules that have untracked files in their work tree as changed. |
| 3223 | This setting overrides any setting made in .gitmodules for this submodule, |
| Junio C Hamano | de9745c | 2010-08-23 17:10:18 | [diff] [blame] | 3224 | both settings can be overridden on the command line by using the |
| Junio C Hamano | 369e340 | 2013-10-15 18:40:25 | [diff] [blame] | 3225 | "--ignore-submodules" option. The 'git submodule' commands are not |
| 3226 | affected by this setting. |
| Junio C Hamano | 619596a | 2010-08-18 22:15:35 | [diff] [blame] | 3227 | |
| Junio C Hamano | dc8d0c3 | 2017-03-30 23:00:21 | [diff] [blame] | 3228 | submodule.<name>.active:: |
| 3229 | Boolean value indicating if the submodule is of interest to git |
| 3230 | commands. This config option takes precedence over the |
| 3231 | submodule.active config option. |
| 3232 | |
| 3233 | submodule.active:: |
| 3234 | A repeated field which contains a pathspec used to match against a |
| 3235 | submodule's path to determine if the submodule is of interest to git |
| 3236 | commands. |
| 3237 | |
| Junio C Hamano | 3a31ce5 | 2017-06-13 21:15:55 | [diff] [blame] | 3238 | submodule.recurse:: |
| 3239 | Specifies if commands recurse into submodules by default. This |
| 3240 | applies to all commands that have a `--recurse-submodules` option. |
| 3241 | Defaults to false. |
| 3242 | |
| Junio C Hamano | bec5da4 | 2016-04-06 22:58:21 | [diff] [blame] | 3243 | submodule.fetchJobs:: |
| 3244 | Specifies how many submodules are fetched/cloned at the same time. |
| 3245 | A positive integer allows up to that number of submodules fetched |
| 3246 | in parallel. A value of 0 will give some reasonable default. |
| 3247 | If unset, it defaults to 1. |
| 3248 | |
| Junio C Hamano | cd45166 | 2016-09-13 00:54:09 | [diff] [blame] | 3249 | submodule.alternateLocation:: |
| 3250 | Specifies how the submodules obtain alternates when submodules are |
| 3251 | cloned. Possible values are `no`, `superproject`. |
| 3252 | By default `no` is assumed, which doesn't add references. When the |
| 3253 | value is set to `superproject` the submodule to be cloned computes |
| 3254 | its alternates location relative to the superprojects alternate. |
| 3255 | |
| Junio C Hamano | ce01de8 | 2017-02-16 22:59:12 | [diff] [blame] | 3256 | submodule.alternateErrorStrategy:: |
| Junio C Hamano | cd45166 | 2016-09-13 00:54:09 | [diff] [blame] | 3257 | Specifies how to treat errors with the alternates for a submodule |
| 3258 | as computed via `submodule.alternateLocation`. Possible values are |
| 3259 | `ignore`, `info`, `die`. Default is `die`. |
| 3260 | |
| Junio C Hamano | bec5da4 | 2016-04-06 22:58:21 | [diff] [blame] | 3261 | tag.forceSignAnnotated:: |
| 3262 | A boolean to specify whether annotated tags created should be GPG signed. |
| 3263 | If `--annotate` is specified on the command line, it takes |
| 3264 | precedence over this option. |
| 3265 | |
| Junio C Hamano | 7b43d41 | 2014-07-23 23:09:44 | [diff] [blame] | 3266 | tag.sort:: |
| 3267 | This variable controls the sort ordering of tags when displayed by |
| 3268 | linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the |
| 3269 | value of this variable will be used as the default. |
| 3270 | |
| Junio C Hamano | 75cc4c9 | 2006-07-24 08:25:03 | [diff] [blame] | 3271 | tar.umask:: |
| Junio C Hamano | bdebabb | 2007-08-23 00:25:09 | [diff] [blame] | 3272 | This variable can be used to restrict the permission bits of |
| 3273 | tar archive entries. The default is 0002, which turns off the |
| 3274 | world write bit. The special value "user" indicates that the |
| 3275 | archiving user's umask will be used instead. See umask(2) and |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 3276 | linkgit:git-archive[1]. |
| Junio C Hamano | 75cc4c9 | 2006-07-24 08:25:03 | [diff] [blame] | 3277 | |
| Junio C Hamano | 8fb66e5 | 2011-10-05 20:59:51 | [diff] [blame] | 3278 | transfer.fsckObjects:: |
| 3279 | When `fetch.fsckObjects` or `receive.fsckObjects` are |
| 3280 | not set, the value of this variable is used instead. |
| 3281 | Defaults to false. |
| 3282 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 3283 | transfer.hideRefs:: |
| Junio C Hamano | b6aa12e | 2015-08-19 22:40:17 | [diff] [blame] | 3284 | String(s) `receive-pack` and `upload-pack` use to decide which |
| 3285 | refs to omit from their initial advertisements. Use more than |
| 3286 | one definition to specify multiple prefix strings. A ref that is |
| 3287 | under the hierarchies listed in the value of this variable is |
| 3288 | excluded, and is hidden when responding to `git push` or `git |
| 3289 | fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for |
| 3290 | program-specific versions of this config. |
| 3291 | + |
| 3292 | You may also include a `!` in front of the ref name to negate the entry, |
| 3293 | explicitly exposing it, even if an earlier entry marked it as hidden. |
| 3294 | If you have multiple hideRefs values, later entries override earlier ones |
| 3295 | (and entries in more-specific config files override less-specific ones). |
| Junio C Hamano | 713eded | 2015-12-03 00:24:02 | [diff] [blame] | 3296 | + |
| 3297 | If a namespace is in use, the namespace prefix is stripped from each |
| 3298 | reference before it is matched against `transfer.hiderefs` patterns. |
| 3299 | For example, if `refs/heads/master` is specified in `transfer.hideRefs` and |
| 3300 | the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master` |
| 3301 | is omitted from the advertisements but `refs/heads/master` and |
| 3302 | `refs/namespaces/bar/refs/heads/master` are still advertised as so-called |
| 3303 | "have" lines. In order to match refs before stripping, add a `^` in front of |
| 3304 | the ref name. If you combine `!` and `^`, `!` must be specified first. |
| Junio C Hamano | 56ace3d | 2017-01-10 23:43:41 | [diff] [blame] | 3305 | + |
| 3306 | Even if you hide refs, a client may still be able to steal the target |
| 3307 | objects via the techniques described in the "SECURITY" section of the |
| 3308 | linkgit:gitnamespaces[7] man page; it's best to keep private data in a |
| 3309 | separate repository. |
| Junio C Hamano | 80ad00d | 2013-02-18 00:19:03 | [diff] [blame] | 3310 | |
| Junio C Hamano | 4653c6f | 2008-11-26 22:50:20 | [diff] [blame] | 3311 | transfer.unpackLimit:: |
| 3312 | When `fetch.unpackLimit` or `receive.unpackLimit` are |
| 3313 | not set, the value of this variable is used instead. |
| 3314 | The default value is 100. |
| 3315 | |
| Junio C Hamano | 81703b2 | 2014-03-14 22:00:27 | [diff] [blame] | 3316 | uploadarchive.allowUnreachable:: |
| 3317 | If true, allow clients to use `git archive --remote` to request |
| 3318 | any tree, whether reachable from the ref tips or not. See the |
| Junio C Hamano | 56ace3d | 2017-01-10 23:43:41 | [diff] [blame] | 3319 | discussion in the "SECURITY" section of |
| Junio C Hamano | 81703b2 | 2014-03-14 22:00:27 | [diff] [blame] | 3320 | linkgit:git-upload-archive[1] for more details. Defaults to |
| 3321 | `false`. |
| 3322 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 3323 | uploadpack.hideRefs:: |
| Junio C Hamano | b6aa12e | 2015-08-19 22:40:17 | [diff] [blame] | 3324 | This variable is the same as `transfer.hideRefs`, but applies |
| 3325 | only to `upload-pack` (and so affects only fetches, not pushes). |
| 3326 | An attempt to fetch a hidden ref by `git fetch` will fail. See |
| 3327 | also `uploadpack.allowTipSHA1InWant`. |
| Junio C Hamano | 5e7f131 | 2013-03-21 22:49:01 | [diff] [blame] | 3328 | |
| Junio C Hamano | 85f1fde | 2015-06-01 20:37:32 | [diff] [blame] | 3329 | uploadpack.allowTipSHA1InWant:: |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 3330 | When `uploadpack.hideRefs` is in effect, allow `upload-pack` |
| Junio C Hamano | 5e7f131 | 2013-03-21 22:49:01 | [diff] [blame] | 3331 | to accept a fetch request that asks for an object at the tip |
| 3332 | of a hidden ref (by default, such a request is rejected). |
| Junio C Hamano | 56ace3d | 2017-01-10 23:43:41 | [diff] [blame] | 3333 | See also `uploadpack.hideRefs`. Even if this is false, a client |
| 3334 | may be able to steal objects via the techniques described in the |
| 3335 | "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's |
| 3336 | best to keep private data in a separate repository. |
| Junio C Hamano | 80ad00d | 2013-02-18 00:19:03 | [diff] [blame] | 3337 | |
| Junio C Hamano | 85f1fde | 2015-06-01 20:37:32 | [diff] [blame] | 3338 | uploadpack.allowReachableSHA1InWant:: |
| 3339 | Allow `upload-pack` to accept a fetch request that asks for an |
| 3340 | object that is reachable from any ref tip. However, note that |
| 3341 | calculating object reachability is computationally expensive. |
| Junio C Hamano | 56ace3d | 2017-01-10 23:43:41 | [diff] [blame] | 3342 | Defaults to `false`. Even if this is false, a client may be able |
| 3343 | to steal objects via the techniques described in the "SECURITY" |
| 3344 | section of the linkgit:gitnamespaces[7] man page; it's best to |
| 3345 | keep private data in a separate repository. |
| 3346 | |
| 3347 | uploadpack.allowAnySHA1InWant:: |
| 3348 | Allow `upload-pack` to accept a fetch request that asks for any |
| 3349 | object at all. |
| Junio C Hamano | 85f1fde | 2015-06-01 20:37:32 | [diff] [blame] | 3350 | Defaults to `false`. |
| 3351 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 3352 | uploadpack.keepAlive:: |
| Junio C Hamano | 79f4c7c | 2013-09-20 21:03:37 | [diff] [blame] | 3353 | When `upload-pack` has started `pack-objects`, there may be a |
| 3354 | quiet period while `pack-objects` prepares the pack. Normally |
| 3355 | it would output progress information, but if `--quiet` was used |
| 3356 | for the fetch, `pack-objects` will output nothing at all until |
| 3357 | the pack data begins. Some clients and networks may consider |
| 3358 | the server to be hung and give up. Setting this option instructs |
| 3359 | `upload-pack` to send an empty keepalive packet every |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 3360 | `uploadpack.keepAlive` seconds. Setting this option to 0 |
| Junio C Hamano | 79f4c7c | 2013-09-20 21:03:37 | [diff] [blame] | 3361 | disables keepalive packets entirely. The default is 5 seconds. |
| 3362 | |
| Junio C Hamano | c6c919b | 2016-07-06 21:34:15 | [diff] [blame] | 3363 | uploadpack.packObjectsHook:: |
| 3364 | If this option is set, when `upload-pack` would run |
| 3365 | `git pack-objects` to create a packfile for a client, it will |
| 3366 | run this shell command instead. The `pack-objects` command and |
| 3367 | arguments it _would_ have run (including the `git pack-objects` |
| 3368 | at the beginning) are appended to the shell command. The stdin |
| 3369 | and stdout of the hook are treated as if `pack-objects` itself |
| 3370 | was run. I.e., `upload-pack` will feed input intended for |
| 3371 | `pack-objects` to the hook, and expects a completed packfile on |
| 3372 | stdout. |
| 3373 | + |
| 3374 | Note that this configuration variable is ignored if it is seen in the |
| 3375 | repository-level config (this is a safety measure against fetching from |
| 3376 | untrusted repositories). |
| 3377 | |
| Junio C Hamano | 24bc09a | 2008-02-28 00:27:44 | [diff] [blame] | 3378 | url.<base>.insteadOf:: |
| 3379 | Any URL that starts with this value will be rewritten to |
| 3380 | start, instead, with <base>. In cases where some site serves a |
| 3381 | large number of repositories, and serves them with multiple |
| 3382 | access methods, and some users need to use different access |
| 3383 | methods, this feature allows people to specify any of the |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 3384 | equivalent URLs and have Git automatically rewrite the URL to |
| Junio C Hamano | 24bc09a | 2008-02-28 00:27:44 | [diff] [blame] | 3385 | the best alternative for the particular user, even for a |
| 3386 | never-before-seen repository on the site. When more than one |
| 3387 | insteadOf strings match a given URL, the longest match is used. |
| Junio C Hamano | e0e20df | 2017-06-04 02:10:21 | [diff] [blame] | 3388 | + |
| 3389 | Note that any protocol restrictions will be applied to the rewritten |
| 3390 | URL. If the rewrite changes the URL to use a custom protocol or remote |
| 3391 | helper, you may need to adjust the `protocol.*.allow` config to permit |
| 3392 | the request. In particular, protocols you expect to use for submodules |
| 3393 | must be set to `always` rather than the default of `user`. See the |
| 3394 | description of `protocol.allow` above. |
| Junio C Hamano | 24bc09a | 2008-02-28 00:27:44 | [diff] [blame] | 3395 | |
| Junio C Hamano | 7df6dcf | 2009-09-13 09:51:17 | [diff] [blame] | 3396 | url.<base>.pushInsteadOf:: |
| 3397 | Any URL that starts with this value will not be pushed to; |
| 3398 | instead, it will be rewritten to start with <base>, and the |
| 3399 | resulting URL will be pushed to. In cases where some site serves |
| 3400 | a large number of repositories, and serves them with multiple |
| 3401 | access methods, some of which do not allow push, this feature |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 3402 | allows people to specify a pull-only URL and have Git |
| Junio C Hamano | 7df6dcf | 2009-09-13 09:51:17 | [diff] [blame] | 3403 | automatically use an appropriate URL to push, even for a |
| 3404 | never-before-seen repository on the site. When more than one |
| 3405 | pushInsteadOf strings match a given URL, the longest match is |
| Junio C Hamano | 076ffcc | 2013-02-06 05:13:21 | [diff] [blame] | 3406 | used. If a remote has an explicit pushurl, Git will ignore this |
| Junio C Hamano | 7df6dcf | 2009-09-13 09:51:17 | [diff] [blame] | 3407 | setting for that remote. |
| 3408 | |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 3409 | user.email:: |
| 3410 | Your email address to be recorded in any newly created commits. |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 3411 | Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and |
| 3412 | `EMAIL` environment variables. See linkgit:git-commit-tree[1]. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 3413 | |
| 3414 | user.name:: |
| 3415 | Your full name to be recorded in any newly created commits. |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 3416 | Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME` |
| Junio C Hamano | 35738e8 | 2008-01-07 07:55:46 | [diff] [blame] | 3417 | environment variables. See linkgit:git-commit-tree[1]. |
| Junio C Hamano | 07824ce | 2006-04-25 07:36:54 | [diff] [blame] | 3418 | |
| Junio C Hamano | f85ef63 | 2016-02-17 22:31:06 | [diff] [blame] | 3419 | user.useConfigOnly:: |
| Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 3420 | Instruct Git to avoid trying to guess defaults for `user.email` |
| 3421 | and `user.name`, and instead retrieve the values only from the |
| Junio C Hamano | f85ef63 | 2016-02-17 22:31:06 | [diff] [blame] | 3422 | configuration. For example, if you have multiple email addresses |
| 3423 | and would like to use a different one for each repository, then |
| 3424 | with this configuration option set to `true` in the global config |
| 3425 | along with a name, Git will prompt you to set up an email before |
| 3426 | making new commits in a newly cloned repository. |
| 3427 | Defaults to `false`. |
| 3428 | |
| Junio C Hamano | 322c624 | 2015-03-23 21:32:46 | [diff] [blame] | 3429 | user.signingKey:: |
| Junio C Hamano | 369e340 | 2013-10-15 18:40:25 | [diff] [blame] | 3430 | If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the |
| 3431 | key you want it to automatically when creating a signed tag or |
| 3432 | commit, you can override the default selection with this variable. |
| 3433 | This option is passed unchanged to gpg's --local-user parameter, |
| 3434 | so you may specify a key using any method that gpg supports. |
| Junio C Hamano | a890c4f | 2007-01-28 10:29:21 | [diff] [blame] | 3435 | |
| Junio C Hamano | bcd98f4 | 2017-01-24 00:12:16 | [diff] [blame] | 3436 | versionsort.prereleaseSuffix (deprecated):: |
| 3437 | Deprecated alias for `versionsort.suffix`. Ignored if |
| 3438 | `versionsort.suffix` is set. |
| 3439 | |
| 3440 | versionsort.suffix:: |
| 3441 | Even when version sort is used in linkgit:git-tag[1], tagnames |
| 3442 | with the same base version but different suffixes are still sorted |
| 3443 | lexicographically, resulting e.g. in prerelease tags appearing |
| 3444 | after the main release (e.g. "1.0-rc1" after "1.0"). This |
| 3445 | variable can be specified to determine the sorting order of tags |
| 3446 | with different suffixes. |
| Junio C Hamano | 0762262 | 2015-03-20 21:47:26 | [diff] [blame] | 3447 | + |
| Junio C Hamano | bcd98f4 | 2017-01-24 00:12:16 | [diff] [blame] | 3448 | By specifying a single suffix in this variable, any tagname containing |
| 3449 | that suffix will appear before the corresponding main release. E.g. if |
| 3450 | the variable is set to "-rc", then all "1.0-rcX" tags will appear before |
| 3451 | "1.0". If specified multiple times, once per suffix, then the order of |
| 3452 | suffixes in the configuration will determine the sorting order of tagnames |
| 3453 | with those suffixes. E.g. if "-pre" appears before "-rc" in the |
| 3454 | configuration, then all "1.0-preX" tags will be listed before any |
| 3455 | "1.0-rcX" tags. The placement of the main release tag relative to tags |
| 3456 | with various suffixes can be determined by specifying the empty suffix |
| 3457 | among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and |
| 3458 | "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags |
| 3459 | are listed first, followed by "v4.8", then "v4.8-ckX" and finally |
| 3460 | "v4.8-bfsX". |
| 3461 | + |
| 3462 | If more than one suffixes match the same tagname, then that tagname will |
| 3463 | be sorted according to the suffix which starts at the earliest position in |
| 3464 | the tagname. If more than one different matching suffixes start at |
| 3465 | that earliest position, then that tagname will be sorted according to the |
| 3466 | longest of those suffixes. |
| 3467 | The sorting order between different suffixes is undefined if they are |
| 3468 | in multiple config files. |
| Junio C Hamano | 0762262 | 2015-03-20 21:47:26 | [diff] [blame] | 3469 | |
| Junio C Hamano | 4e27231 | 2008-01-08 09:13:21 | [diff] [blame] | 3470 | web.browser:: |
| 3471 | Specify a web browser that may be used by some commands. |
| 3472 | Currently only linkgit:git-instaweb[1] and linkgit:git-help[1] |
| 3473 | may use it. |
| Junio C Hamano | 047135e | 2017-12-19 21:57:54 | [diff] [blame^] | 3474 | |
| 3475 | worktree.guessRemote:: |
| 3476 | With `add`, if no branch argument, and neither of `-b` nor |
| 3477 | `-B` nor `--detach` are given, the command defaults to |
| 3478 | creating a new branch from HEAD. If `worktree.guessRemote` is |
| 3479 | set to true, `worktree add` tries to find a remote-tracking |
| 3480 | branch whose name uniquely matches the new branch name. If |
| 3481 | such a branch exists, it is checked out and set as "upstream" |
| 3482 | for the new branch. If no such match can be found, it falls |
| 3483 | back to creating a new branch from the current HEAD. |