summaryrefslogtreecommitdiffstats
path: root/doc/internal
diff options
context:
space:
mode:
authorRichard Levitte <levitte@openssl.org>2019-07-02 14:57:36 +0200
committerRichard Levitte <levitte@openssl.org>2019-07-02 16:30:56 +0200
commit7c95390ef021e18d6b834cea9009d0d26b4642d5 (patch)
tree2aa4a2a481661f863670135b51f628939bba1cc9 /doc/internal
parent94f4d58a87eac9c6fe4cb46b998656bd6d6f03a5 (diff)
ossl_provider_upref to ossl_provider_up_ref
Common pattern is that the routines to increment the reference count are called something_up_ref, not something_upref. Adapt ossl_provider_upref() accordingly. Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/9293)
Diffstat (limited to 'doc/internal')
-rw-r--r--doc/internal/man3/evp_generic_fetch.pod12
-rw-r--r--doc/internal/man3/ossl_method_construct.pod2
-rw-r--r--doc/internal/man3/ossl_provider_new.pod8
3 files changed, 11 insertions, 11 deletions
diff --git a/doc/internal/man3/evp_generic_fetch.pod b/doc/internal/man3/evp_generic_fetch.pod
index 2679a7eba2..0688ac0170 100644
--- a/doc/internal/man3/evp_generic_fetch.pod
+++ b/doc/internal/man3/evp_generic_fetch.pod
@@ -13,7 +13,7 @@ evp_generic_fetch - generic algorithm fetcher and method creator for EVP
const char *name, const char *properties,
void *(*new_method)(const OSSL_DISPATCH *fns,
OSSL_PROVIDER *prov),
- int (*upref_method)(void *),
+ int (*up_ref_method)(void *),
void (*free_method)(void *));
=head1 DESCRIPTION
@@ -21,7 +21,7 @@ evp_generic_fetch - generic algorithm fetcher and method creator for EVP
evp_generic_fetch() calls ossl_method_construct() with the given
C<libctx>, C<operation_id>, C<name>, and C<properties> and uses
it to create an EVP method with the help of the functions
-C<new_method>, C<upref_method>, and C<free_method>.
+C<new_method>, C<up_ref_method>, and C<free_method>.
The three functions are supposed to:
@@ -32,7 +32,7 @@ The three functions are supposed to:
creates an internal method from function pointers found in the
dispatch table C<fns>.
-=item upref_method()
+=item up_ref_method()
increments the reference counter for the given method, if there is
one.
@@ -116,7 +116,7 @@ And here's the implementation of the FOO method fetcher:
}
foo->prov = prov;
if (prov)
- ossl_provider_upref(prov);
+ ossl_provider_up_ref(prov);
return foo;
}
@@ -137,7 +137,7 @@ And here's the implementation of the FOO method fetcher:
return EVP_FOO_meth_from_dispatch(fns, prov);
}
- static int foo_upref(void *vfoo)
+ static int foo_up_ref(void *vfoo)
{
EVP_FOO *foo = vfoo;
int ref = 0;
@@ -157,7 +157,7 @@ And here's the implementation of the FOO method fetcher:
{
EVP_FOO *foo =
evp_generic_fetch(ctx, OSSL_OP_FOO, name, properties,
- foo_from_dispatch, foo_upref, foo_free);
+ foo_from_dispatch, foo_up_ref, foo_free);
/*
* If this method exists in legacy form, with a constant NID for the
diff --git a/doc/internal/man3/ossl_method_construct.pod b/doc/internal/man3/ossl_method_construct.pod
index c3c7319c47..9beb7942f0 100644
--- a/doc/internal/man3/ossl_method_construct.pod
+++ b/doc/internal/man3/ossl_method_construct.pod
@@ -131,7 +131,7 @@ The associated provider object I<prov> is passed as well, to make
it possible for the sub-system constructor to keep a reference, which
is recommended.
If such a reference is kept, the I<provider object> reference counter
-must be incremented, using ossl_provider_upref().
+must be incremented, using ossl_provider_up_ref().
This function is expected to set the method's reference count to 1.
diff --git a/doc/internal/man3/ossl_provider_new.pod b/doc/internal/man3/ossl_provider_new.pod
index b1018e2957..cb40cb2cf9 100644
--- a/doc/internal/man3/ossl_provider_new.pod
+++ b/doc/internal/man3/ossl_provider_new.pod
@@ -2,7 +2,7 @@
=head1 NAME
-ossl_provider_find, ossl_provider_new, ossl_provider_upref,
+ossl_provider_find, ossl_provider_new, ossl_provider_up_ref,
ossl_provider_free,
ossl_provider_set_fallback, ossl_provider_set_module_path,
ossl_provider_add_parameter,
@@ -22,7 +22,7 @@ ossl_provider_get_params, ossl_provider_query_operation
OSSL_PROVIDER *ossl_provider_find(OPENSSL_CTX *libctx, const char *name);
OSSL_PROVIDER *ossl_provider_new(OPENSSL_CTX *libctx, const char *name,
ossl_provider_init_fn *init_function);
- int ossl_provider_upref(OSSL_PROVIDER *prov);
+ int ossl_provider_up_ref(OSSL_PROVIDER *prov);
void ossl_provider_free(OSSL_PROVIDER *prov);
/* Setters */
@@ -99,7 +99,7 @@ function.
For further description of the initialisation function, see the
description of ossl_provider_activate() below.
-ossl_provider_upref() increments the provider object I<prov>'s
+ossl_provider_up_ref() increments the provider object I<prov>'s
reference count.
ossl_provider_free() decrements the provider object I<prov>'s
@@ -220,7 +220,7 @@ of the built in macro B<MODULESDIR>.
ossl_provider_find() and ossl_provider_new() return a pointer to a
provider object (I<OSSL_PROVIDER>) on success, or NULL on error.
-ossl_provider_upref() returns the value of the reference count after
+ossl_provider_up_ref() returns the value of the reference count after
it has been incremented.
ossl_provider_free() doesn't return any value.