diff options
| author | Nicola Tuveri <nic.tuv@gmail.com> | 2021-01-22 18:50:12 +0200 |
|---|---|---|
| committer | Nicola Tuveri <nic.tuv@gmail.com> | 2021-02-17 13:20:46 +0200 |
| commit | 3a962b2093a6226daa26e4d1855d4eb9f2e5035b (patch) | |
| tree | 4133b9fc1da40473738924ecc695493b3e2ee77e /doc | |
| parent | 851b06b7055b2ab3eaf82f8989f8729920862b2f (diff) | |
[doc/man3][OSSL_ENCODER] Move NOTES to the bottom
For consistency with `OSSL_DECODER.pod`, and `man-pages(7)`, the `NOTES`
section is moved at the end of the file.
According to `man-pages(7)` the recommended section order is:
> NAME
> SYNOPSIS
> CONFIGURATION [Normally only in Section 4]
> DESCRIPTION
> OPTIONS [Normally only in Sections 1, 8]
> EXIT STATUS [Normally only in Sections 1, 8]
> RETURN VALUE [Normally only in Sections 2, 3]
> ERRORS [Typically only in Sections 2, 3]
> ENVIRONMENT
> FILES
> VERSIONS [Normally only in Sections 2, 3]
> CONFORMING TO
> NOTES
> BUGS
> EXAMPLE
> SEE ALSO
This commit does not attempt to fix the order in all pages but focuses
only on `OSSL_ENCODER` which has a "twin" man page in `OSSL_DECODER`,
making the inconsistent section order quite jarring.
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/13932)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man3/OSSL_ENCODER.pod | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/man3/OSSL_ENCODER.pod b/doc/man3/OSSL_ENCODER.pod index 14c4f0585b..da1aa475dc 100644 --- a/doc/man3/OSSL_ENCODER.pod +++ b/doc/man3/OSSL_ENCODER.pod @@ -87,12 +87,6 @@ OSSL_ENCODER_get_params() attempts to get parameters specified with an L<OSSL_PARAM(3)> array I<params>. Parameters that the implementation doesn't recognise should be ignored. -=head1 NOTES - -OSSL_ENCODER_fetch() may be called implicitly by other fetching -functions, using the same library context and properties. -Any other API that uses keys will typically do this. - =head1 RETURN VALUES OSSL_ENCODER_fetch() returns a pointer to the key management @@ -114,6 +108,12 @@ otherwise 0. OSSL_ENCODER_number() returns an integer. +=head1 NOTES + +OSSL_ENCODER_fetch() may be called implicitly by other fetching +functions, using the same library context and properties. +Any other API that uses keys will typically do this. + =head1 SEE ALSO L<provider(7)>, L<OSSL_ENCODER_CTX(3)>, L<OSSL_ENCODER_to_bio(3)>, |