yuzu-emu/mbedtls
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix some typos, improve wording & formatting

Browse source 
Signed-off-by: Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com>
This commit is contained in:
Manuel Pégourié-Gonnard 2022-09-16 09:45:43 +02:00
parent d18c24b166
commit 138387fc8c
2 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/architecture/psa-migration/strategy.md
View file

@ -351,7 +351,7 @@ It should be noted that there are currently:
- too many different ways of computing a hash (low-level, MD, PSA); - too many different ways of computing a hash (low-level, MD, PSA);
- too many different ways to configure the library that influence which of - too many different ways to configure the library that influence which of
these ways is available and will be used (`MBEDTLS_USE_PSA_CRYPTO`, these ways is available and will be used (`MBEDTLS_USE_PSA_CRYPTO`,
`MBEDTLS_PSA_CRYPTO_CONFIG`, `mbedtls_config.h` + `psa/crypto_config.h`). `MBEDTLS_PSA_CRYPTO_CONFIG`, `mbedtls_config.h` + `psa/crypto_config.h`).
As a result, we need more families of dependency macros than we'd like to. As a result, we need more families of dependency macros than we'd like to.
This is a temporary situation until we move to a place where everything is This is a temporary situation until we move to a place where everything is
@ -361,12 +361,12 @@ the new macros in the hope of avoiding confusion.
Note: the new macros supplement but do not replace the existing macros: Note: the new macros supplement but do not replace the existing macros:
- code that always uses PSA Crypto (for example, code specific to TLS 1.3) - code that always uses PSA Crypto (for example, code specific to TLS 1.3)
should use `PSA_WANT_xxx`; should use `PSA_WANT_xxx`;
- code that always uses the legacy API (for exmaple, crypto modules that have - code that always uses the legacy API (for example, crypto modules that have
not undergone step 1 yet) should use `MBEDTLS_xxx_C`; not undergone step 1 yet) should use `MBEDTLS_xxx_C`;
- code that may use one of the two APIs, either based on - code that may use one of the two APIs, either based on
`MBEDTLS_USE_PSA_CRYPTO` (X.509, TLS 1.2, shared between TLS 1.2 and 1.3), `MBEDTLS_USE_PSA_CRYPTO` (X.509, TLS 1.2, shared between TLS 1.2 and 1.3),
or based on availability (crypto modules after step 1), should use one of the or based on availability (crypto modules after step 1), should use one of
new macros from `legacy_or_psa.h`. the new macros from `legacy_or_psa.h`.
Executing step 3 will mostly consist of using the right dependency macros in Executing step 3 will mostly consist of using the right dependency macros in
the right places (once the previous steps are done). the right places (once the previous steps are done).

4
include/mbedtls/legacy_or_psa.h
View file

@ -19,7 +19,7 @@
*/ */
/* /*
* Note: applications who are targetting a specific configurations do not need * Note: applications that are targeting a specific configuration do not need
* to use these macros; instead they should directly use the functions they * to use these macros; instead they should directly use the functions they
* know are available in their configuration. * know are available in their configuration.
* *
@ -29,7 +29,7 @@
* *
* Note: code that is purely based on the legacy crypto APIs (mbedtls_xxx()) * Note: code that is purely based on the legacy crypto APIs (mbedtls_xxx())
* does not need to use these macros; instead it should use the relevant * does not need to use these macros; instead it should use the relevant
* MBEDTLS_xxx_ macros. * MBEDTLS_xxx macros.
* *
* These macros are for code that wants to use <crypto feature> and will do so * These macros are for code that wants to use <crypto feature> and will do so
* using <legacy API> or PSA depending on <condition>, where: * using <legacy API> or PSA depending on <condition>, where: