git(7)
======
-v0.99.4, Aug 2005
+v0.99.5, Aug 2005
NAME
----
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
+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
+reading link:git-update-index.html[git-update-index] and
link:git-read-tree.html[git-read-tree] 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.
Manipulation commands
~~~~~~~~~~~~~~~~~~~~~
-link:git-checkout-cache.html[git-checkout-cache]::
+link:git-apply.html[git-apply]::
+ Reads a "diff -up1" or git generated patch file and
+ applies it to the working tree.
+
+link:git-checkout-index.html[git-checkout-index]::
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]::
Creates a new commit object
+link:git-hash-object.html[git-hash-object]::
+ Computes the object ID from a file.
+
link:git-init-db.html[git-init-db]::
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
+link:git-merge-index.html[git-merge-index]::
+ Runs a merge for files needing merging
+ Previously this command was known as git-merge-cache.
link:git-mktag.html[git-mktag]::
Creates a tag object
-link:git-read-tree.html[git-read-tree]::
- Reads tree information into the directory cache
-
-link:git-update-cache.html[git-update-cache]::
- Modifies the index or directory cache
-
-link:git-hash-object.html[git-hash-object]::
- Computes the object ID from a file.
-
-link:git-write-tree.html[git-write-tree]::
- Creates a tree from the current cache
-
link:git-pack-objects.html[git-pack-objects]::
Creates a packed archive of objects.
+link:git-prune-packed.html[git-prune-packed]::
+ Remove extra objects that are already in pack files.
+
+link:git-read-tree.html[git-read-tree]::
+ Reads tree information into the directory cache
+
link:git-unpack-objects.html[git-unpack-objects]::
Unpacks objects out of a packed archive.
-link:git-prune-packed.html[git-prune-packed]::
- Remove extra objects that are already in pack files.
+link:git-update-index.html[git-update-index]::
+ Modifies the index or directory cache
+ Previously this command was known as git-update-cache.
-link:git-apply.html[git-apply]::
- Reads a "diff -up1" or git generated patch file and
- applies it to the working tree.
+link:git-write-tree.html[git-write-tree]::
+ Creates a tree from the current cache
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]::
+link:git-diff-index.html[git-diff-index]::
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]::
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
-
link:git-diff-stages.html[git-diff-stages]::
Compares two "merge stages" in the index file.
+link:git-diff-tree.html[git-diff-tree]::
+ Compares the content and mode of blobs found via two tree objects
+
link:git-export.html[git-export]::
Exports each commit and a diff against each of its parents
-link:git-fsck-cache.html[git-fsck-cache]::
+link:git-fsck-objects.html[git-fsck-objects]::
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]::
Information about files in the cache/working directory
link:git-ls-tree.html[git-ls-tree]::
Displays a tree object in human readable form
-link:git-merge-cache.html[git-merge-cache]::
- Runs a merge for files needing merging
+link:git-merge-base.html[git-merge-base]::
+ Finds as good a common ancestor as possible for a merge
link:git-rev-list.html[git-rev-list]::
Lists commit objects in reverse chronological order
link:git-rev-tree.html[git-rev-tree]::
Provides the revision tree for one or more commits
+link:git-show-index.html[git-show-index]::
+ Displays contents of a pack idx file.
+
link:git-tar-tree.html[git-tar-tree]::
Creates a tar archive of the files in the named tree
link:git-var.html[git-var]::
Displays a git logical variable
-link:git-show-index.html[git-show-index]::
- Displays contents of a pack idx file.
-
link:git-verify-pack.html[git-verify-pack]::
Validates packed GIT archive files
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]::
Clones a repository into the current repository (engine
for ssh and local transport)
-link:git-http-pull.html[git-http-pull]::
+link:git-fetch-pack.html[git-fetch-pack]::
+ Updates from a remote repository.
+
+link:git-http-fetch.html[git-http-fetch]::
Downloads a remote GIT repository via HTTP
+ Previously this command was known as git-http-pull.
-link:git-local-pull.html[git-local-pull]::
+link:git-local-fetch.html[git-local-fetch]::
Duplicates another GIT repository on a local system
+ Previously this command was known as git-local-pull.
-link:git-ssh-pull.html[git-ssh-pull]::
- Pulls from a remote repository over ssh connection
-
-link:git-send-pack.html[git-send-pack]::
- Pushes to a remote repository, intelligently.
+link:git-peek-remote.html[git-peek-remote]::
+ Lists references on a remote repository using upload-pack protocol.
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.
-
-link:git-fetch-pack.html[git-fetch-pack]::
- Updates from a remote repository.
+link:git-send-pack.html[git-send-pack]::
+ Pushes to a remote repository, intelligently.
-link:git-peek-remote.html[git-peek-remote]::
- Lists references on a remote repository using upload-pack protocol.
+link:git-ssh-fetch.html[git-ssh-fetch]::
+ Pulls from a remote repository over ssh connection
+ Previously this command was known as git-ssh-pull.
-link:git-upload-pack.html[git-upload-pack]::
- Invoked by 'git-clone-pack' and 'git-fetch-pack' to push
- what are asked for.
+link:git-ssh-upload.html[git-ssh-upload]::
+ Helper "server-side" program used by git-ssh-fetch
+ Previously this command was known as git-ssh-push.
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.
+link:git-upload-pack.html[git-upload-pack]::
+ 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.
-link:git-shortlog.html[git-shortlog]::
- Summarizes 'git log' output.
+link:git-add.html[git-add]::
+ Add paths to the index file.
+ Previously this command was known as git-add-script.
-link:git-status-script.html[git-status-script]::
- Shows the working tree status.
+link:git-applymbox.html[git-applymbox]::
+ Apply patches from a mailbox.
-link:git-fetch-script.html[git-fetch-script]::
- Download from a remote repository via various protocols.
+link:git-bisect.html[git-bisect]::
+ Find the change that introduced a bug.
+ Previously this command was known as git-bisect-script.
-link:git-pull-script.html[git-pull-script]::
- Fetch from and merge with a remote repository.
+link:git-branch.html[git-branch]::
+ Create and Show branches.
+ Previously this command was known as git-branch-script.
-link:git-resolve-script.html[git-resolve-script]::
- Merge two commits.
+link:git-checkout.html[git-checkout]::
+ Checkout and switch to a branch.
+ Previously this command was known as git-checkout-script.
-link:git-octopus-script.html[git-octopus-script]::
- Merge more than two commits.
+link:git-cherry-pick.html[git-cherry-pick]::
+ Cherry-pick the effect of an existing commit.
+ Previously this command was known as git-cherry-pick-script.
-link:git-push-script.html[git-push-script]::
- Update remote refs along with associated objects.
+link:git-clone.html[git-clone]::
+ Clones a repository into a new directory.
+ Previously this command was known as git-clone-script.
-link:git-commit-script.html[git-commit-script]::
+link:git-commit.html[git-commit]::
Record changes to the repository.
+ Previously this command was known as git-commit-script.
-link:git-show-branch.html[git-show-branch]::
- Show branches and their commits.
-
-link:git-repack-script.html[git-repack-script]::
- Pack unpacked objects in a repository.
+link:git-fetch.html[git-fetch]::
+ Download from a remote repository via various protocols.
+ Previously this command was known as git-fetch-script.
-link:git-rename-script.html[git-rename]::
- Rename files and directories.
+link:git-log.html[git-log]::
+ Shows commit logs.
+ Previously this command was known as git-log-script.
-link:git-ls-remote-script.html[git-ls-remote-script]::
+link:git-ls-remote.html[git-ls-remote]::
Shows references in a remote or local repository.
+ Previously this command was known as git-ls-remote-script.
+link:git-octopus.html[git-octopus]::
+ Merge more than two commits.
+ Previously this command was known as git-octopus-script.
-Ancillary Commands
-------------------
-Manipulators:
+link:git-pull.html[git-pull]::
+ Fetch from and merge with a remote repository.
+ Previously this command was known as git-pull-script.
-link:git-apply-patch-script.html[git-apply-patch-script]::
- Sample script to apply the diffs from git-diff-*
+link:git-push.html[git-push]::
+ Update remote refs along with associated objects.
+ Previously this command was known as git-push-script.
-link:git-convert-cache.html[git-convert-cache]::
- Converts old-style GIT repository
+link:git-rebase.html[git-rebase]::
+ Rebase local commits to new upstream head.
+ Previously this command was known as git-rebase-script.
-link:git-merge-one-file-script.html[git-merge-one-file-script]::
- The standard helper program to use with "git-merge-cache"
+link:git-rename.html[git-rename]::
+ Rename files and directories.
+ Previously this command was known as git-rename-script.
-link:git-prune-script.html[git-prune-script]::
- Prunes all unreachable objects from the object database
+link:git-repack.html[git-repack]::
+ Pack unpacked objects in a repository.
+ Previously this command was known as git-repack-script.
-link:git-tag-script.html[git-tag-script]::
- An example script to create a tag object signed with GPG
+link:git-reset.html[git-reset]::
+ Reset current HEAD to the specified state.
+ Previously this command was known as git-reset-script.
-link:git-cvsimport-script.html[git-cvsimport-script]::
- Salvage your data out of another SCM people love to hate.
+link:git-resolve.html[git-resolve]::
+ Merge two commits.
+ Previously this command was known as git-resolve-script.
+link:git-revert.html[git-revert]::
+ Revert an existing commit.
+ Previously this command was known as git-revert-script.
-Interrogators:
+link:git-shortlog.html[git-shortlog]::
+ Summarizes 'git log' output.
-link:git-diff-helper.html[git-diff-helper]::
- Generates patch format output for git-diff-*
+link:git-show-branch.html[git-show-branch]::
+ Show branches and their commits.
-link:git-ssh-push.html[git-ssh-push]::
- Helper "server-side" program used by git-ssh-pull
+link:git-status.html[git-status]::
+ Shows the working tree status.
+ Previously this command was known as git-status-script.
-link:git-send-email-script.html[git-send-email]::
- Send patch e-mails out of "format-patch --mbox" output.
+link:git-verify-tag.html[git-verify-tag]::
+ Check the GPG signature of tag.
+ Previously this command was known as git-verify-tag-script.
+link:git-whatchanged.html[git-whatchanged]::
+ Shows commit logs and differences they introduce.
-Commands not yet documented
----------------------------
-link:git-applymbox.html[git-applymbox]::
- git-applymbox.
+Ancillary Commands
+------------------
+Manipulators:
link:git-applypatch.html[git-applypatch]::
- git-applypatch.
+ Apply one patch extracted from an e-mail.
-link:git-mailinfo.html[git-mailinfo]::
- git-mailinfo.
+link:git-archimport.html[git-archimport]::
+ Import an arch repository into git.
+ Previously this command was known as git-archimport-script.
-link:git-mailsplit.html[git-mailsplit]::
- git-mailsplit.
+link:git-convert-objects.html[git-convert-objects]::
+ Converts old-style GIT repository
+ Previously this command was known as git-convert-cache.
-link:git-add-script.html[git-add-script]::
- git-add-script.
+link:git-cvsimport.html[git-cvsimport]::
+ Salvage your data out of another SCM people love to hate.
+ Previously this command was known as git-cvsimport-script.
-link:git-bisect-script.html[git-bisect-script]::
- git-bisect-script.
+link:git-merge-one-file.html[git-merge-one-file]::
+ The standard helper program to use with "git-merge-index"
+ Previously this command was known as git-merge-one-file-script.
-link:git-branch-script.html[git-branch-script]::
- git-branch-script.
+link:git-prune.html[git-prune]::
+ Prunes all unreachable objects from the object database
+ Previously this command was known as git-prune-script.
-link:git-build-rev-cache.html[git-build-rev-cache]::
- git-build-rev-cache.
+link:git-relink.html[git-relink]::
+ Hardlink common objects in local repositories.
+ Previously this command was known as git-relink-script.
-link:git-checkout-script.html[git-checkout-script]::
- git-checkout-script.
+link:git-sh-setup.html[git-sh-setup]::
+ Common git shell script setup code.
+ Previously this command was known as git-sh-setup-script.
-link:git-cherry.html[git-cherry]::
- git-cherry.
+link:git-tag.html[git-tag]::
+ An example script to create a tag object signed with GPG
+ Previously this command was known as git-tag-script.
-link:git-clone-dumb-http.html[git-clone-dumb-http]::
- git-clone-dumb-http.
-link:git-count-objects-script.html[git-count-objects-script]::
- git-count-objects-script.
+Interrogators:
-link:git-daemon.html[git-daemon]::
- git-daemon.
+link:git-build-rev-cache.html[git-build-rev-cache]::
+ Create or update a rev-cache file.
+
+link:git-cherry.html[git-cherry]::
+ Find commits not merged upstream.
-link:git-diff-script.html[git-diff-script]::
- git-diff-script.
+link:git-count-objects.html[git-count-objects]::
+ Count unpacked number of objects and their disk consumption.
+ Previously this command was known as git-count-objects-script.
-link:git-format-patch-script.html[git-format-patch-script]::
- git-format-patch-script.
+link:git-daemon.html[git-daemon]::
+ A really simple server for GIT repositories.
+
+link:git-diff-helper.html[git-diff-helper]::
+ Generates patch format output for git-diff-*
link:git-get-tar-commit-id.html[git-get-tar-commit-id]::
- git-get-tar-commit-id.
+ Extract commit ID from an archive created using git-tar-tree.
-link:git-patch-id.html[git-patch-id]::
- git-patch-id.
+link:git-mailinfo.html[git-mailinfo]::
+ Extracts patch from a single e-mail message.
-link:git-rebase-script.html[git-rebase-script]::
- git-rebase-script.
+link:git-mailsplit.html[git-mailsplit]::
+ git-mailsplit.
-link:git-relink-script.html[git-relink-script]::
- git-relink-script.
+link:git-patch-id.html[git-patch-id]::
+ Compute unique ID for a patch.
-link:git-request-pull-script.html[git-request-pull-script]::
- git-request-pull-script.
+link:git-parse-remote.html[git-parse-remote]::
+ Routines to help parsing $GIT_DIR/remotes/
+ Previously this command was known as git-parse-remote-script.
-link:git-reset-script.html[git-reset-script]::
- git-reset-script.
+link:git-request-pull.html[git-request-pull]::
+ git-request-pull.
+ Previously this command was known as git-request-pull-script.
link:git-rev-parse.html[git-rev-parse]::
- git-rev-parse.
-
-link:git-revert-script.html[git-revert-script]::
- git-revert-script.
+ Pick out and massage parameters.
-link:git-sh-setup-script.html[git-sh-setup-script]::
- git-sh-setup-script.
+link:git-send-email.html[git-send-email]::
+ Send patch e-mails out of "format-patch --mbox" output.
+ Previously this command was known as git-send-email-script.
link:git-show-rev-cache.html[git-show-rev-cache]::
- git-show-rev-cache.
+ Show the contents of a rev-cache file.
+
+Commands not yet documented
+---------------------------
+
+link:git-diff.html[git-diff]::
+ git-diff.
+ Previously this command was known as git-diff-script.
+
+link:git-format-patch.html[git-format-patch]::
+ git-format-patch.
+ Previously this command was known as git-format-patch-script.
link:git-stripspace.html[git-stripspace]::
git-stripspace.
-link:git-verify-tag-script.html[git-verify-tag-script]::
- git-verify-tag-script.
-
link:gitk.html[gitk]::
gitk.
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
-----------
Please see link:glossary.html[glossary] document.
'GIT_DIFF_OPTS'::
'GIT_EXTERNAL_DIFF'::
see the "generating patches" section in :
- link:git-diff-cache.html[git-diff-cache];
+ link:git-diff-index.html[git-diff-index];
link:git-diff-files.html[git-diff-files];
link:git-diff-tree.html[git-diff-tree]
-Discussion
-----------
+Discussion[[Discussion]]
+------------------------
include::../README[]
Author
projects / thirdparty / git.git / blobdiff