Merge branches 'lt/show' and 'lt/revlist'
[gitweb.git] / Documentation / git.txt
index d13325063520ca005765a4769c71321950b5dd8a..e8ef3efa89a69b3ef4a919a40b8fbd4dec690d0f 100644 (file)
@@ -1,6 +1,5 @@
 git(7)
 ======
-v0.99.4, Aug 2005
 
 NAME
 ----
@@ -9,31 +8,71 @@ git - the stupid content tracker
 
 SYNOPSIS
 --------
-'git-<command>' <args>
+'git' [--version] [--exec-path[=GIT_EXEC_PATH]] [--help] COMMAND [ARGS]
 
 DESCRIPTION
 -----------
+'git' is both a program and a directory content tracker system.
+The program 'git' is just a wrapper to reach the core git programs
+(or a potty if you like, as it's not exactly porcelain but still
+brings your stuff to the plumbing).
 
-This is reference information for the core git commands.
+OPTIONS
+-------
+--version::
+       prints the git suite version that the 'git' program came from.
 
-Before reading this cover to cover, you may want to take a look
-at the link:tutorial.html[tutorial] document.
+--help::
+       prints the synopsis and a list of available commands.
+       If a git command is named this option will bring up the
+       man-page for that command.
 
-The Discussion section below contains much useful definition and
-clarification info - read that first.  And of the commands, I suggest
-reading link:git-update-cache.html[git-update-cache] and
-link:git-read-tree.html[git-read-tree] first - I wish I had!
+--exec-path::
+       path to wherever your core git programs are installed.
+       This can also be controlled by setting the GIT_EXEC_PATH
+       environment variable. If no path is given 'git' will print
+       the current setting and then exit.
 
-David Greaves <david@dgreaves.com>
-08/05/05
 
-Updated by Junio C Hamano <junkio@cox.net> on 2005-05-05 to
-reflect recent changes.
+NOT LEARNING CORE GIT COMMANDS
+------------------------------
+
+This manual is intended to give complete background information
+and internal workings of git, which may be too much for most
+people.  The <<Discussion>> section below contains much useful
+definition and clarification - read that first.
+
+If you are interested in using git to manage (version control)
+projects, use link:tutorial.html[The Tutorial] to get you started,
+and then link:everyday.html[Everyday GIT] as a guide to the
+minimum set of commands you need to know for day-to-day work.
+Most likely, that will get you started, and you can go a long
+way without knowing the low level details too much.
+
+The link:core-tutorial.html[Core tutorial] document covers how things
+internally work.
+
+If you are migrating from CVS, link:cvs-migration.html[cvs
+migration] document may be helpful after you finish the
+tutorial.
+
+After you get the general feel from the tutorial and this
+overview page, you may want to take a look at the
+link:howto-index.html[howto] documents.
+
+
+CORE GIT COMMANDS
+-----------------
+
+If you are writing your own Porcelain, you need to be familiar
+with most of the low level commands --- I suggest starting from
+gitlink:git-update-index[1] and gitlink:git-read-tree[1].
+
 
 Commands Overview
 -----------------
 The git commands can helpfully be split into those that manipulate
-the repository, the cache and the working fileset, those that
+the repository, the index and the files in the working tree, those that
 interrogate and compare them, and those that moves objects and
 references between repositories.
 
@@ -47,339 +86,416 @@ SCMs layered over git.
 
 Manipulation commands
 ~~~~~~~~~~~~~~~~~~~~~
-link:git-checkout-cache.html[git-checkout-cache]::
-       Copy files from the cache to the working directory
-
-link:git-commit-tree.html[git-commit-tree]::
-       Creates a new commit object
+gitlink:git-apply[1]::
+       Reads a "diff -up1" or git generated patch file and
+       applies it to the working tree.
 
-link:git-init-db.html[git-init-db]::
-       Creates an empty git object database
+gitlink:git-checkout-index[1]::
+       Copy files from the index to the working tree.
 
-link:git-merge-base.html[git-merge-base]::
-       Finds as good a common ancestor as possible for a merge
+gitlink:git-commit-tree[1]::
+       Creates a new commit object.
 
