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