diff mbox series

docs: add note about experimental API in LTS

Message ID 20231020141930.426503-1-ktraynor@redhat.com (mailing list archive)
State Accepted, archived
Delegated to: David Marchand
Headers
Series docs: add note about experimental API in LTS |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-compile-amd64-testing success Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/intel-Functional success Functional PASS
ci/github-robot: build success github build: passed
ci/iol-unit-amd64-testing success Testing PASS
ci/iol-unit-arm64-testing success Testing PASS
ci/iol-compile-arm64-testing success Testing PASS
ci/iol-intel-Functional success Functional Testing PASS

Commit Message

Kevin Traynor Oct. 20, 2023, 2:19 p.m. UTC 
The justification and impact for changing experimental API on LTS
branches is different from the main branch. So the policy that is
being used for allowing experimental APIs to change is stricter on
the LTS branches.

This was not documented anywhere, so add some documentation.

Suggested-by: David Marchand <david.marchand@redhat.com>
Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
---
 doc/guides/contributing/stable.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

Comments

Bruce Richardson Oct. 20, 2023, 3:01 p.m. UTC | #1 
On Fri, Oct 20, 2023 at 03:19:30PM +0100, Kevin Traynor wrote:
> The justification and impact for changing experimental API on LTS
> branches is different from the main branch. So the policy that is
> being used for allowing experimental APIs to change is stricter on
> the LTS branches.
> 
> This was not documented anywhere, so add some documentation.
> 
> Suggested-by: David Marchand <david.marchand@redhat.com>
> Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
> ---
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Ferruh Yigit Oct. 20, 2023, 3:14 p.m. UTC | #2 
On 10/20/2023 4:01 PM, Bruce Richardson wrote:
> On Fri, Oct 20, 2023 at 03:19:30PM +0100, Kevin Traynor wrote:
>> The justification and impact for changing experimental API on LTS
>> branches is different from the main branch. So the policy that is
>> being used for allowing experimental APIs to change is stricter on
>> the LTS branches.
>>
>> This was not documented anywhere, so add some documentation.
>>
>> Suggested-by: David Marchand <david.marchand@redhat.com>
>> Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
>> ---
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
>

Acked-by: Ferruh Yigit <ferruh.yigit@amd.com>
David Marchand Nov. 24, 2023, 1:52 p.m. UTC | #3 
On Fri, Oct 20, 2023 at 4:19 PM Kevin Traynor <ktraynor@redhat.com> wrote:
>
> The justification and impact for changing experimental API on LTS
> branches is different from the main branch. So the policy that is
> being used for allowing experimental APIs to change is stricter on
> the LTS branches.
>
> This was not documented anywhere, so add some documentation.
>
> Suggested-by: David Marchand <david.marchand@redhat.com>
> Signed-off-by: Kevin Traynor <ktraynor@redhat.com>

Thanks Kevin, applied.
diff mbox series

Patch

diff --git a/doc/guides/contributing/stable.rst b/doc/guides/contributing/stable.rst
index 9ee7b4b7cc..8156b72b20 100644
--- a/doc/guides/contributing/stable.rst
+++ b/doc/guides/contributing/stable.rst
@@ -127,4 +127,12 @@  but may be considered in some cases where:
 * An existing feature in LTS is not usable as intended without it.
 
+APIs marked as ``experimental`` are not considered part of the ABI version
+and can be changed without prior notice. This is necessary for the API to be
+improved and stabilized and become part of the ABI version in the future.
+
+However, in LTS releases ``experimental`` API should not be changed as there
+will not be a future ABI version on the branch and compatibility with previous
+release of an LTS version is of the highest importance.
+
 The Stable Mailing List
 -----------------------