-link:git-mktag.html[git-mktag]::
-       Creates a tag object
+gitlink:git-hash-object[1]::
+       Computes the object ID from a file.
 
-link:git-read-tree.html[git-read-tree]::
-       Reads tree information into the directory cache
+gitlink:git-index-pack[1]::
+       Build pack idx file for an existing packed archive.
 
-link:git-update-cache.html[git-update-cache]::
-       Modifies the index or directory cache
+gitlink:git-init-db[1]::
+       Creates an empty git object database, or reinitialize an
+       existing one.
 
-link:git-hash-object.html[git-hash-object]::
-       Computes the object ID from a file.
+gitlink:git-merge-index[1]::
+       Runs a merge for files needing merging.
 
-link:git-write-tree.html[git-write-tree]::
-       Creates a tree from the current cache
+gitlink:git-mktag[1]::
+       Creates a tag object.
 
-link:git-pack-objects.html[git-pack-objects]::
+gitlink:git-pack-objects[1]::
        Creates a packed archive of objects.
 
-link:git-unpack-objects.html[git-unpack-objects]::
+gitlink:git-prune-packed[1]::
+       Remove extra objects that are already in pack files.
+
+gitlink:git-read-tree[1]::
+       Reads tree information into the index.
+
+gitlink:git-repo-config[1]::
+       Get and set options in .git/config.
+
+gitlink:git-unpack-objects[1]::
        Unpacks objects out of a packed archive.
 
-link:git-prune-packed.html[git-prune-packed]::
-       Remove extra objects that are already in pack files.
+gitlink:git-update-index[1]::
+       Registers files in the working tree to the index.
 
-link:git-apply.html[git-apply]::
-       Reads a "diff -up1" or git generated patch file and
-       applies it to the working tree.
+gitlink:git-write-tree[1]::
+       Creates a tree from the index.
 
 
 Interrogation commands
 ~~~~~~~~~~~~~~~~~~~~~~
-link:git-cat-file.html[git-cat-file]::
-       Provide content or type information for repository objects
 
-link:git-diff-cache.html[git-diff-cache]::
-       Compares content and mode of blobs between the cache and repository
+gitlink:git-cat-file[1]::
+       Provide content or type/size information for repository objects.
 
-link:git-diff-files.html[git-diff-files]::
-       Compares files in the working tree and the cache
+gitlink:git-describe[1]::
+       Show the most recent tag that is reachable from a commit.
 
-link:git-diff-tree.html[git-diff-tree]::
-       Compares the content and mode of blobs found via two tree objects
+gitlink:git-diff-index[1]::
+       Compares content and mode of blobs between the index and repository.
 
-link:git-diff-stages.html[git-diff-stages]::
-       Compares two "merge stages" in the index file.
+gitlink:git-diff-files[1]::
+       Compares files in the working tree and the index.
 
-link:git-export.html[git-export]::
-       Exports each commit and a diff against each of its parents
+gitlink:git-diff-stages[1]::
+       Compares two "merge stages" in the index.
 
-link:git-fsck-cache.html[git-fsck-cache]::
-       Verifies the connectivity and validity of the objects in the database
+gitlink:git-diff-tree[1]::
+       Compares the content and mode of blobs found via two tree objects.
 
-link:git-ls-files.html[git-ls-files]::
-       Information about files in the cache/working directory
+gitlink:git-fsck-objects[1]::
+       Verifies the connectivity and validity of the objects in the database.
 
-link:git-ls-tree.html[git-ls-tree]::
-       Displays a tree object in human readable form
+gitlink:git-ls-files[1]::
+       Information about files in the index and the working tree.
 
-link:git-merge-cache.html[git-merge-cache]::
-       Runs a merge for files needing merging
+gitlink:git-ls-tree[1]::
+       Displays a tree object in human readable form.
 
-link:git-rev-list.html[git-rev-list]::
-       Lists commit objects in reverse chronological order
+gitlink:git-merge-base[1]::
+       Finds as good common ancestors as possible for a merge.
 
-link:git-rev-tree.html[git-rev-tree]::
-       Provides the revision tree for one or more commits
+gitlink:git-name-rev[1]::
+       Find symbolic names for given revs.
 
