lib/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-05-02 22:44:46 +03:00
Code

Fix typo / improve documentation for test step fns

Browse Source 
Signed-off-by: Paul Elliott <paul.elliott@arm.com>
This commit is contained in:
Paul Elliott 2024-02-09 14:41:24 +00:00
parent 54ad01efed
commit 5d2bcc63cd
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
tests/include/test/helpers.h
View File

@ -116,10 +116,10 @@ int mbedtls_test_get_line_no(void);
/** /**
* \brief Increment the current test step. * \brief Increment the current test step.
* *
* \note Calling this function from within multiple threads at the * \note It is not recommended for multiple threads to call this
* same time is not recommended - whilst it is entirely thread * function concurrently - whilst it is entirely thread safe,
* safe, the order of calls to this function can obviously not * the order of calls to this function can obviously not be
* be ensured, so unexpected results may occur. * ensured, so unexpected results may occur.
*/ */
void mbedtls_test_increment_step(void); void mbedtls_test_increment_step(void);
@ -231,10 +231,10 @@ void mbedtls_test_skip(const char *test, int line_no, const char *filename);
* "step number" is the index of a for loop but it can be * "step number" is the index of a for loop but it can be
* whatever you want. * whatever you want.
* *
* \note Calling this function from a within multiple threads at the * \note It is not recommended for multiple threads to call this
* same time is not recommended - whilst it is entirely thread * function concurrently - whilst it is entirely thread safe,
* safe, the order of calls to this function can obviously not * the order of calls to this function can obviously not be
* be ensured, so unexpected results may occur. * ensured, so unexpected results may occur.
* *
* \param step The step number to report. * \param step The step number to report.
*/ */