lib/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-08-07 06:42:56 +03:00
Code Activity

Add guidance for generating deprecated list

Browse Source 
Signed-off-by: Werner Lewis <werner.lewis@arm.com>
This commit is contained in:
Werner Lewis
2022-06-24 11:02:54 +01:00
parent 016cec17e8
commit f8a478795c
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/3.0-migration-guide.md
View File

@@ -23,6 +23,10 @@ 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
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.
For some deprecated functions, 2.x documentation will suggest using a variant For some deprecated functions, 2.x documentation will suggest using a variant
suffixed with `_ret`. In Mbed TLS 3.x, this change may not be required, as most suffixed with `_ret`. In Mbed TLS 3.x, this change may not be required, as most
of these variants have been renamed without the suffix. The section of these variants have been renamed without the suffix. The section