Documentation: move blame examples
[gitweb.git] / Documentation / repository-layout.txt
index 297a47bdf399e79b0d227dcf75ab20628ae1a0c9..275d18bb545f3b14ad1f7de50d4224f184a507f8 100644 (file)
@@ -1,10 +1,9 @@
-GIT repository layout
+git repository layout
 =====================
-v0.99.5, Sep 2005
 
 You may find these things in your git repository (`.git`
 directory for a repository associated with your working tree, or
-`'project'.git` directory for a public 'naked' repository).
+`'project'.git` directory for a public 'bare' repository).
 
 objects::
        Object store associated with this repository.  Usually
@@ -22,7 +21,7 @@ outside world but sometimes useful for private repository.
 . You can be using `objects/info/alternates` mechanism, or
 `$GIT_ALTERNATE_OBJECT_DIRECTORIES` mechanism to 'borrow'
 objects from other object stores.  A repository with this kind
-of incompete object store is not suitable to be published for
+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 right object stores
 it borrows from.
@@ -74,7 +73,7 @@ HEAD::
        A symlink of the form `refs/heads/'name'` to point at
        the current branch, if exists.  It does not mean much if
        the repository is not associated with any working tree
-       (i.e. 'naked' repository), but a valid git repository
+       (i.e. a 'bare' repository), but a valid git repository
        *must* have such a symlink here.  It is legal if the
        named branch 'name' does not (yet) exist.
 
@@ -90,10 +89,12 @@ hooks::
        commands.  A handful of sample hooks are installed when
        `git init-db` is run, but all of them are disabled by
        default.  To enable, they need to be made executable.
+       Read link:hooks.html[hooks] for more details about
+       each hook.
 
 index::
        The current index file for the repository.  It is
-       usually not found in a naked repository.
+       usually not found in a bare repository.
 
 info::
        Additional information about the repository is recorded
@@ -107,7 +108,7 @@ info/refs::
        up-to-date if the repository is published for dumb
        transports.  The `git-receive-pack` command, which is
        run on a remote repository when you `git push` into it,
-       runs `hooks/update` hook to help you achive this.
+       runs `hooks/update` hook to help you achieve this.
 
 info/grafts::
        This file records fake commit ancestry information, to
@@ -117,20 +118,26 @@ info/grafts::
        listing their 40-byte hexadecimal object names separated
        by a space and terminated by a newline.
 
-info/rev-cache::
-       No higher-level tool currently takes advantage of this
-       file, but it is generated when `git update-server-info`
-       is run.  It records the commit ancestry information of
-       the commits in this repository in a concise binary
-       format, and can be read with `git-show-rev-cache`.
-
 info/exclude::
        This file, by convention among Porcelains, stores the
-       exclude pattern list.  `git status` looks at it, but
-       otherwise it is not looked at by any of the core GIT
-       commands.
+       exclude pattern list. `.gitignore` is the per-directory
+       ignore file.  `git status`, `git add`, `git rm` and `git
+       clean` look at it but the core git commands do not look
+       at it.  See also: gitlink:git-ls-files[1] `--exclude-from`
+       and `--exclude-per-directory`.
 
 remotes::
-       Stoers shorthands to be used to give URL and default
+       Stores shorthands to be used to give URL and default
        refnames to interact with remote repository to `git
        fetch`, `git pull` and `git push` commands.
+
+logs::
+       Records of changes made to refs are stored in this
+       directory.  See the documentation on git-update-ref
+       for more information.
+
+logs/refs/heads/`name`::
+       Records all changes made to the branch tip named `name`.
+
+logs/refs/tags/`name`::
+       Records all changes made to the tag named `name`.