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