X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=Documentation%2Fgit-read-tree.txt;h=5653baccaffe888bc5a238e0fef8212045ab187d;hb=df8baa42fe4eeb5a021ac262caf601f44d2a5746;hp=7665946f805c71ef38b1ed616108d189dbc2c1cf;hpb=638ccfdf0eeabf3d985426308b2a82db6207ae28;p=git.git diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt index 7665946f..5653bacc 100644 --- a/Documentation/git-read-tree.txt +++ b/Documentation/git-read-tree.txt @@ -9,14 +9,14 @@ git-read-tree - Reads tree information into the directory cache SYNOPSIS -------- -'git-read-tree' ( | [-m [-u]] [ []]) +'git-read-tree' ( | [-m [-u|-i]] [ []]) DESCRIPTION ----------- Reads the tree information given by into the directory cache, but does not actually *update* any of the files it "caches". (see: -git-checkout-cache) +git-checkout-index) Optionally, it can merge a tree into the cache, perform a fast-forward (i.e. 2-way) merge, or a 3-way merge, with the -m @@ -35,13 +35,23 @@ OPTIONS After a successful merge, update the files in the work tree with the result of the merge. +-i:: + Usually a merge requires the index file as well as the + files in the working tree are up to date with the + current head commit, in order not to lose local + changes. This flag disables the check with the working + tree and is meant to be used when creating a merge of + trees that are not directly related to the current + working tree status into a temporary index file. + + :: The id of the tree object(s) to be read/merged. Merging ------- -If '-m' is specified, "git-read-tree" can performs 3 kinds of +If '-m' is specified, "git-read-tree" can perform 3 kinds of merge, a single tree merge if only 1 tree is given, a fast-forward merge with 2 trees, or a 3-way merge if 3 trees are provided. @@ -51,12 +61,12 @@ Single Tree Merge ~~~~~~~~~~~~~~~~~ If only 1 tree is specified, git-read-tree operates as if the user did not specify '-m', except that if the original cache has an entry for a -given pathname; and the contents of the path matches with the tree +given pathname, and the contents of the path matches with the tree being read, the stat info from the cache is used. (In other words, the -cache's stat()s take precedence over the merged tree's) +cache's stat()s take precedence over the merged tree's). That means that if you do a "git-read-tree -m " followed by a -"git-checkout-cache -f -u -a", the "git-checkout-cache" only checks out +"git-checkout-index -f -u -a", the "git-checkout-index" only checks out the stuff that really changed. This is used to avoid unnecessary false hits when "git-diff-files" is @@ -74,10 +84,10 @@ fast forward situation). When two trees are specified, the user is telling git-read-tree the following: - (1) The current index and work tree is derived from $H, but + 1. The current index and work tree is derived from $H, but the user may have local changes in them since $H; - (2) The user wants to fast-forward to $M. + 2. The user wants to fast-forward to $M. In this case, the "git-read-tree -m $H $M" command makes sure that no local change is lost as the result of this "merge". @@ -126,13 +136,13 @@ operating under the -u flag. When this form of git-read-tree returns successfully, you can see what "local changes" you made are carried forward by running -"git-diff-cache --cached $M". Note that this does not -necessarily match "git-diff-cache --cached $H" would have +"git-diff-index --cached $M". Note that this does not +necessarily match "git-diff-index --cached $H" would have produced before such a two tree merge. This is because of cases 18 and 19 --- if you already had the changes in $M (e.g. maybe -you picked it up via e-mail in a patch form), "git-diff-cache +you picked it up via e-mail in a patch form), "git-diff-index --cached $H" would have told you about the change before this -merge, but it would not show in "git-diff-cache --cached $M" +merge, but it would not show in "git-diff-index --cached $M" output after two-tree merge. @@ -184,7 +194,7 @@ populated. Here is an outline of how the algorithm works: automatically collapse to "merged" state by git-read-tree. - a file that has _any_ difference what-so-ever in the three trees - will stay as separate entries in the index. It's up to "script + will stay as separate entries in the index. It's up to "porcelain policy" to determine how to remove the non-0 stages, and insert a merged version. @@ -205,8 +215,8 @@ populated. Here is an outline of how the algorithm works: matching "stage1" entry if it exists too. .. all the normal trivial rules .. -You would normally use "git-merge-cache" with supplied -"git-merge-one-file-script" to do this last step. The script +You would normally use "git-merge-index" with supplied +"git-merge-one-file" to do this last step. The script does not touch the files in the work tree, and the entire merge happens in the index file. In other words, there is no need to worry about what is in the working directory, since it is never @@ -225,13 +235,13 @@ changes. To illustrate, suppose you start from what has been commited last to your repository: $ JC=`cat .git/HEAD` - $ git-checkout-cache -f -u -a $JC + $ git-checkout-index -f -u -a $JC -You do random edits, without running git-update-cache. And then +You do random edits, without running git-update-index. And then you notice that the tip of your "upstream" tree has advanced since you pulled from him: - $ git-fetch-script rsync://.... linus + $ git-fetch rsync://.... linus $ LT=`cat .git/MERGE_HEAD` Your work tree is still based on your HEAD ($JC), but you have @@ -240,7 +250,7 @@ added or modified cache entries since $JC, and if you haven't, then does the right thing. So with the following sequence: $ git-read-tree -m -u `git-merge-base $JC $LT` $JC $LT - $ git-merge-cache git-merge-one-file-script -a + $ git-merge-index git-merge-one-file -a $ echo "Merge with Linus" | \ git-commit-tree `git-write-tree` -p $JC -p $LT @@ -251,7 +261,7 @@ updated to the result of the merge. See Also -------- -link:git-write-tree.html[git-write-tree]; link:git-ls-files.html[git-ls-files] +gitlink:git-write-tree[1]; gitlink:git-ls-files[1] Author @@ -264,5 +274,5 @@ Documentation by David Greaves, Junio C Hamano and the git-list