diff options
| author | Sandrine Bailleux <sandrine.bailleux@arm.com> | 2023-04-26 13:39:28 +0200 |
|---|---|---|
| committer | TrustedFirmware Code Review <review@review.trustedfirmware.org> | 2023-04-26 13:39:28 +0200 |
| commit | 00cdd81ea7723b739dd74433edface1ff2744b54 (patch) | |
| tree | c9b14b03ed7a43df2b0f204eef1f2687b5c3d3a8 /docs | |
| parent | 89bc91a1ad68af547d77dfa008eb4f10b1639167 (diff) | |
| parent | 47c8dcfde7e137ec9d2aa595ad87bd1e458c2dfb (diff) | |
| download | arm-trusted-firmware-00cdd81ea7723b739dd74433edface1ff2744b54.tar.gz | |
Merge changes from topics "sb/deprecate-cryptocell", "sb/deprecation-policy" into integration
* changes:
docs: deprecate CryptoCell-712/713 drivers
docs: split deprecated interfaces and drivers
docs: extend deprecation policy
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/about/release-information.rst | 19 | ||||
| -rw-r--r-- | docs/process/platform-ports-policy.rst | 21 |
2 files changed, 28 insertions, 12 deletions
diff --git a/docs/about/release-information.rst b/docs/about/release-information.rst index f99b7ffba..cd52460b9 100644 --- a/docs/about/release-information.rst +++ b/docs/about/release-information.rst @@ -69,9 +69,26 @@ 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 | +--------------------------------+-------------+---------+---------------------------------------------------------+ +| CryptoCell-712 | 2.9 | 3.0 | No longer maintained. | ++--------------------------------+-------------+---------+---------------------------------------------------------+ +| CryptoCell-713 | 2.9 | 3.0 | No longer maintained. | ++--------------------------------+-------------+---------+---------------------------------------------------------+ -------------- -*Copyright (c) 2018-2022, Arm Limited and Contributors. All rights reserved.* +*Copyright (c) 2018-2023, Arm Limited and Contributors. All rights reserved.* 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. |