Fix documenation mistakes
authorPauli <pauli@openssl.org>
Sat, 22 Oct 2022 03:09:06 +0000 (14:09 +1100)
committerPauli <pauli@openssl.org>
Wed, 16 Nov 2022 07:02:02 +0000 (18:02 +1100)
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/19377)

doc/internal/man3/DEFINE_LIST_OF.pod

index 311c200b7abc0fc5991c2dde07d861ed762d2070..d886defc43fb9fe16b6e9bedbd7b199e79247869 100644 (file)
@@ -51,55 +51,55 @@ The OSSL_LIST() macro returns the name for a list of the specified
 B<I<TYPE>>.  This is a structure which should be treated as opaque.
 
 DEFINE_LIST_OF() creates a set of functions for a list of B<I<TYPE>>
-elements with the name B<I<NAME>>.  The type is represented
-by B<OSSL_LIST>(B<I<NAME>>) and each function name begins with
-B<ossl_list_I<NAME>_>.  The list's linkages are stored in the
-B<OSSL_LIST_MEMBER>(B<I<NAME>>, B<I<TYPE>>) field.
+elements with the name B<I<TYPE>>.  The type is represented
+by B<OSSL_LIST>(B<I<TYPE>>) and each function name begins with
+B<ossl_list_I<TYPE>_>.  The list's linkages are stored in the
+B<OSSL_LIST_MEMBER>(B<I<TYPE>>, B<I<TYPE>>) field.
 
-B<ossl_list_I<NAME>_init>() initialises the memory pointed to by I<list>
+B<ossl_list_I<TYPE>_init>() initialises the memory pointed to by I<list>
 to zero which creates an empty list.
 
-B<ossl_list_I<NAME>_init_elem>() initialises the list related memory pointed
+B<ossl_list_I<TYPE>_init_elem>() initialises the list related memory pointed
 to by I<elem> to zero which allows it to be used in lists.
 
-B<ossl_list_I<NAME>_is_empty>() returns nonzero if I<list> has no elements and
+B<ossl_list_I<TYPE>_is_empty>() returns nonzero if I<list> has no elements and
 zero otherwise.
 
-B<ossl_list_I<NAME>_num>() returns the number of elements in I<list>.
+B<ossl_list_I<TYPE>_num>() returns the number of elements in I<list>.
 
-B<ossl_list_I<NAME>_head>() returns the first element in the I<list>
+B<ossl_list_I<TYPE>_head>() returns the first element in the I<list>
 or NULL if there are no elements.
 
-B<ossl_list_I<NAME>_tail>() returns the last element in the I<list>
+B<ossl_list_I<TYPE>_tail>() returns the last element in the I<list>
 or NULL if there are no elements.
 
-B<ossl_list_I<NAME>_remove>() removes the specified element I<elem> from
+B<ossl_list_I<TYPE>_remove>() removes the specified element I<elem> from
 the I<list>.  It is illegal to remove an element that isn't in the list.
 
-B<ossl_list_I<NAME>_insert_head>() inserts the element I<elem>, which
+B<ossl_list_I<TYPE>_insert_head>() inserts the element I<elem>, which
 must not be in the list, into the first position in the I<list>.
 
-B<ossl_list_I<NAME>_insert_tail>() inserts the element I<elem>, which
+B<ossl_list_I<TYPE>_insert_tail>() inserts the element I<elem>, which
 must not be in the list, into the last position in the I<list>.
 
-B<ossl_list_I<NAME>_insert_before>() inserts the element I<elem>,
+B<ossl_list_I<TYPE>_insert_before>() inserts the element I<elem>,
 which must not be in the list, into the I<list> immediately before the
 I<existing> element.
 
-B<ossl_list_I<NAME>_insert_after>() inserts the element I<elem>,
+B<ossl_list_I<TYPE>_insert_after>() inserts the element I<elem>,
 which must not be in the list, into the I<list> immediately after the
 I<existing> element.
 
 =head1 RETURN VALUES
 
-B<ossl_list_I<NAME>_is_empty>() returns nonzero if the list is empty and zero
+B<ossl_list_I<TYPE>_is_empty>() returns nonzero if the list is empty and zero
 otherwise.
 
-B<ossl_list_I<NAME>_num>() returns the number of elements in the
+B<ossl_list_I<TYPE>_num>() returns the number of elements in the
 list.
 
-B<ossl_list_I<NAME>_head>(), B<ossl_list_I<NAME>_tail>(),
-B<ossl_list_I<NAME>_next>() and B<ossl_list_I<NAME>_prev>() return
+B<ossl_list_I<TYPE>_head>(), B<ossl_list_I<TYPE>_tail>(),
+B<ossl_list_I<TYPE>_next>() and B<ossl_list_I<TYPE>_prev>() return
 the specified element in the list.
 
 =head1 EXAMPLES