Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" |
| 2 | "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> |
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> |
| 4 | <head> |
| 5 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 6 | <meta name="generator" content="AsciiDoc 8.2.5" /> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 7 | <style type="text/css"> |
| 8 | /* Debug borders */ |
| 9 | p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { |
| 10 | /* |
| 11 | border: 1px solid red; |
| 12 | */ |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | margin: 1em 5% 1em 5%; |
| 17 | } |
| 18 | |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 19 | a { |
| 20 | color: blue; |
| 21 | text-decoration: underline; |
| 22 | } |
| 23 | a:visited { |
| 24 | color: fuchsia; |
| 25 | } |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 26 | |
| 27 | em { |
| 28 | font-style: italic; |
| 29 | } |
| 30 | |
| 31 | strong { |
| 32 | font-weight: bold; |
| 33 | } |
| 34 | |
| 35 | tt { |
| 36 | color: navy; |
| 37 | } |
| 38 | |
| 39 | h1, h2, h3, h4, h5, h6 { |
| 40 | color: #527bbd; |
| 41 | font-family: sans-serif; |
| 42 | margin-top: 1.2em; |
| 43 | margin-bottom: 0.5em; |
| 44 | line-height: 1.3; |
| 45 | } |
| 46 | |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 47 | h1, h2, h3 { |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 48 | border-bottom: 2px solid silver; |
| 49 | } |
| 50 | h2 { |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 51 | padding-top: 0.5em; |
| 52 | } |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 53 | h3 { |
| 54 | float: left; |
| 55 | } |
| 56 | h3 + * { |
| 57 | clear: left; |
| 58 | } |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 59 | |
| 60 | div.sectionbody { |
| 61 | font-family: serif; |
| 62 | margin-left: 0; |
| 63 | } |
| 64 | |
| 65 | hr { |
| 66 | border: 1px solid silver; |
| 67 | } |
| 68 | |
| 69 | p { |
| 70 | margin-top: 0.5em; |
| 71 | margin-bottom: 0.5em; |
| 72 | } |
| 73 | |
| 74 | pre { |
| 75 | padding: 0; |
| 76 | margin: 0; |
| 77 | } |
| 78 | |
| 79 | span#author { |
| 80 | color: #527bbd; |
| 81 | font-family: sans-serif; |
| 82 | font-weight: bold; |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 83 | font-size: 1.1em; |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 84 | } |
| 85 | span#email { |
| 86 | } |
| 87 | span#revision { |
| 88 | font-family: sans-serif; |
| 89 | } |
| 90 | |
| 91 | div#footer { |
| 92 | font-family: sans-serif; |
| 93 | font-size: small; |
| 94 | border-top: 2px solid silver; |
| 95 | padding-top: 0.5em; |
| 96 | margin-top: 4.0em; |
| 97 | } |
| 98 | div#footer-text { |
| 99 | float: left; |
| 100 | padding-bottom: 0.5em; |
| 101 | } |
| 102 | div#footer-badges { |
| 103 | float: right; |
| 104 | padding-bottom: 0.5em; |
| 105 | } |
| 106 | |
| 107 | div#preamble, |
| 108 | div.tableblock, div.imageblock, div.exampleblock, div.verseblock, |
| 109 | div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, |
| 110 | div.admonitionblock { |
| 111 | margin-right: 10%; |
| 112 | margin-top: 1.5em; |
| 113 | margin-bottom: 1.5em; |
| 114 | } |
| 115 | div.admonitionblock { |
| 116 | margin-top: 2.5em; |
| 117 | margin-bottom: 2.5em; |
| 118 | } |
| 119 | |
| 120 | div.content { /* Block element content. */ |
| 121 | padding: 0; |
| 122 | } |
| 123 | |
| 124 | /* Block element titles. */ |
| 125 | div.title, caption.title { |
| 126 | font-family: sans-serif; |
| 127 | font-weight: bold; |
| 128 | text-align: left; |
| 129 | margin-top: 1.0em; |
| 130 | margin-bottom: 0.5em; |
| 131 | } |
| 132 | div.title + * { |
| 133 | margin-top: 0; |
| 134 | } |
| 135 | |
| 136 | td div.title:first-child { |
| 137 | margin-top: 0.0em; |
| 138 | } |
| 139 | div.content div.title:first-child { |
| 140 | margin-top: 0.0em; |
| 141 | } |
| 142 | div.content + div.title { |
| 143 | margin-top: 0.0em; |
| 144 | } |
| 145 | |
| 146 | div.sidebarblock > div.content { |
| 147 | background: #ffffee; |
| 148 | border: 1px solid silver; |
| 149 | padding: 0.5em; |
| 150 | } |
| 151 | |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 152 | div.listingblock { |
| 153 | margin-right: 0%; |
| 154 | } |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 155 | div.listingblock > div.content { |
| 156 | border: 1px solid silver; |
| 157 | background: #f4f4f4; |
| 158 | padding: 0.5em; |
| 159 | } |
| 160 | |
| 161 | div.quoteblock > div.content { |
| 162 | padding-left: 2.0em; |
| 163 | } |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 164 | |
| 165 | div.attribution { |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 166 | text-align: right; |
| 167 | } |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 168 | div.verseblock + div.attribution { |
| 169 | text-align: left; |
| 170 | } |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 171 | |
| 172 | div.admonitionblock .icon { |
| 173 | vertical-align: top; |
| 174 | font-size: 1.1em; |
| 175 | font-weight: bold; |
| 176 | text-decoration: underline; |
| 177 | color: #527bbd; |
| 178 | padding-right: 0.5em; |
| 179 | } |
| 180 | div.admonitionblock td.content { |
| 181 | padding-left: 0.5em; |
| 182 | border-left: 2px solid silver; |
| 183 | } |
| 184 | |
| 185 | div.exampleblock > div.content { |
| 186 | border-left: 2px solid silver; |
| 187 | padding: 0.5em; |
| 188 | } |
| 189 | |
| 190 | div.verseblock div.content { |
| 191 | white-space: pre; |
| 192 | } |
| 193 | |
| 194 | div.imageblock div.content { padding-left: 0; } |
| 195 | div.imageblock img { border: 1px solid silver; } |
| 196 | span.image img { border-style: none; } |
| 197 | |
| 198 | dl { |
| 199 | margin-top: 0.8em; |
| 200 | margin-bottom: 0.8em; |
| 201 | } |
| 202 | dt { |
| 203 | margin-top: 0.5em; |
| 204 | margin-bottom: 0; |
| 205 | font-style: italic; |
| 206 | } |
| 207 | dd > *:first-child { |
| 208 | margin-top: 0; |
| 209 | } |
| 210 | |
| 211 | ul, ol { |
| 212 | list-style-position: outside; |
| 213 | } |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 214 | div.olist2 ol { |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 215 | list-style-type: lower-alpha; |
| 216 | } |
| 217 | |
| 218 | div.tableblock > table { |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 219 | border: 3px solid #527bbd; |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 220 | } |
| 221 | thead { |
| 222 | font-family: sans-serif; |
| 223 | font-weight: bold; |
| 224 | } |
| 225 | tfoot { |
| 226 | font-weight: bold; |
| 227 | } |
| 228 | |
| 229 | div.hlist { |
| 230 | margin-top: 0.8em; |
| 231 | margin-bottom: 0.8em; |
| 232 | } |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 233 | div.hlist td { |
| 234 | padding-bottom: 5px; |
| 235 | } |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 236 | td.hlist1 { |
| 237 | vertical-align: top; |
| 238 | font-style: italic; |
| 239 | padding-right: 0.8em; |
| 240 | } |
| 241 | td.hlist2 { |
| 242 | vertical-align: top; |
| 243 | } |
| 244 | |
| 245 | @media print { |
| 246 | div#footer-badges { display: none; } |
| 247 | } |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 248 | |
| 249 | div#toctitle { |
| 250 | color: #527bbd; |
| 251 | font-family: sans-serif; |
| 252 | font-size: 1.1em; |
| 253 | font-weight: bold; |
| 254 | margin-top: 1.0em; |
| 255 | margin-bottom: 0.1em; |
| 256 | } |
| 257 | |
| 258 | div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { |
| 259 | margin-top: 0; |
| 260 | margin-bottom: 0; |
| 261 | } |
| 262 | div.toclevel2 { |
| 263 | margin-left: 2em; |
| 264 | font-size: 0.9em; |
| 265 | } |
| 266 | div.toclevel3 { |
| 267 | margin-left: 4em; |
| 268 | font-size: 0.9em; |
| 269 | } |
| 270 | div.toclevel4 { |
| 271 | margin-left: 6em; |
| 272 | font-size: 0.9em; |
| 273 | } |
| 274 | include1::./stylesheets/xhtml11-manpage.css[] |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 275 | /* Workarounds for IE6's broken and incomplete CSS2. */ |
| 276 | |
| 277 | div.sidebar-content { |
| 278 | background: #ffffee; |
| 279 | border: 1px solid silver; |
| 280 | padding: 0.5em; |
| 281 | } |
| 282 | div.sidebar-title, div.image-title { |
| 283 | font-family: sans-serif; |
| 284 | font-weight: bold; |
| 285 | margin-top: 0.0em; |
| 286 | margin-bottom: 0.5em; |
| 287 | } |
| 288 | |
| 289 | div.listingblock div.content { |
| 290 | border: 1px solid silver; |
| 291 | background: #f4f4f4; |
| 292 | padding: 0.5em; |
| 293 | } |
| 294 | |
| 295 | div.quoteblock-content { |
| 296 | padding-left: 2.0em; |
| 297 | } |
| 298 | |
| 299 | div.exampleblock-content { |
| 300 | border-left: 2px solid silver; |
| 301 | padding-left: 0.5em; |
| 302 | } |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 303 | |
| 304 | /* IE6 sets dynamically generated links as visited. */ |
| 305 | div#toc a:visited { color: blue; } |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 306 | </style> |
| 307 | <title>git-checkout-index(1)</title> |
| 308 | </head> |
| 309 | <body> |
| 310 | <div id="header"> |
| 311 | <h1> |
| 312 | git-checkout-index(1) Manual Page |
| 313 | </h1> |
| 314 | <h2>NAME</h2> |
| 315 | <div class="sectionbody"> |
| 316 | <p>git-checkout-index - |
Junio C Hamano | 7c73c66 | 2007-01-19 00:37:50 | [diff] [blame] | 317 | Copy files from the index to the working tree |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 318 | </p> |
| 319 | </div> |
| 320 | </div> |
| 321 | <h2>SYNOPSIS</h2> |
| 322 | <div class="sectionbody"> |
Junio C Hamano | 235a91e | 2006-01-07 01:13:58 | [diff] [blame] | 323 | <div class="verseblock"> |
Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame] | 324 | <div class="content"><em>git checkout-index</em> [-u] [-q] [-a] [-f] [-n] [--prefix=<string>] |
Junio C Hamano | f84a2b1 | 2006-03-07 05:16:28 | [diff] [blame] | 325 | [--stage=<number>|all] |
| 326 | [--temp] |
Junio C Hamano | decf50e | 2006-03-05 10:51:14 | [diff] [blame] | 327 | [-z] [--stdin] |
| 328 | [--] [<file>]*</div></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 329 | </div> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 330 | <h2 id="_description">DESCRIPTION</h2> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 331 | <div class="sectionbody"> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 332 | <div class="para"><p>Will copy all files listed from the index to the working directory |
| 333 | (not overwriting existing files).</p></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 334 | </div> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 335 | <h2 id="_options">OPTIONS</h2> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 336 | <div class="sectionbody"> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 337 | <div class="vlist"><dl> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 338 | <dt> |
Junio C Hamano | eb41599 | 2008-06-08 22:49:47 | [diff] [blame] | 339 | -u |
| 340 | </dt> |
| 341 | <dt> |
| 342 | --index |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 343 | </dt> |
| 344 | <dd> |
| 345 | <p> |
| 346 | update stat information for the checked out entries in |
| 347 | the index file. |
| 348 | </p> |
| 349 | </dd> |
| 350 | <dt> |
Junio C Hamano | eb41599 | 2008-06-08 22:49:47 | [diff] [blame] | 351 | -q |
| 352 | </dt> |
| 353 | <dt> |
| 354 | --quiet |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 355 | </dt> |
| 356 | <dd> |
| 357 | <p> |
| 358 | be quiet if files exist or are not in the index |
| 359 | </p> |
| 360 | </dd> |
| 361 | <dt> |
Junio C Hamano | eb41599 | 2008-06-08 22:49:47 | [diff] [blame] | 362 | -f |
| 363 | </dt> |
| 364 | <dt> |
| 365 | --force |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 366 | </dt> |
| 367 | <dd> |
| 368 | <p> |
| 369 | forces overwrite of existing files |
| 370 | </p> |
| 371 | </dd> |
| 372 | <dt> |
Junio C Hamano | eb41599 | 2008-06-08 22:49:47 | [diff] [blame] | 373 | -a |
| 374 | </dt> |
| 375 | <dt> |
| 376 | --all |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 377 | </dt> |
| 378 | <dd> |
| 379 | <p> |
| 380 | checks out all files in the index. Cannot be used |
| 381 | together with explicit filenames. |
| 382 | </p> |
| 383 | </dd> |
| 384 | <dt> |
Junio C Hamano | eb41599 | 2008-06-08 22:49:47 | [diff] [blame] | 385 | -n |
| 386 | </dt> |
| 387 | <dt> |
| 388 | --no-create |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 389 | </dt> |
| 390 | <dd> |
| 391 | <p> |
| 392 | Don't checkout new files, only refresh files already checked |
| 393 | out. |
| 394 | </p> |
| 395 | </dd> |
| 396 | <dt> |
| 397 | --prefix=<string> |
| 398 | </dt> |
| 399 | <dd> |
| 400 | <p> |
| 401 | When creating files, prepend <string> (usually a directory |
| 402 | including a trailing /) |
| 403 | </p> |
| 404 | </dd> |
| 405 | <dt> |
Junio C Hamano | f84a2b1 | 2006-03-07 05:16:28 | [diff] [blame] | 406 | --stage=<number>|all |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 407 | </dt> |
| 408 | <dd> |
| 409 | <p> |
| 410 | Instead of checking out unmerged entries, copy out the |
| 411 | files from named stage. <number> must be between 1 and 3. |
Junio C Hamano | f84a2b1 | 2006-03-07 05:16:28 | [diff] [blame] | 412 | Note: --stage=all automatically implies --temp. |
| 413 | </p> |
| 414 | </dd> |
| 415 | <dt> |
| 416 | --temp |
| 417 | </dt> |
| 418 | <dd> |
| 419 | <p> |
| 420 | Instead of copying the files to the working directory |
| 421 | write the content to temporary files. The temporary name |
| 422 | associations will be written to stdout. |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 423 | </p> |
| 424 | </dd> |
| 425 | <dt> |
Junio C Hamano | decf50e | 2006-03-05 10:51:14 | [diff] [blame] | 426 | --stdin |
| 427 | </dt> |
| 428 | <dd> |
| 429 | <p> |
| 430 | Instead of taking list of paths from the command line, |
| 431 | read list of paths from the standard input. Paths are |
| 432 | separated by LF (i.e. one path per line) by default. |
| 433 | </p> |
| 434 | </dd> |
| 435 | <dt> |
| 436 | -z |
| 437 | </dt> |
| 438 | <dd> |
| 439 | <p> |
| 440 | Only meaningful with <tt>--stdin</tt>; paths are separated with |
| 441 | NUL character instead of LF. |
| 442 | </p> |
| 443 | </dd> |
| 444 | <dt> |
Junio C Hamano | 1bb569e | 2006-05-05 23:14:25 | [diff] [blame] | 445 | -- |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 446 | </dt> |
| 447 | <dd> |
| 448 | <p> |
| 449 | Do not interpret any more arguments as options. |
| 450 | </p> |
| 451 | </dd> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 452 | </dl></div> |
| 453 | <div class="para"><p>The order of the flags used to matter, but not anymore.</p></div> |
| 454 | <div class="para"><p>Just doing <tt>git checkout-index</tt> does nothing. You probably meant |
Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame] | 455 | <tt>git checkout-index -a</tt>. And if you want to force it, you want |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 456 | <tt>git checkout-index -f -a</tt>.</p></div> |
| 457 | <div class="para"><p>Intuitiveness is not the goal here. Repeatability is. The reason for |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 458 | the "no arguments means no work" behavior is that from scripts you are |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 459 | supposed to be able to do:</p></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 460 | <div class="listingblock"> |
| 461 | <div class="content"> |
Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame] | 462 | <pre><tt>$ find . -name '*.h' -print0 | xargs -0 git checkout-index -f --</tt></pre> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 463 | </div></div> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 464 | <div class="para"><p>which will force all existing <tt>*.h</tt> files to be replaced with their |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 465 | cached copies. If an empty command line implied "all", then this would |
Junio C Hamano | decf50e | 2006-03-05 10:51:14 | [diff] [blame] | 466 | force-refresh everything in the index, which was not the point. But |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 467 | since <em>git-checkout-index</em> accepts --stdin it would be faster to use:</p></div> |
Junio C Hamano | decf50e | 2006-03-05 10:51:14 | [diff] [blame] | 468 | <div class="listingblock"> |
| 469 | <div class="content"> |
Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame] | 470 | <pre><tt>$ find . -name '*.h' -print0 | git checkout-index -f -z --stdin</tt></pre> |
Junio C Hamano | decf50e | 2006-03-05 10:51:14 | [diff] [blame] | 471 | </div></div> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 472 | <div class="para"><p>The <tt>--</tt> is just a good idea when you know the rest will be filenames; |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 473 | it will prevent problems with a filename of, for example, <tt>-a</tt>. |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 474 | Using <tt>--</tt> is probably a good policy in scripts.</p></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 475 | </div> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 476 | <h2 id="_using_temp_or_stage_all">Using --temp or --stage=all</h2> |
Junio C Hamano | f84a2b1 | 2006-03-07 05:16:28 | [diff] [blame] | 477 | <div class="sectionbody"> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 478 | <div class="para"><p>When <tt>--temp</tt> is used (or implied by <tt>--stage=all</tt>) |
| 479 | <em>git-checkout-index</em> will create a temporary file for each index |
Junio C Hamano | f84a2b1 | 2006-03-07 05:16:28 | [diff] [blame] | 480 | entry being checked out. The index will not be updated with stat |
| 481 | information. These options can be useful if the caller needs all |
| 482 | stages of all unmerged entries so that the unmerged files can be |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 483 | processed by an external merge tool.</p></div> |
| 484 | <div class="para"><p>A listing will be written to stdout providing the association of |
Junio C Hamano | f84a2b1 | 2006-03-07 05:16:28 | [diff] [blame] | 485 | temporary file names to tracked path names. The listing format |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 486 | has two variations:</p></div> |
| 487 | <div class="olist"><ol> |
Junio C Hamano | f84a2b1 | 2006-03-07 05:16:28 | [diff] [blame] | 488 | <li> |
| 489 | <p> |
| 490 | tempname TAB path RS |
| 491 | </p> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 492 | <div class="para"><p>The first format is what gets used when <tt>--stage</tt> is omitted or |
Junio C Hamano | f84a2b1 | 2006-03-07 05:16:28 | [diff] [blame] | 493 | is not <tt>--stage=all</tt>. The field tempname is the temporary file |
| 494 | name holding the file content and path is the tracked path name in |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 495 | the index. Only the requested entries are output.</p></div> |
Junio C Hamano | f84a2b1 | 2006-03-07 05:16:28 | [diff] [blame] | 496 | </li> |
| 497 | <li> |
| 498 | <p> |
| 499 | stage1temp SP stage2temp SP stage3tmp TAB path RS |
| 500 | </p> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 501 | <div class="para"><p>The second format is what gets used when <tt>--stage=all</tt>. The three |
Junio C Hamano | f84a2b1 | 2006-03-07 05:16:28 | [diff] [blame] | 502 | stage temporary fields (stage1temp, stage2temp, stage3temp) list the |
| 503 | name of the temporary file if there is a stage entry in the index |
| 504 | or <tt>.</tt> if there is no stage entry. Paths which only have a stage 0 |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 505 | entry will always be omitted from the output.</p></div> |
Junio C Hamano | f84a2b1 | 2006-03-07 05:16:28 | [diff] [blame] | 506 | </li> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 507 | </ol></div> |
| 508 | <div class="para"><p>In both formats RS (the record separator) is newline by default |
Junio C Hamano | f84a2b1 | 2006-03-07 05:16:28 | [diff] [blame] | 509 | but will be the null byte if -z was passed on the command line. |
| 510 | The temporary file names are always safe strings; they will never |
| 511 | contain directory separators or whitespace characters. The path |
| 512 | field is always relative to the current directory and the temporary |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 513 | file names are always relative to the top level directory.</p></div> |
| 514 | <div class="para"><p>If the object being copied out to a temporary file is a symbolic |
Junio C Hamano | f84a2b1 | 2006-03-07 05:16:28 | [diff] [blame] | 515 | link the content of the link will be written to a normal file. It is |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 516 | up to the end-user or the Porcelain to make use of this information.</p></div> |
Junio C Hamano | f84a2b1 | 2006-03-07 05:16:28 | [diff] [blame] | 517 | </div> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 518 | <h2 id="_examples">EXAMPLES</h2> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 519 | <div class="sectionbody"> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 520 | <div class="vlist"><dl> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 521 | <dt> |
| 522 | To update and refresh only the files already checked out |
| 523 | </dt> |
| 524 | <dd> |
| 525 | <div class="listingblock"> |
| 526 | <div class="content"> |
Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame] | 527 | <pre><tt>$ git checkout-index -n -f -a && git update-index --ignore-missing --refresh</tt></pre> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 528 | </div></div> |
| 529 | </dd> |
| 530 | <dt> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 531 | Using <em>git-checkout-index</em> to "export an entire tree" |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 532 | </dt> |
| 533 | <dd> |
| 534 | <p> |
| 535 | The prefix ability basically makes it trivial to use |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 536 | <em>git-checkout-index</em> as an "export as tree" function. |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 537 | Just read the desired tree into the index, and do: |
| 538 | </p> |
| 539 | <div class="listingblock"> |
| 540 | <div class="content"> |
Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame] | 541 | <pre><tt>$ git checkout-index --prefix=git-export-dir/ -a</tt></pre> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 542 | </div></div> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 543 | <div class="para"><p><tt>git checkout-index</tt> will "export" the index into the specified |
| 544 | directory.</p></div> |
| 545 | <div class="para"><p>The final "/" is important. The exported name is literally just |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 546 | prefixed with the specified string. Contrast this with the |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 547 | following example.</p></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 548 | </dd> |
| 549 | <dt> |
| 550 | Export files with a prefix |
| 551 | </dt> |
| 552 | <dd> |
| 553 | <div class="listingblock"> |
| 554 | <div class="content"> |
Junio C Hamano | fce7c7e | 2008-07-02 03:06:38 | [diff] [blame] | 555 | <pre><tt>$ git checkout-index --prefix=.merged- Makefile</tt></pre> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 556 | </div></div> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 557 | <div class="para"><p>This will check out the currently cached copy of <tt>Makefile</tt> |
| 558 | into the file <tt>.merged-Makefile</tt>.</p></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 559 | </dd> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 560 | </dl></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 561 | </div> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 562 | <h2 id="_author">Author</h2> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 563 | <div class="sectionbody"> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 564 | <div class="para"><p>Written by Linus Torvalds <torvalds@osdl.org></p></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 565 | </div> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 566 | <h2 id="_documentation">Documentation</h2> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 567 | <div class="sectionbody"> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 568 | <div class="para"><p>Documentation by David Greaves, |
| 569 | Junio C Hamano and the git-list <git@vger.kernel.org>.</p></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 570 | </div> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 571 | <h2 id="_git">GIT</h2> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 572 | <div class="sectionbody"> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 573 | <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div> |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 574 | </div> |
| 575 | <div id="footer"> |
| 576 | <div id="footer-text"> |
Junio C Hamano | ba4b928 | 2008-07-06 05:20:31 | [diff] [blame] | 577 | Last updated 2008-07-06 05:16:37 UTC |
Junio C Hamano | 1a4e841 | 2005-12-27 08:17:23 | [diff] [blame] | 578 | </div> |
| 579 | </div> |
| 580 | </body> |
| 581 | </html> |