Add clarification on 2.x branch choice

Signed-off-by: Werner Lewis <werner.lewis@arm.com>
This commit is contained in:
Werner Lewis 2022-06-27 09:30:11 +01:00
parent f5b86f3b16
commit 4b8aaa4e60

View File

@ -25,7 +25,8 @@ explain how to upgrade, and should be referred to when migrating code. Where a
migration path is not provided in prior documentation, changes made and the
upgrade steps required will be explained in this guide.
To generate the documentation, checkout the `mbedtls-2.28` branch and follow
It's best to use the latest version of Mbed TLS 2.x for this purpose, which is the 2.28 LTS release.
So to generate the documentation, checkout the `mbedtls-2.28` branch and follow
the instructions in the [Documentation section of the README](https://github.com/Mbed-TLS/mbedtls/blob/development/README.md#documentation).
Then browse `apidoc/deprecated.html` for guidance on upgrading deprecated code.