Git

git-reset 最后更新于 2.53.0

名称

git-reset - 将 HEAD 或索引设置为已知状态

概要

git reset [--soft | --mixed [-N] | --hard | --merge | --keep] [-q] [<commit>]
git reset [-q] [<tree-ish>] [--] <pathspec>…
git reset [-q] [--pathspec-from-file=<file> [--pathspec-file-nul]] [<tree-ish>]
git reset (--patch | -p) [<tree-ish>] [--] [<pathspec>…]

描述

git reset 执行以下任一操作

git reset [<mode>] <commit> 更改 HEAD 指向的提交。这使得可以撤销各种 Git 操作，例如提交、合并、变基和拉取。
当您指定文件或目录或传递 --patch 时，git reset 会更新指定文件的暂存版本。

git reset [<mode>] [<commit>]

将当前分支头 (HEAD) 设置为指向 <commit>。根据 <mode>，还会更新工作目录和/或索引以匹配 <commit> 的内容。<commit> 默认为 HEAD。操作之前，ORIG_HEAD 将设置为当前分支的尖端。

<mode> 必须是以下之一（默认为 --mixed）

--mixed

保持您的工作目录不变。更新索引以匹配新的 HEAD，因此不会有任何内容被暂存。

如果指定了 -N，将已删除的路径标记为“意图添加”（参见 git-add[1]）。

--soft

保持您的工作树文件和索引不变。例如，如果您没有暂存的更改，您可以使用 git reset --soft HEAD~5; git commit 将最近的 5 次提交合并为 1 次提交。即使工作树中有更改，此操作也有效，这些更改保持不变，但这种用法可能会导致混淆。

--hard

用 <commit> 中的版本覆盖所有文件和目录，并且可能会覆盖未跟踪的文件。不在 <commit> 中的跟踪文件将被删除，以便工作树匹配 <commit>。更新索引以匹配新的 HEAD，因此不会有任何内容被暂存。

--merge

重置索引并更新工作树中在 <commit> 和 HEAD 之间不同的文件，但保留索引和工作树之间不同的文件（即，有尚未添加的更改的文件）。主要用于重置未合并的索引条目，例如 git am -3 或 git switch -m 在某些情况下留下的那些。如果一个文件在 <commit> 和索引之间不同，并且有未暂存的更改，则重置中止。

--keep

重置索引条目并更新工作树中在 <commit> 和 HEAD 之间不同的文件。如果一个文件在 <commit> 和 HEAD 之间不同，并且有本地更改，则重置中止。

--recurse-submodules

--no-recurse-submodules

当工作树更新时，使用 --recurse-submodules 还会根据超级项目中记录的提交递归重置所有活动子模块的工作树，同时将子模块的 HEAD 设置为在该提交处分离。

git reset [-q] [<tree-ish>] [--] <pathspec>...

git reset [-q] [--pathspec-from-file=<file> [--pathspec-file-nul]] [<tree-ish>]

对于所有指定的文件或目录，将暂存版本设置为给定提交或树（默认为 HEAD）中的版本。

这意味着 git reset <pathspec> 与 git add <pathspec> 相反：它取消暂存指定文件或目录的所有更改。这等同于 git restore --staged <pathspec>...。

在此模式下，git reset 仅更新索引（不更新 HEAD 或工作树文件）。如果您想更新文件和索引条目，请使用 git-restore[1]。

git reset (--patch | -p) [<tree-ish>] [--] [<pathspec>...]

交互式地从索引和指定提交或树（默认为 HEAD）之间的差异中选择更改。索引使用选定的更改进行修改。

这意味着 git reset -p 与 git add -p 相反，即您可以使用它来选择性地取消暂存更改。请参阅 git-add[1] 的“交互模式”部分，了解如何使用 --patch 选项。

有关这三个命令之间的区别，请参阅 git[1] 中的“Reset、restore 和 revert”部分。

选项

