diff options
author | Richard Levitte <levitte@openssl.org> | 2021-01-12 15:41:10 +0100 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2021-01-14 11:37:52 +0100 |
commit | f5f4fbaa44af055e0658c6810b91aa8607e8383a (patch) | |
tree | 8bd17b97515b1eafe1d2f42ef58a329d9ebb2f5c /doc/man3/OSSL_CMP_ITAV_set0.pod | |
parent | 4369a882a565c42673b28c586a5c46a8bca98d17 (diff) |
Make the OSSL_CMP manual conform with man-pages(7)
Details from man-pages(7) that are used:
Formatting conventions for manual pages describing functions
...
Variable names should, like argument names, be specified in italics.
...
Formatting conventions (general)
...
Special macros, which are usually in uppercase, are in bold.
Exception: don't boldface NULL.
...
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/13846)
Diffstat (limited to 'doc/man3/OSSL_CMP_ITAV_set0.pod')
-rw-r--r-- | doc/man3/OSSL_CMP_ITAV_set0.pod | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/man3/OSSL_CMP_ITAV_set0.pod b/doc/man3/OSSL_CMP_ITAV_set0.pod index 276daa7d51..cca4537fd8 100644 --- a/doc/man3/OSSL_CMP_ITAV_set0.pod +++ b/doc/man3/OSSL_CMP_ITAV_set0.pod @@ -29,21 +29,21 @@ ITAV is short for InfoTypeAndValue. This type is defined in RFC 4210 section 5.3.19 and Appendix F. It is used at various places in CMP messages, e.g., in the generalInfo PKIHeader field, to hold a key-value pair. -OSSL_CMP_ITAV_create() creates a new OSSL_CMP_ITAV structure and fills it in. -It combines B<OSSL_CMP_ITAV_new()> and B<OSSL_CMP_ITAV_set0>. +OSSL_CMP_ITAV_create() creates a new B<OSSL_CMP_ITAV> structure and fills it in. +It combines OSSL_CMP_ITAV_new() and OSSL_CMP_ITAV_set0(). -OSSL_CMP_ITAV_set0() sets the B<itav> with an infoType of B<type> and an -infoValue of B<value>. This function uses the pointers B<type> and B<value> +OSSL_CMP_ITAV_set0() sets the I<itav> with an infoType of I<type> and an +infoValue of I<value>. This function uses the pointers I<type> and I<value> internally, so they must B<not> be freed up after the call. OSSL_CMP_ITAV_get0_type() returns a direct pointer to the infoType in the -B<itav>. +I<itav>. OSSL_CMP_ITAV_get0_value() returns a direct pointer to the infoValue in -the B<itav> as generic ASN1_TYPE*. +the I<itav> as generic B<ASN1_TYPE> pointer. -OSSL_CMP_ITAV_push0_stack_item() pushes B<itav> to the stack pointed to -by B<*itav_sk_p>. It creates a new stack if B<*itav_sk_p> points to NULL. +OSSL_CMP_ITAV_push0_stack_item() pushes I<itav> to the stack pointed to +by I<*itav_sk_p>. It creates a new stack if I<*itav_sk_p> points to NULL. =head1 NOTES @@ -65,7 +65,7 @@ OSSL_CMP_ITAV_push0_stack_item() returns 1 on success, 0 on error. The following code creates and sets a structure representing a generic InfoTypeAndValue sequence, using an OID created from text as type, and an -integer as value. Afterwards, it is pushed to the OSSL_CMP_CTX to be later +integer as value. Afterwards, it is pushed to the B<OSSL_CMP_CTX> to be later included in the requests' PKIHeader's genInfo field. ASN1_OBJECT *type = OBJ_txt2obj("1.2.3.4.5", 1); |