[0/3] ABI: Document and support ABI and API Trailers
mbox series

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

Message

Kieran Bingham Sept. 3, 2026, 2:51 p.m. UTC 
Extend the documentation to report on two new trailers...
  ABI:
  API:

These trailers are accepted in the commit message in the trailer
section, but they are not validated and support free text. This allows
the contributor to specify the text appropriate to describe the breakage
rather than restrict to something which would become less meaningful.

The checkstyle tool is extended to support this, and a final patch which
is not for merge offers a potential example of it's usage by taking text
reported by the abi-compliance-checker tool.

Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
---
Kieran Bingham (3):
      utils: checkstyle: Allow free form ABI/API trailers
      Documentation: contributing: Add ABI/API trailer guide
      DNI: TESTONLY: libcamera: camera: Add an ABI break in SensorConfig

 Documentation/contributing.rst | 21 +++++++++++++++++++++
 include/libcamera/camera.h     |  2 ++
 utils/checkstyle.py            |  9 +++++++--
 3 files changed, 30 insertions(+), 2 deletions(-)
---
base-commit: 63f9b4e5d9a9ba2ee2ebe1bfcdc0af453863c988
change-id: 20260903-kbingham-abi-trailers-e251b0a26388

Best regards,