]> git.ipfire.org Git - thirdparty/git.git/blob - Documentation/git.txt
Merge branch 'ds/refmap-doc'
[thirdparty/git.git] / Documentation / git.txt
1 git(1)
2 ======
3
4 NAME
5 ----
6 git - the stupid content tracker
7
8
9 SYNOPSIS
10 --------
11 [verse]
12 'git' [--version] [--help] [-C <path>] [-c <name>=<value>]
13 [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
14 [-p|--paginate|-P|--no-pager] [--no-replace-objects] [--bare]
15 [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
16 [--super-prefix=<path>]
17 <command> [<args>]
18
19 DESCRIPTION
20 -----------
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
25 See linkgit:gittutorial[7] to get started, then see
26 linkgit:giteveryday[7] for a useful minimum set of
27 commands. The link:user-manual.html[Git User's Manual] has a more
28 in-depth introduction.
29
30 After you mastered the basic concepts, you can come back to this
31 page to learn what commands Git offers. You can learn more about
32 individual Git commands with "git help command". linkgit:gitcli[7]
33 manual page gives you an overview of the command-line command syntax.
34
35 A formatted and hyperlinked copy of the latest Git documentation
36 can be viewed at https://git.github.io/htmldocs/git.html
37 or https://git-scm.com/docs.
38
39
40 OPTIONS
41 -------
42 --version::
43 Prints the Git suite version that the 'git' program came from.
44
45 --help::
46 Prints the synopsis and a list of the most commonly used
47 commands. If the option `--all` or `-a` is given then all
48 available commands are printed. If a Git command is named this
49 option will bring up the manual page for that command.
50 +
51 Other options are available to control how the manual page is
52 displayed. See linkgit:git-help[1] for more information,
53 because `git --help ...` is converted internally into `git
54 help ...`.
55
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
60 <path>`. If '<path>' is present but empty, e.g. `-C ""`, then the
61 current working directory is left unchanged.
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
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).
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
80 foo.bar= ...`) sets `foo.bar` to the empty string which `git config
81 --type=bool` will convert to `false`.
82
83 --exec-path[=<path>]::
84 Path to wherever your core Git programs are installed.
85 This can also be controlled by setting the GIT_EXEC_PATH
86 environment variable. If no path is given, 'git' will print
87 the current setting and then exit.
88
89 --html-path::
90 Print the path, without trailing slash, where Git's HTML
91 documentation is installed and exit.
92
93 --man-path::
94 Print the manpath (see `man(1)`) for the man pages for
95 this version of Git and exit.
96
97 --info-path::
98 Print the path where the Info files documenting this
99 version of Git are installed and exit.
100
101 -p::
102 --paginate::
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).
107
108 -P::
109 --no-pager::
110 Do not pipe Git output into a pager.
111
112 --git-dir=<path>::
113 Set the path to the repository. This can also be controlled by
114 setting the `GIT_DIR` environment variable. It can be an absolute
115 path or relative path to current working directory.
116
117 --work-tree=<path>::
118 Set the path to the working tree. It can be an absolute path
119 or a path relative to the current working directory.
120 This can also be controlled by setting the GIT_WORK_TREE
121 environment variable and the core.worktree configuration
122 variable (see core.worktree in linkgit:git-config[1] for a
123 more detailed discussion).
124
125 --namespace=<path>::
126 Set the Git namespace. See linkgit:gitnamespaces[7] for more
127 details. Equivalent to setting the `GIT_NAMESPACE` environment
128 variable.
129
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
135 --bare::
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
140 --no-replace-objects::
141 Do not use replacement refs to replace Git objects. See
142 linkgit:git-replace[1] for more information.
143
144 --literal-pathspecs::
145 Treat pathspecs literally (i.e. no globbing, no pathspec magic).
146 This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
147 variable to `1`.
148
149 --glob-pathspecs::
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
155 --noglob-pathspecs::
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)"
160
161 --icase-pathspecs::
162 Add "icase" magic to all pathspec. This is equivalent to setting
163 the `GIT_ICASE_PATHSPECS` environment variable to `1`.
164
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
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
173 parse-options), main (all commands in libexec directory),
174 others (all other commands in `$PATH` that have git- prefix),
175 list-<category> (see categories in command-list.txt),
176 nohelpers (exclude helper commands), alias and config
177 (retrieve command list from config variable completion.commands)
178
179 GIT COMMANDS
180 ------------
181
182 We divide Git into high level ("porcelain") commands and low level
183 ("plumbing") commands.
184
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 ~~~~~~~~~~~~~~~~~~~~~~~
193
194 include::cmds-mainporcelain.txt[]
195
196 Ancillary Commands
197 ~~~~~~~~~~~~~~~~~~
198 Manipulators:
199
200 include::cmds-ancillarymanipulators.txt[]
201
202 Interrogators:
203
204 include::cmds-ancillaryinterrogators.txt[]
205
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
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
235
236 Low-level commands (plumbing)
237 -----------------------------
238
239 Although Git includes its
240 own porcelain layer, its low-level commands are sufficient to support
241 development of alternative porcelains. Developers of such porcelains
242 might start by reading about linkgit:git-update-index[1] and
243 linkgit:git-read-tree[1].
244
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
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
258
259 Manipulation commands
260 ~~~~~~~~~~~~~~~~~~~~~
261
262 include::cmds-plumbingmanipulators.txt[]
263
264
265 Interrogation commands
266 ~~~~~~~~~~~~~~~~~~~~~~
267
268 include::cmds-plumbinginterrogators.txt[]
269
270 In general, the interrogate commands do not touch the files in
271 the working tree.
272
273
274 Syncing repositories
275 ~~~~~~~~~~~~~~~~~~~~
276
277 include::cmds-synchingrepositories.txt[]
278
279 The following are helper commands used by the above; end users
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
293
294 Configuration Mechanism
295 -----------------------
296
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:
300
301 ------------
302 #
303 # A '#' or ';' character indicates a comment.
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"
314 email = "gitster@pobox.com"
315
316 ------------
317
318 Various commands read from the configuration file and adjust
319 their operation accordingly. See linkgit:git-config[1] for a
320 list and more details about the configuration mechanism.
321
322
323 Identifier Terminology
324 ----------------------
325 <object>::
326 Indicates the object name for any type of object.
327
328 <blob>::
329 Indicates a blob object name.
330
331 <tree>::
332 Indicates a tree object name.
333
334 <commit>::
335 Indicates a commit object name.
336
337 <tree-ish>::
338 Indicates a tree, commit or tag object name. A
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>.
342
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
349 <type>::
350 Indicates that an object type is required.
351 Currently one of: `blob`, `tree`, `commit`, or `tag`.
352
353 <file>::
354 Indicates a filename - almost always relative to the
355 root of the tree structure `GIT_INDEX_FILE` describes.
356
357 Symbolic Identifiers
358 --------------------
359 Any Git command accepting any <object> can also use the following
360 symbolic notation:
361
362 HEAD::
363 indicates the head of the current branch.
364
365 <tag>::
366 a valid tag 'name'
367 (i.e. a `refs/tags/<tag>` reference).
368
369 <head>::
370 a valid head 'name'
371 (i.e. a `refs/heads/<head>` reference).
372
373 For a more complete list of ways to spell object names, see
374 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
375
376
377 File/Directory Structure
378 ------------------------
379
380 Please see the linkgit:gitrepository-layout[5] document.
381
382 Read linkgit:githooks[5] for more details about each hook.
383
384 Higher level SCMs may provide and manage additional information in the
385 `$GIT_DIR`.
386
387
388 Terminology
389 -----------
390 Please see linkgit:gitglossary[7].
391
392
393 Environment Variables
394 ---------------------
395 Various Git commands use the following environment variables:
396
397 The Git Repository
398 ~~~~~~~~~~~~~~~~~~
399 These environment variables apply to 'all' core Git commands. Nb: it
400 is worth noting that they may be used/overridden by SCMS sitting above
401 Git so take care if using a foreign front-end.
402
403 `GIT_INDEX_FILE`::
404 This environment allows the specification of an alternate
405 index file. If not specified, the default of `$GIT_DIR/index`
406 is used.
407
408 `GIT_INDEX_VERSION`::
409 This environment variable allows the specification of an index
410 version for new repositories. It won't affect existing index
411 files. By default index file version 2 or 3 is used. See
412 linkgit:git-update-index[1] for more information.
413
414 `GIT_OBJECT_DIRECTORY`::
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
420 `GIT_ALTERNATE_OBJECT_DIRECTORIES`::
421 Due to the immutable nature of Git objects, old objects can be
422 archived into shared, read-only directories. This variable
423 specifies a ":" separated (on Windows ";" separated) list
424 of Git object directories which can be used to search for Git
425 objects. New objects will not be written to these directories.
426 +
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`.
432
433 `GIT_DIR`::
434 If the `GIT_DIR` environment variable is set then it
435 specifies a path to use instead of the default `.git`
436 for the base of the repository.
437 The `--git-dir` command-line option also sets this value.
438
439 `GIT_WORK_TREE`::
440 Set the path to the root of the working tree.
441 This can also be controlled by the `--work-tree` command-line
442 option and the core.worktree configuration variable.
443
444 `GIT_NAMESPACE`::
445 Set the Git namespace; see linkgit:gitnamespaces[7] for details.
446 The `--namespace` command-line option also sets this value.
447
448 `GIT_CEILING_DIRECTORIES`::
449 This should be a colon-separated list of absolute paths. If
450 set, it is a list of directories that Git should not chdir up
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.,
461 `GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink`.
462
463 `GIT_DISCOVERY_ACROSS_FILESYSTEM`::
464 When run in a directory that does not have ".git" repository
465 directory, Git tries to find such a directory in the parent
466 directories to find the top of the working tree, but by default it
467 does not cross filesystem boundaries. This environment variable
468 can be set to true to tell Git not to stop at filesystem
469 boundaries. Like `GIT_CEILING_DIRECTORIES`, this will not affect
470 an explicit repository directory set via `GIT_DIR` or on the
471 command line.
472
473 `GIT_COMMON_DIR`::
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
477 taken from $GIT_DIR. See linkgit:gitrepository-layout[5] and
478 linkgit:git-worktree[1] for
479 details. This variable has lower precedence than other path
480 variables such as GIT_INDEX_FILE, GIT_OBJECT_DIRECTORY...
481
482 Git Commits
483 ~~~~~~~~~~~
484 `GIT_AUTHOR_NAME`::
485 `GIT_AUTHOR_EMAIL`::
486 `GIT_AUTHOR_DATE`::
487 `GIT_COMMITTER_NAME`::
488 `GIT_COMMITTER_EMAIL`::
489 `GIT_COMMITTER_DATE`::
490 'EMAIL'::
491 see linkgit:git-commit-tree[1]
492
493 Git Diffs
494 ~~~~~~~~~
495 `GIT_DIFF_OPTS`::
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
499 value passed on the Git diff command line.
500
501 `GIT_EXTERNAL_DIFF`::
502 When the environment variable `GIT_EXTERNAL_DIFF` is set, the
503 program named by it is called, instead of the diff invocation
504 described above. For a path that is added, removed, or modified,
505 `GIT_EXTERNAL_DIFF` is called with 7 parameters:
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>,
513 <old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
514 <old|new>-mode:: are the octal representation of the file modes.
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
519 index). `GIT_EXTERNAL_DIFF` should not worry about unlinking the
520 temporary file --- it is removed when `GIT_EXTERNAL_DIFF` exits.
521 +
522 For a path that is unmerged, `GIT_EXTERNAL_DIFF` is called with 1
523 parameter, <path>.
524 +
525 For each path `GIT_EXTERNAL_DIFF` is called, two environment variables,
526 `GIT_DIFF_PATH_COUNTER` and `GIT_DIFF_PATH_TOTAL` are set.
527
528 `GIT_DIFF_PATH_COUNTER`::
529 A 1-based counter incremented by one for every path.
530
531 `GIT_DIFF_PATH_TOTAL`::
532 The total number of paths.
533
534 other
535 ~~~~~
536 `GIT_MERGE_VERBOSITY`::
537 A number controlling the amount of output shown by
538 the recursive merge strategy. Overrides merge.verbosity.
539 See linkgit:git-merge[1]
540
541 `GIT_PAGER`::
542 This environment variable overrides `$PAGER`. If it is set
543 to an empty string or to the value "cat", Git will not launch
544 a pager. See also the `core.pager` option in
545 linkgit:git-config[1].
546
547 `GIT_PROGRESS_DELAY`::
548 A number controlling how many seconds to delay before showing
549 optional progress indicators. Defaults to 2.
550
551 `GIT_EDITOR`::
552 This environment variable overrides `$EDITOR` and `$VISUAL`.
553 It is used by several Git commands when, on interactive mode,
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
557 `GIT_SSH`::
558 `GIT_SSH_COMMAND`::
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.
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.
565 +
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).
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
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
582 `GIT_ASKPASS`::
583 If this environment variable is set, then Git commands which need to
584 acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
585 will call this program with a suitable prompt as command-line argument
586 and read the password from its STDOUT. See also the `core.askPass`
587 option in linkgit:git-config[1].
588
589 `GIT_TERMINAL_PROMPT`::
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
593 `GIT_CONFIG_NOSYSTEM`::
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
601 `GIT_FLUSH`::
602 If this environment variable is set to "1", then commands such
603 as 'git blame' (in incremental mode), 'git rev-list', 'git log',
604 'git check-attr' and 'git check-ignore' will
605 force a flush of the output stream after each record have been
606 flushed. If this
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
609 not set, Git will choose buffered or record-oriented flushing
610 based on whether stdout appears to be redirected to a file or not.
611
612 `GIT_TRACE`::
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
627 as a file path and will try to append the trace messages
628 to it.
629 +
630 Unsetting the variable, or setting it to empty, "0" or
631 "false" (case insensitive) disables trace messages.
632
633 `GIT_TRACE_FSMONITOR`::
634 Enables trace messages for the filesystem monitor extension.
635 See `GIT_TRACE` for available trace output options.
636
637 `GIT_TRACE_PACK_ACCESS`::
638 Enables trace messages for all accesses to any packs. For each
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.
642 See `GIT_TRACE` for available trace output options.
643
644 `GIT_TRACE_PACKET`::
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
648 starting with "PACK" (but see `GIT_TRACE_PACKFILE` below).
649 See `GIT_TRACE` for available trace output options.
650
651 `GIT_TRACE_PACKFILE`::
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
662 `GIT_TRACE_PERFORMANCE`::
663 Enables performance related trace messages, e.g. total execution
664 time of each Git command.
665 See `GIT_TRACE` for available trace output options.
666
667 `GIT_TRACE_SETUP`::
668 Enables trace messages printing the .git, working tree and current
669 working directory after Git has completed its setup phase.
670 See `GIT_TRACE` for available trace output options.
671
672 `GIT_TRACE_SHALLOW`::
673 Enables trace messages that can help debugging fetching /
674 cloning of shallow repositories.
675 See `GIT_TRACE` for available trace output options.
676
677 `GIT_TRACE_CURL`::
678 Enables a curl full trace dump of all incoming and outgoing data,
679 including descriptive information, of the git transport protocol.
680 This is similar to doing curl `--trace-ascii` on the command line.
681 This option overrides setting the `GIT_CURL_VERBOSE` environment
682 variable.
683 See `GIT_TRACE` for available trace output options.
684
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
689 `GIT_TRACE2`::
690 Enables more detailed trace messages from the "trace2" library.
691 Output from `GIT_TRACE2` is a simple text-based format for human
692 readability.
693 +
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
723
724 `GIT_TRACE2_EVENT`::
725 This setting writes a JSON-based format that is suited for machine
726 interpretation.
727 See `GIT_TRACE2` for available trace output options and
728 link:technical/api-trace2.html[Trace2 documentation] for full details.
729
730 `GIT_TRACE2_PERF`::
731 In addition to the text-based messages available in `GIT_TRACE2`, this
732 setting writes a column-based format for understanding nesting
733 regions.
734 See `GIT_TRACE2` for available trace output options and
735 link:technical/api-trace2.html[Trace2 documentation] for full details.
736
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
743 `GIT_LITERAL_PATHSPECS`::
744 Setting this variable to `1` will cause Git to treat all
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
749 literal paths to Git (e.g., paths previously given to you by
750 `git ls-tree`, `--raw` diff output, etc).
751
752 `GIT_GLOB_PATHSPECS`::
753 Setting this variable to `1` will cause Git to treat all
754 pathspecs as glob patterns (aka "glob" magic).
755
756 `GIT_NOGLOB_PATHSPECS`::
757 Setting this variable to `1` will cause Git to treat all
758 pathspecs as literal (aka "literal" magic).
759
760 `GIT_ICASE_PATHSPECS`::
761 Setting this variable to `1` will cause Git to treat all
762 pathspecs as case-insensitive.
763
764 `GIT_REFLOG_ACTION`::
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
774 `GIT_REF_PARANOIA`::
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
785 `GIT_ALLOW_PROTOCOL`::
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.
800
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
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
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
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
842 Discussion[[Discussion]]
843 ------------------------
844
845 More detail on the following is available from the
846 link:user-manual.html#git-concepts[Git concepts chapter of the
847 user-manual] and linkgit:gitcore-tutorial[7].
848
849 A Git project normally consists of a working directory with a ".git"
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
858 directory hierarchies; and commits, which each reference a single tree
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
866 All objects are named by the SHA-1 hash of their contents, normally
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
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
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.
894
895 FURTHER DOCUMENTATION
896 ---------------------
897
898 See the references in the "description" section to get started
899 using Git. The following is probably more detail than necessary
900 for a first-time user.
901
902 The link:user-manual.html#git-concepts[Git concepts chapter of the
903 user-manual] and linkgit:gitcore-tutorial[7] both provide
904 introductions to the underlying Git architecture.
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
912 link:technical/api-index.html[Git API documentation].
913
914 Users migrating from CVS may also want to
915 read linkgit:gitcvs-migration[7].
916
917
918 Authors
919 -------
920 Git was started by Linus Torvalds, and is currently maintained by Junio
921 C Hamano. Numerous contributions have come from the Git mailing list
922 <git@vger.kernel.org>. http://www.openhub.net/p/git/contributors/summary
923 gives you a more complete list of contributors.
924
925 If you have a clone of git.git itself, the
926 output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
927 the authors for specific parts of the project.
928
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
934 subscribed to the list to send a message there. See the list archive
935 at https://lore.kernel.org/git for previous bug reports and other
936 discussions.
937
938 Issues which are security relevant should be disclosed privately to
939 the Git Security mailing list <git-security@googlegroups.com>.
940
941 SEE ALSO
942 --------
943 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
944 linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
945 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
946 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
947 linkgit:gitworkflows[7]
948
949 GIT
950 ---
951 Part of the linkgit:git[1] suite