gnutls_load_file: document limitation regarding partial failure

Signed-off-by: Daiki Ueno <ueno@gnu.org>

diff --git a/lib/file.c b/lib/file.c
index 03aa265c38300addbc170f1a2873aa65234a800f..ed044ff842732cdc2f10eb0bad504eb797f4f13e 100644 (file)
--- a/lib/file.c
+++ b/lib/file.c
@@ -46,6 +46,10 @@ int _gnutls_file_exists(const char *file)
  * zero terminated but the terminating null is not included in length.
  * The returned data are allocated using gnutls_malloc().
  *
+ * Note that this function is not designed for reading sensitive materials,
+ * such as private keys, on practical applications. When the reading fails
+ * in the middle, the partially loaded content might remain on memory.
+ *
  * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise
  *   an error code is returned.
  *