From 47801a698541a76c877f8beb654015168b10bd6c Mon Sep 17 00:00:00 2001 From: Sandrine Bailleux Date: Mon, 17 Apr 2023 15:45:46 +0200 Subject: docs: extend deprecation policy 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 Change-Id: Ieb235d6a1fb089343e0e1e3e5f36067552f2f8f0 --- docs/process/platform-ports-policy.rst | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) (limited to 'docs') diff --git a/docs/process/platform-ports-policy.rst b/docs/process/platform-ports-policy.rst index b296a5f6a..02eb6bde3 100644 --- a/docs/process/platform-ports-policy.rst +++ b/docs/process/platform-ports-policy.rst @@ -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 the deprecated interface. -Platform deprecation policy ---------------------------- +Deprecation policy +------------------ -If a platform is no longer maintained, it is best to deprecate it to keep the -projects' source tree clean and healthy. Deprecation can be a 1-stage or 2-stage -process (up to the platform maintainers). +If a platform, driver or library interface is no longer maintained, it is best +to deprecate it to keep the projects' source tree clean and healthy. Deprecation +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 - cooling off period before deleting it (typically 2 release cycles). In this - case, we keep track ot the *Deprecated* version separately from the *Deleted* - version. + - *2-stage*: The source code can be kept in the repository for a cooling off + period before deleting it (typically 2 release cycles). In this case, we keep + track of the *Deprecated* version separately from the *Deleted* version. - - *1-stage*: The platform's source code can be deleted straight away. In this - case, both versions are the same. + - *1-stage*: The source code can be deleted straight away. In this case, both + versions are the same. The :ref:`Platform Ports` page provides a list of all deprecated/deleted platform ports (or soon to be) to this day. -- cgit v1.2.1 From 1dc77d43efd93c1ba73913efe0d71ffe61c5f5ac Mon Sep 17 00:00:00 2001 From: Sandrine Bailleux Date: Mon, 17 Apr 2023 16:01:50 +0200 Subject: docs: split deprecated interfaces and drivers Having a dedicated section for deprecated interfaces, and another one for deprecated drivers, sounds cleaner. Signed-off-by: Sandrine Bailleux Change-Id: Iaf65e9f4dabff89b9e86c17062656edd8c344016 --- docs/about/release-information.rst | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/about/release-information.rst b/docs/about/release-information.rst index f99b7ffba..8a87e8412 100644 --- a/docs/about/release-information.rst +++ b/docs/about/release-information.rst @@ -69,9 +69,22 @@ after which it will be removed. +================================+=============+=========+=========================================================+ | plat_convert_pk() function | Nov'22 | 2.9 | Platform conversion to manage specific PK hash | +--------------------------------+-------------+---------+---------------------------------------------------------+ + +Removal of Deprecated Drivers +----------------------------- + +As mentioned in the :ref:`Platform Ports Policy`, this is a live document +cataloging all the deprecated drivers in TF-A project and the Release version +after which it will be removed. + ++--------------------------------+-------------+---------+---------------------------------------------------------+ +| Driver | Deprecation | Removed | Comments | +| | Date | after | | +| | | Release | | ++================================+=============+=========+=========================================================+ | io_dummy driver | Nov'22 | 2.9 | No more used by any upstream platform | +--------------------------------+-------------+---------+---------------------------------------------------------+ -------------- -*Copyright (c) 2018-2022, Arm Limited and Contributors. All rights reserved.* +*Copyright (c) 2018-2023, Arm Limited and Contributors. All rights reserved.* -- cgit v1.2.1 From 47c8dcfde7e137ec9d2aa595ad87bd1e458c2dfb Mon Sep 17 00:00:00 2001 From: Sandrine Bailleux Date: Mon, 17 Apr 2023 14:09:41 +0200 Subject: docs: deprecate CryptoCell-712/713 drivers We plan to deprecate the CryptoCell-712 and CryptoCell-713 drivers in TF-A release v2.9 and eventually remove the code from the tree in release 3.0. The only upstream platforms which use these drivers today are the Arm Ltd developpment platforms, such as Juno. Write this information down into the "Release Processes" document. Signed-off-by: Sandrine Bailleux Change-Id: Ib064292733a271ecbff0dde315911017e2c4da7e --- docs/about/release-information.rst | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs') diff --git a/docs/about/release-information.rst b/docs/about/release-information.rst index 8a87e8412..cd52460b9 100644 --- a/docs/about/release-information.rst +++ b/docs/about/release-information.rst @@ -84,6 +84,10 @@ after which it will be removed. +================================+=============+=========+=========================================================+ | io_dummy driver | Nov'22 | 2.9 | No more used by any upstream platform | +--------------------------------+-------------+---------+---------------------------------------------------------+ +| CryptoCell-712 | 2.9 | 3.0 | No longer maintained. | ++--------------------------------+-------------+---------+---------------------------------------------------------+ +| CryptoCell-713 | 2.9 | 3.0 | No longer maintained. | ++--------------------------------+-------------+---------+---------------------------------------------------------+ -------------- -- cgit v1.2.1