diff options
author | Richard Levitte <levitte@openssl.org> | 2019-09-28 08:07:18 +0200 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2019-10-01 22:31:30 +0200 |
commit | 723e9c8983f92bc256a7e8677cc02f05b47e227c (patch) | |
tree | f3fef2a633b61bfc9f2d6c1244bfe77556ecaacc /doc/man3/ASN1_INTEGER_get_int64.pod | |
parent | e8769719c9bbe53d7af088111b7625671660d4db (diff) |
Make ASN1 manuals 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: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/10042)
Diffstat (limited to 'doc/man3/ASN1_INTEGER_get_int64.pod')
-rw-r--r-- | doc/man3/ASN1_INTEGER_get_int64.pod | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/doc/man3/ASN1_INTEGER_get_int64.pod b/doc/man3/ASN1_INTEGER_get_int64.pod index da1e432a2c..cf0ff65686 100644 --- a/doc/man3/ASN1_INTEGER_get_int64.pod +++ b/doc/man3/ASN1_INTEGER_get_int64.pod @@ -37,7 +37,7 @@ These functions convert to and from B<ASN1_INTEGER> and B<ASN1_ENUMERATED> structures. ASN1_INTEGER_get_int64() converts an B<ASN1_INTEGER> into an B<int64_t> type -If successful it returns 1 and sets B<*pr> to the value of B<a>. If it fails +If successful it returns 1 and sets I<*pr> to the value of I<a>. If it fails (due to invalid type or the value being too big to fit into an B<int64_t> type) it returns 0. @@ -45,26 +45,26 @@ ASN1_INTEGER_get_uint64() is similar to ASN1_INTEGER_get_int64_t() except it converts to a B<uint64_t> type and an error is returned if the passed integer is negative. -ASN1_INTEGER_get() also returns the value of B<a> but it returns 0 if B<a> is +ASN1_INTEGER_get() also returns the value of I<a> but it returns 0 if I<a> is NULL and -1 on error (which is ambiguous because -1 is a legitimate value for an B<ASN1_INTEGER>). New applications should use ASN1_INTEGER_get_int64() instead. -ASN1_INTEGER_set_int64() sets the value of B<ASN1_INTEGER> B<a> to the -B<int64_t> value B<r>. +ASN1_INTEGER_set_int64() sets the value of B<ASN1_INTEGER> I<a> to the +B<int64_t> value I<r>. -ASN1_INTEGER_set_uint64() sets the value of B<ASN1_INTEGER> B<a> to the -B<uint64_t> value B<r>. +ASN1_INTEGER_set_uint64() sets the value of B<ASN1_INTEGER> I<a> to the +B<uint64_t> value I<r>. -ASN1_INTEGER_set() sets the value of B<ASN1_INTEGER> B<a> to the B<long> value -B<v>. +ASN1_INTEGER_set() sets the value of B<ASN1_INTEGER> I<a> to the I<long> value +I<v>. -BN_to_ASN1_INTEGER() converts B<BIGNUM> B<bn> to an B<ASN1_INTEGER>. If B<ai> -is NULL a new B<ASN1_INTEGER> structure is returned. If B<ai> is not NULL then +BN_to_ASN1_INTEGER() converts B<BIGNUM> I<bn> to an B<ASN1_INTEGER>. If I<ai> +is NULL a new B<ASN1_INTEGER> structure is returned. If I<ai> is not NULL then the existing structure will be used instead. -ASN1_INTEGER_to_BN() converts ASN1_INTEGER B<ai> into a B<BIGNUM>. If B<bn> is -NULL a new B<BIGNUM> structure is returned. If B<bn> is not NULL then the +ASN1_INTEGER_to_BN() converts ASN1_INTEGER I<ai> into a B<BIGNUM>. If I<bn> is +NULL a new B<BIGNUM> structure is returned. If I<bn> is not NULL then the existing structure will be used instead. ASN1_ENUMERATED_get_int64(), ASN1_ENUMERATED_set_int64(), @@ -72,8 +72,8 @@ ASN1_ENUMERATED_set(), BN_to_ASN1_ENUMERATED() and ASN1_ENUMERATED_to_BN() behave in an identical way to their ASN1_INTEGER counterparts except they operate on an B<ASN1_ENUMERATED> value. -ASN1_ENUMERATED_get() returns the value of B<a> in a similar way to -ASN1_INTEGER_get() but it returns B<0xffffffffL> if the value of B<a> will not +ASN1_ENUMERATED_get() returns the value of I<a> in a similar way to +ASN1_INTEGER_get() but it returns B<0xffffffffL> if the value of I<a> will not fit in a long type. New applications should use ASN1_ENUMERATED_get_int64() instead. |