2 .\" Copyright (c) 2018 Stefan Sperling <stsp@openbsd.org>
4 .\" Permission to use, copy, modify, and distribute this software for any
5 .\" purpose with or without fee is hereby granted, provided that the above
6 .\" copyright notice and this permission notice appear in all copies.
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 .Nd Git repository format
23 A Git repository stores a series of versioned snapshots of a file hierarchy.
24 Conceptually, the repository's data model is a directed acyclic graph which
25 contains three types of objects as nodes:
28 The content of tracked files is stored in objects of type
33 object points to any number of such blobs, and also to other trees in
34 order to represent a hierarchy of files and directories.
38 object points to the root element of one tree, and thus records the
39 state of this entire tree as a snapshot.
40 Commit objects are chained together to form lines of version control history.
41 Most commits have just one successor commit, but commits may be succeeded by
42 an arbitrary number of subsequent commits so that diverging lines of version
43 control history, known as
46 A commit which precedes another commit is referred to as that other commit's
48 A commit with multiple parents unites disparate lines of history and is
54 object associates a user-defined label with another object, which is
55 typically a commit object.
56 Tag objects also contain a tag message, as well as author and
57 timestamp information.
60 Each object is identified by a SHA1 hash calculated over both the object's
61 header and the data stored in the object.
63 Loose objects are stored as individual files beneath the directory
65 spread across 256 sub-directories named after the 256 possible hexadecimal
66 values of the first byte of an object identifier.
67 The name of the loose object file corresponds to the remaining hexadecimal
68 byte values of the object's identifier.
70 A loose object file begins with a header which specifies the type of object
71 as an ASCII string, followed by an ASCII space character, followed by the
72 object data's size encoded as an ASCII number string.
73 The header is terminated by a
75 character, and the remainder of the file contains object data.
76 Loose objects files are compressed with
79 Multiple objects can be bundled in a
81 for better disk space efficiency and increased run-time performance.
82 The pack file format introduces two additional types of objects:
84 .It Offset Delta Objects
85 This object is represented as a delta against another object in the
87 This other object is referred to by its offset in the pack file.
88 .It Reference Delta Objects
89 This object is represented as a delta against another object in the
91 The other object is referred to by its SHA1 object identifier.
94 Pack files are self-contained and may not refer to loose objects or
95 objects stored in other pack files.
96 Deltified objects may refer to other deltified objects as their delta base,
97 forming chains of deltas.
98 The ultimate base of a delta chain must be an object of the same type as
99 the original object which is stored in deltified form.
101 Each pack file is accompanied by a corresponding
103 file, which lists the IDs and offsets of all objects contained in the
106 A reference associates a name with an object ID.
107 A prominent use of references is providing names to branches in the
108 repository by pointing at commit objects which represent the current
109 tip commit of a branch.
110 Because references may point to arbitrary object IDs, their use
111 is not limited to branches.
113 The name is a UTF-8 string with the following disallowed characters:
121 [ (opening square bracket),
123 Additionally, the name may not contain the two-character sequences
126 Reference names may optionally have multiple components separated by
127 the / (slash) character, forming a hierarchy of reference namespaces.
130 reference namespace for internal use.
132 A symbolic reference associates a name with the name of another reference.
133 The most prominent example is the
135 reference which points at the name of the repository's default branch
138 References are stored either as a plain file within the repository,
143 file which contains one reference definition per line.
145 Any object which is not directly or indirectly reachable via a reference
146 is subject to deletion by Git's garbage collector or
147 .Cm gotadmin cleanup .
149 .Bl -tag -width packed-refs -compact
151 A reference to the current head commit of the Git work tree.
152 In bare repositories, this files serves as a default reference.
154 Reference to original head commit.
155 Set by some Git operations.
157 Reference to a branch tip commit most recently fetched from another repository.
159 Legacy directory used by the deprecated Gogito Git interface.
161 Git configuration file.
165 A human-readable description of the repository.
167 Configuration file for
172 This directory contains hook scripts to run when certain events occur.
174 The file index used by
176 This file is not used by
182 Various configuration items.
184 Directory where reflogs are stored.
186 Loose and packed objects are stored in this directory.
188 A file which stores references.
189 Corresponding on-disk references take precedence over those stored here.
191 The default directory to store references in.
194 A typical Git repository exposes a work tree which allows the user to make
195 changes to versioned files and create new commits.
196 When a Git work tree is present, the actual repository data is stored in a
198 subfolder of the repository's root directory.
199 A Git repository without a work tree is known as a
203 does not make use of Git's work tree and treats every repository as if it
213 The Git repository format was initially designed by Linus Torvalds in 2005
214 and has since been extended by various people involved in the development
215 of the Git version control system.
217 The particular set of disallowed characters in reference names is a
218 consequence of design choices made for the command-line interface of
220 The same characters are disallowed by Got for compatibility purposes.
221 Got additionally prevents users from creating reference names with
222 a leading - (dash) character, because this is rarely intended and
223 not considered useful.
