gitrepository-layout.5   [plain text]

'\" t
.\"     Title: gitrepository-layout
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: 02/24/2014
.\"    Manual: Git Manual
.\"    Source: Git 1.9.0
.\"  Language: English
.\"
.TH "GITREPOSITORY\-LAYOU" "5" "02/24/2014" "Git 1\&.9\&.0" "Git Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
gitrepository-layout \- Git Repository Layout
.SH "SYNOPSIS"
.sp
$GIT_DIR/*
.SH "DESCRIPTION"
.sp
A Git repository comes in two different flavours:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
a
\&.git
directory at the root of the working tree;
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
a
<project>\&.git
directory that is a
\fIbare\fR
repository (i\&.e\&. without its own working tree), that is typically used for exchanging histories with others by pushing into it and fetching from it\&.
.RE
.sp
\fBNote\fR: Also you can have a plain text file \&.git at the root of your working tree, containing gitdir: <path> to point at the real directory that has the repository\&. This mechanism is often used for a working tree of a submodule checkout, to allow you in the containing superproject to git checkout a branch that does not have the submodule\&. The checkout has to remove the entire submodule working tree, without losing the submodule repository\&.
.sp
These things may exist in a Git repository\&.
.PP
objects
.RS 4
Object store associated with this repository\&. Usually an object store is self sufficient (i\&.e\&. all the objects that are referred to by an object found in it are also found in it), but there are a few ways to violate it\&.
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  1." 4.2
.\}
You could have an incomplete but locally usable repository by creating a shallow clone\&. See
\fBgit-clone\fR(1)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  2." 4.2
.\}
You could be using the
objects/info/alternates
or
$GIT_ALTERNATE_OBJECT_DIRECTORIES
mechanisms to
\fIborrow\fR
objects from other object stores\&. A repository with this kind of incomplete object store is not suitable to be published for use with dumb transports but otherwise is OK as long as
objects/info/alternates
points at the object stores it borrows from\&.
.RE
.RE
.PP
objects/[0\-9a\-f][0\-9a\-f]
.RS 4
A newly created object is stored in its own file\&. The objects are splayed over 256 subdirectories using the first two characters of the sha1 object name to keep the number of directory entries in
objects
itself to a manageable number\&. Objects found here are often called
\fIunpacked\fR
(or
\fIloose\fR) objects\&.
.RE
.PP
objects/pack
.RS 4
Packs (files that store many object in compressed form, along with index files to allow them to be randomly accessed) are found in this directory\&.
.RE
.PP
objects/info
.RS 4
Additional information about the object store is recorded in this directory\&.
.RE
.PP
objects/info/packs
.RS 4
This file is to help dumb transports discover what packs are available in this object store\&. Whenever a pack is added or removed,
git update\-server\-info
should be run to keep this file up\-to\-date if the repository is published for dumb transports\&.
\fIgit repack\fR
does this by default\&.
.RE
.PP
objects/info/alternates
.RS 4
This file records paths to alternate object stores that this object store borrows objects from, one pathname per line\&. Note that not only native Git tools use it locally, but the HTTP fetcher also tries to use it remotely; this will usually work if you have relative paths (relative to the object database, not to the repository!) in your alternates file, but it will not work if you use absolute paths unless the absolute path in filesystem and web URL is the same\&. See also
\fIobjects/info/http\-alternates\fR\&.
.RE
.PP
objects/info/http\-alternates
.RS 4
This file records URLs to alternate object stores that this object store borrows objects from, to be used when the repository is fetched over HTTP\&.
.RE
.PP
refs
.RS 4
References are stored in subdirectories of this directory\&. The
\fIgit prune\fR
command knows to preserve objects reachable from refs found in this directory and its subdirectories\&.
.RE
.PP
refs/heads/name
.RS 4
records tip\-of\-the\-tree commit objects of branch
name
.RE
.PP
refs/tags/name
.RS 4
records any object name (not necessarily a commit object, or a tag object that points at a commit object)\&.
.RE
.PP
refs/remotes/name
.RS 4
records tip\-of\-the\-tree commit objects of branches copied from a remote repository\&.
.RE
.PP
refs/replace/<obj\-sha1>
.RS 4
records the SHA\-1 of the object that replaces
<obj\-sha1>\&. This is similar to info/grafts and is internally used and maintained by
\fBgit-replace\fR(1)\&. Such refs can be exchanged between repositories while grafts are not\&.
.RE
.PP
packed\-refs
.RS 4
records the same information as refs/heads/, refs/tags/, and friends record in a more efficient way\&. See
\fBgit-pack-refs\fR(1)\&.
.RE
.PP
HEAD
.RS 4
A symref (see glossary) to the
refs/heads/
namespace describing the currently active branch\&. It does not mean much if the repository is not associated with any working tree (i\&.e\&. a
\fIbare\fR
repository), but a valid Git repository
\fBmust\fR
have the HEAD file; some porcelains may use it to guess the designated "default" branch of the repository (usually
\fImaster\fR)\&. It is legal if the named branch
\fIname\fR
does not (yet) exist\&. In some legacy setups, it is a symbolic link instead of a symref that points at the current branch\&.
.sp
HEAD can also record a specific commit directly, instead of being a symref to point at the current branch\&. Such a state is often called
\fIdetached HEAD\&.\fR
See
\fBgit-checkout\fR(1)
for details\&.
.RE
.PP
branches
.RS 4
A slightly deprecated way to store shorthands to be used to specify a URL to
\fIgit fetch\fR,
\fIgit pull\fR
and
\fIgit push\fR\&. A file can be stored as
branches/<name>
and then
\fIname\fR
can be given to these commands in place of
\fIrepository\fR
argument\&. See the REMOTES section in
\fBgit-fetch\fR(1)
for details\&. This mechanism is legacy and not likely to be found in modern repositories\&.
.RE
.PP
hooks
.RS 4
Hooks are customization scripts used by various Git commands\&. A handful of sample hooks are installed when
\fIgit init\fR
is run, but all of them are disabled by default\&. To enable, the
\&.sample
suffix has to be removed from the filename by renaming\&. Read
\fBgithooks\fR(5)
for more details about each hook\&.
.RE
.PP
index
.RS 4
The current index file for the repository\&. It is usually not found in a bare repository\&.
.RE
.PP
info
.RS 4
Additional information about the repository is recorded in this directory\&.
.RE
.PP
info/refs
.RS 4
This file helps dumb transports discover what refs are available in this repository\&. If the repository is published for dumb transports, this file should be regenerated by
\fIgit update\-server\-info\fR
every time a tag or branch is created or modified\&. This is normally done from the
hooks/update
hook, which is run by the
\fIgit\-receive\-pack\fR
command when you
\fIgit push\fR
into the repository\&.
.RE
.PP
info/grafts
.RS 4
This file records fake commit ancestry information, to pretend the set of parents a commit has is different from how the commit was actually created\&. One record per line describes a commit and its fake parents by listing their 40\-byte hexadecimal object names separated by a space and terminated by a newline\&.
.RE
.PP
info/exclude
.RS 4
This file, by convention among Porcelains, stores the exclude pattern list\&.
\&.gitignore
is the per\-directory ignore file\&.
\fIgit status\fR,
\fIgit add\fR,
\fIgit rm\fR
and
\fIgit clean\fR
look at it but the core Git commands do not look at it\&. See also:
\fBgitignore\fR(5)\&.
.RE
.PP
info/sparse\-checkout
.RS 4
This file stores sparse checkout patterns\&. See also:
\fBgit-read-tree\fR(1)\&.
.RE
.PP
remotes
.RS 4
Stores shorthands for URL and default refnames for use when interacting with remote repositories via
\fIgit fetch\fR,
\fIgit pull\fR
and
\fIgit push\fR
commands\&. See the REMOTES section in
\fBgit-fetch\fR(1)
for details\&. This mechanism is legacy and not likely to be found in modern repositories\&.
.RE
.PP
logs
.RS 4
Records of changes made to refs are stored in this directory\&. See
\fBgit-update-ref\fR(1)
for more information\&.
.RE
.PP
logs/refs/heads/name
.RS 4
Records all changes made to the branch tip named
name\&.
.RE
.PP
logs/refs/tags/name
.RS 4
Records all changes made to the tag named
name\&.
.RE
.PP
shallow
.RS 4
This is similar to
info/grafts
but is internally used and maintained by shallow clone mechanism\&. See
\-\-depth
option to
\fBgit-clone\fR(1)
and
\fBgit-fetch\fR(1)\&.
.RE
.PP
modules
.RS 4
Contains the git\-repositories of the submodules\&.
.RE
.SH "SEE ALSO"
.sp
\fBgit-init\fR(1), \fBgit-clone\fR(1), \fBgit-fetch\fR(1), \fBgit-pack-refs\fR(1), \fBgit-gc\fR(1), \fBgit-checkout\fR(1), \fBgitglossary\fR(7), \m[blue]\fBThe Git User\(cqs Manual\fR\m[]\&\s-2\u[1]\d\s+2
.SH "GIT"
.sp
Part of the \fBgit\fR(1) suite\&.
.SH "NOTES"
.IP " 1." 4
The Git User\(cqs Manual
.RS 4
\%git-htmldocs/user-manual.html
.RE