From 4b8aaa4e60bc13786a6a6a76e62ade41c21f3722 Mon Sep 17 00:00:00 2001 From: Werner Lewis Date: Mon, 27 Jun 2022 09:30:11 +0100 Subject: [PATCH] Add clarification on 2.x branch choice Signed-off-by: Werner Lewis --- docs/3.0-migration-guide.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/3.0-migration-guide.md b/docs/3.0-migration-guide.md index 8474069037..14c8aa821d 100644 --- a/docs/3.0-migration-guide.md +++ b/docs/3.0-migration-guide.md @@ -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.