Additional updates to docs links

Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
This commit is contained in:
Dave Rodgman 2022-10-12 16:47:08 +01:00
parent 7c195160df
commit b319684bca
8 changed files with 10 additions and 10 deletions

View file

@ -463,7 +463,7 @@ API changes
provides better randomness. Instead of HAVEGE, declare OS or hardware RNG provides better randomness. Instead of HAVEGE, declare OS or hardware RNG
interfaces with mbedtls_entropy_add_source() and/or use an entropy seed interfaces with mbedtls_entropy_add_source() and/or use an entropy seed
file created securely during device provisioning. See file created securely during device provisioning. See
https://tls.mbed.org/kb/how-to/add-entropy-sources-to-entropy-pool for https://mbed-tls.readthedocs.io/en/latest/kb/how-to/add-entropy-sources-to-entropy-pool/ for
more information. more information.
* Add missing const attributes to API functions. * Add missing const attributes to API functions.
* Remove helpers for the transition from Mbed TLS 1.3 to Mbed TLS 2.0: the * Remove helpers for the transition from Mbed TLS 1.3 to Mbed TLS 2.0: the

View file

@ -2,7 +2,7 @@
Here are some useful sources of information about using Mbed TLS: Here are some useful sources of information about using Mbed TLS:
- [ReadTheDocs](https://tls.mbed.org/kb); - [ReadTheDocs](https://mbed-tls.readthedocs.io/);
- API documentation, see the [Documentation section of the - API documentation, see the [Documentation section of the
README](README.md#License); README](README.md#License);
- the `docs` directory in the source tree; - the `docs` directory in the source tree;

View file

@ -141,7 +141,7 @@ recommended), or users who used it through the entropy module but had it as the
only source of entropy. If you're in that case, please declare OS or hardware only source of entropy. If you're in that case, please declare OS or hardware
RNG interfaces with `mbedtls_entropy_add_source()` and/or use an entropy seed RNG interfaces with `mbedtls_entropy_add_source()` and/or use an entropy seed
file created securely during device provisioning. See file created securely during device provisioning. See
<https://tls.mbed.org/kb/how-to/add-entropy-sources-to-entropy-pool> for more <https://mbed-tls.readthedocs.io/en/latest/kb/how-to/add-entropy-sources-to-entropy-pool> for more
information. information.
### Remove helpers for the transition from Mbed TLS 1.3 to Mbed TLS 2.0 ### Remove helpers for the transition from Mbed TLS 1.3 to Mbed TLS 2.0

View file

@ -38,7 +38,7 @@ The general principle of an alternative implementation is:
* Create a header file `xxx_alt.h` that defines the context type(s) used by the module. For example, `mbedtls_aes_context` for AES. * Create a header file `xxx_alt.h` that defines the context type(s) used by the module. For example, `mbedtls_aes_context` for AES.
* Implement all the functions from the module, i.e. the functions declared in `include/mbedtls/xxx.h`. * Implement all the functions from the module, i.e. the functions declared in `include/mbedtls/xxx.h`.
See https://tls.mbed.org/kb/development/hw_acc_guidelines for a more detailed guide. See https://mbed-tls.readthedocs.io/en/latest/kb/development/hw_acc_guidelines for a more detailed guide.
### Constraints on context types ### Constraints on context types

View file

@ -6,7 +6,7 @@ This document is incomplete. You can help by expanding it.
## Unit tests ## Unit tests
See <https://tls.mbed.org/kb/development/test_suites> See <https://mbed-tls.readthedocs.io/en/latest/kb/development/test_suites>
### Unit test descriptions ### Unit test descriptions

View file

@ -181,7 +181,7 @@ Coding rules checklist for TLS 1.3
The following coding rules are aimed to be a checklist for TLS 1.3 upstreaming The following coding rules are aimed to be a checklist for TLS 1.3 upstreaming
work to reduce review rounds and the number of comments in each round. They work to reduce review rounds and the number of comments in each round. They
come along (do NOT replace) the project coding rules come along (do NOT replace) the project coding rules
(https://tls.mbed.org/kb/development/mbedtls-coding-standards). They have been (https://mbed-tls.readthedocs.io/en/latest/kb/development/mbedtls-coding-standards). They have been
established and discussed following the review of #4882 that was the established and discussed following the review of #4882 that was the
PR upstreaming the first part of TLS 1.3 ClientHello writing code. PR upstreaming the first part of TLS 1.3 ClientHello writing code.

View file

@ -2552,7 +2552,7 @@
* *
* \note See also our Knowledge Base article about porting to a new * \note See also our Knowledge Base article about porting to a new
* environment: * environment:
* https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS * https://mbed-tls.readthedocs.io/en/latest/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
* *
* Module: library/net_sockets.c * Module: library/net_sockets.c
* *
@ -3108,7 +3108,7 @@
* contexts are not shared between threads. If you do intend to use contexts * contexts are not shared between threads. If you do intend to use contexts
* between threads, you will need to enable this layer to prevent race * between threads, you will need to enable this layer to prevent race
* conditions. See also our Knowledge Base article about threading: * conditions. See also our Knowledge Base article about threading:
* https://tls.mbed.org/kb/development/thread-safety-and-multi-threading * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
* *
* Module: library/threading.c * Module: library/threading.c
* *
@ -3140,7 +3140,7 @@
* *
* \note See also our Knowledge Base article about porting to a new * \note See also our Knowledge Base article about porting to a new
* environment: * environment:
* https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS * https://mbed-tls.readthedocs.io/en/latest/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
* *
* Module: library/timing.c * Module: library/timing.c
*/ */

View file

@ -2322,7 +2322,7 @@ int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
* here, except if using an event-driven style. * here, except if using an event-driven style.
* *
* \note See also the "DTLS tutorial" article in our knowledge base. * \note See also the "DTLS tutorial" article in our knowledge base.
* https://tls.mbed.org/kb/how-to/dtls-tutorial * https://mbed-tls.readthedocs.io/en/latest/kb/how-to/dtls-tutorial
*/ */
void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl, void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
void *p_timer, void *p_timer,