man1/git-switch.1

   1 '\" t
   2 .\"     Title: git-switch
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2023-08-14
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.42.0.rc1.11.gfc6bba66bc
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-SWITCH" "1" "2023\-08\-14" "Git 2\&.42\&.0\&.rc1\&.11\&.gf" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-switch \- Switch branches
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit switch\fR [<options>] [\-\-no\-guess] <branch>
  36 \fIgit switch\fR [<options>] \-\-detach [<start\-point>]
  37 \fIgit switch\fR [<options>] (\-c|\-C) <new\-branch> [<start\-point>]
  38 \fIgit switch\fR [<options>] \-\-orphan <new\-branch>
  39 .fi
  40 .sp
  41 .SH "DESCRIPTION"
  42 .sp
  43 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\&.
  44 .sp
  45 Optionally a new branch could be created with either \fB\-c\fR, \fB\-C\fR, automatically from a remote branch of same name (see \fB\-\-guess\fR), or detach the working tree from any branch with \fB\-\-detach\fR, along with switching\&.
  46 .sp
  47 Switching branches does not require a clean index and working tree (i\&.e\&. no differences compared to \fBHEAD\fR)\&. The operation is aborted however if the operation leads to loss of local changes, unless told otherwise with \fB\-\-discard\-changes\fR or \fB\-\-merge\fR\&.
  48 .sp
  49 THIS COMMAND IS EXPERIMENTAL\&. THE BEHAVIOR MAY CHANGE\&.
  50 .SH "OPTIONS"
  51 .PP
  52 <branch>
  53 .RS 4
  54 Branch to switch to\&.
  55 .RE
  56 .PP
  57 <new\-branch>
  58 .RS 4
  59 Name for the new branch\&.
  60 .RE
  61 .PP
  62 <start\-point>
  63 .RS 4
  64 The starting point for the new branch\&. Specifying a
  65 \fB<start\-point>\fR
  66 allows you to create a branch based on some other point in history than where HEAD currently points\&. (Or, in the case of
  67 \fB\-\-detach\fR, allows you to inspect and detach from some other point\&.)
  68 .sp
  69 You can use the
  70 \fB@{\-N}\fR
  71 syntax to refer to the N\-th last branch/commit switched to using "git switch" or "git checkout" operation\&. You may also specify
  72 \fB\-\fR
  73 which is synonymous to
  74 \fB@{\-1}\fR\&. This is often used to switch quickly between two branches, or to undo a branch switch by mistake\&.
  75 .sp
  76 As a special case, you may use
  77 \fBA\&.\&.\&.B\fR
  78 as a shortcut for the merge base of
  79 \fBA\fR
  80 and
  81 \fBB\fR
  82 if there is exactly one merge base\&. You can leave out at most one of
  83 \fBA\fR
  84 and
  85 \fBB\fR, in which case it defaults to
  86 \fBHEAD\fR\&.
  87 .RE
  88 .PP
  89 \-c <new\-branch>, \-\-create <new\-branch>
  90 .RS 4
  91 Create a new branch named
  92 \fB<new\-branch>\fR
  93 starting at
  94 \fB<start\-point>\fR
  95 before switching to the branch\&. This is a convenient shortcut for:
  96 .sp
  97 .if n \{\
  98 .RS 4
  99 .\}
 100 .nf
 101 $ git branch <new\-branch>
 102 $ git switch <new\-branch>
 103 .fi
 104 .if n \{\
 105 .RE
 106 .\}
 107 .sp
 108 .RE
 109 .PP
 110 \-C <new\-branch>, \-\-force\-create <new\-branch>
 111 .RS 4
 112 Similar to
 113 \fB\-\-create\fR
 114 except that if
 115 \fB<new\-branch>\fR
 116 already exists, it will be reset to
 117 \fB<start\-point>\fR\&. This is a convenient shortcut for:
 118 .sp
 119 .if n \{\
 120 .RS 4
 121 .\}
 122 .nf
 123 $ git branch \-f <new\-branch>
 124 $ git switch <new\-branch>
 125 .fi
 126 .if n \{\
 127 .RE
 128 .\}
 129 .sp
 130 .RE
 131 .PP
 132 \-d, \-\-detach
 133 .RS 4
 134 Switch to a commit for inspection and discardable experiments\&. See the "DETACHED HEAD" section in
 135 \fBgit-checkout\fR(1)
 136 for details\&.
 137 .RE
 138 .PP
 139 \-\-guess, \-\-no\-guess
 140 .RS 4
 141 If
 142 \fB<branch>\fR
 143 is not found but there does exist a tracking branch in exactly one remote (call it
 144 \fB<remote>\fR) with a matching name, treat as equivalent to
 145 .sp
 146 .if n \{\
 147 .RS 4
 148 .\}
 149 .nf
 150 $ git switch \-c <branch> \-\-track <remote>/<branch>
 151 .fi
 152 .if n \{\
 153 .RE
 154 .\}
 155 .sp
 156 If the branch exists in multiple remotes and one of them is named by the
 157 \fBcheckout\&.defaultRemote\fR
 158 configuration variable, we\(cqll use that one for the purposes of disambiguation, even if the
 159 \fB<branch>\fR
 160 isn\(cqt unique across all remotes\&. Set it to e\&.g\&.
 161 \fBcheckout\&.defaultRemote=origin\fR
 162 to always checkout remote branches from there if
 163 \fB<branch>\fR
 164 is ambiguous but exists on the
 165 \fIorigin\fR
 166 remote\&. See also
 167 \fBcheckout\&.defaultRemote\fR
 168 in
 169 \fBgit-config\fR(1)\&.
 170 .sp
 171 \fB\-\-guess\fR
 172 is the default behavior\&. Use
 173 \fB\-\-no\-guess\fR
 174 to disable it\&.
 175 .sp
 176 The default behavior can be set via the
 177 \fBcheckout\&.guess\fR
 178 configuration variable\&.
 179 .RE
 180 .PP
 181 \-f, \-\-force
 182 .RS 4
 183 An alias for
 184 \fB\-\-discard\-changes\fR\&.
 185 .RE
 186 .PP
 187 \-\-discard\-changes
 188 .RS 4
 189 Proceed even if the index or the working tree differs from
 190 \fBHEAD\fR\&. Both the index and working tree are restored to match the switching target\&. If
 191 \fB\-\-recurse\-submodules\fR
 192 is specified, submodule content is also restored to match the switching target\&. This is used to throw away local changes\&.
 193 .RE
 194 .PP
 195 \-m, \-\-merge
 196 .RS 4
 197 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\&.
 198 .sp
 199 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
 200 \fBgit add\fR
 201 (or
 202 \fBgit rm\fR
 203 if the merge should result in deletion of the path)\&.
 204 .RE
 205 .PP
 206 \-\-conflict=<style>
 207 .RS 4
 208 The same as
 209 \fB\-\-merge\fR
 210 option above, but changes the way the conflicting hunks are presented, overriding the
 211 \fBmerge\&.conflictStyle\fR
 212 configuration variable\&. Possible values are "merge" (default), "diff3", and "zdiff3"\&.
 213 .RE
 214 .PP
 215 \-q, \-\-quiet
 216 .RS 4
 217 Quiet, suppress feedback messages\&.
 218 .RE
 219 .PP
 220 \-\-progress, \-\-no\-progress
 221 .RS 4
 222 Progress status is reported on the standard error stream by default when it is attached to a terminal, unless
 223 \fB\-\-quiet\fR
 224 is specified\&. This flag enables progress reporting even if not attached to a terminal, regardless of
 225 \fB\-\-quiet\fR\&.
 226 .RE
 227 .PP
 228 \-t, \-\-track [direct|inherit]
 229 .RS 4
 230 When creating a new branch, set up "upstream" configuration\&.
 231 \fB\-c\fR
 232 is implied\&. See
 233 \fB\-\-track\fR
 234 in
 235 \fBgit-branch\fR(1)
 236 for details\&.
 237 .sp
 238 If no
 239 \fB\-c\fR
 240 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
 241 \fBhack\fR
 242 as the local branch when branching off of
 243 \fBorigin/hack\fR
 244 (or
 245 \fBremotes/origin/hack\fR, or even
 246 \fBrefs/remotes/origin/hack\fR)\&. 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
 247 \fB\-c\fR
 248 in such a case\&.
 249 .RE
 250 .PP
 251 \-\-no\-track
 252 .RS 4
 253 Do not set up "upstream" configuration, even if the
 254 \fBbranch\&.autoSetupMerge\fR
 255 configuration variable is true\&.
 256 .RE
 257 .PP
 258 \-\-orphan <new\-branch>
 259 .RS 4
 260 Create a new
 261 \fIorphan\fR
 262 branch, named
 263 \fB<new\-branch>\fR\&. All tracked files are removed\&.
 264 .RE
 265 .PP
 266 \-\-ignore\-other\-worktrees
 267 .RS 4
 268 \fBgit switch\fR
 269 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\&.
 270 .RE
 271 .PP
 272 \-\-recurse\-submodules, \-\-no\-recurse\-submodules
 273 .RS 4
 274 Using
 275 \fB\-\-recurse\-submodules\fR
 276 will update the content of all active submodules according to the commit recorded in the superproject\&. If nothing (or
 277 \fB\-\-no\-recurse\-submodules\fR) is used, submodules working trees will not be updated\&. Just like
 278 \fBgit-submodule\fR(1), this will detach
 279 \fBHEAD\fR
 280 of the submodules\&.
 281 .RE
 282 .SH "EXAMPLES"
 283 .sp
 284 The following command switches to the "master" branch:
 285 .sp
 286 .if n \{\
 287 .RS 4
 288 .\}
 289 .nf
 290 $ git switch master
 291 .fi
 292 .if n \{\
 293 .RE
 294 .\}
 295 .sp
 296 .sp
 297 After working in the wrong branch, switching to the correct branch would be done using:
 298 .sp
 299 .if n \{\
 300 .RS 4
 301 .\}
 302 .nf
 303 $ git switch mytopic
 304 .fi
 305 .if n \{\
 306 .RE
 307 .\}
 308 .sp
 309 .sp
 310 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:
 311 .sp
 312 .if n \{\
 313 .RS 4
 314 .\}
 315 .nf
 316 $ git switch mytopic
 317 error: You have local changes to \*(Aqfrotz\*(Aq; not switching branches\&.
 318 .fi
 319 .if n \{\
 320 .RE
 321 .\}
 322 .sp
 323 .sp
 324 You can give the \fB\-m\fR flag to the command, which would try a three\-way merge:
 325 .sp
 326 .if n \{\
 327 .RS 4
 328 .\}
 329 .nf
 330 $ git switch \-m mytopic
 331 Auto\-merging frotz
 332 .fi
 333 .if n \{\
 334 .RE
 335 .\}
 336 .sp
 337 .sp
 338 After this three\-way merge, the local modifications are \fInot\fR registered in your index file, so \fBgit diff\fR would show you what changes you made since the tip of the new branch\&.
 339 .sp
 340 To switch back to the previous branch before we switched to mytopic (i\&.e\&. "master" branch):
 341 .sp
 342 .if n \{\
 343 .RS 4
 344 .\}
 345 .nf
 346 $ git switch \-
 347 .fi
 348 .if n \{\
 349 .RE
 350 .\}
 351 .sp
 352 .sp
 353 You can grow a new branch from any commit\&. For example, switch to "HEAD~3" and create branch "fixup":
 354 .sp
 355 .if n \{\
 356 .RS 4
 357 .\}
 358 .nf
 359 $ git switch \-c fixup HEAD~3
 360 Switched to a new branch \*(Aqfixup\*(Aq
 361 .fi
 362 .if n \{\
 363 .RE
 364 .\}
 365 .sp
 366 .sp
 367 If you want to start a new branch from a remote branch of the same name:
 368 .sp
 369 .if n \{\
 370 .RS 4
 371 .\}
 372 .nf
 373 $ git switch new\-topic
 374 Branch \*(Aqnew\-topic\*(Aq set up to track remote branch \*(Aqnew\-topic\*(Aq from \*(Aqorigin\*(Aq
 375 Switched to a new branch \*(Aqnew\-topic\*(Aq
 376 .fi
 377 .if n \{\
 378 .RE
 379 .\}
 380 .sp
 381 .sp
 382 To check out commit \fBHEAD~3\fR for temporary inspection or experiment without creating a new branch:
 383 .sp
 384 .if n \{\
 385 .RS 4
 386 .\}
 387 .nf
 388 $ git switch \-\-detach HEAD~3
 389 HEAD is now at 9fc9555312 Merge branch \*(Aqcc/shared\-index\-permbits\*(Aq
 390 .fi
 391 .if n \{\
 392 .RE
 393 .\}
 394 .sp
 395 .sp
 396 If it turns out whatever you have done is worth keeping, you can always create a new name for it (without switching away):
 397 .sp
 398 .if n \{\
 399 .RS 4
 400 .\}
 401 .nf
 402 $ git switch \-c good\-surprises
 403 .fi
 404 .if n \{\
 405 .RE
 406 .\}
 407 .sp
 408 .SH "CONFIGURATION"
 409 .sp
 410 Everything below this line in this section is selectively included from the \fBgit-config\fR(1) documentation\&. The content is the same as what\(cqs found there:
 411 .PP
 412 checkout\&.defaultRemote
 413 .RS 4
 414 When you run
 415 \fBgit checkout <something>\fR
 416 or
 417 \fBgit switch <something>\fR
 418 and only have one remote, it may implicitly fall back on checking out and tracking e\&.g\&.
 419 \fBorigin/<something>\fR\&. This stops working as soon as you have more than one remote with a
 420 \fB<something>\fR
 421 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
 422 \fBorigin\fR\&.
 423 .sp
 424 Currently this is used by
 425 \fBgit-switch\fR(1)
 426 and
 427 \fBgit-checkout\fR(1)
 428 when
 429 \fBgit checkout <something>\fR
 430 or
 431 \fBgit switch <something>\fR
 432 will checkout the
 433 \fB<something>\fR
 434 branch on another remote, and by
 435 \fBgit-worktree\fR(1)
 436 when
 437 \fBgit worktree add\fR
 438 refers to a remote branch\&. This setting might be used for other checkout\-like commands or functionality in the future\&.
 439 .RE
 440 .PP
 441 checkout\&.guess
 442 .RS 4
 443 Provides the default value for the
 444 \fB\-\-guess\fR
 445 or
 446 \fB\-\-no\-guess\fR
 447 option in
 448 \fBgit checkout\fR
 449 and
 450 \fBgit switch\fR\&. See
 451 \fBgit-switch\fR(1)
 452 and
 453 \fBgit-checkout\fR(1)\&.
 454 .RE
 455 .PP
 456 checkout\&.workers
 457 .RS 4
 458 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
 459 \fBcheckout\&.thresholdForParallelism\fR
 460 affect all commands that perform checkout\&. E\&.g\&. checkout, clone, reset, sparse\-checkout, etc\&.
 461 .sp
 462 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\&.
 463 .RE
 464 .PP
 465 checkout\&.thresholdForParallelism
 466 .RS 4
 467 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 to define the minimum number of files for which parallel checkout should be attempted\&. The default is 100\&.
 468 .RE
 469 .SH "SEE ALSO"
 470 .sp
 471 \fBgit-checkout\fR(1), \fBgit-branch\fR(1)
 472 .SH "GIT"
 473 .sp
 474 Part of the \fBgit\fR(1) suite