@matheusbsbs / matheus-bagliano / commits / fd25c82a80
Fork 0

git-checkout-index: documentation updates.

Now the behaviour of '-a' has been straightened out, document it. Signed-off-by: Junio C Hamano <junkio@cox.net>

Junio C Hamano committed Oct 17, 2005 at 17:38 UTC fd25c82a80533da035d42a5ac229ec5c5b332411
1 file changed +7 -13
Documentation/git-checkout-index.txt
+7 -13
@@ -30,8 +30,8 @@ OPTIONS
30 forces overwrite of existing files
31
32 -a::
33 - checks out all files in the cache (will then continue to
34 - process listed files).
33 + checks out all files in the cache. Cannot be used
34 + together with explicit filenames.
35
36 -n::
37 Don't checkout new files, only refresh files already checked
@@ -44,15 +44,9 @@ OPTIONS
44 --::
45 Do not interpret any more arguments as options.
46
47 -Note that the order of the flags matters:
47 +The order of the flags used to matter, but not anymore.
48
49 - git-checkout-index -a -f file.c
50 -
51 -will first check out all files listed in the cache (but not overwrite
52 -any old ones), and then force-checkout `file.c` a second time (ie that
53 -one *will* overwrite any old contents with the same filename).
54 -
55 -Also, just doing "git-checkout-index" does nothing. You probably meant
49 +Just doing "git-checkout-index" does nothing. You probably meant
50 "git-checkout-index -a". And if you want to force it, you want
51 "git-checkout-index -f -a".
52
@@ -78,12 +72,12 @@ scripting!).
72 The prefix ability basically makes it trivial to use
73 git-checkout-index as an "export as tree" function. Just read the
74 desired tree into the index, and do a
81 -
75 +
76 git-checkout-index --prefix=git-export-dir/ -a
83 -
77 +
78 and git-checkout-index will "export" the cache into the specified
79 directory.
86 -
80 +
81 NOTE The final "/" is important. The exported name is literally just
82 prefixed with the specified string, so you can also do something like
83