params: add a warning about the PTR types.

[oweals/openssl.git] / include / openssl / core.h

diff --git a/include/openssl/core.h b/include/openssl/core.h
index 5959a3188064690c09c5b6c961675d6ba9b57df4..e5a4b9266a2313b46991c55fee060b259d4d519a 100644 (file)
--- a/include/openssl/core.h
+++ b/include/openssl/core.h
@@ -124,6 +124,9 @@ struct ossl_param_st {
  *
  * WARNING!  Using these is FRAGILE, as it assumes that the actual
  * data and its location are constant.
+ *
+ * EXTRA WARNING!  If you are not completely sure you most likely want
+ * to use the OSSL_PARAM_UTF8_STRING type.
  */
 # define OSSL_PARAM_UTF8_PTR             6
 /*-
@@ -140,6 +143,9 @@ struct ossl_param_st {
  *
  * WARNING!  Using these is FRAGILE, as it assumes that the actual
  * data and its location are constant.
+ *
+ * EXTRA WARNING!  If you are not completely sure you most likely want
+ * to use the OSSL_PARAM_OCTET_STRING type.
  */
 # define OSSL_PARAM_OCTET_PTR            7