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