tor-browser

commit 8b1daa842f3ac55b929006ac900af131596d4748
parent 43f934a98c54a5de1fc9f707b8ffbf6d4e9250c0
Author: Michael Froman <mfroman@mozilla.com>
Date:   Mon, 24 Nov 2025 02:43:47 +0000

Bug 2001165 - clarify the documentation for writing the patches. r=dbaker DONTBUILD

Differential Revision: https://phabricator.services.mozilla.com/D273639

Diffstat:
M
dom/media/webrtc/third_party_build/save_patch_stack.py
 | 
15
++++++++++-----

1 file changed, 10 insertions(+), 5 deletions(-)
diff --git a/dom/media/webrtc/third_party_build/save_patch_stack.py b/dom/media/webrtc/third_party_build/save_patch_stack.py
@@ -84,7 +84,7 @@ def save_patch_stack(
     base_commit_sha = found_lines[0].split(" ")[0]
     print(f"Found base_commit_sha: {base_commit_sha}")
 
-    # First, a word about pre-stack and normal patches.  During the
+    # First, a word about pre-stack and standard patches.  During the
     # libwebrtc update process, there are 2 cases where we insert
     # patches between the upstream trunk commit we're current based on
     # and the Mozilla patch-stack:
@@ -106,17 +106,22 @@ def save_patch_stack(
     #    technique allows us to fix any potential rebase conflicts when
     #    the commit is eventually relanded the final time.
     #
-    # Pre-stack commits are everything that we insert between upstream and
-    # the Mozilla patch-stack from the two categories above.
+    # Pre-stack commits (written with a 'p' prefix) are everything that
+    # we insert between upstream and the Mozilla patch-stack from the
+    # two categories above.
     #
-    # Normal commits are the Mozilla patch-stack commits.
+    # Standard commits (written with a 's' prefix) are the Mozilla
+    # patch-stack commits.
+    #
+    # Note: the prefixes are also conveniently alphabetical so that
+    # restoring them can be done with a simple 'git am *.patch' command.
 
     # write only the pre-stack patches out
     write_patch_files_with_prefix(
         github_path, patch_directory, f"{merge_base}", f"{base_commit_sha}^", "p"
     )
 
-    # write only the "normal" stack patches out
+    # write only the standard stack patches out
     write_patch_files_with_prefix(
         github_path, patch_directory, f"{base_commit_sha}^", f"{github_branch}", "s"
     )