简体中文 ▾ 主题 ▾ 最新版本 ▾ git-switch 最后更新于 2.51.0

名称

git-switch - 切换分支

概要

git switch [<options>] [--no-guess] <branch>
git switch [<options>] --detach [<start-point>]
git switch [<options>] (-c|-C) <new-branch> [<start-point>]
git switch [<options>] --orphan <new-branch>

描述

切换到指定分支。工作区和暂存区(index)将更新以匹配该分支。所有新提交都将添加到该分支的末梢。

在切换的同时,可以选择使用 -c-C 创建新分支,或从同名的远程分支自动创建(参见 --guess),或者使用 --detach 将工作区与任何分支分离。

切换分支不需要清洁的暂存区和工作区(即与 HEAD 相比没有差异)。但如果操作会导致本地修改丢失,除非使用了 --discard-changes--merge,否则操作将被终止。

选项

<分支>

要切换到的分支。

<新分支>

新分支的名称。

<起始点>

新分支的起始点。指定 <起始点> 允许您基于历史中除当前 HEAD 指向位置以外的其他点创建分支。(或者在 --detach 的情况下,允许您检视并分离自其他点。)

您可以使用 @{-<N>} 语法来引用使用 git switchgit checkout 操作切换到的第 <N> 个最后分支/提交。您也可以指定 -,它等同于 @{-1}。这通常用于在两个分支之间快速切换,或撤销一次误操作的分支切换。

作为一种特殊情况,如果 <rev-a><rev-b> 恰好有一个合并基准,您可以使用 <rev-a>...<rev-b> 作为它们的合并基准的快捷方式。您最多可以省略 <rev-a><rev-b> 中的一个,在这种情况下默认值为 HEAD

-c <新分支>
--create <新分支>

在切换到分支之前,先创建一个名为 <新分支> 且起始于 <起始点> 的新分支。这是以下操作的事务性等价物:

$ git branch <new-branch>
$ git switch <new-branch>

也就是说,除非 git switch 成功,否则分支不会被重置/创建(例如,当该分支正在另一个工作树中使用时,不仅当前分支保持不变,分支也不会被重置到起始点)。

-C <新分支>
--force-create <新分支>

--create 类似,不同之处在于如果 <新分支> 已经存在,它将被重置为 <起始点>。这是以下操作的便捷快捷方式:

$ git branch -f _<new-branch>_
$ git switch _<new-branch>_
-d
--detach

切换到一个提交以进行检视和可丢弃的实验。详见 git-checkout[1] 中的“DETACHED HEAD”章节。

--guess
--no-guess

如果找不到 <分支>,但在恰好一个远程库(称之为 <远程库>)中存在名称匹配的跟踪分支,则将其视为等同于:

$ git switch -c <branch> --track <remote>/<branch>

如果该分支存在于多个远程库中,且其中一个由 checkout.defaultRemote 配置变量指定,我们将使用该远程库进行消歧,即使 <分支> 在所有远程库中不是唯一的。例如,将其设置为 checkout.defaultRemote=origin,以便在 <分支> 模糊但存在于 origin 远程库时,始终从那里检出远程分支。另请参阅 git-config[1] 中的 checkout.defaultRemote

--guess 是默认行为。使用 --no-guess 禁用它。

默认行为可以通过 checkout.guess 配置变量来设置。

-f
--force

--discard-changes 的别名。

--discard-changes

即使暂存区或工作树与 HEAD 不同也继续操作。暂存区和工作树都会被恢复以匹配切换目标。如果指定了 --recurse-submodules,子模块内容也会被恢复以匹配切换目标。这用于丢弃本地修改。

-m
--merge

如果您对一个或多个文件进行了本地修改,且这些文件在当前分支和要切换到的分支之间存在差异,该命令为了在上下文中保留您的修改会拒绝切换分支。但是,使用此选项,将在当前分支、您的工作树内容和新分支之间进行三方合并,然后您将处于新分支上。

当发生合并冲突时,冲突路径的暂存区条目将保持未合并状态,您需要解决冲突并使用 git add 标记已解决的路径(如果合并结果应该是删除该路径,则使用 git rm)。

--conflict=<样式>

与上面的 --merge 选项相同,但会更改冲突块的呈现方式,覆盖 merge.conflictStyle 配置变量。可能的值包括 merge(默认)、diff3zdiff3

-q
--quiet

安静模式,抑制反馈消息。

--progress
--no-progress

默认情况下,如果进度状态流被连接到终端,则进度状态会显示在标准错误流上,除非指定了 --quiet。此标志即使未连接到终端也会启用进度报告,无论 --quiet 如何。

-t
--track[ (direct|inherit)]

