Misc fix ups to deprecate explicit de-init documentation
[openssl.git] / doc / crypto / CONF_modules_free.pod
index af8ae6a..4a8580c 100644 (file)
@@ -2,16 +2,21 @@
 
 =head1 NAME
 
- CONF_modules_free, CONF_modules_load, CONF_modules_unload -
+ CONF_modules_free, CONF_modules_finish, CONF_modules_unload -
  OpenSSL configuration cleanup functions
 
 =head1 SYNOPSIS
 
  #include <openssl/conf.h>
 
- void CONF_modules_free(void);
- void CONF_modules_unload(int all);
  void CONF_modules_finish(void);
+ void CONF_modules_unload(int all);
+
+Deprecated:
+
+ #if OPENSSL_API_COMPAT < 0x10100000L
+ void CONF_modules_free(void)
+ #endif
 
 =head1 DESCRIPTION
 
@@ -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 exit to tidy up any configuration performed.
+From 1.1.0 CONF_modules_free() is deprecated and no explicit CONF cleanup is
+required at all. For more information see L<OPENSSL_init_crypto(3)>.
 
 =head1 RETURN VALUE
 
@@ -36,12 +43,11 @@ None of the functions return a value.
 
 =head1 SEE ALSO
 
-L<conf(5)|conf(5)>, L<OPENSSL_config(3)|OPENSSL_config(3)>,
-L<CONF_modules_load_file(3), CONF_modules_load_file(3)>
+L<conf(5)>, L<OPENSSL_config(3)>,
+L<CONF_modules_load_file(3)>
 
 =head1 HISTORY
 
-CONF_modules_free(), CONF_modules_unload(), and CONF_modules_finish()
-first appeared in OpenSSL 0.9.7.
+CONF_modules_free() was deprecated in OpenSSL 1.1.0.
 
 =cut