blob: b81d42d59ca717e8cfa8711eae5d3f5c79f5b918 [file] [log] [blame]
Paul Beesleyfc9ee362019-03-07 15:47:15 +00001Release Processes
2=================
Joel Hutton9e605632019-02-25 15:18:56 +00003
Joel Hutton9e605632019-02-25 15:18:56 +00004Project Release Cadence
5-----------------------
6
7The project currently aims to do a release once every 6 months which will be
8tagged on the master branch. There will be a code freeze (stop merging
9non-essential PRs) up to 4 weeks prior to the target release date. The release
10candidates will start appearing after this and only bug fixes or updates
11required for the release will be merged. The maintainers are free to use their
12judgement on what PRs are essential for the release. A release branch may be
13created after code freeze if there are significant PRs that need merging onto
14the integration branch during the merge window.
15
16The release testing will be performed on release candidates and depending on
17issues found, additional release candidates may be created to fix the issues.
18
19::
20
21 |<----------6 months---------->|
22 |<---4 weeks--->| |<---4 weeks--->|
23 +-----------------------------------------------------------> time
24 | | | |
25 code freeze ver w.x code freeze ver y.z
26
27
28Upcoming Releases
29~~~~~~~~~~~~~~~~~
30
31These are the estimated dates for the upcoming release. These may change
32depending on project requirement and partner feedback.
33
34+-----------------+---------------------------+------------------------------+
35| Release Version | Target Date | Expected Code Freeze |
36+=================+===========================+==============================+
37| v2.0 | 1st week of Oct '18 | 1st week of Sep '18 |
38+-----------------+---------------------------+------------------------------+
39| v2.1 | 5th week of Mar '19 | 1st week of Mar '19 |
40+-----------------+---------------------------+------------------------------+
41
42Removal of Deprecated Interfaces
43--------------------------------
44
45As mentioned in the `Platform compatibility policy`_, this is a live document
46cataloging all the deprecated interfaces in TF-A project and the Release version
47after which it will be removed.
48
49+--------------------------------+-------------+---------+---------------------------------------------------------+
50| Interface | Deprecation | Removed | Comments |
51| | Date | after | |
52| | | Release | |
53+================================+=============+=========+=========================================================+
54| Legacy Console API | Jan '18 | v2.1 | Deprecated in favour of ``MULTI_CONSOLE_API`` |
55+--------------------------------+-------------+---------+---------------------------------------------------------+
56| Weak default | Oct '18 | v2.1 | The default implementations are defined in |
57| ``plat_crash_console_*`` | | | `crash_console_helpers.S`_. The platforms have to |
58| APIs | | | define ``plat_crash_console_*``. |
59+--------------------------------+-------------+---------+---------------------------------------------------------+
60| ``finish_console_register`` | Oct '18 | v2.1 | The old version of the macro is deprecated. See commit |
61| macro in | | | cc5859c_ for more details. |
62| ``MULTI_CONSOLE_API`` | | | |
63+--------------------------------+-------------+---------+---------------------------------------------------------+
64| Types ``tzc_action_t`` and | Oct '18 | v2.1 | Using logical operations such as OR in enumerations |
65| ``tzc_region_attributes_t`` | | | goes against the MISRA guidelines. |
66+--------------------------------+-------------+---------+---------------------------------------------------------+
67| Macro ``EL_IMPLEMENTED()`` | Oct '18 | v2.1 | Deprecated in favour of ``el_implemented()``. |
68+--------------------------------+-------------+---------+---------------------------------------------------------+
69| ``get_afflvl_shift()``, | Dec '18 | v2.1 | Removed. |
70| ``mpidr_mask_lower_afflvls()``,| | | |
71| and ``eret()``. | | | |
72+--------------------------------+-------------+---------+---------------------------------------------------------+
73| Extra include paths in the | Jan '18 | v2.1 | Now it is needed to use the full path of the common |
74| Makefile in ``INCLUDES``. | | | header files. More information in commit 09d40e0e0828_. |
75+--------------------------------+-------------+---------+---------------------------------------------------------+
76
Joel Hutton0f79fb12019-02-26 16:23:54 +000077*Copyright (c) 2018-2019, Arm Limited and Contributors. All rights reserved.*
Joel Hutton9e605632019-02-25 15:18:56 +000078
Joel Hutton0f79fb12019-02-26 16:23:54 +000079.. _Platform compatibility policy: platform-compatibility-policy.rst
80.. _crash_console_helpers.S: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git/tree/plat/common/aarch64/crash_console_helpers.S
81.. _cc5859c: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git/commit/?id=cc5859ca19ff546c35eb0331000dae090b6eabcf
82.. _09d40e0e0828: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git/commit/?id=09d40e0e08283a249e7dce0e106c07c5141f9b7e