[2/3] Documentation: contributing: Add ABI/API trailer guide
diff mbox series

Message ID 20260903-kbingham-abi-trailers-v1-2-72ae051c912a@ideasonboard.com
State New
Headers show
Series
  • ABI: Document and support ABI and API Trailers
Related show

Commit Message

Kieran Bingham Sept. 3, 2026, 2:51 p.m. UTC 
Document the requirement to specify when commits knowingly change either
the ABI or public API of libcamera.

Future enhancements to the CI infrastructure can use these tags to
accept changes which knowingly break the ABI/API and prevent unknown ABI
or API breakages to be merged.

Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
---
 Documentation/contributing.rst | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

Patch
diff mbox series 

diff --git a/Documentation/contributing.rst b/Documentation/contributing.rst
index 20682d56c75d..2588da4e224d 100644
--- a/Documentation/contributing.rst
+++ b/Documentation/contributing.rst
@@ -71,6 +71,27 @@  Freedesktop also provides our CI and `testing pipeline`_.
 
 .. _testing pipeline: https://gitlab.freedesktop.org/camera/libcamera/-/pipelines
 
+ABI and API Stability
+---------------------
+
+We provide a script `./utils/abi-compat.sh` which can be run to detect and
+report any ABI or API breakage in the public interfaces.
+
+Contributions which knowingly break the ABI or API should specify this in the
+commit message with one of the following trailer examples.
+
+The CI testing suite may choose to reject contributions which cause an ABI or
+API breakage but do not specify the effect in the commit log.
+
+::
+
+  ABI: struct IPAModuleInfo:
+       Field pipelineName has been removed from the middle position of this
+       structural type.
+
+  API: struct IPAModuleInfo:
+       Field pipelineName has been removed from this type.
+
 Issue Tracker
 -------------