git(7)
======
-May 2005
NAME
----
This is reference information for the core git commands.
-The Discussion section below contains much useful definition and
+Before reading this cover to cover, you may want to take a look
+at the link:tutorial.html[tutorial] document.
+
+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!
+reading gitlink:git-update-index[1] and
+gitlink:git-read-tree[1] first - I wish I had!
+
+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.
+
David Greaves <david@dgreaves.com>
08/05/05
interrogate and compare them, and those that moves objects and
references between repositories.
-There are also some ancilliary programs that can be viewed as useful
+In addition, git itself comes with a spartan set of porcelain
+commands. They are usable but are not meant to compete with real
+Porcelains.
+
+There are also some ancillary programs that can be viewed as useful
aids for using the core commands but which are unlikely to be used by
SCMs layered over git.
Manipulation commands
~~~~~~~~~~~~~~~~~~~~~
-link:git-checkout-cache.html[git-checkout-cache]::
+gitlink:git-apply[1]::
+ Reads a "diff -up1" or git generated patch file and
+ applies it to the working tree.
+
+gitlink:git-checkout-index[1]::
Copy files from the cache to the working directory
+ Previously this command was known as git-checkout-cache.
-link:git-commit-tree.html[git-commit-tree]::
+gitlink:git-commit-tree[1]::
Creates a new commit object
-link:git-init-db.html[git-init-db]::
+gitlink:git-hash-object[1]::
+ Computes the object ID from a file.
+
+gitlink:git-index-pack.html[1]::
+ Build pack index file for an existing packed archive.
+
+gitlink:git-init-db[1]::
Creates an empty git object database
-link:git-merge-base.html[git-merge-base]::
- Finds as good a common ancestor as possible for a merge
+gitlink:git-merge-index[1]::
+ Runs a merge for files needing merging
+ Previously this command was known as git-merge-cache.
-link:git-mktag.html[git-mktag]::
+gitlink:git-mktag[1]::
Creates a tag object
-link:git-read-tree.html[git-read-tree]::
+gitlink:git-pack-objects[1]::
+ Creates a packed archive of 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 directory cache
-link:git-update-cache.html[git-update-cache]::
- Modifies the index or directory cache
+gitlink:git-unpack-objects[1]::
+ Unpacks objects out of a packed archive.
-link:git-hash-object.html[git-hash-object]::
- Computes the object ID from a file.
+gitlink:git-update-index[1]::
+ Modifies the index or directory cache
+ Previously this command was known as git-update-cache.
-link:git-write-tree.html[git-write-tree]::
+gitlink:git-write-tree[1]::
Creates a tree from the current cache
+
Interrogation commands
~~~~~~~~~~~~~~~~~~~~~~
-link:git-cat-file.html[git-cat-file]::
+
+gitlink:git-cat-file[1]::
Provide content or type information for repository objects
-link:git-diff-cache.html[git-diff-cache]::
+gitlink:git-diff-index[1]::
Compares content and mode of blobs between the cache and repository
+ Previously this command was known as git-diff-cache.
-link:git-diff-files.html[git-diff-files]::
+gitlink:git-diff-files[1]::
Compares files in the working tree and the cache
-link:git-diff-tree.html[git-diff-tree]::
- Compares the content and mode of blobs found via two tree objects
+gitlink:git-diff-stages[1]::
+ Compares two "merge stages" in the index file.
-link:git-export.html[git-export]::
- Exports each commit and a diff against each of its parents
+gitlink:git-diff-tree[1]::
+ Compares the content and mode of blobs found via two tree objects
-link:git-fsck-cache.html[git-fsck-cache]::
+gitlink:git-fsck-objects[1]::
Verifies the connectivity and validity of the objects in the database
+ Previously this command was known as git-fsck-cache.
-link:git-ls-files.html[git-ls-files]::
+gitlink:git-ls-files[1]::
Information about files in the cache/working directory
-link:git-ls-tree.html[git-ls-tree]::
+gitlink:git-ls-tree[1]::
Displays a tree object in human readable form
-link:git-merge-cache.html[git-merge-cache]::
- Runs a merge for files needing merging
+gitlink:git-merge-base[1]::
+ Finds as good a common ancestor as possible for a merge
-link:git-rev-list.html[git-rev-list]::
+gitlink:git-rev-list[1]::
Lists commit objects in reverse chronological order
-link:git-rev-tree.html[git-rev-tree]::
- Provides the revision tree for one or more commits
+gitlink:git-show-index[1]::
+ Displays contents of a pack idx file.
-link:git-tar-tree.html[git-tar-tree]::
+gitlink:git-tar-tree[1]::
Creates a tar archive of the files in the named tree
-link:git-unpack-file.html[git-unpack-file]::
+gitlink:git-unpack-file[1]::
Creates a temporary file with a blob's contents
-link:git-var.html[git-var]::
+gitlink:git-var[1]::
Displays a git logical variable
-link:git-verify-pack.html[git-verify-pack]::
- Validates packed GIT archive files
+gitlink:git-verify-pack[1]::
+ Validates packed git archive files
The interrogate commands may create files - and you can force them to
touch the working file set - but in general they don't
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)
-link:git-fetch-script.html[git-fetch-script]::
- Download from a remote repository via various protocols
- (user interface).
+gitlink:git-fetch-pack[1]::
+ Updates from a remote repository.
-link:git-pull-script.html[git-pull-script]::
- Fetch from and merge with a remote repository via
- various protocols (user interface).
+gitlink:git-http-fetch[1]::
+ Downloads a remote git repository via HTTP
+ Previously this command was known as git-http-pull.
-link:git-http-pull.html[git-http-pull]::
- Downloads a remote GIT repository via HTTP
+gitlink:git-local-fetch[1]::
+ Duplicates another git repository on a local system
+ Previously this command was known as git-local-pull.
-link:git-local-pull.html[git-local-pull]::
- Duplicates another GIT repository on a local system
+gitlink:git-peek-remote[1]::
+ Lists references on a remote repository using upload-pack protocol.
-link:git-ssh-pull.html[git-ssh-pull]::
- Pulls from a remote repository over ssh connection
+gitlink:git-receive-pack[1]::
+ Invoked by 'git-send-pack' to receive what is pushed to it.
-link:git-send-pack.html[git-send-pack]::
+gitlink:git-send-pack[1]::
Pushes to a remote repository, intelligently.
-link:git-receive-pack.html[git-receive-pack]::
- 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-ssh-fetch[1]::
+ Pulls from a remote repository over ssh connection
+ Previously this command was known as git-ssh-pull.
-link:git-fetch-pack.html[git-fetch-pack]::
- Updates from a remote repository.
+gitlink:git-ssh-upload[1]::
+ Helper "server-side" program used by git-ssh-fetch
+ Previously this command was known as git-ssh-push.
-link:git-peek-remote.html[git-peek-remote]::
- Lists references on a remote repository using upload-pack protocol.
+gitlink:git-update-server-info[1]::
+ Updates auxiliary information on a dumb server to help
+ clients discover references and packs on it.
-link:git-upload-pack.html[git-upload-pack]::
+gitlink:git-upload-pack[1]::
Invoked by 'git-clone-pack' and 'git-fetch-pack' to push
what are asked for.
-link:git-update-server-info.html[git-update-server-info]::
- Updates auxiliary information on a dumb server to help
- clients discover references and packs on it.
+Porcelain-ish Commands
+----------------------
+
+gitlink:git-add[1]::
+ Add paths to the index file.
+ Previously this command was known as git-add-script.
+
+gitlink:git-applymbox[1]::
+ Apply patches from a mailbox.
+
+gitlink:git-bisect[1]::
+ Find the change that introduced a bug.
+ Previously this command was known as git-bisect-script.
+
+gitlink:git-branch[1]::
+ Create and Show branches.
+ Previously this command was known as git-branch-script.
+
+gitlink:git-checkout[1]::
+ Checkout and switch to a branch.
+ Previously this command was known as git-checkout-script.
+
+gitlink:git-cherry-pick[1]::
+ Cherry-pick the effect of an existing commit.
+ Previously this command was known as git-cherry-pick-script.
-Ancilliary Commands
--------------------
+gitlink:git-clone[1]::
+ Clones a repository into a new directory.
+ Previously this command was known as git-clone-script.
+
+gitlink:git-commit[1]::
+ Record changes to the repository.
+ Previously this command was known as git-commit-script.
+
+gitlink:git-diff[1]::
+ Show changes between commits, commit and working tree, etc.
+ Previously this command was known as git-diff-script.
+
+gitlink:git-fetch[1]::
+ Download from a remote repository via various protocols.
+ Previously this command was known as git-fetch-script.
+
+gitlink:git-format-patch[1]::
+ Prepare patches for e-mail submission.
+ Previously this command was known as git-format-patch-script.
+
+gitlink:git-grep[1]::
+ Print lines matching a pattern
+
+gitlink:git-log[1]::
+ Shows commit logs.
+ Previously this command was known as git-log-script.
+
+gitlink:git-ls-remote[1]::
+ Shows references in a remote or local repository.
+ Previously this command was known as git-ls-remote-script.
+
+gitlink:git-merge[1]::
+ Grand unified merge driver.
+
+gitlink:git-octopus[1]::
+ Merge more than two commits.
+ Previously this command was known as git-octopus-script.
+
+gitlink:git-pull[1]::
+ Fetch from and merge with a remote repository.
+ Previously this command was known as git-pull-script.
+
+gitlink:git-push[1]::
+ Update remote refs along with associated objects.
+ Previously this command was known as git-push-script.
+
+gitlink:git-rebase[1]::
+ Rebase local commits to new upstream head.
+ Previously this command was known as git-rebase-script.
+
+gitlink:git-rename[1]::
+ Rename files and directories.
+ Previously this command was known as git-rename-script.
+
+gitlink:git-repack[1]::
+ Pack unpacked objects in a repository.
+ Previously this command was known as git-repack-script.
+
+gitlink:git-reset[1]::
+ Reset current HEAD to the specified state.
+ Previously this command was known as git-reset-script.
+
+gitlink:git-resolve[1]::
+ Merge two commits.
+ Previously this command was known as git-resolve-script.
+
+gitlink:git-revert[1]::
+ Revert an existing commit.
+ Previously this command was known as git-revert-script.
+
+gitlink:git-shortlog[1]::
+ Summarizes 'git log' output.
+
+gitlink:git-show-branch[1]::
+ Show branches and their commits.
+
+gitlink:git-status[1]::
+ Shows the working tree status.
+ Previously this command was known as git-status-script.
+
+gitlink:git-verify-tag[1]::
+ Check the GPG signature of tag.
+ Previously this command was known as git-verify-tag-script.
+
+gitlink:git-whatchanged[1]::
+ Shows commit logs and differences they introduce.
+
+
+Ancillary Commands
+------------------
Manipulators:
-link:git-apply-patch-script.html[git-apply-patch-script]::
- Sample script to apply the diffs from git-diff-*
+gitlink:git-applypatch[1]::
+ Apply one patch extracted from an e-mail.
+
+gitlink:git-archimport[1]::
+ Import an arch repository into git.
+ Previously this command was known as git-archimport-script.
-link:git-convert-cache.html[git-convert-cache]::
- Converts old-style GIT repository
+gitlink:git-convert-objects[1]::
+ Converts old-style git repository
+ Previously this command was known as git-convert-cache.
-link:git-merge-one-file-script.html[git-merge-one-file-script]::
- The standard helper program to use with "git-merge-cache"
+gitlink:git-cvsimport[1]::
+ Salvage your data out of another SCM people love to hate.
+ Previously this command was known as git-cvsimport-script.
-link:git-prune-script.html[git-prune-script]::
+gitlink:git-merge-one-file[1]::
+ The standard helper program to use with "git-merge-index"
+ Previously this command was known as git-merge-one-file-script.
+
+gitlink:git-prune[1]::
Prunes all unreachable objects from the object database
+ Previously this command was known as git-prune-script.
+
+gitlink:git-relink[1]::
+ Hardlink common objects in local repositories.
+ Previously this command was known as git-relink-script.
-link:git-resolve-script.html[git-resolve-script]::
- Script used to merge two trees
+gitlink:git-sh-setup[1]::
+ Common git shell script setup code.
+ Previously this command was known as git-sh-setup-script.
-link:git-tag-script.html[git-tag-script]::
+gitlink:git-tag[1]::
An example script to create a tag object signed with GPG
+ Previously this command was known as git-tag-script.
+
+
+Interrogators:
+
+gitlink:git-cherry[1]::
+ Find commits not merged upstream.
+
+gitlink:git-count-objects[1]::
+ Count unpacked number of objects and their disk consumption.
+ Previously this command was known as git-count-objects-script.
+
+gitlink:git-daemon[1]::
+ A really simple server for git repositories.
+
+gitlink:git-get-tar-commit-id[1]::
+ Extract commit ID from an archive created using git-tar-tree.
+gitlink:git-mailinfo[1]::
+ Extracts patch from a single e-mail message.
-Interogators:
+gitlink:git-mailsplit[1]::
+ git-mailsplit.
-link:git-diff-helper.html[git-diff-helper]::
- Generates patch format output for git-diff-*
+gitlink:git-patch-id[1]::
+ Compute unique ID for a patch.
-link:git-ssh-push.html[git-ssh-push]::
- Helper "server-side" program used by git-ssh-pull
+gitlink:git-parse-remote[1]::
+ Routines to help parsing $GIT_DIR/remotes/
+ Previously this command was known as git-parse-remote-script.
+gitlink:git-request-pull[1]::
+ git-request-pull.
+ Previously this command was known as git-request-pull-script.
+
+gitlink:git-rev-parse[1]::
+ Pick out and massage parameters.
+
+gitlink:git-send-email[1]::
+ Send patch e-mails out of "format-patch --mbox" output.
+ Previously this command was known as git-send-email-script.
+
+gitlink:git-stripspace[1]::
+ Filter out empty lines.
+
+
+Commands not yet documented
+---------------------------
+
+gitlink:gitk[1]::
+ gitk.
Identifier Terminology
Symbolic Identifiers
--------------------
-Any git comand accepting any <object> can also use the following
+Any git command accepting any <object> can also use the following
symbolic notation:
HEAD::
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.
+
Terminology
-----------
-Each line contains terms which you may see used interchangeably
-
- object database, .git directory
- directory cache, index
- id, sha1, sha1-id, sha1 hash
- type, tag
+Please see link:glossary.html[glossary] document.
Environment Variables
'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
Due to the immutable nature of git objects, old objects can be
archived into shared, read-only directories. This variable
- specifies a ":" seperated list of git object directories which
+ specifies a ":" separated list of git object directories which
can be used to search for git objects. New objects will not be
written to these directories.
'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
-----------
+Discussion[[Discussion]]
+------------------------
include::../README[]
Author
GIT
---
-Part of the link:git.html[git] suite
+Part of the gitlink:git[7] suite