[openssl] master update
nic.tuv at gmail.com
nic.tuv at gmail.com
Wed Feb 17 11:27:11 UTC 2021
The branch master has been updated
via 3a962b2093a6226daa26e4d1855d4eb9f2e5035b (commit)
via 851b06b7055b2ab3eaf82f8989f8729920862b2f (commit)
from 68883d9db86534176d744c7691ac7565f5def884 (commit)
- Log -----------------------------------------------------------------
commit 3a962b2093a6226daa26e4d1855d4eb9f2e5035b
Author: Nicola Tuveri <nic.tuv at gmail.com>
Date: Fri Jan 22 18:50:12 2021 +0200
[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 at openssl.org>
(Merged from https://github.com/openssl/openssl/pull/13932)
commit 851b06b7055b2ab3eaf82f8989f8729920862b2f
Author: Nicola Tuveri <nic.tuv at gmail.com>
Date: Fri Jan 22 18:45:07 2021 +0200
[doc/man3] Fix typo in DESCRIPTION of OSSL_ENCODER_properties
This commit fixes the DECSCRIPTION section of doc/man3/OSSL_ENCODER.pod,
where `OSSL_ENCODER_properties` was incorrectly referred to as
`OSSL_ENCODER_provider`.
Reviewed-by: Tomas Mraz <tomas at openssl.org>
(Merged from https://github.com/openssl/openssl/pull/13932)
-----------------------------------------------------------------------
Summary of changes:
doc/man3/OSSL_ENCODER.pod | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/doc/man3/OSSL_ENCODER.pod b/doc/man3/OSSL_ENCODER.pod
index a9da0aaff3..da1aa475dc 100644
--- a/doc/man3/OSSL_ENCODER.pod
+++ b/doc/man3/OSSL_ENCODER.pod
@@ -63,7 +63,7 @@ I<encoder>, and when the count reaches zero, frees it.
OSSL_ENCODER_provider() returns the provider of the given
I<encoder>.
-OSSL_ENCODER_provider() returns the property definition associated
+OSSL_ENCODER_properties() returns the property definition associated
with the given I<encoder>.
OSSL_ENCODER_is_a() checks if I<encoder> is an implementation of an
@@ -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)>,
More information about the openssl-commits
mailing list