eden-emu/mbedtls
15
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add clarification on 2.x branch choice

Browse source 
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
1 changed files with 2 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/3.0-migration-guide.md
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 migration path is not provided in prior documentation, changes made and the
upgrade steps required will be explained in this guide. 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). 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. Then browse `apidoc/deprecated.html` for guidance on upgrading deprecated code.