Documentation rewording
Signed-off-by: TRodziewicz <tomasz.rodziewicz@mobica.com>
diff --git a/ChangeLog.d/issue4083.txt b/ChangeLog.d/issue4083.txt
index f3f7e31..8457337 100644
--- a/ChangeLog.d/issue4083.txt
+++ b/ChangeLog.d/issue4083.txt
@@ -1,5 +1,4 @@
-Changes
- * Remove the following functions: mbedtls_timing_self_test() and
- mbedtls_hardclock_poll(). Move the following functions to the benchmark.c
- file and make them static: mbedtls_timing_hardclock() and
+Removals
+ * Remove the following functions: mbedtls_timing_self_test(),
+ mbedtls_hardclock_poll(), mbedtls_timing_hardclock() and
mbedtls_set_alarm(). Fixes #4083.
diff --git a/docs/3.0-migration-guide.d/move_part_of_timing_module_out_of_the_library.md b/docs/3.0-migration-guide.d/move_part_of_timing_module_out_of_the_library.md
index f0b539c..fa61e27 100644
--- a/docs/3.0-migration-guide.d/move_part_of_timing_module_out_of_the_library.md
+++ b/docs/3.0-migration-guide.d/move_part_of_timing_module_out_of_the_library.md
@@ -5,8 +5,5 @@
`mbedtls_timing_self_test()`, `mbedtls_hardclock_poll()`,
`mbedtls_timing_hardclock()` and `mbedtls_set_alarm()`.
-This change is the first step of a plan of removal of the `timing.c` from the
-library. The plan is to move all the timing functions to the `platform.c` file.
-
-For users who still need removed functions the migration path is to re-implement
-them as a platform support code.
+If you were relying on these functions, you'll now need to change to using your
+platform's corresponding functions directly.
diff --git a/include/mbedtls/config.h b/include/mbedtls/config.h
index 74b8222..4a98c5d 100644
--- a/include/mbedtls/config.h
+++ b/include/mbedtls/config.h
@@ -1013,8 +1013,7 @@
/**
* \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
*
- * Do not add default entropy sources. These are the platform specific
- * poll function.
+ * Do not add default entropy sources in mbedtls_entropy_init().
*
* This is useful to have more control over the added entropy sources in an
* application.
diff --git a/include/mbedtls/timing.h b/include/mbedtls/timing.h
index 9ea5c29..5289889 100644
--- a/include/mbedtls/timing.h
+++ b/include/mbedtls/timing.h
@@ -63,25 +63,7 @@
extern volatile int mbedtls_timing_alarmed;
-/**
- * \brief Return the elapsed time in milliseconds
- *
- * \warning May change without notice
- *
- * \param val points to a timer structure
- * \param reset If 0, query the elapsed time. Otherwise (re)start the timer.
- *
- * \return Elapsed time since the previous reset in ms. When
- * restarting, this is always 0.
- *
- * \note To initialize a timer, call this function with reset=1.
- *
- * Determining the elapsed time and resetting the timer is not
- * atomic on all platforms, so after the sequence
- * `{ get_timer(1); ...; time1 = get_timer(1); ...; time2 =
- * get_timer(0) }` the value time1+time2 is only approximately
- * the delay since the first reset.
- */
+/* Internal use */
unsigned long mbedtls_timing_get_timer( struct mbedtls_timing_hr_time *val, int reset );
/**
diff --git a/library/timing.c b/library/timing.c
index d87d8b6..e6dfc72 100644
--- a/library/timing.c
+++ b/library/timing.c
@@ -83,6 +83,25 @@
#else /* _WIN32 && !EFIX64 && !EFI32 */
+/**
+ * \brief Return the elapsed time in milliseconds
+ *
+ * \warning May change without notice
+ *
+ * \param val points to a timer structure
+ * \param reset If 0, query the elapsed time. Otherwise (re)start the timer.
+ *
+ * \return Elapsed time since the previous reset in ms. When
+ * restarting, this is always 0.
+ *
+ * \note To initialize a timer, call this function with reset=1.
+ *
+ * Determining the elapsed time and resetting the timer is not
+ * atomic on all platforms, so after the sequence
+ * `{ get_timer(1); ...; time1 = get_timer(1); ...; time2 =
+ * get_timer(0) }` the value time1+time2 is only approximately
+ * the delay since the first reset.
+ */
unsigned long mbedtls_timing_get_timer( struct mbedtls_timing_hr_time *val, int reset )
{
struct _hr_time *t = (struct _hr_time *) val;
