From dc16aa7eacfdf2b032d9e4b641b74f01476baaba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Manuel=20P=C3=A9gouri=C3=A9-Gonnard?= Date: Wed, 25 Jun 2014 12:55:12 +0200 Subject: [PATCH] Improve comments on POLARSSL_ERROR_STRERROR_DUMMY --- include/polarssl/config.h | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/include/polarssl/config.h b/include/polarssl/config.h index 9aae6119c..c66b9d486 100644 --- a/include/polarssl/config.h +++ b/include/polarssl/config.h @@ -638,6 +638,9 @@ * Make available the backward compatible error_strerror() next to the * current polarssl_strerror(). * + * For new code, it is recommended to use polarssl_strerror() instead and + * disabled this. + * * Disable if you run into name conflicts and want to really remove the * error_strerror() */ @@ -647,7 +650,11 @@ * \def POLARSSL_ERROR_STRERROR_DUMMY * * Enable a dummy error function to make use of polarssl_strerror() in - * third party libraries easier. + * third party libraries easier when POLARSSL_ERROR_C is disabled + * (no effect when POLARSSL_ERROR_C is enabled). + * + * You can safely disable this if POLARSSL_ERROR_C is enabled, or if you're + * not using polarssl_strerror() or error_strerror() in your application. * * Disable if you run into name conflicts and want to really remove the * polarssl_strerror()