Deprecate CONF_modules_free() and make it a no-op
[openssl.git] / doc / crypto / CONF_modules_free.pod
index 37a7b16..12e594d 100644 (file)
@@ -9,10 +9,15 @@
 
  #include <openssl/conf.h>
 
- void CONF_modules_free(void);
  void CONF_modules_finish(void);
  void CONF_modules_unload(int all);
 
+Deprecated:
+
+ #if OPENSSL_API_COMPAT < 0x10100000L
+ # define CONF_modules_free()
+ #endif
+
 =head1 DESCRIPTION
 
 CONF_modules_free() closes down and frees up all memory allocated by all
@@ -27,8 +32,10 @@ B<all> is B<1> all modules, including builtin modules will be unloaded.
 
 =head1 NOTES
 
-Normally applications will only call CONF_modules_free() at application to
-tidy up any configuration performed.
+Normally in versions of OpenSSL prior to 1.1.0 applications will only call
+CONF_modules_free() at application to tidy up any configuration performed. From
+1.1.0 CONF_modules_free() is deprecated an no explicit CONF cleanup as required
+at all. For more information see L<OPENSSL_init_crypto(3)>.
 
 =head1 RETURN VALUE
 
@@ -39,4 +46,8 @@ None of the functions return a value.
 L<conf(5)>, L<OPENSSL_config(3)>,
 L<CONF_modules_load_file(3)>
 
+=head1 HISTORY
+
+CONF_modules_free() was deprecated in OpenSSL 1.1.0.
+
 =cut