Junio C Hamano | 215a7ad | 2005-09-07 17:26:23 -0700 | [diff] [blame] | 1 | git-checkout-index(1) |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 2 | ===================== |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 3 | |
| 4 | NAME |
| 5 | ---- |
Junio C Hamano | c3f0baa | 2007-01-18 15:53:37 -0800 | [diff] [blame] | 6 | git-checkout-index - Copy files from the index to the working tree |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 7 | |
| 8 | |
| 9 | SYNOPSIS |
| 10 | -------- |
Jonas Fonseca | 353ce81 | 2005-12-31 18:37:15 +0100 | [diff] [blame] | 11 | [verse] |
Jonathan Nieder | b1889c3 | 2008-06-30 01:09:04 -0500 | [diff] [blame] | 12 | 'git checkout-index' [-u] [-q] [-a] [-f] [-n] [--prefix=<string>] |
Shawn Pearce | de84f99 | 2006-03-05 03:24:15 -0500 | [diff] [blame] | 13 | [--stage=<number>|all] |
| 14 | [--temp] |
Victoria Dye | 88078f5 | 2022-01-11 18:05:02 +0000 | [diff] [blame] | 15 | [--ignore-skip-worktree-bits] |
Shawn Pearce | 9debe63 | 2006-02-28 21:43:33 -0500 | [diff] [blame] | 16 | [-z] [--stdin] |
Štěpán Němec | 0adda93 | 2010-10-08 19:31:17 +0200 | [diff] [blame] | 17 | [--] [<file>...] |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 18 | |
| 19 | DESCRIPTION |
| 20 | ----------- |
Elijah Newren | cf6cac2 | 2023-10-08 06:45:03 +0000 | [diff] [blame] | 21 | Copies all listed files from the index to the working directory |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 22 | (not overwriting existing files). |
| 23 | |
| 24 | OPTIONS |
| 25 | ------- |
Stephan Beyer | 3240240 | 2008-06-08 03:36:09 +0200 | [diff] [blame] | 26 | -u:: |
| 27 | --index:: |
Junio C Hamano | 415e96c | 2005-05-15 14:23:12 -0700 | [diff] [blame] | 28 | update stat information for the checked out entries in |
Lukas_Sandström | 5f3aa19 | 2005-11-11 02:12:27 +0100 | [diff] [blame] | 29 | the index file. |
Junio C Hamano | 415e96c | 2005-05-15 14:23:12 -0700 | [diff] [blame] | 30 | |
Stephan Beyer | 3240240 | 2008-06-08 03:36:09 +0200 | [diff] [blame] | 31 | -q:: |
| 32 | --quiet:: |
Lukas_Sandström | 5f3aa19 | 2005-11-11 02:12:27 +0100 | [diff] [blame] | 33 | be quiet if files exist or are not in the index |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 34 | |
Stephan Beyer | 3240240 | 2008-06-08 03:36:09 +0200 | [diff] [blame] | 35 | -f:: |
| 36 | --force:: |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 37 | forces overwrite of existing files |
| 38 | |
Stephan Beyer | 3240240 | 2008-06-08 03:36:09 +0200 | [diff] [blame] | 39 | -a:: |
| 40 | --all:: |
Victoria Dye | 88078f5 | 2022-01-11 18:05:02 +0000 | [diff] [blame] | 41 | checks out all files in the index except for those with the |
| 42 | skip-worktree bit set (see `--ignore-skip-worktree-bits`). |
| 43 | Cannot be used together with explicit filenames. |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 44 | |
Stephan Beyer | 3240240 | 2008-06-08 03:36:09 +0200 | [diff] [blame] | 45 | -n:: |
| 46 | --no-create:: |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 47 | Don't checkout new files, only refresh files already checked |
| 48 | out. |
| 49 | |
| 50 | --prefix=<string>:: |
| 51 | When creating files, prepend <string> (usually a directory |
| 52 | including a trailing /) |
| 53 | |
Shawn Pearce | de84f99 | 2006-03-05 03:24:15 -0500 | [diff] [blame] | 54 | --stage=<number>|all:: |
Junio C Hamano | 3bd348a | 2005-12-07 00:29:51 -0800 | [diff] [blame] | 55 | Instead of checking out unmerged entries, copy out the |
Elijah Newren | 0a4f051 | 2023-10-08 06:45:17 +0000 | [diff] [blame] | 56 | files from the named stage. <number> must be between 1 and 3. |
Shawn Pearce | de84f99 | 2006-03-05 03:24:15 -0500 | [diff] [blame] | 57 | Note: --stage=all automatically implies --temp. |
| 58 | |
| 59 | --temp:: |
Elijah Newren | 4d54268 | 2023-10-08 06:45:24 +0000 | [diff] [blame] | 60 | Instead of copying the files to the working directory, |
Shawn Pearce | de84f99 | 2006-03-05 03:24:15 -0500 | [diff] [blame] | 61 | write the content to temporary files. The temporary name |
| 62 | associations will be written to stdout. |
Junio C Hamano | 3bd348a | 2005-12-07 00:29:51 -0800 | [diff] [blame] | 63 | |
Victoria Dye | 88078f5 | 2022-01-11 18:05:02 +0000 | [diff] [blame] | 64 | --ignore-skip-worktree-bits:: |
| 65 | Check out all files, including those with the skip-worktree bit |
| 66 | set. |
| 67 | |
Shawn Pearce | 9debe63 | 2006-02-28 21:43:33 -0500 | [diff] [blame] | 68 | --stdin:: |
Elijah Newren | 0a4f051 | 2023-10-08 06:45:17 +0000 | [diff] [blame] | 69 | Instead of taking a list of paths from the command line, |
| 70 | read the list of paths from the standard input. Paths are |
Shawn Pearce | 9debe63 | 2006-02-28 21:43:33 -0500 | [diff] [blame] | 71 | separated by LF (i.e. one path per line) by default. |
| 72 | |
| 73 | -z:: |
| 74 | Only meaningful with `--stdin`; paths are separated with |
| 75 | NUL character instead of LF. |
| 76 | |
sean | e994004 | 2006-05-05 15:05:24 -0400 | [diff] [blame] | 77 | \--:: |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 78 | Do not interpret any more arguments as options. |
| 79 | |
Junio C Hamano | fd25c82 | 2005-10-17 17:38:09 -0700 | [diff] [blame] | 80 | The order of the flags used to matter, but not anymore. |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 81 | |
Jonathan Nieder | b1889c3 | 2008-06-30 01:09:04 -0500 | [diff] [blame] | 82 | Just doing `git checkout-index` does nothing. You probably meant |
| 83 | `git checkout-index -a`. And if you want to force it, you want |
| 84 | `git checkout-index -f -a`. |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 85 | |
| 86 | Intuitiveness is not the goal here. Repeatability is. The reason for |
Jon Loeliger | 61f693b | 2005-12-05 23:13:03 -0600 | [diff] [blame] | 87 | the "no arguments means no work" behavior is that from scripts you are |
| 88 | supposed to be able to do: |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 89 | |
Jon Loeliger | 61f693b | 2005-12-05 23:13:03 -0600 | [diff] [blame] | 90 | ---------------- |
Jonathan Nieder | b1889c3 | 2008-06-30 01:09:04 -0500 | [diff] [blame] | 91 | $ find . -name '*.h' -print0 | xargs -0 git checkout-index -f -- |
Jon Loeliger | 61f693b | 2005-12-05 23:13:03 -0600 | [diff] [blame] | 92 | ---------------- |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 93 | |
| 94 | which will force all existing `*.h` files to be replaced with their |
| 95 | cached copies. If an empty command line implied "all", then this would |
Shawn Pearce | 9debe63 | 2006-02-28 21:43:33 -0500 | [diff] [blame] | 96 | force-refresh everything in the index, which was not the point. But |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 97 | since 'git checkout-index' accepts --stdin it would be faster to use: |
Shawn Pearce | 9debe63 | 2006-02-28 21:43:33 -0500 | [diff] [blame] | 98 | |
| 99 | ---------------- |
Jonathan Nieder | b1889c3 | 2008-06-30 01:09:04 -0500 | [diff] [blame] | 100 | $ find . -name '*.h' -print0 | git checkout-index -f -z --stdin |
Shawn Pearce | 9debe63 | 2006-02-28 21:43:33 -0500 | [diff] [blame] | 101 | ---------------- |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 102 | |
Jon Loeliger | 61f693b | 2005-12-05 23:13:03 -0600 | [diff] [blame] | 103 | The `--` is just a good idea when you know the rest will be filenames; |
| 104 | it will prevent problems with a filename of, for example, `-a`. |
| 105 | Using `--` is probably a good policy in scripts. |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 106 | |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 107 | |
Shawn Pearce | de84f99 | 2006-03-05 03:24:15 -0500 | [diff] [blame] | 108 | Using --temp or --stage=all |
| 109 | --------------------------- |
| 110 | When `--temp` is used (or implied by `--stage=all`) |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 111 | 'git checkout-index' will create a temporary file for each index |
Shawn Pearce | de84f99 | 2006-03-05 03:24:15 -0500 | [diff] [blame] | 112 | entry being checked out. The index will not be updated with stat |
| 113 | information. These options can be useful if the caller needs all |
| 114 | stages of all unmerged entries so that the unmerged files can be |
| 115 | processed by an external merge tool. |
| 116 | |
| 117 | A listing will be written to stdout providing the association of |
| 118 | temporary file names to tracked path names. The listing format |
| 119 | has two variations: |
| 120 | |
| 121 | . tempname TAB path RS |
| 122 | + |
| 123 | The first format is what gets used when `--stage` is omitted or |
| 124 | is not `--stage=all`. The field tempname is the temporary file |
| 125 | name holding the file content and path is the tracked path name in |
| 126 | the index. Only the requested entries are output. |
| 127 | |
| 128 | . stage1temp SP stage2temp SP stage3tmp TAB path RS |
| 129 | + |
| 130 | The second format is what gets used when `--stage=all`. The three |
| 131 | stage temporary fields (stage1temp, stage2temp, stage3temp) list the |
| 132 | name of the temporary file if there is a stage entry in the index |
| 133 | or `.` if there is no stage entry. Paths which only have a stage 0 |
| 134 | entry will always be omitted from the output. |
| 135 | |
| 136 | In both formats RS (the record separator) is newline by default |
| 137 | but will be the null byte if -z was passed on the command line. |
| 138 | The temporary file names are always safe strings; they will never |
| 139 | contain directory separators or whitespace characters. The path |
| 140 | field is always relative to the current directory and the temporary |
| 141 | file names are always relative to the top level directory. |
| 142 | |
| 143 | If the object being copied out to a temporary file is a symbolic |
| 144 | link the content of the link will be written to a normal file. It is |
| 145 | up to the end-user or the Porcelain to make use of this information. |
| 146 | |
| 147 | |
Jon Loeliger | 61f693b | 2005-12-05 23:13:03 -0600 | [diff] [blame] | 148 | EXAMPLES |
| 149 | -------- |
| 150 | To update and refresh only the files already checked out:: |
| 151 | + |
| 152 | ---------------- |
Jonathan Nieder | b1889c3 | 2008-06-30 01:09:04 -0500 | [diff] [blame] | 153 | $ git checkout-index -n -f -a && git update-index --ignore-missing --refresh |
Jon Loeliger | 61f693b | 2005-12-05 23:13:03 -0600 | [diff] [blame] | 154 | ---------------- |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 155 | |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 156 | Using 'git checkout-index' to "export an entire tree":: |
Jon Loeliger | 61f693b | 2005-12-05 23:13:03 -0600 | [diff] [blame] | 157 | The prefix ability basically makes it trivial to use |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 158 | 'git checkout-index' as an "export as tree" function. |
Jon Loeliger | 61f693b | 2005-12-05 23:13:03 -0600 | [diff] [blame] | 159 | Just read the desired tree into the index, and do: |
| 160 | + |
| 161 | ---------------- |
Jonathan Nieder | b1889c3 | 2008-06-30 01:09:04 -0500 | [diff] [blame] | 162 | $ git checkout-index --prefix=git-export-dir/ -a |
Jon Loeliger | 61f693b | 2005-12-05 23:13:03 -0600 | [diff] [blame] | 163 | ---------------- |
| 164 | + |
Jonathan Nieder | b1889c3 | 2008-06-30 01:09:04 -0500 | [diff] [blame] | 165 | `git checkout-index` will "export" the index into the specified |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 166 | directory. |
Jon Loeliger | 61f693b | 2005-12-05 23:13:03 -0600 | [diff] [blame] | 167 | + |
| 168 | The final "/" is important. The exported name is literally just |
| 169 | prefixed with the specified string. Contrast this with the |
| 170 | following example. |
Junio C Hamano | fd25c82 | 2005-10-17 17:38:09 -0700 | [diff] [blame] | 171 | |
Jon Loeliger | 61f693b | 2005-12-05 23:13:03 -0600 | [diff] [blame] | 172 | Export files with a prefix:: |
| 173 | + |
| 174 | ---------------- |
Jonathan Nieder | b1889c3 | 2008-06-30 01:09:04 -0500 | [diff] [blame] | 175 | $ git checkout-index --prefix=.merged- Makefile |
Jon Loeliger | 61f693b | 2005-12-05 23:13:03 -0600 | [diff] [blame] | 176 | ---------------- |
| 177 | + |
| 178 | This will check out the currently cached copy of `Makefile` |
| 179 | into the file `.merged-Makefile`. |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 180 | |
David Greaves | 2cf565c | 2005-05-10 22:32:30 +0100 | [diff] [blame] | 181 | GIT |
| 182 | --- |
Christian Couder | 9e1f0a8 | 2008-06-06 09:07:32 +0200 | [diff] [blame] | 183 | Part of the linkgit:git[1] suite |