From c52ef407bad144109ac52cc25f1519cdd2f39520 Mon Sep 17 00:00:00 2001
From: Hanno Becker <hanno.becker@arm.com>
Date: Wed, 5 Sep 2018 16:28:59 +0100
Subject: [PATCH] Improve documentation of mbedtls_platform_gmtime_r()

---
 include/mbedtls/config.h        | 8 ++------
 include/mbedtls/platform_util.h | 9 ++++-----
 2 files changed, 6 insertions(+), 11 deletions(-)

diff --git a/include/mbedtls/config.h b/include/mbedtls/config.h
index 214ea9403..9a7905ae0 100644
--- a/include/mbedtls/config.h
+++ b/include/mbedtls/config.h
@@ -146,12 +146,8 @@
  * Comment if your system does not have a correct clock.
  *
  * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
- * behaves similarly to the gmtime() function from the C standard,
- * but is thread-safe. Mbed TLS will try to identify the underlying platform
- * and configure an appropriate underlying implementation (e.g. gmtime_r() for
- * POSIX and gmtime_s() for Windows). If this is not possible, then
- * gmtime() will be used. Refer to the documentation for
- * mbedtls_platform_gmtime_r() for more information.
+ * behaves similarly to the gmtime_r() function from the C standard. Refer to
+ * the documentation for mbedtls_platform_gmtime_r() for more information.
  *
  * \note It is possible to configure an implementation for
  * mbedtls_platform_gmtime_r() at compile-time by using the macro
diff --git a/include/mbedtls/platform_util.h b/include/mbedtls/platform_util.h
index e62a3af4e..9c8a93077 100644
--- a/include/mbedtls/platform_util.h
+++ b/include/mbedtls/platform_util.h
@@ -67,14 +67,13 @@ void mbedtls_platform_zeroize( void *buf, size_t len );
 
 #if defined(MBEDTLS_HAVE_TIME_DATE)
 /**
- * \brief      Thread-safe implementation of gmtime()
+ * \brief      Platform-specific implementation of gmtime_r()
  *
- *             The function is an abstraction that when called behaves similar
- *             to the gmtime() function from the C standard, but is thread
- *             safe.
+ *             The function is a thread-safe abstraction that behaves
+ *             similar to the gmtime_r() function from the C standard.
  *
  *             Mbed TLS will try to identify the underlying platform and
- *             configure an appropriate underlying implementation (e.g.
+ *             make use of an appropriate underlying implementation (e.g.
  *             gmtime_r() for POSIX and gmtime_s() for Windows). If this is
  *             not possible, then gmtime() will be used. In this case, calls
  *             from the library to gmtime() will be guarded by the mutex