Google Git
Sign in
chromium / external / gitster / git-htmldocs / a28a920b817789e9535e30d163d1cfeda9803b99 / . / git-checkout-index.html
blob: 0a7fd35c5f28681ea65e7152e44ed13f104e269b [file] [log] [blame]
Junio C Hamano1a4e8412005-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 Hamano7bd050f2011-09-22 06:32:22[diff] [blame]6<meta name="generator" content="AsciiDoc 8.5.2" />
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7<title>git-checkout-index(1)</title>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]8<style type="text/css">
9/* Debug borders */
10p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11/*
12 border: 1px solid red;
13*/
14}
15
16body {
17 margin: 1em 5% 1em 5%;
18}
19
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]20a {
21 color: blue;
22 text-decoration: underline;
23}
24a:visited {
25 color: fuchsia;
26}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]27
28em {
29 font-style: italic;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]30 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]31}
32
33strong {
34 font-weight: bold;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]35 color: #083194;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]36}
37
38tt {
39 color: navy;
40}
41
42h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
48}
49
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]50h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]51 border-bottom: 2px solid silver;
52}
53h2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]54 padding-top: 0.5em;
55}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]56h3 {
57 float: left;
58}
59h3 + * {
60 clear: left;
61}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]62
63div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
66}
67
68hr {
69 border: 1px solid silver;
70}
71
72p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
75}
76
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]77ul, ol, li > p {
78 margin-top: 0;
79}
80
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]81pre {
82 padding: 0;
83 margin: 0;
84}
85
86span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]90 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]91}
92span#email {
93}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]94span#revnumber, span#revdate, span#revremark {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]95 font-family: sans-serif;
96}
97
98div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
104}
105div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
108}
109div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
112}
113
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]114div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
117}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]118div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]121 margin-top: 1.0em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]122 margin-bottom: 1.5em;
123}
124div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]129}
130
131div.content { /* Block element content. */
132 padding: 0;
133}
134
135/* Block element titles. */
136div.title, caption.title {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]137 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
143}
144div.title + * {
145 margin-top: 0;
146}
147
148td div.title:first-child {
149 margin-top: 0.0em;
150}
151div.content div.title:first-child {
152 margin-top: 0.0em;
153}
154div.content + div.title {
155 margin-top: 0.0em;
156}
157
158div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
162}
163
164div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
168}
169
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]170div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]173 margin-right: 10%;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]174 border-left: 5px solid #dddddd;
175 color: #777777;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]176}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]177
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]178div.quoteblock > div.attribution {
179 padding-top: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]180 text-align: right;
181}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]182
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]183div.verseblock > div.content {
184 white-space: pre;
185}
186div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
189}
190/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]191div.verseblock + div.attribution {
192 text-align: left;
193}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]194
195div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
202}
203div.admonitionblock td.content {
204 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]205 border-left: 3px solid #dddddd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]206}
207
208div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]211}
212
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]213div.imageblock div.content { padding-left: 0; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]214span.image img { border-style: none; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]215a.image:visited { color: white; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]216
217dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
220}
221dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]224 font-style: normal;
225 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]226}
227dd > *:first-child {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]228 margin-top: 0.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]229}
230
231ul, ol {
232 list-style-position: outside;
233}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]234ol.arabic {
235 list-style-type: decimal;
236}
237ol.loweralpha {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]238 list-style-type: lower-alpha;
239}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]240ol.upperalpha {
241 list-style-type: upper-alpha;
242}
243ol.lowerroman {
244 list-style-type: lower-roman;
245}
246ol.upperroman {
247 list-style-type: upper-roman;
248}
249
250div.compact ul, div.compact ol,
251div.compact p, div.compact p,
252div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
255}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]256
257div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]258 border: 3px solid #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]259}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]260thead, p.table.header {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]261 font-family: sans-serif;
262 font-weight: bold;
263}
264tfoot {
265 font-weight: bold;
266}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]267td > div.verse {
268 white-space: pre;
269}
270p.table {
271 margin-top: 0;
272}
273/* Because the table frame attribute is overriden by CSS in most browsers. */
274div.tableblock > table[frame="void"] {
275 border-style: none;
276}
277div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
280}
281div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
284}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]285
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]286
287div.hdlist {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
290}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]291div.hdlist tr {
292 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]293}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]294dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
296}
297td.hdlist1 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]298 vertical-align: top;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]299 font-style: normal;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]300 padding-right: 0.8em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]301 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]302}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]303td.hdlist2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]304 vertical-align: top;
305}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]306div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
309}
310
311.comment {
312 background: yellow;
313}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]314
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]315.footnote, .footnoteref {
316 font-size: 0.8em;
317}
318
319span.footnote, span.footnoteref {
320 vertical-align: super;
321}
322
323#footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
326}
327
328#footnotes div.footnote {
329 margin: 0 0 5px 0;
330}
331
332#footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
340}
341
342
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]343@media print {
344 div#footer-badges { display: none; }
345}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]346
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]347div#toc {
348 margin-bottom: 2.5em;
349}
350
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]351div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
358}
359
360div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
363}
364div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
367}
368div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
371}
372div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
375}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]376/* Overrides for manpage documents */
377h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
382}
383h2 {
384 border-style: none;
385}
386div.sectionbody {
387 margin-left: 5%;
388}
389
390@media print {
391 div#toc { display: none; }
392}
393
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]394/* Workarounds for IE6's broken and incomplete CSS2. */
395
396div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
400}
401div.sidebar-title, div.image-title {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]402 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
407}
408
409div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
413}
414
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]415div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
418}
419
420div.verseblock-content {
421 white-space: pre;
422}
423div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]426}
427
428div.exampleblock-content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]429 border-left: 3px solid #dddddd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]430 padding-left: 0.5em;
431}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]432
433/* IE6 sets dynamically generated links as visited. */
434div#toc a:visited { color: blue; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]435</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]436<script type="text/javascript">
437/*<![CDATA[*/
438window.onload = function(){asciidoc.footnotes();}
439var asciidoc = { // Namespace.
440
441/////////////////////////////////////////////////////////////////////
442// Table Of Contents generator
443/////////////////////////////////////////////////////////////////////
444
445/* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
447 *
448 * Table Of Content generator
449 * Version: 0.4
450 *
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
453 */
454
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
457
458// toclevels = 1..4.
459toc: function (toclevels) {
460
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
468 }
469 return text;
470 }
471
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
476 }
477
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
490 }
491 iterate(i);
492 }
493 }
494 }
495 iterate(el);
496 return result;
497 }
498
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
512 }
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
515},
516
517
518/////////////////////////////////////////////////////////////////////
519// Footnotes generator
520/////////////////////////////////////////////////////////////////////
521
522/* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
524 */
525
526footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
547 }
548 }
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
561 }
562 }
563 }
564}
565
566}
567/*]]>*/
568</script>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]569</head>
570<body>
571<div id="header">
572<h1>
573git-checkout-index(1) Manual Page
574</h1>
575<h2>NAME</h2>
576<div class="sectionbody">
577<p>git-checkout-index -
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]578 Copy files from the index to the working tree
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]579</p>
580</div>
581</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]582<div id="content">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]583<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]584<div class="sectionbody">
Junio C Hamano235a91e2006-01-07 01:13:58[diff] [blame]585<div class="verseblock">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]586<div class="verseblock-content"><em>git checkout-index</em> [-u] [-q] [-a] [-f] [-n] [--prefix=&lt;string&gt;]
Junio C Hamanof84a2b12006-03-07 05:16:28[diff] [blame]587 [--stage=&lt;number&gt;|all]
588 [--temp]
Junio C Hamanodecf50e2006-03-05 10:51:14[diff] [blame]589 [-z] [--stdin]
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]590 [--] [&lt;file&gt;&#8230;]</div>
591<div class="verseblock-attribution">
592</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]593</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]594<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]595<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]596<div class="paragraph"><p>Will copy all files listed from the index to the working directory
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]597(not overwriting existing files).</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]598</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]599<h2 id="_options">OPTIONS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]600<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]601<div class="dlist"><dl>
602<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]603-u
604</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]605<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]606--index
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]607</dt>
608<dd>
609<p>
610 update stat information for the checked out entries in
611 the index file.
612</p>
613</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]614<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]615-q
616</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]617<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]618--quiet
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]619</dt>
620<dd>
621<p>
622 be quiet if files exist or are not in the index
623</p>
624</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]625<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]626-f
627</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]628<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]629--force
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]630</dt>
631<dd>
632<p>
633 forces overwrite of existing files
634</p>
635</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]636<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]637-a
638</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]639<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]640--all
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]641</dt>
642<dd>
643<p>
644 checks out all files in the index. Cannot be used
645 together with explicit filenames.
646</p>
647</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]648<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]649-n
650</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]651<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]652--no-create
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]653</dt>
654<dd>
655<p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]656 Don&#8217;t checkout new files, only refresh files already checked
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]657 out.
658</p>
659</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]660<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]661--prefix=&lt;string&gt;
662</dt>
663<dd>
664<p>
665 When creating files, prepend &lt;string&gt; (usually a directory
666 including a trailing /)
667</p>
668</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]669<dt class="hdlist1">
Junio C Hamanof84a2b12006-03-07 05:16:28[diff] [blame]670--stage=&lt;number&gt;|all
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]671</dt>
672<dd>
673<p>
674 Instead of checking out unmerged entries, copy out the
675 files from named stage. &lt;number&gt; must be between 1 and 3.
Junio C Hamanof84a2b12006-03-07 05:16:28[diff] [blame]676 Note: --stage=all automatically implies --temp.
677</p>
678</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]679<dt class="hdlist1">
Junio C Hamanof84a2b12006-03-07 05:16:28[diff] [blame]680--temp
681</dt>
682<dd>
683<p>
684 Instead of copying the files to the working directory
685 write the content to temporary files. The temporary name
686 associations will be written to stdout.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]687</p>
688</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]689<dt class="hdlist1">
Junio C Hamanodecf50e2006-03-05 10:51:14[diff] [blame]690--stdin
691</dt>
692<dd>
693<p>
694 Instead of taking list of paths from the command line,
695 read list of paths from the standard input. Paths are
696 separated by LF (i.e. one path per line) by default.
697</p>
698</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]699<dt class="hdlist1">
Junio C Hamanodecf50e2006-03-05 10:51:14[diff] [blame]700-z
701</dt>
702<dd>
703<p>
704 Only meaningful with <tt>--stdin</tt>; paths are separated with
705 NUL character instead of LF.
706</p>
707</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]708<dt class="hdlist1">
Junio C Hamano1bb569e2006-05-05 23:14:25[diff] [blame]709--
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]710</dt>
711<dd>
712<p>
713 Do not interpret any more arguments as options.
714</p>
715</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]716</dl></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]717<div class="paragraph"><p>The order of the flags used to matter, but not anymore.</p></div>
718<div class="paragraph"><p>Just doing <tt>git checkout-index</tt> does nothing. You probably meant
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]719<tt>git checkout-index -a</tt>. And if you want to force it, you want
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]720<tt>git checkout-index -f -a</tt>.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]721<div class="paragraph"><p>Intuitiveness is not the goal here. Repeatability is. The reason for
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]722the "no arguments means no work" behavior is that from scripts you are
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]723supposed to be able to do:</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]724<div class="listingblock">
725<div class="content">
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]726<pre><tt>$ find . -name '*.h' -print0 | xargs -0 git checkout-index -f --</tt></pre>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]727</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]728<div class="paragraph"><p>which will force all existing <tt>*.h</tt> files to be replaced with their
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]729cached copies. If an empty command line implied "all", then this would
Junio C Hamanodecf50e2006-03-05 10:51:14[diff] [blame]730force-refresh everything in the index, which was not the point. But
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]731since <em>git checkout-index</em> accepts --stdin it would be faster to use:</p></div>
Junio C Hamanodecf50e2006-03-05 10:51:14[diff] [blame]732<div class="listingblock">
733<div class="content">
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]734<pre><tt>$ find . -name '*.h' -print0 | git checkout-index -f -z --stdin</tt></pre>
Junio C Hamanodecf50e2006-03-05 10:51:14[diff] [blame]735</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]736<div class="paragraph"><p>The <tt>--</tt> is just a good idea when you know the rest will be filenames;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]737it will prevent problems with a filename of, for example, <tt>-a</tt>.
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]738Using <tt>--</tt> is probably a good policy in scripts.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]739</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]740<h2 id="_using_temp_or_stage_all">Using --temp or --stage=all</h2>
Junio C Hamanof84a2b12006-03-07 05:16:28[diff] [blame]741<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]742<div class="paragraph"><p>When <tt>--temp</tt> is used (or implied by <tt>--stage=all</tt>)
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]743<em>git checkout-index</em> will create a temporary file for each index
Junio C Hamanof84a2b12006-03-07 05:16:28[diff] [blame]744entry being checked out. The index will not be updated with stat
745information. These options can be useful if the caller needs all
746stages of all unmerged entries so that the unmerged files can be
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]747processed by an external merge tool.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]748<div class="paragraph"><p>A listing will be written to stdout providing the association of
Junio C Hamanof84a2b12006-03-07 05:16:28[diff] [blame]749temporary file names to tracked path names. The listing format
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]750has two variations:</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]751<div class="olist arabic"><ol class="arabic">
Junio C Hamanof84a2b12006-03-07 05:16:28[diff] [blame]752<li>
753<p>
754tempname TAB path RS
755</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]756<div class="paragraph"><p>The first format is what gets used when <tt>--stage</tt> is omitted or
Junio C Hamanof84a2b12006-03-07 05:16:28[diff] [blame]757is not <tt>--stage=all</tt>. The field tempname is the temporary file
758name holding the file content and path is the tracked path name in
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]759the index. Only the requested entries are output.</p></div>
Junio C Hamanof84a2b12006-03-07 05:16:28[diff] [blame]760</li>
761<li>
762<p>
763stage1temp SP stage2temp SP stage3tmp TAB path RS
764</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]765<div class="paragraph"><p>The second format is what gets used when <tt>--stage=all</tt>. The three
Junio C Hamanof84a2b12006-03-07 05:16:28[diff] [blame]766stage temporary fields (stage1temp, stage2temp, stage3temp) list the
767name of the temporary file if there is a stage entry in the index
768or <tt>.</tt> if there is no stage entry. Paths which only have a stage 0
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]769entry will always be omitted from the output.</p></div>
Junio C Hamanof84a2b12006-03-07 05:16:28[diff] [blame]770</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]771</ol></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]772<div class="paragraph"><p>In both formats RS (the record separator) is newline by default
Junio C Hamanof84a2b12006-03-07 05:16:28[diff] [blame]773but will be the null byte if -z was passed on the command line.
774The temporary file names are always safe strings; they will never
775contain directory separators or whitespace characters. The path
776field is always relative to the current directory and the temporary
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]777file names are always relative to the top level directory.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]778<div class="paragraph"><p>If the object being copied out to a temporary file is a symbolic
Junio C Hamanof84a2b12006-03-07 05:16:28[diff] [blame]779link the content of the link will be written to a normal file. It is
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]780up to the end-user or the Porcelain to make use of this information.</p></div>
Junio C Hamanof84a2b12006-03-07 05:16:28[diff] [blame]781</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]782<h2 id="_examples">EXAMPLES</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]783<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]784<div class="dlist"><dl>
785<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]786To update and refresh only the files already checked out
787</dt>
788<dd>
789<div class="listingblock">
790<div class="content">
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]791<pre><tt>$ git checkout-index -n -f -a &amp;&amp; git update-index --ignore-missing --refresh</tt></pre>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]792</div></div>
793</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]794<dt class="hdlist1">
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]795Using <em>git checkout-index</em> to "export an entire tree"
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]796</dt>
797<dd>
798<p>
799 The prefix ability basically makes it trivial to use
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]800 <em>git checkout-index</em> as an "export as tree" function.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]801 Just read the desired tree into the index, and do:
802</p>
803<div class="listingblock">
804<div class="content">
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]805<pre><tt>$ git checkout-index --prefix=git-export-dir/ -a</tt></pre>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]806</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]807<div class="paragraph"><p><tt>git checkout-index</tt> will "export" the index into the specified
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]808directory.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]809<div class="paragraph"><p>The final "/" is important. The exported name is literally just
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]810prefixed with the specified string. Contrast this with the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]811following example.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]812</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]813<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]814Export files with a prefix
815</dt>
816<dd>
817<div class="listingblock">
818<div class="content">
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]819<pre><tt>$ git checkout-index --prefix=.merged- Makefile</tt></pre>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]820</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]821<div class="paragraph"><p>This will check out the currently cached copy of <tt>Makefile</tt>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]822into the file <tt>.merged-Makefile</tt>.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]823</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]824</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]825</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]826<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]827<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame^]828<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]829</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]830</div>
831<div id="footnotes"><hr /></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]832<div id="footer">
833<div id="footer-text">
Junio C Hamano02194af2011-11-17 20:33:59[diff] [blame]834Last updated 2011-11-15 13:45:02 PDT
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]835</div>
836</div>
837</body>
838</html>