Autogenerated HTML docs for v2.44.0-591-g8f758
[git-htmldocs.git] / git-reset.html
blob0dfcc35306fbab5e03c0592cec80ddab3a7bd900
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-reset(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-reset(1) Manual Page
739 </h1>
740 <h2>NAME</h2>
741 <div class="sectionbody">
742 <p>git-reset -
743 Reset current HEAD to the specified state
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 reset</em> [-q] [&lt;tree-ish&gt;] [--] &lt;pathspec&gt;&#8230;
753 <em>git reset</em> [-q] [--pathspec-from-file=&lt;file&gt; [--pathspec-file-nul]] [&lt;tree-ish&gt;]
754 <em>git reset</em> (--patch | -p) [&lt;tree-ish&gt;] [--] [&lt;pathspec&gt;&#8230;]
755 <em>git reset</em> [--soft | --mixed [-N] | --hard | --merge | --keep] [-q] [&lt;commit&gt;]</pre>
756 <div class="attribution">
757 </div></div>
758 </div>
759 </div>
760 <div class="sect1">
761 <h2 id="_description">DESCRIPTION</h2>
762 <div class="sectionbody">
763 <div class="paragraph"><p>In the first three forms, copy entries from <code>&lt;tree-ish&gt;</code> to the index.
764 In the last form, set the current branch head (<code>HEAD</code>) to <code>&lt;commit&gt;</code>,
765 optionally modifying index and working tree to match.
766 The <code>&lt;tree-ish&gt;</code>/<code>&lt;commit&gt;</code> defaults to <code>HEAD</code> in all forms.</p></div>
767 <div class="dlist"><dl>
768 <dt class="hdlist1">
769 <em>git reset</em> [-q] [&lt;tree-ish&gt;] [--] &lt;pathspec&gt;&#8230;
770 </dt>
771 <dt class="hdlist1">
772 <em>git reset</em> [-q] [--pathspec-from-file=&lt;file&gt; [--pathspec-file-nul]] [&lt;tree-ish&gt;]
773 </dt>
774 <dd>
776 These forms reset the index entries for all paths that match the
777 <code>&lt;pathspec&gt;</code> to their state at <code>&lt;tree-ish&gt;</code>. (It does not affect
778 the working tree or the current branch.)
779 </p>
780 <div class="paragraph"><p>This means that <code>git reset &lt;pathspec&gt;</code> is the opposite of <code>git add
781 &lt;pathspec&gt;</code>. This command is equivalent to
782 <code>git restore [--source=&lt;tree-ish&gt;] --staged &lt;pathspec&gt;...</code>.</p></div>
783 <div class="paragraph"><p>After running <code>git reset &lt;pathspec&gt;</code> to update the index entry, you can
784 use <a href="git-restore.html">git-restore(1)</a> to check the contents out of the index to
785 the working tree. Alternatively, using <a href="git-restore.html">git-restore(1)</a>
786 and specifying a commit with <code>--source</code>, you
787 can copy the contents of a path out of a commit to the index and to the
788 working tree in one go.</p></div>
789 </dd>
790 <dt class="hdlist1">
791 <em>git reset</em> (--patch | -p) [&lt;tree-ish&gt;] [--] [&lt;pathspec&gt;&#8230;]
792 </dt>
793 <dd>
795 Interactively select hunks in the difference between the index
796 and <code>&lt;tree-ish&gt;</code> (defaults to <code>HEAD</code>). The chosen hunks are applied
797 in reverse to the index.
798 </p>
799 <div class="paragraph"><p>This means that <code>git reset -p</code> is the opposite of <code>git add -p</code>, i.e.
800 you can use it to selectively reset hunks. See the &#8220;Interactive Mode&#8221;
801 section of <a href="git-add.html">git-add(1)</a> to learn how to operate the <code>--patch</code> mode.</p></div>
802 </dd>
803 <dt class="hdlist1">
804 <em>git reset</em> [&lt;mode&gt;] [&lt;commit&gt;]
805 </dt>
806 <dd>
808 This form resets the current branch head to <code>&lt;commit&gt;</code> and
809 possibly updates the index (resetting it to the tree of <code>&lt;commit&gt;</code>) and
810 the working tree depending on <code>&lt;mode&gt;</code>. Before the operation, <code>ORIG_HEAD</code>
811 is set to the tip of the current branch. If <code>&lt;mode&gt;</code> is omitted,
812 defaults to <code>--mixed</code>. The <code>&lt;mode&gt;</code> must be one of the following:
813 </p>
814 <div class="openblock">
815 <div class="content">
816 <div class="dlist"><dl>
817 <dt class="hdlist1">
818 --soft
819 </dt>
820 <dd>
822 Does not touch the index file or the working tree at all (but
823 resets the head to <code>&lt;commit&gt;</code>, just like all modes do). This leaves
824 all your changed files "Changes to be committed", as <code>git status</code>
825 would put it.
826 </p>
827 </dd>
828 <dt class="hdlist1">
829 --mixed
830 </dt>
831 <dd>
833 Resets the index but not the working tree (i.e., the changed files
834 are preserved but not marked for commit) and reports what has not
835 been updated. This is the default action.
836 </p>
837 <div class="paragraph"><p>If <code>-N</code> is specified, removed paths are marked as intent-to-add (see
838 <a href="git-add.html">git-add(1)</a>).</p></div>
839 </dd>
840 <dt class="hdlist1">
841 --hard
842 </dt>
843 <dd>
845 Resets the index and working tree. Any changes to tracked files in the
846 working tree since <code>&lt;commit&gt;</code> are discarded. Any untracked files or
847 directories in the way of writing any tracked files are simply deleted.
848 </p>
849 </dd>
850 <dt class="hdlist1">
851 --merge
852 </dt>
853 <dd>
855 Resets the index and updates the files in the working tree that are
856 different between <code>&lt;commit&gt;</code> and <code>HEAD</code>, but keeps those which are
857 different between the index and working tree (i.e. which have changes
858 which have not been added).
859 If a file that is different between <code>&lt;commit&gt;</code> and the index has
860 unstaged changes, reset is aborted.
861 </p>
862 <div class="paragraph"><p>In other words, <code>--merge</code> does something like a <code>git read-tree -u -m &lt;commit&gt;</code>,
863 but carries forward unmerged index entries.</p></div>
864 </dd>
865 <dt class="hdlist1">
866 --keep
867 </dt>
868 <dd>
870 Resets index entries and updates files in the working tree that are
871 different between <code>&lt;commit&gt;</code> and <code>HEAD</code>.
872 If a file that is different between <code>&lt;commit&gt;</code> and <code>HEAD</code> has local
873 changes, reset is aborted.
874 </p>
875 </dd>
876 <dt class="hdlist1">
877 --[no-]recurse-submodules
878 </dt>
879 <dd>
881 When the working tree is updated, using --recurse-submodules will
882 also recursively reset the working tree of all active submodules
883 according to the commit recorded in the superproject, also setting
884 the submodules' HEAD to be detached at that commit.
885 </p>
886 </dd>
887 </dl></div>
888 </div></div>
889 </dd>
890 </dl></div>
891 <div class="paragraph"><p>See "Reset, restore and revert" in <a href="git.html">git(1)</a> for the differences
892 between the three commands.</p></div>
893 </div>
894 </div>
895 <div class="sect1">
896 <h2 id="_options">OPTIONS</h2>
897 <div class="sectionbody">
898 <div class="dlist"><dl>
899 <dt class="hdlist1">
901 </dt>
902 <dt class="hdlist1">
903 --quiet
904 </dt>
905 <dd>
907 Be quiet, only report errors.
908 </p>
909 </dd>
910 <dt class="hdlist1">
911 --refresh
912 </dt>
913 <dt class="hdlist1">
914 --no-refresh
915 </dt>
916 <dd>
918 Refresh the index after a mixed reset. Enabled by default.
919 </p>
920 </dd>
921 <dt class="hdlist1">
922 --pathspec-from-file=&lt;file&gt;
923 </dt>
924 <dd>
926 Pathspec is passed in <code>&lt;file&gt;</code> instead of commandline args. If
927 <code>&lt;file&gt;</code> is exactly <code>-</code> then standard input is used. Pathspec
928 elements are separated by LF or CR/LF. Pathspec elements can be
929 quoted as explained for the configuration variable <code>core.quotePath</code>
930 (see <a href="git-config.html">git-config(1)</a>). See also <code>--pathspec-file-nul</code> and
931 global <code>--literal-pathspecs</code>.
932 </p>
933 </dd>
934 <dt class="hdlist1">
935 --pathspec-file-nul
936 </dt>
937 <dd>
939 Only meaningful with <code>--pathspec-from-file</code>. Pathspec elements are
940 separated with NUL character and all other characters are taken
941 literally (including newlines and quotes).
942 </p>
943 </dd>
944 <dt class="hdlist1">
946 </dt>
947 <dd>
949 Do not interpret any more arguments as options.
950 </p>
951 </dd>
952 <dt class="hdlist1">
953 &lt;pathspec&gt;&#8230;
954 </dt>
955 <dd>
957 Limits the paths affected by the operation.
958 </p>
959 <div class="paragraph"><p>For more details, see the <em>pathspec</em> entry in <a href="gitglossary.html">gitglossary(7)</a>.</p></div>
960 </dd>
961 </dl></div>
962 </div>
963 </div>
964 <div class="sect1">
965 <h2 id="_examples">EXAMPLES</h2>
966 <div class="sectionbody">
967 <div class="dlist"><dl>
968 <dt class="hdlist1">
969 Undo add
970 </dt>
971 <dd>
972 <div class="listingblock">
973 <div class="content">
974 <pre><code>$ edit <b>&lt;1&gt;</b>
975 $ git add frotz.c filfre.c
976 $ mailx <b>&lt;2&gt;</b>
977 $ git reset <b>&lt;3&gt;</b>
978 $ git pull git://info.example.com/ nitfol <b>&lt;4&gt;</b></code></pre>
979 </div></div>
980 <div class="colist arabic"><ol>
981 <li>
983 You are happily working on something, and find the changes
984 in these files are in good order. You do not want to see them
985 when you run <code>git diff</code>, because you plan to work on other files
986 and changes with these files are distracting.
987 </p>
988 </li>
989 <li>
991 Somebody asks you to pull, and the changes sound worthy of merging.
992 </p>
993 </li>
994 <li>
996 However, you already dirtied the index (i.e. your index does
997 not match the <code>HEAD</code> commit). But you know the pull you are going
998 to make does not affect <code>frotz.c</code> or <code>filfre.c</code>, so you revert the
999 index changes for these two files. Your changes in working tree
1000 remain there.
1001 </p>
1002 </li>
1003 <li>
1005 Then you can pull and merge, leaving <code>frotz.c</code> and <code>filfre.c</code>
1006 changes still in the working tree.
1007 </p>
1008 </li>
1009 </ol></div>
1010 </dd>
1011 <dt class="hdlist1">
1012 Undo a commit and redo
1013 </dt>
1014 <dd>
1015 <div class="listingblock">
1016 <div class="content">
1017 <pre><code>$ git commit ...
1018 $ git reset --soft HEAD^ <b>&lt;1&gt;</b>
1019 $ edit <b>&lt;2&gt;</b>
1020 $ git commit -a -c ORIG_HEAD <b>&lt;3&gt;</b></code></pre>
1021 </div></div>
1022 <div class="colist arabic"><ol>
1023 <li>
1025 This is most often done when you remembered what you
1026 just committed is incomplete, or you misspelled your commit
1027 message, or both. Leaves working tree as it was before "reset".
1028 </p>
1029 </li>
1030 <li>
1032 Make corrections to working tree files.
1033 </p>
1034 </li>
1035 <li>
1037 "reset" copies the old head to <code>.git/ORIG_HEAD</code>; redo the
1038 commit by starting with its log message. If you do not need to
1039 edit the message further, you can give <code>-C</code> option instead.
1040 </p>
1041 <div class="paragraph"><p>See also the <code>--amend</code> option to <a href="git-commit.html">git-commit(1)</a>.</p></div>
1042 </li>
1043 </ol></div>
1044 </dd>
1045 <dt class="hdlist1">
1046 Undo a commit, making it a topic branch
1047 </dt>
1048 <dd>
1049 <div class="listingblock">
1050 <div class="content">
1051 <pre><code>$ git branch topic/wip <b>&lt;1&gt;</b>
1052 $ git reset --hard HEAD~3 <b>&lt;2&gt;</b>
1053 $ git switch topic/wip <b>&lt;3&gt;</b></code></pre>
1054 </div></div>
1055 <div class="colist arabic"><ol>
1056 <li>
1058 You have made some commits, but realize they were premature
1059 to be in the <code>master</code> branch. You want to continue polishing
1060 them in a topic branch, so create <code>topic/wip</code> branch off of the
1061 current <code>HEAD</code>.
1062 </p>
1063 </li>
1064 <li>
1066 Rewind the master branch to get rid of those three commits.
1067 </p>
1068 </li>
1069 <li>
1071 Switch to <code>topic/wip</code> branch and keep working.
1072 </p>
1073 </li>
1074 </ol></div>
1075 </dd>
1076 <dt class="hdlist1">
1077 Undo commits permanently
1078 </dt>
1079 <dd>
1080 <div class="listingblock">
1081 <div class="content">
1082 <pre><code>$ git commit ...
1083 $ git reset --hard HEAD~3 <b>&lt;1&gt;</b></code></pre>
1084 </div></div>
1085 <div class="colist arabic"><ol>
1086 <li>
1088 The last three commits (<code>HEAD</code>, <code>HEAD^</code>, and <code>HEAD~2</code>) were bad
1089 and you do not want to ever see them again. Do <strong>not</strong> do this if
1090 you have already given these commits to somebody else. (See the
1091 "RECOVERING FROM UPSTREAM REBASE" section in <a href="git-rebase.html">git-rebase(1)</a>
1092 for the implications of doing so.)
1093 </p>
1094 </li>
1095 </ol></div>
1096 </dd>
1097 <dt class="hdlist1">
1098 Undo a merge or pull
1099 </dt>
1100 <dd>
1101 <div class="listingblock">
1102 <div class="content">
1103 <pre><code>$ git pull <b>&lt;1&gt;</b>
1104 Auto-merging nitfol
1105 CONFLICT (content): Merge conflict in nitfol
1106 Automatic merge failed; fix conflicts and then commit the result.
1107 $ git reset --hard <b>&lt;2&gt;</b>
1108 $ git pull . topic/branch <b>&lt;3&gt;</b>
1109 Updating from 41223... to 13134...
1110 Fast-forward
1111 $ git reset --hard ORIG_HEAD <b>&lt;4&gt;</b></code></pre>
1112 </div></div>
1113 <div class="colist arabic"><ol>
1114 <li>
1116 Try to update from the upstream resulted in a lot of
1117 conflicts; you were not ready to spend a lot of time merging
1118 right now, so you decide to do that later.
1119 </p>
1120 </li>
1121 <li>
1123 "pull" has not made merge commit, so <code>git reset --hard</code>
1124 which is a synonym for <code>git reset --hard HEAD</code> clears the mess
1125 from the index file and the working tree.
1126 </p>
1127 </li>
1128 <li>
1130 Merge a topic branch into the current branch, which resulted
1131 in a fast-forward.
1132 </p>
1133 </li>
1134 <li>
1136 But you decided that the topic branch is not ready for public
1137 consumption yet. "pull" or "merge" always leaves the original
1138 tip of the current branch in <code>ORIG_HEAD</code>, so resetting hard to it
1139 brings your index file and the working tree back to that state,
1140 and resets the tip of the branch to that commit.
1141 </p>
1142 </li>
1143 </ol></div>
1144 </dd>
1145 <dt class="hdlist1">
1146 Undo a merge or pull inside a dirty working tree
1147 </dt>
1148 <dd>
1149 <div class="listingblock">
1150 <div class="content">
1151 <pre><code>$ git pull <b>&lt;1&gt;</b>
1152 Auto-merging nitfol
1153 Merge made by recursive.
1154 nitfol | 20 +++++----
1156 $ git reset --merge ORIG_HEAD <b>&lt;2&gt;</b></code></pre>
1157 </div></div>
1158 <div class="colist arabic"><ol>
1159 <li>
1161 Even if you may have local modifications in your
1162 working tree, you can safely say <code>git pull</code> when you know
1163 that the change in the other branch does not overlap with
1164 them.
1165 </p>
1166 </li>
1167 <li>
1169 After inspecting the result of the merge, you may find
1170 that the change in the other branch is unsatisfactory. Running
1171 <code>git reset --hard ORIG_HEAD</code> will let you go back to where you
1172 were, but it will discard your local changes, which you do not
1173 want. <code>git reset --merge</code> keeps your local changes.
1174 </p>
1175 </li>
1176 </ol></div>
1177 </dd>
1178 <dt class="hdlist1">
1179 Interrupted workflow
1180 </dt>
1181 <dd>
1182 <div class="paragraph"><p>Suppose you are interrupted by an urgent fix request while you
1183 are in the middle of a large change. The files in your
1184 working tree are not in any shape to be committed yet, but you
1185 need to get to the other branch for a quick bugfix.</p></div>
1186 <div class="listingblock">
1187 <div class="content">
1188 <pre><code>$ git switch feature ;# you were working in "feature" branch and
1189 $ work work work ;# got interrupted
1190 $ git commit -a -m "snapshot WIP" <b>&lt;1&gt;</b>
1191 $ git switch master
1192 $ fix fix fix
1193 $ git commit ;# commit with real log
1194 $ git switch feature
1195 $ git reset --soft HEAD^ ;# go back to WIP state <b>&lt;2&gt;</b>
1196 $ git reset <b>&lt;3&gt;</b></code></pre>
1197 </div></div>
1198 <div class="colist arabic"><ol>
1199 <li>
1201 This commit will get blown away so a throw-away log message is OK.
1202 </p>
1203 </li>
1204 <li>
1206 This removes the <em>WIP</em> commit from the commit history, and sets
1207 your working tree to the state just before you made that snapshot.
1208 </p>
1209 </li>
1210 <li>
1212 At this point the index file still has all the WIP changes you
1213 committed as <em>snapshot WIP</em>. This updates the index to show your
1214 WIP files as uncommitted.
1215 </p>
1216 <div class="paragraph"><p>See also <a href="git-stash.html">git-stash(1)</a>.</p></div>
1217 </li>
1218 </ol></div>
1219 </dd>
1220 <dt class="hdlist1">
1221 Reset a single file in the index
1222 </dt>
1223 <dd>
1224 <div class="paragraph"><p>Suppose you have added a file to your index, but later decide you do not
1225 want to add it to your commit. You can remove the file from the index
1226 while keeping your changes with git reset.</p></div>
1227 <div class="listingblock">
1228 <div class="content">
1229 <pre><code>$ git reset -- frotz.c <b>&lt;1&gt;</b>
1230 $ git commit -m "Commit files in index" <b>&lt;2&gt;</b>
1231 $ git add frotz.c <b>&lt;3&gt;</b></code></pre>
1232 </div></div>
1233 <div class="colist arabic"><ol>
1234 <li>
1236 This removes the file from the index while keeping it in the working
1237 directory.
1238 </p>
1239 </li>
1240 <li>
1242 This commits all other changes in the index.
1243 </p>
1244 </li>
1245 <li>
1247 Adds the file to the index again.
1248 </p>
1249 </li>
1250 </ol></div>
1251 </dd>
1252 <dt class="hdlist1">
1253 Keep changes in working tree while discarding some previous commits
1254 </dt>
1255 <dd>
1256 <div class="paragraph"><p>Suppose you are working on something and you commit it, and then you
1257 continue working a bit more, but now you think that what you have in
1258 your working tree should be in another branch that has nothing to do
1259 with what you committed previously. You can start a new branch and
1260 reset it while keeping the changes in your working tree.</p></div>
1261 <div class="listingblock">
1262 <div class="content">
1263 <pre><code>$ git tag start
1264 $ git switch -c branch1
1265 $ edit
1266 $ git commit ... <b>&lt;1&gt;</b>
1267 $ edit
1268 $ git switch -c branch2 <b>&lt;2&gt;</b>
1269 $ git reset --keep start <b>&lt;3&gt;</b></code></pre>
1270 </div></div>
1271 <div class="colist arabic"><ol>
1272 <li>
1274 This commits your first edits in <code>branch1</code>.
1275 </p>
1276 </li>
1277 <li>
1279 In the ideal world, you could have realized that the earlier
1280 commit did not belong to the new topic when you created and switched
1281 to <code>branch2</code> (i.e. <code>git switch -c branch2 start</code>), but nobody is
1282 perfect.
1283 </p>
1284 </li>
1285 <li>
1287 But you can use <code>reset --keep</code> to remove the unwanted commit after
1288 you switched to <code>branch2</code>.
1289 </p>
1290 </li>
1291 </ol></div>
1292 </dd>
1293 <dt class="hdlist1">
1294 Split a commit apart into a sequence of commits
1295 </dt>
1296 <dd>
1297 <div class="paragraph"><p>Suppose that you have created lots of logically separate changes and committed
1298 them together. Then, later you decide that it might be better to have each
1299 logical chunk associated with its own commit. You can use git reset to rewind
1300 history without changing the contents of your local files, and then successively
1301 use <code>git add -p</code> to interactively select which hunks to include into each commit,
1302 using <code>git commit -c</code> to pre-populate the commit message.</p></div>
1303 <div class="listingblock">
1304 <div class="content">
1305 <pre><code>$ git reset -N HEAD^ <b>&lt;1&gt;</b>
1306 $ git add -p <b>&lt;2&gt;</b>
1307 $ git diff --cached <b>&lt;3&gt;</b>
1308 $ git commit -c HEAD@{1} <b>&lt;4&gt;</b>
1309 ... <b>&lt;5&gt;</b>
1310 $ git add ... <b>&lt;6&gt;</b>
1311 $ git diff --cached <b>&lt;7&gt;</b>
1312 $ git commit ... <b>&lt;8&gt;</b></code></pre>
1313 </div></div>
1314 <div class="colist arabic"><ol>
1315 <li>
1317 First, reset the history back one commit so that we remove the original
1318 commit, but leave the working tree with all the changes. The -N ensures
1319 that any new files added with <code>HEAD</code> are still marked so that <code>git add -p</code>
1320 will find them.
1321 </p>
1322 </li>
1323 <li>
1325 Next, we interactively select diff hunks to add using the <code>git add -p</code>
1326 facility. This will ask you about each diff hunk in sequence and you can
1327 use simple commands such as "yes, include this", "No don&#8217;t include this"
1328 or even the very powerful "edit" facility.
1329 </p>
1330 </li>
1331 <li>
1333 Once satisfied with the hunks you want to include, you should verify what
1334 has been prepared for the first commit by using <code>git diff --cached</code>. This
1335 shows all the changes that have been moved into the index and are about
1336 to be committed.
1337 </p>
1338 </li>
1339 <li>
1341 Next, commit the changes stored in the index. The <code>-c</code> option specifies to
1342 pre-populate the commit message from the original message that you started
1343 with in the first commit. This is helpful to avoid retyping it. The
1344 <code>HEAD@{1}</code> is a special notation for the commit that <code>HEAD</code> used to be at
1345 prior to the original reset commit (1 change ago).
1346 See <a href="git-reflog.html">git-reflog(1)</a> for more details. You may also use any other
1347 valid commit reference.
1348 </p>
1349 </li>
1350 <li>
1352 You can repeat steps 2-4 multiple times to break the original code into
1353 any number of commits.
1354 </p>
1355 </li>
1356 <li>
1358 Now you&#8217;ve split out many of the changes into their own commits, and might
1359 no longer use the patch mode of <code>git add</code>, in order to select all remaining
1360 uncommitted changes.
1361 </p>
1362 </li>
1363 <li>
1365 Once again, check to verify that you&#8217;ve included what you want to. You may
1366 also wish to verify that git diff doesn&#8217;t show any remaining changes to be
1367 committed later.
1368 </p>
1369 </li>
1370 <li>
1372 And finally create the final commit.
1373 </p>
1374 </li>
1375 </ol></div>
1376 </dd>
1377 </dl></div>
1378 </div>
1379 </div>
1380 <div class="sect1">
1381 <h2 id="_discussion">DISCUSSION</h2>
1382 <div class="sectionbody">
1383 <div class="paragraph"><p>The tables below show what happens when running:</p></div>
1384 <div class="listingblock">
1385 <div class="content">
1386 <pre><code>git reset --option target</code></pre>
1387 </div></div>
1388 <div class="paragraph"><p>to reset the <code>HEAD</code> to another commit (<code>target</code>) with the different
1389 reset options depending on the state of the files.</p></div>
1390 <div class="paragraph"><p>In these tables, <code>A</code>, <code>B</code>, <code>C</code> and <code>D</code> are some different states of a
1391 file. For example, the first line of the first table means that if a
1392 file is in state <code>A</code> in the working tree, in state <code>B</code> in the index, in
1393 state <code>C</code> in <code>HEAD</code> and in state <code>D</code> in the target, then <code>git reset --soft
1394 target</code> will leave the file in the working tree in state <code>A</code> and in the
1395 index in state <code>B</code>. It resets (i.e. moves) the <code>HEAD</code> (i.e. the tip of
1396 the current branch, if you are on one) to <code>target</code> (which has the file
1397 in state <code>D</code>).</p></div>
1398 <div class="literalblock">
1399 <div class="content">
1400 <pre><code>working index HEAD target working index HEAD
1401 ----------------------------------------------------
1402 A B C D --soft A B D
1403 --mixed A D D
1404 --hard D D D
1405 --merge (disallowed)
1406 --keep (disallowed)</code></pre>
1407 </div></div>
1408 <div class="literalblock">
1409 <div class="content">
1410 <pre><code>working index HEAD target working index HEAD
1411 ----------------------------------------------------
1412 A B C C --soft A B C
1413 --mixed A C C
1414 --hard C C C
1415 --merge (disallowed)
1416 --keep A C C</code></pre>
1417 </div></div>
1418 <div class="literalblock">
1419 <div class="content">
1420 <pre><code>working index HEAD target working index HEAD
1421 ----------------------------------------------------
1422 B B C D --soft B B D
1423 --mixed B D D
1424 --hard D D D
1425 --merge D D D
1426 --keep (disallowed)</code></pre>
1427 </div></div>
1428 <div class="literalblock">
1429 <div class="content">
1430 <pre><code>working index HEAD target working index HEAD
1431 ----------------------------------------------------
1432 B B C C --soft B B C
1433 --mixed B C C
1434 --hard C C C
1435 --merge C C C
1436 --keep B C C</code></pre>
1437 </div></div>
1438 <div class="literalblock">
1439 <div class="content">
1440 <pre><code>working index HEAD target working index HEAD
1441 ----------------------------------------------------
1442 B C C D --soft B C D
1443 --mixed B D D
1444 --hard D D D
1445 --merge (disallowed)
1446 --keep (disallowed)</code></pre>
1447 </div></div>
1448 <div class="literalblock">
1449 <div class="content">
1450 <pre><code>working index HEAD target working index HEAD
1451 ----------------------------------------------------
1452 B C C C --soft B C C
1453 --mixed B C C
1454 --hard C C C
1455 --merge B C C
1456 --keep B C C</code></pre>
1457 </div></div>
1458 <div class="paragraph"><p><code>reset --merge</code> is meant to be used when resetting out of a conflicted
1459 merge. Any mergy operation guarantees that the working tree file that is
1460 involved in the merge does not have a local change with respect to the index
1461 before it starts, and that it writes the result out to the working tree. So if
1462 we see some difference between the index and the target and also
1463 between the index and the working tree, then it means that we are not
1464 resetting out from a state that a mergy operation left after failing
1465 with a conflict. That is why we disallow <code>--merge</code> option in this case.</p></div>
1466 <div class="paragraph"><p><code>reset --keep</code> is meant to be used when removing some of the last
1467 commits in the current branch while keeping changes in the working
1468 tree. If there could be conflicts between the changes in the commit we
1469 want to remove and the changes in the working tree we want to keep,
1470 the reset is disallowed. That&#8217;s why it is disallowed if there are both
1471 changes between the working tree and <code>HEAD</code>, and between <code>HEAD</code> and the
1472 target. To be safe, it is also disallowed when there are unmerged
1473 entries.</p></div>
1474 <div class="paragraph"><p>The following tables show what happens when there are unmerged
1475 entries:</p></div>
1476 <div class="literalblock">
1477 <div class="content">
1478 <pre><code>working index HEAD target working index HEAD
1479 ----------------------------------------------------
1480 X U A B --soft (disallowed)
1481 --mixed X B B
1482 --hard B B B
1483 --merge B B B
1484 --keep (disallowed)</code></pre>
1485 </div></div>
1486 <div class="literalblock">
1487 <div class="content">
1488 <pre><code>working index HEAD target working index HEAD
1489 ----------------------------------------------------
1490 X U A A --soft (disallowed)
1491 --mixed X A A
1492 --hard A A A
1493 --merge A A A
1494 --keep (disallowed)</code></pre>
1495 </div></div>
1496 <div class="paragraph"><p><code>X</code> means any state and <code>U</code> means an unmerged index.</p></div>
1497 </div>
1498 </div>
1499 <div class="sect1">
1500 <h2 id="_git">GIT</h2>
1501 <div class="sectionbody">
1502 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1503 </div>
1504 </div>
1505 </div>
1506 <div id="footnotes"><hr /></div>
1507 <div id="footer">
1508 <div id="footer-text">
1509 Last updated
1510 2023-01-21 17:52:14 PST
1511 </div>
1512 </div>
1513 </body>
1514 </html>