[llvm] Update the backporting docs (PR #100401)
Aaron Ballman via llvm-commits
llvm-commits at lists.llvm.org
Wed Jul 24 08:16:58 PDT 2024
https://github.com/AaronBallman created https://github.com/llvm/llvm-project/pull/100401
The documentation implies the special commands only work with issues, but they also work directly from a pull request.
>From 593f763565207fea62ec26b01e8a2728bda818ec Mon Sep 17 00:00:00 2001
From: Aaron Ballman <aaron at aaronballman.com>
Date: Wed, 24 Jul 2024 11:15:27 -0400
Subject: [PATCH] Update the backporting docs
The documentation implies the special commands only work with issues,
but they also work directly from a pull request.
---
llvm/docs/GitHub.rst | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/llvm/docs/GitHub.rst b/llvm/docs/GitHub.rst
index 4010958c5d313..f1b1135d8de6f 100644
--- a/llvm/docs/GitHub.rst
+++ b/llvm/docs/GitHub.rst
@@ -376,10 +376,10 @@ Releases
Backporting Fixes to the Release Branches
-----------------------------------------
-You can use special comments on issues to make backport requests for the
-release branches. This is done by making a comment containing the following
-command on any issue that has been added to one of the "X.Y.Z Release"
-milestones.
+You can use special comments on issues or pull requestes to make backport
+requests for the release branches. This is done by making a comment containing
+the following command on any issue or pull request that has been added to one
+of the "X.Y.Z Release" milestones.
::
@@ -388,8 +388,8 @@ milestones.
This command takes one or more git commit hashes as arguments and will attempt
to cherry-pick the commit(s) to the release branch. If the commit(s) fail to
apply cleanly, then a comment with a link to the failing job will be added to
-the issue. If the commit(s) do apply cleanly, then a pull request will
-be created with the specified commits.
+the issue/pull request. If the commit(s) do apply cleanly, then a pull request
+will be created with the specified commits.
If a commit you want to backport does not apply cleanly, you may resolve
the conflicts locally and then create a pull request against the release
More information about the llvm-commits
mailing list