Autogenerated HTML docs for v2.43.0-334-gd4dbc
[git-htmldocs.git] / git-switch.html
blob5b50a10de0eba0a7188ec6858c0baa53a0775420
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-switch(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-switch(1) Manual Page
739 </h1>
740 <h2>NAME</h2>
741 <div class="sectionbody">
742 <p>git-switch -
743 Switch branches
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 switch</em> [&lt;options&gt;] [--no-guess] &lt;branch&gt;
753 <em>git switch</em> [&lt;options&gt;] --detach [&lt;start-point&gt;]
754 <em>git switch</em> [&lt;options&gt;] (-c|-C) &lt;new-branch&gt; [&lt;start-point&gt;]
755 <em>git switch</em> [&lt;options&gt;] --orphan &lt;new-branch&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>Switch to a specified branch. The working tree and the index are
764 updated to match the branch. All new commits will be added to the tip
765 of this branch.</p></div>
766 <div class="paragraph"><p>Optionally a new branch could be created with either <code>-c</code>, <code>-C</code>,
767 automatically from a remote branch of same name (see <code>--guess</code>), or
768 detach the working tree from any branch with <code>--detach</code>, along with
769 switching.</p></div>
770 <div class="paragraph"><p>Switching branches does not require a clean index and working tree
771 (i.e. no differences compared to <code>HEAD</code>). The operation is aborted
772 however if the operation leads to loss of local changes, unless told
773 otherwise with <code>--discard-changes</code> or <code>--merge</code>.</p></div>
774 <div class="paragraph"><p>THIS COMMAND IS EXPERIMENTAL. THE BEHAVIOR MAY CHANGE.</p></div>
775 </div>
776 </div>
777 <div class="sect1">
778 <h2 id="_options">OPTIONS</h2>
779 <div class="sectionbody">
780 <div class="dlist"><dl>
781 <dt class="hdlist1">
782 &lt;branch&gt;
783 </dt>
784 <dd>
786 Branch to switch to.
787 </p>
788 </dd>
789 <dt class="hdlist1">
790 &lt;new-branch&gt;
791 </dt>
792 <dd>
794 Name for the new branch.
795 </p>
796 </dd>
797 <dt class="hdlist1">
798 &lt;start-point&gt;
799 </dt>
800 <dd>
802 The starting point for the new branch. Specifying a
803 <code>&lt;start-point&gt;</code> allows you to create a branch based on some
804 other point in history than where HEAD currently points. (Or,
805 in the case of <code>--detach</code>, allows you to inspect and detach
806 from some other point.)
807 </p>
808 <div class="paragraph"><p>You can use the <code>@{-N}</code> syntax to refer to the N-th last
809 branch/commit switched to using "git switch" or "git checkout"
810 operation. You may also specify <code>-</code> which is synonymous to <code>@{-1}</code>.
811 This is often used to switch quickly between two branches, or to undo
812 a branch switch by mistake.</p></div>
813 <div class="paragraph"><p>As a special case, you may use <code>A...B</code> as a shortcut for the merge
814 base of <code>A</code> and <code>B</code> if there is exactly one merge base. You can leave
815 out at most one of <code>A</code> and <code>B</code>, in which case it defaults to <code>HEAD</code>.</p></div>
816 </dd>
817 <dt class="hdlist1">
818 -c &lt;new-branch&gt;
819 </dt>
820 <dt class="hdlist1">
821 --create &lt;new-branch&gt;
822 </dt>
823 <dd>
825 Create a new branch named <code>&lt;new-branch&gt;</code> starting at
826 <code>&lt;start-point&gt;</code> before switching to the branch. This is the
827 transactional equivalent of
828 </p>
829 <div class="listingblock">
830 <div class="content">
831 <pre><code>$ git branch &lt;new-branch&gt;
832 $ git switch &lt;new-branch&gt;</code></pre>
833 </div></div>
834 <div class="paragraph"><p>that is to say, the branch is not reset/created unless "git switch" is
835 successful (e.g., when the branch is in use in another worktree, not
836 just the current branch stays the same, but the branch is not reset to
837 the start-point, either).</p></div>
838 </dd>
839 <dt class="hdlist1">
840 -C &lt;new-branch&gt;
841 </dt>
842 <dt class="hdlist1">
843 --force-create &lt;new-branch&gt;
844 </dt>
845 <dd>
847 Similar to <code>--create</code> except that if <code>&lt;new-branch&gt;</code> already
848 exists, it will be reset to <code>&lt;start-point&gt;</code>. This is a
849 convenient shortcut for:
850 </p>
851 <div class="listingblock">
852 <div class="content">
853 <pre><code>$ git branch -f &lt;new-branch&gt;
854 $ git switch &lt;new-branch&gt;</code></pre>
855 </div></div>
856 </dd>
857 <dt class="hdlist1">
859 </dt>
860 <dt class="hdlist1">
861 --detach
862 </dt>
863 <dd>
865 Switch to a commit for inspection and discardable
866 experiments. See the "DETACHED HEAD" section in
867 <a href="git-checkout.html">git-checkout(1)</a> for details.
868 </p>
869 </dd>
870 <dt class="hdlist1">
871 --guess
872 </dt>
873 <dt class="hdlist1">
874 --no-guess
875 </dt>
876 <dd>
878 If <code>&lt;branch&gt;</code> is not found but there does exist a tracking
879 branch in exactly one remote (call it <code>&lt;remote&gt;</code>) with a
880 matching name, treat as equivalent to
881 </p>
882 <div class="listingblock">
883 <div class="content">
884 <pre><code>$ git switch -c &lt;branch&gt; --track &lt;remote&gt;/&lt;branch&gt;</code></pre>
885 </div></div>
886 <div class="paragraph"><p>If the branch exists in multiple remotes and one of them is named by
887 the <code>checkout.defaultRemote</code> configuration variable, we&#8217;ll use that
888 one for the purposes of disambiguation, even if the <code>&lt;branch&gt;</code> isn&#8217;t
889 unique across all remotes. Set it to e.g. <code>checkout.defaultRemote=origin</code>
890 to always checkout remote branches from there if <code>&lt;branch&gt;</code> is
891 ambiguous but exists on the <em>origin</em> remote. See also
892 <code>checkout.defaultRemote</code> in <a href="git-config.html">git-config(1)</a>.</p></div>
893 <div class="paragraph"><p><code>--guess</code> is the default behavior. Use <code>--no-guess</code> to disable it.</p></div>
894 <div class="paragraph"><p>The default behavior can be set via the <code>checkout.guess</code> configuration
895 variable.</p></div>
896 </dd>
897 <dt class="hdlist1">
899 </dt>
900 <dt class="hdlist1">
901 --force
902 </dt>
903 <dd>
905 An alias for <code>--discard-changes</code>.
906 </p>
907 </dd>
908 <dt class="hdlist1">
909 --discard-changes
910 </dt>
911 <dd>
913 Proceed even if the index or the working tree differs from
914 <code>HEAD</code>. Both the index and working tree are restored to match
915 the switching target. If <code>--recurse-submodules</code> is specified,
916 submodule content is also restored to match the switching
917 target. This is used to throw away local changes.
918 </p>
919 </dd>
920 <dt class="hdlist1">
922 </dt>
923 <dt class="hdlist1">
924 --merge
925 </dt>
926 <dd>
928 If you have local modifications to one or more files that are
929 different between the current branch and the branch to which
930 you are switching, the command refuses to switch branches in
931 order to preserve your modifications in context. However,
932 with this option, a three-way merge between the current
933 branch, your working tree contents, and the new branch is
934 done, and you will be on the new branch.
935 </p>
936 <div class="paragraph"><p>When a merge conflict happens, the index entries for conflicting
937 paths are left unmerged, and you need to resolve the conflicts
938 and mark the resolved paths with <code>git add</code> (or <code>git rm</code> if the merge
939 should result in deletion of the path).</p></div>
940 </dd>
941 <dt class="hdlist1">
942 --conflict=&lt;style&gt;
943 </dt>
944 <dd>
946 The same as <code>--merge</code> option above, but changes the way the
947 conflicting hunks are presented, overriding the
948 <code>merge.conflictStyle</code> configuration variable. Possible values are
949 "merge" (default), "diff3", and "zdiff3".
950 </p>
951 </dd>
952 <dt class="hdlist1">
954 </dt>
955 <dt class="hdlist1">
956 --quiet
957 </dt>
958 <dd>
960 Quiet, suppress feedback messages.
961 </p>
962 </dd>
963 <dt class="hdlist1">
964 --progress
965 </dt>
966 <dt class="hdlist1">
967 --no-progress
968 </dt>
969 <dd>
971 Progress status is reported on the standard error stream
972 by default when it is attached to a terminal, unless <code>--quiet</code>
973 is specified. This flag enables progress reporting even if not
974 attached to a terminal, regardless of <code>--quiet</code>.
975 </p>
976 </dd>
977 <dt class="hdlist1">
979 </dt>
980 <dt class="hdlist1">
981 --track [direct|inherit]
982 </dt>
983 <dd>
985 When creating a new branch, set up "upstream" configuration.
986 <code>-c</code> is implied. See <code>--track</code> in <a href="git-branch.html">git-branch(1)</a> for
987 details.
988 </p>
989 <div class="paragraph"><p>If no <code>-c</code> option is given, the name of the new branch will be derived
990 from the remote-tracking branch, by looking at the local part of the
991 refspec configured for the corresponding remote, and then stripping
992 the initial part up to the "*". This would tell us to use <code>hack</code> as
993 the local branch when branching off of <code>origin/hack</code> (or
994 <code>remotes/origin/hack</code>, or even <code>refs/remotes/origin/hack</code>). If the
995 given name has no slash, or the above guessing results in an empty
996 name, the guessing is aborted. You can explicitly give a name with
997 <code>-c</code> in such a case.</p></div>
998 </dd>
999 <dt class="hdlist1">
1000 --no-track
1001 </dt>
1002 <dd>
1004 Do not set up "upstream" configuration, even if the
1005 <code>branch.autoSetupMerge</code> configuration variable is true.
1006 </p>
1007 </dd>
1008 <dt class="hdlist1">
1009 --orphan &lt;new-branch&gt;
1010 </dt>
1011 <dd>
1013 Create a new unborn branch, named <code>&lt;new-branch&gt;</code>. All
1014 tracked files are removed.
1015 </p>
1016 </dd>
1017 <dt class="hdlist1">
1018 --ignore-other-worktrees
1019 </dt>
1020 <dd>
1022 <code>git switch</code> refuses when the wanted ref is already
1023 checked out by another worktree. This option makes it check
1024 the ref out anyway. In other words, the ref can be held by
1025 more than one worktree.
1026 </p>
1027 </dd>
1028 <dt class="hdlist1">
1029 --recurse-submodules
1030 </dt>
1031 <dt class="hdlist1">
1032 --no-recurse-submodules
1033 </dt>
1034 <dd>
1036 Using <code>--recurse-submodules</code> will update the content of all
1037 active submodules according to the commit recorded in the
1038 superproject. If nothing (or <code>--no-recurse-submodules</code>) is
1039 used, submodules working trees will not be updated. Just
1040 like <a href="git-submodule.html">git-submodule(1)</a>, this will detach <code>HEAD</code> of the
1041 submodules.
1042 </p>
1043 </dd>
1044 </dl></div>
1045 </div>
1046 </div>
1047 <div class="sect1">
1048 <h2 id="_examples">EXAMPLES</h2>
1049 <div class="sectionbody">
1050 <div class="paragraph"><p>The following command switches to the "master" branch:</p></div>
1051 <div class="listingblock">
1052 <div class="content">
1053 <pre><code>$ git switch master</code></pre>
1054 </div></div>
1055 <div class="paragraph"><p>After working in the wrong branch, switching to the correct branch
1056 would be done using:</p></div>
1057 <div class="listingblock">
1058 <div class="content">
1059 <pre><code>$ git switch mytopic</code></pre>
1060 </div></div>
1061 <div class="paragraph"><p>However, your "wrong" branch and correct "mytopic" branch may differ
1062 in files that you have modified locally, in which case the above
1063 switch would fail like this:</p></div>
1064 <div class="listingblock">
1065 <div class="content">
1066 <pre><code>$ git switch mytopic
1067 error: You have local changes to 'frotz'; not switching branches.</code></pre>
1068 </div></div>
1069 <div class="paragraph"><p>You can give the <code>-m</code> flag to the command, which would try a three-way
1070 merge:</p></div>
1071 <div class="listingblock">
1072 <div class="content">
1073 <pre><code>$ git switch -m mytopic
1074 Auto-merging frotz</code></pre>
1075 </div></div>
1076 <div class="paragraph"><p>After this three-way merge, the local modifications are <em>not</em>
1077 registered in your index file, so <code>git diff</code> would show you what
1078 changes you made since the tip of the new branch.</p></div>
1079 <div class="paragraph"><p>To switch back to the previous branch before we switched to mytopic
1080 (i.e. "master" branch):</p></div>
1081 <div class="listingblock">
1082 <div class="content">
1083 <pre><code>$ git switch -</code></pre>
1084 </div></div>
1085 <div class="paragraph"><p>You can grow a new branch from any commit. For example, switch to
1086 "HEAD~3" and create branch "fixup":</p></div>
1087 <div class="listingblock">
1088 <div class="content">
1089 <pre><code>$ git switch -c fixup HEAD~3
1090 Switched to a new branch 'fixup'</code></pre>
1091 </div></div>
1092 <div class="paragraph"><p>If you want to start a new branch from a remote branch of the same
1093 name:</p></div>
1094 <div class="listingblock">
1095 <div class="content">
1096 <pre><code>$ git switch new-topic
1097 Branch 'new-topic' set up to track remote branch 'new-topic' from 'origin'
1098 Switched to a new branch 'new-topic'</code></pre>
1099 </div></div>
1100 <div class="paragraph"><p>To check out commit <code>HEAD~3</code> for temporary inspection or experiment
1101 without creating a new branch:</p></div>
1102 <div class="listingblock">
1103 <div class="content">
1104 <pre><code>$ git switch --detach HEAD~3
1105 HEAD is now at 9fc9555312 Merge branch 'cc/shared-index-permbits'</code></pre>
1106 </div></div>
1107 <div class="paragraph"><p>If it turns out whatever you have done is worth keeping, you can
1108 always create a new name for it (without switching away):</p></div>
1109 <div class="listingblock">
1110 <div class="content">
1111 <pre><code>$ git switch -c good-surprises</code></pre>
1112 </div></div>
1113 </div>
1114 </div>
1115 <div class="sect1">
1116 <h2 id="_configuration">CONFIGURATION</h2>
1117 <div class="sectionbody">
1118 <div class="paragraph"><p>Everything below this line in this section is selectively included
1119 from the <a href="git-config.html">git-config(1)</a> documentation. The content is the same
1120 as what&#8217;s found there:</p></div>
1121 <div class="dlist"><dl>
1122 <dt class="hdlist1">
1123 checkout.defaultRemote
1124 </dt>
1125 <dd>
1127 When you run <code>git checkout &lt;something&gt;</code>
1128 or <code>git switch &lt;something&gt;</code> and only have one
1129 remote, it may implicitly fall back on checking out and
1130 tracking e.g. <code>origin/&lt;something&gt;</code>. This stops working as soon
1131 as you have more than one remote with a <code>&lt;something&gt;</code>
1132 reference. This setting allows for setting the name of a
1133 preferred remote that should always win when it comes to
1134 disambiguation. The typical use-case is to set this to
1135 <code>origin</code>.
1136 </p>
1137 <div class="paragraph"><p>Currently this is used by <a href="git-switch.html">git-switch(1)</a> and
1138 <a href="git-checkout.html">git-checkout(1)</a> when <code>git checkout &lt;something&gt;</code>
1139 or <code>git switch &lt;something&gt;</code>
1140 will checkout the <code>&lt;something&gt;</code> branch on another remote,
1141 and by <a href="git-worktree.html">git-worktree(1)</a> when <code>git worktree add</code> refers to a
1142 remote branch. This setting might be used for other checkout-like
1143 commands or functionality in the future.</p></div>
1144 </dd>
1145 <dt class="hdlist1">
1146 checkout.guess
1147 </dt>
1148 <dd>
1150 Provides the default value for the <code>--guess</code> or <code>--no-guess</code>
1151 option in <code>git checkout</code> and <code>git switch</code>. See
1152 <a href="git-switch.html">git-switch(1)</a> and <a href="git-checkout.html">git-checkout(1)</a>.
1153 </p>
1154 </dd>
1155 <dt class="hdlist1">
1156 checkout.workers
1157 </dt>
1158 <dd>
1160 The number of parallel workers to use when updating the working tree.
1161 The default is one, i.e. sequential execution. If set to a value less
1162 than one, Git will use as many workers as the number of logical cores
1163 available. This setting and <code>checkout.thresholdForParallelism</code> affect
1164 all commands that perform checkout. E.g. checkout, clone, reset,
1165 sparse-checkout, etc.
1166 </p>
1167 <div class="paragraph"><p>Note: Parallel checkout usually delivers better performance for repositories
1168 located on SSDs or over NFS. For repositories on spinning disks and/or machines
1169 with a small number of cores, the default sequential checkout often performs
1170 better. The size and compression level of a repository might also influence how
1171 well the parallel version performs.</p></div>
1172 </dd>
1173 <dt class="hdlist1">
1174 checkout.thresholdForParallelism
1175 </dt>
1176 <dd>
1178 When running parallel checkout with a small number of files, the cost
1179 of subprocess spawning and inter-process communication might outweigh
1180 the parallelization gains. This setting allows you to define the minimum
1181 number of files for which parallel checkout should be attempted. The
1182 default is 100.
1183 </p>
1184 </dd>
1185 </dl></div>
1186 </div>
1187 </div>
1188 <div class="sect1">
1189 <h2 id="_see_also">SEE ALSO</h2>
1190 <div class="sectionbody">
1191 <div class="paragraph"><p><a href="git-checkout.html">git-checkout(1)</a>,
1192 <a href="git-branch.html">git-branch(1)</a></p></div>
1193 </div>
1194 </div>
1195 <div class="sect1">
1196 <h2 id="_git">GIT</h2>
1197 <div class="sectionbody">
1198 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1199 </div>
1200 </div>
1201 </div>
1202 <div id="footnotes"><hr /></div>
1203 <div id="footer">
1204 <div id="footer-text">
1205 Last updated
1206 2024-01-02 14:28:43 PST
1207 </div>
1208 </div>
1209 </body>
1210 </html>