Autogenerated HTML docs for v2.41.0-28-gd7d884
[git-htmldocs.git] / git-restore.html
blob389d9784f10634026db297c1d51ed765f61ef5c1
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5 <head>
6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
7 <meta name="generator" content="AsciiDoc 10.2.0" />
8 <title>git-restore(1)</title>
9 <style type="text/css">
10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
12 /* Default font. */
13 body {
14 font-family: Georgia,serif;
17 /* Title font. */
18 h1, h2, h3, h4, h5, h6,
19 div.title, caption.title,
20 thead, p.table.header,
21 #toctitle,
22 #author, #revnumber, #revdate, #revremark,
23 #footer {
24 font-family: Arial,Helvetica,sans-serif;
27 body {
28 margin: 1em 5% 1em 5%;
31 a {
32 color: blue;
33 text-decoration: underline;
35 a:visited {
36 color: fuchsia;
39 em {
40 font-style: italic;
41 color: navy;
44 strong {
45 font-weight: bold;
46 color: #083194;
49 h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
56 h1, h2, h3 {
57 border-bottom: 2px solid silver;
59 h2 {
60 padding-top: 0.5em;
62 h3 {
63 float: left;
65 h3 + * {
66 clear: left;
68 h5 {
69 font-size: 1.0em;
72 div.sectionbody {
73 margin-left: 0;
76 hr {
77 border: 1px solid silver;
80 p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
85 ul, ol, li > p {
86 margin-top: 0;
88 ul > li { color: #aaa; }
89 ul > li > * { color: black; }
91 .monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
95 padding: 0;
96 margin: 0;
98 pre {
99 white-space: pre-wrap;
102 #author {
103 color: #527bbd;
104 font-weight: bold;
105 font-size: 1.1em;
107 #email {
109 #revnumber, #revdate, #revremark {
112 #footer {
113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
118 #footer-text {
119 float: left;
120 padding-bottom: 0.5em;
122 #footer-badges {
123 float: right;
124 padding-bottom: 0.5em;
127 #preamble {
128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
131 div.imageblock, div.exampleblock, div.verseblock,
132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133 div.admonitionblock {
134 margin-top: 1.0em;
135 margin-bottom: 1.5em;
137 div.admonitionblock {
138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
144 div.content { /* Block element content. */
145 padding: 0;
148 /* Block element titles. */
149 div.title, caption.title {
150 color: #527bbd;
151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
156 div.title + * {
157 margin-top: 0;
160 td div.title:first-child {
161 margin-top: 0.0em;
163 div.content div.title:first-child {
164 margin-top: 0.0em;
166 div.content + div.title {
167 margin-top: 0.0em;
170 div.sidebarblock > div.content {
171 background: #ffffee;
172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
174 padding: 0.5em;
177 div.listingblock > div.content {
178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
181 padding: 0.5em;
184 div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
187 margin-right: 10%;
188 border-left: 5px solid #f0f0f0;
189 color: #888;
192 div.quoteblock > div.attribution {
193 padding-top: 0.5em;
194 text-align: right;
197 div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
201 div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
206 div.verseblock + div.attribution {
207 text-align: left;
210 div.admonitionblock .icon {
211 vertical-align: top;
212 font-size: 1.1em;
213 font-weight: bold;
214 text-decoration: underline;
215 color: #527bbd;
216 padding-right: 0.5em;
218 div.admonitionblock td.content {
219 padding-left: 0.5em;
220 border-left: 3px solid #dddddd;
223 div.exampleblock > div.content {
224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
228 div.imageblock div.content { padding-left: 0; }
229 span.image img { border-style: none; vertical-align: text-bottom; }
230 a.image:visited { color: white; }
232 dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
236 dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
239 font-style: normal;
240 color: navy;
242 dd > *:first-child {
243 margin-top: 0.1em;
246 ul, ol {
247 list-style-position: outside;
249 ol.arabic {
250 list-style-type: decimal;
252 ol.loweralpha {
253 list-style-type: lower-alpha;
255 ol.upperalpha {
256 list-style-type: upper-alpha;
258 ol.lowerroman {
259 list-style-type: lower-roman;
261 ol.upperroman {
262 list-style-type: upper-roman;
265 div.compact ul, div.compact ol,
266 div.compact p, div.compact p,
267 div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
272 tfoot {
273 font-weight: bold;
275 td > div.verse {
276 white-space: pre;
279 div.hdlist {
280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
283 div.hdlist tr {
284 padding-bottom: 15px;
286 dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
289 td.hdlist1 {
290 vertical-align: top;
291 font-style: normal;
292 padding-right: 0.8em;
293 color: navy;
295 td.hdlist2 {
296 vertical-align: top;
298 div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
303 .comment {
304 background: yellow;
307 .footnote, .footnoteref {
308 font-size: 0.8em;
311 span.footnote, span.footnoteref {
312 vertical-align: super;
315 #footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
320 #footnotes div.footnote {
321 margin: 0 0 5px 0;
324 #footnotes hr {
325 border: none;
326 border-top: 1px solid silver;
327 height: 1px;
328 text-align: left;
329 margin-left: 0;
330 width: 20%;
331 min-width: 100px;
334 div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
339 div.colist td img {
340 margin-top: 0.3em;
343 @media print {
344 #footer-badges { display: none; }
347 #toc {
348 margin-bottom: 2.5em;
351 #toctitle {
352 color: #527bbd;
353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
360 margin-top: 0;
361 margin-bottom: 0;
363 div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
367 div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
371 div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
376 span.aqua { color: aqua; }
377 span.black { color: black; }
378 span.blue { color: blue; }
379 span.fuchsia { color: fuchsia; }
380 span.gray { color: gray; }
381 span.green { color: green; }
382 span.lime { color: lime; }
383 span.maroon { color: maroon; }
384 span.navy { color: navy; }
385 span.olive { color: olive; }
386 span.purple { color: purple; }
387 span.red { color: red; }
388 span.silver { color: silver; }
389 span.teal { color: teal; }
390 span.white { color: white; }
391 span.yellow { color: yellow; }
393 span.aqua-background { background: aqua; }
394 span.black-background { background: black; }
395 span.blue-background { background: blue; }
396 span.fuchsia-background { background: fuchsia; }
397 span.gray-background { background: gray; }
398 span.green-background { background: green; }
399 span.lime-background { background: lime; }
400 span.maroon-background { background: maroon; }
401 span.navy-background { background: navy; }
402 span.olive-background { background: olive; }
403 span.purple-background { background: purple; }
404 span.red-background { background: red; }
405 span.silver-background { background: silver; }
406 span.teal-background { background: teal; }
407 span.white-background { background: white; }
408 span.yellow-background { background: yellow; }
410 span.big { font-size: 2em; }
411 span.small { font-size: 0.6em; }
413 span.underline { text-decoration: underline; }
414 span.overline { text-decoration: overline; }
415 span.line-through { text-decoration: line-through; }
417 div.unbreakable { page-break-inside: avoid; }
421 * xhtml11 specific
423 * */
425 div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
429 div.tableblock > table {
430 border: 3px solid #527bbd;
432 thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
436 p.table {
437 margin-top: 0;
439 /* Because the table frame attribute is overridden by CSS in most browsers. */
440 div.tableblock > table[frame="void"] {
441 border-style: none;
443 div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
447 div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
454 * html5 specific
456 * */
458 table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
462 thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
466 p.tableblock {
467 margin-top: 0;
469 table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
476 th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
483 table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
487 table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
491 table.tableblock.frame-none {
492 border-style: hidden;
495 th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
498 th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
501 th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
505 th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
508 th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
517 * manpage specific
519 * */
521 body.manpage h1 {
522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
527 body.manpage h2 {
528 border-style: none;
530 body.manpage div.sectionbody {
531 margin-left: 3em;
534 @media print {
535 body.manpage div#toc { display: none; }
539 </style>
540 <script type="text/javascript">
541 /*<![CDATA[*/
542 var asciidoc = { // Namespace.
544 /////////////////////////////////////////////////////////////////////
545 // Table Of Contents generator
546 /////////////////////////////////////////////////////////////////////
548 /* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
551 * Table Of Content generator
552 * Version: 0.4
554 * Feel free to use this script under the terms of the GNU General Public
555 * License, as long as you do not remove or alter this notice.
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
561 // toclevels = 1..4.
562 toc: function (toclevels) {
564 function getText(el) {
565 var text = "";
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
568 text += i.data;
569 else if (i.firstChild != null)
570 text += getText(i);
572 return text;
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
581 function tocEntries(el, toclevels) {
582 var result = new Array;
583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
586 // browsers).
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
594 iterate(i);
598 iterate(el);
599 return result;
602 var toc = document.getElementById("toc");
603 if (!toc) {
604 return;
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
609 var i;
610 for (i = 0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
612 if (entry.nodeName.toLowerCase() == 'div'
613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
621 // Rebuild TOC entries.
622 var entries = tocEntries(document.getElementById("content"), toclevels);
623 for (var i = 0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id == "")
626 entry.element.id = "_toc_" + i;
627 var a = document.createElement("a");
628 a.href = "#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement("div");
631 div.appendChild(a);
632 div.className = "toclevel" + entry.toclevel;
633 toc.appendChild(div);
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
640 /////////////////////////////////////////////////////////////////////
641 // Footnotes generator
642 /////////////////////////////////////////////////////////////////////
644 /* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
648 footnotes: function () {
649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
651 var noteholder = document.getElementById("footnotes");
652 if (!noteholder) {
653 return;
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
659 entriesToRemove.push(entry);
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
667 var spans = cont.getElementsByTagName("span");
668 var refs = {};
669 var n = 0;
670 for (i=0; i<spans.length; i++) {
671 if (spans[i].className == "footnote") {
672 n++;
673 var note = spans[i].getAttribute("data-note");
674 if (!note) {
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
678 spans[i].innerHTML =
679 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n + "</a>]";
681 spans[i].setAttribute("data-note", note);
683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
691 if (n == 0)
692 noteholder.parentNode.removeChild(noteholder);
693 else {
694 // Process footnoterefs.
695 for (i=0; i<spans.length; i++) {
696 if (spans[i].className == "footnoteref") {
697 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
698 href = href.match(/#.*/)[0]; // Because IE return full URL.
699 n = refs[href];
700 spans[i].innerHTML =
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
708 install: function(toclevels) {
709 var timerId;
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
731 asciidoc.install();
732 /*]]>*/
733 </script>
734 </head>
735 <body class="manpage">
736 <div id="header">
737 <h1>
738 git-restore(1) Manual Page
739 </h1>
740 <h2>NAME</h2>
741 <div class="sectionbody">
742 <p>git-restore -
743 Restore working tree files
744 </p>
745 </div>
746 </div>
747 <div id="content">
748 <div class="sect1">
749 <h2 id="_synopsis">SYNOPSIS</h2>
750 <div class="sectionbody">
751 <div class="verseblock">
752 <pre class="content"><em>git restore</em> [&lt;options&gt;] [--source=&lt;tree&gt;] [--staged] [--worktree] [--] &lt;pathspec&gt;&#8230;
753 <em>git restore</em> [&lt;options&gt;] [--source=&lt;tree&gt;] [--staged] [--worktree] --pathspec-from-file=&lt;file&gt; [--pathspec-file-nul]
754 <em>git restore</em> (-p|--patch) [&lt;options&gt;] [--source=&lt;tree&gt;] [--staged] [--worktree] [--] [&lt;pathspec&gt;&#8230;]</pre>
755 <div class="attribution">
756 </div></div>
757 </div>
758 </div>
759 <div class="sect1">
760 <h2 id="_description">DESCRIPTION</h2>
761 <div class="sectionbody">
762 <div class="paragraph"><p>Restore specified paths in the working tree with some contents from a
763 restore source. If a path is tracked but does not exist in the restore
764 source, it will be removed to match the source.</p></div>
765 <div class="paragraph"><p>The command can also be used to restore the content in the index with
766 <code>--staged</code>, or restore both the working tree and the index with
767 <code>--staged --worktree</code>.</p></div>
768 <div class="paragraph"><p>By default, if <code>--staged</code> is given, the contents are restored from <code>HEAD</code>,
769 otherwise from the index. Use <code>--source</code> to restore from a different commit.</p></div>
770 <div class="paragraph"><p>See "Reset, restore and revert" in <a href="git.html">git(1)</a> for the differences
771 between the three commands.</p></div>
772 <div class="paragraph"><p>THIS COMMAND IS EXPERIMENTAL. THE BEHAVIOR MAY CHANGE.</p></div>
773 </div>
774 </div>
775 <div class="sect1">
776 <h2 id="_options">OPTIONS</h2>
777 <div class="sectionbody">
778 <div class="dlist"><dl>
779 <dt class="hdlist1">
780 -s &lt;tree&gt;
781 </dt>
782 <dt class="hdlist1">
783 --source=&lt;tree&gt;
784 </dt>
785 <dd>
787 Restore the working tree files with the content from the given
788 tree. It is common to specify the source tree by naming a
789 commit, branch or tag associated with it.
790 </p>
791 <div class="paragraph"><p>If not specified, the contents are restored from <code>HEAD</code> if <code>--staged</code> is
792 given, otherwise from the index.</p></div>
793 <div class="paragraph"><p>As a special case, you may use <code>"A...B"</code> as a shortcut for the
794 merge base of <code>A</code> and <code>B</code> if there is exactly one merge base. You can
795 leave out at most one of <code>A</code> and <code>B</code>, in which case it defaults to <code>HEAD</code>.</p></div>
796 </dd>
797 <dt class="hdlist1">
799 </dt>
800 <dt class="hdlist1">
801 --patch
802 </dt>
803 <dd>
805 Interactively select hunks in the difference between the
806 restore source and the restore location. See the &#8220;Interactive
807 Mode&#8221; section of <a href="git-add.html">git-add(1)</a> to learn how to operate
808 the <code>--patch</code> mode.
809 </p>
810 <div class="paragraph"><p>Note that <code>--patch</code> can accept no pathspec and will prompt to restore
811 all modified paths.</p></div>
812 </dd>
813 <dt class="hdlist1">
815 </dt>
816 <dt class="hdlist1">
817 --worktree
818 </dt>
819 <dt class="hdlist1">
821 </dt>
822 <dt class="hdlist1">
823 --staged
824 </dt>
825 <dd>
827 Specify the restore location. If neither option is specified,
828 by default the working tree is restored. Specifying <code>--staged</code>
829 will only restore the index. Specifying both restores both.
830 </p>
831 </dd>
832 <dt class="hdlist1">
834 </dt>
835 <dt class="hdlist1">
836 --quiet
837 </dt>
838 <dd>
840 Quiet, suppress feedback messages. Implies <code>--no-progress</code>.
841 </p>
842 </dd>
843 <dt class="hdlist1">
844 --progress
845 </dt>
846 <dt class="hdlist1">
847 --no-progress
848 </dt>
849 <dd>
851 Progress status is reported on the standard error stream
852 by default when it is attached to a terminal, unless <code>--quiet</code>
853 is specified. This flag enables progress reporting even if not
854 attached to a terminal, regardless of <code>--quiet</code>.
855 </p>
856 </dd>
857 <dt class="hdlist1">
858 --ours
859 </dt>
860 <dt class="hdlist1">
861 --theirs
862 </dt>
863 <dd>
865 When restoring files in the working tree from the index, use
866 stage #2 (<em>ours</em>) or #3 (<em>theirs</em>) for unmerged paths.
867 </p>
868 <div class="paragraph"><p>Note that during <code>git rebase</code> and <code>git pull --rebase</code>, <em>ours</em> and
869 <em>theirs</em> may appear swapped. See the explanation of the same options
870 in <a href="git-checkout.html">git-checkout(1)</a> for details.</p></div>
871 </dd>
872 <dt class="hdlist1">
874 </dt>
875 <dt class="hdlist1">
876 --merge
877 </dt>
878 <dd>
880 When restoring files on the working tree from the index,
881 recreate the conflicted merge in the unmerged paths.
882 </p>
883 </dd>
884 <dt class="hdlist1">
885 --conflict=&lt;style&gt;
886 </dt>
887 <dd>
889 The same as <code>--merge</code> option above, but changes the way the
890 conflicting hunks are presented, overriding the
891 <code>merge.conflictStyle</code> configuration variable. Possible values
892 are "merge" (default), "diff3", and "zdiff3".
893 </p>
894 </dd>
895 <dt class="hdlist1">
896 --ignore-unmerged
897 </dt>
898 <dd>
900 When restoring files on the working tree from the index, do
901 not abort the operation if there are unmerged entries and
902 neither <code>--ours</code>, <code>--theirs</code>, <code>--merge</code> or <code>--conflict</code> is
903 specified. Unmerged paths on the working tree are left alone.
904 </p>
905 </dd>
906 <dt class="hdlist1">
907 --ignore-skip-worktree-bits
908 </dt>
909 <dd>
911 In sparse checkout mode, by default is to only update entries
912 matched by <code>&lt;pathspec&gt;</code> and sparse patterns in
913 $GIT_DIR/info/sparse-checkout. This option ignores the sparse
914 patterns and unconditionally restores any files in
915 <code>&lt;pathspec&gt;</code>.
916 </p>
917 </dd>
918 <dt class="hdlist1">
919 --recurse-submodules
920 </dt>
921 <dt class="hdlist1">
922 --no-recurse-submodules
923 </dt>
924 <dd>
926 If <code>&lt;pathspec&gt;</code> names an active submodule and the restore location
927 includes the working tree, the submodule will only be updated if
928 this option is given, in which case its working tree will be
929 restored to the commit recorded in the superproject, and any local
930 modifications overwritten. If nothing (or
931 <code>--no-recurse-submodules</code>) is used, submodules working trees will
932 not be updated. Just like <a href="git-checkout.html">git-checkout(1)</a>, this will detach
933 <code>HEAD</code> of the submodule.
934 </p>
935 </dd>
936 <dt class="hdlist1">
937 --overlay
938 </dt>
939 <dt class="hdlist1">
940 --no-overlay
941 </dt>
942 <dd>
944 In overlay mode, the command never removes files when
945 restoring. In no-overlay mode, tracked files that do not
946 appear in the <code>--source</code> tree are removed, to make them match
947 <code>&lt;tree&gt;</code> exactly. The default is no-overlay mode.
948 </p>
949 </dd>
950 <dt class="hdlist1">
951 --pathspec-from-file=&lt;file&gt;
952 </dt>
953 <dd>
955 Pathspec is passed in <code>&lt;file&gt;</code> instead of commandline args. If
956 <code>&lt;file&gt;</code> is exactly <code>-</code> then standard input is used. Pathspec
957 elements are separated by LF or CR/LF. Pathspec elements can be
958 quoted as explained for the configuration variable <code>core.quotePath</code>
959 (see <a href="git-config.html">git-config(1)</a>). See also <code>--pathspec-file-nul</code> and
960 global <code>--literal-pathspecs</code>.
961 </p>
962 </dd>
963 <dt class="hdlist1">
964 --pathspec-file-nul
965 </dt>
966 <dd>
968 Only meaningful with <code>--pathspec-from-file</code>. Pathspec elements are
969 separated with NUL character and all other characters are taken
970 literally (including newlines and quotes).
971 </p>
972 </dd>
973 <dt class="hdlist1">
975 </dt>
976 <dd>
978 Do not interpret any more arguments as options.
979 </p>
980 </dd>
981 <dt class="hdlist1">
982 &lt;pathspec&gt;&#8230;
983 </dt>
984 <dd>
986 Limits the paths affected by the operation.
987 </p>
988 <div class="paragraph"><p>For more details, see the <em>pathspec</em> entry in <a href="gitglossary.html">gitglossary(7)</a>.</p></div>
989 </dd>
990 </dl></div>
991 </div>
992 </div>
993 <div class="sect1">
994 <h2 id="_examples">EXAMPLES</h2>
995 <div class="sectionbody">
996 <div class="paragraph"><p>The following sequence switches to the <code>master</code> branch, reverts the
997 <code>Makefile</code> to two revisions back, deletes hello.c by mistake, and gets
998 it back from the index.</p></div>
999 <div class="listingblock">
1000 <div class="content">
1001 <pre><code>$ git switch master
1002 $ git restore --source master~2 Makefile <b>&lt;1&gt;</b>
1003 $ rm -f hello.c
1004 $ git restore hello.c <b>&lt;2&gt;</b></code></pre>
1005 </div></div>
1006 <div class="colist arabic"><ol>
1007 <li>
1009 take a file out of another commit
1010 </p>
1011 </li>
1012 <li>
1014 restore hello.c from the index
1015 </p>
1016 </li>
1017 </ol></div>
1018 <div class="paragraph"><p>If you want to restore <em>all</em> C source files to match the version in
1019 the index, you can say</p></div>
1020 <div class="listingblock">
1021 <div class="content">
1022 <pre><code>$ git restore '*.c'</code></pre>
1023 </div></div>
1024 <div class="paragraph"><p>Note the quotes around <code>*.c</code>. The file <code>hello.c</code> will also be
1025 restored, even though it is no longer in the working tree, because the
1026 file globbing is used to match entries in the index (not in the
1027 working tree by the shell).</p></div>
1028 <div class="paragraph"><p>To restore all files in the current directory</p></div>
1029 <div class="listingblock">
1030 <div class="content">
1031 <pre><code>$ git restore .</code></pre>
1032 </div></div>
1033 <div class="paragraph"><p>or to restore all working tree files with <em>top</em> pathspec magic (see
1034 <a href="gitglossary.html">gitglossary(7)</a>)</p></div>
1035 <div class="listingblock">
1036 <div class="content">
1037 <pre><code>$ git restore :/</code></pre>
1038 </div></div>
1039 <div class="paragraph"><p>To restore a file in the index to match the version in <code>HEAD</code> (this is
1040 the same as using <a href="git-reset.html">git-reset(1)</a>)</p></div>
1041 <div class="listingblock">
1042 <div class="content">
1043 <pre><code>$ git restore --staged hello.c</code></pre>
1044 </div></div>
1045 <div class="paragraph"><p>or you can restore both the index and the working tree (this the same
1046 as using <a href="git-checkout.html">git-checkout(1)</a>)</p></div>
1047 <div class="listingblock">
1048 <div class="content">
1049 <pre><code>$ git restore --source=HEAD --staged --worktree hello.c</code></pre>
1050 </div></div>
1051 <div class="paragraph"><p>or the short form which is more practical but less readable:</p></div>
1052 <div class="listingblock">
1053 <div class="content">
1054 <pre><code>$ git restore -s@ -SW hello.c</code></pre>
1055 </div></div>
1056 </div>
1057 </div>
1058 <div class="sect1">
1059 <h2 id="_see_also">SEE ALSO</h2>
1060 <div class="sectionbody">
1061 <div class="paragraph"><p><a href="git-checkout.html">git-checkout(1)</a>,
1062 <a href="git-reset.html">git-reset(1)</a></p></div>
1063 </div>
1064 </div>
1065 <div class="sect1">
1066 <h2 id="_git">GIT</h2>
1067 <div class="sectionbody">
1068 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1069 </div>
1070 </div>
1071 </div>
1072 <div id="footnotes"><hr /></div>
1073 <div id="footer">
1074 <div id="footer-text">
1075 Last updated
1076 2021-12-15 12:58:55 PST
1077 </div>
1078 </div>
1079 </body>
1080 </html>