Deprecate CONF_modules_free() and make it a no-op
[openssl.git] / doc / crypto / CONF_modules_free.pod
1 =pod
2
3 =head1 NAME
4
5  CONF_modules_free, CONF_modules_finish, CONF_modules_unload -
6  OpenSSL configuration cleanup functions
7
8 =head1 SYNOPSIS
9
10  #include <openssl/conf.h>
11
12  void CONF_modules_finish(void);
13  void CONF_modules_unload(int all);
14
15 Deprecated:
16
17  #if OPENSSL_API_COMPAT < 0x10100000L
18  # define CONF_modules_free()
19  #endif
20
21 =head1 DESCRIPTION
22
23 CONF_modules_free() closes down and frees up all memory allocated by all
24 configuration modules.
25
26 CONF_modules_finish() calls each configuration modules B<finish> handler
27 to free up any configuration that module may have performed.
28
29 CONF_modules_unload() finishes and unloads configuration modules. If
30 B<all> is set to B<0> only modules loaded from DSOs will be unloads. If
31 B<all> is B<1> all modules, including builtin modules will be unloaded.
32
33 =head1 NOTES
34
35 Normally in versions of OpenSSL prior to 1.1.0 applications will only call
36 CONF_modules_free() at application to tidy up any configuration performed. From
37 1.1.0 CONF_modules_free() is deprecated an no explicit CONF cleanup as required
38 at all. For more information see L<OPENSSL_init_crypto(3)>.
39
40 =head1 RETURN VALUE
41
42 None of the functions return a value.
43
44 =head1 SEE ALSO
45
46 L<conf(5)>, L<OPENSSL_config(3)>,
47 L<CONF_modules_load_file(3)>
48
49 =head1 HISTORY
50
51 CONF_modules_free() was deprecated in OpenSSL 1.1.0.
52
53 =cut