创建新分支时,设置“上游”配置。隐含 -c。详见 git-branch[1] 中的 --track

如果没有给出 -c 选项,新分支的名称将从远程跟踪分支推导出来,方法是查看为相应远程库配置的引用规格(refspec)的本地部分,然后去掉直到“*”的初始部分。这将告诉我们在从 origin/hack(或 remotes/origin/hack,甚至 refs/remotes/origin/hack)分叉时使用 hack 作为本地分支。如果给定的名称没有斜杠,或者上述推测导致名称为空,则推测被中止。在这种情况下,您可以使用 -c 显式指定一个名称。

--no-track

即使 branch.autoSetupMerge 配置变量为 true,也不设置“上游”配置。

--orphan <新分支>

创建一个名为 <新分支> 的新未出生(unborn)分支。所有已跟踪的文件都将被移除。

--ignore-other-worktrees

当所需的引用已经被另一个工作树检出时,git switch 会拒绝操作。此选项使其仍然检出该引用。换句话说,该引用可以由多个工作树持有。

--recurse-submodules
--no-recurse-submodules

使用 --recurse-submodules 将根据主项目中记录的提交更新所有活动子模块的内容。如果未使用任何参数(或使用了 --no-recurse-submodules),子模块的工作树将不会被更新。就像 git-submodule[1] 一样,这会使子模块的 HEAD 处于分离状态。

示例

以下命令切换到 "master" 分支

$ git switch master

在错误的分支工作后,切换到正确的分支可以使用

$ git switch mytopic

然而,您的“错误”分支和正确的 "mytopic" 分支在您本地修改的文件上可能存在差异,在这种情况下,上述切换会像这样失败

$ git switch mytopic
error: You have local changes to 'frotz'; not switching branches.

您可以向命令提供 -m 标志,这将尝试三方合并

$ git switch -m mytopic
Auto-merging frotz

在这次三方合并之后,本地修改 不会 注册在您的暂存区文件中,因此 git diff 将显示您自新分支末梢以来所做的更改。

切换回切换到 mytopic 之前的上一个分支(即 "master" 分支)

$ git switch -

您可以从任何提交处生长出一个新分支。例如,切换到 "HEAD~3" 并创建分支 "fixup"

$ git switch -c fixup HEAD~3
Switched to a new branch 'fixup'

如果您想从同名的远程分支启动一个新分支

$ git switch new-topic
Branch `new-topic` set up to track remote branch `new-topic` from `origin`
Switched to a new branch `new-topic`

要在不创建新分支的情况下,检出提交 HEAD~3 以进行临时检视或实验

$ git switch --detach HEAD~3
HEAD is now at 9fc9555312 Merge branch 'cc/shared-index-permbits'

如果事实证明您所做的任何工作都值得保留,您可以随时为它创建一个新名称(无需切换走)

$ git switch -c good-surprises

配置

本节中以下所有内容均从 git-config[1] 文档中选择性地包含。内容与彼处相同:

checkout.defaultRemote

当您运行 git checkout <something>git switch <something> 且只有一个远程时,它可能会隐式地回退到签出和跟踪 e.g. origin/<something>。一旦您有多个具有 *<something>* 引用的远程,这种情况就会停止工作。此设置允许设置一个首选远程的名称,该名称在歧义化时应始终优先。典型用例是将其设置为 origin

目前,它由 git-switch[1]git-checkout[1] 使用,当 git checkout <something>git switch <something> 会签出另一个远程上的 *<something>* 分支时,以及由 git-worktree[1] 使用,当 git worktree add 指的是远程分支时。此设置将来可能会用于其他类似 checkout 的命令或功能。

checkout.guess

git checkoutgit switch 命令中的 --guess--no-guess 选项提供默认值。参见 git-switch[1]git-checkout[1]

checkout.workers

更新工作树时使用的并行工作进程数量。默认为一个,即顺序执行。如果设置为小于一的值,Git 将使用与可用逻辑核心数相同的数量的工作进程。此设置和 checkout.thresholdForParallelism 会影响所有执行 checkout 的命令。例如:checkout、clone、reset、sparse-checkout 等。

注意
并行 checkout 通常可以提高位于 SSD 或 NFS 上的存储库的性能。对于旋转硬盘和/或核心数较少的机器上的存储库,默认的顺序 checkout 通常性能更好。存储库的大小和压缩级别也可能影响并行版本的性能。
checkout.thresholdForParallelism

当使用少量文件进行并行 checkout 时,子进程生成和进程间通信的成本可能会超过并行化的收益。此设置允许您定义应尝试并行 checkout 的最小文件数。默认值为 100。

GIT

Git[1] 套件的一部分