]>
Commit | Line | Data |
---|---|---|
9e1f0a85 | 1 | git(1) |
2cf565c5 | 2 | ====== |
2cf565c5 DG |
3 | |
4 | NAME | |
5 | ---- | |
6 | git - the stupid content tracker | |
7 | ||
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
8b70004b | 11 | [verse] |
6b52f48b | 12 | 'git' [-v | --version] [-h | --help] [-C <path>] [-c <name>=<value>] |
68e4b552 | 13 | [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path] |
7213c288 | 14 | [-p|--paginate|-P|--no-pager] [--no-replace-objects] [--bare] |
d49483f0 | 15 | [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>] |
9152904c | 16 | [--super-prefix=<path>] [--config-env=<name>=<envvar>] |
68e4b552 | 17 | <command> [<args>] |
2cf565c5 DG |
18 | |
19 | DESCRIPTION | |
20 | ----------- | |
23091e95 BF |
21 | Git is a fast, scalable, distributed revision control system with an |
22 | unusually rich command set that provides both high-level operations | |
23 | and full access to internals. | |
24 | ||
6998e4db | 25 | See linkgit:gittutorial[7] to get started, then see |
673151a9 | 26 | linkgit:giteveryday[7] for a useful minimum set of |
7687ae98 JH |
27 | commands. The link:user-manual.html[Git User's Manual] has a more |
28 | in-depth introduction. | |
cb22bc44 | 29 | |
7687ae98 | 30 | After you mastered the basic concepts, you can come back to this |
2de9b711 TA |
31 | page to learn what commands Git offers. You can learn more about |
32 | individual Git commands with "git help command". linkgit:gitcli[7] | |
06ab60c0 | 33 | manual page gives you an overview of the command-line command syntax. |
4514ad4f | 34 | |
f7935827 | 35 | A formatted and hyperlinked copy of the latest Git documentation |
e2dca456 PO |
36 | can be viewed at https://git.github.io/htmldocs/git.html |
37 | or https://git-scm.com/docs. | |
34b604af | 38 | |
26cfcfbf | 39 | |
cb22bc44 AE |
40 | OPTIONS |
41 | ------- | |
6b52f48b | 42 | -v:: |
cb22bc44 | 43 | --version:: |
2de9b711 | 44 | Prints the Git suite version that the 'git' program came from. |
b6d8887d | 45 | + |
82a57cd1 | 46 | This option is internally converted to `git version ...` and accepts |
b6d8887d MA |
47 | the same options as the linkgit:git-version[1] command. If `--help` is |
48 | also given, it takes precedence over `--version`. | |
cb22bc44 | 49 | |
6b52f48b | 50 | -h:: |
cb22bc44 | 51 | --help:: |
a87cd02c | 52 | Prints the synopsis and a list of the most commonly used |
bcf9626a | 53 | commands. If the option `--all` or `-a` is given then all |
2de9b711 | 54 | available commands are printed. If a Git command is named this |
0f6f195b | 55 | option will bring up the manual page for that command. |
45533d26 CC |
56 | + |
57 | Other options are available to control how the manual page is | |
5162e697 | 58 | displayed. See linkgit:git-help[1] for more information, |
db5d6666 JN |
59 | because `git --help ...` is converted internally into `git |
60 | help ...`. | |
cb22bc44 | 61 | |
44e1e4d6 NR |
62 | -C <path>:: |
63 | Run as if git was started in '<path>' instead of the current working | |
64 | directory. When multiple `-C` options are given, each subsequent | |
65 | non-absolute `-C <path>` is interpreted relative to the preceding `-C | |
1a64e07d SG |
66 | <path>`. If '<path>' is present but empty, e.g. `-C ""`, then the |
67 | current working directory is left unchanged. | |
44e1e4d6 NR |
68 | + |
69 | This option affects options that expect path name like `--git-dir` and | |
70 | `--work-tree` in that their interpretations of the path names would be | |
71 | made relative to the working directory caused by the `-C` option. For | |
72 | example the following invocations are equivalent: | |
73 | ||
74 | git --git-dir=a.git --work-tree=b -C c status | |
75 | git --git-dir=c/a.git --work-tree=c/b status | |
76 | ||
8b1fa778 AR |
77 | -c <name>=<value>:: |
78 | Pass a configuration parameter to the command. The value | |
79 | given will override values from configuration files. | |
80 | The <name> is expected in the same format as listed by | |
81 | 'git config' (subkeys separated by dots). | |
a789ca70 JH |
82 | + |
83 | Note that omitting the `=` in `git -c foo.bar ...` is allowed and sets | |
84 | `foo.bar` to the boolean true value (just like `[foo]bar` would in a | |
85 | config file). Including the equals but with an empty value (like `git -c | |
5e633326 | 86 | foo.bar= ...`) sets `foo.bar` to the empty string which `git config |
ed3bb3df | 87 | --type=bool` will convert to `false`. |
8b1fa778 | 88 | |
ce81b1da PS |
89 | --config-env=<name>=<envvar>:: |
90 | Like `-c <name>=<value>`, give configuration variable | |
91 | '<name>' a value, where <envvar> is the name of an | |
92 | environment variable from which to retrieve the value. Unlike | |
93 | `-c` there is no shortcut for directly setting the value to an | |
94 | empty string, instead the environment variable itself must be | |
95 | set to the empty string. It is an error if the `<envvar>` does not exist | |
96 | in the environment. `<envvar>` may not contain an equals sign | |
83171ede | 97 | to avoid ambiguity with `<name>` containing one. |
ce81b1da PS |
98 | + |
99 | This is useful for cases where you want to pass transitory | |
100 | configuration options to git, but are doing so on OS's where | |
101 | other processes might be able to read your cmdline | |
102 | (e.g. `/proc/self/cmdline`), but not your environ | |
103 | (e.g. `/proc/self/environ`). That behavior is the default on | |
104 | Linux, but may not be on your system. | |
105 | + | |
106 | Note that this might add security for variables such as | |
107 | `http.extraHeader` where the sensitive information is part of | |
108 | the value, but not e.g. `url.<base>.insteadOf` where the | |
109 | sensitive information can be part of the key. | |
110 | ||
62b4698e | 111 | --exec-path[=<path>]:: |
2de9b711 | 112 | Path to wherever your core Git programs are installed. |
cb22bc44 | 113 | This can also be controlled by setting the GIT_EXEC_PATH |
56992f76 | 114 | environment variable. If no path is given, 'git' will print |
cb22bc44 AE |
115 | the current setting and then exit. |
116 | ||
89a56bfb | 117 | --html-path:: |
2de9b711 | 118 | Print the path, without trailing slash, where Git's HTML |
239b5ed9 | 119 | documentation is installed and exit. |
89a56bfb | 120 | |
f2dd8c37 | 121 | --man-path:: |
239b5ed9 | 122 | Print the manpath (see `man(1)`) for the man pages for |
2de9b711 | 123 | this version of Git and exit. |
f2dd8c37 JS |
124 | |
125 | --info-path:: | |
239b5ed9 | 126 | Print the path where the Info files documenting this |
2de9b711 | 127 | version of Git are installed and exit. |
89a56bfb | 128 | |
3240240f SB |
129 | -p:: |
130 | --paginate:: | |
06300d97 JN |
131 | Pipe all output into 'less' (or if set, $PAGER) if standard |
132 | output is a terminal. This overrides the `pager.<cmd>` | |
133 | configuration options (see the "Configuration Mechanism" section | |
134 | below). | |
6acbcb92 | 135 | |
7213c288 | 136 | -P:: |
463a849d | 137 | --no-pager:: |
2de9b711 | 138 | Do not pipe Git output into a pager. |
463a849d | 139 | |
6acbcb92 | 140 | --git-dir=<path>:: |
d82ad549 HW |
141 | Set the path to the repository (".git" directory). This can also be |
142 | controlled by setting the `GIT_DIR` environment variable. It can be | |
143 | an absolute path or relative path to current working directory. | |
144 | + | |
145 | Specifying the location of the ".git" directory using this | |
146 | option (or `GIT_DIR` environment variable) turns off the | |
147 | repository discovery that tries to find a directory with | |
148 | ".git" subdirectory (which is how the repository and the | |
149 | top-level of the working tree are discovered), and tells Git | |
150 | that you are at the top level of the working tree. If you | |
151 | are not at the top-level directory of the working tree, you | |
152 | should tell Git where the top-level of the working tree is, | |
153 | with the `--work-tree=<path>` option (or `GIT_WORK_TREE` | |
154 | environment variable) | |
155 | + | |
156 | If you just want to run git as if it was started in `<path>` then use | |
157 | `git -C <path>`. | |
6acbcb92 | 158 | |
892c41b9 | 159 | --work-tree=<path>:: |
ea472c1e JH |
160 | Set the path to the working tree. It can be an absolute path |
161 | or a path relative to the current working directory. | |
892c41b9 ML |
162 | This can also be controlled by setting the GIT_WORK_TREE |
163 | environment variable and the core.worktree configuration | |
ea472c1e JH |
164 | variable (see core.worktree in linkgit:git-config[1] for a |
165 | more detailed discussion). | |
892c41b9 | 166 | |
d49483f0 | 167 | --namespace=<path>:: |
2de9b711 | 168 | Set the Git namespace. See linkgit:gitnamespaces[7] for more |
d49483f0 JT |
169 | details. Equivalent to setting the `GIT_NAMESPACE` environment |
170 | variable. | |
171 | ||
74866d75 BW |
172 | --super-prefix=<path>:: |
173 | Currently for internal use only. Set a prefix which gives a path from | |
174 | above a repository down to its root. One use is to give submodules | |
175 | context about the superproject that invoked it. | |
176 | ||
6acbcb92 | 177 | --bare:: |
9277d602 JH |
178 | Treat the repository as a bare repository. If GIT_DIR |
179 | environment is not set, it is set to the current working | |
180 | directory. | |
181 | ||
b0fa7ab5 | 182 | --no-replace-objects:: |
2de9b711 | 183 | Do not use replacement refs to replace Git objects. See |
b0fa7ab5 CC |
184 | linkgit:git-replace[1] for more information. |
185 | ||
823ab40f | 186 | --literal-pathspecs:: |
a16bf9dd NTND |
187 | Treat pathspecs literally (i.e. no globbing, no pathspec magic). |
188 | This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment | |
823ab40f JK |
189 | variable to `1`. |
190 | ||
6fb02165 | 191 | --glob-pathspecs:: |
bd30c2e4 NTND |
192 | Add "glob" magic to all pathspec. This is equivalent to setting |
193 | the `GIT_GLOB_PATHSPECS` environment variable to `1`. Disabling | |
194 | globbing on individual pathspecs can be done using pathspec | |
195 | magic ":(literal)" | |
196 | ||
6fb02165 | 197 | --noglob-pathspecs:: |
bd30c2e4 NTND |
198 | Add "literal" magic to all pathspec. This is equivalent to setting |
199 | the `GIT_NOGLOB_PATHSPECS` environment variable to `1`. Enabling | |
200 | globbing on individual pathspecs can be done using pathspec | |
201 | magic ":(glob)" | |
9755afbd | 202 | |
6fb02165 | 203 | --icase-pathspecs:: |
93d93537 NTND |
204 | Add "icase" magic to all pathspec. This is equivalent to setting |
205 | the `GIT_ICASE_PATHSPECS` environment variable to `1`. | |
9755afbd | 206 | |
27344d6a JK |
207 | --no-optional-locks:: |
208 | Do not perform optional operations that require locks. This is | |
209 | equivalent to setting the `GIT_OPTIONAL_LOCKS` to `0`. | |
210 | ||
0089521c NTND |
211 | --list-cmds=group[,group...]:: |
212 | List commands by group. This is an internal/experimental | |
213 | option and may change or be removed in the future. Supported | |
214 | groups are: builtins, parseopt (builtin commands that use | |
6bb2dc0b | 215 | parse-options), main (all commands in libexec directory), |
3c777767 | 216 | others (all other commands in `$PATH` that have git- prefix), |
e11dca10 | 217 | list-<category> (see categories in command-list.txt), |
6532f374 NTND |
218 | nohelpers (exclude helper commands), alias and config |
219 | (retrieve command list from config variable completion.commands) | |
0089521c | 220 | |
23091e95 BF |
221 | GIT COMMANDS |
222 | ------------ | |
9755afbd | 223 | |
2de9b711 | 224 | We divide Git into high level ("porcelain") commands and low level |
23091e95 | 225 | ("plumbing") commands. |
8b15e2fb | 226 | |
23091e95 BF |
227 | High-level commands (porcelain) |
228 | ------------------------------- | |
229 | ||
230 | We separate the porcelain commands into the main commands and some | |
231 | ancillary user utilities. | |
232 | ||
233 | Main porcelain commands | |
234 | ~~~~~~~~~~~~~~~~~~~~~~~ | |
905197de | 235 | |
377e8139 | 236 | include::cmds-mainporcelain.txt[] |
e31bb3bb | 237 | |
90933efb | 238 | Ancillary Commands |
23091e95 | 239 | ~~~~~~~~~~~~~~~~~~ |
2f2de9b4 JH |
240 | Manipulators: |
241 | ||
377e8139 | 242 | include::cmds-ancillarymanipulators.txt[] |
204ee6a9 | 243 | |
90933efb | 244 | Interrogators: |
204ee6a9 | 245 | |
377e8139 | 246 | include::cmds-ancillaryinterrogators.txt[] |
7fc9d69f | 247 | |
89bf2077 JH |
248 | |
249 | Interacting with Others | |
250 | ~~~~~~~~~~~~~~~~~~~~~~~ | |
251 | ||
252 | These commands are to interact with foreign SCM and with other | |
253 | people via patch over e-mail. | |
254 | ||
255 | include::cmds-foreignscminterface.txt[] | |
256 | ||
46e91b66 NTND |
257 | Reset, restore and revert |
258 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | |
259 | There are three commands with similar names: `git reset`, | |
260 | `git restore` and `git revert`. | |
261 | ||
262 | * linkgit:git-revert[1] is about making a new commit that reverts the | |
263 | changes made by other commits. | |
264 | ||
265 | * linkgit:git-restore[1] is about restoring files in the working tree | |
266 | from either the index or another commit. This command does not | |
267 | update your branch. The command can also be used to restore files in | |
268 | the index from another commit. | |
269 | ||
270 | * linkgit:git-reset[1] is about updating your branch, moving the tip | |
271 | in order to add or remove commits from the branch. This operation | |
272 | changes the commit history. | |
273 | + | |
274 | `git reset` can also be used to restore the index, overlapping with | |
275 | `git restore`. | |
276 | ||
89bf2077 | 277 | |
b1f33d62 RR |
278 | Low-level commands (plumbing) |
279 | ----------------------------- | |
280 | ||
2de9b711 | 281 | Although Git includes its |
b1f33d62 RR |
282 | own porcelain layer, its low-level commands are sufficient to support |
283 | development of alternative porcelains. Developers of such porcelains | |
5162e697 DM |
284 | might start by reading about linkgit:git-update-index[1] and |
285 | linkgit:git-read-tree[1]. | |
b1f33d62 | 286 | |
89bf2077 JH |
287 | The interface (input, output, set of options and the semantics) |
288 | to these low-level commands are meant to be a lot more stable | |
289 | than Porcelain level commands, because these commands are | |
290 | primarily for scripted use. The interface to Porcelain commands | |
291 | on the other hand are subject to change in order to improve the | |
292 | end user experience. | |
293 | ||
294 | The following description divides | |
295 | the low-level commands into commands that manipulate objects (in | |
b1f33d62 RR |
296 | the repository, index, and working tree), commands that interrogate and |
297 | compare objects, and commands that move objects and references between | |
298 | repositories. | |
299 | ||
89bf2077 | 300 | |
b1f33d62 RR |
301 | Manipulation commands |
302 | ~~~~~~~~~~~~~~~~~~~~~ | |
b1f33d62 | 303 | |
377e8139 | 304 | include::cmds-plumbingmanipulators.txt[] |
b1f33d62 RR |
305 | |
306 | ||
307 | Interrogation commands | |
308 | ~~~~~~~~~~~~~~~~~~~~~~ | |
309 | ||
377e8139 | 310 | include::cmds-plumbinginterrogators.txt[] |
b1f33d62 RR |
311 | |
312 | In general, the interrogate commands do not touch the files in | |
313 | the working tree. | |
314 | ||
315 | ||
031fd4b9 EN |
316 | Syncing repositories |
317 | ~~~~~~~~~~~~~~~~~~~~ | |
b1f33d62 | 318 | |
377e8139 | 319 | include::cmds-synchingrepositories.txt[] |
b1f33d62 | 320 | |
57f6ec02 | 321 | The following are helper commands used by the above; end users |
89bf2077 JH |
322 | typically do not use them directly. |
323 | ||
324 | include::cmds-synchelpers.txt[] | |
325 | ||
326 | ||
327 | Internal helper commands | |
328 | ~~~~~~~~~~~~~~~~~~~~~~~~ | |
329 | ||
330 | These are internal helper commands used by other commands; end | |
331 | users typically do not use them directly. | |
332 | ||
333 | include::cmds-purehelpers.txt[] | |
334 | ||
f442f28a PB |
335 | Guides |
336 | ------ | |
337 | ||
338 | The following documentation pages are guides about Git concepts. | |
339 | ||
340 | include::cmds-guide.txt[] | |
341 | ||
b1f33d62 | 342 | |
5773c9f2 JH |
343 | Configuration Mechanism |
344 | ----------------------- | |
345 | ||
c0179c0d MM |
346 | Git uses a simple text format to store customizations that are per |
347 | repository and are per user. Such a configuration file may look | |
348 | like this: | |
5773c9f2 JH |
349 | |
350 | ------------ | |
351 | # | |
2fa090b6 | 352 | # A '#' or ';' character indicates a comment. |
5773c9f2 JH |
353 | # |
354 | ||
355 | ; core variables | |
356 | [core] | |
357 | ; Don't trust file modes | |
358 | filemode = false | |
359 | ||
360 | ; user identity | |
361 | [user] | |
362 | name = "Junio C Hamano" | |
c0179c0d | 363 | email = "gitster@pobox.com" |
5773c9f2 JH |
364 | |
365 | ------------ | |
366 | ||
367 | Various commands read from the configuration file and adjust | |
06300d97 | 368 | their operation accordingly. See linkgit:git-config[1] for a |
c0179c0d | 369 | list and more details about the configuration mechanism. |
5773c9f2 JH |
370 | |
371 | ||
6c84e2e0 | 372 | Identifier Terminology |
2cf565c5 DG |
373 | ---------------------- |
374 | <object>:: | |
2fa090b6 | 375 | Indicates the object name for any type of object. |
2cf565c5 DG |
376 | |
377 | <blob>:: | |
2fa090b6 | 378 | Indicates a blob object name. |
2cf565c5 DG |
379 | |
380 | <tree>:: | |
2fa090b6 | 381 | Indicates a tree object name. |
2cf565c5 DG |
382 | |
383 | <commit>:: | |
2fa090b6 | 384 | Indicates a commit object name. |
2cf565c5 DG |
385 | |
386 | <tree-ish>:: | |
2fa090b6 | 387 | Indicates a tree, commit or tag object name. A |
6c84e2e0 DG |
388 | command that takes a <tree-ish> argument ultimately wants to |
389 | operate on a <tree> object but automatically dereferences | |
390 | <commit> and <tag> objects that point at a <tree>. | |
2cf565c5 | 391 | |
043d7605 TT |
392 | <commit-ish>:: |
393 | Indicates a commit or tag object name. A | |
394 | command that takes a <commit-ish> argument ultimately wants to | |
395 | operate on a <commit> object but automatically dereferences | |
396 | <tag> objects that point at a <commit>. | |
397 | ||
2cf565c5 DG |
398 | <type>:: |
399 | Indicates that an object type is required. | |
2fa090b6 | 400 | Currently one of: `blob`, `tree`, `commit`, or `tag`. |
2cf565c5 DG |
401 | |
402 | <file>:: | |
2fa090b6 JH |
403 | Indicates a filename - almost always relative to the |
404 | root of the tree structure `GIT_INDEX_FILE` describes. | |
2cf565c5 | 405 | |
c1bdacf9 DG |
406 | Symbolic Identifiers |
407 | -------------------- | |
2de9b711 | 408 | Any Git command accepting any <object> can also use the following |
6c84e2e0 | 409 | symbolic notation: |
c1bdacf9 DG |
410 | |
411 | HEAD:: | |
0abcfbff | 412 | indicates the head of the current branch. |
2fa090b6 | 413 | |
c1bdacf9 | 414 | <tag>:: |
2fa090b6 | 415 | a valid tag 'name' |
0abcfbff | 416 | (i.e. a `refs/tags/<tag>` reference). |
2fa090b6 | 417 | |
c1bdacf9 | 418 | <head>:: |
2fa090b6 | 419 | a valid head 'name' |
0abcfbff | 420 | (i.e. a `refs/heads/<head>` reference). |
2fa090b6 | 421 | |
d47107d8 | 422 | For a more complete list of ways to spell object names, see |
9d83e382 | 423 | "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7]. |
d47107d8 | 424 | |
c1bdacf9 DG |
425 | |
426 | File/Directory Structure | |
427 | ------------------------ | |
c1bdacf9 | 428 | |
6998e4db | 429 | Please see the linkgit:gitrepository-layout[5] document. |
c1bdacf9 | 430 | |
6998e4db | 431 | Read linkgit:githooks[5] for more details about each hook. |
6250ad1e | 432 | |
c1bdacf9 | 433 | Higher level SCMs may provide and manage additional information in the |
2fa090b6 | 434 | `$GIT_DIR`. |
c1bdacf9 | 435 | |
a1d4aa74 | 436 | |
2cf565c5 DG |
437 | Terminology |
438 | ----------- | |
6998e4db | 439 | Please see linkgit:gitglossary[7]. |
2cf565c5 DG |
440 | |
441 | ||
442 | Environment Variables | |
443 | --------------------- | |
80f0b3f3 JH |
444 | Various Git commands pay attention to environment variables and change |
445 | their behavior. The environment variables marked as "Boolean" take | |
446 | their values the same way as Boolean valued configuration variables, e.g. | |
447 | "true", "yes", "on" and positive numbers are taken as "yes". | |
448 | ||
449 | Here are the variables: | |
2cf565c5 | 450 | |
2de9b711 | 451 | The Git Repository |
c1bdacf9 | 452 | ~~~~~~~~~~~~~~~~~~ |
2de9b711 | 453 | These environment variables apply to 'all' core Git commands. Nb: it |
c1bdacf9 | 454 | is worth noting that they may be used/overridden by SCMS sitting above |
f25b98e6 | 455 | Git so take care if using a foreign front-end. |
c1bdacf9 | 456 | |
eee7f4a2 | 457 | `GIT_INDEX_FILE`:: |
c1bdacf9 | 458 | This environment allows the specification of an alternate |
5f3aa197 LS |
459 | index file. If not specified, the default of `$GIT_DIR/index` |
460 | is used. | |
c1bdacf9 | 461 | |
eee7f4a2 | 462 | `GIT_INDEX_VERSION`:: |
136347d7 TG |
463 | This environment variable allows the specification of an index |
464 | version for new repositories. It won't affect existing index | |
70320541 NTND |
465 | files. By default index file version 2 or 3 is used. See |
466 | linkgit:git-update-index[1] for more information. | |
136347d7 | 467 | |
eee7f4a2 | 468 | `GIT_OBJECT_DIRECTORY`:: |
c1bdacf9 DG |
469 | If the object storage directory is specified via this |
470 | environment variable then the sha1 directories are created | |
471 | underneath - otherwise the default `$GIT_DIR/objects` | |
472 | directory is used. | |
473 | ||
eee7f4a2 | 474 | `GIT_ALTERNATE_OBJECT_DIRECTORIES`:: |
2de9b711 | 475 | Due to the immutable nature of Git objects, old objects can be |
c1bdacf9 | 476 | archived into shared, read-only directories. This variable |
80ba074f | 477 | specifies a ":" separated (on Windows ";" separated) list |
2de9b711 | 478 | of Git object directories which can be used to search for Git |
80ba074f | 479 | objects. New objects will not be written to these directories. |
cf3c6352 | 480 | + |
ad471949 AH |
481 | Entries that begin with `"` (double-quote) will be interpreted |
482 | as C-style quoted paths, removing leading and trailing | |
483 | double-quotes and respecting backslash escapes. E.g., the value | |
484 | `"path-with-\"-and-:-in-it":vanilla-path` has two paths: | |
485 | `path-with-"-and-:-in-it` and `vanilla-path`. | |
c1bdacf9 | 486 | |
eee7f4a2 TR |
487 | `GIT_DIR`:: |
488 | If the `GIT_DIR` environment variable is set then it | |
2fa090b6 JH |
489 | specifies a path to use instead of the default `.git` |
490 | for the base of the repository. | |
bcf9626a | 491 | The `--git-dir` command-line option also sets this value. |
c1bdacf9 | 492 | |
eee7f4a2 | 493 | `GIT_WORK_TREE`:: |
a758a349 | 494 | Set the path to the root of the working tree. |
bcf9626a | 495 | This can also be controlled by the `--work-tree` command-line |
892c41b9 ML |
496 | option and the core.worktree configuration variable. |
497 | ||
eee7f4a2 | 498 | `GIT_NAMESPACE`:: |
2de9b711 | 499 | Set the Git namespace; see linkgit:gitnamespaces[7] for details. |
bcf9626a | 500 | The `--namespace` command-line option also sets this value. |
d49483f0 | 501 | |
eee7f4a2 | 502 | `GIT_CEILING_DIRECTORIES`:: |
7ec30aaa | 503 | This should be a colon-separated list of absolute paths. If |
3e07d268 | 504 | set, it is a list of directories that Git should not chdir up |
7ec30aaa MH |
505 | into while looking for a repository directory (useful for |
506 | excluding slow-loading network directories). It will not | |
507 | exclude the current working directory or a GIT_DIR set on the | |
508 | command line or in the environment. Normally, Git has to read | |
509 | the entries in this list and resolve any symlink that | |
510 | might be present in order to compare them with the current | |
511 | directory. However, if even this access is slow, you | |
512 | can add an empty entry to the list to tell Git that the | |
513 | subsequent entries are not symlinks and needn't be resolved; | |
514 | e.g., | |
eee7f4a2 | 515 | `GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink`. |
0454dd93 | 516 | |
eee7f4a2 | 517 | `GIT_DISCOVERY_ACROSS_FILESYSTEM`:: |
e6405517 | 518 | When run in a directory that does not have ".git" repository |
2de9b711 | 519 | directory, Git tries to find such a directory in the parent |
e6405517 | 520 | directories to find the top of the working tree, but by default it |
80f0b3f3 | 521 | does not cross filesystem boundaries. This Boolean environment variable |
2de9b711 | 522 | can be set to true to tell Git not to stop at filesystem |
eee7f4a2 TR |
523 | boundaries. Like `GIT_CEILING_DIRECTORIES`, this will not affect |
524 | an explicit repository directory set via `GIT_DIR` or on the | |
cf87463e | 525 | command line. |
8030e442 | 526 | |
eee7f4a2 | 527 | `GIT_COMMON_DIR`:: |
c7b3a3d2 NTND |
528 | If this variable is set to a path, non-worktree files that are |
529 | normally in $GIT_DIR will be taken from this path | |
530 | instead. Worktree-specific files such as HEAD or index are | |
529fef20 | 531 | taken from $GIT_DIR. See linkgit:gitrepository-layout[5] and |
1eaca7a5 | 532 | linkgit:git-worktree[1] for |
c7b3a3d2 NTND |
533 | details. This variable has lower precedence than other path |
534 | variables such as GIT_INDEX_FILE, GIT_OBJECT_DIRECTORY... | |
535 | ||
ed11a5a7 | 536 | `GIT_DEFAULT_HASH`:: |
3c9331a1 | 537 | If this variable is set, the default hash algorithm for new |
538 | repositories will be set to this value. This value is currently | |
539 | ignored when cloning; the setting of the remote repository | |
ff233d8d MÅ |
540 | is used instead. The default is "sha1". THIS VARIABLE IS |
541 | EXPERIMENTAL! See `--object-format` in linkgit:git-init[1]. | |
3c9331a1 | 542 | |
2de9b711 | 543 | Git Commits |
c1bdacf9 | 544 | ~~~~~~~~~~~ |
eee7f4a2 | 545 | `GIT_AUTHOR_NAME`:: |
bc94e586 | 546 | The human-readable name used in the author identity when creating commit or |
547 | tag objects, or when writing reflogs. Overrides the `user.name` and | |
548 | `author.name` configuration settings. | |
549 | ||
eee7f4a2 | 550 | `GIT_AUTHOR_EMAIL`:: |
bc94e586 | 551 | The email address used in the author identity when creating commit or |
552 | tag objects, or when writing reflogs. Overrides the `user.email` and | |
553 | `author.email` configuration settings. | |
554 | ||
eee7f4a2 | 555 | `GIT_AUTHOR_DATE`:: |
bc94e586 | 556 | The date used for the author identity when creating commit or tag objects, or |
557 | when writing reflogs. See linkgit:git-commit[1] for valid formats. | |
558 | ||
eee7f4a2 | 559 | `GIT_COMMITTER_NAME`:: |
bc94e586 | 560 | The human-readable name used in the committer identity when creating commit or |
561 | tag objects, or when writing reflogs. Overrides the `user.name` and | |
562 | `committer.name` configuration settings. | |
563 | ||
eee7f4a2 | 564 | `GIT_COMMITTER_EMAIL`:: |
bc94e586 | 565 | The email address used in the author identity when creating commit or |
566 | tag objects, or when writing reflogs. Overrides the `user.email` and | |
567 | `committer.email` configuration settings. | |
568 | ||
eee7f4a2 | 569 | `GIT_COMMITTER_DATE`:: |
bc94e586 | 570 | The date used for the committer identity when creating commit or tag objects, or |
571 | when writing reflogs. See linkgit:git-commit[1] for valid formats. | |
572 | ||
573 | `EMAIL`:: | |
574 | The email address used in the author and committer identities if no other | |
575 | relevant environment variable or configuration setting has been set. | |
c1bdacf9 | 576 | |
2de9b711 | 577 | Git Diffs |
c1bdacf9 | 578 | ~~~~~~~~~ |
eee7f4a2 | 579 | `GIT_DIFF_OPTS`:: |
fde97d8a SE |
580 | Only valid setting is "--unified=??" or "-u??" to set the |
581 | number of context lines shown when a unified diff is created. | |
582 | This takes precedence over any "-U" or "--unified" option | |
2de9b711 | 583 | value passed on the Git diff command line. |
fde97d8a | 584 | |
eee7f4a2 TR |
585 | `GIT_EXTERNAL_DIFF`:: |
586 | When the environment variable `GIT_EXTERNAL_DIFF` is set, the | |
17bae894 PB |
587 | program named by it is called to generate diffs, and Git |
588 | does not use its builtin diff machinery. | |
589 | For a path that is added, removed, or modified, | |
eee7f4a2 | 590 | `GIT_EXTERNAL_DIFF` is called with 7 parameters: |
fde97d8a SE |
591 | |
592 | path old-file old-hex old-mode new-file new-hex new-mode | |
593 | + | |
594 | where: | |
595 | ||
596 | <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the | |
597 | contents of <old|new>, | |
d5fa1f1a | 598 | <old|new>-hex:: are the 40-hexdigit SHA-1 hashes, |
fde97d8a | 599 | <old|new>-mode:: are the octal representation of the file modes. |
fde97d8a SE |
600 | + |
601 | The file parameters can point at the user's working file | |
602 | (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file` | |
603 | when a new file is added), or a temporary file (e.g. `old-file` in the | |
eee7f4a2 TR |
604 | index). `GIT_EXTERNAL_DIFF` should not worry about unlinking the |
605 | temporary file --- it is removed when `GIT_EXTERNAL_DIFF` exits. | |
fde97d8a | 606 | + |
eee7f4a2 | 607 | For a path that is unmerged, `GIT_EXTERNAL_DIFF` is called with 1 |
fde97d8a | 608 | parameter, <path>. |
ee7fb0b1 | 609 | + |
eee7f4a2 TR |
610 | For each path `GIT_EXTERNAL_DIFF` is called, two environment variables, |
611 | `GIT_DIFF_PATH_COUNTER` and `GIT_DIFF_PATH_TOTAL` are set. | |
ee7fb0b1 | 612 | |
eee7f4a2 | 613 | `GIT_DIFF_PATH_COUNTER`:: |
ee7fb0b1 ZK |
614 | A 1-based counter incremented by one for every path. |
615 | ||
eee7f4a2 | 616 | `GIT_DIFF_PATH_TOTAL`:: |
ee7fb0b1 | 617 | The total number of paths. |
2cf565c5 | 618 | |
575ba9d6 ML |
619 | other |
620 | ~~~~~ | |
eee7f4a2 | 621 | `GIT_MERGE_VERBOSITY`:: |
dbddb714 JN |
622 | A number controlling the amount of output shown by |
623 | the recursive merge strategy. Overrides merge.verbosity. | |
5162e697 | 624 | See linkgit:git-merge[1] |
dbddb714 | 625 | |
eee7f4a2 | 626 | `GIT_PAGER`:: |
a7738c77 | 627 | This environment variable overrides `$PAGER`. If it is set |
2de9b711 | 628 | to an empty string or to the value "cat", Git will not launch |
ab54cd6c JN |
629 | a pager. See also the `core.pager` option in |
630 | linkgit:git-config[1]. | |
c27d205a | 631 | |
44a4693b DS |
632 | `GIT_PROGRESS_DELAY`:: |
633 | A number controlling how many seconds to delay before showing | |
634 | optional progress indicators. Defaults to 2. | |
635 | ||
eee7f4a2 | 636 | `GIT_EDITOR`:: |
36384c97 | 637 | This environment variable overrides `$EDITOR` and `$VISUAL`. |
2de9b711 | 638 | It is used by several Git commands when, on interactive mode, |
36384c97 RSM |
639 | an editor is to be launched. See also linkgit:git-var[1] |
640 | and the `core.editor` option in linkgit:git-config[1]. | |
641 | ||
902a126e PB |
642 | `GIT_SEQUENCE_EDITOR`:: |
643 | This environment variable overrides the configured Git editor | |
644 | when editing the todo list of an interactive rebase. See also | |
5bed7f66 PB |
645 | linkgit:git-rebase[1] and the `sequence.editor` option in |
646 | linkgit:git-config[1]. | |
902a126e | 647 | |
eee7f4a2 TR |
648 | `GIT_SSH`:: |
649 | `GIT_SSH_COMMAND`:: | |
39942766 TQ |
650 | If either of these environment variables is set then 'git fetch' |
651 | and 'git push' will use the specified command instead of 'ssh' | |
652 | when they need to connect to a remote system. | |
94b8ae5a BW |
653 | The command-line parameters passed to the configured command are |
654 | determined by the ssh variant. See `ssh.variant` option in | |
655 | linkgit:git-config[1] for details. | |
d5538b41 | 656 | + |
39942766 TQ |
657 | `$GIT_SSH_COMMAND` takes precedence over `$GIT_SSH`, and is interpreted |
658 | by the shell, which allows additional arguments to be included. | |
659 | `$GIT_SSH` on the other hand must be just the path to a program | |
660 | (which can be a wrapper shell script, if additional arguments are | |
661 | needed). | |
d5538b41 SP |
662 | + |
663 | Usually it is easier to configure any desired options through your | |
664 | personal `.ssh/config` file. Please consult your ssh documentation | |
665 | for further details. | |
666 | ||
dd33e077 SF |
667 | `GIT_SSH_VARIANT`:: |
668 | If this environment variable is set, it overrides Git's autodetection | |
669 | whether `GIT_SSH`/`GIT_SSH_COMMAND`/`core.sshCommand` refer to OpenSSH, | |
670 | plink or tortoiseplink. This variable overrides the config setting | |
671 | `ssh.variant` that serves the same purpose. | |
672 | ||
29491ca5 JH |
673 | `GIT_SSL_NO_VERIFY`:: |
674 | Setting and exporting this environment variable to any value | |
675 | tells Git not to verify the SSL certificate when fetching or | |
676 | pushing over HTTPS. | |
677 | ||
eee7f4a2 | 678 | `GIT_ASKPASS`:: |
2de9b711 | 679 | If this environment variable is set, then Git commands which need to |
453842c9 | 680 | acquire passwords or passphrases (e.g. for HTTP or IMAP authentication) |
06ab60c0 | 681 | will call this program with a suitable prompt as command-line argument |
ae9f6311 | 682 | and read the password from its STDOUT. See also the `core.askPass` |
453842c9 KF |
683 | option in linkgit:git-config[1]. |
684 | ||
eee7f4a2 | 685 | `GIT_TERMINAL_PROMPT`:: |
80f0b3f3 | 686 | If this Boolean environment variable is set to false, git will not prompt |
e652c0eb JK |
687 | on the terminal (e.g., when asking for HTTP authentication). |
688 | ||
4179b489 PS |
689 | `GIT_CONFIG_GLOBAL`:: |
690 | `GIT_CONFIG_SYSTEM`:: | |
691 | Take the configuration from the given files instead from global or | |
692 | system-level configuration files. If `GIT_CONFIG_SYSTEM` is set, the | |
693 | system config file defined at build time (usually `/etc/gitconfig`) | |
694 | will not be read. Likewise, if `GIT_CONFIG_GLOBAL` is set, neither | |
695 | `$HOME/.gitconfig` nor `$XDG_CONFIG_HOME/git/config` will be read. Can | |
696 | be set to `/dev/null` to skip reading configuration files of the | |
697 | respective level. | |
698 | ||
eee7f4a2 | 699 | `GIT_CONFIG_NOSYSTEM`:: |
e8ef401c | 700 | Whether to skip reading settings from the system-wide |
80f0b3f3 | 701 | `$(prefix)/etc/gitconfig` file. This Boolean environment variable can |
e8ef401c JN |
702 | be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a |
703 | predictable environment for a picky script, or you can set it | |
80f0b3f3 | 704 | to true to temporarily avoid using a buggy `/etc/gitconfig` file while |
e8ef401c JN |
705 | waiting for someone with sufficient permissions to fix it. |
706 | ||
eee7f4a2 | 707 | `GIT_FLUSH`:: |
fd01795b | 708 | // NEEDSWORK: make it into a usual Boolean environment variable |
06f59e9f | 709 | If this environment variable is set to "1", then commands such |
0b444cdb | 710 | as 'git blame' (in incremental mode), 'git rev-list', 'git log', |
627a8b8d | 711 | 'git check-attr' and 'git check-ignore' will |
f1ed7fea AS |
712 | force a flush of the output stream after each record have been |
713 | flushed. If this | |
06f59e9f TT |
714 | variable is set to "0", the output of these commands will be done |
715 | using completely buffered I/O. If this environment variable is | |
2de9b711 | 716 | not set, Git will choose buffered or record-oriented flushing |
06f59e9f TT |
717 | based on whether stdout appears to be redirected to a file or not. |
718 | ||
eee7f4a2 | 719 | `GIT_TRACE`:: |
eb9250df KB |
720 | Enables general trace messages, e.g. alias expansion, built-in |
721 | command execution and external command execution. | |
722 | + | |
723 | If this variable is set to "1", "2" or "true" (comparison | |
724 | is case insensitive), trace messages will be printed to | |
725 | stderr. | |
726 | + | |
727 | If the variable is set to an integer value greater than 2 | |
728 | and lower than 10 (strictly) then Git will interpret this | |
729 | value as an open file descriptor and will try to write the | |
730 | trace messages into this file descriptor. | |
731 | + | |
732 | Alternatively, if the variable is set to an absolute path | |
733 | (starting with a '/' character), Git will interpret this | |
fa0aeea7 SG |
734 | as a file path and will try to append the trace messages |
735 | to it. | |
eb9250df KB |
736 | + |
737 | Unsetting the variable, or setting it to empty, "0" or | |
738 | "false" (case insensitive) disables trace messages. | |
575ba9d6 | 739 | |
bd76afd1 AV |
740 | `GIT_TRACE_FSMONITOR`:: |
741 | Enables trace messages for the filesystem monitor extension. | |
742 | See `GIT_TRACE` for available trace output options. | |
743 | ||
eee7f4a2 | 744 | `GIT_TRACE_PACK_ACCESS`:: |
67dc598e | 745 | Enables trace messages for all accesses to any packs. For each |
b12ca963 NTND |
746 | access, the pack file name and an offset in the pack is |
747 | recorded. This may be helpful for troubleshooting some | |
748 | pack-related performance problems. | |
eee7f4a2 | 749 | See `GIT_TRACE` for available trace output options. |
b12ca963 | 750 | |
eee7f4a2 | 751 | `GIT_TRACE_PACKET`:: |
eb9250df KB |
752 | Enables trace messages for all packets coming in or out of a |
753 | given program. This can help with debugging object negotiation | |
754 | or other protocol issues. Tracing is turned off at a packet | |
eee7f4a2 TR |
755 | starting with "PACK" (but see `GIT_TRACE_PACKFILE` below). |
756 | See `GIT_TRACE` for available trace output options. | |
eb9250df | 757 | |
eee7f4a2 | 758 | `GIT_TRACE_PACKFILE`:: |
32359838 JK |
759 | Enables tracing of packfiles sent or received by a |
760 | given program. Unlike other trace output, this trace is | |
761 | verbatim: no headers, and no quoting of binary data. You almost | |
762 | certainly want to direct into a file (e.g., | |
763 | `GIT_TRACE_PACKFILE=/tmp/my.pack`) rather than displaying it on | |
764 | the terminal or mixing it with other trace output. | |
765 | + | |
766 | Note that this is currently only implemented for the client side | |
767 | of clones and fetches. | |
768 | ||
eee7f4a2 | 769 | `GIT_TRACE_PERFORMANCE`:: |
578da039 KB |
770 | Enables performance related trace messages, e.g. total execution |
771 | time of each Git command. | |
eee7f4a2 | 772 | See `GIT_TRACE` for available trace output options. |
578da039 | 773 | |
4441f427 HWN |
774 | `GIT_TRACE_REFS`:: |
775 | Enables trace messages for operations on the ref database. | |
776 | See `GIT_TRACE` for available trace output options. | |
777 | ||
eee7f4a2 | 778 | `GIT_TRACE_SETUP`:: |
eb9250df KB |
779 | Enables trace messages printing the .git, working tree and current |
780 | working directory after Git has completed its setup phase. | |
eee7f4a2 | 781 | See `GIT_TRACE` for available trace output options. |
eb9250df | 782 | |
eee7f4a2 | 783 | `GIT_TRACE_SHALLOW`:: |
eb9250df KB |
784 | Enables trace messages that can help debugging fetching / |
785 | cloning of shallow repositories. | |
eee7f4a2 | 786 | See `GIT_TRACE` for available trace output options. |
1dd278ce | 787 | |
2f84df2c | 788 | `GIT_TRACE_CURL`:: |
74c682d3 EP |
789 | Enables a curl full trace dump of all incoming and outgoing data, |
790 | including descriptive information, of the git transport protocol. | |
2f84df2c | 791 | This is similar to doing curl `--trace-ascii` on the command line. |
2f84df2c | 792 | See `GIT_TRACE` for available trace output options. |
74c682d3 | 793 | |
8ba18e6f JT |
794 | `GIT_TRACE_CURL_NO_DATA`:: |
795 | When a curl trace is enabled (see `GIT_TRACE_CURL` above), do not dump | |
796 | data (that is, only dump info lines and headers). | |
797 | ||
e4b75d6a | 798 | `GIT_TRACE2`:: |
04b7e86e | 799 | Enables more detailed trace messages from the "trace2" library. |
e4b75d6a | 800 | Output from `GIT_TRACE2` is a simple text-based format for human |
04b7e86e DS |
801 | readability. |
802 | + | |
4e0d3aa1 SG |
803 | If this variable is set to "1", "2" or "true" (comparison |
804 | is case insensitive), trace messages will be printed to | |
805 | stderr. | |
806 | + | |
807 | If the variable is set to an integer value greater than 2 | |
808 | and lower than 10 (strictly) then Git will interpret this | |
809 | value as an open file descriptor and will try to write the | |
810 | trace messages into this file descriptor. | |
811 | + | |
812 | Alternatively, if the variable is set to an absolute path | |
813 | (starting with a '/' character), Git will interpret this | |
814 | as a file path and will try to append the trace messages | |
815 | to it. If the path already exists and is a directory, the | |
816 | trace messages will be written to files (one per process) | |
817 | in that directory, named according to the last component | |
818 | of the SID and an optional counter (to avoid filename | |
819 | collisions). | |
820 | + | |
821 | In addition, if the variable is set to | |
822 | `af_unix:[<socket_type>:]<absolute-pathname>`, Git will try | |
823 | to open the path as a Unix Domain Socket. The socket type | |
824 | can be either `stream` or `dgram`. | |
825 | + | |
826 | Unsetting the variable, or setting it to empty, "0" or | |
827 | "false" (case insensitive) disables trace messages. | |
828 | + | |
829 | See link:technical/api-trace2.html[Trace2 documentation] | |
830 | for full details. | |
831 | ||
04b7e86e | 832 | |
e4b75d6a | 833 | `GIT_TRACE2_EVENT`:: |
04b7e86e | 834 | This setting writes a JSON-based format that is suited for machine |
4e0d3aa1 SG |
835 | interpretation. |
836 | See `GIT_TRACE2` for available trace output options and | |
837 | link:technical/api-trace2.html[Trace2 documentation] for full details. | |
04b7e86e | 838 | |
e4b75d6a SG |
839 | `GIT_TRACE2_PERF`:: |
840 | In addition to the text-based messages available in `GIT_TRACE2`, this | |
04b7e86e | 841 | setting writes a column-based format for understanding nesting |
4e0d3aa1 SG |
842 | regions. |
843 | See `GIT_TRACE2` for available trace output options and | |
844 | link:technical/api-trace2.html[Trace2 documentation] for full details. | |
04b7e86e | 845 | |
827e7d4d JT |
846 | `GIT_TRACE_REDACT`:: |
847 | By default, when tracing is activated, Git redacts the values of | |
88e9b1e3 | 848 | cookies, the "Authorization:" header, the "Proxy-Authorization:" |
80f0b3f3 | 849 | header and packfile URIs. Set this Boolean environment variable to false to prevent this |
88e9b1e3 | 850 | redaction. |
83411783 | 851 | |
eee7f4a2 | 852 | `GIT_LITERAL_PATHSPECS`:: |
80f0b3f3 | 853 | Setting this Boolean environment variable to true will cause Git to treat all |
823ab40f JK |
854 | pathspecs literally, rather than as glob patterns. For example, |
855 | running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search | |
856 | for commits that touch the path `*.c`, not any paths that the | |
857 | glob `*.c` matches. You might want this if you are feeding | |
2de9b711 | 858 | literal paths to Git (e.g., paths previously given to you by |
823ab40f JK |
859 | `git ls-tree`, `--raw` diff output, etc). |
860 | ||
eee7f4a2 | 861 | `GIT_GLOB_PATHSPECS`:: |
80f0b3f3 | 862 | Setting this Boolean environment variable to true will cause Git to treat all |
bd30c2e4 NTND |
863 | pathspecs as glob patterns (aka "glob" magic). |
864 | ||
eee7f4a2 | 865 | `GIT_NOGLOB_PATHSPECS`:: |
80f0b3f3 | 866 | Setting this Boolean environment variable to true will cause Git to treat all |
bd30c2e4 NTND |
867 | pathspecs as literal (aka "literal" magic). |
868 | ||
eee7f4a2 | 869 | `GIT_ICASE_PATHSPECS`:: |
80f0b3f3 | 870 | Setting this Boolean environment variable to true will cause Git to treat all |
93d93537 NTND |
871 | pathspecs as case-insensitive. |
872 | ||
eee7f4a2 | 873 | `GIT_REFLOG_ACTION`:: |
c3e2d189 JH |
874 | When a ref is updated, reflog entries are created to keep |
875 | track of the reason why the ref was updated (which is | |
876 | typically the name of the high-level command that updated | |
877 | the ref), in addition to the old and new values of the ref. | |
878 | A scripted Porcelain command can use set_reflog_action | |
879 | helper function in `git-sh-setup` to set its name to this | |
880 | variable when it is invoked as the top level command by the | |
881 | end user, to be recorded in the body of the reflog. | |
882 | ||
eee7f4a2 | 883 | `GIT_REF_PARANOIA`:: |
80f0b3f3 | 884 | If this Boolean environment variable is set to false, ignore broken or badly named refs when iterating |
968f12fd JK |
885 | over lists of refs. Normally Git will try to include any such |
886 | refs, which may cause some operations to fail. This is usually | |
887 | preferable, as potentially destructive operations (e.g., | |
888 | linkgit:git-prune[1]) are better off aborting rather than | |
889 | ignoring broken refs (and thus considering the history they | |
890 | point to as not worth saving). The default value is `1` (i.e., | |
891 | be paranoid about detecting and aborting all operations). You | |
892 | should not normally need to set this to `0`, but it may be | |
893 | useful when trying to salvage data from a corrupted repository. | |
49672f26 | 894 | |
eee7f4a2 | 895 | `GIT_ALLOW_PROTOCOL`:: |
f1762d77 BW |
896 | If set to a colon-separated list of protocols, behave as if |
897 | `protocol.allow` is set to `never`, and each of the listed | |
898 | protocols has `protocol.<name>.allow` set to `always` | |
559c2c3d | 899 | (overriding any existing configuration). See the description of |
f1762d77 BW |
900 | `protocol.allow` in linkgit:git-config[1] for more details. |
901 | ||
902 | `GIT_PROTOCOL_FROM_USER`:: | |
80f0b3f3 | 903 | Set this Boolean environment variable to false to prevent protocols used by fetch/push/clone which are |
f1762d77 BW |
904 | configured to the `user` state. This is useful to restrict recursive |
905 | submodule initialization from an untrusted repository or for programs | |
906 | which feed potentially-untrusted URLS to git commands. See | |
907 | linkgit:git-config[1] for more details. | |
823ab40f | 908 | |
373d70ef BW |
909 | `GIT_PROTOCOL`:: |
910 | For internal use only. Used in handshaking the wire protocol. | |
911 | Contains a colon ':' separated list of keys with optional values | |
912 | 'key[=value]'. Presence of unknown keys and values must be | |
913 | ignored. | |
2834a72d JK |
914 | + |
915 | Note that servers may need to be configured to allow this variable to | |
916 | pass over some transports. It will be propagated automatically when | |
917 | accessing local repositories (i.e., `file://` or a filesystem path), as | |
918 | well as over the `git://` protocol. For git-over-http, it should work | |
919 | automatically in most configurations, but see the discussion in | |
920 | linkgit:git-http-backend[1]. For git-over-ssh, the ssh server may need | |
921 | to be configured to allow clients to pass this variable (e.g., by using | |
922 | `AcceptEnv GIT_PROTOCOL` with OpenSSH). | |
923 | + | |
924 | This configuration is optional. If the variable is not propagated, then | |
925 | clients will fall back to the original "v0" protocol (but may miss out | |
926 | on some performance improvements or features). This variable currently | |
927 | only affects clones and fetches; it is not yet used for pushes (but may | |
928 | be in the future). | |
373d70ef | 929 | |
27344d6a | 930 | `GIT_OPTIONAL_LOCKS`:: |
80f0b3f3 | 931 | If this Boolean environment variable is set to false, Git will complete any requested operation without |
27344d6a JK |
932 | performing any optional sub-operations that require taking a lock. |
933 | For example, this will prevent `git status` from refreshing the | |
934 | index as a side effect. This is useful for processes running in | |
935 | the background which do not want to cause lock contention with | |
936 | other operations on the repository. Defaults to `1`. | |
937 | ||
b2f55717 JS |
938 | `GIT_REDIRECT_STDIN`:: |
939 | `GIT_REDIRECT_STDOUT`:: | |
940 | `GIT_REDIRECT_STDERR`:: | |
941 | Windows-only: allow redirecting the standard input/output/error | |
942 | handles to paths specified by the environment variables. This is | |
943 | particularly useful in multi-threaded applications where the | |
944 | canonical way to pass standard handles via `CreateProcess()` is | |
945 | not an option because it would require the handles to be marked | |
946 | inheritable (and consequently *every* spawned process would | |
947 | inherit them, possibly blocking regular Git operations). The | |
948 | primary intended use case is to use named pipes for communication | |
949 | (e.g. `\\.\pipe\my-git-stdin-123`). | |
950 | + | |
951 | Two special values are supported: `off` will simply close the | |
952 | corresponding standard handle, and if `GIT_REDIRECT_STDERR` is | |
953 | `2>&1`, standard error will be redirected to the same handle as | |
954 | standard output. | |
955 | ||
a2cd709d AR |
956 | `GIT_PRINT_SHA1_ELLIPSIS` (deprecated):: |
957 | If set to `yes`, print an ellipsis following an | |
958 | (abbreviated) SHA-1 value. This affects indications of | |
959 | detached HEADs (linkgit:git-checkout[1]) and the raw | |
960 | diff output (linkgit:git-diff[1]). Printing an | |
961 | ellipsis in the cases mentioned is no longer considered | |
962 | adequate and support for it is likely to be removed in the | |
963 | foreseeable future (along with the variable). | |
964 | ||
8db9307c JH |
965 | Discussion[[Discussion]] |
966 | ------------------------ | |
40dac517 BF |
967 | |
968 | More detail on the following is available from the | |
2de9b711 | 969 | link:user-manual.html#git-concepts[Git concepts chapter of the |
6998e4db | 970 | user-manual] and linkgit:gitcore-tutorial[7]. |
40dac517 | 971 | |
2de9b711 | 972 | A Git project normally consists of a working directory with a ".git" |
40dac517 BF |
973 | subdirectory at the top level. The .git directory contains, among other |
974 | things, a compressed object database representing the complete history | |
975 | of the project, an "index" file which links that history to the current | |
976 | contents of the working tree, and named pointers into that history such | |
977 | as tags and branch heads. | |
978 | ||
979 | The object database contains objects of three main types: blobs, which | |
980 | hold file data; trees, which point to blobs and other trees to build up | |
02ff6250 | 981 | directory hierarchies; and commits, which each reference a single tree |
40dac517 BF |
982 | and some number of parent commits. |
983 | ||
984 | The commit, equivalent to what other systems call a "changeset" or | |
985 | "version", represents a step in the project's history, and each parent | |
986 | represents an immediately preceding step. Commits with more than one | |
987 | parent represent merges of independent lines of development. | |
988 | ||
d5fa1f1a | 989 | All objects are named by the SHA-1 hash of their contents, normally |
40dac517 BF |
990 | written as a string of 40 hex digits. Such names are globally unique. |
991 | The entire history leading up to a commit can be vouched for by signing | |
992 | just that commit. A fourth object type, the tag, is provided for this | |
993 | purpose. | |
994 | ||
995 | When first created, objects are stored in individual files, but for | |
996 | efficiency may later be compressed together into "pack files". | |
997 | ||
998 | Named pointers called refs mark interesting points in history. A ref | |
d5fa1f1a TA |
999 | may contain the SHA-1 name of an object or the name of another ref. Refs |
1000 | with names beginning `ref/head/` contain the SHA-1 name of the most | |
1001 | recent commit (or "head") of a branch under development. SHA-1 names of | |
40dac517 BF |
1002 | tags of interest are stored under `ref/tags/`. A special ref named |
1003 | `HEAD` contains the name of the currently checked-out branch. | |
1004 | ||
1005 | The index file is initialized with a list of all paths and, for each | |
1006 | path, a blob object and a set of attributes. The blob object represents | |
1007 | the contents of the file as of the head of the current branch. The | |
1008 | attributes (last modified time, size, etc.) are taken from the | |
1009 | corresponding file in the working tree. Subsequent changes to the | |
1010 | working tree can be found by comparing these attributes. The index may | |
1011 | be updated with new content, and new commits may be created from the | |
1012 | content stored in the index. | |
1013 | ||
1014 | The index is also capable of storing multiple entries (called "stages") | |
1015 | for a given pathname. These stages are used to hold the various | |
1016 | unmerged version of a file when a merge is in progress. | |
6c84e2e0 | 1017 | |
7687ae98 JH |
1018 | FURTHER DOCUMENTATION |
1019 | --------------------- | |
1020 | ||
1021 | See the references in the "description" section to get started | |
2de9b711 | 1022 | using Git. The following is probably more detail than necessary |
7687ae98 JH |
1023 | for a first-time user. |
1024 | ||
2de9b711 | 1025 | The link:user-manual.html#git-concepts[Git concepts chapter of the |
7687ae98 | 1026 | user-manual] and linkgit:gitcore-tutorial[7] both provide |
2de9b711 | 1027 | introductions to the underlying Git architecture. |
7687ae98 JH |
1028 | |
1029 | See linkgit:gitworkflows[7] for an overview of recommended workflows. | |
1030 | ||
1031 | See also the link:howto-index.html[howto] documents for some useful | |
1032 | examples. | |
1033 | ||
1034 | The internals are documented in the | |
48a8c26c | 1035 | link:technical/api-index.html[Git API documentation]. |
7687ae98 JH |
1036 | |
1037 | Users migrating from CVS may also want to | |
1038 | read linkgit:gitcvs-migration[7]. | |
1039 | ||
1040 | ||
cb22bc44 AE |
1041 | Authors |
1042 | ------- | |
48bb914e | 1043 | Git was started by Linus Torvalds, and is currently maintained by Junio |
2de9b711 | 1044 | C Hamano. Numerous contributions have come from the Git mailing list |
405869d0 | 1045 | <git@vger.kernel.org>. http://www.openhub.net/p/git/contributors/summary |
6ecc01f2 JH |
1046 | gives you a more complete list of contributors. |
1047 | ||
1048 | If you have a clone of git.git itself, the | |
d8f708f8 JK |
1049 | output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you |
1050 | the authors for specific parts of the project. | |
2cf565c5 | 1051 | |
c97ca277 JH |
1052 | Reporting Bugs |
1053 | -------------- | |
1054 | ||
1055 | Report bugs to the Git mailing list <git@vger.kernel.org> where the | |
1056 | development and maintenance is primarily done. You do not have to be | |
c56170a0 | 1057 | subscribed to the list to send a message there. See the list archive |
46c67492 | 1058 | at https://lore.kernel.org/git for previous bug reports and other |
c56170a0 | 1059 | discussions. |
c97ca277 | 1060 | |
2caa7b8d ÆAB |
1061 | Issues which are security relevant should be disclosed privately to |
1062 | the Git Security mailing list <git-security@googlegroups.com>. | |
1063 | ||
497c8331 CC |
1064 | SEE ALSO |
1065 | -------- | |
1066 | linkgit:gittutorial[7], linkgit:gittutorial-2[7], | |
673151a9 | 1067 | linkgit:giteveryday[7], linkgit:gitcvs-migration[7], |
497c8331 | 1068 | linkgit:gitglossary[7], linkgit:gitcore-tutorial[7], |
801a011d TR |
1069 | linkgit:gitcli[7], link:user-manual.html[The Git User's Manual], |
1070 | linkgit:gitworkflows[7] | |
497c8331 | 1071 | |
2cf565c5 DG |
1072 | GIT |
1073 | --- | |
9e1f0a85 | 1074 | Part of the linkgit:git[1] suite |