-link:git-tar-tree.html[git-tar-tree]::
-       Creates a tar archive of the files in the named tree
+gitlink:git-pack-redundant[1]::
+       Find redundant pack files.
 
-link:git-unpack-file.html[git-unpack-file]::
-       Creates a temporary file with a blob's contents
+gitlink:git-rev-list[1]::
+       Lists commit objects in reverse chronological order.
 
-link:git-var.html[git-var]::
-       Displays a git logical variable
-
-link:git-show-index.html[git-show-index]::
+gitlink:git-show-index[1]::
        Displays contents of a pack idx file.
 
-link:git-verify-pack.html[git-verify-pack]::
-       Validates packed GIT archive files
+gitlink:git-tar-tree[1]::
+       Creates a tar archive of the files in the named tree object.
+
+gitlink:git-unpack-file[1]::
+       Creates a temporary file with a blob's contents.
+
+gitlink:git-var[1]::
+       Displays a git logical variable.
 
-The interrogate commands may create files - and you can force them to
-touch the working file set - but in general they don't
+gitlink:git-verify-pack[1]::
+       Validates packed git archive files.
+
+In general, the interrogate commands do not touch the files in
+the working tree.
 
 
 Synching repositories
 ~~~~~~~~~~~~~~~~~~~~~
 
-link:git-clone-script.html[git-clone-script]::
-       Clones a repository into the current repository (user interface)
-
-link:git-clone-pack.html[git-clone-pack]::
+gitlink:git-clone-pack[1]::
        Clones a repository into the current repository (engine
-       for ssh and local transport)
+       for ssh and local transport).
 
-link:git-http-pull.html[git-http-pull]::
-       Downloads a remote GIT repository via HTTP
+gitlink:git-fetch-pack[1]::
+       Updates from a remote repository (engine for ssh and
+       local transport).
 
-link:git-local-pull.html[git-local-pull]::
-       Duplicates another GIT repository on a local system
+gitlink:git-http-fetch[1]::
+       Downloads a remote git repository via HTTP by walking
+       commit chain.
 
-link:git-ssh-pull.html[git-ssh-pull]::
-       Pulls from a remote repository over ssh connection
+gitlink:git-local-fetch[1]::
+       Duplicates another git repository on a local system by
+       walking commit chain.
 
-link:git-send-pack.html[git-send-pack]::
-       Pushes to a remote repository, intelligently.
+gitlink:git-peek-remote[1]::
+       Lists references on a remote repository using
+       upload-pack protocol (engine for ssh and local
+       transport).
 
-link:git-receive-pack.html[git-receive-pack]::
+gitlink:git-receive-pack[1]::
        Invoked by 'git-send-pack' to receive what is pushed to it.
 
-link:git-clone-pack.html[git-clone-pack]::
-       Clones from a remote repository.
+gitlink:git-send-pack[1]::
+       Pushes to a remote repository, intelligently.
 
-link:git-fetch-pack.html[git-fetch-pack]::
-       Updates from a remote repository.
+gitlink:git-http-push[1]::
+       Push missing objects using HTTP/DAV.
 
-link:git-peek-remote.html[git-peek-remote]::
-       Lists references on a remote repository using upload-pack protocol.
+gitlink:git-shell[1]::
+       Restricted shell for GIT-only SSH access.
 
-link:git-upload-pack.html[git-upload-pack]::
-       Invoked by 'git-clone-pack' and 'git-fetch-pack' to push
-       what are asked for.
+gitlink:git-ssh-fetch[1]::
+       Pulls from a remote repository over ssh connection by
+       walking commit chain.
 
-link:git-update-server-info.html[git-update-server-info]::
+gitlink:git-ssh-upload[1]::
+       Helper "server-side" program used by git-ssh-fetch.
+
+gitlink:git-update-server-info[1]::
        Updates auxiliary information on a dumb server to help
        clients discover references and packs on it.
 
+gitlink:git-upload-pack[1]::
+       Invoked by 'git-clone-pack' and 'git-fetch-pack' to push
+       what are asked for.
+
 
 Porcelain-ish Commands
 ----------------------
