git.oblomov.eu Git - git/blob - Documentation/gitrepository-layout.txt

   1 gitrepository-layout(5)
   2 =======================
   3
   4 NAME
   5 ----
   6 gitrepository-layout - Git Repository Layout
   7
   8 SYNOPSIS
   9 --------
  10 $GIT_DIR/*
  11
  12 DESCRIPTION
  13 -----------
  14
  15 A Git repository comes in two different flavours:
  16
  17  * a `.git` directory at the root of the working tree;
  18
  19  * a `<project>.git` directory that is a 'bare' repository
  20    (i.e. without its own working tree), that is typically used for
  21    exchanging histories with others by pushing into it and fetching
  22    from it.
  23
  24 *Note*: Also you can have a plain text file `.git` at the root of
  25 your working tree, containing `gitdir: <path>` to point at the real
  26 directory that has the repository.  This mechanism is often used for
  27 a working tree of a submodule checkout, to allow you in the
  28 containing superproject to `git checkout` a branch that does not
  29 have the submodule.  The `checkout` has to remove the entire
  30 submodule working tree, without losing the submodule repository.
  31
  32 These things may exist in a Git repository.
  33
  34 objects::
  35         Object store associated with this repository.  Usually
  36         an object store is self sufficient (i.e. all the objects
  37         that are referred to by an object found in it are also
  38         found in it), but there are a few ways to violate it.
  39 +
  40 . You could have an incomplete but locally usable repository
  41 by creating a shallow clone.  See linkgit:git-clone[1].
  42 . You could be using the `objects/info/alternates` or
  43 `$GIT_ALTERNATE_OBJECT_DIRECTORIES` mechanisms to 'borrow'
  44 objects from other object stores.  A repository with this kind
  45 of incomplete object store is not suitable to be published for
  46 use with dumb transports but otherwise is OK as long as
  47 `objects/info/alternates` points at the object stores it
  48 borrows from.
  49 +
  50 This directory is ignored if $GIT_COMMON_DIR is set and
  51 "$GIT_COMMON_DIR/objects" will be used instead.
  52
  53 objects/[0-9a-f][0-9a-f]::
  54         A newly created object is stored in its own file.
  55         The objects are splayed over 256 subdirectories using
  56         the first two characters of the sha1 object name to
  57         keep the number of directory entries in `objects`
  58         itself to a manageable number. Objects found
  59         here are often called 'unpacked' (or 'loose') objects.
  60
  61 objects/pack::
  62         Packs (files that store many object in compressed form,
  63         along with index files to allow them to be randomly
  64         accessed) are found in this directory.
  65
  66 objects/info::
  67         Additional information about the object store is
  68         recorded in this directory.
  69
  70 objects/info/packs::
  71         This file is to help dumb transports discover what packs
  72         are available in this object store.  Whenever a pack is
  73         added or removed, `git update-server-info` should be run
  74         to keep this file up to date if the repository is
  75         published for dumb transports.  'git repack' does this
  76         by default.
  77
  78 objects/info/alternates::
  79         This file records paths to alternate object stores that
  80         this object store borrows objects from, one pathname per
  81         line. Note that not only native Git tools use it locally,
  82         but the HTTP fetcher also tries to use it remotely; this
  83         will usually work if you have relative paths (relative
  84         to the object database, not to the repository!) in your
  85         alternates file, but it will not work if you use absolute
  86         paths unless the absolute path in filesystem and web URL
  87         is the same. See also 'objects/info/http-alternates'.
  88
  89 objects/info/http-alternates::
  90         This file records URLs to alternate object stores that
  91         this object store borrows objects from, to be used when
  92         the repository is fetched over HTTP.
  93
  94 refs::
  95         References are stored in subdirectories of this
  96         directory.  The 'git prune' command knows to preserve
  97         objects reachable from refs found in this directory and
  98         its subdirectories.
  99         This directory is ignored (except refs/bisect and
 100         refs/worktree) if $GIT_COMMON_DIR is set and
 101         "$GIT_COMMON_DIR/refs" will be used instead.
 102
 103 refs/heads/`name`::
 104         records tip-of-the-tree commit objects of branch `name`
 105
 106 refs/tags/`name`::
 107         records any object name (not necessarily a commit
 108         object, or a tag object that points at a commit object).
 109
 110 refs/remotes/`name`::
 111         records tip-of-the-tree commit objects of branches copied
 112         from a remote repository.
 113
 114 refs/replace/`<obj-sha1>`::
 115         records the SHA-1 of the object that replaces `<obj-sha1>`.
 116         This is similar to info/grafts and is internally used and
 117         maintained by linkgit:git-replace[1]. Such refs can be exchanged
 118         between repositories while grafts are not.
 119
 120 packed-refs::
 121         records the same information as refs/heads/, refs/tags/,
 122         and friends record in a more efficient way.  See
 123         linkgit:git-pack-refs[1]. This file is ignored if $GIT_COMMON_DIR
 124         is set and "$GIT_COMMON_DIR/packed-refs" will be used instead.
 125
 126 HEAD::
 127         A symref (see glossary) to the `refs/heads/` namespace
 128         describing the currently active branch.  It does not mean
 129         much if the repository is not associated with any working tree
 130         (i.e. a 'bare' repository), but a valid Git repository
 131         *must* have the HEAD file; some porcelains may use it to
 132         guess the designated "default" branch of the repository
 133         (usually 'master').  It is legal if the named branch
 134         'name' does not (yet) exist.  In some legacy setups, it is
 135         a symbolic link instead of a symref that points at the current
 136         branch.
 137 +
 138 HEAD can also record a specific commit directly, instead of
 139 being a symref to point at the current branch.  Such a state
 140 is often called 'detached HEAD.'  See linkgit:git-checkout[1]
 141 for details.
 142
 143 config::
 144         Repository specific configuration file. This file is ignored
 145         if $GIT_COMMON_DIR is set and "$GIT_COMMON_DIR/config" will be
 146         used instead.
 147
 148 branches::
 149         A slightly deprecated way to store shorthands to be used
 150         to specify a URL to 'git fetch', 'git pull' and 'git push'.
 151         A file can be stored as `branches/<name>` and then
 152         'name' can be given to these commands in place of
 153         'repository' argument.  See the REMOTES section in
 154         linkgit:git-fetch[1] for details.  This mechanism is legacy
 155         and not likely to be found in modern repositories. This
 156         directory is ignored if $GIT_COMMON_DIR is set and
 157         "$GIT_COMMON_DIR/branches" will be used instead.
 158
 159
 160 hooks::
 161         Hooks are customization scripts used by various Git
 162         commands.  A handful of sample hooks are installed when
 163         'git init' is run, but all of them are disabled by
 164         default.  To enable, the `.sample` suffix has to be
 165         removed from the filename by renaming.
 166         Read linkgit:githooks[5] for more details about
 167         each hook. This directory is ignored if $GIT_COMMON_DIR is set
 168         and "$GIT_COMMON_DIR/hooks" will be used instead.
 169
 170 common::
 171         When multiple working trees are used, most of files in
 172         $GIT_DIR are per-worktree with a few known exceptions. All
 173         files under 'common' however will be shared between all
 174         working trees.
 175
 176 index::
 177         The current index file for the repository.  It is
 178         usually not found in a bare repository.
 179
 180 sharedindex.<SHA-1>::
 181         The shared index part, to be referenced by $GIT_DIR/index and
 182         other temporary index files. Only valid in split index mode.
 183
 184 info::
 185         Additional information about the repository is recorded
 186         in this directory. This directory is ignored if $GIT_COMMON_DIR
 187         is set and "$GIT_COMMON_DIR/info" will be used instead.
 188
 189 info/refs::
 190         This file helps dumb transports discover what refs are
 191         available in this repository.  If the repository is
 192         published for dumb transports, this file should be
 193         regenerated by 'git update-server-info' every time a tag
 194         or branch is created or modified.  This is normally done
 195         from the `hooks/update` hook, which is run by the
 196         'git-receive-pack' command when you 'git push' into the
 197         repository.
 198
 199 info/grafts::
 200         This file records fake commit ancestry information, to
 201         pretend the set of parents a commit has is different
 202         from how the commit was actually created.  One record
 203         per line describes a commit and its fake parents by
 204         listing their 40-byte hexadecimal object names separated
 205         by a space and terminated by a newline.
 206 +
 207 Note that the grafts mechanism is outdated and can lead to problems
 208 transferring objects between repositories; see linkgit:git-replace[1]
 209 for a more flexible and robust system to do the same thing.
 210
 211 info/exclude::
 212         This file, by convention among Porcelains, stores the
 213         exclude pattern list. `.gitignore` is the per-directory
 214         ignore file.  'git status', 'git add', 'git rm' and
 215         'git clean' look at it but the core Git commands do not look
 216         at it.  See also: linkgit:gitignore[5].
 217
 218 info/attributes::
 219         Defines which attributes to assign to a path, similar to per-directory
 220         `.gitattributes` files.   See also: linkgit:gitattributes[5].
 221
 222 info/sparse-checkout::
 223         This file stores sparse checkout patterns.
 224         See also: linkgit:git-read-tree[1].
 225
 226 remotes::
 227         Stores shorthands for URL and default refnames for use
 228         when interacting with remote repositories via 'git fetch',
 229         'git pull' and 'git push' commands.  See the REMOTES section
 230         in linkgit:git-fetch[1] for details.  This mechanism is legacy
 231         and not likely to be found in modern repositories. This
 232         directory is ignored if $GIT_COMMON_DIR is set and
 233         "$GIT_COMMON_DIR/remotes" will be used instead.
 234
 235 logs::
 236         Records of changes made to refs are stored in this directory.
 237         See linkgit:git-update-ref[1] for more information. This
 238         directory is ignored if $GIT_COMMON_DIR is set and
 239         "$GIT_COMMON_DIR/logs" will be used instead.
 240
 241 logs/refs/heads/`name`::
 242         Records all changes made to the branch tip named `name`.
 243
 244 logs/refs/tags/`name`::
 245         Records all changes made to the tag named `name`.
 246
 247 shallow::
 248         This is similar to `info/grafts` but is internally used
 249         and maintained by shallow clone mechanism.  See `--depth`
 250         option to linkgit:git-clone[1] and linkgit:git-fetch[1]. This
 251         file is ignored if $GIT_COMMON_DIR is set and
 252         "$GIT_COMMON_DIR/shallow" will be used instead.
 253
 254 commondir::
 255         If this file exists, $GIT_COMMON_DIR (see linkgit:git[1]) will
 256         be set to the path specified in this file if it is not
 257         explicitly set. If the specified path is relative, it is
 258         relative to $GIT_DIR. The repository with commondir is
 259         incomplete without the repository pointed by "commondir".
 260
 261 modules::
 262         Contains the git-repositories of the submodules.
 263
 264 worktrees::
 265         Contains administrative data for linked
 266         working trees. Each subdirectory contains the working tree-related
 267         part of a linked working tree. This directory is ignored if
 268         $GIT_COMMON_DIR is set, in which case
 269         "$GIT_COMMON_DIR/worktrees" will be used instead.
 270
 271 worktrees/<id>/gitdir::
 272         A text file containing the absolute path back to the .git file
 273         that points to here. This is used to check if the linked
 274         repository has been manually removed and there is no need to
 275         keep this directory any more. The mtime of this file should be
 276         updated every time the linked repository is accessed.
 277
 278 worktrees/<id>/locked::
 279         If this file exists, the linked working tree may be on a
 280         portable device and not available. The presence of this file
 281         prevents `worktrees/<id>` from being pruned either automatically
 282         or manually by `git worktree prune`. The file may contain a string
 283         explaining why the repository is locked.
 284
 285 SEE ALSO
 286 --------
 287 linkgit:git-init[1],
 288 linkgit:git-clone[1],
 289 linkgit:git-fetch[1],
 290 linkgit:git-pack-refs[1],
 291 linkgit:git-gc[1],
 292 linkgit:git-checkout[1],
 293 linkgit:gitglossary[7],
 294 link:user-manual.html[The Git User's Manual]
 295
 296 GIT
 297 ---
 298 Part of the linkgit:git[1] suite