diff options
author | Dr. Matthias St. Pierre <matthias.st.pierre@ncp-e.com> | 2020-10-15 12:55:50 +0300 |
---|---|---|
committer | Matt Caswell <matt@openssl.org> | 2020-10-15 12:00:21 +0100 |
commit | a829b735b645516041b55746e013692babd8cd31 (patch) | |
tree | dcc8bd43fe6eb5b1893ce77b73090bd4e6b5c4b1 /doc | |
parent | b425001010044adbdbcd98f8682694b30b73bbf4 (diff) |
Rename some occurrences of 'library_context' and 'lib_ctx' to 'libctx'
This change makes the naming more consistent, because three different terms
were used for the same thing. (The term libctx was used by far most often.)
Reviewed-by: Paul Dale <paul.dale@oracle.com>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/12621)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/internal/man3/ossl_provider_new.pod | 8 | ||||
-rw-r--r-- | doc/man7/provider-base.pod | 6 |
2 files changed, 7 insertions, 7 deletions
diff --git a/doc/internal/man3/ossl_provider_new.pod b/doc/internal/man3/ossl_provider_new.pod index a0a7631d15..dc7717062c 100644 --- a/doc/internal/man3/ossl_provider_new.pod +++ b/doc/internal/man3/ossl_provider_new.pod @@ -11,7 +11,7 @@ ossl_provider_ctx, ossl_provider_forall_loaded, ossl_provider_name, ossl_provider_dso, ossl_provider_module_name, ossl_provider_module_path, -ossl_provider_library_context, +ossl_provider_libctx, ossl_provider_teardown, ossl_provider_gettable_params, ossl_provider_get_params, ossl_provider_query_operation, ossl_provider_set_operation_bit, ossl_provider_test_operation_bit, @@ -55,7 +55,7 @@ ossl_provider_get_capabilities const DSO *ossl_provider_dso(OSSL_PROVIDER *prov); const char *ossl_provider_module_name(OSSL_PROVIDER *prov); const char *ossl_provider_module_path(OSSL_PROVIDER *prov); - OSSL_LIB_CTX *ossl_provider_library_context(const OSSL_PROVIDER *prov); + OSSL_LIB_CTX *ossl_provider_libctx(const OSSL_PROVIDER *prov); /* Thin wrappers around calls to the provider */ void ossl_provider_teardown(const OSSL_PROVIDER *prov); @@ -144,7 +144,7 @@ This will be used in preference to automatically trying to figure out the path from the provider name and the default module directory (more on this in L</NOTES>). -ossl_provider_library_context() returns the library context the given +ossl_provider_libctx() returns the library context the given provider I<prov> is registered in. ossl_provider_add_parameter() adds a global parameter for the provider @@ -280,7 +280,7 @@ ossl_provider_module_name(), and ossl_provider_module_path() return a pointer to their respective data if it's available, otherwise NULL is returned. -ossl_provider_library_context() return a pointer to the library context. +ossl_provider_libctx() return a pointer to the library context. This may be NULL, and is perfectly valid, as it denotes the default global library context. diff --git a/doc/man7/provider-base.pod b/doc/man7/provider-base.pod index b92f117d86..536c5ed430 100644 --- a/doc/man7/provider-base.pod +++ b/doc/man7/provider-base.pod @@ -20,7 +20,7 @@ provider-base int core_get_params(const OSSL_CORE_HANDLE *handle, OSSL_PARAM params[]); int core_thread_start(const OSSL_CORE_HANDLE *handle, OSSL_thread_stop_handler_fn handfn); - OPENSSL_CORE_CTX *core_get_library_context(const OSSL_CORE_HANDLE *handle); + OPENSSL_CORE_CTX *core_get_libctx(const OSSL_CORE_HANDLE *handle); void core_new_error(const OSSL_CORE_HANDLE *handle); void core_set_error_debug(const OSSL_CORE_HANDLE *handle, const char *file, int line, const char *func); @@ -104,7 +104,7 @@ provider): core_gettable_params OSSL_FUNC_CORE_GETTABLE_PARAMS core_get_params OSSL_FUNC_CORE_GET_PARAMS core_thread_start OSSL_FUNC_CORE_THREAD_START - core_get_library_context OSSL_FUNC_CORE_GET_LIBRARY_CONTEXT + core_get_libctx OSSL_FUNC_CORE_GET_LIBCTX core_new_error OSSL_FUNC_CORE_NEW_ERROR core_set_error_debug OSSL_FUNC_CORE_SET_ERROR_DEBUG core_set_error OSSL_FUNC_CORE_SET_ERROR @@ -152,7 +152,7 @@ parameters. =for comment core_thread_start() TBA -core_get_library_context() retrieves the library context in which the library +core_get_libctx() retrieves the library context in which the library object for the current provider is stored, accessible through the I<handle>. This may sometimes be useful if the provider wishes to store a reference to its context in the same library context. |