-q
--quiet: 静默模式，只报告错误。
--refresh
--no-refresh: 混合重置后刷新索引。默认启用。
--pathspec-from-file=<file>: Pathspec 从 <file> 而不是命令行参数传递。如果 <file> 是 -，则使用标准输入。Pathspec 元素由 LF 或 CR/LF 分隔。Pathspec 元素可以按 core.quotePath 配置变量的解释进行引用（参见 git-config[1]）。另请参见 --pathspec-file-nul 和全局 --literal-pathspecs。
--pathspec-file-nul: 仅在与 --pathspec-from-file 一起使用时有意义。路径规范元素由 NUL 字符分隔，所有其他字符都被视为字面值（包括换行符和引号）。
-U<n>
--unified=<n>: 生成具有 <n> 行上下文的 diff。如果配置选项未设置，则默认为 diff.context 或 3。
--inter-hunk-context=<n>: 在差异块之间显示上下文，最多达指定行数 <number>，从而合并彼此接近的块。默认为 diff.interHunkContext，如果未设置配置选项则为 0。
--: 不再将任何后续参数解释为选项。
<pathspec>...: 限制受操作影响的路径。

有关更多详细信息，请参阅 gitglossary[7] 中的 pathspec 条目。

示例

撤销添加

$ edit                                     (1)
$ git add frotz.c filfre.c
$ mailx                                    (2)
$ git reset                                (3)
$ git pull git://info.example.com/ nitfol  (4)

您正在愉快地工作，发现这些文件中的更改状态良好。您不想在运行 git diff 时看到它们，因为您计划在其他文件上工作，而这些文件的更改会分散注意力。
有人要求您拉取，并且更改听起来值得合并。
但是，您已经弄脏了索引（即您的索引与 HEAD 提交不匹配）。但您知道您将要执行的拉取不会影响 frotz.c 或 filfre.c，因此您撤消了这两个文件的索引更改。您在工作树中的更改仍然保留在那里。
然后您可以拉取并合并，将 frotz.c 和 filfre.c 的更改仍然留在工作树中。

撤销提交并重做

$ git commit ...
$ git reset --soft HEAD^      (1)
$ edit                        (2)
$ git commit -a -c ORIG_HEAD  (3)

这通常发生在您想起刚刚提交的内容不完整，或者拼写错误提交消息，或者两者兼有的时候。工作树保持“reset”之前的状态。
对工作树文件进行更正。
"reset" 将旧头复制到 .git/ORIG_HEAD；通过其日志消息重新提交。如果您不需要进一步编辑消息，可以改用 -C 选项。

另请参阅 git-commit[1] 的 --amend 选项。

撤销提交，使其成为主题分支

$ git branch topic/wip          (1)
$ git reset --hard HEAD~3       (2)
$ git switch topic/wip          (3)

您已经进行了一些提交，但意识到它们过早地进入 master 分支。您希望在主题分支中继续完善它们，因此从当前的 HEAD 创建 topic/wip 分支。
将 master 分支回溯以摆脱那三次提交。
切换到 topic/wip 分支并继续工作。

永久撤销提交

$ git commit ...
$ git reset --hard HEAD~3   (1)

最后三次提交（HEAD、HEAD^ 和 HEAD~2）是错误的，您不想再看到它们。如果您已经将这些提交提供给其他人，请**不要**这样做。（请参阅 git-rebase[1] 中“从上游变基中恢复”一节，了解这样做的影响。）

撤销合并或拉取

$ git pull                         (1)
Auto-merging nitfol
CONFLICT (content): Merge conflict in nitfol
Automatic merge failed; fix conflicts and then commit the result.
$ git reset --hard                 (2)
$ git pull . topic/branch          (3)
Updating from 41223... to 13134...
Fast-forward
$ git reset --hard ORIG_HEAD       (4)

尝试从上游更新导致大量冲突；您现在没有准备好花大量时间进行合并，所以您决定稍后再做。
"pull" 没有创建合并提交，所以 git reset --hard（它是 git reset --hard HEAD 的同义词）清除了索引文件和工作树中的混乱。
将主题分支合并到当前分支，导致快进。
但您决定主题分支尚未准备好公开。 “pull”或“merge”总是将当前分支的原始尖端留在 ORIG_HEAD 中，因此硬重置到它会将您的索引文件和工作树恢复到该状态，并将分支的尖端重置到该提交。

在脏工作树中撤销合并或拉取

