projects
/
git.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
git-daemon: --inetd implies --syslog
[git.git]
/
Documentation
/
git.txt
diff --git
a/Documentation/git.txt
b/Documentation/git.txt
index
b10edff
..
7045f3f
100644
(file)
--- a/
Documentation/git.txt
+++ b/
Documentation/git.txt
@@
-1,6
+1,5
@@
git(7)
======
git(7)
======
-v0.99.5, Aug 2005
NAME
----
NAME
----
@@
-21,8
+20,8
@@
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
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.
If you are migrating from CVS, link:cvs-migration.html[cvs migration]
document may be helpful after you finish the tutorial.
@@
-41,7
+40,7
@@
reflect recent changes.
Commands Overview
-----------------
The git commands can helpfully be split into those that manipulate
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 working fileset, those that
interrogate and compare them, and those that moves objects and
references between repositories.
interrogate and compare them, and those that moves objects and
references between repositories.
@@
-55,100
+54,100
@@
SCMs layered over git.
Manipulation commands
~~~~~~~~~~~~~~~~~~~~~
Manipulation commands
~~~~~~~~~~~~~~~~~~~~~
-
link:git-apply.html[git-apply
]::
+
gitlink:git-apply[1
]::
Reads a "diff -up1" or git generated patch file and
applies it to the working tree.
Reads a "diff -up1" or git generated patch file and
applies it to the working tree.
-
link:git-checkout-cache.html[git-checkout-cache
]::
- Copy files from the
cache
to the working directory
+
gitlink:git-checkout-index[1
]::
+ Copy files from the
index
to the working directory
-
link:git-commit-tree.html[git-commit-tree
]::
+
gitlink:git-commit-tree[1
]::
Creates a new commit object
Creates a new commit object
-
link:git-hash-object.html[git-hash-object
]::
+
gitlink:git-hash-object[1
]::
Computes the object ID from a file.
Computes the object ID from a file.
-link:git-init-db.html[git-init-db]::
+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
Creates an empty git object database
-
link:git-merge-cache.html[git-merge-cache
]::
+
gitlink:git-merge-index[1
]::
Runs a merge for files needing merging
Runs a merge for files needing merging
-
link:git-mktag.html[git-mktag
]::
+
gitlink:git-mktag[1
]::
Creates a tag object
Creates a tag object
-
link:git-pack-objects.html[git-pack-objects
]::
+
gitlink:git-pack-objects[1
]::
Creates a packed archive of objects.
Creates a packed archive of objects.
-
link:git-prune-packed.html[git-prune-packed
]::
+
gitlink:git-prune-packed[1
]::
Remove extra objects that are already in pack files.
Remove extra objects that are already in pack files.
-
link:git-read-tree.html[git-read-tree
]::
- Reads tree information into the directory
cache
+
gitlink:git-read-tree[1
]::
+ Reads tree information into the directory
index
-
link:git-unpack-objects.html[git-unpack-objects
]::
+
gitlink:git-unpack-objects[1
]::
Unpacks objects out of a packed archive.
Unpacks objects out of a packed archive.
-
link:git-update-cache.html[git-update-cache
]::
+
gitlink:git-update-index[1
]::
Modifies the index or directory cache
Modifies the index or directory cache
-
link:git-write-tree.html[git-write-tree
]::
- Creates a tree from the current
cache
+
gitlink:git-write-tree[1
]::
+ Creates a tree from the current
index
Interrogation commands
~~~~~~~~~~~~~~~~~~~~~~
Interrogation commands
~~~~~~~~~~~~~~~~~~~~~~
-
link:git-cat-file.html[git-cat-file
]::
+
gitlink:git-cat-file[1
]::
Provide content or type information for repository objects
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-diff-index[1
]::
+ Compares content and mode of blobs between the
index
and repository
-
link:git-diff-files.html[git-diff-files
]::
- Compares files in the working tree and the
cache
+
gitlink:git-diff-files[1
]::
+ Compares files in the working tree and the
index
-
link:git-diff-stages.html[git-diff-stages
]::
+
gitlink:git-diff-stages[1
]::
Compares two "merge stages" in the index file.
Compares two "merge stages" in the index file.
-
link:git-diff-tree.html[git-diff-tree
]::
+
gitlink:git-diff-tree[1
]::
Compares the content and mode of blobs found via two tree objects
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]::
+gitlink:git-fsck-objects[1]::
Verifies the connectivity and validity of the objects in the database
Verifies the connectivity and validity of the objects in the database
-
link:git-ls-files.html[git-ls-files
]::
- Information about files in the
cache
/working directory
+
gitlink:git-ls-files[1
]::
+ Information about files in the
index
/working directory
-
link:git-ls-tree.html[git-ls-tree
]::
+
gitlink:git-ls-tree[1
]::
Displays a tree object in human readable form
Displays a tree object in human readable form
-
link:git-merge-base.html[git-merge-base
]::
+
gitlink:git-merge-base[1
]::
Finds as good a common ancestor as possible for a merge
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
+
gitlink:git-name-rev[1
]::
+ Find symbolic names for given revs
-
link:git-rev-tree.html[git-rev-tree
]::
- Provides the revision tree for one or more commits
+
gitlink:git-rev-list[1
]::
+ Lists commit objects in reverse chronological order
-
link:git-show-index.html[git-show-index
]::
+
gitlink:git-show-index[1
]::
Displays contents of a pack idx file.
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
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
Creates a temporary file with a blob's contents
-
link:git-var.html[git-var
]::
+
gitlink:git-var[1
]::
Displays a git logical variable
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
The interrogate commands may create files - and you can force them to
touch the working file set - but in general they don't
@@
-157,39
+156,42
@@
touch the working file set - but in general they don't
Synching repositories
~~~~~~~~~~~~~~~~~~~~~
Synching repositories
~~~~~~~~~~~~~~~~~~~~~
-
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)
Clones a repository into the current repository (engine
for ssh and local transport)
-
link:git-fetch-pack.html[git-fetch-pack
]::
+
gitlink:git-fetch-pack[1
]::
Updates from a remote repository.
Updates from a remote repository.
-
link:git-http-pull.html[git-http-pull
]::
- Downloads a remote
GIT
repository via HTTP
+
gitlink:git-http-fetch[1
]::
+ Downloads a remote
git
repository via HTTP
-
link:git-local-pull.html[git-local-pull
]::
- Duplicates another
GIT
repository on a local system
+
gitlink:git-local-fetch[1
]::
+ Duplicates another
git
repository on a local system
-
link:git-peek-remote.html[git-peek-remote
]::
+
gitlink:git-peek-remote[1
]::
Lists references on a remote repository using upload-pack protocol.
Lists references on a remote repository using upload-pack protocol.
-
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.
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.
Pushes to a remote repository, intelligently.
-link:git-ssh-pull.html[git-ssh-pull]::
+gitlink:git-shell[1]::
+ Restricted shell for GIT-only SSH access.
+
+gitlink:git-ssh-fetch[1]::
Pulls from a remote repository over ssh connection
Pulls from a remote repository over ssh connection
-
link:git-ssh-push.html[git-ssh-push
]::
- Helper "server-side" program used by git-ssh-
pull
+
gitlink:git-ssh-upload[1
]::
+ Helper "server-side" program used by git-ssh-
fetch
-
link:git-update-server-info.html[git-update-server-info
]::
+
gitlink:git-update-server-info[1
]::
Updates auxiliary information on a dumb server to help
clients discover references and packs on it.
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.
Invoked by 'git-clone-pack' and 'git-fetch-pack' to push
what are asked for.
@@
-197,73
+199,94
@@
link:git-upload-pack.html[git-upload-pack]::
Porcelain-ish Commands
----------------------
Porcelain-ish Commands
----------------------
-
link:git-add-script.html[git-add-script
]::
+
gitlink:git-add[1
]::
Add paths to the index file.
Add paths to the index file.
-link:git-applymbox.html[git-applymbox]::
+gitlink:git-am[1]::
+ Apply patches from a mailbox, but cooler.
+
+gitlink:git-applymbox[1]::
Apply patches from a mailbox.
Apply patches from a mailbox.
-
link:git-bisect-script.html[git-bisect-script
]::
+
gitlink:git-bisect[1
]::
Find the change that introduced a bug.
Find the change that introduced a bug.
-
link:git-branch-script.html[git-branch-script
]::
+
gitlink:git-branch[1
]::
Create and Show branches.
Create and Show branches.
-link:git-cherry-pick-script.html[git-cherry-pick-script]::
+gitlink:git-checkout[1]::
+ Checkout and switch to a branch.
+
+gitlink:git-cherry-pick[1]::
Cherry-pick the effect of an existing commit.
Cherry-pick the effect of an existing commit.
-
link:git-clone-script.html[git-clone-script
]::
+
gitlink:git-clone[1
]::
Clones a repository into a new directory.
Clones a repository into a new directory.
-
link:git-commit-script.html[git-commit-script
]::
+
gitlink:git-commit[1
]::
Record changes to the repository.
Record changes to the repository.
-link:git-fetch-script.html[git-fetch-script]::
+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.
Download from a remote repository via various protocols.
-link:git-log-script.html[git-log-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.
Shows commit logs.
-
link:git-ls-remote-script.html[git-ls-remote-script
]::
+
gitlink:git-ls-remote[1
]::
Shows references in a remote or local repository.
Shows references in a remote or local repository.
-link:git-octopus-script.html[git-octopus-script]::
+gitlink:git-merge[1]::
+ Grand unified merge driver.
+
+gitlink:git-mv[1]::
+ Move or rename a file, a directory, or a symlink.
+
+gitlink:git-octopus[1]::
Merge more than two commits.
Merge more than two commits.
-
link:git-pull-script.html[git-pull-script
]::
+
gitlink:git-pull[1
]::
Fetch from and merge with a remote repository.
Fetch from and merge with a remote repository.
-
link:git-push-script.html[git-push-script
]::
+
gitlink:git-push[1
]::
Update remote refs along with associated objects.
Update remote refs along with associated objects.
-
link:git-rebase-script.html[git-rebase-script
]::
+
gitlink:git-rebase[1
]::
Rebase local commits to new upstream head.
Rebase local commits to new upstream head.
-link:git-rename-script.html[git-rename]::
- Rename files and directories.
-
-link:git-repack-script.html[git-repack-script]::
+gitlink:git-repack[1]::
Pack unpacked objects in a repository.
Pack unpacked objects in a repository.
-link:git-resolve-script.html[git-resolve-script]::
+gitlink:git-reset[1]::
+ Reset current HEAD to the specified state.
+
+gitlink:git-resolve[1]::
Merge two commits.
Merge two commits.
-
link:git-revert-script.html[git-revert-script
]::
+
gitlink:git-revert[1
]::
Revert an existing commit.
Revert an existing commit.
-
link:git-shortlog.html[git-shortlog
]::
+
gitlink:git-shortlog[1
]::
Summarizes 'git log' output.
Summarizes 'git log' output.
-
link:git-show-branch.html[git-show-branch
]::
+
gitlink:git-show-branch[1
]::
Show branches and their commits.
Show branches and their commits.
-
link:git-status-script.html[git-status-script
]::
+
gitlink:git-status[1
]::
Shows the working tree status.
Shows the working tree status.
-
link:git-verify-tag-script.html[git-verify-tag-script
]::
+
gitlink:git-verify-tag[1
]::
Check the GPG signature of tag.
Check the GPG signature of tag.
-
link:git-whatchanged.html[git-whatchanged
]::
+
gitlink:git-whatchanged[1
]::
Shows commit logs and differences they introduce.
Shows commit logs and differences they introduce.
@@
-271,92
+294,127
@@
Ancillary Commands
------------------
Manipulators:
------------------
Manipulators:
-
link:git-applypatch.html[git-applypatch
]::
+
gitlink:git-applypatch[1
]::
Apply one patch extracted from an e-mail.
Apply one patch extracted from an e-mail.
-
link:git-convert-cache.html[git-convert-cache
]::
- Converts old-style GIT repository
+
gitlink:git-archimport[1
]::
+ Import an arch repository into git.
-link:git-cvsimport-script.html[git-cvsimport-script]::
+gitlink:git-convert-objects[1]::
+ Converts old-style git repository
+
+gitlink:git-cvsimport[1]::
Salvage your data out of another SCM people love to hate.
Salvage your data out of another SCM people love to hate.
-link:git-merge-one-file-script.html[git-merge-one-file-script]::
- The standard helper program to use with "git-merge-cache"
+gitlink:git-lost-found[1]::
+ Recover lost refs that luckily have not yet been pruned.
+
+gitlink:git-merge-one-file[1]::
+ The standard helper program to use with "git-merge-index"
-
link:git-prune-script.html[git-prune-script
]::
+
gitlink:git-prune[1
]::
Prunes all unreachable objects from the object database
Prunes all unreachable objects from the object database
-
link:git-relink-script.html[git-relink-script
]::
+
gitlink:git-relink[1
]::
Hardlink common objects in local repositories.
Hardlink common objects in local repositories.
-link:git-sh-setup-script.html[git-sh-setup-script]::
+gitlink:git-svnimport[1]::
+ Import a SVN repository into git.
+
+gitlink:git-sh-setup[1]::
Common git shell script setup code.
Common git shell script setup code.
-link:git-tag-script.html[git-tag-script]::
+gitlink:git-symbolic-ref[1]::
+ Read and modify symbolic refs
+
+gitlink:git-tag[1]::
An example script to create a tag object signed with GPG
An example script to create a tag object signed with GPG
+gitlink:git-update-ref[1]::
+ Update the object name stored in a ref safely.
+
Interrogators:
Interrogators:
-link:git-cherry.html[git-cherry]::
+gitlink:git-check-ref-format[1]::
+ Make sure ref name is well formed.
+
+gitlink:git-cherry[1]::
Find commits not merged upstream.
Find commits not merged upstream.
-
link:git-count-objects-script.html[git-count-objects-script
]::
+
gitlink:git-count-objects[1
]::
Count unpacked number of objects and their disk consumption.
Count unpacked number of objects and their disk consumption.
-
link:git-diff-helper.html[git-diff-helper
]::
- Generates patch format output for git-diff-*
+
gitlink:git-daemon[1
]::
+ A really simple server for git repositories.
-link:git-mailinfo.html[git-mailinfo]::
+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.
Extracts patch from a single e-mail message.
-
link:git-mailsplit.html[git-mailsplit
]::
+
gitlink:git-mailsplit[1
]::
git-mailsplit.
git-mailsplit.
-
link:git-patch-id.html[git-patch-id
]::
+
gitlink:git-patch-id[1
]::
Compute unique ID for a patch.
Compute unique ID for a patch.
-link:git-send-email-script.html[git-send-email]::
+gitlink:git-parse-remote[1]::
+ Routines to help parsing $GIT_DIR/remotes/
+
+gitlink:git-request-pull[1]::
+ git-request-pull.
+
+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.
Send patch e-mails out of "format-patch --mbox" output.
-
link:git-get-tar-commit-id.html[git-get-tar-commit-id
]::
-
Extract commit ID from an archive created using git-tar-tree
.
+
gitlink:git-symbolic-refs[1
]::
+
Read and modify symbolic refs
.
-Commands not yet documented
----------------------------
+gitlink:git-stripspace[1]::
+ Filter out empty lines.
-link:git-build-rev-cache.html[git-build-rev-cache]::
- git-build-rev-cache.
-link:git-checkout-script.html[git-checkout-script]::
- git-checkout-script.
+Commands not yet documented
+---------------------------
-
link:git-daemon.html[git-daemon
]::
- git
-daemon
.
+
gitlink:gitk[1
]::
+ git
k
.
-link:git-diff-script.html[git-diff-script]::
- git-diff-script.
-link:git-format-patch-script.html[git-format-patch-script]::
- git-format-patch-script.
+Configuration Mechanism
+-----------------------
-link:git-request-pull-script.html[git-request-pull-script]::
- git-request-pull-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-reset-script.html[git-reset-script]::
- git-reset-script.
+------------
+#
+# This is the config file, and
+# a '#' or ';' character indicates
+# a comment
+#
-link:git-rev-parse.html[git-rev-parse]::
- git-rev-parse.
+; core variables
+[core]
+ ; Don't trust file modes
+ filemode = false
-link:git-show-rev-cache.html[git-show-rev-cache]::
- git-show-rev-cache.
+; user identity
+[user]
+ name = "Junio C Hamano"
+ email = "junkio@twinsun.com"
-link:git-stripspace.html[git-stripspace]::
- git-stripspace.
+------------
-link:gitk.html[gitk]::
-
gitk
.
+Various commands read from the configuration file and adjust
+
their operation accordingly
.
Identifier Terminology
Identifier Terminology
@@
-432,8
+490,8
@@
git so take care if using Cogito etc
'GIT_INDEX_FILE'::
This environment allows the specification of an alternate
'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
'GIT_OBJECT_DIRECTORY'::
If the object storage directory is specified via this
@@
-460,16
+518,16
@@
git Commits
'GIT_AUTHOR_DATE'::
'GIT_COMMITTER_NAME'::
'GIT_COMMITTER_EMAIL'::
'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 :
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[[Discussion]]
------------------------
@@
-485,5
+543,5
@@
Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel
GIT
---
GIT
---
-Part of the
link:git.html[git
] suite
+Part of the
gitlink:git[7
] suite