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