$ git pull                         (1)
Auto-merging nitfol
Merge made by recursive.
 nitfol                |   20 +++++----
 ...
$ git reset --merge ORIG_HEAD      (2)

即使您的工作树中可能有本地修改，当您知道其他分支中的更改不与它们重叠时，您也可以安全地说 git pull。
检查合并结果后，您可能会发现其他分支中的更改不令人满意。运行 git reset --hard ORIG_HEAD 将让您回到原来的位置，但它会丢弃您的本地更改，这是您不想要的。git reset --merge 保留您的本地更改。

中断的工作流

假设您在进行重大更改时被紧急修复请求打断。工作树中的文件尚未处于可提交状态，但您需要切换到其他分支进行快速错误修复。

$ git switch feature  ;# you were working in "feature" branch and
$ work work work      ;# got interrupted
$ git commit -a -m "snapshot WIP"                 (1)
$ git switch master
$ fix fix fix
$ git commit ;# commit with real log
$ git switch feature
$ git reset --soft HEAD^ ;# go back to WIP state  (2)
$ git reset                                       (3)

此提交将被丢弃，因此一次性日志消息是没问题的。
这将从提交历史中删除 WIP 提交，并将您的工作树设置为您创建该快照之前的状态。
此时，索引文件仍然包含您提交为 snapshot WIP 的所有 WIP 更改。这会更新索引以将您的 WIP 文件显示为未提交。

另请参阅 git-stash[1]。

重置索引中的单个文件

假设您已将文件添加到索引中，但后来决定不想将其添加到提交中。您可以使用 git reset 从索引中删除文件，同时保留您的更改。

$ git reset -- frotz.c                      (1)
$ git commit -m "Commit files in index"     (2)
$ git add frotz.c                           (3)

这将从索引中删除文件，同时将其保留在工作目录中。
这会提交索引中的所有其他更改。
再次将文件添加到索引。

在丢弃之前的一些提交时保留工作树中的更改

假设您正在处理一些事情并将其提交，然后您继续工作更多一点，但现在您认为工作树中的内容应该在另一个与您之前提交的内容无关的分支中。您可以创建一个新分支并重置它，同时保留工作树中的更改。

$ git tag start
$ git switch -c branch1
$ edit
$ git commit ...                            (1)
$ edit
$ git switch -c branch2                     (2)
$ git reset --keep start                    (3)

这将把您的第一次编辑提交到 branch1。
在理想世界中，当您创建并切换到 branch2 时（即 git switch -c branch2 start），您可能已经意识到较早的提交不属于新主题，但没有人是完美的。
但是您可以使用 reset --keep 在切换到 branch2 后删除不需要的提交。

将一个提交拆分成一系列提交

假设您创建了许多逻辑上独立的更改并将它们一起提交。然后，您后来决定最好将每个逻辑块与自己的提交相关联。您可以使用 git reset 在不更改本地文件内容的情况下回溯历史记录，然后连续使用 git add -p 交互式地选择要包含在每个提交中的块，使用 git commit -c 预填充提交消息。

$ git reset -N HEAD^                        (1)
$ git add -p                                (2)
$ git diff --cached                         (3)
$ git commit -c HEAD@{1}                    (4)
...                                         (5)
$ git add ...                               (6)
$ git diff --cached                         (7)
$ git commit ...                            (8)

首先，将历史记录回溯一个提交，以便我们删除原始提交，但保留所有更改的工作树。-N 确保使用 HEAD 添加的任何新文件仍然被标记，以便 git add -p 可以找到它们。
接下来，我们使用 git add -p 工具交互式地选择要添加的差异块。它会依次询问您每个差异块，您可以使用简单的命令，例如“是，包含此项”、“否，不包含此项”甚至非常强大的“编辑”功能。
一旦对要包含的块感到满意，您应该使用 git diff --cached 验证为第一次提交准备了什么。这将显示已移入索引并即将提交的所有更改。
接下来，提交存储在索引中的更改。-c 选项指定从您在第一次提交中开始的原始消息预填充提交消息。这有助于避免重新输入。 HEAD@{1} 是 HEAD 在原始重置提交之前（1 次更改之前）所处的提交的特殊表示法。有关更多详细信息，请参阅 git-reflog[1]。您也可以使用任何其他有效的提交引用。
您可以重复步骤 2-4 多次，将原始代码拆分为任意数量的提交。
现在您已经将许多更改拆分成单独的提交，并且可能不再使用 git add 的补丁模式来选择所有剩余的未提交更改。
再次检查以确认您已包含所需的内容。您可能还希望验证 git diff 没有显示任何剩余的待提交更改。
最后创建最终提交。

