Djam/arm-trusted-firmware
1
0
Fork 0
mirror of https://github.com/ARM-software/arm-trusted-firmware.git synced 2025-04-30 07:39:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: add a note about downstream platforms

Browse source 
Clarify that downstream platforms generally do not affect code
deprecation / removal decisions.

Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>
Change-Id: I44b979c4e67ee03537852769e96544e19137bda3
This commit is contained in:
Sandrine Bailleux 2023-04-17 15:37:48 +02:00
parent edee0430d4
commit 8f55cde216
1 changed files with 13 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/process/platform-ports-policy.rst
View file

@ -10,12 +10,18 @@ Platform compatibility policy
Platform compatibility is mainly affected by changes to Platform APIs (as Platform compatibility is mainly affected by changes to Platform APIs (as
documented in the :ref:`Porting Guide`), driver APIs (like the GICv3 drivers) or documented in the :ref:`Porting Guide`), driver APIs (like the GICv3 drivers) or
library interfaces (like xlat_table library). The project will try to maintain library interfaces (like xlat_table library). The project will try to maintain
compatibility for upstream platforms. Due to evolving requirements and compatibility for upstream platforms.
enhancements, there might be changes affecting platform compatibility which
means the previous interface needs to be deprecated and a new interface Due to evolving requirements and enhancements, there might be changes affecting
introduced to replace it. In case the migration to the new interface is trivial, platform compatibility, which means the previous interface needs to be deprecated
the contributor of the change is expected to make good effort to migrate the and a new interface introduced to replace it. In case the migration to the new
upstream platforms to the new interface. interface is trivial, the contributor of the change is expected to make good
effort to migrate the upstream platforms to the new interface.
The project will generally not take into account downstream platforms. If those
are affected by a deprecation / removal decision, we encourage their maintainers
to upstream their platform code or copy the latest version of the code being
deprecated into their downstream tree.
The deprecated interfaces are listed inside :ref:`Release Processes` as well as The deprecated interfaces are listed inside :ref:`Release Processes` as well as
the release after which each one will be removed. When an interface is the release after which each one will be removed. When an interface is
@ -46,6 +52,6 @@ platform ports (or soon to be) to this day.
-------------- --------------
*Copyright (c) 2018-2022, Arm Limited and Contributors. All rights reserved.* *Copyright (c) 2018-2023, Arm Limited and Contributors. All rights reserved.*
.. _TF-A public mailing list: https://lists.trustedfirmware.org/mailman3/lists/tf-a.lists.trustedfirmware.org/ .. _TF-A public mailing list: https://lists.trustedfirmware.org/mailman3/lists/tf-a.lists.trustedfirmware.org/