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

Add backticks where needed

Browse source 
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
This commit is contained in:
Dave Rodgman 2021-06-30 18:35:43 +01:00
parent 2e1e623d33
commit 9d3417845c
1 changed files with 36 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

72
docs/3.0-migration-guide.md
View file

@ -389,7 +389,7 @@ The following functions now take an extra parameter indicating the size of the o
The requirements for the output buffer have not changed, but passing a buffer that is too small now reliably causes the functions to return an error, rather than overflowing the buffer.
### Rename mbedtls_*_ret() cryptography functions whose deprecated variants have been removed
### Rename `mbedtls_*_ret()` cryptography functions whose deprecated variants have been removed
This change affects users who were using the `mbedtls_*_ret()` cryptography
functions.
@ -398,30 +398,30 @@ Those functions were created based on now-deprecated functions according to a
requirement that a function needs to return a value. This change brings back the
original names of those functions. The renamed functions are:
| name before this change | after the change |
|------------------------------|--------------------------|
| mbedtls_ctr_drbg_update_ret | mbedtls_ctr_drbg_update |
| mbedtls_hmac_drbg_update_ret | mbedtls_hmac_drbg_update |
| mbedtls_md5_starts_ret | mbedtls_md5_starts |
| mbedtls_md5_update_ret | mbedtls_md5_update |
| mbedtls_md5_finish_ret | mbedtls_md5_finish |
| mbedtls_md5_ret | mbedtls_md5 |
| mbedtls_ripemd160_starts_ret | mbedtls_ripemd160_starts |
| mbedtls_ripemd160_update_ret | mbedtls_ripemd160_update |
| mbedtls_ripemd160_finish_ret | mbedtls_ripemd160_finish |
| mbedtls_ripemd160_ret | mbedtls_ripemd160 |
| mbedtls_sha1_starts_ret | mbedtls_sha1_starts |
| mbedtls_sha1_update_ret | mbedtls_sha1_update |
| mbedtls_sha1_finish_ret | mbedtls_sha1_finish |
| mbedtls_sha1_ret | mbedtls_sha1 |
| mbedtls_sha256_starts_ret | mbedtls_sha256_starts |
| mbedtls_sha256_update_ret | mbedtls_sha256_update |
| mbedtls_sha256_finish_ret | mbedtls_sha256_finish |
| mbedtls_sha256_ret | mbedtls_sha256 |
| mbedtls_sha512_starts_ret | mbedtls_sha512_starts |
| mbedtls_sha512_update_ret | mbedtls_sha512_update |
| mbedtls_sha512_finish_ret | mbedtls_sha512_finish |
| mbedtls_sha512_ret | mbedtls_sha512 |
| name before this change | after the change |
|--------------------------------|----------------------------|
| `mbedtls_ctr_drbg_update_ret` | `mbedtls_ctr_drbg_update` |
| `mbedtls_hmac_drbg_update_ret` | `mbedtls_hmac_drbg_update` |
| `mbedtls_md5_starts_ret` | `mbedtls_md5_starts` |
| `mbedtls_md5_update_ret` | `mbedtls_md5_update` |
| `mbedtls_md5_finish_ret` | `mbedtls_md5_finish` |
| `mbedtls_md5_ret` | `mbedtls_md5` |
| `mbedtls_ripemd160_starts_ret` | `mbedtls_ripemd160_starts` |
| `mbedtls_ripemd160_update_ret` | `mbedtls_ripemd160_update` |
| `mbedtls_ripemd160_finish_ret` | `mbedtls_ripemd160_finish` |
| `mbedtls_ripemd160_ret` | `mbedtls_ripemd160` |
| `mbedtls_sha1_starts_ret` | `mbedtls_sha1_starts` |
| `mbedtls_sha1_update_ret` | `mbedtls_sha1_update` |
| `mbedtls_sha1_finish_ret` | `mbedtls_sha1_finish` |
| `mbedtls_sha1_ret` | `mbedtls_sha1` |
| `mbedtls_sha256_starts_ret` | `mbedtls_sha256_starts` |
| `mbedtls_sha256_update_ret` | `mbedtls_sha256_update` |
| `mbedtls_sha256_finish_ret` | `mbedtls_sha256_finish` |
| `mbedtls_sha256_ret` | `mbedtls_sha256` |
| `mbedtls_sha512_starts_ret` | `mbedtls_sha512_starts` |
| `mbedtls_sha512_update_ret` | `mbedtls_sha512_update` |
| `mbedtls_sha512_finish_ret` | `mbedtls_sha512_finish` |
| `mbedtls_sha512_ret` | `mbedtls_sha512` |
To migrate to the this change the user can keep the `*_ret` names in their code
and include the `compat_2.x.h` header file which holds macros with proper
@ -452,15 +452,15 @@ The signature functions in the PK module no longer accept 0 as the `hash_len` pa
The migration path is to pass the correct value to those functions.
### Remove the padding parameters from mbedtls_rsa_init()
### Remove the padding parameters from `mbedtls_rsa_init()`
This affects all users who use the RSA encryption, decryption, sign and
verify APIs.
The function mbedtls_rsa_init() no longer supports selecting the PKCS#1 v2.1
The function `mbedtls_rsa_init()` no longer supports selecting the PKCS#1 v2.1
encoding and its hash. It just selects the PKCS#1 v1.5 encoding by default. If
you were using the PKCS#1 v2.1 encoding you now need, subsequently to the call
to mbedtls_rsa_init(), to call mbedtls_rsa_set_padding() to set it.
to `mbedtls_rsa_init()`, to call `mbedtls_rsa_set_padding()` to set it.
To choose the padding type when initializing a context, instead of
@ -526,8 +526,8 @@ and explain your need; we'll consider adding a new API in a future version.
The CCM interface has changed with the addition of support for
multi-part operations. Five new API functions have been defined:
mbedtls_ccm_starts(), mbedtls_ccm_set_lengths(),
mbedtls_ccm_update_ad(), mbedtls_ccm_update() and mbedtls_ccm_finish().
`mbedtls_ccm_starts()`, `mbedtls_ccm_set_lengths()`,
`mbedtls_ccm_update_ad()`, `mbedtls_ccm_update()` and `mbedtls_ccm_finish()`.
Alternative implementations of CCM (`MBEDTLS_CCM_ALT`) have now to
implement those additional five API functions.
@ -807,7 +807,7 @@ recommended ciphersuites (based on AES-GCM, AES-CCM or ChachaPoly for example)
and if your peer doesn't support any, encourage them to upgrade their software.
If you were using a ciphersuite without encryption, you just have to
enable MBEDTLS_CIPHER_NULL_CIPHER now.
enable `MBEDTLS_CIPHER_NULL_CIPHER` now.
### Remove the `MBEDTLS_SSL_MAX_CONTENT_LEN` configuration option
@ -845,7 +845,7 @@ Migration paths:
### Remove `MBEDTLS_SSL_DTLS_BADMAC_LIMIT` option
This change does not affect users who used the default `mbedtls_config.h`, as the option
MBEDTLS_SSL_DTLS_BADMAC_LIMIT was already on by default.
`MBEDTLS_SSL_DTLS_BADMAC_LIMIT` was already on by default.
This option was a trade-off between functionality and code size: it allowed
users who didn't need that feature to avoid paying the cost in code size, by
@ -865,11 +865,11 @@ instead.
### Remove `MBEDTLS_SSL_RECORD_CHECKING` option and enable its action by default
This change does not affect users who use the default mbedtls_config.h, as the
option MBEDTLS_SSL_RECORD_CHECKING was already on by default.
This change does not affect users who use the default `mbedtls_config.h`, as the
option `MBEDTLS_SSL_RECORD_CHECKING` was already on by default.
This option was added only to control compilation of one function,
mbedtls_ssl_check_record(), which is only useful in some specific cases, so it
`mbedtls_ssl_check_record()`, which is only useful in some specific cases, so it
was made optional to allow users who don't need it to save some code space.
However, the same effect can be achieved by using link-time garbage collection.
@ -986,7 +986,7 @@ Migration path:
### Turn `MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE` configuration option into a runtime option
This change affects users who were enabling MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE
This change affects users who were enabling `MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE`
option in the `mbedtls_config.h`
This option has been removed and a new function with similar functionality has