1GIT(1)                            Git Manual                            GIT(1)
2
3
4

NAME

6       git - the stupid content tracker
7

SYNOPSIS

9       git [-v | --version] [-h | --help] [-C <path>] [-c <name>=<value>]
10           [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
11           [-p|--paginate|-P|--no-pager] [--no-replace-objects] [--bare]
12           [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
13           [--config-env=<name>=<envvar>] <command> [<args>]
14

DESCRIPTION

16       Git is a fast, scalable, distributed revision control system with an
17       unusually rich command set that provides both high-level operations and
18       full access to internals.
19
20       See gittutorial(7) to get started, then see giteveryday(7) for a useful
21       minimum set of commands. The Git User’s Manual[1] has a more in-depth
22       introduction.
23
24       After you mastered the basic concepts, you can come back to this page
25       to learn what commands Git offers. You can learn more about individual
26       Git commands with "git help command". gitcli(7) manual page gives you
27       an overview of the command-line command syntax.
28
29       A formatted and hyperlinked copy of the latest Git documentation can be
30       viewed at https://git.github.io/htmldocs/git.html or
31       https://git-scm.com/docs.
32

OPTIONS

34       -v, --version
35           Prints the Git suite version that the git program came from.
36
37           This option is internally converted to git version ...  and accepts
38           the same options as the git-version(1) command. If --help is also
39           given, it takes precedence over --version.
40
41       -h, --help
42           Prints the synopsis and a list of the most commonly used commands.
43           If the option --all or -a is given then all available commands are
44           printed. If a Git command is named this option will bring up the
45           manual page for that command.
46
47           Other options are available to control how the manual page is
48           displayed. See git-help(1) for more information, because git --help
49           ...  is converted internally into git help ....
50
51       -C <path>
52           Run as if git was started in <path> instead of the current working
53           directory. When multiple -C options are given, each subsequent
54           non-absolute -C <path> is interpreted relative to the preceding -C
55           <path>. If <path> is present but empty, e.g.  -C "", then the
56           current working directory is left unchanged.
57
58           This option affects options that expect path name like --git-dir
59           and --work-tree in that their interpretations of the path names
60           would be made relative to the working directory caused by the -C
61           option. For example the following invocations are equivalent:
62
63               git --git-dir=a.git --work-tree=b -C c status
64               git --git-dir=c/a.git --work-tree=c/b status
65
66       -c <name>=<value>
67           Pass a configuration parameter to the command. The value given will
68           override values from configuration files. The <name> is expected in
69           the same format as listed by git config (subkeys separated by
70           dots).
71
72           Note that omitting the = in git -c foo.bar ...  is allowed and sets
73           foo.bar to the boolean true value (just like [foo]bar would in a
74           config file). Including the equals but with an empty value (like
75           git -c foo.bar= ...) sets foo.bar to the empty string which git
76           config --type=bool will convert to false.
77
78       --config-env=<name>=<envvar>
79           Like -c <name>=<value>, give configuration variable <name> a value,
80           where <envvar> is the name of an environment variable from which to
81           retrieve the value. Unlike -c there is no shortcut for directly
82           setting the value to an empty string, instead the environment
83           variable itself must be set to the empty string. It is an error if
84           the <envvar> does not exist in the environment.  <envvar> may not
85           contain an equals sign to avoid ambiguity with <name> containing
86           one.
87
88           This is useful for cases where you want to pass transitory
89           configuration options to git, but are doing so on operating systems
90           where other processes might be able to read your command line (e.g.
91           /proc/self/cmdline), but not your environment (e.g.
92           /proc/self/environ). That behavior is the default on Linux, but may
93           not be on your system.
94
95           Note that this might add security for variables such as
96           http.extraHeader where the sensitive information is part of the
97           value, but not e.g.  url.<base>.insteadOf where the sensitive
98           information can be part of the key.
99
100       --exec-path[=<path>]
101           Path to wherever your core Git programs are installed. This can
102           also be controlled by setting the GIT_EXEC_PATH environment
103           variable. If no path is given, git will print the current setting
104           and then exit.
105
106       --html-path
107           Print the path, without trailing slash, where Git’s HTML
108           documentation is installed and exit.
109
110       --man-path
111           Print the manpath (see man(1)) for the man pages for this version
112           of Git and exit.
113
114       --info-path
115           Print the path where the Info files documenting this version of Git
116           are installed and exit.
117
118       -p, --paginate
119           Pipe all output into less (or if set, $PAGER) if standard output is
120           a terminal. This overrides the pager.<cmd> configuration options
121           (see the "Configuration Mechanism" section below).
122
123       -P, --no-pager
124           Do not pipe Git output into a pager.
125
126       --git-dir=<path>
127           Set the path to the repository (".git" directory). This can also be
128           controlled by setting the GIT_DIR environment variable. It can be
129           an absolute path or relative path to current working directory.
130
131           Specifying the location of the ".git" directory using this option
132           (or GIT_DIR environment variable) turns off the repository
133           discovery that tries to find a directory with ".git" subdirectory
134           (which is how the repository and the top-level of the working tree
135           are discovered), and tells Git that you are at the top level of the
136           working tree. If you are not at the top-level directory of the
137           working tree, you should tell Git where the top-level of the
138           working tree is, with the --work-tree=<path> option (or
139           GIT_WORK_TREE environment variable)
140
141           If you just want to run git as if it was started in <path> then use
142           git -C <path>.
143
144       --work-tree=<path>
145           Set the path to the working tree. It can be an absolute path or a
146           path relative to the current working directory. This can also be
147           controlled by setting the GIT_WORK_TREE environment variable and
148           the core.worktree configuration variable (see core.worktree in git-
149           config(1) for a more detailed discussion).
150
151       --namespace=<path>
152           Set the Git namespace. See gitnamespaces(7) for more details.
153           Equivalent to setting the GIT_NAMESPACE environment variable.
154
155       --bare
156           Treat the repository as a bare repository. If GIT_DIR environment
157           is not set, it is set to the current working directory.
158
159       --no-replace-objects
160           Do not use replacement refs to replace Git objects. See git-
161           replace(1) for more information.
162
163       --literal-pathspecs
164           Treat pathspecs literally (i.e. no globbing, no pathspec magic).
165           This is equivalent to setting the GIT_LITERAL_PATHSPECS environment
166           variable to 1.
167
168       --glob-pathspecs
169           Add "glob" magic to all pathspec. This is equivalent to setting the
170           GIT_GLOB_PATHSPECS environment variable to 1. Disabling globbing on
171           individual pathspecs can be done using pathspec magic ":(literal)"
172
173       --noglob-pathspecs
174           Add "literal" magic to all pathspec. This is equivalent to setting
175           the GIT_NOGLOB_PATHSPECS environment variable to 1. Enabling
176           globbing on individual pathspecs can be done using pathspec magic
177           ":(glob)"
178
179       --icase-pathspecs
180           Add "icase" magic to all pathspec. This is equivalent to setting
181           the GIT_ICASE_PATHSPECS environment variable to 1.
182
183       --no-optional-locks
184           Do not perform optional operations that require locks. This is
185           equivalent to setting the GIT_OPTIONAL_LOCKS to 0.
186
187       --list-cmds=group[,group...]
188           List commands by group. This is an internal/experimental option and
189           may change or be removed in the future. Supported groups are:
190           builtins, parseopt (builtin commands that use parse-options), main
191           (all commands in libexec directory), others (all other commands in
192           $PATH that have git- prefix), list-<category> (see categories in
193           command-list.txt), nohelpers (exclude helper commands), alias and
194           config (retrieve command list from config variable
195           completion.commands)
196
197       --attr-source=<tree-ish>
198           Read gitattributes from <tree-ish> instead of the worktree. See
199           gitattributes(5). This is equivalent to setting the GIT_ATTR_SOURCE
200           environment variable.
201

GIT COMMANDS

203       We divide Git into high level ("porcelain") commands and low level
204       ("plumbing") commands.
205

HIGH-LEVEL COMMANDS (PORCELAIN)

207       We separate the porcelain commands into the main commands and some
208       ancillary user utilities.
209
210   Main porcelain commands
211       git-add(1)
212           Add file contents to the index.
213
214       git-am(1)
215           Apply a series of patches from a mailbox.
216
217       git-archive(1)
218           Create an archive of files from a named tree.
219
220       git-bisect(1)
221           Use binary search to find the commit that introduced a bug.
222
223       git-branch(1)
224           List, create, or delete branches.
225
226       git-bundle(1)
227           Move objects and refs by archive.
228
229       git-checkout(1)
230           Switch branches or restore working tree files.
231
232       git-cherry-pick(1)
233           Apply the changes introduced by some existing commits.
234
235       git-citool(1)
236           Graphical alternative to git-commit.
237
238       git-clean(1)
239           Remove untracked files from the working tree.
240
241       git-clone(1)
242           Clone a repository into a new directory.
243
244       git-commit(1)
245           Record changes to the repository.
246
247       git-describe(1)
248           Give an object a human readable name based on an available ref.
249
250       git-diff(1)
251           Show changes between commits, commit and working tree, etc.
252
253       git-fetch(1)
254           Download objects and refs from another repository.
255
256       git-format-patch(1)
257           Prepare patches for e-mail submission.
258
259       git-gc(1)
260           Cleanup unnecessary files and optimize the local repository.
261
262       git-grep(1)
263           Print lines matching a pattern.
264
265       git-gui(1)
266           A portable graphical interface to Git.
267
268       git-init(1)
269           Create an empty Git repository or reinitialize an existing one.
270
271       git-log(1)
272           Show commit logs.
273
274       git-maintenance(1)
275           Run tasks to optimize Git repository data.
276
277       git-merge(1)
278           Join two or more development histories together.
279
280       git-mv(1)
281           Move or rename a file, a directory, or a symlink.
282
283       git-notes(1)
284           Add or inspect object notes.
285
286       git-pull(1)
287           Fetch from and integrate with another repository or a local branch.
288
289       git-push(1)
290           Update remote refs along with associated objects.
291
292       git-range-diff(1)
293           Compare two commit ranges (e.g. two versions of a branch).
294
295       git-rebase(1)
296           Reapply commits on top of another base tip.
297
298       git-reset(1)
299           Reset current HEAD to the specified state.
300
301       git-restore(1)
302           Restore working tree files.
303
304       git-revert(1)
305           Revert some existing commits.
306
307       git-rm(1)
308           Remove files from the working tree and from the index.
309
310       git-shortlog(1)
311           Summarize git log output.
312
313       git-show(1)
314           Show various types of objects.
315
316       git-sparse-checkout(1)
317           Reduce your working tree to a subset of tracked files.
318
319       git-stash(1)
320           Stash the changes in a dirty working directory away.
321
322       git-status(1)
323           Show the working tree status.
324
325       git-submodule(1)
326           Initialize, update or inspect submodules.
327
328       git-switch(1)
329           Switch branches.
330
331       git-tag(1)
332           Create, list, delete or verify a tag object signed with GPG.
333
334       git-worktree(1)
335           Manage multiple working trees.
336
337       gitk(1)
338           The Git repository browser.
339
340       scalar(1)
341           A tool for managing large Git repositories.
342
343   Ancillary Commands
344       Manipulators:
345
346       git-config(1)
347           Get and set repository or global options.
348
349       git-fast-export(1)
350           Git data exporter.
351
352       git-fast-import(1)
353           Backend for fast Git data importers.
354
355       git-filter-branch(1)
356           Rewrite branches.
357
358       git-mergetool(1)
359           Run merge conflict resolution tools to resolve merge conflicts.
360
361       git-pack-refs(1)
362           Pack heads and tags for efficient repository access.
363
364       git-prune(1)
365           Prune all unreachable objects from the object database.
366
367       git-reflog(1)
368           Manage reflog information.
369
370       git-remote(1)
371           Manage set of tracked repositories.
372
373       git-repack(1)
374           Pack unpacked objects in a repository.
375
376       git-replace(1)
377           Create, list, delete refs to replace objects.
378
379       Interrogators:
380
381       git-annotate(1)
382           Annotate file lines with commit information.
383
384       git-blame(1)
385           Show what revision and author last modified each line of a file.
386
387       git-bugreport(1)
388           Collect information for user to file a bug report.
389
390       git-count-objects(1)
391           Count unpacked number of objects and their disk consumption.
392
393       git-diagnose(1)
394           Generate a zip archive of diagnostic information.
395
396       git-difftool(1)
397           Show changes using common diff tools.
398
399       git-fsck(1)
400           Verifies the connectivity and validity of the objects in the
401           database.
402
403       git-help(1)
404           Display help information about Git.
405
406       git-instaweb(1)
407           Instantly browse your working repository in gitweb.
408
409       git-merge-tree(1)
410           Perform merge without touching index or working tree.
411
412       git-rerere(1)
413           Reuse recorded resolution of conflicted merges.
414
415       git-show-branch(1)
416           Show branches and their commits.
417
418       git-verify-commit(1)
419           Check the GPG signature of commits.
420
421       git-verify-tag(1)
422           Check the GPG signature of tags.
423
424       git-version(1)
425           Display version information about Git.
426
427       git-whatchanged(1)
428           Show logs with differences each commit introduces.
429
430       gitweb(1)
431           Git web interface (web frontend to Git repositories).
432
433   Interacting with Others
434       These commands are to interact with foreign SCM and with other people
435       via patch over e-mail.
436
437       git-cvsexportcommit(1)
438           Export a single commit to a CVS checkout.
439
440       git-cvsimport(1)
441           Salvage your data out of another SCM people love to hate.
442
443       git-cvsserver(1)
444           A CVS server emulator for Git.
445
446       git-imap-send(1)
447           Send a collection of patches from stdin to an IMAP folder.
448
449       git-p4(1)
450           Import from and submit to Perforce repositories.
451
452       git-quiltimport(1)
453           Applies a quilt patchset onto the current branch.
454
455       git-request-pull(1)
456           Generates a summary of pending changes.
457
458       git-send-email(1)
459           Send a collection of patches as emails.
460
461       git-svn(1)
462           Bidirectional operation between a Subversion repository and Git.
463
464   Reset, restore and revert
465       There are three commands with similar names: git reset, git restore and
466       git revert.
467
468git-revert(1) is about making a new commit that reverts the changes
469           made by other commits.
470
471git-restore(1) is about restoring files in the working tree from
472           either the index or another commit. This command does not update
473           your branch. The command can also be used to restore files in the
474           index from another commit.
475
476git-reset(1) is about updating your branch, moving the tip in order
477           to add or remove commits from the branch. This operation changes
478           the commit history.
479
480           git reset can also be used to restore the index, overlapping with
481           git restore.
482

LOW-LEVEL COMMANDS (PLUMBING)

484       Although Git includes its own porcelain layer, its low-level commands
485       are sufficient to support development of alternative porcelains.
486       Developers of such porcelains might start by reading about git-update-
487       index(1) and git-read-tree(1).
488
489       The interface (input, output, set of options and the semantics) to
490       these low-level commands are meant to be a lot more stable than
491       Porcelain level commands, because these commands are primarily for
492       scripted use. The interface to Porcelain commands on the other hand are
493       subject to change in order to improve the end user experience.
494
495       The following description divides the low-level commands into commands
496       that manipulate objects (in the repository, index, and working tree),
497       commands that interrogate and compare objects, and commands that move
498       objects and references between repositories.
499
500   Manipulation commands
501       git-apply(1)
502           Apply a patch to files and/or to the index.
503
504       git-checkout-index(1)
505           Copy files from the index to the working tree.
506
507       git-commit-graph(1)
508           Write and verify Git commit-graph files.
509
510       git-commit-tree(1)
511           Create a new commit object.
512
513       git-hash-object(1)
514           Compute object ID and optionally create an object from a file.
515
516       git-index-pack(1)
517           Build pack index file for an existing packed archive.
518
519       git-merge-file(1)
520           Run a three-way file merge.
521
522       git-merge-index(1)
523           Run a merge for files needing merging.
524
525       git-mktag(1)
526           Creates a tag object with extra validation.
527
528       git-mktree(1)
529           Build a tree-object from ls-tree formatted text.
530
531       git-multi-pack-index(1)
532           Write and verify multi-pack-indexes.
533
534       git-pack-objects(1)
535           Create a packed archive of objects.
536
537       git-prune-packed(1)
538           Remove extra objects that are already in pack files.
539
540       git-read-tree(1)
541           Reads tree information into the index.
542
543       git-symbolic-ref(1)
544           Read, modify and delete symbolic refs.
545
546       git-unpack-objects(1)
547           Unpack objects from a packed archive.
548
549       git-update-index(1)
550           Register file contents in the working tree to the index.
551
552       git-update-ref(1)
553           Update the object name stored in a ref safely.
554
555       git-write-tree(1)
556           Create a tree object from the current index.
557
558   Interrogation commands
559       git-cat-file(1)
560           Provide contents or details of repository objects.
561
562       git-cherry(1)
563           Find commits yet to be applied to upstream.
564
565       git-diff-files(1)
566           Compares files in the working tree and the index.
567
568       git-diff-index(1)
569           Compare a tree to the working tree or index.
570
571       git-diff-tree(1)
572           Compares the content and mode of blobs found via two tree objects.
573
574       git-for-each-ref(1)
575           Output information on each ref.
576
577       git-for-each-repo(1)
578           Run a Git command on a list of repositories.
579
580       git-get-tar-commit-id(1)
581           Extract commit ID from an archive created using git-archive.
582
583       git-ls-files(1)
584           Show information about files in the index and the working tree.
585
586       git-ls-remote(1)
587           List references in a remote repository.
588
589       git-ls-tree(1)
590           List the contents of a tree object.
591
592       git-merge-base(1)
593           Find as good common ancestors as possible for a merge.
594
595       git-name-rev(1)
596           Find symbolic names for given revs.
597
598       git-pack-redundant(1)
599           Find redundant pack files.
600
601       git-rev-list(1)
602           Lists commit objects in reverse chronological order.
603
604       git-rev-parse(1)
605           Pick out and massage parameters.
606
607       git-show-index(1)
608           Show packed archive index.
609
610       git-show-ref(1)
611           List references in a local repository.
612
613       git-unpack-file(1)
614           Creates a temporary file with a blob’s contents.
615
616       git-var(1)
617           Show a Git logical variable.
618
619       git-verify-pack(1)
620           Validate packed Git archive files.
621
622       In general, the interrogate commands do not touch the files in the
623       working tree.
624
625   Syncing repositories
626       git-daemon(1)
627           A really simple server for Git repositories.
628
629       git-fetch-pack(1)
630           Receive missing objects from another repository.
631
632       git-http-backend(1)
633           Server side implementation of Git over HTTP.
634
635       git-send-pack(1)
636           Push objects over Git protocol to another repository.
637
638       git-update-server-info(1)
639           Update auxiliary info file to help dumb servers.
640
641       The following are helper commands used by the above; end users
642       typically do not use them directly.
643
644       git-http-fetch(1)
645           Download from a remote Git repository via HTTP.
646
647       git-http-push(1)
648           Push objects over HTTP/DAV to another repository.
649
650       git-receive-pack(1)
651           Receive what is pushed into the repository.
652
653       git-shell(1)
654           Restricted login shell for Git-only SSH access.
655
656       git-upload-archive(1)
657           Send archive back to git-archive.
658
659       git-upload-pack(1)
660           Send objects packed back to git-fetch-pack.
661
662   Internal helper commands
663       These are internal helper commands used by other commands; end users
664       typically do not use them directly.
665
666       git-check-attr(1)
667           Display gitattributes information.
668
669       git-check-ignore(1)
670           Debug gitignore / exclude files.
671
672       git-check-mailmap(1)
673           Show canonical names and email addresses of contacts.
674
675       git-check-ref-format(1)
676           Ensures that a reference name is well formed.
677
678       git-column(1)
679           Display data in columns.
680
681       git-credential(1)
682           Retrieve and store user credentials.
683
684       git-credential-cache(1)
685           Helper to temporarily store passwords in memory.
686
687       git-credential-store(1)
688           Helper to store credentials on disk.
689
690       git-fmt-merge-msg(1)
691           Produce a merge commit message.
692
693       git-hook(1)
694           Run git hooks.
695
696       git-interpret-trailers(1)
697           Add or parse structured information in commit messages.
698
699       git-mailinfo(1)
700           Extracts patch and authorship from a single e-mail message.
701
702       git-mailsplit(1)
703           Simple UNIX mbox splitter program.
704
705       git-merge-one-file(1)
706           The standard helper program to use with git-merge-index.
707
708       git-patch-id(1)
709           Compute unique ID for a patch.
710
711       git-sh-i18n(1)
712           Git’s i18n setup code for shell scripts.
713
714       git-sh-setup(1)
715           Common Git shell script setup code.
716
717       git-stripspace(1)
718           Remove unnecessary whitespace.
719

GUIDES

721       The following documentation pages are guides about Git concepts.
722
723       gitcore-tutorial(7)
724           A Git core tutorial for developers.
725
726       gitcredentials(7)
727           Providing usernames and passwords to Git.
728
729       gitcvs-migration(7)
730           Git for CVS users.
731
732       gitdiffcore(7)
733           Tweaking diff output.
734
735       giteveryday(7)
736           A useful minimum set of commands for Everyday Git.
737
738       gitfaq(7)
739           Frequently asked questions about using Git.
740
741       gitglossary(7)
742           A Git Glossary.
743
744       gitnamespaces(7)
745           Git namespaces.
746
747       gitremote-helpers(7)
748           Helper programs to interact with remote repositories.
749
750       gitsubmodules(7)
751           Mounting one repository inside another.
752
753       gittutorial(7)
754           A tutorial introduction to Git.
755
756       gittutorial-2(7)
757           A tutorial introduction to Git: part two.
758
759       gitworkflows(7)
760           An overview of recommended workflows with Git.
761

REPOSITORY, COMMAND AND FILE INTERFACES

763       This documentation discusses repository and command interfaces which
764       users are expected to interact with directly. See --user-formats in
765       git-help(1) for more details on the criteria.
766
767       gitattributes(5)
768           Defining attributes per path.
769
770       gitcli(7)
771           Git command-line interface and conventions.
772
773       githooks(5)
774           Hooks used by Git.
775
776       gitignore(5)
777           Specifies intentionally untracked files to ignore.
778
779       gitmailmap(5)
780           Map author/committer names and/or E-Mail addresses.
781
782       gitmodules(5)
783           Defining submodule properties.
784
785       gitrepository-layout(5)
786           Git Repository Layout.
787
788       gitrevisions(7)
789           Specifying revisions and ranges for Git.
790

FILE FORMATS, PROTOCOLS AND OTHER DEVELOPER INTERFACES

792       This documentation discusses file formats, over-the-wire protocols and
793       other git developer interfaces. See --developer-interfaces in git-
794       help(1).
795
796       gitformat-bundle(5)
797           The bundle file format.
798
799       gitformat-chunk(5)
800           Chunk-based file formats.
801
802       gitformat-commit-graph(5)
803           Git commit-graph format.
804
805       gitformat-index(5)
806           Git index format.
807
808       gitformat-pack(5)
809           Git pack format.
810
811       gitformat-signature(5)
812           Git cryptographic signature formats.
813
814       gitprotocol-capabilities(5)
815           Protocol v0 and v1 capabilities.
816
817       gitprotocol-common(5)
818           Things common to various protocols.
819
820       gitprotocol-http(5)
821           Git HTTP-based protocols.
822
823       gitprotocol-pack(5)
824           How packs are transferred over-the-wire.
825
826       gitprotocol-v2(5)
827           Git Wire Protocol, Version 2.
828

CONFIGURATION MECHANISM

830       Git uses a simple text format to store customizations that are per
831       repository and are per user. Such a configuration file may look like
832       this:
833
834           #
835           # A '#' or ';' character indicates a comment.
836           #
837
838           ; core variables
839           [core]
840                   ; Don't trust file modes
841                   filemode = false
842
843           ; user identity
844           [user]
845                   name = "Junio C Hamano"
846                   email = "gitster@pobox.com"
847
848       Various commands read from the configuration file and adjust their
849       operation accordingly. See git-config(1) for a list and more details
850       about the configuration mechanism.
851

IDENTIFIER TERMINOLOGY

853       <object>
854           Indicates the object name for any type of object.
855
856       <blob>
857           Indicates a blob object name.
858
859       <tree>
860           Indicates a tree object name.
861
862       <commit>
863           Indicates a commit object name.
864
865       <tree-ish>
866           Indicates a tree, commit or tag object name. A command that takes a
867           <tree-ish> argument ultimately wants to operate on a <tree> object
868           but automatically dereferences <commit> and <tag> objects that
869           point at a <tree>.
870
871       <commit-ish>
872           Indicates a commit or tag object name. A command that takes a
873           <commit-ish> argument ultimately wants to operate on a <commit>
874           object but automatically dereferences <tag> objects that point at a
875           <commit>.
876
877       <type>
878           Indicates that an object type is required. Currently one of: blob,
879           tree, commit, or tag.
880
881       <file>
882           Indicates a filename - almost always relative to the root of the
883           tree structure GIT_INDEX_FILE describes.
884

SYMBOLIC IDENTIFIERS

886       Any Git command accepting any <object> can also use the following
887       symbolic notation:
888
889       HEAD
890           indicates the head of the current branch.
891
892       <tag>
893           a valid tag name (i.e. a refs/tags/<tag> reference).
894
895       <head>
896           a valid head name (i.e. a refs/heads/<head> reference).
897
898       For a more complete list of ways to spell object names, see "SPECIFYING
899       REVISIONS" section in gitrevisions(7).
900

FILE/DIRECTORY STRUCTURE

902       Please see the gitrepository-layout(5) document.
903
904       Read githooks(5) for more details about each hook.
905
906       Higher level SCMs may provide and manage additional information in the
907       $GIT_DIR.
908

TERMINOLOGY

910       Please see gitglossary(7).
911

ENVIRONMENT VARIABLES

913       Various Git commands pay attention to environment variables and change
914       their behavior. The environment variables marked as "Boolean" take
915       their values the same way as Boolean valued configuration variables,
916       e.g. "true", "yes", "on" and positive numbers are taken as "yes".
917
918       Here are the variables:
919
920   The Git Repository
921       These environment variables apply to all core Git commands. Nb: it is
922       worth noting that they may be used/overridden by SCMS sitting above Git
923       so take care if using a foreign front-end.
924
925       GIT_INDEX_FILE
926           This environment variable specifies an alternate index file. If not
927           specified, the default of $GIT_DIR/index is used.
928
929       GIT_INDEX_VERSION
930           This environment variable specifies what index version is used when
931           writing the index file out. It won’t affect existing index files.
932           By default index file version 2 or 3 is used. See git-update-
933           index(1) for more information.
934
935       GIT_OBJECT_DIRECTORY
936           If the object storage directory is specified via this environment
937           variable then the sha1 directories are created underneath -
938           otherwise the default $GIT_DIR/objects directory is used.
939
940       GIT_ALTERNATE_OBJECT_DIRECTORIES
941           Due to the immutable nature of Git objects, old objects can be
942           archived into shared, read-only directories. This variable
943           specifies a ":" separated (on Windows ";" separated) list of Git
944           object directories which can be used to search for Git objects. New
945           objects will not be written to these directories.
946
947           Entries that begin with " (double-quote) will be interpreted as
948           C-style quoted paths, removing leading and trailing double-quotes
949           and respecting backslash escapes. E.g., the value
950           "path-with-\"-and-:-in-it":vanilla-path has two paths:
951           path-with-"-and-:-in-it and vanilla-path.
952
953       GIT_DIR
954           If the GIT_DIR environment variable is set then it specifies a path
955           to use instead of the default .git for the base of the repository.
956           The --git-dir command-line option also sets this value.
957
958       GIT_WORK_TREE
959           Set the path to the root of the working tree. This can also be
960           controlled by the --work-tree command-line option and the
961           core.worktree configuration variable.
962
963       GIT_NAMESPACE
964           Set the Git namespace; see gitnamespaces(7) for details. The
965           --namespace command-line option also sets this value.
966
967       GIT_CEILING_DIRECTORIES
968           This should be a colon-separated list of absolute paths. If set, it
969           is a list of directories that Git should not chdir up into while
970           looking for a repository directory (useful for excluding
971           slow-loading network directories). It will not exclude the current
972           working directory or a GIT_DIR set on the command line or in the
973           environment. Normally, Git has to read the entries in this list and
974           resolve any symlink that might be present in order to compare them
975           with the current directory. However, if even this access is slow,
976           you can add an empty entry to the list to tell Git that the
977           subsequent entries are not symlinks and needn’t be resolved; e.g.,
978           GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink.
979
980       GIT_DISCOVERY_ACROSS_FILESYSTEM
981           When run in a directory that does not have ".git" repository
982           directory, Git tries to find such a directory in the parent
983           directories to find the top of the working tree, but by default it
984           does not cross filesystem boundaries. This Boolean environment
985           variable can be set to true to tell Git not to stop at filesystem
986           boundaries. Like GIT_CEILING_DIRECTORIES, this will not affect an
987           explicit repository directory set via GIT_DIR or on the command
988           line.
989
990       GIT_COMMON_DIR
991           If this variable is set to a path, non-worktree files that are
992           normally in $GIT_DIR will be taken from this path instead.
993           Worktree-specific files such as HEAD or index are taken from
994           $GIT_DIR. See gitrepository-layout(5) and git-worktree(1) for
995           details. This variable has lower precedence than other path
996           variables such as GIT_INDEX_FILE, GIT_OBJECT_DIRECTORY...
997
998       GIT_DEFAULT_HASH
999           If this variable is set, the default hash algorithm for new
1000           repositories will be set to this value. This value is ignored when
1001           cloning and the setting of the remote repository is always used.
1002           The default is "sha1". See --object-format in git-init(1).
1003
1004   Git Commits
1005       GIT_AUTHOR_NAME
1006           The human-readable name used in the author identity when creating
1007           commit or tag objects, or when writing reflogs. Overrides the
1008           user.name and author.name configuration settings.
1009
1010       GIT_AUTHOR_EMAIL
1011           The email address used in the author identity when creating commit
1012           or tag objects, or when writing reflogs. Overrides the user.email
1013           and author.email configuration settings.
1014
1015       GIT_AUTHOR_DATE
1016           The date used for the author identity when creating commit or tag
1017           objects, or when writing reflogs. See git-commit(1) for valid
1018           formats.
1019
1020       GIT_COMMITTER_NAME
1021           The human-readable name used in the committer identity when
1022           creating commit or tag objects, or when writing reflogs. Overrides
1023           the user.name and committer.name configuration settings.
1024
1025       GIT_COMMITTER_EMAIL
1026           The email address used in the author identity when creating commit
1027           or tag objects, or when writing reflogs. Overrides the user.email
1028           and committer.email configuration settings.
1029
1030       GIT_COMMITTER_DATE
1031           The date used for the committer identity when creating commit or
1032           tag objects, or when writing reflogs. See git-commit(1) for valid
1033           formats.
1034
1035       EMAIL
1036           The email address used in the author and committer identities if no
1037           other relevant environment variable or configuration setting has
1038           been set.
1039
1040   Git Diffs
1041       GIT_DIFF_OPTS
1042           Only valid setting is "--unified=??" or "-u??" to set the number of
1043           context lines shown when a unified diff is created. This takes
1044           precedence over any "-U" or "--unified" option value passed on the
1045           Git diff command line.
1046
1047       GIT_EXTERNAL_DIFF
1048           When the environment variable GIT_EXTERNAL_DIFF is set, the program
1049           named by it is called to generate diffs, and Git does not use its
1050           builtin diff machinery. For a path that is added, removed, or
1051           modified, GIT_EXTERNAL_DIFF is called with 7 parameters:
1052
1053               path old-file old-hex old-mode new-file new-hex new-mode
1054
1055           where:
1056
1057       <old|new>-file
1058           are files GIT_EXTERNAL_DIFF can use to read the contents of
1059           <old|new>,
1060
1061       <old|new>-hex
1062           are the 40-hexdigit SHA-1 hashes,
1063
1064       <old|new>-mode
1065           are the octal representation of the file modes.
1066
1067           The file parameters can point at the user’s working file (e.g.
1068           new-file in "git-diff-files"), /dev/null (e.g.  old-file when a new
1069           file is added), or a temporary file (e.g.  old-file in the index).
1070           GIT_EXTERNAL_DIFF should not worry about unlinking the temporary
1071           file — it is removed when GIT_EXTERNAL_DIFF exits.
1072
1073           For a path that is unmerged, GIT_EXTERNAL_DIFF is called with 1
1074           parameter, <path>.
1075
1076           For each path GIT_EXTERNAL_DIFF is called, two environment
1077           variables, GIT_DIFF_PATH_COUNTER and GIT_DIFF_PATH_TOTAL are set.
1078
1079       GIT_DIFF_PATH_COUNTER
1080           A 1-based counter incremented by one for every path.
1081
1082       GIT_DIFF_PATH_TOTAL
1083           The total number of paths.
1084
1085   other
1086       GIT_MERGE_VERBOSITY
1087           A number controlling the amount of output shown by the recursive
1088           merge strategy. Overrides merge.verbosity. See git-merge(1)
1089
1090       GIT_PAGER
1091           This environment variable overrides $PAGER. If it is set to an
1092           empty string or to the value "cat", Git will not launch a pager.
1093           See also the core.pager option in git-config(1).
1094
1095       GIT_PROGRESS_DELAY
1096           A number controlling how many seconds to delay before showing
1097           optional progress indicators. Defaults to 2.
1098
1099       GIT_EDITOR
1100           This environment variable overrides $EDITOR and $VISUAL. It is used
1101           by several Git commands when, on interactive mode, an editor is to
1102           be launched. See also git-var(1) and the core.editor option in git-
1103           config(1).
1104
1105       GIT_SEQUENCE_EDITOR
1106           This environment variable overrides the configured Git editor when
1107           editing the todo list of an interactive rebase. See also git-
1108           rebase(1) and the sequence.editor option in git-config(1).
1109
1110       GIT_SSH, GIT_SSH_COMMAND
1111           If either of these environment variables is set then git fetch and
1112           git push will use the specified command instead of ssh when they
1113           need to connect to a remote system. The command-line parameters
1114           passed to the configured command are determined by the ssh variant.
1115           See ssh.variant option in git-config(1) for details.
1116
1117           $GIT_SSH_COMMAND takes precedence over $GIT_SSH, and is interpreted
1118           by the shell, which allows additional arguments to be included.
1119           $GIT_SSH on the other hand must be just the path to a program
1120           (which can be a wrapper shell script, if additional arguments are
1121           needed).
1122
1123           Usually it is easier to configure any desired options through your
1124           personal .ssh/config file. Please consult your ssh documentation
1125           for further details.
1126
1127       GIT_SSH_VARIANT
1128           If this environment variable is set, it overrides Git’s
1129           autodetection whether GIT_SSH/GIT_SSH_COMMAND/core.sshCommand refer
1130           to OpenSSH, plink or tortoiseplink. This variable overrides the
1131           config setting ssh.variant that serves the same purpose.
1132
1133       GIT_SSL_NO_VERIFY
1134           Setting and exporting this environment variable to any value tells
1135           Git not to verify the SSL certificate when fetching or pushing over
1136           HTTPS.
1137
1138       GIT_ATTR_SOURCE
1139           Sets the treeish that gitattributes will be read from.
1140
1141       GIT_ASKPASS
1142           If this environment variable is set, then Git commands which need
1143           to acquire passwords or passphrases (e.g. for HTTP or IMAP
1144           authentication) will call this program with a suitable prompt as
1145           command-line argument and read the password from its STDOUT. See
1146           also the core.askPass option in git-config(1).
1147
1148       GIT_TERMINAL_PROMPT
1149           If this Boolean environment variable is set to false, git will not
1150           prompt on the terminal (e.g., when asking for HTTP authentication).
1151
1152       GIT_CONFIG_GLOBAL, GIT_CONFIG_SYSTEM
1153           Take the configuration from the given files instead from global or
1154           system-level configuration files. If GIT_CONFIG_SYSTEM is set, the
1155           system config file defined at build time (usually /etc/gitconfig)
1156           will not be read. Likewise, if GIT_CONFIG_GLOBAL is set, neither
1157           $HOME/.gitconfig nor $XDG_CONFIG_HOME/git/config will be read. Can
1158           be set to /dev/null to skip reading configuration files of the
1159           respective level.
1160
1161       GIT_CONFIG_NOSYSTEM
1162           Whether to skip reading settings from the system-wide
1163           $(prefix)/etc/gitconfig file. This Boolean environment variable can
1164           be used along with $HOME and $XDG_CONFIG_HOME to create a
1165           predictable environment for a picky script, or you can set it to
1166           true to temporarily avoid using a buggy /etc/gitconfig file while
1167           waiting for someone with sufficient permissions to fix it.
1168
1169       GIT_FLUSH
1170           If this environment variable is set to "1", then commands such as
1171           git blame (in incremental mode), git rev-list, git log, git
1172           check-attr and git check-ignore will force a flush of the output
1173           stream after each record have been flushed. If this variable is set
1174           to "0", the output of these commands will be done using completely
1175           buffered I/O. If this environment variable is not set, Git will
1176           choose buffered or record-oriented flushing based on whether stdout
1177           appears to be redirected to a file or not.
1178
1179       GIT_TRACE
1180           Enables general trace messages, e.g. alias expansion, built-in
1181           command execution and external command execution.
1182
1183           If this variable is set to "1", "2" or "true" (comparison is case
1184           insensitive), trace messages will be printed to stderr.
1185
1186           If the variable is set to an integer value greater than 2 and lower
1187           than 10 (strictly) then Git will interpret this value as an open
1188           file descriptor and will try to write the trace messages into this
1189           file descriptor.
1190
1191           Alternatively, if the variable is set to an absolute path (starting
1192           with a / character), Git will interpret this as a file path and
1193           will try to append the trace messages to it.
1194
1195           Unsetting the variable, or setting it to empty, "0" or "false"
1196           (case insensitive) disables trace messages.
1197
1198       GIT_TRACE_FSMONITOR
1199           Enables trace messages for the filesystem monitor extension. See
1200           GIT_TRACE for available trace output options.
1201
1202       GIT_TRACE_PACK_ACCESS
1203           Enables trace messages for all accesses to any packs. For each
1204           access, the pack file name and an offset in the pack is recorded.
1205           This may be helpful for troubleshooting some pack-related
1206           performance problems. See GIT_TRACE for available trace output
1207           options.
1208
1209       GIT_TRACE_PACKET
1210           Enables trace messages for all packets coming in or out of a given
1211           program. This can help with debugging object negotiation or other
1212           protocol issues. Tracing is turned off at a packet starting with
1213           "PACK" (but see GIT_TRACE_PACKFILE below). See GIT_TRACE for
1214           available trace output options.
1215
1216       GIT_TRACE_PACKFILE
1217           Enables tracing of packfiles sent or received by a given program.
1218           Unlike other trace output, this trace is verbatim: no headers, and
1219           no quoting of binary data. You almost certainly want to direct into
1220           a file (e.g., GIT_TRACE_PACKFILE=/tmp/my.pack) rather than
1221           displaying it on the terminal or mixing it with other trace output.
1222
1223           Note that this is currently only implemented for the client side of
1224           clones and fetches.
1225
1226       GIT_TRACE_PERFORMANCE
1227           Enables performance related trace messages, e.g. total execution
1228           time of each Git command. See GIT_TRACE for available trace output
1229           options.
1230
1231       GIT_TRACE_REFS
1232           Enables trace messages for operations on the ref database. See
1233           GIT_TRACE for available trace output options.
1234
1235       GIT_TRACE_SETUP
1236           Enables trace messages printing the .git, working tree and current
1237           working directory after Git has completed its setup phase. See
1238           GIT_TRACE for available trace output options.
1239
1240       GIT_TRACE_SHALLOW
1241           Enables trace messages that can help debugging fetching / cloning
1242           of shallow repositories. See GIT_TRACE for available trace output
1243           options.
1244
1245       GIT_TRACE_CURL
1246           Enables a curl full trace dump of all incoming and outgoing data,
1247           including descriptive information, of the git transport protocol.
1248           This is similar to doing curl --trace-ascii on the command line.
1249           See GIT_TRACE for available trace output options.
1250
1251       GIT_TRACE_CURL_NO_DATA
1252           When a curl trace is enabled (see GIT_TRACE_CURL above), do not
1253           dump data (that is, only dump info lines and headers).
1254
1255       GIT_TRACE2
1256           Enables more detailed trace messages from the "trace2" library.
1257           Output from GIT_TRACE2 is a simple text-based format for human
1258           readability.
1259
1260           If this variable is set to "1", "2" or "true" (comparison is case
1261           insensitive), trace messages will be printed to stderr.
1262
1263           If the variable is set to an integer value greater than 2 and lower
1264           than 10 (strictly) then Git will interpret this value as an open
1265           file descriptor and will try to write the trace messages into this
1266           file descriptor.
1267
1268           Alternatively, if the variable is set to an absolute path (starting
1269           with a / character), Git will interpret this as a file path and
1270           will try to append the trace messages to it. If the path already
1271           exists and is a directory, the trace messages will be written to
1272           files (one per process) in that directory, named according to the
1273           last component of the SID and an optional counter (to avoid
1274           filename collisions).
1275
1276           In addition, if the variable is set to
1277           af_unix:[<socket_type>:]<absolute-pathname>, Git will try to open
1278           the path as a Unix Domain Socket. The socket type can be either
1279           stream or dgram.
1280
1281           Unsetting the variable, or setting it to empty, "0" or "false"
1282           (case insensitive) disables trace messages.
1283
1284           See Trace2 documentation[2] for full details.
1285
1286       GIT_TRACE2_EVENT
1287           This setting writes a JSON-based format that is suited for machine
1288           interpretation. See GIT_TRACE2 for available trace output options
1289           and Trace2 documentation[2] for full details.
1290
1291       GIT_TRACE2_PERF
1292           In addition to the text-based messages available in GIT_TRACE2,
1293           this setting writes a column-based format for understanding nesting
1294           regions. See GIT_TRACE2 for available trace output options and
1295           Trace2 documentation[2] for full details.
1296
1297       GIT_TRACE_REDACT
1298           By default, when tracing is activated, Git redacts the values of
1299           cookies, the "Authorization:" header, the "Proxy-Authorization:"
1300           header and packfile URIs. Set this Boolean environment variable to
1301           false to prevent this redaction.
1302
1303       GIT_LITERAL_PATHSPECS
1304           Setting this Boolean environment variable to true will cause Git to
1305           treat all pathspecs literally, rather than as glob patterns. For
1306           example, running GIT_LITERAL_PATHSPECS=1 git log -- '*.c' will
1307           search for commits that touch the path *.c, not any paths that the
1308           glob *.c matches. You might want this if you are feeding literal
1309           paths to Git (e.g., paths previously given to you by git ls-tree,
1310           --raw diff output, etc).
1311
1312       GIT_GLOB_PATHSPECS
1313           Setting this Boolean environment variable to true will cause Git to
1314           treat all pathspecs as glob patterns (aka "glob" magic).
1315
1316       GIT_NOGLOB_PATHSPECS
1317           Setting this Boolean environment variable to true will cause Git to
1318           treat all pathspecs as literal (aka "literal" magic).
1319
1320       GIT_ICASE_PATHSPECS
1321           Setting this Boolean environment variable to true will cause Git to
1322           treat all pathspecs as case-insensitive.
1323
1324       GIT_REFLOG_ACTION
1325           When a ref is updated, reflog entries are created to keep track of
1326           the reason why the ref was updated (which is typically the name of
1327           the high-level command that updated the ref), in addition to the
1328           old and new values of the ref. A scripted Porcelain command can use
1329           set_reflog_action helper function in git-sh-setup to set its name
1330           to this variable when it is invoked as the top level command by the
1331           end user, to be recorded in the body of the reflog.
1332
1333       GIT_REF_PARANOIA
1334           If this Boolean environment variable is set to false, ignore broken
1335           or badly named refs when iterating over lists of refs. Normally Git
1336           will try to include any such refs, which may cause some operations
1337           to fail. This is usually preferable, as potentially destructive
1338           operations (e.g., git-prune(1)) are better off aborting rather than
1339           ignoring broken refs (and thus considering the history they point
1340           to as not worth saving). The default value is 1 (i.e., be paranoid
1341           about detecting and aborting all operations). You should not
1342           normally need to set this to 0, but it may be useful when trying to
1343           salvage data from a corrupted repository.
1344
1345       GIT_COMMIT_GRAPH_PARANOIA
1346           When loading a commit object from the commit-graph, Git performs an
1347           existence check on the object in the object database. This is done
1348           to avoid issues with stale commit-graphs that contain references to
1349           already-deleted commits, but comes with a performance penalty.
1350
1351           The default is "true", which enables the aforementioned behavior.
1352           Setting this to "false" disables the existence check. This can lead
1353           to a performance improvement at the cost of consistency.
1354
1355       GIT_ALLOW_PROTOCOL
1356           If set to a colon-separated list of protocols, behave as if
1357           protocol.allow is set to never, and each of the listed protocols
1358           has protocol.<name>.allow set to always (overriding any existing
1359           configuration). See the description of protocol.allow in git-
1360           config(1) for more details.
1361
1362       GIT_PROTOCOL_FROM_USER
1363           Set this Boolean environment variable to false to prevent protocols
1364           used by fetch/push/clone which are configured to the user state.
1365           This is useful to restrict recursive submodule initialization from
1366           an untrusted repository or for programs which feed
1367           potentially-untrusted URLS to git commands. See git-config(1) for
1368           more details.
1369
1370       GIT_PROTOCOL
1371           For internal use only. Used in handshaking the wire protocol.
1372           Contains a colon : separated list of keys with optional values
1373           key[=value]. Presence of unknown keys and values must be ignored.
1374
1375           Note that servers may need to be configured to allow this variable
1376           to pass over some transports. It will be propagated automatically
1377           when accessing local repositories (i.e., file:// or a filesystem
1378           path), as well as over the git:// protocol. For git-over-http, it
1379           should work automatically in most configurations, but see the
1380           discussion in git-http-backend(1). For git-over-ssh, the ssh server
1381           may need to be configured to allow clients to pass this variable
1382           (e.g., by using AcceptEnv GIT_PROTOCOL with OpenSSH).
1383
1384           This configuration is optional. If the variable is not propagated,
1385           then clients will fall back to the original "v0" protocol (but may
1386           miss out on some performance improvements or features). This
1387           variable currently only affects clones and fetches; it is not yet
1388           used for pushes (but may be in the future).
1389
1390       GIT_OPTIONAL_LOCKS
1391           If this Boolean environment variable is set to false, Git will
1392           complete any requested operation without performing any optional
1393           sub-operations that require taking a lock. For example, this will
1394           prevent git status from refreshing the index as a side effect. This
1395           is useful for processes running in the background which do not want
1396           to cause lock contention with other operations on the repository.
1397           Defaults to 1.
1398
1399       GIT_REDIRECT_STDIN, GIT_REDIRECT_STDOUT, GIT_REDIRECT_STDERR
1400           Windows-only: allow redirecting the standard input/output/error
1401           handles to paths specified by the environment variables. This is
1402           particularly useful in multi-threaded applications where the
1403           canonical way to pass standard handles via CreateProcess() is not
1404           an option because it would require the handles to be marked
1405           inheritable (and consequently every spawned process would inherit
1406           them, possibly blocking regular Git operations). The primary
1407           intended use case is to use named pipes for communication (e.g.
1408           \\.\pipe\my-git-stdin-123).
1409
1410           Two special values are supported: off will simply close the
1411           corresponding standard handle, and if GIT_REDIRECT_STDERR is 2>&1,
1412           standard error will be redirected to the same handle as standard
1413           output.
1414
1415       GIT_PRINT_SHA1_ELLIPSIS (deprecated)
1416           If set to yes, print an ellipsis following an (abbreviated) SHA-1
1417           value. This affects indications of detached HEADs (git-checkout(1))
1418           and the raw diff output (git-diff(1)). Printing an ellipsis in the
1419           cases mentioned is no longer considered adequate and support for it
1420           is likely to be removed in the foreseeable future (along with the
1421           variable).
1422

DISCUSSION

1424       More detail on the following is available from the Git concepts chapter
1425       of the user-manual[3] and gitcore-tutorial(7).
1426
1427       A Git project normally consists of a working directory with a ".git"
1428       subdirectory at the top level. The .git directory contains, among other
1429       things, a compressed object database representing the complete history
1430       of the project, an "index" file which links that history to the current
1431       contents of the working tree, and named pointers into that history such
1432       as tags and branch heads.
1433
1434       The object database contains objects of three main types: blobs, which
1435       hold file data; trees, which point to blobs and other trees to build up
1436       directory hierarchies; and commits, which each reference a single tree
1437       and some number of parent commits.
1438
1439       The commit, equivalent to what other systems call a "changeset" or
1440       "version", represents a step in the project’s history, and each parent
1441       represents an immediately preceding step. Commits with more than one
1442       parent represent merges of independent lines of development.
1443
1444       All objects are named by the SHA-1 hash of their contents, normally
1445       written as a string of 40 hex digits. Such names are globally unique.
1446       The entire history leading up to a commit can be vouched for by signing
1447       just that commit. A fourth object type, the tag, is provided for this
1448       purpose.
1449
1450       When first created, objects are stored in individual files, but for
1451       efficiency may later be compressed together into "pack files".
1452
1453       Named pointers called refs mark interesting points in history. A ref
1454       may contain the SHA-1 name of an object or the name of another ref.
1455       Refs with names beginning ref/head/ contain the SHA-1 name of the most
1456       recent commit (or "head") of a branch under development. SHA-1 names of
1457       tags of interest are stored under ref/tags/. A special ref named HEAD
1458       contains the name of the currently checked-out branch.
1459
1460       The index file is initialized with a list of all paths and, for each
1461       path, a blob object and a set of attributes. The blob object represents
1462       the contents of the file as of the head of the current branch. The
1463       attributes (last modified time, size, etc.) are taken from the
1464       corresponding file in the working tree. Subsequent changes to the
1465       working tree can be found by comparing these attributes. The index may
1466       be updated with new content, and new commits may be created from the
1467       content stored in the index.
1468
1469       The index is also capable of storing multiple entries (called "stages")
1470       for a given pathname. These stages are used to hold the various
1471       unmerged version of a file when a merge is in progress.
1472

FURTHER DOCUMENTATION

1474       See the references in the "description" section to get started using
1475       Git. The following is probably more detail than necessary for a
1476       first-time user.
1477
1478       The Git concepts chapter of the user-manual[3] and gitcore-tutorial(7)
1479       both provide introductions to the underlying Git architecture.
1480
1481       See gitworkflows(7) for an overview of recommended workflows.
1482
1483       See also the howto[4] documents for some useful examples.
1484
1485       The internals are documented in the Git API documentation[5].
1486
1487       Users migrating from CVS may also want to read gitcvs-migration(7).
1488

AUTHORS

1490       Git was started by Linus Torvalds, and is currently maintained by Junio
1491       C Hamano. Numerous contributions have come from the Git mailing list
1492       <git@vger.kernel.org[6]>.
1493       http://www.openhub.net/p/git/contributors/summary gives you a more
1494       complete list of contributors.
1495
1496       If you have a clone of git.git itself, the output of git-shortlog(1)
1497       and git-blame(1) can show you the authors for specific parts of the
1498       project.
1499

REPORTING BUGS

1501       Report bugs to the Git mailing list <git@vger.kernel.org[6]> where the
1502       development and maintenance is primarily done. You do not have to be
1503       subscribed to the list to send a message there. See the list archive at
1504       https://lore.kernel.org/git for previous bug reports and other
1505       discussions.
1506
1507       Issues which are security relevant should be disclosed privately to the
1508       Git Security mailing list <git-security@googlegroups.com[7]>.
1509

SEE ALSO

1511       gittutorial(7), gittutorial-2(7), giteveryday(7), gitcvs-migration(7),
1512       gitglossary(7), gitcore-tutorial(7), gitcli(7), The Git User’s
1513       Manual[1], gitworkflows(7)
1514

GIT

1516       Part of the git(1) suite
1517

NOTES

1519        1. Git User’s Manual
1520           file:///usr/share/doc/git/user-manual.html
1521
1522        2. Trace2 documentation
1523           file:///usr/share/doc/git/technical/api-trace2.html
1524
1525        3. Git concepts chapter of the user-manual
1526           file:///usr/share/doc/git/user-manual.html#git-concepts
1527
1528        4. howto
1529           file:///usr/share/doc/git/howto-index.html
1530
1531        5. Git API documentation
1532           file:///usr/share/doc/git/technical/api-index.html
1533
1534        6. git@vger.kernel.org
1535           mailto:git@vger.kernel.org
1536
1537        7. git-security@googlegroups.com
1538           mailto:git-security@googlegroups.com
1539
1540
1541
1542Git 2.43.0                        11/20/2023                            GIT(1)
Impressum