diff options
| author | Gilles Peskine <Gilles.Peskine@arm.com> | 2024-03-04 15:54:54 +0100 |
|---|---|---|
| committer | Gilles Peskine <Gilles.Peskine@arm.com> | 2024-03-04 17:12:59 +0100 |
| commit | 0c3f0e998d584ac4ca01caa398bcf777ee802f5e (patch) | |
| tree | 5d9cd99911785bfa953bca3a1d291725f90cca0c /README.md | |
| parent | de047b09fe1f7c2ee878a0cc7b6f75f4cf429649 (diff) | |
| download | mbedtls-0c3f0e998d584ac4ca01caa398bcf777ee802f5e.zip mbedtls-0c3f0e998d584ac4ca01caa398bcf777ee802f5e.tar.gz mbedtls-0c3f0e998d584ac4ca01caa398bcf777ee802f5e.tar.bz2 | |
Note the need to tell git to set up the submodule
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 4 |
1 files changed, 4 insertions, 0 deletions
@@ -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. |