From 215a7ad1ef790467a4cd3f0dcffbd6e5f04c38f7 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Wed, 7 Sep 2005 17:26:23 -0700 Subject: Big tool rename. As promised, this is the "big tool rename" patch. The primary differences since 0.99.6 are: (1) git-*-script are no more. The commands installed do not have any such suffix so users do not have to remember if something is implemented as a shell script or not. (2) Many command names with 'cache' in them are renamed with 'index' if that is what they mean. There are backward compatibility symblic links so that you and Porcelains can keep using the old names, but the backward compatibility support is expected to be removed in the near future. Signed-off-by: Junio C Hamano --- .gitignore | 20 +- Documentation/diff-format.txt | 10 +- Documentation/diffcore.txt | 4 +- Documentation/git-add-script.txt | 33 - Documentation/git-add.txt | 33 + Documentation/git-archimport-script.txt | 42 -- Documentation/git-archimport.txt | 42 ++ Documentation/git-bisect-script.txt | 90 --- Documentation/git-bisect.txt | 90 +++ Documentation/git-branch-script.txt | 39 - Documentation/git-branch.txt | 39 + Documentation/git-checkout-cache.txt | 106 --- Documentation/git-checkout-index.txt | 106 +++ Documentation/git-checkout-script.txt | 43 -- Documentation/git-checkout.txt | 43 ++ Documentation/git-cherry-pick-script.txt | 57 -- Documentation/git-cherry-pick.txt | 57 ++ Documentation/git-clone-script.txt | 60 -- Documentation/git-clone.txt | 60 ++ Documentation/git-commit-script.txt | 72 -- Documentation/git-commit.txt | 72 ++ Documentation/git-convert-cache.txt | 30 - Documentation/git-convert-objects.txt | 30 + Documentation/git-count-objects-script.txt | 28 - Documentation/git-count-objects.txt | 28 + Documentation/git-cvsimport-script.txt | 109 --- Documentation/git-cvsimport.txt | 109 +++ Documentation/git-diff-cache.txt | 134 ---- Documentation/git-diff-files.txt | 2 +- Documentation/git-diff-helper.txt | 4 +- Documentation/git-diff-index.txt | 134 ++++ Documentation/git-diff-script.txt | 38 - Documentation/git-diff-tree.txt | 4 +- Documentation/git-diff.txt | 38 + Documentation/git-fetch-script.txt | 41 - Documentation/git-fetch.txt | 41 + Documentation/git-format-patch-script.txt | 38 - Documentation/git-format-patch.txt | 38 + Documentation/git-fsck-cache.txt | 145 ---- Documentation/git-fsck-objects.txt | 145 ++++ Documentation/git-hash-object.txt | 2 +- Documentation/git-http-fetch.txt | 42 ++ Documentation/git-http-pull.txt | 42 -- Documentation/git-local-fetch.txt | 44 ++ Documentation/git-local-pull.txt | 44 -- Documentation/git-log-script.txt | 45 -- Documentation/git-log.txt | 45 ++ Documentation/git-ls-remote-script.txt | 64 -- Documentation/git-ls-remote.txt | 64 ++ Documentation/git-merge-cache.txt | 89 --- Documentation/git-merge-index.txt | 89 +++ Documentation/git-merge-one-file-script.txt | 31 - Documentation/git-merge-one-file.txt | 31 + Documentation/git-octopus-script.txt | 39 - Documentation/git-octopus.txt | 39 + Documentation/git-pack-objects.txt | 2 +- Documentation/git-parse-remote-script.txt | 48 -- Documentation/git-parse-remote.txt | 48 ++ Documentation/git-prune-packed.txt | 2 +- Documentation/git-prune-script.txt | 43 -- Documentation/git-prune.txt | 43 ++ Documentation/git-pull-script.txt | 41 - Documentation/git-pull.txt | 41 + Documentation/git-push-script.txt | 36 - Documentation/git-push.txt | 36 + Documentation/git-read-tree.txt | 24 +- Documentation/git-rebase-script.txt | 35 - Documentation/git-rebase.txt | 35 + Documentation/git-relink-script.txt | 37 - Documentation/git-relink.txt | 37 + Documentation/git-rename-script.txt | 33 - Documentation/git-rename.txt | 33 + Documentation/git-repack-script.txt | 59 -- Documentation/git-repack.txt | 59 ++ Documentation/git-request-pull-script.txt | 40 - Documentation/git-request-pull.txt | 40 + Documentation/git-reset-script.txt | 45 -- Documentation/git-reset.txt | 45 ++ Documentation/git-resolve-script.txt | 37 - Documentation/git-resolve.txt | 37 + Documentation/git-revert-script.txt | 48 -- Documentation/git-revert.txt | 48 ++ Documentation/git-send-email-script.txt | 79 -- Documentation/git-send-email.txt | 79 ++ Documentation/git-sh-setup-script.txt | 34 - Documentation/git-sh-setup.txt | 34 + Documentation/git-show-branch.txt | 2 +- Documentation/git-ssh-fetch.txt | 52 ++ Documentation/git-ssh-pull.txt | 52 -- Documentation/git-ssh-push.txt | 48 -- Documentation/git-ssh-upload.txt | 48 ++ Documentation/git-status-script.txt | 46 -- Documentation/git-status.txt | 46 ++ Documentation/git-tag-script.txt | 39 - Documentation/git-tag.txt | 39 + Documentation/git-update-cache.txt | 126 ---- Documentation/git-update-index.txt | 126 ++++ Documentation/git-var.txt | 2 +- Documentation/git-verify-tag-script.txt | 32 - Documentation/git-verify-tag.txt | 32 + Documentation/git-write-tree.txt | 2 +- Documentation/git.txt | 146 ++-- Documentation/hooks.txt | 12 +- Documentation/howto/make-dist.txt | 2 +- .../howto/rebase-from-internal-branch.txt | 2 +- Documentation/howto/revert-branch-rebase.txt | 4 +- Documentation/tutorial.txt | 54 +- INSTALL | 6 +- Makefile | 152 ++-- README | 26 +- checkout-cache.c | 151 ---- checkout-index.c | 151 ++++ cmd-rename.sh | 53 ++ convert-cache.c | 326 -------- convert-objects.c | 326 ++++++++ debian/changelog | 2 +- diff-cache.c | 296 -------- diff-index.c | 296 ++++++++ entry.c | 12 +- fetch.c | 210 ++++++ fetch.h | 48 ++ fsck-cache.c | 537 -------------- fsck-objects.c | 537 ++++++++++++++ git | 20 - git-add-script | 2 - git-add.sh | 2 + git-applymbox | 109 --- git-applymbox.sh | 109 +++ git-applypatch | 118 --- git-applypatch.sh | 118 +++ git-archimport-script | 604 --------------- git-archimport.perl | 604 +++++++++++++++ git-bisect-script | 178 ----- git-bisect.sh | 178 +++++ git-branch-script | 32 - git-branch.sh | 32 + git-checkout-script | 76 -- git-checkout.sh | 76 ++ git-cherry | 91 --- git-cherry.sh | 91 +++ git-clone-script | 165 ----- git-clone.sh | 165 +++++ git-commit-script | 233 ------ git-commit.sh | 233 ++++++ git-count-objects-script | 13 - git-count-objects.sh | 13 + git-cvsimport-script | 823 --------------------- git-cvsimport.perl | 823 +++++++++++++++++++++ git-diff-script | 35 - git-diff.sh | 35 + git-fetch-script | 244 ------ git-fetch.sh | 244 ++++++ git-format-patch-script | 220 ------ git-format-patch.sh | 220 ++++++ git-log-script | 15 - git-log.sh | 15 + git-ls-remote-script | 100 --- git-ls-remote.sh | 100 +++ git-merge-one-file-script | 88 --- git-merge-one-file.sh | 88 +++ git-octopus-script | 103 --- git-octopus.sh | 103 +++ git-parse-remote-script | 155 ---- git-parse-remote.sh | 155 ++++ git-prune-script | 27 - git-prune.sh | 27 + git-pull-script | 44 -- git-pull.sh | 44 ++ git-push-script | 52 -- git-push.sh | 52 ++ git-rebase-script | 68 -- git-rebase.sh | 68 ++ git-relink-script | 173 ----- git-relink.perl | 173 +++++ git-rename-script | 70 -- git-rename.perl | 70 ++ git-repack-script | 68 -- git-repack.sh | 68 ++ git-request-pull-script | 35 - git-request-pull.sh | 35 + git-reset-script | 97 --- git-reset.sh | 97 +++ git-resolve-script | 104 --- git-resolve.sh | 104 +++ git-revert-script | 164 ---- git-revert.sh | 166 +++++ git-send-email-script | 368 --------- git-send-email.perl | 368 +++++++++ git-sh-setup-script | 27 - git-sh-setup.sh | 27 + git-shortlog | 177 ----- git-shortlog.perl | 177 +++++ git-status-script | 85 --- git-status.sh | 85 +++ git-tag-script | 82 -- git-tag.sh | 82 ++ git-verify-tag-script | 8 - git-verify-tag.sh | 8 + git-whatchanged | 7 - git-whatchanged.sh | 7 + git.sh | 27 + http-fetch.c | 371 ++++++++++ http-pull.c | 371 ---------- local-fetch.c | 227 ++++++ local-pull.c | 227 ------ merge-cache.c | 135 ---- merge-index.c | 135 ++++ pull.c | 210 ------ pull.h | 48 -- ssh-fetch.c | 129 ++++ ssh-pull.c | 129 ---- ssh-push.c | 133 ---- ssh-upload.c | 133 ++++ t/README | 10 +- t/lib-read-tree-m-3way.sh | 44 +- t/t0000-basic.sh | 26 +- t/t0100-environment-names.sh | 2 +- t/t0110-environment-names-old.sh | 4 +- t/t1000-read-tree-m-3way.sh | 74 +- t/t1001-read-tree-m-2way.sh | 86 +-- t/t1002-read-tree-m-u-2way.sh | 46 +- t/t1005-read-tree-m-2way-emu23.sh | 92 +-- t/t2000-checkout-cache-clash.sh | 18 +- t/t2001-checkout-cache-clash.sh | 18 +- t/t2002-checkout-cache-u.sh | 16 +- t/t2003-checkout-cache-mkdir.sh | 18 +- t/t2100-update-cache-badpath.sh | 12 +- t/t3010-ls-files-killed.sh | 4 +- t/t3100-ls-tree-restrict.sh | 2 +- t/t4000-diff-format.sh | 2 +- t/t4001-diff-rename.sh | 8 +- t/t4002-diff-basic.sh | 18 +- t/t4003-diff-rename-1.sh | 16 +- t/t4004-diff-rename-symlink.sh | 6 +- t/t4005-diff-rename-2.sh | 14 +- t/t4006-diff-mode.sh | 6 +- t/t4007-rename-3.sh | 14 +- t/t4008-diff-break-rewrite.sh | 32 +- t/t4009-diff-rename-4.sh | 14 +- t/t4010-diff-pathspec.sh | 14 +- t/t4102-apply-rename.sh | 2 +- t/t4112-apply-renames.sh | 2 +- t/t5000-tar-tree.sh | 4 +- t/t5300-pack-object.sh | 4 +- t/t5400-send-pack.sh | 6 +- t/t6001-rev-list-merge-order.sh | 2 +- t/t6002-rev-list-bisect.sh | 2 +- t/t6003-rev-list-topo-order.sh | 2 +- t/t6101-rev-parse-parents.sh | 2 +- templates/hooks--commit-msg | 2 +- templates/hooks--pre-commit | 4 +- update-cache.c | 407 ---------- update-index.c | 407 ++++++++++ 253 files changed, 11125 insertions(+), 11017 deletions(-) delete mode 100644 Documentation/git-add-script.txt create mode 100644 Documentation/git-add.txt delete mode 100644 Documentation/git-archimport-script.txt create mode 100644 Documentation/git-archimport.txt delete mode 100644 Documentation/git-bisect-script.txt create mode 100644 Documentation/git-bisect.txt delete mode 100644 Documentation/git-branch-script.txt create mode 100644 Documentation/git-branch.txt delete mode 100644 Documentation/git-checkout-cache.txt create mode 100644 Documentation/git-checkout-index.txt delete mode 100644 Documentation/git-checkout-script.txt create mode 100644 Documentation/git-checkout.txt delete mode 100644 Documentation/git-cherry-pick-script.txt create mode 100644 Documentation/git-cherry-pick.txt delete mode 100644 Documentation/git-clone-script.txt create mode 100644 Documentation/git-clone.txt delete mode 100644 Documentation/git-commit-script.txt create mode 100644 Documentation/git-commit.txt delete mode 100644 Documentation/git-convert-cache.txt create mode 100644 Documentation/git-convert-objects.txt delete mode 100644 Documentation/git-count-objects-script.txt create mode 100644 Documentation/git-count-objects.txt delete mode 100644 Documentation/git-cvsimport-script.txt create mode 100644 Documentation/git-cvsimport.txt delete mode 100644 Documentation/git-diff-cache.txt create mode 100644 Documentation/git-diff-index.txt delete mode 100644 Documentation/git-diff-script.txt create mode 100644 Documentation/git-diff.txt delete mode 100644 Documentation/git-fetch-script.txt create mode 100644 Documentation/git-fetch.txt delete mode 100644 Documentation/git-format-patch-script.txt create mode 100644 Documentation/git-format-patch.txt delete mode 100644 Documentation/git-fsck-cache.txt create mode 100644 Documentation/git-fsck-objects.txt create mode 100644 Documentation/git-http-fetch.txt delete mode 100644 Documentation/git-http-pull.txt create mode 100644 Documentation/git-local-fetch.txt delete mode 100644 Documentation/git-local-pull.txt delete mode 100644 Documentation/git-log-script.txt create mode 100644 Documentation/git-log.txt delete mode 100644 Documentation/git-ls-remote-script.txt create mode 100644 Documentation/git-ls-remote.txt delete mode 100644 Documentation/git-merge-cache.txt create mode 100644 Documentation/git-merge-index.txt delete mode 100644 Documentation/git-merge-one-file-script.txt create mode 100644 Documentation/git-merge-one-file.txt delete mode 100644 Documentation/git-octopus-script.txt create mode 100644 Documentation/git-octopus.txt delete mode 100644 Documentation/git-parse-remote-script.txt create mode 100644 Documentation/git-parse-remote.txt delete mode 100644 Documentation/git-prune-script.txt create mode 100644 Documentation/git-prune.txt delete mode 100644 Documentation/git-pull-script.txt create mode 100644 Documentation/git-pull.txt delete mode 100644 Documentation/git-push-script.txt create mode 100644 Documentation/git-push.txt delete mode 100644 Documentation/git-rebase-script.txt create mode 100644 Documentation/git-rebase.txt delete mode 100644 Documentation/git-relink-script.txt create mode 100644 Documentation/git-relink.txt delete mode 100644 Documentation/git-rename-script.txt create mode 100644 Documentation/git-rename.txt delete mode 100644 Documentation/git-repack-script.txt create mode 100644 Documentation/git-repack.txt delete mode 100644 Documentation/git-request-pull-script.txt create mode 100644 Documentation/git-request-pull.txt delete mode 100644 Documentation/git-reset-script.txt create mode 100644 Documentation/git-reset.txt delete mode 100644 Documentation/git-resolve-script.txt create mode 100644 Documentation/git-resolve.txt delete mode 100644 Documentation/git-revert-script.txt create mode 100644 Documentation/git-revert.txt delete mode 100644 Documentation/git-send-email-script.txt create mode 100644 Documentation/git-send-email.txt delete mode 100644 Documentation/git-sh-setup-script.txt create mode 100644 Documentation/git-sh-setup.txt create mode 100644 Documentation/git-ssh-fetch.txt delete mode 100644 Documentation/git-ssh-pull.txt delete mode 100644 Documentation/git-ssh-push.txt create mode 100644 Documentation/git-ssh-upload.txt delete mode 100644 Documentation/git-status-script.txt create mode 100644 Documentation/git-status.txt delete mode 100644 Documentation/git-tag-script.txt create mode 100644 Documentation/git-tag.txt delete mode 100644 Documentation/git-update-cache.txt create mode 100644 Documentation/git-update-index.txt delete mode 100644 Documentation/git-verify-tag-script.txt create mode 100644 Documentation/git-verify-tag.txt delete mode 100644 checkout-cache.c create mode 100644 checkout-index.c create mode 100755 cmd-rename.sh delete mode 100644 convert-cache.c create mode 100644 convert-objects.c delete mode 100644 diff-cache.c create mode 100644 diff-index.c create mode 100644 fetch.c create mode 100644 fetch.h delete mode 100644 fsck-cache.c create mode 100644 fsck-objects.c delete mode 100755 git delete mode 100755 git-add-script create mode 100755 git-add.sh delete mode 100755 git-applymbox create mode 100755 git-applymbox.sh delete mode 100755 git-applypatch create mode 100755 git-applypatch.sh delete mode 100755 git-archimport-script create mode 100755 git-archimport.perl delete mode 100755 git-bisect-script create mode 100755 git-bisect.sh delete mode 100755 git-branch-script create mode 100755 git-branch.sh delete mode 100755 git-checkout-script create mode 100755 git-checkout.sh delete mode 100755 git-cherry create mode 100755 git-cherry.sh delete mode 100755 git-clone-script create mode 100755 git-clone.sh delete mode 100755 git-commit-script create mode 100755 git-commit.sh delete mode 100755 git-count-objects-script create mode 100755 git-count-objects.sh delete mode 100755 git-cvsimport-script create mode 100755 git-cvsimport.perl delete mode 100755 git-diff-script create mode 100755 git-diff.sh delete mode 100755 git-fetch-script create mode 100755 git-fetch.sh delete mode 100755 git-format-patch-script create mode 100755 git-format-patch.sh delete mode 100755 git-log-script create mode 100755 git-log.sh delete mode 100755 git-ls-remote-script create mode 100755 git-ls-remote.sh delete mode 100755 git-merge-one-file-script create mode 100755 git-merge-one-file.sh delete mode 100755 git-octopus-script create mode 100755 git-octopus.sh delete mode 100755 git-parse-remote-script create mode 100755 git-parse-remote.sh delete mode 100755 git-prune-script create mode 100755 git-prune.sh delete mode 100755 git-pull-script create mode 100755 git-pull.sh delete mode 100755 git-push-script create mode 100755 git-push.sh delete mode 100755 git-rebase-script create mode 100755 git-rebase.sh delete mode 100755 git-relink-script create mode 100755 git-relink.perl delete mode 100755 git-rename-script create mode 100755 git-rename.perl delete mode 100755 git-repack-script create mode 100755 git-repack.sh delete mode 100755 git-request-pull-script create mode 100755 git-request-pull.sh delete mode 100755 git-reset-script create mode 100755 git-reset.sh delete mode 100755 git-resolve-script create mode 100755 git-resolve.sh delete mode 100755 git-revert-script create mode 100755 git-revert.sh delete mode 100755 git-send-email-script create mode 100755 git-send-email.perl delete mode 100755 git-sh-setup-script create mode 100755 git-sh-setup.sh delete mode 100755 git-shortlog create mode 100755 git-shortlog.perl delete mode 100755 git-status-script create mode 100755 git-status.sh delete mode 100755 git-tag-script create mode 100755 git-tag.sh delete mode 100755 git-verify-tag-script create mode 100755 git-verify-tag.sh delete mode 100755 git-whatchanged create mode 100755 git-whatchanged.sh create mode 100755 git.sh create mode 100644 http-fetch.c delete mode 100644 http-pull.c create mode 100644 local-fetch.c delete mode 100644 local-pull.c delete mode 100644 merge-cache.c create mode 100644 merge-index.c delete mode 100644 pull.c delete mode 100644 pull.h create mode 100644 ssh-fetch.c delete mode 100644 ssh-pull.c delete mode 100644 ssh-push.c create mode 100644 ssh-upload.c delete mode 100644 update-cache.c create mode 100644 update-index.c diff --git a/.gitignore b/.gitignore index 245f54e050..12b01379de 100644 --- a/.gitignore +++ b/.gitignore @@ -1,28 +1,28 @@ git-apply git-build-rev-cache git-cat-file -git-checkout-cache +git-checkout-index git-clone-pack git-commit-tree -git-convert-cache +git-convert-objects git-daemon -git-diff-cache +git-diff-index git-diff-files git-diff-helper git-diff-stages git-diff-tree git-export git-fetch-pack -git-fsck-cache +git-fsck-objects git-get-tar-commit-id git-hash-object -git-http-pull +git-http-fetch git-init-db -git-local-pull +git-local-fetch git-ls-files git-ls-tree git-merge-base -git-merge-cache +git-merge-index git-mktag git-pack-objects git-patch-id @@ -37,13 +37,13 @@ git-send-pack git-show-branch git-show-index git-show-rev-cache -git-ssh-pull -git-ssh-push +git-ssh-fetch +git-ssh-upload git-stripspace git-tar-tree git-unpack-file git-unpack-objects -git-update-cache +git-update-index git-update-server-info git-upload-pack git-var diff --git a/Documentation/diff-format.txt b/Documentation/diff-format.txt index 811d143808..424e75a1c2 100644 --- a/Documentation/diff-format.txt +++ b/Documentation/diff-format.txt @@ -1,13 +1,13 @@ -The output format from "git-diff-cache", "git-diff-tree" and +The output format from "git-diff-index", "git-diff-tree" and "git-diff-files" are very similar. These commands all compare two sets of things; what are compared are different: -git-diff-cache :: +git-diff-index :: compares the and the files on the filesystem. -git-diff-cache --cached :: +git-diff-index --cached :: compares the and the cache. git-diff-tree [-r] [...]:: @@ -58,7 +58,7 @@ Example: Generating patches with -p -------------------------- -When "git-diff-cache", "git-diff-tree", or "git-diff-files" are run +When "git-diff-index", "git-diff-tree", or "git-diff-files" are run with a '-p' option, they do not produce the output described above; instead they produce a patch file. @@ -77,7 +77,7 @@ The "diff" formatting options can be customized via the environment variable 'GIT_DIFF_OPTS'. For example, if you prefer context diff: - GIT_DIFF_OPTS=-c git-diff-cache -p $(cat .git/HEAD) + GIT_DIFF_OPTS=-c git-diff-index -p $(cat .git/HEAD) 2. When the environment variable 'GIT_EXTERNAL_DIFF' is set, the diff --git a/Documentation/diffcore.txt b/Documentation/diffcore.txt index 1a6e725aae..a0ffe85a25 100644 --- a/Documentation/diffcore.txt +++ b/Documentation/diffcore.txt @@ -6,7 +6,7 @@ June 2005 Introduction ------------ -The diff commands git-diff-cache, git-diff-files, and +The diff commands git-diff-index, git-diff-files, and git-diff-tree can be told to manipulate differences they find in unconventional ways before showing diff(1) output. The manipulation is collectively called "diffcore transformation". @@ -21,7 +21,7 @@ The chain of operation The git-diff-* family works by first comparing two sets of files: - - git-diff-cache compares contents of a "tree" object and the + - git-diff-index compares contents of a "tree" object and the working directory (when '--cached' flag is not used) or a "tree" object and the index file (when '--cached' flag is used); diff --git a/Documentation/git-add-script.txt b/Documentation/git-add-script.txt deleted file mode 100644 index 300114358a..0000000000 --- a/Documentation/git-add-script.txt +++ /dev/null @@ -1,33 +0,0 @@ -git-add-script(1) -================= - -NAME ----- -git-add-script - Add files to the cache. - -SYNOPSIS --------- -'git-add-script' ... - -DESCRIPTION ------------ -A simple wrapper to git-update-cache to add files to the cache for people used -to do "cvs add". - -OPTIONS -------- -...:: - Files to add to the cache. - -Author ------- -Written by Linus Torvalds - -Documentation --------------- -Documentation by Junio C Hamano and the git-list . - -GIT ---- -Part of the link:git.html[git] suite - diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt new file mode 100644 index 0000000000..beb450075b --- /dev/null +++ b/Documentation/git-add.txt @@ -0,0 +1,33 @@ +git-add(1) +========== + +NAME +---- +git-add - Add files to the cache. + +SYNOPSIS +-------- +'git-add' ... + +DESCRIPTION +----------- +A simple wrapper to git-update-index to add files to the cache for people used +to do "cvs add". + +OPTIONS +------- +...:: + Files to add to the cache. + +Author +------ +Written by Linus Torvalds + +Documentation +-------------- +Documentation by Junio C Hamano and the git-list . + +GIT +--- +Part of the link:git.html[git] suite + diff --git a/Documentation/git-archimport-script.txt b/Documentation/git-archimport-script.txt deleted file mode 100644 index 134fbedd9b..0000000000 --- a/Documentation/git-archimport-script.txt +++ /dev/null @@ -1,42 +0,0 @@ -git-archimport-script(1) -======================== - -NAME ----- -git-archimport-script - Import an arch repository into git - - -SYNOPSIS --------- -`git-archimport-script` [--option...] - -DESCRIPTION ------------ -The script expects you to provide the key roots where it can start the -import from an 'initial import' or 'tag' type of Arch commit. It will -then follow all the branching and tagging within the provided roots. - -It will die if it sees branches that have different roots. - - -OPTIONS -------- ---option:: - Some option not yet documented. - -...:: - Some argument not yet documented. - - -Author ------- -Written by Martin Langhoff . - -Documentation --------------- -Documentation by Junio C Hamano and the git-list . - -GIT ---- -Part of the link:git.html[git] suite - diff --git a/Documentation/git-archimport.txt b/Documentation/git-archimport.txt new file mode 100644 index 0000000000..8ce5f0a93f --- /dev/null +++ b/Documentation/git-archimport.txt @@ -0,0 +1,42 @@ +git-archimport(1) +================= + +NAME +---- +git-archimport - Import an arch repository into git + + +SYNOPSIS +-------- +`git-archimport` [--option...] + +DESCRIPTION +----------- +The script expects you to provide the key roots where it can start the +import from an 'initial import' or 'tag' type of Arch commit. It will +then follow all the branching and tagging within the provided roots. + +It will die if it sees branches that have different roots. + + +OPTIONS +------- +--option:: + Some option not yet documented. + +...:: + Some argument not yet documented. + + +Author +------ +Written by Martin Langhoff . + +Documentation +-------------- +Documentation by Junio C Hamano and the git-list . + +GIT +--- +Part of the link:git.html[git] suite + diff --git a/Documentation/git-bisect-script.txt b/Documentation/git-bisect-script.txt deleted file mode 100644 index b4531c6e6a..0000000000 --- a/Documentation/git-bisect-script.txt +++ /dev/null @@ -1,90 +0,0 @@ -git-bisect-script(1) -==================== - -NAME ----- -git-bisect-script - Find the change that introduced a bug - - -SYNOPSIS --------- -'git bisect' start -'git bisect' bad -'git bisect' good -'git bisect' reset [] -'git bisect' visualize - - -DESCRIPTION ------------ -This command uses 'git-rev-list --bisect' option to help drive -the binary search process to find which change introduced a bug, -given an old "good" commit object name and a later "bad" commit -object name. - -The way you use it is: - ------------------------------------------------- -git bisect start -git bisect bad # Current version is bad -git bisect good v2.6.13-rc2 # v2.6.13-rc2 was the last version - # tested that was good ------------------------------------------------- - -When you give at least one bad and one good versions, it will -bisect the revision tree and say something like: - ------------------------------------------------- -Bisecting: 675 revisions left to test after this ------------------------------------------------- - -and check out the state in the middle. Now, compile that kernel, and boot -it. Now, let's say that this booted kernel works fine, then just do - ------------------------------------------------- -git bisect good # this one is good ------------------------------------------------- - -which will now say - ------------------------------------------------- -Bisecting: 337 revisions left to test after this ------------------------------------------------- - -and you continue along, compiling that one, testing it, and depending on -whether it is good or bad, you say "git bisect good" or "git bisect bad", -and ask for the next bisection. - -Until you have no more left, and you'll have been left with the first bad -kernel rev in "refs/bisect/bad". - -Oh, and then after you want to reset to the original head, do a - ------------------------------------------------- -git bisect reset ------------------------------------------------- - -to get back to the master branch, instead of being in one of the bisection -branches ("git bisect start" will do that for you too, actually: it will -reset the bisection state, and before it does that it checks that you're -not using some old bisection branch). - -During the bisection process, you can say - - git bisect visualize - -to see the currently remaining suspects in `gitk`. - - -Author ------- -Written by Linus Torvalds - -Documentation --------------- -Documentation by Junio C Hamano and the git-list . - -GIT ---- -Part of the link:git.html[git] suite - diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt new file mode 100644 index 0000000000..ae438761b2 --- /dev/null +++ b/Documentation/git-bisect.txt @@ -0,0 +1,90 @@ +git-bisect(1) +============= + +NAME +---- +git-bisect - Find the change that introduced a bug + + +SYNOPSIS +-------- +'git bisect' start +'git bisect' bad +'git bisect' good +'git bisect' reset [] +'git bisect' visualize + + +DESCRIPTION +----------- +This command uses 'git-rev-list --bisect' option to help drive +the binary search process to find which change introduced a bug, +given an old "good" commit object name and a later "bad" commit +object name. + +The way you use it is: + +------------------------------------------------ +git bisect start +git bisect bad # Current version is bad +git bisect good v2.6.13-rc2 # v2.6.13-rc2 was the last version + # tested that was good +------------------------------------------------ + +When you give at least one bad and one good versions, it will +bisect the revision tree and say something like: + +------------------------------------------------ +Bisecting: 675 revisions left to test after this +------------------------------------------------ + +and check out the state in the middle. Now, compile that kernel, and boot +it. Now, let's say that this booted kernel works fine, then just do + +------------------------------------------------ +git bisect good # this one is good +------------------------------------------------ + +which will now say + +------------------------------------------------ +Bisecting: 337 revisions left to test after this +------------------------------------------------ + +and you continue along, compiling that one, testing it, and depending on +whether it is good or bad, you say "git bisect good" or "git bisect bad", +and ask for the next bisection. + +Until you have no more left, and you'll have been left with the first bad +kernel rev in "refs/bisect/bad". + +Oh, and then after you want to reset to the original head, do a + +------------------------------------------------ +git bisect reset +------------------------------------------------ + +to get back to the master branch, instead of being in one of the bisection +branches ("git bisect start" will do that for you too, actually: it will +reset the bisection state, and before it does that it checks that you're +not using some old bisection branch). + +During the bisection process, you can say + + git bisect visualize + +to see the currently remaining suspects in `gitk`. + + +Author +------ +Written by Linus Torvalds + +Documentation +-------------- +Documentation by Junio C Hamano and the git-list . + +GIT +--- +Part of the link:git.html[git] suite + diff --git a/Documentation/git-branch-script.txt b/Documentation/git-branch-script.txt deleted file mode 100644 index 3ace8adc83..0000000000 --- a/Documentation/git-branch-script.txt +++ /dev/null @@ -1,39 +0,0 @@ -git-branch-script(1) -==================== - -NAME ----- -git-branch-script - Create a new branch. - -SYNOPSIS --------- -'git-branch-script' [ [start-point]] - -DESCRIPTION ------------ -If no argument is provided, show available branches and mark current -branch with star. Otherwise, create a new branch of name . - -If a starting point is also specified, that will be where the branch is -created, otherwise it will be created at the current HEAD. - -OPTIONS -------- -:: - The name of the branch to create. - -start-point:: - Where to make the branch; defaults to HEAD. - -Author ------- -Written by Linus Torvalds and Junio C Hamano - -Documentation --------------- -Documentation by Junio C Hamano and the git-list . - -GIT ---- -Part of the link:git.html[git] suite - diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt new file mode 100644 index 0000000000..914c0e6a5a --- /dev/null +++ b/Documentation/git-branch.txt @@ -0,0 +1,39 @@ +git-branch(1) +============= + +NAME +---- +git-branch - Create a new branch. + +SYNOPSIS +-------- +'git-branch' [ [start-point]] + +DESCRIPTION +----------- +If no argument is provided, show available branches and mark current +branch with star. Otherwise, create a new branch of name . + +If a starting point is also specified, that will be where the branch is +created, otherwise it will be created at the current HEAD. + +OPTIONS +------- +:: + The name of the branch to create. + +start-point:: + Where to make the branch; defaults to HEAD. + +Author +------ +Written by Linus Torvalds and Junio C Hamano + +Documentation +-------------- +Documentation by Junio C Hamano and the git-list . + +GIT +--- +Part of the link:git.html[git] suite + diff --git a/Documentation/git-checkout-cache.txt b/Documentation/git-checkout-cache.txt deleted file mode 100644 index 321a00c251..0000000000 --- a/Documentation/git-checkout-cache.txt +++ /dev/null @@ -1,106 +0,0 @@ -git-checkout-cache(1) -===================== -v0.1, May 2005 - -NAME ----- -git-checkout-cache - Copy files from the cache to the working directory - - -SYNOPSIS --------- -'git-checkout-cache' [-u] [-q] [-a] [-f] [-n] [--prefix=] - [--] ... - -DESCRIPTION ------------ -Will copy all files listed from the cache to the working directory -(not overwriting existing files). - -OPTIONS -------- --u:: - update stat information for the checked out entries in - the cache file. - --q:: - be quiet if files exist or are not in the cache - --f:: - forces overwrite of existing files - --a:: - checks out all files in the cache (will then continue to - process listed files). - --n:: - Don't checkout new files, only refresh files already checked - out. - ---prefix=:: - When creating files, prepend (usually a directory - including a trailing /) - ---:: - Do not interpret any more arguments as options. - -Note that the order of the flags matters: - - git-checkout-cache -a -f file.c - -will first check out all files listed in the cache (but not overwrite -any old ones), and then force-checkout `file.c` a second time (ie that -one *will* overwrite any old contents with the same filename). - -Also, just doing "git-checkout-cache" does nothing. You probably meant -"git-checkout-cache -a". And if you want to force it, you want -"git-checkout-cache -f -a". - -Intuitiveness is not the goal here. Repeatability is. The reason for -the "no arguments means no work" thing is that from scripts you are -supposed to be able to do things like: - - find . -name '*.h' -print0 | xargs -0 git-checkout-cache -f -- - -which will force all existing `*.h` files to be replaced with their -cached copies. If an empty command line implied "all", then this would -force-refresh everything in the cache, which was not the point. - -To update and refresh only the files already checked out: - - git-checkout-cache -n -f -a && git-update-cache --ignore-missing --refresh - -Oh, and the "--" is just a good idea when you know the rest will be -filenames. Just so that you wouldn't have a filename of "-a" causing -problems (not possible in the above example, but get used to it in -scripting!). - -The prefix ability basically makes it trivial to use -git-checkout-cache as an "export as tree" function. Just read the -desired tree into the index, and do a - - git-checkout-cache --prefix=git-export-dir/ -a - -and git-checkout-cache will "export" the cache into the specified -directory. - -NOTE The final "/" is important. The exported name is literally just -prefixed with the specified string, so you can also do something like - - git-checkout-cache --prefix=.merged- Makefile - -to check out the currently cached copy of `Makefile` into the file -`.merged-Makefile` - -Author ------- -Written by Linus Torvalds - -Documentation --------------- -Documentation by David Greaves, Junio C Hamano and the git-list . - -GIT ---- -Part of the link:git.html[git] suite - diff --git a/Documentation/git-checkout-index.txt b/Documentation/git-checkout-index.txt new file mode 100644 index 0000000000..bb15214c98 --- /dev/null +++ b/Documentation/git-checkout-index.txt @@ -0,0 +1,106 @@ +git-checkout-index(1) +===================== +v0.1, May 2005 + +NAME +---- +git-checkout-index - Copy files from the cache to the working directory + + +SYNOPSIS +-------- +'git-checkout-index' [-u] [-q] [-a] [-f] [-n] [--prefix=] + [--] ... + +DESCRIPTION +----------- +Will copy all files listed from the cache to the working directory +(not overwriting existing files). + +OPTIONS +------- +-u:: + update stat information for the checked out entries in + the cache file. + +-q:: + be quiet if files exist or are not in the cache + +-f:: + forces overwrite of existing files + +-a:: + checks out all files in the cache (will then continue to + process listed files). + +-n:: + Don't checkout new files, only refresh files already checked + out. + +--prefix=:: + When creating files, prepend (usually a directory + including a trailing /) + +--:: + Do not interpret any more arguments as options. + +Note that the order of the flags matters: + + git-checkout-index -a -f file.c + +will first check out all files listed in the cache (but not overwrite +any old ones), and then force-checkout `file.c` a second time (ie that +one *will* overwrite any old contents with the same filename). + +Also, just doing "git-checkout-index" does nothing. You probably meant +"git-checkout-index -a". And if you want to force it, you want +"git-checkout-index -f -a". + +Intuitiveness is not the goal here. Repeatability is. The reason for +the "no arguments means no work" thing is that from scripts you are +supposed to be able to do things like: + + find . -name '*.h' -print0 | xargs -0 git-checkout-index -f -- + +which will force all existing `*.h` files to be replaced with their +cached copies. If an empty command line implied "all", then this would +force-refresh everything in the cache, which was not the point. + +To update and refresh only the files already checked out: + + git-checkout-index -n -f -a && git-update-index --ignore-missing --refresh + +Oh, and the "--" is just a good idea when you know the rest will be +filenames. Just so that you wouldn't have a filename of "-a" causing +problems (not possible in the above example, but get used to it in +scripting!). + +The prefix ability basically makes it trivial to use +git-checkout-index as an "export as tree" function. Just read the +desired tree into the index, and do a + + git-checkout-index --prefix=git-export-dir/ -a + +and git-checkout-index will "export" the cache into the specified +directory. + +NOTE The final "/" is important. The exported name is literally just +prefixed with the specified string, so you can also do something like + + git-checkout-index --prefix=.merged- Makefile + +to check out the currently cached copy of `Makefile` into the file +`.merged-Makefile` + +Author +------ +Written by Linus Torvalds + +Documentation +-------------- +Documentation by David Greaves, Junio C Hamano and the git-list . + +GIT +--- +Part of the link:git.html[git] suite + diff --git a/Documentation/git-checkout-script.txt b/Documentation/git-checkout-script.txt deleted file mode 100644 index 52831abd19..0000000000 --- a/Documentation/git-checkout-script.txt +++ /dev/null @@ -1,43 +0,0 @@ -git-checkout-script(1) -====================== - -NAME ----- -git-checkout-script - Checkout and switch to a branch. - -SYNOPSIS --------- -'git-checkout-script' [-f] [-b ] [] - -DESCRIPTION ------------ -Updates the index and working tree to reflect the specified branch, -. Updates HEAD to be or, if specified, . - -OPTIONS -------- --f:: - Force an re-read of everything. - --b:: - Create a new branch and start it at . - -:: - Name for the new branch. - -:: - Branch to checkout; may be any object ID that resolves to a - commit. Defaults to HEAD. - -Author ------- -Written by Linus Torvalds - -Documentation --------------- -Documentation by Junio C Hamano and the git-list . - -GIT ---- -Part of the link:git.html[git] suite - diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt new file mode 100644 index 0000000000..3bc7743ef6 --- /dev/null +++ b/Documentation/git-checkout.txt @@ -0,0 +1,43 @@ +git-checkout(1) +=============== + +NAME +---- +git-checkout - Checkout and switch to a branch. + +SYNOPSIS +-------- +'git-checkout' [-f] [-b ] [] + +DESCRIPTION +----------- +Updates the index and working tree to reflect the specified branch, +. Updates HEAD to be or, if specified, . + +OPTIONS +------- +-f:: + Force an re-read of everything. + +-b:: + Create a new branch and start it at . + +:: + Name for the new branch. + +:: + Branch to checkout; may be any object ID that resolves to a + commit. Defaults to HEAD. + +Author +------ +Written by Linus Torvalds + +Documentation +-------------- +Documentation by Junio C Hamano and the git-list . + +GIT +--- +Part of the link:git.html[git] suite + diff --git a/Documentation/git-cherry-pick-script.txt b/Documentation/git-cherry-pick-script.txt deleted file mode 100644 index ab9fb227da..0000000000 --- a/Documentation/git-cherry-pick-script.txt +++ /dev/null @@ -1,57 +0,0 @@ -git-cherry-pick-script(1) -========================= -v0.99.5 Aug 2005 - -NAME ----- -git-cherry-pick-script - Apply the change introduced by an existing commit. - -SYNOPSIS --------- -'git-cherry-pick-script' [-n] [-r] - -DESCRIPTION ------------ -Given one existing commit, apply the change the patch introduces, and record a -new commit that records it. This requires your working tree to be clean (no -modifications from the HEAD commit). - -OPTIONS -------- -:: - Commit to cherry-pick. - --r:: - Usuall the command appends which commit was - cherry-picked after the original commit message when - making a commit. This option, '--replay', causes it to - use the original commit message intact. This is useful - when you are reordering the patches in your private tree - before publishing, and is used by 'git rebase'. - --n:: - Usually the command automatically creates a commit with - a commit log message stating which commit was - cherry-picked. This flag applies the change necessary - to cherry-pick the named commit to your working tree, - but does not make the commit. In addition, when this - option is used, your working tree does not have to match - the HEAD commit. The cherry-pick is done against the - beginning state of your working tree. - - This is useful when cherry-picking more than one commits' - effect to your working tree in a row. - - -Author ------- -Written by Junio C Hamano - -Documentation --------------- -Documentation by Junio C Hamano and the git-list . - -GIT ---- -Part of the link:git.html[git] suite - diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt new file mode 100644 index 0000000000..38a4875248 --- /dev/null +++ b/Documentation/git-cherry-pick.txt @@ -0,0 +1,57 @@ +git-cherry-pick(1) +================== +v0.99.5 Aug 2005 + +NAME +---- +git-cherry-pick - Apply the change introduced by an existing commit. + +SYNOPSIS +-------- +'git-cherry-pick' [-n] [-r] + +DESCRIPTION +----------- +Given one existing commit, apply the change the patch introduces, and record a +new commit that records it. This requires your working tree to be clean (no +modifications from the HEAD commit). + +OPTIONS +------- +:: + Commit to cherry-pick. + +-r:: + Usuall the command appends which commit was + cherry-picked after the original commit message when + making a commit. This option, '--replay', causes it to + use the original commit message intact. This is useful + when you are reordering the patches in your private tree + before publishing, and is used by 'git rebase'. + +-n:: + Usually the command automatically creates a commit with + a commit log message stating which commit was + cherry-picked. This flag applies the change necessary + to cherry-pick the named commit to your working tree, + but does not make the commit. In addition, when this + option is used, your working tree does not have to match + the HEAD commit. The cherry-pick is done against the + beginning state of your working tree. + + This is useful when cherry-picking more than one commits' + effect to your working tree in a row. + + +Author +------ +Written by Junio C Hamano + +Documentation +-------------- +Documentation by Junio C Hamano and the git-list . + +GIT +--- +Part of the link:git.html[git] suite + diff --git a/Documentation/git-clone-script.txt b/Documentation/git-clone-script.txt deleted file mode 100644 index afb25bd83c..0000000000 --- a/Documentation/git-clone-script.txt +++ /dev/null @@ -1,60 +0,0 @@ -git-clone-script(1) -=================== -v0.1, July 2005 - -NAME ----- -git-clone-script - Clones a repository. - - -SYNOPSIS --------- -'git clone' [-l] [-u ] [-q] - -DESCRIPTION ------------ -Clones a repository into a newly created directory. - -OPTIONS -------- --l:: - When the repository to clone from is on a local machine, - this flag bypasses normal "git aware" transport - mechanism and clones the repository by making a copy of - HEAD and everything under objects and refs directories. - The files under .git/objects/ directory are hardlinked - to save space when possible. - --q:: - Operate quietly. This flag is passed to "rsync" and - "git-clone-pack" commands when given. - --u :: - When given, and the repository to clone from is handled - by 'git-clone-pack', '--exec=' is passed to - the command to specify non-default path for the command - run on the other end. - -:: - The (possibly remote) repository to clone from. It can - be an "rsync://host/dir" URL, an "http://host/dir" URL, - or [:]/dir notation that is used by 'git-clone-pack'. - Currently http transport is not supported. - -:: - The name of a new directory to be cloned into. It is an - error to specify an existing directory. - -Author ------- -Written by Linus Torvalds - -Documentation --------------- -Documentation by Junio C Hamano. - - -GIT ---- -Part of the link:git.html[git] suite - diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt new file mode 100644 index 0000000000..cff87ea1dc --- /dev/null +++ b/Documentation/git-clone.txt @@ -0,0 +1,60 @@ +git-clone(1) +============ +v0.1, July 2005 + +NAME +---- +git-clone - Clones a repository. + + +SYNOPSIS +-------- +'git clone' [-l] [-u ] [-q] + +DESCRIPTION +----------- +Clones a repository into a newly created directory. + +OPTIONS +------- +-l:: + When the repository to clone from is on a local machine, + this flag bypasses normal "git aware" transport + mechanism and clones the repository by making a copy of + HEAD and everything under objects and refs directories. + The files under .git/objects/ directory are hardlinked + to save space when possible. + +-q:: + Operate quietly. This flag is passed to "rsync" and + "git-clone-pack" commands when given. + +-u :: + When given, and the repository to clone from is handled + by 'git-clone-pack', '--exec=' is passed to + the command to specify non-default path for the command + run on the other end. + +:: + The (possibly remote) repository to clone from. It can + be an "rsync://host/dir" URL, an "http://host/dir" URL, + or [:]/dir notation that is used by 'git-clone-pack'. + Currently http transport is not supported. + +:: + The name of a new directory to be cloned into. It is an + error to specify an existing directory. + +Author +------ +Written by Linus Torvalds + +Documentation +-------------- +Documentation by Junio C Hamano. + + +GIT +--- +Part of the link:git.html[git] suite + diff --git a/Documentation/git-commit-script.txt b/Documentation/git-commit-script.txt deleted file mode 100644 index faa1870e34..0000000000 --- a/Documentation/git-commit-script.txt +++ /dev/null @@ -1,72 +0,0 @@ -git-commit-script(1) -==================== -v0.99.4, Aug 2005 - -NAME ----- -git-commit-script - Record your changes - -SYNOPSIS --------- -'git commit' [-a] [-s] [-v] [(-c | -C) | -F | -m ] [-e] ... - -DESCRIPTION ------------ -Updates the index file for given paths, or all modified files if -'-a' is specified, and makes a commit object. The command -VISUAL and EDITOR environment variables to edit the commit log -message. - -This command can run `commit-msg`, `pre-commit`, and -`post-commit` hooks. See link:hooks.html[hooks] for more -information. - -OPTIONS -------- --a:: - Update all paths in the index file. - --c or -C :: - Take existing commit object, and reuse the log message - and the authorship information (including the timestamp) - when creating the commit. With '-C', the editor is not - invoked; with '-c' the user can further edit the commit - message. - --F :: - Take the commit message from the given file. Use '-' to - read the message from the standard input. - --m :: - Use the given as the commit message. - --s:: - Add Signed-off-by line at the end of the commit message. - --v:: - Look for suspicious lines the commit introduces, and - abort committing if there is one. The definition of - 'suspicious lines' is currently the lines that has - trailing whitespaces, and the lines whose indentation - has a SP character immediately followed by a TAB - character. - --e:: - The message taken from file with `-F`, command line with - `-m`, and from file with `-C` are usually used as the - commit log message unmodified. This option lets you - further edit the message taken from these sources. - -...:: - Update specified paths in the index file before committing. - - -Author ------- -Written by Linus Torvalds and -Junio C Hamano - - -GIT ---- -Part of the link:git.html[git] suite diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt new file mode 100644 index 0000000000..afcf6ef858 --- /dev/null +++ b/Documentation/git-commit.txt @@ -0,0 +1,72 @@ +git-commit(1) +============= +v0.99.4, Aug 2005 + +NAME +---- +git-commit - Record your changes + +SYNOPSIS +-------- +'git commit' [-a] [-s] [-v] [(-c | -C) | -F | -m ] [-e] ... + +DESCRIPTION +----------- +Updates the index file for given paths, or all modified files if +'-a' is specified, and makes a commit object. The command +VISUAL and EDITOR environment variables to edit the commit log +message. + +This command can run `commit-msg`, `pre-commit`, and +`post-commit` hooks. See link:hooks.html[hooks] for more +information. + +OPTIONS +------- +-a:: + Update all paths in the index file. + +-c or -C :: + Take existing commit object, and reuse the log message + and the authorship information (including the timestamp) + when creating the commit. With '-C', the editor is not + invoked; with '-c' the user can further edit the commit + message. + +-F :: + Take the commit message from the given file. Use '-' to + read the message from the standard input. + +-m :: + Use the given as the commit message. + +-s:: + Add Signed-off-by line at the end of the commit message. + +-v:: + Look for suspicious lines the commit introduces, and + abort committing if there is one. The definition of + 'suspicious lines' is currently the lines that has + trailing whitespaces, and the lines whose indentation + has a SP character immediately followed by a TAB + character. + +-e:: + The message taken from file with `-F`, command line with + `-m`, and from file with `-C` are usually used as the + commit log message unmodified. This option lets you + further edit the message taken from these sources. + +...:: + Update specified paths in the index file before committing. + + +Author +------ +Written by Linus Torvalds and +Junio C Hamano + + +GIT +--- +Part of the link:git.html[git] suite diff --git a/Documentation/git-convert-cache.txt b/Documentation/git-convert-cache.txt deleted file mode 100644 index 66d7fe7855..0000000000 --- a/Documentation/git-convert-cache.txt +++ /dev/null @@ -1,30 +0,0 @@ -git-convert-cache(1) -==================== -v0.1, May 2005 - -NAME ----- -git-convert-cache - Converts old-style GIT repository - - -SYNOPSIS --------- -'git-convert-cache' - -DESCRIPTION ------------ -Converts old-style GIT repository to the latest format - - -Author ------- -Written by Linus Torvalds - -Documentation --------------- -Documentation by David Greaves, Junio C Hamano and the git-list . - -GIT ---- -Part of the link:git.html[git] suite - diff --git a/Documentation/git-convert-objects.txt b/Documentation/git-convert-objects.txt new file mode 100644 index 0000000000..b1bc1c5752 --- /dev/null +++ b/Documentation/git-convert-objects.txt @@ -0,0 +1,30 @@ +git-convert-objects(1) +====================== +v0.1, May 2005 + +NAME +---- +git-convert-objects - Converts old-style GIT repository + + +SYNOPSIS +-------- +'git-convert-objects' + +DESCRIPTION +----------- +Converts old-style GIT repository to the latest format + + +Author +------ +Written by Linus Torvalds + +Documentation +-------------- +Documentation by David Greaves, Junio C Hamano and the git-list . + +GIT +--- +Part of the link:git.html[git] suite + diff --git a/Documentation/git-count-objects-script.txt b/Documentation/git-count-objects-script.txt deleted file mode 100644 index 8a3cedfb5f..0000000000 --- a/Documentation/git-count-objects-script.txt +++ /dev/null @@ -1,28 +0,0 @@ -git-count-objects-script(1) -=========================== - -NAME ----- -git-count-objects-script - Reports on unpacked objects. - -SYNOPSIS --------- -'git-count-objects-script' - -DESCRIPTION ------------ -This counts the number of unpacked object files and disk space consumed by -them, to help you decide when it is a good time to repack. - -Author ------- -Written by Junio C Hamano - -Documentation --------------- -Documentation by Junio C Hamano and the git-list . - -GIT ---- -Part of the link:git.html[git] suite - diff --git a/Documentation/git-count-objects.txt b/Documentation/git-count-objects.txt new file mode 100644 index 0000000000..824852c7a1 --- /dev/null +++ b/Documentation/git-count-objects.txt @@ -0,0 +1,28 @@ +git-count-objects(1) +==================== + +NAME +---- +git-count-objects - Reports on unpacked objects. + +SYNOPSIS +-------- +'git-count-objects' + +DESCRIPTION +----------- +This counts the number of unpacked object files and disk space consumed by +them, to help you decide when it is a good time to repack. + +Author +------ +Written by Junio C Hamano + +Documentation +-------------- +Documentation by Junio C Hamano and the git-list . + +GIT +--- +Part of the link:git.html[git] suite + diff --git a/Documentation/git-cvsimport-script.txt b/Documentation/git-cvsimport-script.txt deleted file mode 100644 index 9d8acfcb13..0000000000 --- a/Documentation/git-cvsimport-script.txt +++ /dev/null @@ -1,109 +0,0 @@ -git-cvsimport-script(1) -======================= -v0.1, July 2005 - -NAME ----- -git-cvsimport-script - Import a CVS repository into git - - -SYNOPSIS --------- -'git-cvsimport-script' [ -o ] [ -h ] [ -v ] - [ -d ] [ -p ] - [ -C ] [ -i ] [ -k ] - [ -s ] [ -m ] [ -M regex ] [ ] - - -DESCRIPTION ------------ -Imports a CVS repository into git. It will either create a new -repository, or incrementally import into an existing one. - -Splitting the CVS log into patch sets is done by 'cvsps'. -At least version 2.1 is required. - -OPTIONS -------- --d :: - The root of the CVS archive. May be local (a simple path) or remote; - currently, only the :local:, :ext: and :pserver: access methods - are supported. - --C :: - The GIT repository to import to. If the directory doesn't - exist, it will be created. Default is the current directory. - --i:: - Import-only: don't perform a checkout after importing. This option - ensures the working directory and cache remain untouched and will - not create them if they do not exist. - --k:: - Kill keywords: will extract files with -kk from the CVS archive - to avoid noisy changesets. Highly recommended, but off by default - to preserve compatibility with early imported trees. - --u:: - Convert underscores in tag and branch names to dots. - --o :: - The 'HEAD' branch from CVS is imported to the 'origin' branch within - the git repository, as 'HEAD' already has a special meaning for git. - Use this option if you want to import into a different branch. - - Use '-o master' for continuing an import that was initially done by - the old cvs2git tool. - --p :: - Additional options for cvsps. - The options '-u' and '-A' are implicit and should not be used here. - - If you need to pass multiple options, separate them with a comma. - --m:: - Attempt to detect merges based on the commit message. This option - will enable default regexes that try to capture the name source - branch name from the commit message. - --M :: - Attempt to detect merges based on the commit message with a custom - regex. It can be used with -m to also see the default regexes. - You must escape forward slashes. - --v:: - Verbosity: let 'cvsimport' report what it is doing. - -:: - The CVS module you want to import. Relative to . - --h:: - Print a short usage message and exit. - --z :: - Pass the timestamp fuzz factor to cvsps. - --s :: - Substitute the character "/" in branch names with - -OUTPUT ------- -If '-v' is specified, the script reports what it is doing. - -Otherwise, success is indicated the Unix way, i.e. by simply exiting with -a zero exit status. - - -Author ------- -Written by Matthias Urlichs , with help from -various participants of the git-list . - -Documentation --------------- -Documentation by Matthias Urlichs . - -GIT ---- -Part of the link:git.html[git] suite - diff --git a/Documentation/git-cvsimport.txt b/Documentation/git-cvsimport.txt new file mode 100644 index 0000000000..edf952122f --- /dev/null +++ b/Documentation/git-cvsimport.txt @@ -0,0 +1,109 @@ +git-cvsimport(1) +================ +v0.1, July 2005 + +NAME +---- +git-cvsimport - Import a CVS repository into git + + +SYNOPSIS +-------- +'git-cvsimport' [ -o ] [ -h ] [ -v ] + [ -d ] [ -p ] + [ -C ] [ -i ] [ -k ] + [ -s ] [ -m ] [ -M regex ] [ ] + + +DESCRIPTION +----------- +Imports a CVS repository into git. It will either create a new +repository, or incrementally import into an existing one. + +Splitting the CVS log into patch sets is done by 'cvsps'. +At least version 2.1 is required. + +OPTIONS +------- +-d :: + The root of the CVS archive. May be local (a simple path) or remote; + currently, only the :local:, :ext: and :pserver: access methods + are supported. + +-C :: + The GIT repository to import to. If the directory doesn't + exist, it will be created. Default is the current directory. + +-i:: + Import-only: don't perform a checkout after importing. This option + ensures the working directory and cache remain untouched and will + not create them if they do not exist. + +-k:: + Kill keywords: will extract files with -kk from the CVS archive + to avoid noisy changesets. Highly recommended, but off by default + to preserve compatibility with early imported trees. + +-u:: + Convert underscores in tag and branch names to dots. + +-o :: + The 'HEAD' branch from CVS is imported to the 'origin' branch within + the git repository, as 'HEAD' already has a special meaning for git. + Use this option if you want to import into a different branch. + + Use '-o master' for continuing an import that was initially done by + the old cvs2git tool. + +-p :: + Additional options for cvsps. + The options '-u' and '-A' are implicit and should not be used here. + + If you need to pass multiple options, separate them with a comma. + +-m:: + Attempt to detect merges based on the commit message. This option + will enable default regexes that try to capture the name source + branch name from the commit message. + +-M :: + Attempt to detect merges based on the commit message with a custom + regex. It can be used with -m to also see the default regexes. + You must escape forward slashes. + +-v:: + Verbosity: let 'cvsimport' report what it is doing. + +:: + The CVS module you want to import. Relative to . + +-h:: + Print a short usage message and exit. + +-z :: + Pass the timestamp fuzz factor to cvsps. + +-s :: + Substitute the character "/" in branch names with + +OUTPUT +------ +If '-v' is specified, the script reports what it is doing. + +Otherwise, success is indicated the Unix way, i.e. by simply exiting with +a zero exit status. + + +Author +------ +Written by Matthias Urlichs , with help from +various participants of the git-list . + +Documentation +-------------- +Documentation by Matthias Urlichs . + +GIT +--- +Part of the link:git.html[git] suite + diff --git a/Documentation/git-diff-cache.txt b/Documentation/git-diff-cache.txt deleted file mode 100644 index a353d12628..0000000000 --- a/Documentation/git-diff-cache.txt +++ /dev/null @@ -1,134 +0,0 @@ -git-diff-cache(1) -================= -v0.1, May 2005 - -NAME ----- -git-diff-cache - Compares content and mode of blobs between the cache and repository - - -SYNOPSIS --------- -'git-diff-cache' [-m] [--cached] [] [...] - -DESCRIPTION ------------ -Compares the content and mode of the blobs found via a tree -object with the content of the current cache and, optionally -ignoring the stat state of the file on disk. When paths are -specified, compares only those named paths. Otherwise all -entries in the cache are compared. - -OPTIONS -------- -include::diff-options.txt[] - -:: - The id of a tree object to diff against. - ---cached:: - do not consider the on-disk file at all - --m:: - By default, files recorded in the index but not checked - out are reported as deleted. This flag makes - "git-diff-cache" say that all non-checked-out files are up - to date. - -Output format -------------- -include::diff-format.txt[] - -Operating Modes ---------------- -You can choose whether you want to trust the index file entirely -(using the '--cached' flag) or ask the diff logic to show any files -that don't match the stat state as being "tentatively changed". Both -of these operations are very useful indeed. - -Cached Mode ------------ -If '--cached' is specified, it allows you to ask: - - show me the differences between HEAD and the current cache - contents (the ones I'd write with a "git-write-tree") - -For example, let's say that you have worked on your working directory, updated -some files in the cache and are ready to commit. You want to see eactly -*what* you are going to commit is without having to write a new tree -object and compare it that way, and to do that, you just do - - git-diff-cache --cached $(cat .git/HEAD) - -Example: let's say I had renamed `commit.c` to `git-commit.c`, and I had -done an "git-update-cache" to make that effective in the index file. -"git-diff-files" wouldn't show anything at all, since the index file -matches my working directory. But doing a "git-diff-cache" does: - - torvalds@ppc970:~/git> git-diff-cache --cached $(cat .git/HEAD) - -100644 blob 4161aecc6700a2eb579e842af0b7f22b98443f74 commit.c - +100644 blob 4161aecc6700a2eb579e842af0b7f22b98443f74 git-commit.c - -You can trivially see that the above is a rename. - -In fact, "git-diff-cache --cached" *should* always be entirely equivalent to -actually doing a "git-write-tree" and comparing that. Except this one is much -nicer for the case where you just want to check where you are. - -So doing a "git-diff-cache --cached" is basically very useful when you are -asking yourself "what have I already marked for being committed, and -what's the difference to a previous tree". - -Non-cached Mode ---------------- -The "non-cached" mode takes a different approach, and is potentially -the more useful of the two in that what it does can't be emulated with -a "git-write-tree" + "git-diff-tree". Thus that's the default mode. -The non-cached version asks the question: - - show me the differences between HEAD and the currently checked out - tree - index contents _and_ files that aren't up-to-date - -which is obviously a very useful question too, since that tells you what -you *could* commit. Again, the output matches the "git-diff-tree -r" -output to a tee, but with a twist. - -The twist is that if some file doesn't match the cache, we don't have -a backing store thing for it, and we use the magic "all-zero" sha1 to -show that. So let's say that you have edited `kernel/sched.c`, but -have not actually done a "git-update-cache" on it yet - there is no -"object" associated with the new state, and you get: - - torvalds@ppc970:~/v2.6/linux> git-diff-cache $(cat .git/HEAD ) - *100644->100664 blob 7476bb......->000000...... kernel/sched.c - -ie it shows that the tree has changed, and that `kernel/sched.c` has is -not up-to-date and may contain new stuff. The all-zero sha1 means that to -get the real diff, you need to look at the object in the working directory -directly rather than do an object-to-object diff. - -NOTE! As with other commands of this type, "git-diff-cache" does not -actually look at the contents of the file at all. So maybe -`kernel/sched.c` hasn't actually changed, and it's just that you -touched it. In either case, it's a note that you need to -"git-upate-cache" it to make the cache be in sync. - -NOTE 2! You can have a mixture of files show up as "has been updated" -and "is still dirty in the working directory" together. You can always -tell which file is in which state, since the "has been updated" ones -show a valid sha1, and the "not in sync with the index" ones will -always have the special all-zero sha1. - - -Author ------- -Written by Linus Torvalds - -Documentation --------------- -Documentation by David Greaves, Junio C Hamano and the git-list . - -GIT ---- -Part of the link:git.html[git] suite - diff --git a/Documentation/git-diff-files.txt b/Documentation/git-diff-files.txt index 3e1244f8d3..72c7a718f5 100644 --- a/Documentation/git-diff-files.txt +++ b/Documentation/git-diff-files.txt @@ -16,7 +16,7 @@ DESCRIPTION Compares the files in the working tree and the cache. When paths are specified, compares only those named paths. Otherwise all entries in the cache are compared. The output format is the -same as "git-diff-cache" and "git-diff-tree". +same as "git-diff-index" and "git-diff-tree". OPTIONS ------- diff --git a/Documentation/git-diff-helper.txt b/Documentation/git-diff-helper.txt index d826deb42e..26f5f3950a 100644 --- a/Documentation/git-diff-helper.txt +++ b/Documentation/git-diff-helper.txt @@ -13,7 +13,7 @@ SYNOPSIS DESCRIPTION ----------- -Reads output from "git-diff-cache", "git-diff-tree" and "git-diff-files" and +Reads output from "git-diff-index", "git-diff-tree" and "git-diff-files" and generates patch format output. OPTIONS @@ -35,7 +35,7 @@ OPTIONS See Also -------- -The section on generating patches in link:git-diff-cache.html[git-diff-cache] +The section on generating patches in link:git-diff-index.html[git-diff-index] Author diff --git a/Documentation/git-diff-index.txt b/Documentation/git-diff-index.txt new file mode 100644 index 0000000000..12bfcb3243 --- /dev/null +++ b/Documentation/git-diff-index.txt @@ -0,0 +1,134 @@ +git-diff-index(1) +================= +v0.1, May 2005 + +NAME +---- +git-diff-index - Compares content and mode of blobs between the cache and repository + + +SYNOPSIS +-------- +'git-diff-index' [-m] [--cached] [] [...] + +DESCRIPTION +----------- +Compares the content and mode of the blobs found via a tree +object with the content of the current cache and, optionally +ignoring the stat state of the file on disk. When paths are +specified, compares only those named paths. Otherwise all +entries in the cache are compared. + +OPTIONS +------- +include::diff-options.txt[] + +:: + The id of a tree object to diff against. + +--cached:: + do not consider the on-disk file at all + +-m:: + By default, files recorded in the index but not checked + out are reported as deleted. This flag makes + "git-diff-index" say that all non-checked-out files are up + to date. + +Output format +------------- +include::diff-format.txt[] + +Operating Modes +--------------- +You can choose whether you want to trust the index file entirely +(using the '--cached' flag) or ask the diff logic to show any files +that don't match the stat state as being "tentatively changed". Both +of these operations are very useful indeed. + +Cached Mode +----------- +If '--cached' is specified, it allows you to ask: + + show me the differences between HEAD and the current cache + contents (the ones I'd write with a "git-write-tree") + +For example, let's say that you have worked on your working directory, updated +some files in the cache and are ready to commit. You want to see eactly +*what* you are going to commit is without having to write a new tree +object and compare it that way, and to do that, you just do + + git-diff-index --cached $(cat .git/HEAD) + +Example: let's say I had renamed `commit.c` to `git-commit.c`, and I had +done an "git-update-index" to make that effective in the index file. +"git-diff-files" wouldn't show anything at all, since the index file +matches my working directory. But doing a "git-diff-index" does: + + torvalds@ppc970:~/git> git-diff-index --cached $(cat .git/HEAD) + -100644 blob 4161aecc6700a2eb579e842af0b7f22b98443f74 commit.c + +100644 blob 4161aecc6700a2eb579e842af0b7f22b98443f74 git-commit.c + +You can trivially see that the above is a rename. + +In fact, "git-diff-index --cached" *should* always be entirely equivalent to +actually doing a "git-write-tree" and comparing that. Except this one is much +nicer for the case where you just want to check where you are. + +So doing a "git-diff-index --cached" is basically very useful when you are +asking yourself "what have I already marked for being committed, and +what's the difference to a previous tree". + +Non-cached Mode +--------------- +The "non-cached" mode takes a different approach, and is potentially +the more useful of the two in that what it does can't be emulated with +a "git-write-tree" + "git-diff-tree". Thus that's the default mode. +The non-cached version asks the question: + + show me the differences between HEAD and the currently checked out + tree - index contents _and_ files that aren't up-to-date + +which is obviously a very useful question too, since that tells you what +you *could* commit. Again, the output matches the "git-diff-tree -r" +output to a tee, but with a twist. + +The twist is that if some file doesn't match the cache, we don't have +a backing store thing for it, and we use the magic "all-zero" sha1 to +show that. So let's say that you have edited `kernel/sched.c`, but +have not actually done a "git-update-index" on it yet - there is no +"object" associated with the new state, and you get: + + torvalds@ppc970:~/v2.6/linux> git-diff-index $(cat .git/HEAD ) + *100644->100664 blob 7476bb......->000000...... kernel/sched.c + +ie it shows that the tree has changed, and that `kernel/sched.c` has is +not up-to-date and may contain new stuff. The all-zero sha1 means that to +get the real diff, you need to look at the object in the working directory +directly rather than do an object-to-object diff. + +NOTE! As with other commands of this type, "git-diff-index" does not +actually look at the contents of the file at all. So maybe +`kernel/sched.c` hasn't actually changed, and it's just that you +touched it. In either case, it's a note that you need to +"git-upate-cache" it to make the cache be in sync. + +NOTE 2! You can have a mixture of files show up as "has been updated" +and "is still dirty in the working directory" together. You can always +tell which file is in which state, since the "has been updated" ones +show a valid sha1, and the "not in sync with the index" ones will +always have the special all-zero sha1. + + +Author +------ +Written by Linus Torvalds + +Documentation +-------------- +Documentation by David Greaves, Junio C Hamano and the git-list . + +GIT +--- +Part of the link:git.html[git] suite + diff --git a/Documentation/git-diff-script.txt b/Documentation/git-diff-script.txt deleted file mode 100644 index 64acdc0c06..0000000000 --- a/Documentation/git-diff-script.txt +++ /dev/null @@ -1,38 +0,0 @@ -git-diff-script(1) -================== - -NAME ----- -git-diff-script - Some git command not yet documented. - - -SYNOPSIS --------- -'git-diff-script' [ --option ] ... - -DESCRIPTION ------------ -Does something not yet documented. - - -OPTIONS -------- ---option:: - Some option not yet documented. - -...:: - Some argument not yet documented. - - -Author ------- -Written by Linus Torvalds - -Documentation --------------- -Documentation by Junio C Hamano and the git-list . - -GIT ---- -Part of the link:git.html[git] suite - diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt index 5ccf0ba129..9ec4b29ff7 100644 --- a/Documentation/git-diff-tree.txt +++ b/Documentation/git-diff-tree.txt @@ -93,7 +93,7 @@ so it can be used to name subdirectories. An example of normal usage is: torvalds@ppc970:~/git> git-diff-tree 5319e4...... - *100664->100664 blob ac348b.......->a01513....... git-fsck-cache.c + *100664->100664 blob ac348b.......->a01513....... git-fsck-objects.c which tells you that the last commit changed just one file (it's from this one: @@ -104,7 +104,7 @@ this one: author Linus Torvalds Sat Apr 9 12:02:30 2005 committer Linus Torvalds Sat Apr 9 12:02:30 2005 - Make "git-fsck-cache" print out all the root commits it finds. + Make "git-fsck-objects" print out all the root commits it finds. Once I do the reference tracking, I'll also make it print out all the HEAD commits it finds, which is even more interesting. diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt new file mode 100644 index 0000000000..f43a60f4f1 --- /dev/null +++ b/Documentation/git-diff.txt @@ -0,0 +1,38 @@ +git-diff(1) +=========== + +NAME +---- +git-diff - Some git command not yet documented. + + +SYNOPSIS +-------- +'git-diff' [ --option ] ... + +DESCRIPTION +----------- +Does something not yet documented. + + +OPTIONS +------- +--option:: + Some option not yet documented. + +...:: + Some argument not yet documented. + + +Author +------ +Written by Linus Torvalds + +Documentation +-------------- +Documentation by Junio C Hamano and the git-list . + +GIT +--- +Part of the link:git.html[git] suite + diff --git a/Documentation/git-fetch-script.txt b/Documentation/git-fetch-script.txt deleted file mode 100644 index d15222b561..0000000000 --- a/Documentation/git-fetch-script.txt +++ /dev/null @@ -1,41 +0,0 @@ -git-fetch-script(1) -=================== -v0.99.5, Aug 2005 - -NAME ----- -git-fetch-script - Download objects and a head from another repository. - - -SYNOPSIS --------- -'git-fetch-script' ... - - -DESCRIPTION ------------ -Fetches named heads or tags from another repository, along with -the objects necessary to complete them. - -The ref names and their object names of fetched refs are stored -in $GIT_DIR/FETCH_HEAD. This information is left for a later merge -operation done by "git resolve" or "git octopus". - - -OPTIONS -------- -include::pull-fetch-param.txt[] - - -Author ------- -Written by Linus Torvalds and -Junio C Hamano - -Documentation --------------- -Documentation by David Greaves, Junio C Hamano and the git-list . - -GIT ---- -Part of the link:git.html[git] suite diff --git a/Documentation/git-fetch.txt b/Documentation/git-fetch.txt new file mode 100644 index 0000000000..017f646601 --- /dev/null +++ b/Documentation/git-fetch.txt @@ -0,0 +1,41 @@ +git-fetch(1) +============ +v0.99.5, Aug 2005 + +NAME +---- +git-fetch - Download objects and a head from another repository. + + +SYNOPSIS +-------- +'git-fetch' ... + + +DESCRIPTION +----------- +Fetches named heads or tags from another repository, along with +the objects necessary to complete them. + +The ref names and their object names of fetched refs are stored +in $GIT_DIR/FETCH_HEAD. This information is left for a later merge +operation done by "git resolve" or "git octopus". + + +OPTIONS +------- +include::pull-fetch-param.txt[] + + +Author +------ +Written by Linus Torvalds and +Junio C Hamano + +Documentation +-------------- +Documentation by David Greaves, Junio C Hamano and the git-list . + +GIT +--- +Part of the link:git.html[git] suite diff --git a/Documentation/git-format-patch-script.txt b/Documentation/git-format-patch-script.txt deleted file mode 100644 index ae3b8a113d..0000000000 --- a/Documentation/git-format-patch-script.txt +++ /dev/null @@ -1,38 +0,0 @@ -git-format-patch-script(1) -========================== - -NAME ----- -git-format-patch-script - Some git command not yet documented. - - -SYNOPSIS --------- -'git-format-patch-script' [ --option ] ... - -DESCRIPTION ------------ -Does something not yet documented. - - -OPTIONS -------- ---option:: - Some option not yet documented. - -...:: - Some argument not yet documented. - - -Author ------- -Written by Junio C Hamano - -Documentation --------------- -Documentation by Junio C Hamano and the git-list . - -GIT ---- -Part of the link:git.html[git] suite - diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt new file mode 100644 index 0000000000..1788a97b70 --- /dev/null +++ b/Documentation/git-format-patch.txt @@ -0,0 +1,38 @@ +git-format-patch(1) +=================== + +NAME +---- +git-format-patch - Some git command not yet documented. + + +SYNOPSIS +-------- +'git-format-patch' [ --option ] ... + +DESCRIPTION +----------- +Does something not yet documented. + + +OPTIONS +------- +--option:: + Some option not yet documented. + +...:: + Some argument not yet documented. + + +Author +------ +Written by Junio C Hamano + +Documentation +-------------- +Documentation by Junio C Hamano and the git-list . + +GIT +--- +Part of the link:git.html[git] suite + diff --git a/Documentation/git-fsck-cache.txt b/Documentation/git-fsck-cache.txt deleted file mode 100644 index 13f19653fe..0000000000 --- a/Documentation/git-fsck-cache.txt +++ /dev/null @@ -1,145 +0,0 @@ -git-fsck-cache(1) -================= -v0.1, May 2005 - -NAME ----- -git-fsck-cache - Verifies the connectivity and validity of the objects in the database - - -SYNOPSIS --------- -'git-fsck-cache' [--tags] [--root] [--unreachable] [--cache] [--standalone | --full] [--strict] [*] - -DESCRIPTION ------------ -Verifies the connectivity and validity of the objects in the database. - -OPTIONS -------- -:: - An object to treat as the head of an unreachability trace. - - If no objects are given, git-fsck-cache defaults to using the - index file and all SHA1 references in .git/refs/* as heads. - ---unreachable:: - Print out objects that exist but that aren't readable from any - of the reference nodes. - ---root:: - Report root nodes. - ---tags:: - Report tags. - ---cache:: - Consider any object recorded in the cache also as a head node for - an unreachability trace. - ---standalone:: - Limit checks to the contents of GIT_OBJECT_DIRECTORY - ($GIT_DIR/objects), making sure that it is consistent and - complete without referring to objects found in alternate - object pools listed in GIT_ALTERNATE_OBJECT_DIRECTORIES, - nor packed GIT archives found in $GIT_DIR/objects/pack; - cannot be used with --full. - ---full:: - Check not just objects in GIT_OBJECT_DIRECTORY - ($GIT_DIR/objects), but also the ones found in alternate - object pools listed in GIT_ALTERNATE_OBJECT_DIRECTORIES, - and in packed GIT archives found in $GIT_DIR/objects/pack - and corresponding pack subdirectories in alternate - object pools; cannot be used with --standalone. - ---strict:: - Enable more strict checking, namely to catch a file mode - recorded with g+w bit set, which was created by older - versions of GIT. Existing repositories, including the - Linux kernel, GIT itself, and sparse repository have old - objects that triggers this check, but it is recommended - to check new projects with this flag. - -It tests SHA1 and general object sanity, and it does full tracking of -the resulting reachability and everything else. It prints out any -corruption it finds (missing or bad objects), and if you use the -'--unreachable' flag it will also print out objects that exist but -that aren't readable from any of the specified head nodes. - -So for example - - git-fsck-cache --unreachable $(cat .git/HEAD .git/refs/heads/*) - -will do quite a _lot_ of verification on the tree. There are a few -extra validity tests to be added (make sure that tree objects are -sorted properly etc), but on the whole if "git-fsck-cache" is happy, you -do have a valid tree. - -Any corrupt objects you will have to find in backups or other archives -(ie you can just remove them and do an "rsync" with some other site in -the hopes that somebody else has the object you have corrupted). - -Of course, "valid tree" doesn't mean that it wasn't generated by some -evil person, and the end result might be crap. Git is a revision -tracking system, not a quality assurance system ;) - -Extracted Diagnostics ---------------------- - -expect dangling commits - potential heads - due to lack of head information:: - You haven't specified any nodes as heads so it won't be - possible to differentiate between un-parented commits and - root nodes. - -missing sha1 directory '':: - The directory holding the sha1 objects is missing. - -unreachable :: - The object , isn't actually referred to directly - or indirectly in any of the trees or commits seen. This can - mean that there's another root node that you're not specifying - or that the tree is corrupt. If you haven't missed a root node - then you might as well delete unreachable nodes since they - can't be used. - -missing :: - The object , is referred to but isn't present in - the database. - -dangling :: - The object , is present in the database but never - 'directly' used. A dangling commit could be a root node. - -warning: git-fsck-cache: tree has full pathnames in it:: - And it shouldn't... - -sha1 mismatch :: - The database has an object who's sha1 doesn't match the - database value. - This indicates a serious data integrity problem. - -Environment Variables ---------------------- - -GIT_OBJECT_DIRECTORY:: - used to specify the object database root (usually $GIT_DIR/objects) - -GIT_INDEX_FILE:: - used to specify the index file of the cache - -GIT_ALTERNATE_OBJECT_DIRECTORIES: - used to specify additional object database roots (usually unset) - -Author ------- -Written by Linus Torvalds - -Documentation --------------- -Documentation by David Greaves, Junio C Hamano and the git-list . - -GIT ---- -Part of the link:git.html[git] suite - diff --git a/Documentation/git-fsck-objects.txt b/Documentation/git-fsck-objects.txt new file mode 100644 index 0000000000..2b8640439b --- /dev/null +++ b/Documentation/git-fsck-objects.txt @@ -0,0 +1,145 @@ +git-fsck-objects(1) +=================== +v0.1, May 2005 + +NAME +---- +git-fsck-objects - Verifies the connectivity and validity of the objects in the database + + +SYNOPSIS +-------- +'git-fsck-objects' [--tags] [--root] [--unreachable] [--cache] [--standalone | --full] [--strict] [*] + +DESCRIPTION +----------- +Verifies the connectivity and validity of the objects in the database. + +OPTIONS +------- +:: + An object to treat as the head of an unreachability trace. + + If no objects are given, git-fsck-objects defaults to using the + index file and all SHA1 references in .git/refs/* as heads. + +--unreachable:: + Print out objects that exist but that aren't readable from any + of the reference nodes. + +--root:: + Report root nodes. + +--tags:: + Report tags. + +--cache:: + Consider any object recorded in the cache also as a head node for + an unreachability trace. + +--standalone:: + Limit checks to the contents of GIT_OBJECT_DIRECTORY + ($GIT_DIR/objects), making sure that it is consistent and + complete without referring to objects found in alternate + object pools listed in GIT_ALTERNATE_OBJECT_DIRECTORIES, + nor packed GIT archives found in $GIT_DIR/objects/pack; + cannot be used with --full. + +--full:: + Check not just objects in GIT_OBJECT_DIRECTORY + ($GIT_DIR/objects), but also the ones found in alternate + object pools listed in GIT_ALTERNATE_OBJECT_DIRECTORIES, + and in packed GIT archives found in $GIT_DIR/objects/pack + and corresponding pack subdirectories in alternate + object pools; cannot be used with --standalone. + +--strict:: + Enable more strict checking, namely to catch a file mode + recorded with g+w bit set, which was created by older + versions of GIT. Existing repositories, including the + Linux kernel, GIT itself, and sparse repository have old + objects that triggers this check, but it is recommended + to check new projects with this flag. + +It tests SHA1 and general object sanity, and it does full tracking of +the resulting reachability and everything else. It prints out any +corruption it finds (missing or bad objects), and if you use the +'--unreachable' flag it will also print out objects that exist but +that aren't readable from any of the specified head nodes. + +So for example + + git-fsck-objects --unreachable $(cat .git/HEAD .git/refs/heads/*) + +will do quite a _lot_ of verification on the tree. There are a few +extra validity tests to be added (make sure that tree objects are +sorted properly etc), but on the whole if "git-fsck-objects" is happy, you +do have a valid tree. + +Any corrupt objects you will have to find in backups or other archives +(ie you can just remove them and do an "rsync" with some other site in +the hopes that somebody else has the object you have corrupted). + +Of course, "valid tree" doesn't mean that it wasn't generated by some +evil person, and the end result might be crap. Git is a revision +tracking system, not a quality assurance system ;) + +Extracted Diagnostics +--------------------- + +expect dangling commits - potential heads - due to lack of head information:: + You haven't specified any nodes as heads so it won't be + possible to differentiate between un-parented commits and + root nodes. + +missing sha1 directory '':: + The directory holding the sha1 objects is missing. + +unreachable :: + The object , isn't actually referred to directly + or indirectly in any of the trees or commits seen. This can + mean that there's another root node that you're not specifying + or that the tree is corrupt. If you haven't missed a root node + then you might as well delete unreachable nodes since they + can't be used. + +missing :: + The object , is referred to but isn't present in + the database. + +dangling :: + The object , is present in the database but never + 'directly' used. A dangling commit could be a root node. + +warning: git-fsck-objects: tree has full pathnames in it:: + And it shouldn't... + +sha1 mismatch :: + The database has an object who's sha1 doesn't match the + database value. + This indicates a serious data integrity problem. + +Environment Variables +--------------------- + +GIT_OBJECT_DIRECTORY:: + used to specify the object database root (usually $GIT_DIR/objects) + +GIT_INDEX_FILE:: + used to specify the index file of the cache + +GIT_ALTERNATE_OBJECT_DIRECTORIES: + used to specify additional object database roots (usually unset) + +Author +------ +Written by Linus Torvalds + +Documentation +-------------- +Documentation by David Greaves, Junio C Hamano and the git-list . + +GIT +--- +Part of the link:git.html[git] suite + diff --git a/Documentation/git-hash-object.txt b/Documentation/git-hash-object.txt index a77adab143..4dd06f7c89 100644 --- a/Documentation/git-hash-object.txt +++ b/Documentation/git-hash-object.txt @@ -17,7 +17,7 @@ Computes the object ID value for an object with specified type with the contents of the named file (which can be outside of the work tree), and optionally writes the resulting object into the object database. Reports its object ID to its standard output. -This is used by "git-cvsimport-script" to update the cache +This is used by "git-cvsimport" to update the cache without modifying files in the work tree. When is not specified, it defaults to "blob". diff --git a/Documentation/git-http-fetch.txt b/Documentation/git-http-fetch.txt new file mode 100644 index 0000000000..9cd862e03d --- /dev/null +++ b/Documentation/git-http-fetch.txt @@ -0,0 +1,42 @@ +git-http-fetch(1) +================= +v0.1, May 2005 + +NAME +---- +git-http-fetch - Downloads a remote GIT repository via HTTP + + +SYNOPSIS +-------- +'git-http-fetch' [-c] [-t] [-a] [-d] [-v] [-w filename] [--recover] commit-id url + +DESCRIPTION +----------- +Downloads a remote GIT repository via HTTP. + +-c:: + Get the commit objects. +-t:: + Get trees associated with the commit objects. +-a:: + Get all the objects. +-v:: + Report what is downloaded. + +-w :: + Writes the commit-id into the filename under $GIT_DIR/refs/ on + the local end after the transfer is complete. + +Author +------ +Written by Linus Torvalds + +Documentation +-------------- +Documentation by David Greaves, Junio C Hamano and the git-list . + +GIT +--- +Part of the link:git.html[git] suite + diff --git a/Documentation/git-http-pull.txt b/Documentation/git-http-pull.txt deleted file mode 100644 index edc5cebf7c..0000000000 --- a/Documentation/git-http-pull.txt +++ /dev/null @@ -1,42 +0,0 @@ -git-http-pull(1) -================ -v0.1, May 2005 - -NAME ----- -git-http-pull - Downloads a remote GIT repository via HTTP - - -SYNOPSIS --------- -'git-http-pull' [-c] [-t] [-a] [-d] [-v] [-w filename] [--recover] commit-id url - -DESCRIPTION ------------ -Downloads a remote GIT repository via HTTP. - --c:: - Get the commit objects. --t:: - Get trees associated with the commit objects. --a:: - Get all the objects. --v:: - Report what is downloaded. - --w :: - Writes the commit-id into the filename under $GIT_DIR/refs/ on - the local end after the transfer is complete. - -Author ------- -Written by Linus Torvalds - -Documentation --------------- -Documentation by David Greaves, Junio C Hamano and the git-list . - -GIT ---- -Part of the link:git.html[git] suite - diff --git a/Documentation/git-local-fetch.txt b/Documentation/git-local-fetch.txt new file mode 100644 index 0000000000..aad7d99af1 --- /dev/null +++ b/Documentation/git-local-fetch.txt @@ -0,0 +1,44 @@ +git-local-fetch(1) +================== +v0.1, May 2005 + +NAME +---- +git-local-fetch - Duplicates another GIT repository on a local system + + +SYNOPSIS +-------- +'git-local-fetch' [-c] [-t] [-a] [-d] [-v] [-w filename] [--recover] [-l] [-s] [-n] commit-id path + +DESCRIPTION +----------- +Duplicates another GIT repository on a local system. + +OPTIONS +------- +-c:: + Get the commit objects. +-t:: + Get trees associated with the commit objects. +-a:: + Get all the objects. +-v:: + Report what is downloaded. + +-w :: + Writes the commit-id into the filename under $GIT_DIR/refs/ on + the local end after the transfer is complete. + +Author +------ +Written by Junio C Hamano + +Documentation +-------------- +Documentation by David Greaves, Junio C Hamano and the git-list . + +GIT +--- +Part of the link:git.html[git] suite + diff --git a/Documentation/git-local-pull.txt b/Documentation/git-local-pull.txt deleted file mode 100644 index 4651e81581..0000000000 --- a/Documentation/git-local-pull.txt +++ /dev/null @@ -1,44 +0,0 @@ -git-local-pull(1) -================= -v0.1, May 2005 - -NAME ----- -git-local-pull - Duplicates another GIT repository on a local system - - -SYNOPSIS --------- -'git-local-pull' [-c] [-t] [-a] [-d] [-v] [-w filename] [--recover] [-l] [-s] [-n] commit-id path - -DESCRIPTION ------------ -Duplicates another GIT repository on a local system. - -OPTIONS -------- --c:: - Get the commit objects. --t:: - Get trees associated with the commit objects. --a:: - Get all the objects. --v:: - Report what is downloaded. - --w :: - Writes the commit-id into the filename under $GIT_DIR/refs/ on - the local end after the transfer is complete. - -Author ------- -Written by Junio C Hamano - -Documentation --------------- -Documentation by David Greaves, Junio C Hamano and the git-list . - -GIT ---- -Part of the link:git.html[git] suite - diff --git a/Documentation/git-log-script.txt b/Documentation/git-log-script.txt deleted file mode 100644 index ed359bec86..0000000000 --- a/Documentation/git-log-script.txt +++ /dev/null @@ -1,45 +0,0 @@ -git-log-script(1) -================= -v0.99.4, Aug 2005 - -NAME ----- -git-log-script - Show commit logs - - -SYNOPSIS --------- -'git log'