Electron 中的补丁

Electron 构建于两个主要的上游项目之上：Chromium 和 Node.js。这两个项目各自也有许多依赖项。我们尽最大努力按原样使用这些依赖项，但有时我们无法在不修补这些上游依赖项以适应我们的用例的情况下实现我们的目标。

补丁理由

Electron 中的每个补丁都是维护负担。当上游代码发生变化时，补丁可能会失效——有时甚至没有补丁冲突或编译错误。保持我们的补丁集最新和有效是一项持续的工作。因此，我们努力将补丁数量保持在最低限度。为此，每个补丁都必须在提交消息中描述其存在的原因。该原因必须是以下之一

该补丁是临时的，旨在（或已）提交到上游或以其他方式最终删除。如果可用，请包含指向上游 PR 或代码审查的链接，或者包含一种用于验证补丁是否仍然在稍后日期需要的手续。
该补丁允许代码在 Electron 环境中编译，但由于它是 Electron 特有的（例如，修补 Chrome 的 Profile 引用），因此无法提交到上游。包含有关为什么不能在不使用补丁的情况下实现更改的理由（例如，通过子类化或复制代码）。
该补丁对功能进行 Electron 特定的更改，这些更改与上游从根本上不兼容。

通常，我们合作的所有上游项目都是友好的，并且通常乐于接受允许代码同时与 Electron 和上游项目兼容的重构。（例如，请参阅 Chromium 中的此更改，该更改允许我们删除执行相同操作的补丁，或 Node 中的此更改，该更改对 Node 来说是无操作，但修复了 Electron 中的错误。）我们应该尽可能地将更改提交到上游，并避免无限期的补丁。

补丁系统

如果您不幸需要进行只能通过修补上游项目才能进行的更改，则需要知道如何在 Electron 中管理补丁。

Electron 中对上游项目的所有补丁都包含在 patches/ 目录中。patches/ 的每个子目录包含几个补丁文件，以及一个 .patches 文件，其中列出了应按什么顺序应用补丁。可以将这些文件视为在检出上游项目后应用于上游项目之上的 git 提交系列。

patches
├── config.json   <-- this describes which patchset directory is applied to what project
├── chromium
│   ├── .patches
│   ├── accelerator.patch
│   ├── add_contentgpuclient_precreatemessageloop_callback.patch
│   ⋮
├── node
│   ├── .patches
│   ├── add_openssl_is_boringssl_guard_to_oaep_hash_check.patch
│   ├── build_add_gn_build_files.patch
│   ⋮
⋮

为了帮助管理这些补丁集，我们提供了两个工具：git-import-patches 和 git-export-patches。git-import-patches 通过按正确顺序应用每个补丁并为每个补丁创建一个提交，将一组补丁文件导入到 git 仓库中。git-export-patches 执行相反的操作；它将仓库中的一系列 git 提交导出到目录中的一组文件和一个配套的 .patches 文件。

顺便说一句，我们使用 .patches 文件来维护应用补丁的顺序，而不是像 001- 那样在每个文件名前面加上数字，因为这可以减少与补丁顺序相关的冲突。它可以防止两个 PR 都以相同的编号在系列末尾添加补丁，最终都合并导致重复标识符的情况，并且还可以减少在系列中间添加或删除补丁时的变动。

用法

添加新补丁

$ cd src/third_party/electron_node
$ vim some/code/file.cc
$ git commit
$ ../../electron/script/git-export-patches -o ../../electron/patches/node

注意

git-export-patches 会忽略任何未提交的文件，因此您必须创建一个提交才能导出您的更改。提交消息的主题行将用于派生补丁文件名，并且提交消息的正文应包含补丁存在的原因。

重新导出补丁有时会导致不相关补丁中的 shasum 发生变化。这通常是无害的并且可以忽略（但请随时将这些更改添加到您的 PR 中，它将阻止它们对其他人显示）。

编辑现有补丁

$ cd src/v8
$ vim some/code/file.cc
$ git log
# Find the commit sha of the patch you want to edit.
$ git commit --fixup [COMMIT_SHA]
$ git rebase --autosquash -i [COMMIT_SHA]^
$ ../electron/script/git-export-patches -o ../electron/patches/v8

请注意，^ 符号可能会在 Windows 上引起问题。解决方法是将其用引号引起来 "[COMMIT_SHA]^" 或避免使用它 [COMMIT_SHA]~1。

删除补丁

$ vim src/electron/patches/node/.patches
# Delete the line with the name of the patch you want to remove
$ cd src/third_party/electron_node
$ git reset --hard refs/patches/upstream-head
$ ../../electron/script/git-import-patches ../../electron/patches/node
$ ../../electron/script/git-export-patches -o ../../electron/patches/node

请注意，git-import-patches 会将运行该命令时 HEAD 的提交标记为 refs/patches/upstream-head。这使您可以跟踪哪些提交来自 Electron 补丁（在 refs/patches/upstream-head 之后的那些），哪些提交在上游（在 refs/patches/upstream-head 之前的那些）。

解决冲突

在更新上游依赖项时，补丁可能无法干净地应用。通常，可以使用三向合并自动解决冲突。您可以通过传递 -3 参数来指示 git-import-patches 使用三向合并算法

$ cd src/third_party/electron_node
# If the patch application failed midway through, you can reset it with:
$ git am --abort
# And then retry with 3-way merge:
$ ../../electron/script/git-import-patches -3 ../../electron/patches/node

如果 git-import-patches -3 遇到无法自动解决的合并冲突，它将暂停并允许您手动解决冲突。解决冲突后，git add 解决的文件并继续应用其余补丁，方法是运行 git am --continue。

补丁理由​

补丁系统​

用法​

添加新补丁​

编辑现有补丁​

删除补丁​

解决冲突​