From b4d3f203da6210f148b2a0c7bf5a802b55ba0e65 Mon Sep 17 00:00:00 2001 From: Richard Levitte Date: Fri, 7 Jun 2019 12:30:01 +0200 Subject: [PATCH] doc/internal/man3/ossl_method_construct.pod: follow common conventions Reviewed-by: Shane Lontis (Merged from https://github.com/openssl/openssl/pull/9109) --- doc/internal/man3/ossl_method_construct.pod | 40 ++++++++++----------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/doc/internal/man3/ossl_method_construct.pod b/doc/internal/man3/ossl_method_construct.pod index 02ccc17574..ecb99e080b 100644 --- a/doc/internal/man3/ossl_method_construct.pod +++ b/doc/internal/man3/ossl_method_construct.pod @@ -58,10 +58,10 @@ It's important to keep in mind that a method is identified by three things: =head2 Functions ossl_method_construct() creates a method by asking all available -providers for a dispatch table given an C, an algorithm -C and a set of C, and then calling the appropriate +providers for a dispatch table given an I, an algorithm +I and a set of I, and then calling the appropriate functions given by the sub-system specific method creator through -C and the data in C (which is passed by +I and the data in I (which is passed by ossl_method_construct()). This function assumes that the sub-system method creator implements @@ -73,14 +73,14 @@ appropriate). A central part of constructing a sub-system specific method is to give ossl_method_construct a set of functions, all in the -C structure, which holds the following +B structure, which holds the following function pointers: =over 4 =item alloc_tmp_store() -Create a temporary method store in the scope of the library context C. +Create a temporary method store in the scope of the library context I. This store is used to temporarily store methods for easier lookup, for when the provider doesn't want its dispatch table stored in a longer term cache. @@ -93,41 +93,41 @@ Remove a temporary store. Look up an already existing method from a store by name. -The store may be given with C. +The store may be given with I. B is a valid value and means that a sub-system default store must be used. -This default store should be stored in the library context C. +This default store should be stored in the library context I. The method to be looked up should be identified with the given -C, C, the provided property query C -and data from C (which is the C that was passed to +I, I, the provided property query I +and data from I (which is the I that was passed to ossl_construct_method()). This function is expected to increment the method's reference count. =item put() -Places the C created by the construct() function (see below) +Places the I created by the construct() function (see below) in a store. -The store may be given with C. +The store may be given with I. B is a valid value and means that a sub-system default store must be used. -This default store should be stored in the library context C. +This default store should be stored in the library context I. -The method should be associated with the given C, -C and property definition C as well as any -identification data given through C (which is the C +The method should be associated with the given I, +I and property definition I as well as any +identification data given through I (which is the I that was passed to ossl_construct_method()). -This function is expected to increment the C's reference count. +This function is expected to increment the I's reference count. =item construct() -Constructs a sub-system method for the given C and the given -dispatch table C. +Constructs a sub-system method for the given I and the given +dispatch table I. -The associated I C is passed as well, to make +The associated provider object I 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 reference counter @@ -137,7 +137,7 @@ This function is expected to set the method's reference count to 1. =item desctruct() -Decrement the C's reference count, and destruct it when +Decrement the I's reference count, and destruct it when the reference count reaches zero. =back -- 2.25.1