From f8a478795cc3e9667b1b2ca15c173b410970223b Mon Sep 17 00:00:00 2001 From: Werner Lewis Date: Fri, 24 Jun 2022 11:02:54 +0100 Subject: [PATCH] Add guidance for generating deprecated list Signed-off-by: Werner Lewis --- docs/3.0-migration-guide.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/3.0-migration-guide.md b/docs/3.0-migration-guide.md index 71e5975728..e728446283 100644 --- a/docs/3.0-migration-guide.md +++ b/docs/3.0-migration-guide.md @@ -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 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 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