-link:git-whatchanged.html[git-whatchanged]::
-       Shows commit logs and differences they introduce.
 
-link:git-log-script.html[git-log-script]::
-       Shows commit logs.
+gitlink:git-add[1]::
+       Add paths to the index.
 
-link:git-shortlog.html[git-shortlog]::
-       Summarizes 'git log' output.
+gitlink:git-am[1]::
+       Apply patches from a mailbox, but cooler.
 
-link:git-status-script.html[git-status-script]::
-       Shows the working tree status.
+gitlink:git-applymbox[1]::
+       Apply patches from a mailbox, original version by Linus.
+
+gitlink:git-bisect[1]::
+       Find the change that introduced a bug by binary search.
+
+gitlink:git-branch[1]::
+       Create and Show branches.
+
+gitlink:git-checkout[1]::
+       Checkout and switch to a branch.
+
+gitlink:git-cherry-pick[1]::
+       Cherry-pick the effect of an existing commit.
 
-link:git-fetch-script.html[git-fetch-script]::
+gitlink:git-clone[1]::
+       Clones a repository into a new directory.
+
+gitlink:git-commit[1]::
+       Record changes to the repository.
+
+gitlink:git-diff[1]::
+       Show changes between commits, commit and working tree, etc.
+
+gitlink:git-fetch[1]::
        Download from a remote repository via various protocols.
 
-link:git-pull-script.html[git-pull-script]::
+gitlink:git-format-patch[1]::
+       Prepare patches for e-mail submission.
+
+gitlink:git-grep[1]::
+       Print lines matching a pattern.
+
+gitlink:git-log[1]::
+       Shows commit logs.
+
+gitlink:git-ls-remote[1]::
+       Shows references in a remote or local repository.
+
+gitlink:git-merge[1]::
+       Grand unified merge driver.
+
+gitlink:git-mv[1]::
+       Move or rename a file, a directory, or a symlink.
+
+gitlink:git-pull[1]::
        Fetch from and merge with a remote repository.
 
-ulink:git-commit-script.html[git-commit-script]::
-       Record changes to the repository.
+gitlink:git-push[1]::
+       Update remote refs along with associated objects.
 
-link:git-show-branch.html[git-show-branch]::
-       Show branches and their commits.
+gitlink:git-rebase[1]::
+       Rebase local commits to the updated upstream head.
 
-link:git-repack-script.html[git-repack-script]::
+gitlink:git-repack[1]::
        Pack unpacked objects in a repository.
 
-link:git-rename-script.html[git-rename]::
-       Rename files and directories.
+gitlink:git-reset[1]::
+       Reset current HEAD to the specified state.
 
-link:git-ls-remote-script.html[git-ls-remote-script]::
-       Shows references in a remote or local repository.
+gitlink:git-resolve[1]::
+       Merge two commits.
 
+gitlink:git-revert[1]::
+       Revert an existing commit.
 
-Ancillary Commands
-------------------
-Manipulators:
+gitlink:git-shortlog[1]::
+       Summarizes 'git log' output.
 
-link:git-apply-patch-script.html[git-apply-patch-script]::
-       Sample script to apply the diffs from git-diff-*
+gitlink:git-show-branch[1]::
+       Show branches and their commits.
 
-link:git-convert-cache.html[git-convert-cache]::
-       Converts old-style GIT repository
+gitlink:git-status[1]::
+       Shows the working tree status.
 
-link:git-merge-one-file-script.html[git-merge-one-file-script]::
-       The standard helper program to use with "git-merge-cache"
+gitlink:git-verify-tag[1]::
+       Check the GPG signature of tag.
 
-link:git-prune-script.html[git-prune-script]::
-       Prunes all unreachable objects from the object database
+gitlink:git-whatchanged[1]::
+       Shows commit logs and differences they introduce.
 
-link:git-resolve-script.html[git-resolve-script]::
-       Script used to merge two trees
 
