From 0c3f0e998d584ac4ca01caa398bcf777ee802f5e Mon Sep 17 00:00:00 2001 From: Gilles Peskine Date: Mon, 4 Mar 2024 15:54:54 +0100 Subject: [PATCH] Note the need to tell git to set up the submodule Signed-off-by: Gilles Peskine --- README.md | 4 ++++ framework | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2505d8fd9..7d3894e8b 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,10 @@ You need the following tools to build the library with the provided makefiles: * Microsoft Visual Studio 2013 or later (if using Visual Studio). * Doxygen 1.8.11 or later (if building the documentation; slightly older versions should work). +### Git usage + +The `development` branch and the `mbedtls-3.6` long-term support of Mbed TLS use a [Git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules#_cloning_submodules) ([framework](https://github.com/Mbed-TLS/mbedtls-framework)). This is not needed to merely compile the library at a release tag. This is not needed to consume a release archive (zip or tar). + ### Generated source files in the development branch The source code of Mbed TLS includes some files that are automatically generated by scripts and whose content depends only on the Mbed TLS source, not on the platform or on the library configuration. These files are not included in the development branch of Mbed TLS, but the generated files are included in official releases. This section explains how to generate the missing files in the development branch. diff --git a/framework b/framework index 2c29c56c1..26ab40de5 160000 --- a/framework +++ b/framework @@ -1 +1 @@ -Subproject commit 2c29c56c1095044dd78d6ea5d804fe1f61f946bf +Subproject commit 26ab40de5887c872b5108981fece907104e8409c