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: 2024-02-19
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.44.0.rc2
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-SWITCH" "1" "2024\-02\-19" "Git 2\&.44\&.0\&.rc2" "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 the transactional equivalent of
  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 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)\&.
 109 .RE
 110 .PP
 111 \-C <new\-branch>, \-\-force\-create <new\-branch>
 112 .RS 4
 113 Similar to
 114 \fB\-\-create\fR
 115 except that if
 116 \fB<new\-branch>\fR
 117 already exists, it will be reset to
 118 \fB<start\-point>\fR\&. This is a convenient shortcut for:
 119 .sp
 120 .if n \{\
 121 .RS 4
 122 .\}
 123 .nf
 124 $ git branch \-f <new\-branch>
 125 $ git switch <new\-branch>
 126 .fi
 127 .if n \{\
 128 .RE
 129 .\}
 130 .sp
 131 .RE
 132 .PP
 133 \-d, \-\-detach
 134 .RS 4
 135 Switch to a commit for inspection and discardable experiments\&. See the "DETACHED HEAD" section in
 136 \fBgit-checkout\fR(1)
 137 for details\&.
 138 .RE
 139 .PP
 140 \-\-guess, \-\-no\-guess
 141 .RS 4
 142 If
 143 \fB<branch>\fR
 144 is not found but there does exist a tracking branch in exactly one remote (call it
 145 \fB<remote>\fR) with a matching name, treat as equivalent to
 146 .sp
 147 .if n \{\
 148 .RS 4
 149 .\}
 150 .nf
 151 $ git switch \-c <branch> \-\-track <remote>/<branch>
 152 .fi
 153 .if n \{\
 154 .RE
 155 .\}
 156 .sp
 157 If the branch exists in multiple remotes and one of them is named by the
 158 \fBcheckout\&.defaultRemote\fR
 159 configuration variable, we\(cqll use that one for the purposes of disambiguation, even if the
 160 \fB<branch>\fR
 161 isn\(cqt unique across all remotes\&. Set it to e\&.g\&.
 162 \fBcheckout\&.defaultRemote=origin\fR
 163 to always checkout remote branches from there if
 164 \fB<branch>\fR
 165 is ambiguous but exists on the
 166 \fIorigin\fR
 167 remote\&. See also
 168 \fBcheckout\&.defaultRemote\fR
 169 in
 170 \fBgit-config\fR(1)\&.
 171 .sp
 172 \fB\-\-guess\fR
 173 is the default behavior\&. Use
 174 \fB\-\-no\-guess\fR
 175 to disable it\&.
 176 .sp
 177 The default behavior can be set via the
 178 \fBcheckout\&.guess\fR
 179 configuration variable\&.
 180 .RE
 181 .PP
 182 \-f, \-\-force
 183 .RS 4
 184 An alias for
 185 \fB\-\-discard\-changes\fR\&.
 186 .RE
 187 .PP
 188 \-\-discard\-changes
 189 .RS 4
 190 Proceed even if the index or the working tree differs from
 191 \fBHEAD\fR\&. Both the index and working tree are restored to match the switching target\&. If
 192 \fB\-\-recurse\-submodules\fR
 193 is specified, submodule content is also restored to match the switching target\&. This is used to throw away local changes\&.
 194 .RE
 195 .PP
 196 \-m, \-\-merge
 197 .RS 4
 198 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\&.
 199 .sp
 200 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
 201 \fBgit add\fR
 202 (or
 203 \fBgit rm\fR
 204 if the merge should result in deletion of the path)\&.
 205 .RE
 206 .PP
 207 \-\-conflict=<style>
 208 .RS 4
 209 The same as
 210 \fB\-\-merge\fR
 211 option above, but changes the way the conflicting hunks are presented, overriding the
 212 \fBmerge\&.conflictStyle\fR
 213 configuration variable\&. Possible values are "merge" (default), "diff3", and "zdiff3"\&.
 214 .RE
 215 .PP
 216 \-q, \-\-quiet
 217 .RS 4
 218 Quiet, suppress feedback messages\&.
 219 .RE
 220 .PP
 221 \-\-progress, \-\-no\-progress
 222 .RS 4
 223 Progress status is reported on the standard error stream by default when it is attached to a terminal, unless
 224 \fB\-\-quiet\fR
 225 is specified\&. This flag enables progress reporting even if not attached to a terminal, regardless of
 226 \fB\-\-quiet\fR\&.
 227 .RE
 228 .PP
 229 \-t, \-\-track [direct|inherit]
 230 .RS 4
 231 When creating a new branch, set up "upstream" configuration\&.
 232 \fB\-c\fR
 233 is implied\&. See
 234 \fB\-\-track\fR
 235 in
 236 \fBgit-branch\fR(1)
 237 for details\&.
 238 .sp
 239 If no
 240 \fB\-c\fR
 241 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
 242 \fBhack\fR
 243 as the local branch when branching off of
 244 \fBorigin/hack\fR
 245 (or
 246 \fBremotes/origin/hack\fR, or even
 247 \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
 248 \fB\-c\fR
 249 in such a case\&.
 250 .RE
 251 .PP
 252 \-\-no\-track
 253 .RS 4
 254 Do not set up "upstream" configuration, even if the
 255 \fBbranch\&.autoSetupMerge\fR
 256 configuration variable is true\&.
 257 .RE
 258 .PP
 259 \-\-orphan <new\-branch>
 260 .RS 4
 261 Create a new unborn branch, named
 262 \fB<new\-branch>\fR\&. All tracked files are removed\&.
 263 .RE
 264 .PP
 265 \-\-ignore\-other\-worktrees
 266 .RS 4
 267 \fBgit switch\fR
 268 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\&.
 269 .RE
 270 .PP
 271 \-\-recurse\-submodules, \-\-no\-recurse\-submodules
 272 .RS 4
 273 Using
 274 \fB\-\-recurse\-submodules\fR
 275 will update the content of all active submodules according to the commit recorded in the superproject\&. If nothing (or
 276 \fB\-\-no\-recurse\-submodules\fR) is used, submodules working trees will not be updated\&. Just like
 277 \fBgit-submodule\fR(1), this will detach
 278 \fBHEAD\fR
 279 of the submodules\&.
 280 .RE
 281 .SH "EXAMPLES"
 282 .sp
 283 The following command switches to the "master" branch:
 284 .sp
 285 .if n \{\
 286 .RS 4
 287 .\}
 288 .nf
 289 $ git switch master
 290 .fi
 291 .if n \{\
 292 .RE
 293 .\}
 294 .sp
 295 .sp
 296 After working in the wrong branch, switching to the correct branch would be done using:
 297 .sp
 298 .if n \{\
 299 .RS 4
 300 .\}
 301 .nf
 302 $ git switch mytopic
 303 .fi
 304 .if n \{\
 305 .RE
 306 .\}
 307 .sp
 308 .sp
 309 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:
 310 .sp
 311 .if n \{\
 312 .RS 4
 313 .\}
 314 .nf
 315 $ git switch mytopic
 316 error: You have local changes to \*(Aqfrotz\*(Aq; not switching branches\&.
 317 .fi
 318 .if n \{\
 319 .RE
 320 .\}
 321 .sp
 322 .sp
 323 You can give the \fB\-m\fR flag to the command, which would try a three\-way merge:
 324 .sp
 325 .if n \{\
 326 .RS 4
 327 .\}
 328 .nf
 329 $ git switch \-m mytopic
 330 Auto\-merging frotz
 331 .fi
 332 .if n \{\
 333 .RE
 334 .\}
 335 .sp
 336 .sp
 337 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\&.
 338 .sp
 339 To switch back to the previous branch before we switched to mytopic (i\&.e\&. "master" branch):
 340 .sp
 341 .if n \{\
 342 .RS 4
 343 .\}
 344 .nf
 345 $ git switch \-
 346 .fi
 347 .if n \{\
 348 .RE
 349 .\}
 350 .sp
 351 .sp
 352 You can grow a new branch from any commit\&. For example, switch to "HEAD~3" and create branch "fixup":
 353 .sp
 354 .if n \{\
 355 .RS 4
 356 .\}
 357 .nf
 358 $ git switch \-c fixup HEAD~3
 359 Switched to a new branch \*(Aqfixup\*(Aq
 360 .fi
 361 .if n \{\
 362 .RE
 363 .\}
 364 .sp
 365 .sp
 366 If you want to start a new branch from a remote branch of the same name:
 367 .sp
 368 .if n \{\
 369 .RS 4
 370 .\}
 371 .nf
 372 $ git switch new\-topic
 373 Branch \*(Aqnew\-topic\*(Aq set up to track remote branch \*(Aqnew\-topic\*(Aq from \*(Aqorigin\*(Aq
 374 Switched to a new branch \*(Aqnew\-topic\*(Aq
 375 .fi
 376 .if n \{\
 377 .RE
 378 .\}
 379 .sp
 380 .sp
 381 To check out commit \fBHEAD~3\fR for temporary inspection or experiment without creating a new branch:
 382 .sp
 383 .if n \{\
 384 .RS 4
 385 .\}
 386 .nf
 387 $ git switch \-\-detach HEAD~3
 388 HEAD is now at 9fc9555312 Merge branch \*(Aqcc/shared\-index\-permbits\*(Aq
 389 .fi
 390 .if n \{\
 391 .RE
 392 .\}
 393 .sp
 394 .sp
 395 If it turns out whatever you have done is worth keeping, you can always create a new name for it (without switching away):
 396 .sp
 397 .if n \{\
 398 .RS 4
 399 .\}
 400 .nf
 401 $ git switch \-c good\-surprises
 402 .fi
 403 .if n \{\
 404 .RE
 405 .\}
 406 .sp
 407 .SH "CONFIGURATION"
 408 .sp
 409 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:
 410 .PP
 411 checkout\&.defaultRemote
 412 .RS 4
 413 When you run
 414 \fBgit checkout <something>\fR
 415 or
 416 \fBgit switch <something>\fR
 417 and only have one remote, it may implicitly fall back on checking out and tracking e\&.g\&.
 418 \fBorigin/<something>\fR\&. This stops working as soon as you have more than one remote with a
 419 \fB<something>\fR
 420 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
 421 \fBorigin\fR\&.
 422 .sp
 423 Currently this is used by
 424 \fBgit-switch\fR(1)
 425 and
 426 \fBgit-checkout\fR(1)
 427 when
 428 \fBgit checkout <something>\fR
 429 or
 430 \fBgit switch <something>\fR
 431 will checkout the
 432 \fB<something>\fR
 433 branch on another remote, and by
 434 \fBgit-worktree\fR(1)
 435 when
 436 \fBgit worktree add\fR
 437 refers to a remote branch\&. This setting might be used for other checkout\-like commands or functionality in the future\&.
 438 .RE
 439 .PP
 440 checkout\&.guess
 441 .RS 4
 442 Provides the default value for the
 443 \fB\-\-guess\fR
 444 or
 445 \fB\-\-no\-guess\fR
 446 option in
 447 \fBgit checkout\fR
 448 and
 449 \fBgit switch\fR\&. See
 450 \fBgit-switch\fR(1)
 451 and
 452 \fBgit-checkout\fR(1)\&.
 453 .RE
 454 .PP
 455 checkout\&.workers
 456 .RS 4
 457 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
 458 \fBcheckout\&.thresholdForParallelism\fR
 459 affect all commands that perform checkout\&. E\&.g\&. checkout, clone, reset, sparse\-checkout, etc\&.
 460 .sp
 461 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\&.
 462 .RE
 463 .PP
 464 checkout\&.thresholdForParallelism
 465 .RS 4
 466 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\&.
 467 .RE
 468 .SH "SEE ALSO"
 469 .sp
 470 \fBgit-checkout\fR(1), \fBgit-branch\fR(1)
 471 .SH "GIT"
 472 .sp
 473 Part of the \fBgit\fR(1) suite