-link:git-tag-script.html[git-tag-script]::
-       An example script to create a tag object signed with GPG
+Ancillary Commands
+------------------
+Manipulators:
+
+gitlink:git-applypatch[1]::
+       Apply one patch extracted from an e-mail.
+
+gitlink:git-archimport[1]::
+       Import an arch repository into git.
+
+gitlink:git-convert-objects[1]::
+       Converts old-style git repository.
 
-link:git-cvsimport-script.html[git-cvsimport-script]::
+gitlink:git-cvsimport[1]::
        Salvage your data out of another SCM people love to hate.
 
+gitlink:git-cvsexportcommit[1]::
+       Export a single commit to a CVS checkout.
 
-Interrogators:
+gitlink:git-lost-found[1]::
+       Recover lost refs that luckily have not yet been pruned.
 
-link:git-diff-helper.html[git-diff-helper]::
-       Generates patch format output for git-diff-*
+gitlink:git-merge-one-file[1]::
+       The standard helper program to use with `git-merge-index`.
 
-link:git-ssh-push.html[git-ssh-push]::
-       Helper "server-side" program used by git-ssh-pull
+gitlink:git-prune[1]::
+       Prunes all unreachable objects from the object database.
 
-link:git-send-email-script.html[git-send-email]::
-       Send patch e-mails out of "format-patch --mbox" output.
+gitlink:git-relink[1]::
+       Hardlink common objects in local repositories.
 
+gitlink:git-svnimport[1]::
+       Import a SVN repository into git.
 
-Commands not yet documented
----------------------------
+gitlink:git-sh-setup[1]::
+       Common git shell script setup code.
 
-link:git-applymbox.html[git-applymbox]::
-       git-applymbox.
+gitlink:git-symbolic-ref[1]::
+       Read and modify symbolic refs.
 
-link:git-applypatch.html[git-applypatch]::
-       git-applypatch.
+gitlink:git-tag[1]::
+       An example script to create a tag object signed with GPG.
 
-link:git-mailinfo.html[git-mailinfo]::
-       git-mailinfo.
+gitlink:git-update-ref[1]::
+       Update the object name stored in a ref safely.
 
-link:git-mailsplit.html[git-mailsplit]::
-       git-mailsplit.
 
-link:git-add-script.html[git-add-script]::
-       git-add-script.
+Interrogators:
 
-link:git-bisect-script.html[git-bisect-script]::
-       git-bisect-script.
+gitlink:git-check-ref-format[1]::
+       Make sure ref name is well formed.
 
-link:git-branch-script.html[git-branch-script]::
-       git-branch-script.
+gitlink:git-cherry[1]::
+       Find commits not merged upstream.
 
-link:git-build-rev-cache.html[git-build-rev-cache]::
-       git-build-rev-cache.
+gitlink:git-count-objects[1]::
+       Count unpacked number of objects and their disk consumption.
 
-link:git-checkout-script.html[git-checkout-script]::
-       git-checkout-script.
+gitlink:git-daemon[1]::
+       A really simple server for git repositories.
 
-link:git-cherry.html[git-cherry]::
-       git-cherry.
+gitlink:git-get-tar-commit-id[1]::
+       Extract commit ID from an archive created using git-tar-tree.
 
-link:git-clone-dumb-http.html[git-clone-dumb-http]::
-       git-clone-dumb-http.
+gitlink:git-mailinfo[1]::
+       Extracts patch and authorship information from a single
+       e-mail message, optionally transliterating the commit
+       message into utf-8.
 
-link:git-count-objects-script.html[git-count-objects-script]::
-       git-count-objects-script.
+gitlink:git-mailsplit[1]::
+       A stupid program to split UNIX mbox format mailbox into
+       individual pieces of e-mail.
 
-link:git-daemon.html[git-daemon]::
-       git-daemon.
+gitlink:git-patch-id[1]::
+       Compute unique ID for a patch.
 
-link:git-diff-script.html[git-diff-script]::
-       git-diff-script.
+gitlink:git-parse-remote[1]::
+       Routines to help parsing `$GIT_DIR/remotes/` files.
 
-link:git-format-patch-script.html[git-format-patch-script]::
-       git-format-patch-script.
+gitlink:git-request-pull[1]::
+       git-request-pull.
 
