<?xml version="1.0" encoding="UTF-8"?> | |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" | |
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> | |
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> | |
<head> | |
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> | |
<meta name="generator" content="AsciiDoc 10.2.0" /> | |
<title>git-switch(1)</title> | |
<style type="text/css"> | |
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */ | |
/* Default font. */ | |
body { | |
font-family: Georgia,serif; | |
} | |
/* Title font. */ | |
h1, h2, h3, h4, h5, h6, | |
div.title, caption.title, | |
thead, p.table.header, | |
#toctitle, | |
#author, #revnumber, #revdate, #revremark, | |
#footer { | |
font-family: Arial,Helvetica,sans-serif; | |
} | |
body { | |
margin: 1em 5% 1em 5%; | |
} | |
a { | |
color: blue; | |
text-decoration: underline; | |
} | |
a:visited { | |
color: fuchsia; | |
} | |
em { | |
font-style: italic; | |
color: navy; | |
} | |
strong { | |
font-weight: bold; | |
color: #083194; | |
} | |
h1, h2, h3, h4, h5, h6 { | |
color: #527bbd; | |
margin-top: 1.2em; | |
margin-bottom: 0.5em; | |
line-height: 1.3; | |
} | |
h1, h2, h3 { | |
border-bottom: 2px solid silver; | |
} | |
h2 { | |
padding-top: 0.5em; | |
} | |
h3 { | |
float: left; | |
} | |
h3 + * { | |
clear: left; | |
} | |
h5 { | |
font-size: 1.0em; | |
} | |
div.sectionbody { | |
margin-left: 0; | |
} | |
hr { | |
border: 1px solid silver; | |
} | |
p { | |
margin-top: 0.5em; | |
margin-bottom: 0.5em; | |
} | |
ul, ol, li > p { | |
margin-top: 0; | |
} | |
ul > li { color: #aaa; } | |
ul > li > * { color: black; } | |
.monospaced, code, pre { | |
font-family: "Courier New", Courier, monospace; | |
font-size: inherit; | |
color: navy; | |
padding: 0; | |
margin: 0; | |
} | |
pre { | |
white-space: pre-wrap; | |
} | |
#author { | |
color: #527bbd; | |
font-weight: bold; | |
font-size: 1.1em; | |
} | |
#email { | |
} | |
#revnumber, #revdate, #revremark { | |
} | |
#footer { | |
font-size: small; | |
border-top: 2px solid silver; | |
padding-top: 0.5em; | |
margin-top: 4.0em; | |
} | |
#footer-text { | |
float: left; | |
padding-bottom: 0.5em; | |
} | |
#footer-badges { | |
float: right; | |
padding-bottom: 0.5em; | |
} | |
#preamble { | |
margin-top: 1.5em; | |
margin-bottom: 1.5em; | |
} | |
div.imageblock, div.exampleblock, div.verseblock, | |
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, | |
div.admonitionblock { | |
margin-top: 1.0em; | |
margin-bottom: 1.5em; | |
} | |
div.admonitionblock { | |
margin-top: 2.0em; | |
margin-bottom: 2.0em; | |
margin-right: 10%; | |
color: #606060; | |
} | |
div.content { /* Block element content. */ | |
padding: 0; | |
} | |
/* Block element titles. */ | |
div.title, caption.title { | |
color: #527bbd; | |
font-weight: bold; | |
text-align: left; | |
margin-top: 1.0em; | |
margin-bottom: 0.5em; | |
} | |
div.title + * { | |
margin-top: 0; | |
} | |
td div.title:first-child { | |
margin-top: 0.0em; | |
} | |
div.content div.title:first-child { | |
margin-top: 0.0em; | |
} | |
div.content + div.title { | |
margin-top: 0.0em; | |
} | |
div.sidebarblock > div.content { | |
background: #ffffee; | |
border: 1px solid #dddddd; | |
border-left: 4px solid #f0f0f0; | |
padding: 0.5em; | |
} | |
div.listingblock > div.content { | |
border: 1px solid #dddddd; | |
border-left: 5px solid #f0f0f0; | |
background: #f8f8f8; | |
padding: 0.5em; | |
} | |
div.quoteblock, div.verseblock { | |
padding-left: 1.0em; | |
margin-left: 1.0em; | |
margin-right: 10%; | |
border-left: 5px solid #f0f0f0; | |
color: #888; | |
} | |
div.quoteblock > div.attribution { | |
padding-top: 0.5em; | |
text-align: right; | |
} | |
div.verseblock > pre.content { | |
font-family: inherit; | |
font-size: inherit; | |
} | |
div.verseblock > div.attribution { | |
padding-top: 0.75em; | |
text-align: left; | |
} | |
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ | |
div.verseblock + div.attribution { | |
text-align: left; | |
} | |
div.admonitionblock .icon { | |
vertical-align: top; | |
font-size: 1.1em; | |
font-weight: bold; | |
text-decoration: underline; | |
color: #527bbd; | |
padding-right: 0.5em; | |
} | |
div.admonitionblock td.content { | |
padding-left: 0.5em; | |
border-left: 3px solid #dddddd; | |
} | |
div.exampleblock > div.content { | |
border-left: 3px solid #dddddd; | |
padding-left: 0.5em; | |
} | |
div.imageblock div.content { padding-left: 0; } | |
span.image img { border-style: none; vertical-align: text-bottom; } | |
a.image:visited { color: white; } | |
dl { | |
margin-top: 0.8em; | |
margin-bottom: 0.8em; | |
} | |
dt { | |
margin-top: 0.5em; | |
margin-bottom: 0; | |
font-style: normal; | |
color: navy; | |
} | |
dd > *:first-child { | |
margin-top: 0.1em; | |
} | |
ul, ol { | |
list-style-position: outside; | |
} | |
ol.arabic { | |
list-style-type: decimal; | |
} | |
ol.loweralpha { | |
list-style-type: lower-alpha; | |
} | |
ol.upperalpha { | |
list-style-type: upper-alpha; | |
} | |
ol.lowerroman { | |
list-style-type: lower-roman; | |
} | |
ol.upperroman { | |
list-style-type: upper-roman; | |
} | |
div.compact ul, div.compact ol, | |
div.compact p, div.compact p, | |
div.compact div, div.compact div { | |
margin-top: 0.1em; | |
margin-bottom: 0.1em; | |
} | |
tfoot { | |
font-weight: bold; | |
} | |
td > div.verse { | |
white-space: pre; | |
} | |
div.hdlist { | |
margin-top: 0.8em; | |
margin-bottom: 0.8em; | |
} | |
div.hdlist tr { | |
padding-bottom: 15px; | |
} | |
dt.hdlist1.strong, td.hdlist1.strong { | |
font-weight: bold; | |
} | |
td.hdlist1 { | |
vertical-align: top; | |
font-style: normal; | |
padding-right: 0.8em; | |
color: navy; | |
} | |
td.hdlist2 { | |
vertical-align: top; | |
} | |
div.hdlist.compact tr { | |
margin: 0; | |
padding-bottom: 0; | |
} | |
.comment { | |
background: yellow; | |
} | |
.footnote, .footnoteref { | |
font-size: 0.8em; | |
} | |
span.footnote, span.footnoteref { | |
vertical-align: super; | |
} | |
#footnotes { | |
margin: 20px 0 20px 0; | |
padding: 7px 0 0 0; | |
} | |
#footnotes div.footnote { | |
margin: 0 0 5px 0; | |
} | |
#footnotes hr { | |
border: none; | |
border-top: 1px solid silver; | |
height: 1px; | |
text-align: left; | |
margin-left: 0; | |
width: 20%; | |
min-width: 100px; | |
} | |
div.colist td { | |
padding-right: 0.5em; | |
padding-bottom: 0.3em; | |
vertical-align: top; | |
} | |
div.colist td img { | |
margin-top: 0.3em; | |
} | |
@media print { | |
#footer-badges { display: none; } | |
} | |
#toc { | |
margin-bottom: 2.5em; | |
} | |
#toctitle { | |
color: #527bbd; | |
font-size: 1.1em; | |
font-weight: bold; | |
margin-top: 1.0em; | |
margin-bottom: 0.1em; | |
} | |
div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { | |
margin-top: 0; | |
margin-bottom: 0; | |
} | |
div.toclevel2 { | |
margin-left: 2em; | |
font-size: 0.9em; | |
} | |
div.toclevel3 { | |
margin-left: 4em; | |
font-size: 0.9em; | |
} | |
div.toclevel4 { | |
margin-left: 6em; | |
font-size: 0.9em; | |
} | |
span.aqua { color: aqua; } | |
span.black { color: black; } | |
span.blue { color: blue; } | |
span.fuchsia { color: fuchsia; } | |
span.gray { color: gray; } | |
span.green { color: green; } | |
span.lime { color: lime; } | |
span.maroon { color: maroon; } | |
span.navy { color: navy; } | |
span.olive { color: olive; } | |
span.purple { color: purple; } | |
span.red { color: red; } | |
span.silver { color: silver; } | |
span.teal { color: teal; } | |
span.white { color: white; } | |
span.yellow { color: yellow; } | |
span.aqua-background { background: aqua; } | |
span.black-background { background: black; } | |
span.blue-background { background: blue; } | |
span.fuchsia-background { background: fuchsia; } | |
span.gray-background { background: gray; } | |
span.green-background { background: green; } | |
span.lime-background { background: lime; } | |
span.maroon-background { background: maroon; } | |
span.navy-background { background: navy; } | |
span.olive-background { background: olive; } | |
span.purple-background { background: purple; } | |
span.red-background { background: red; } | |
span.silver-background { background: silver; } | |
span.teal-background { background: teal; } | |
span.white-background { background: white; } | |
span.yellow-background { background: yellow; } | |
span.big { font-size: 2em; } | |
span.small { font-size: 0.6em; } | |
span.underline { text-decoration: underline; } | |
span.overline { text-decoration: overline; } | |
span.line-through { text-decoration: line-through; } | |
div.unbreakable { page-break-inside: avoid; } | |
/* | |
* xhtml11 specific | |
* | |
* */ | |
div.tableblock { | |
margin-top: 1.0em; | |
margin-bottom: 1.5em; | |
} | |
div.tableblock > table { | |
border: 3px solid #527bbd; | |
} | |
thead, p.table.header { | |
font-weight: bold; | |
color: #527bbd; | |
} | |
p.table { | |
margin-top: 0; | |
} | |
/* Because the table frame attribute is overridden by CSS in most browsers. */ | |
div.tableblock > table[frame="void"] { | |
border-style: none; | |
} | |
div.tableblock > table[frame="hsides"] { | |
border-left-style: none; | |
border-right-style: none; | |
} | |
div.tableblock > table[frame="vsides"] { | |
border-top-style: none; | |
border-bottom-style: none; | |
} | |
/* | |
* html5 specific | |
* | |
* */ | |
table.tableblock { | |
margin-top: 1.0em; | |
margin-bottom: 1.5em; | |
} | |
thead, p.tableblock.header { | |
font-weight: bold; | |
color: #527bbd; | |
} | |
p.tableblock { | |
margin-top: 0; | |
} | |
table.tableblock { | |
border-width: 3px; | |
border-spacing: 0px; | |
border-style: solid; | |
border-color: #527bbd; | |
border-collapse: collapse; | |
} | |
th.tableblock, td.tableblock { | |
border-width: 1px; | |
padding: 4px; | |
border-style: solid; | |
border-color: #527bbd; | |
} | |
table.tableblock.frame-topbot { | |
border-left-style: hidden; | |
border-right-style: hidden; | |
} | |
table.tableblock.frame-sides { | |
border-top-style: hidden; | |
border-bottom-style: hidden; | |
} | |
table.tableblock.frame-none { | |
border-style: hidden; | |
} | |
th.tableblock.halign-left, td.tableblock.halign-left { | |
text-align: left; | |
} | |
th.tableblock.halign-center, td.tableblock.halign-center { | |
text-align: center; | |
} | |
th.tableblock.halign-right, td.tableblock.halign-right { | |
text-align: right; | |
} | |
th.tableblock.valign-top, td.tableblock.valign-top { | |
vertical-align: top; | |
} | |
th.tableblock.valign-middle, td.tableblock.valign-middle { | |
vertical-align: middle; | |
} | |
th.tableblock.valign-bottom, td.tableblock.valign-bottom { | |
vertical-align: bottom; | |
} | |
/* | |
* manpage specific | |
* | |
* */ | |
body.manpage h1 { | |
padding-top: 0.5em; | |
padding-bottom: 0.5em; | |
border-top: 2px solid silver; | |
border-bottom: 2px solid silver; | |
} | |
body.manpage h2 { | |
border-style: none; | |
} | |
body.manpage div.sectionbody { | |
margin-left: 3em; | |
} | |
@media print { | |
body.manpage div#toc { display: none; } | |
} | |
</style> | |
<script type="text/javascript"> | |
/*<![CDATA[*/ | |
var asciidoc = { // Namespace. | |
///////////////////////////////////////////////////////////////////// | |
// Table Of Contents generator | |
///////////////////////////////////////////////////////////////////// | |
/* Author: Mihai Bazon, September 2002 | |
* http://students.infoiasi.ro/~mishoo | |
* | |
* Table Of Content generator | |
* Version: 0.4 | |
* | |
* Feel free to use this script under the terms of the GNU General Public | |
* License, as long as you do not remove or alter this notice. | |
*/ | |
/* modified by Troy D. Hanson, September 2006. License: GPL */ | |
/* modified by Stuart Rackham, 2006, 2009. License: GPL */ | |
// toclevels = 1..4. | |
toc: function (toclevels) { | |
function getText(el) { | |
var text = ""; | |
for (var i = el.firstChild; i != null; i = i.nextSibling) { | |
if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants. | |
text += i.data; | |
else if (i.firstChild != null) | |
text += getText(i); | |
} | |
return text; | |
} | |
function TocEntry(el, text, toclevel) { | |
this.element = el; | |
this.text = text; | |
this.toclevel = toclevel; | |
} | |
function tocEntries(el, toclevels) { | |
var result = new Array; | |
var re = new RegExp('[hH]([1-'+(toclevels+1)+'])'); | |
// Function that scans the DOM tree for header elements (the DOM2 | |
// nodeIterator API would be a better technique but not supported by all | |
// browsers). | |
var iterate = function (el) { | |
for (var i = el.firstChild; i != null; i = i.nextSibling) { | |
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) { | |
var mo = re.exec(i.tagName); | |
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") { | |
result[result.length] = new TocEntry(i, getText(i), mo[1]-1); | |
} | |
iterate(i); | |
} | |
} | |
} | |
iterate(el); | |
return result; | |
} | |
var toc = document.getElementById("toc"); | |
if (!toc) { | |
return; | |
} | |
// Delete existing TOC entries in case we're reloading the TOC. | |
var tocEntriesToRemove = []; | |
var i; | |
for (i = 0; i < toc.childNodes.length; i++) { | |
var entry = toc.childNodes[i]; | |
if (entry.nodeName.toLowerCase() == 'div' | |
&& entry.getAttribute("class") | |
&& entry.getAttribute("class").match(/^toclevel/)) | |
tocEntriesToRemove.push(entry); | |
} | |
for (i = 0; i < tocEntriesToRemove.length; i++) { | |
toc.removeChild(tocEntriesToRemove[i]); | |
} | |
// Rebuild TOC entries. | |
var entries = tocEntries(document.getElementById("content"), toclevels); | |
for (var i = 0; i < entries.length; ++i) { | |
var entry = entries[i]; | |
if (entry.element.id == "") | |
entry.element.id = "_toc_" + i; | |
var a = document.createElement("a"); | |
a.href = "#" + entry.element.id; | |
a.appendChild(document.createTextNode(entry.text)); | |
var div = document.createElement("div"); | |
div.appendChild(a); | |
div.className = "toclevel" + entry.toclevel; | |
toc.appendChild(div); | |
} | |
if (entries.length == 0) | |
toc.parentNode.removeChild(toc); | |
}, | |
///////////////////////////////////////////////////////////////////// | |
// Footnotes generator | |
///////////////////////////////////////////////////////////////////// | |
/* Based on footnote generation code from: | |
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html | |
*/ | |
footnotes: function () { | |
// Delete existing footnote entries in case we're reloading the footnodes. | |
var i; | |
var noteholder = document.getElementById("footnotes"); | |
if (!noteholder) { | |
return; | |
} | |
var entriesToRemove = []; | |
for (i = 0; i < noteholder.childNodes.length; i++) { | |
var entry = noteholder.childNodes[i]; | |
if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote") | |
entriesToRemove.push(entry); | |
} | |
for (i = 0; i < entriesToRemove.length; i++) { | |
noteholder.removeChild(entriesToRemove[i]); | |
} | |
// Rebuild footnote entries. | |
var cont = document.getElementById("content"); | |
var spans = cont.getElementsByTagName("span"); | |
var refs = {}; | |
var n = 0; | |
for (i=0; i<spans.length; i++) { | |
if (spans[i].className == "footnote") { | |
n++; | |
var note = spans[i].getAttribute("data-note"); | |
if (!note) { | |
// Use [\s\S] in place of . so multi-line matches work. | |
// Because JavaScript has no s (dotall) regex flag. | |
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; | |
spans[i].innerHTML = | |
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + | |
"' title='View footnote' class='footnote'>" + n + "</a>]"; | |
spans[i].setAttribute("data-note", note); | |
} | |
noteholder.innerHTML += | |
"<div class='footnote' id='_footnote_" + n + "'>" + | |
"<a href='#_footnoteref_" + n + "' title='Return to text'>" + | |
n + "</a>. " + note + "</div>"; | |
var id =spans[i].getAttribute("id"); | |
if (id != null) refs["#"+id] = n; | |
} | |
} | |
if (n == 0) | |
noteholder.parentNode.removeChild(noteholder); | |
else { | |
// Process footnoterefs. | |
for (i=0; i<spans.length; i++) { | |
if (spans[i].className == "footnoteref") { | |
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href"); | |
href = href.match(/#.*/)[0]; // Because IE return full URL. | |
n = refs[href]; | |
spans[i].innerHTML = | |
"[<a href='#_footnote_" + n + | |
"' title='View footnote' class='footnote'>" + n + "</a>]"; | |
} | |
} | |
} | |
}, | |
install: function(toclevels) { | |
var timerId; | |
function reinstall() { | |
asciidoc.footnotes(); | |
if (toclevels) { | |
asciidoc.toc(toclevels); | |
} | |
} | |
function reinstallAndRemoveTimer() { | |
clearInterval(timerId); | |
reinstall(); | |
} | |
timerId = setInterval(reinstall, 500); | |
if (document.addEventListener) | |
document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false); | |
else | |
window.onload = reinstallAndRemoveTimer; | |
} | |
} | |
asciidoc.install(); | |
/*]]>*/ | |
</script> | |
</head> | |
<body class="manpage"> | |
<div id="header"> | |
<h1> | |
git-switch(1) Manual Page | |
</h1> | |
<h2>NAME</h2> | |
<div class="sectionbody"> | |
<p>git-switch - | |
Switch branches | |
</p> | |
</div> | |
</div> | |
<div id="content"> | |
<div class="sect1"> | |
<h2 id="_synopsis">SYNOPSIS</h2> | |
<div class="sectionbody"> | |
<div class="verseblock"> | |
<pre class="content"><em>git switch</em> [<options>] [--no-guess] <branch> | |
<em>git switch</em> [<options>] --detach [<start-point>] | |
<em>git switch</em> [<options>] (-c|-C) <new-branch> [<start-point>] | |
<em>git switch</em> [<options>] --orphan <new-branch></pre> | |
<div class="attribution"> | |
</div></div> | |
</div> | |
</div> | |
<div class="sect1"> | |
<h2 id="_description">DESCRIPTION</h2> | |
<div class="sectionbody"> | |
<div class="paragraph"><p>Switch to a specified branch. The working tree and the index are | |
updated to match the branch. All new commits will be added to the tip | |
of this branch.</p></div> | |
<div class="paragraph"><p>Optionally a new branch could be created with either <code>-c</code>, <code>-C</code>, | |
automatically from a remote branch of same name (see <code>--guess</code>), or | |
detach the working tree from any branch with <code>--detach</code>, along with | |
switching.</p></div> | |
<div class="paragraph"><p>Switching branches does not require a clean index and working tree | |
(i.e. no differences compared to <code>HEAD</code>). The operation is aborted | |
however if the operation leads to loss of local changes, unless told | |
otherwise with <code>--discard-changes</code> or <code>--merge</code>.</p></div> | |
<div class="paragraph"><p>THIS COMMAND IS EXPERIMENTAL. THE BEHAVIOR MAY CHANGE.</p></div> | |
</div> | |
</div> | |
<div class="sect1"> | |
<h2 id="_options">OPTIONS</h2> | |
<div class="sectionbody"> | |
<div class="dlist"><dl> | |
<dt class="hdlist1"> | |
<branch> | |
</dt> | |
<dd> | |
<p> | |
Branch to switch to. | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
<new-branch> | |
</dt> | |
<dd> | |
<p> | |
Name for the new branch. | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
<start-point> | |
</dt> | |
<dd> | |
<p> | |
The starting point for the new branch. Specifying a | |
<code><start-point></code> allows you to create a branch based on some | |
other point in history than where HEAD currently points. (Or, | |
in the case of <code>--detach</code>, allows you to inspect and detach | |
from some other point.) | |
</p> | |
<div class="paragraph"><p>You can use the <code>@{-N}</code> syntax to refer to the N-th last | |
branch/commit switched to using "git switch" or "git checkout" | |
operation. You may also specify <code>-</code> which is synonymous to <code>@{-1}</code>. | |
This is often used to switch quickly between two branches, or to undo | |
a branch switch by mistake.</p></div> | |
<div class="paragraph"><p>As a special case, you may use <code>A...B</code> as a shortcut for the merge | |
base of <code>A</code> and <code>B</code> if there is exactly one merge base. You can leave | |
out at most one of <code>A</code> and <code>B</code>, in which case it defaults to <code>HEAD</code>.</p></div> | |
</dd> | |
<dt class="hdlist1"> | |
-c <new-branch> | |
</dt> | |
<dt class="hdlist1"> | |
--create <new-branch> | |
</dt> | |
<dd> | |
<p> | |
Create a new branch named <code><new-branch></code> starting at | |
<code><start-point></code> before switching to the branch. This is the | |
transactional equivalent of | |
</p> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>$ git branch <new-branch> | |
$ git switch <new-branch></code></pre> | |
</div></div> | |
<div class="paragraph"><p>that is to say, the branch is not reset/created unless "git switch" is | |
successful (e.g., when the branch is in use in another worktree, not | |
just the current branch stays the same, but the branch is not reset to | |
the start-point, either).</p></div> | |
</dd> | |
<dt class="hdlist1"> | |
-C <new-branch> | |
</dt> | |
<dt class="hdlist1"> | |
--force-create <new-branch> | |
</dt> | |
<dd> | |
<p> | |
Similar to <code>--create</code> except that if <code><new-branch></code> already | |
exists, it will be reset to <code><start-point></code>. This is a | |
convenient shortcut for: | |
</p> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>$ git branch -f <new-branch> | |
$ git switch <new-branch></code></pre> | |
</div></div> | |
</dd> | |
<dt class="hdlist1"> | |
-d | |
</dt> | |
<dt class="hdlist1"> | |
--detach | |
</dt> | |
<dd> | |
<p> | |
Switch to a commit for inspection and discardable | |
experiments. See the "DETACHED HEAD" section in | |
<a href="git-checkout.html">git-checkout(1)</a> for details. | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
--guess | |
</dt> | |
<dt class="hdlist1"> | |
--no-guess | |
</dt> | |
<dd> | |
<p> | |
If <code><branch></code> is not found but there does exist a tracking | |
branch in exactly one remote (call it <code><remote></code>) with a | |
matching name, treat as equivalent to | |
</p> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>$ git switch -c <branch> --track <remote>/<branch></code></pre> | |
</div></div> | |
<div class="paragraph"><p>If the branch exists in multiple remotes and one of them is named by | |
the <code>checkout.defaultRemote</code> configuration variable, we’ll use that | |
one for the purposes of disambiguation, even if the <code><branch></code> isn’t | |
unique across all remotes. Set it to e.g. <code>checkout.defaultRemote=origin</code> | |
to always checkout remote branches from there if <code><branch></code> is | |
ambiguous but exists on the <em>origin</em> remote. See also | |
<code>checkout.defaultRemote</code> in <a href="git-config.html">git-config(1)</a>.</p></div> | |
<div class="paragraph"><p><code>--guess</code> is the default behavior. Use <code>--no-guess</code> to disable it.</p></div> | |
<div class="paragraph"><p>The default behavior can be set via the <code>checkout.guess</code> configuration | |
variable.</p></div> | |
</dd> | |
<dt class="hdlist1"> | |
-f | |
</dt> | |
<dt class="hdlist1"> | |
--force | |
</dt> | |
<dd> | |
<p> | |
An alias for <code>--discard-changes</code>. | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
--discard-changes | |
</dt> | |
<dd> | |
<p> | |
Proceed even if the index or the working tree differs from | |
<code>HEAD</code>. Both the index and working tree are restored to match | |
the switching target. If <code>--recurse-submodules</code> is specified, | |
submodule content is also restored to match the switching | |
target. This is used to throw away local changes. | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
-m | |
</dt> | |
<dt class="hdlist1"> | |
--merge | |
</dt> | |
<dd> | |
<p> | |
If you have local modifications to one or more files that are | |
different between the current branch and the branch to which | |
you are switching, the command refuses to switch branches in | |
order to preserve your modifications in context. However, | |
with this option, a three-way merge between the current | |
branch, your working tree contents, and the new branch is | |
done, and you will be on the new branch. | |
</p> | |
<div class="paragraph"><p>When a merge conflict happens, the index entries for conflicting | |
paths are left unmerged, and you need to resolve the conflicts | |
and mark the resolved paths with <code>git add</code> (or <code>git rm</code> if the merge | |
should result in deletion of the path).</p></div> | |
</dd> | |
<dt class="hdlist1"> | |
--conflict=<style> | |
</dt> | |
<dd> | |
<p> | |
The same as <code>--merge</code> option above, but changes the way the | |
conflicting hunks are presented, overriding the | |
<code>merge.conflictStyle</code> configuration variable. Possible values are | |
"merge" (default), "diff3", and "zdiff3". | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
-q | |
</dt> | |
<dt class="hdlist1"> | |
--quiet | |
</dt> | |
<dd> | |
<p> | |
Quiet, suppress feedback messages. | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
--progress | |
</dt> | |
<dt class="hdlist1"> | |
--no-progress | |
</dt> | |
<dd> | |
<p> | |
Progress status is reported on the standard error stream | |
by default when it is attached to a terminal, unless <code>--quiet</code> | |
is specified. This flag enables progress reporting even if not | |
attached to a terminal, regardless of <code>--quiet</code>. | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
-t | |
</dt> | |
<dt class="hdlist1"> | |
--track [direct|inherit] | |
</dt> | |
<dd> | |
<p> | |
When creating a new branch, set up "upstream" configuration. | |
<code>-c</code> is implied. See <code>--track</code> in <a href="git-branch.html">git-branch(1)</a> for | |
details. | |
</p> | |
<div class="paragraph"><p>If no <code>-c</code> option is given, the name of the new branch will be derived | |
from the remote-tracking branch, by looking at the local part of the | |
refspec configured for the corresponding remote, and then stripping | |
the initial part up to the "*". This would tell us to use <code>hack</code> as | |
the local branch when branching off of <code>origin/hack</code> (or | |
<code>remotes/origin/hack</code>, or even <code>refs/remotes/origin/hack</code>). If the | |
given name has no slash, or the above guessing results in an empty | |
name, the guessing is aborted. You can explicitly give a name with | |
<code>-c</code> in such a case.</p></div> | |
</dd> | |
<dt class="hdlist1"> | |
--no-track | |
</dt> | |
<dd> | |
<p> | |
Do not set up "upstream" configuration, even if the | |
<code>branch.autoSetupMerge</code> configuration variable is true. | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
--orphan <new-branch> | |
</dt> | |
<dd> | |
<p> | |
Create a new unborn branch, named <code><new-branch></code>. All | |
tracked files are removed. | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
--ignore-other-worktrees | |
</dt> | |
<dd> | |
<p> | |
<code>git switch</code> refuses when the wanted ref is already | |
checked out by another worktree. This option makes it check | |
the ref out anyway. In other words, the ref can be held by | |
more than one worktree. | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
--recurse-submodules | |
</dt> | |
<dt class="hdlist1"> | |
--no-recurse-submodules | |
</dt> | |
<dd> | |
<p> | |
Using <code>--recurse-submodules</code> will update the content of all | |
active submodules according to the commit recorded in the | |
superproject. If nothing (or <code>--no-recurse-submodules</code>) is | |
used, submodules working trees will not be updated. Just | |
like <a href="git-submodule.html">git-submodule(1)</a>, this will detach <code>HEAD</code> of the | |
submodules. | |
</p> | |
</dd> | |
</dl></div> | |
</div> | |
</div> | |
<div class="sect1"> | |
<h2 id="_examples">EXAMPLES</h2> | |
<div class="sectionbody"> | |
<div class="paragraph"><p>The following command switches to the "master" branch:</p></div> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>$ git switch master</code></pre> | |
</div></div> | |
<div class="paragraph"><p>After working in the wrong branch, switching to the correct branch | |
would be done using:</p></div> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>$ git switch mytopic</code></pre> | |
</div></div> | |
<div class="paragraph"><p>However, your "wrong" branch and correct "mytopic" branch may differ | |
in files that you have modified locally, in which case the above | |
switch would fail like this:</p></div> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>$ git switch mytopic | |
error: You have local changes to 'frotz'; not switching branches.</code></pre> | |
</div></div> | |
<div class="paragraph"><p>You can give the <code>-m</code> flag to the command, which would try a three-way | |
merge:</p></div> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>$ git switch -m mytopic | |
Auto-merging frotz</code></pre> | |
</div></div> | |
<div class="paragraph"><p>After this three-way merge, the local modifications are <em>not</em> | |
registered in your index file, so <code>git diff</code> would show you what | |
changes you made since the tip of the new branch.</p></div> | |
<div class="paragraph"><p>To switch back to the previous branch before we switched to mytopic | |
(i.e. "master" branch):</p></div> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>$ git switch -</code></pre> | |
</div></div> | |
<div class="paragraph"><p>You can grow a new branch from any commit. For example, switch to | |
"HEAD~3" and create branch "fixup":</p></div> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>$ git switch -c fixup HEAD~3 | |
Switched to a new branch 'fixup'</code></pre> | |
</div></div> | |
<div class="paragraph"><p>If you want to start a new branch from a remote branch of the same | |
name:</p></div> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>$ git switch new-topic | |
Branch 'new-topic' set up to track remote branch 'new-topic' from 'origin' | |
Switched to a new branch 'new-topic'</code></pre> | |
</div></div> | |
<div class="paragraph"><p>To check out commit <code>HEAD~3</code> for temporary inspection or experiment | |
without creating a new branch:</p></div> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>$ git switch --detach HEAD~3 | |
HEAD is now at 9fc9555312 Merge branch 'cc/shared-index-permbits'</code></pre> | |
</div></div> | |
<div class="paragraph"><p>If it turns out whatever you have done is worth keeping, you can | |
always create a new name for it (without switching away):</p></div> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><code>$ git switch -c good-surprises</code></pre> | |
</div></div> | |
</div> | |
</div> | |
<div class="sect1"> | |
<h2 id="_configuration">CONFIGURATION</h2> | |
<div class="sectionbody"> | |
<div class="paragraph"><p>Everything below this line in this section is selectively included | |
from the <a href="git-config.html">git-config(1)</a> documentation. The content is the same | |
as what’s found there:</p></div> | |
<div class="dlist"><dl> | |
<dt class="hdlist1"> | |
checkout.defaultRemote | |
</dt> | |
<dd> | |
<p> | |
When you run <code>git checkout <something></code> | |
or <code>git switch <something></code> and only have one | |
remote, it may implicitly fall back on checking out and | |
tracking e.g. <code>origin/<something></code>. This stops working as soon | |
as you have more than one remote with a <code><something></code> | |
reference. This setting allows for setting the name of a | |
preferred remote that should always win when it comes to | |
disambiguation. The typical use-case is to set this to | |
<code>origin</code>. | |
</p> | |
<div class="paragraph"><p>Currently this is used by <a href="git-switch.html">git-switch(1)</a> and | |
<a href="git-checkout.html">git-checkout(1)</a> when <code>git checkout <something></code> | |
or <code>git switch <something></code> | |
will checkout the <code><something></code> branch on another remote, | |
and by <a href="git-worktree.html">git-worktree(1)</a> when <code>git worktree add</code> refers to a | |
remote branch. This setting might be used for other checkout-like | |
commands or functionality in the future.</p></div> | |
</dd> | |
<dt class="hdlist1"> | |
checkout.guess | |
</dt> | |
<dd> | |
<p> | |
Provides the default value for the <code>--guess</code> or <code>--no-guess</code> | |
option in <code>git checkout</code> and <code>git switch</code>. See | |
<a href="git-switch.html">git-switch(1)</a> and <a href="git-checkout.html">git-checkout(1)</a>. | |
</p> | |
</dd> | |
<dt class="hdlist1"> | |
checkout.workers | |
</dt> | |
<dd> | |
<p> | |
The number of parallel workers to use when updating the working tree. | |
The default is one, i.e. sequential execution. If set to a value less | |
than one, Git will use as many workers as the number of logical cores | |
available. This setting and <code>checkout.thresholdForParallelism</code> affect | |
all commands that perform checkout. E.g. checkout, clone, reset, | |
sparse-checkout, etc. | |
</p> | |
<div class="paragraph"><p>Note: Parallel checkout usually delivers better performance for repositories | |
located on SSDs or over NFS. For repositories on spinning disks and/or machines | |
with a small number of cores, the default sequential checkout often performs | |
better. The size and compression level of a repository might also influence how | |
well the parallel version performs.</p></div> | |
</dd> | |
<dt class="hdlist1"> | |
checkout.thresholdForParallelism | |
</dt> | |
<dd> | |
<p> | |
When running parallel checkout with a small number of files, the cost | |
of subprocess spawning and inter-process communication might outweigh | |
the parallelization gains. This setting allows you to define the minimum | |
number of files for which parallel checkout should be attempted. The | |
default is 100. | |
</p> | |
</dd> | |
</dl></div> | |
</div> | |
</div> | |
<div class="sect1"> | |
<h2 id="_see_also">SEE ALSO</h2> | |
<div class="sectionbody"> | |
<div class="paragraph"><p><a href="git-checkout.html">git-checkout(1)</a>, | |
<a href="git-branch.html">git-branch(1)</a></p></div> | |
</div> | |
</div> | |
<div class="sect1"> | |
<h2 id="_git">GIT</h2> | |
<div class="sectionbody"> | |
<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div> | |
</div> | |
</div> | |
</div> | |
<div id="footnotes"><hr /></div> | |
<div id="footer"> | |
<div id="footer-text"> | |
Last updated | |
2024-01-02 14:28:43 PST | |
</div> | |
</div> | |
</body> | |
</html> |