Typo fixes in documentation
This commit is contained in:
parent
45be3d8136
commit
d3deb1d738
3 changed files with 6 additions and 6 deletions
2
Makefile
2
Makefile
|
@ -1,5 +1,5 @@
|
||||||
|
|
||||||
# build crypto form submodule unless explicitly disabled
|
# build crypto from submodule unless explicitly disabled
|
||||||
USE_CRYPTO_SUBMODULE ?= 1
|
USE_CRYPTO_SUBMODULE ?= 1
|
||||||
|
|
||||||
DESTDIR=/usr/local
|
DESTDIR=/usr/local
|
||||||
|
|
|
@ -23,7 +23,7 @@ The Make and CMake build systems create three libraries: libmbedcrypto, libmbedx
|
||||||
|
|
||||||
### Getting files form git: the Crypto submodule
|
### Getting files form git: the Crypto submodule
|
||||||
|
|
||||||
The Mbed Crypto library now has its own git repository, which the Mbed TLS build systems are using as a git submodule in order to build libmbecrypto as a subproject of Mbed TLS. When cloning the Mbed TLS repository, you need to make sure you're getting the submodule as well:
|
The Mbed Crypto library now has its own git repository, which the Mbed TLS build systems are using as a git submodule in order to build libmbedcrypto as a subproject of Mbed TLS. When cloning the Mbed TLS repository, you need to make sure you're getting the submodule as well:
|
||||||
|
|
||||||
git clone --recursive https://github.com/ARMmbed/mbedtls.git
|
git clone --recursive https://github.com/ARMmbed/mbedtls.git
|
||||||
|
|
||||||
|
@ -34,9 +34,9 @@ repository, you can initialise and update the submodule with:
|
||||||
|
|
||||||
After these steps, your clone is now ready for building the libraries as detailed in the following sections.
|
After these steps, your clone is now ready for building the libraries as detailed in the following sections.
|
||||||
|
|
||||||
Note that building libmbedcrypto as a subproject of Mbed LTS does not enable the PSA-specific tests and utility programs. To use these programs, build Mbed Crypto as a standalone project.
|
Note that building libmbedcrypto as a subproject of Mbed TLS does not enable the PSA-specific tests and utility programs. To use these programs, build Mbed Crypto as a standalone project.
|
||||||
|
|
||||||
Please note that for now, Mbed TLS can only use versions of libmbedcrypto that were built as a subproject of Mbed TLS, not versions that were build standalone from the Mbed Crypto repository. This restriction will be removed in the future.
|
Please note that for now, Mbed TLS can only use versions of libmbedcrypto that were built as a subproject of Mbed TLS, not versions that were built standalone from the Mbed Crypto repository. This restriction will be removed in the future.
|
||||||
|
|
||||||
### Make
|
### Make
|
||||||
|
|
||||||
|
|
|
@ -1740,12 +1740,12 @@
|
||||||
* \warning This option enables new Mbed TLS APIs that are dependent on the
|
* \warning This option enables new Mbed TLS APIs that are dependent on the
|
||||||
* PSA Crypto API, so can't come with the same stability guarantees as the
|
* PSA Crypto API, so can't come with the same stability guarantees as the
|
||||||
* rest of the Mbed TLS APIs. You're welcome to experiment with them, but for
|
* rest of the Mbed TLS APIs. You're welcome to experiment with them, but for
|
||||||
* now access to these APIs is opt-in (via enabling the present option), in
|
* now, access to these APIs is opt-in (via enabling the present option), in
|
||||||
* order to clearly differentiate them from the stable Mbed TLS APIs.
|
* order to clearly differentiate them from the stable Mbed TLS APIs.
|
||||||
*
|
*
|
||||||
* Requires: MBEDTLS_PSA_CRYPTO_C.
|
* Requires: MBEDTLS_PSA_CRYPTO_C.
|
||||||
*
|
*
|
||||||
* Uncomment this to enable internal use of PSA Crypto and new associated APIs
|
* Uncomment this to enable internal use of PSA Crypto and new associated APIs.
|
||||||
*/
|
*/
|
||||||
//#define MBEDTLS_USE_PSA_CRYPTO
|
//#define MBEDTLS_USE_PSA_CRYPTO
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue