summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBipin Ravi <bipin.ravi@arm.com>2026-06-18 14:58:41 +0000
committerTrustedFirmware Code Review <review@review.trustedfirmware.org>2026-06-18 14:58:41 +0000
commit740bf1d4e6cb2d5e0efccafecfbc6f7bc12f78fe (patch)
tree2043b7f7d0f9ad84adab92707555338c7355f754 /docs
parentdfba315f13026877db362175e45f365978b8f110 (diff)
parent8755a0cce5e79667021cfe587cc068958dd0934f (diff)
downloadarm-trusted-firmware-740bf1d4e6cb2d5e0efccafecfbc6f7bc12f78fe.tar.gz
arm-trusted-firmware-740bf1d4e6cb2d5e0efccafecfbc6f7bc12f78fe.zip
Merge "docs: document lts candidate trailer" into integration
Diffstat (limited to 'docs')
-rw-r--r--docs/process/commit-style.rst17
-rw-r--r--docs/process/contributing.rst27
2 files changed, 42 insertions, 2 deletions
diff --git a/docs/process/commit-style.rst b/docs/process/commit-style.rst
index 97b4b44c0..e6524331a 100644
--- a/docs/process/commit-style.rst
+++ b/docs/process/commit-style.rst
@@ -145,9 +145,24 @@ then this should be done automatically for you.
More details may be found in the `Gerrit Change-Ids documentation`_.
+Optional Automation Trailers
+----------------------------
+
+Projects and workflows built around |TF-A| may use additional machine-readable
+trailers to simplify triage and backporting. For LTS triage, developers may
+add ``LTS-candidate: yes`` in the footer block at the end of the commit
+message to indicate to the LTS maintainers that the patch should be evaluated
+as a candidate for a future LTS release. LTS maintainers retain the final say
+in triage and merge decisions for the LTS branches.
+
+These trailers are optional and should be added in the footer block of the
+commit message. They do not change the standard TF-A commit subject format,
+which should remain a normal Conventional Commits subject such as
+``fix(psci): ...``.
+
--------------
-*Copyright (c) 2021-2025, Arm Limited and Contributors. All rights reserved.*
+*Copyright (c) 2021-2026, Arm Limited and Contributors. All rights reserved.*
.. _Conventional Commits: https://www.conventionalcommits.org/en/v1.0.0
.. _Gerrit Change-Ids documentation: https://review.trustedfirmware.org/Documentation/user-changeid.html
diff --git a/docs/process/contributing.rst b/docs/process/contributing.rst
index 5413a4d44..5ab7b4b40 100644
--- a/docs/process/contributing.rst
+++ b/docs/process/contributing.rst
@@ -50,6 +50,31 @@ Making Changes
Makefile target is provided for convenience, see :ref:`this
section<automatic-compliance-checking>` for more details.
+- If a patch should be considered for LTS backporting, keep the normal
+ |TF-A| commit subject format and add an ``LTS-candidate: yes`` trailer in
+ the footer block at the end of the commit message, alongside the other
+ commit trailers. This tag acts as an indication to the LTS maintainers that
+ the patch should be evaluated as a candidate for the next LTS release. It
+ also helps the LTS weekly triage tooling to automatically pull the patch in
+ so it can be reviewed among the maintainers. For example:
+
+ .. code::
+
+ fix(psci): get the cpu_ops before exiting coherency
+
+ Dereference the cpu_ops pointer before disabling coherency so the
+ warm path does not observe stale data from cache.
+
+ Signed-off-by: Developer Name <developer@example.com>
+ Change-Id: I0123456789abcdef0123456789abcdef01234567
+ LTS-candidate: yes
+
+ Reviewers and maintainers should use this trailer as the preferred
+ machine-readable signal for LTS triage automation, but LTS maintainers
+ retain the final say on whether a patch is taken into an LTS branch. They
+ should also look for LTS-eligible patches that were posted without it and
+ ask authors to add it in follow-up revisions where practical.
+
- Where appropriate, please update the documentation.
- Consider whether the :ref:`Porting Guide`, :ref:`Firmware Design` document
@@ -332,7 +357,7 @@ Binary Components
--------------
-*Copyright (c) 2013-2025, Arm Limited and Contributors. All rights reserved.*
+*Copyright (c) 2013-2026, Arm Limited and Contributors. All rights reserved.*
.. _review.trustedfirmware.org: https://review.trustedfirmware.org
.. _Git guidelines: https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project