Move setup_diff_pager to libgit.a
[git/jnareb-git.git] / Documentation / git-read-tree.txt
blobc4bde6509e5a2f652dca9345a3a28e9e674c216a
1 git-read-tree(1)
2 ================
4 NAME
5 ----
6 git-read-tree - Reads tree information into the index
9 SYNOPSIS
10 --------
11 [verse]
12 'git read-tree' [[-m [--trivial] [--aggressive] | --reset | --prefix=<prefix>]
13                 [-u [--exclude-per-directory=<gitignore>] | -i]]
14                 [--index-output=<file>] [--no-sparse-checkout]
15                 (--empty | <tree-ish1> [<tree-ish2> [<tree-ish3>]])
18 DESCRIPTION
19 -----------
20 Reads the tree information given by <tree-ish> into the index,
21 but does not actually *update* any of the files it "caches". (see:
22 linkgit:git-checkout-index[1])
24 Optionally, it can merge a tree into the index, perform a
25 fast-forward (i.e. 2-way) merge, or a 3-way merge, with the `-m`
26 flag.  When used with `-m`, the `-u` flag causes it to also update
27 the files in the work tree with the result of the merge.
29 Trivial merges are done by 'git read-tree' itself.  Only conflicting paths
30 will be in unmerged state when 'git read-tree' returns.
32 OPTIONS
33 -------
34 -m::
35         Perform a merge, not just a read.  The command will
36         refuse to run if your index file has unmerged entries,
37         indicating that you have not finished previous merge you
38         started.
40 --reset::
41         Same as -m, except that unmerged entries are discarded
42         instead of failing.
44 -u::
45         After a successful merge, update the files in the work
46         tree with the result of the merge.
48 -i::
49         Usually a merge requires the index file as well as the
50         files in the working tree to be up to date with the
51         current head commit, in order not to lose local
52         changes.  This flag disables the check with the working
53         tree and is meant to be used when creating a merge of
54         trees that are not directly related to the current
55         working tree status into a temporary index file.
57 -n::
58 --dry-run::
59         Check if the command would error out, without updating the index
60         nor the files in the working tree for real.
62 -v::
63         Show the progress of checking files out.
65 --trivial::
66         Restrict three-way merge by 'git read-tree' to happen
67         only if there is no file-level merging required, instead
68         of resolving merge for trivial cases and leaving
69         conflicting files unresolved in the index.
71 --aggressive::
72         Usually a three-way merge by 'git read-tree' resolves
73         the merge for really trivial cases and leaves other
74         cases unresolved in the index, so that porcelains can
75         implement different merge policies.  This flag makes the
76         command resolve a few more cases internally:
78 * when one side removes a path and the other side leaves the path
79   unmodified.  The resolution is to remove that path.
80 * when both sides remove a path.  The resolution is to remove that path.
81 * when both sides add a path identically.  The resolution
82   is to add that path.
84 --prefix=<prefix>/::
85         Keep the current index contents, and read the contents
86         of the named tree-ish under the directory at `<prefix>`.
87         The command will refuse to overwrite entries that already
88         existed in the original index file. Note that the `<prefix>/`
89         value must end with a slash.
91 --exclude-per-directory=<gitignore>::
92         When running the command with `-u` and `-m` options, the
93         merge result may need to overwrite paths that are not
94         tracked in the current branch.  The command usually
95         refuses to proceed with the merge to avoid losing such a
96         path.  However this safety valve sometimes gets in the
97         way.  For example, it often happens that the other
98         branch added a file that used to be a generated file in
99         your branch, and the safety valve triggers when you try
100         to switch to that branch after you ran `make` but before
101         running `make clean` to remove the generated file.  This
102         option tells the command to read per-directory exclude
103         file (usually '.gitignore') and allows such an untracked
104         but explicitly ignored file to be overwritten.
106 --index-output=<file>::
107         Instead of writing the results out to `$GIT_INDEX_FILE`,
108         write the resulting index in the named file.  While the
109         command is operating, the original index file is locked
110         with the same mechanism as usual.  The file must allow
111         to be rename(2)ed into from a temporary file that is
112         created next to the usual index file; typically this
113         means it needs to be on the same filesystem as the index
114         file itself, and you need write permission to the
115         directories the index file and index output file are
116         located in.
118 --no-sparse-checkout::
119         Disable sparse checkout support even if `core.sparseCheckout`
120         is true.
122 --empty::
123         Instead of reading tree object(s) into the index, just empty
124         it.
126 <tree-ish#>::
127         The id of the tree object(s) to be read/merged.
130 Merging
131 -------
132 If `-m` is specified, 'git read-tree' can perform 3 kinds of
133 merge, a single tree merge if only 1 tree is given, a
134 fast-forward merge with 2 trees, or a 3-way merge if 3 trees are
135 provided.
138 Single Tree Merge
139 ~~~~~~~~~~~~~~~~~
140 If only 1 tree is specified, 'git read-tree' operates as if the user did not
141 specify `-m`, except that if the original index has an entry for a
142 given pathname, and the contents of the path match with the tree
143 being read, the stat info from the index is used. (In other words, the
144 index's stat()s take precedence over the merged tree's).
146 That means that if you do a `git read-tree -m <newtree>` followed by a
147 `git checkout-index -f -u -a`, the 'git checkout-index' only checks out
148 the stuff that really changed.
150 This is used to avoid unnecessary false hits when 'git diff-files' is
151 run after 'git read-tree'.
154 Two Tree Merge
155 ~~~~~~~~~~~~~~
157 Typically, this is invoked as `git read-tree -m $H $M`, where $H
158 is the head commit of the current repository, and $M is the head
159 of a foreign tree, which is simply ahead of $H (i.e. we are in a
160 fast-forward situation).
162 When two trees are specified, the user is telling 'git read-tree'
163 the following:
165      1. The current index and work tree is derived from $H, but
166         the user may have local changes in them since $H.
168      2. The user wants to fast-forward to $M.
170 In this case, the `git read-tree -m $H $M` command makes sure
171 that no local change is lost as the result of this "merge".
172 Here are the "carry forward" rules, where "I" denotes the index,
173 "clean" means that index and work tree coincide, and "exists"/"nothing"
174 refer to the presence of a path in the specified commit:
176         I                   H        M        Result
177        -------------------------------------------------------
178      0  nothing             nothing  nothing  (does not happen)
179      1  nothing             nothing  exists   use M
180      2  nothing             exists   nothing  remove path from index
181      3  nothing             exists   exists,  use M if "initial checkout",
182                                      H == M   keep index otherwise
183                                      exists,  fail
184                                      H != M
186         clean I==H  I==M
187        ------------------
188      4  yes   N/A   N/A     nothing  nothing  keep index
189      5  no    N/A   N/A     nothing  nothing  keep index
191      6  yes   N/A   yes     nothing  exists   keep index
192      7  no    N/A   yes     nothing  exists   keep index
193      8  yes   N/A   no      nothing  exists   fail
194      9  no    N/A   no      nothing  exists   fail
196      10 yes   yes   N/A     exists   nothing  remove path from index
197      11 no    yes   N/A     exists   nothing  fail
198      12 yes   no    N/A     exists   nothing  fail
199      13 no    no    N/A     exists   nothing  fail
201         clean (H==M)
202        ------
203      14 yes                 exists   exists   keep index
204      15 no                  exists   exists   keep index
206         clean I==H  I==M (H!=M)
207        ------------------
208      16 yes   no    no      exists   exists   fail
209      17 no    no    no      exists   exists   fail
210      18 yes   no    yes     exists   exists   keep index
211      19 no    no    yes     exists   exists   keep index
212      20 yes   yes   no      exists   exists   use M
213      21 no    yes   no      exists   exists   fail
215 In all "keep index" cases, the index entry stays as in the
216 original index file.  If the entry is not up to date,
217 'git read-tree' keeps the copy in the work tree intact when
218 operating under the -u flag.
220 When this form of 'git read-tree' returns successfully, you can
221 see which of the "local changes" that you made were carried forward by running
222 `git diff-index --cached $M`.  Note that this does not
223 necessarily match what `git diff-index --cached $H` would have
224 produced before such a two tree merge.  This is because of cases
225 18 and 19 --- if you already had the changes in $M (e.g. maybe
226 you picked it up via e-mail in a patch form), `git diff-index
227 --cached $H` would have told you about the change before this
228 merge, but it would not show in `git diff-index --cached $M`
229 output after the two-tree merge.
231 Case 3 is slightly tricky and needs explanation.  The result from this
232 rule logically should be to remove the path if the user staged the removal
233 of the path and then switching to a new branch.  That however will prevent
234 the initial checkout from happening, so the rule is modified to use M (new
235 tree) only when the content of the index is empty.  Otherwise the removal
236 of the path is kept as long as $H and $M are the same.
238 3-Way Merge
239 ~~~~~~~~~~~
240 Each "index" entry has two bits worth of "stage" state. stage 0 is the
241 normal one, and is the only one you'd see in any kind of normal use.
243 However, when you do 'git read-tree' with three trees, the "stage"
244 starts out at 1.
246 This means that you can do
248 ----------------
249 $ git read-tree -m <tree1> <tree2> <tree3>
250 ----------------
252 and you will end up with an index with all of the <tree1> entries in
253 "stage1", all of the <tree2> entries in "stage2" and all of the
254 <tree3> entries in "stage3".  When performing a merge of another
255 branch into the current branch, we use the common ancestor tree
256 as <tree1>, the current branch head as <tree2>, and the other
257 branch head as <tree3>.
259 Furthermore, 'git read-tree' has special-case logic that says: if you see
260 a file that matches in all respects in the following states, it
261 "collapses" back to "stage0":
263    - stage 2 and 3 are the same; take one or the other (it makes no
264      difference - the same work has been done on our branch in
265      stage 2 and their branch in stage 3)
267    - stage 1 and stage 2 are the same and stage 3 is different; take
268      stage 3 (our branch in stage 2 did not do anything since the
269      ancestor in stage 1 while their branch in stage 3 worked on
270      it)
272    - stage 1 and stage 3 are the same and stage 2 is different take
273      stage 2 (we did something while they did nothing)
275 The 'git write-tree' command refuses to write a nonsensical tree, and it
276 will complain about unmerged entries if it sees a single entry that is not
277 stage 0.
279 OK, this all sounds like a collection of totally nonsensical rules,
280 but it's actually exactly what you want in order to do a fast
281 merge. The different stages represent the "result tree" (stage 0, aka
282 "merged"), the original tree (stage 1, aka "orig"), and the two trees
283 you are trying to merge (stage 2 and 3 respectively).
285 The order of stages 1, 2 and 3 (hence the order of three
286 <tree-ish> command line arguments) are significant when you
287 start a 3-way merge with an index file that is already
288 populated.  Here is an outline of how the algorithm works:
290 - if a file exists in identical format in all three trees, it will
291   automatically collapse to "merged" state by 'git read-tree'.
293 - a file that has _any_ difference what-so-ever in the three trees
294   will stay as separate entries in the index. It's up to "porcelain
295   policy" to determine how to remove the non-0 stages, and insert a
296   merged version.
298 - the index file saves and restores with all this information, so you
299   can merge things incrementally, but as long as it has entries in
300   stages 1/2/3 (i.e., "unmerged entries") you can't write the result. So
301   now the merge algorithm ends up being really simple:
303   * you walk the index in order, and ignore all entries of stage 0,
304     since they've already been done.
306   * if you find a "stage1", but no matching "stage2" or "stage3", you
307     know it's been removed from both trees (it only existed in the
308     original tree), and you remove that entry.
310   * if you find a matching "stage2" and "stage3" tree, you remove one
311     of them, and turn the other into a "stage0" entry. Remove any
312     matching "stage1" entry if it exists too.  .. all the normal
313     trivial rules ..
315 You would normally use 'git merge-index' with supplied
316 'git merge-one-file' to do this last step.  The script updates
317 the files in the working tree as it merges each path and at the
318 end of a successful merge.
320 When you start a 3-way merge with an index file that is already
321 populated, it is assumed that it represents the state of the
322 files in your work tree, and you can even have files with
323 changes unrecorded in the index file.  It is further assumed
324 that this state is "derived" from the stage 2 tree.  The 3-way
325 merge refuses to run if it finds an entry in the original index
326 file that does not match stage 2.
328 This is done to prevent you from losing your work-in-progress
329 changes, and mixing your random changes in an unrelated merge
330 commit.  To illustrate, suppose you start from what has been
331 committed last to your repository:
333 ----------------
334 $ JC=`git rev-parse --verify "HEAD^0"`
335 $ git checkout-index -f -u -a $JC
336 ----------------
338 You do random edits, without running 'git update-index'.  And then
339 you notice that the tip of your "upstream" tree has advanced
340 since you pulled from him:
342 ----------------
343 $ git fetch git://.... linus
344 $ LT=`git rev-parse FETCH_HEAD`
345 ----------------
347 Your work tree is still based on your HEAD ($JC), but you have
348 some edits since.  Three-way merge makes sure that you have not
349 added or modified index entries since $JC, and if you haven't,
350 then does the right thing.  So with the following sequence:
352 ----------------
353 $ git read-tree -m -u `git merge-base $JC $LT` $JC $LT
354 $ git merge-index git-merge-one-file -a
355 $ echo "Merge with Linus" | \
356   git commit-tree `git write-tree` -p $JC -p $LT
357 ----------------
359 what you would commit is a pure merge between $JC and $LT without
360 your work-in-progress changes, and your work tree would be
361 updated to the result of the merge.
363 However, if you have local changes in the working tree that
364 would be overwritten by this merge, 'git read-tree' will refuse
365 to run to prevent your changes from being lost.
367 In other words, there is no need to worry about what exists only
368 in the working tree.  When you have local changes in a part of
369 the project that is not involved in the merge, your changes do
370 not interfere with the merge, and are kept intact.  When they
371 *do* interfere, the merge does not even start ('git read-tree'
372 complains loudly and fails without modifying anything).  In such
373 a case, you can simply continue doing what you were in the
374 middle of doing, and when your working tree is ready (i.e. you
375 have finished your work-in-progress), attempt the merge again.
378 Sparse checkout
379 ---------------
381 "Sparse checkout" allows populating the working directory sparsely.
382 It uses the skip-worktree bit (see linkgit:git-update-index[1]) to tell
383 Git whether a file in the working directory is worth looking at.
385 'git read-tree' and other merge-based commands ('git merge', 'git
386 checkout'...) can help maintaining the skip-worktree bitmap and working
387 directory update. `$GIT_DIR/info/sparse-checkout` is used to
388 define the skip-worktree reference bitmap. When 'git read-tree' needs
389 to update the working directory, it resets the skip-worktree bit in the index
390 based on this file, which uses the same syntax as .gitignore files.
391 If an entry matches a pattern in this file, skip-worktree will not be
392 set on that entry. Otherwise, skip-worktree will be set.
394 Then it compares the new skip-worktree value with the previous one. If
395 skip-worktree turns from set to unset, it will add the corresponding
396 file back. If it turns from unset to set, that file will be removed.
398 While `$GIT_DIR/info/sparse-checkout` is usually used to specify what
399 files are in, you can also specify what files are _not_ in, using
400 negate patterns. For example, to remove the file `unwanted`:
402 ----------------
404 !unwanted
405 ----------------
407 Another tricky thing is fully repopulating the working directory when you
408 no longer want sparse checkout. You cannot just disable "sparse
409 checkout" because skip-worktree bits are still in the index and your working
410 directory is still sparsely populated. You should re-populate the working
411 directory with the `$GIT_DIR/info/sparse-checkout` file content as
412 follows:
414 ----------------
416 ----------------
418 Then you can disable sparse checkout. Sparse checkout support in 'git
419 read-tree' and similar commands is disabled by default. You need to
420 turn `core.sparseCheckout` on in order to have sparse checkout
421 support.
424 SEE ALSO
425 --------
426 linkgit:git-write-tree[1]; linkgit:git-ls-files[1];
427 linkgit:gitignore[5]
431 Part of the linkgit:git[1] suite