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