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

docs: extend deprecation policy

Browse source 
Our process documentation already mentions that if a platform is no
longer maintained, it is best to deprecate it to keep the project's
source tree clean and healthy.

The same argument stands for drivers or library interfaces so extend
this policy to those.

Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>
Change-Id: Ieb235d6a1fb089343e0e1e3e5f36067552f2f8f0
This commit is contained in:
Sandrine Bailleux 2023-04-17 15:45:46 +02:00
parent 8f55cde216
commit 47801a6985
1 changed files with 10 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -32,20 +32,19 @@ public mailing list`_ to notify platforms that they should migrate away from the
deprecated interfaces. Platforms are expected to migrate before the removal of deprecated interfaces. Platforms are expected to migrate before the removal of
the deprecated interface. the deprecated interface.
Platform deprecation policy Deprecation policy
--------------------------- ------------------
If a platform is no longer maintained, it is best to deprecate it to keep the If a platform, driver or library interface is no longer maintained, it is best
projects' source tree clean and healthy. Deprecation can be a 1-stage or 2-stage to deprecate it to keep the projects' source tree clean and healthy. Deprecation
process (up to the platform maintainers). can be a 1-stage or 2-stage process (up to the maintainers).
- *2-stage*: The platform's source code can be kept in the repository for a - *2-stage*: The source code can be kept in the repository for a cooling off
cooling off period before deleting it (typically 2 release cycles). In this period before deleting it (typically 2 release cycles). In this case, we keep
case, we keep track ot the *Deprecated* version separately from the *Deleted* track of the *Deprecated* version separately from the *Deleted* version.
version.
- *1-stage*: The platform's source code can be deleted straight away. In this - *1-stage*: The source code can be deleted straight away. In this case, both
case, both versions are the same. versions are the same.
The :ref:`Platform Ports` page provides a list of all deprecated/deleted The :ref:`Platform Ports` page provides a list of all deprecated/deleted
platform ports (or soon to be) to this day. platform ports (or soon to be) to this day.