-link:git-get-tar-commit-id.html[git-get-tar-commit-id]::
-       git-get-tar-commit-id.
+gitlink:git-rev-parse[1]::
+       Pick out and massage parameters.
 
-link:git-patch-id.html[git-patch-id]::
-       git-patch-id.
+gitlink:git-send-email[1]::
+       Send patch e-mails out of "format-patch --mbox" output.
 
-link:git-push-script.html[git-push-script]::
-       git-push-script.
+gitlink:git-symbolic-ref[1]::
+       Read and modify symbolic refs.
 
-link:git-rebase-script.html[git-rebase-script]::
-       git-rebase-script.
+gitlink:git-stripspace[1]::
+       Filter out empty lines.
 
-link:git-relink-script.html[git-relink-script]::
-       git-relink-script.
 
-link:git-request-pull-script.html[git-request-pull-script]::
-       git-request-pull-script.
+Commands not yet documented
+---------------------------
 
-link:git-reset-script.html[git-reset-script]::
-       git-reset-script.
+gitlink:gitk[1]::
+       The gitk repository browser.
 
-link:git-rev-parse.html[git-rev-parse]::
-       git-rev-parse.
 
-link:git-revert-script.html[git-revert-script]::
-       git-revert-script.
+Configuration Mechanism
+-----------------------
 
-link:git-sh-setup-script.html[git-sh-setup-script]::
-       git-sh-setup-script.
+Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
+is used to hold per-repository configuration options.  It is a
+simple text file modelled after `.ini` format familiar to some
+people.  Here is an example:
 
-link:git-show-rev-cache.html[git-show-rev-cache]::
-       git-show-rev-cache.
+------------
+#
+# A '#' or ';' character indicates a comment.
+#
 
-link:git-stripspace.html[git-stripspace]::
-       git-stripspace.
+; core variables
+[core]
+       ; Don't trust file modes
+       filemode = false
 
-link:git-verify-tag-script.html[git-verify-tag-script]::
-       git-verify-tag-script.
+; user identity
+[user]
+       name = "Junio C Hamano"
+       email = "junkio@twinsun.com"
 
-link:gitk.html[gitk]::
-       gitk.
+------------
+
+Various commands read from the configuration file and adjust
+their operation accordingly.
 
 
 Identifier Terminology
 ----------------------
 <object>::
-       Indicates the sha1 identifier for any type of object
+       Indicates the object name for any type of object.
 
 <blob>::
-       Indicates a blob object sha1 identifier
+       Indicates a blob object name.
 
 <tree>::
-       Indicates a tree object sha1 identifier
+       Indicates a tree object name.
 
 <commit>::
-       Indicates a commit object sha1 identifier
+       Indicates a commit object name.
 
 <tree-ish>::
-       Indicates a tree, commit or tag object sha1 identifier.  A
+       Indicates a tree, commit or tag object name.  A
        command that takes a <tree-ish> argument ultimately wants to
        operate on a <tree> object but automatically dereferences
        <commit> and <tag> objects that point at a <tree>.
 
 <type>::
        Indicates that an object type is required.
-       Currently one of: blob/tree/commit/tag
+       Currently one of: `blob`, `tree`, `commit`, or `tag`.
 
 <file>::
-       Indicates a filename - always relative to the root of
-       the tree structure GIT_INDEX_FILE describes.
+       Indicates a filename - almost always relative to the
+       root of the tree structure `GIT_INDEX_FILE` describes.
 
 Symbolic Identifiers
 --------------------
@@ -387,38 +503,30 @@ Any git command accepting any <object> can also use the following
 symbolic notation:
 
 HEAD::
-       indicates the head of the repository (ie the contents of
-       `$GIT_DIR/HEAD`)
+       indicates the head of the current branch (i.e. the
+       contents of `$GIT_DIR/HEAD`).
+
 <tag>::
-       a valid tag 'name'+
-       (ie the contents of `$GIT_DIR/refs/tags/<tag>`)
+       a valid tag 'name'
+       (i.e. the contents of `$GIT_DIR/refs/tags/<tag>`).
+
 <head>::
