[llvm] [llvm][Docs] Clarify release ABI/API compatibility rules (PR #123049)

[David Spickett via llvm-commits]

https://github.com/DavidSpickett updated https://github.com/llvm/llvm-project/pull/123049

>From 1f4dd5390e765b01165c29e1f3218ea185654ad1 Mon Sep 17 00:00:00 2001
From: David Spickett <david.spickett at linaro.org>
Date: Wed, 15 Jan 2025 12:27:51 +0000
Subject: [PATCH 1/2] [llvm][Docs] Clarify release ABI/API compatibility rules

If the current release branch is version X, the phrase "the previous major release."
sounds to me as if it is referring to releases of X-1. Not to
the last release from the current release branch, which is what
I think it intends.

(if it meant X-1, then we could never change the ABI)
---
 llvm/docs/HowToReleaseLLVM.rst | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/llvm/docs/HowToReleaseLLVM.rst b/llvm/docs/HowToReleaseLLVM.rst
index 4274717dbdfa08..f1df90567bab28 100644
--- a/llvm/docs/HowToReleaseLLVM.rst
+++ b/llvm/docs/HowToReleaseLLVM.rst
@@ -349,8 +349,7 @@ Below are the rules regarding patching the release branch:
 
 #. *Bug fix releases* Patches should be limited to bug fixes or very safe
    and critical performance improvements.  Patches must maintain both API and
-   ABI compatibility with the previous major release.
-
+   ABI compatibility with the previous release from the release branch.
 
 Release Final Tasks
 -------------------

>From 7b043d65ebe28c5425e2a81dacf1c9de94a1a996 Mon Sep 17 00:00:00 2001
From: David Spickett <david.spickett at linaro.org>
Date: Wed, 15 Jan 2025 15:52:32 +0000
Subject: [PATCH 2/2] change wording

---
 llvm/docs/HowToReleaseLLVM.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/llvm/docs/HowToReleaseLLVM.rst b/llvm/docs/HowToReleaseLLVM.rst
index f1df90567bab28..ca55ee573c0024 100644
--- a/llvm/docs/HowToReleaseLLVM.rst
+++ b/llvm/docs/HowToReleaseLLVM.rst
@@ -349,7 +349,7 @@ Below are the rules regarding patching the release branch:
 
 #. *Bug fix releases* Patches should be limited to bug fixes or very safe
    and critical performance improvements.  Patches must maintain both API and
-   ABI compatibility with the previous release from the release branch.
+   ABI compatibility with the X.1.0 release.
 
 Release Final Tasks
 -------------------