diff options
| author | Rich Salz <rsalz@openssl.org> | 2016-06-12 21:49:40 -0400 |
|---|---|---|
| committer | Rich Salz <rsalz@openssl.org> | 2016-06-14 12:30:37 -0400 |
| commit | cda3ae5bd0798c56fef5a5c1462d51ca1776504e (patch) | |
| tree | 3fcc90ce98682102ec3c07e65c7e086a7d70a603 /doc | |
| parent | 036e61b1669fee477af2d5d1afd0b015517f7f9a (diff) | |
| download | openssl-cda3ae5bd0798c56fef5a5c1462d51ca1776504e.tar.gz | |
RT4562: Fix misleading doc on OPENSSL_config
Also changed the code to use "appname" not "filename"
Reviewed-by: Matt Caswell <matt@openssl.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/crypto/OPENSSL_config.pod | 11 | ||||
| -rw-r--r-- | doc/crypto/OPENSSL_init_crypto.pod | 12 |
2 files changed, 12 insertions, 11 deletions
diff --git a/doc/crypto/OPENSSL_config.pod b/doc/crypto/OPENSSL_config.pod index 1a8af869c0..eae634a8fa 100644 --- a/doc/crypto/OPENSSL_config.pod +++ b/doc/crypto/OPENSSL_config.pod @@ -8,15 +8,16 @@ OPENSSL_config, OPENSSL_no_config - simple OpenSSL configuration functions #include <openssl/conf.h> - void OPENSSL_config(const char *config_name); + #if OPENSSL_API_COMPAT < 0x10100000L + void OPENSSL_config(const char *appname); void OPENSSL_no_config(void); + #endif =head1 DESCRIPTION -OPENSSL_config() configures OpenSSL using the standard B<openssl.cnf> -configuration file name using B<config_name>. If B<config_name> is NULL then -the file specified in the environment variable B<OPENSSL_CONF> will be used, -and if that is not set then a system default location is used. +OPENSSL_config() configures OpenSSL using the standard B<openssl.cnf> and +reads from the application section B<appname>. If B<appname> is NULL then +the default section, B<openssl_conf>, will be used. Errors are silently ignored. Multiple calls have no effect. diff --git a/doc/crypto/OPENSSL_init_crypto.pod b/doc/crypto/OPENSSL_init_crypto.pod index a35325b3f2..ff2c2e8282 100644 --- a/doc/crypto/OPENSSL_init_crypto.pod +++ b/doc/crypto/OPENSSL_init_crypto.pod @@ -16,8 +16,8 @@ initialisation and deinitialisation functions void OPENSSL_thread_stop(void); OPENSSL_INIT_SETTINGS *OPENSSL_init_new(void); - int OPENSSL_INIT_set_config_filename(OPENSSL_INIT_SETTINGS *init, - const char* name); + int OPENSSL_INIT_set_config_appname(OPENSSL_INIT_SETTINGS *init, + const char* name); void OPENSSL_INIT_free(OPENSSL_INIT_SETTINGS *init); =head1 DESCRIPTION @@ -191,8 +191,8 @@ described in the NOTES section below. The B<OPENSSL_INIT_LOAD_CONFIG> flag will load a default configuration file. To specify a different file, an B<OPENSSL_INIT_SETTINGS> must be created and used. The routines -OPENSSL_init_new() and OPENSSL_INIT_set_config_filename() can be used to -allocate the object and set the configuration filename, and then the +OPENSSL_init_new() and OPENSSL_INIT_set_config_appname() can be used to +allocate the object and set the application name, and then the object can be released with OPENSSL_INIT_free() when done. =head1 NOTES @@ -220,7 +220,7 @@ call should use the RTLD_NODELETE flag (where available on the platform). =head1 RETURN VALUES The functions OPENSSL_init_crypto, OPENSSL_atexit() and -OPENSSL_INIT_set_config_filename() return 1 on success or 0 on error. +OPENSSL_INIT_set_config_appname() return 1 on success or 0 on error. =head1 SEE ALSO @@ -229,7 +229,7 @@ L<OPENSSL_init_ssl(3)> =head1 HISTORY The OPENSSL_init_crypto(), OPENSSL_cleanup(), OPENSSL_atexit(), -OPENSSL_thread_stop(), OPENSSL_init_new(), OPENSSL_INIT_set_config_filename() +OPENSSL_thread_stop(), OPENSSL_init_new(), OPENSSL_INIT_set_config_appname() and OPENSSL_INIT_free() functions were added in OpenSSL 1.1.0. =head1 COPYRIGHT |