讨论

下表显示了运行以下命令时发生的情况

git reset --option target

根据文件的状态，使用不同的重置选项将 HEAD 重置到另一个提交（target）。

在这些表格中，A、B、C 和 D 是文件的不同状态。例如，第一个表格的第一行表示，如果文件在工作树中处于状态 A，在索引中处于状态 B，在 HEAD 中处于状态 C，在目标中处于状态 D，那么 git reset --soft target 将使工作树中的文件保持状态 A，索引中的文件保持状态 B。它将 HEAD（即当前分支的尖端，如果您在其上）重置（即移动）到 target（该文件处于状态 D）。

working index HEAD target         working index HEAD
----------------------------------------------------
 A       B     C    D     --soft   A       B     D
			  --mixed  A       D     D
			  --hard   D       D     D
			  --merge (disallowed)
			  --keep  (disallowed)

working index HEAD target         working index HEAD
----------------------------------------------------
 A       B     C    C     --soft   A       B     C
			  --mixed  A       C     C
			  --hard   C       C     C
			  --merge (disallowed)
			  --keep   A       C     C

working index HEAD target         working index HEAD
----------------------------------------------------
 B       B     C    D     --soft   B       B     D
			  --mixed  B       D     D
			  --hard   D       D     D
			  --merge  D       D     D
			  --keep  (disallowed)

working index HEAD target         working index HEAD
----------------------------------------------------
 B       B     C    C     --soft   B       B     C
			  --mixed  B       C     C
			  --hard   C       C     C
			  --merge  C       C     C
			  --keep   B       C     C

working index HEAD target         working index HEAD
----------------------------------------------------
 B       C     C    D     --soft   B       C     D
			  --mixed  B       D     D
			  --hard   D       D     D
			  --merge (disallowed)
			  --keep  (disallowed)

working index HEAD target         working index HEAD
----------------------------------------------------
 B       C     C    C     --soft   B       C     C
			  --mixed  B       C     C
			  --hard   C       C     C
			  --merge  B       C     C
			  --keep   B       C     C

git reset --merge 旨在用于从冲突合并中重置。任何合并操作都保证涉及合并的工作树文件在开始之前相对于索引没有本地更改，并且它将结果写入工作树。因此，如果我们看到索引和目标之间以及索引和工作树之间存在差异，则意味着我们不是从合并操作在冲突失败后留下的状态中重置。这就是为什么在这种情况下我们不允许使用 --merge 选项。

git reset --keep 旨在用于删除当前分支中的一些最新提交，同时保留工作树中的更改。如果我们要删除的提交中的更改与我们要保留的工作树中的更改之间可能存在冲突，则不允许重置。这就是为什么当工作树和 HEAD 之间以及 HEAD 和目标之间都存在更改时不允许重置的原因。为了安全起见，当存在未合并的条目时也不允许重置。

下表显示了存在未合并条目时的情况

working index HEAD target         working index HEAD
----------------------------------------------------
 X       U     A    B     --soft  (disallowed)
			  --mixed  X       B     B
			  --hard   B       B     B
			  --merge  B       B     B
			  --keep  (disallowed)

working index HEAD target         working index HEAD
----------------------------------------------------
 X       U     A    A     --soft  (disallowed)
			  --mixed  X       A     A
			  --hard   A       A     A
			  --merge  A       A     A
			  --keep  (disallowed)

X 表示任何状态，U 表示未合并索引。

Git[1] 套件的一部分

设置和配置

获取和创建项目

基本快照

分支与合并

共享和更新项目

检查和比较

打补丁

调试

电子邮件

外部系统

服务器管理

指南

管理

底层命令

名称

概要

描述

选项

示例

讨论

GIT

reset