-       a valid head 'name'+
-       (ie the contents of `$GIT_DIR/refs/heads/<head>`)
+       a valid head 'name'
+       (i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
+
 <snap>::
-       a valid snapshot 'name'+
-       (ie the contents of `$GIT_DIR/refs/snap/<snap>`)
+       a valid snapshot 'name'
+       (i.e. the contents of `$GIT_DIR/refs/snap/<snap>`).
 
 
 File/Directory Structure
 ------------------------
-The git-core manipulates the following areas in the directory:
-
- .git/        The base (overridden with $GIT_DIR)
-   objects/    The object base (overridden with $GIT_OBJECT_DIRECTORY)
-     ??/       'First 2 chars of object' directories.
-     pack/     Packed archives.
 
-   refs/       Directories containing symbolic names for objects
-              (each file contains the hex SHA1 + newline)
-     heads/    Commits which are heads of various sorts
-     tags/     Tags, by the tag name (or some local renaming of it)
-     */        Any other subdirectory of refs/ can be used to store
-              files similar to what are under refs/heads/.
-   HEAD        Symlink to refs/heads/<current-branch-name>
+Please see link:repository-layout.html[repository layout] document.
 
 Higher level SCMs may provide and manage additional information in the
-GIT_DIR.
+`$GIT_DIR`.
+
 
 Terminology
 -----------
@@ -433,12 +541,12 @@ The git Repository
 ~~~~~~~~~~~~~~~~~~
 These environment variables apply to 'all' core git commands. Nb: it
 is worth noting that they may be used/overridden by SCMS sitting above
-git so take care if using Cogito etc
+git so take care if using Cogito etc.
 
 'GIT_INDEX_FILE'::
        This environment allows the specification of an alternate
-       cache/index file. If not specified, the default of
-       `$GIT_DIR/index` is used.
+       index file. If not specified, the default of `$GIT_DIR/index`
+       is used.
 
 'GIT_OBJECT_DIRECTORY'::
        If the object storage directory is specified via this
@@ -454,9 +562,9 @@ git so take care if using Cogito etc
        written to these directories.
 
 'GIT_DIR'::
-       If the 'GIT_DIR' environment variable is set then it specifies
-       a path to use instead of `./.git` for the base of the
-       repository.
+       If the 'GIT_DIR' environment variable is set then it
+       specifies a path to use instead of the default `.git`
+       for the base of the repository.
 
 git Commits
 ~~~~~~~~~~~
@@ -465,30 +573,35 @@ git Commits
 'GIT_AUTHOR_DATE'::
 'GIT_COMMITTER_NAME'::
 'GIT_COMMITTER_EMAIL'::
-       see link:git-commit-tree.html[git-commit-tree]
+       see gitlink:git-commit-tree[1]
 
 git Diffs
 ~~~~~~~~~
 'GIT_DIFF_OPTS'::
 'GIT_EXTERNAL_DIFF'::
        see the "generating patches" section in :
-       link:git-diff-cache.html[git-diff-cache];
-       link:git-diff-files.html[git-diff-files];
-       link:git-diff-tree.html[git-diff-tree]
+       gitlink:git-diff-index[1];
+       gitlink:git-diff-files[1];
+       gitlink:git-diff-tree[1]
 
-Discussion
-----------
-include::../README[]
+Discussion[[Discussion]]
+------------------------
+include::README[]
 
-Author
-------
-Written by Linus Torvalds <torvalds@osdl.org> and the git-list <git@vger.kernel.org>.
+Authors
+-------
+* git's founding father is Linus Torvalds <torvalds@osdl.org>.
+* The current git nurse is Junio C Hamano <junkio@cox.net>.
+* The git potty was written by Andres Ericsson <ae@op5.se>.
+* General upbringing is handled by the git-list <git@vger.kernel.org>.
 
 Documentation
 --------------
-Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
+The documentation for git suite was started by David Greaves
+<david@dgreaves.com>, and later enhanced greatly by the
+contributors on the git-list <git@vger.kernel.org>.
 
 GIT
 ---
-Part of the link:git.html[git] suite
+Part of the gitlink:git[7] suite