Commit b5c4bbbe authored by Joshua Lock's avatar Joshua Lock Committed by Richard Levitte
Browse files

Update various man pages to place HISTORY section after SEE ALSO 



SEE ALSO before HISTORY is the more common pattern in OpenSSL manual
pages and seems to be the prevalent order based on sampling my system
manual pages.

Fixes #8631

Reviewed-by: default avatarMatthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
Reviewed-by: default avatarRichard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/8729)
parent 573ac8f2

doc/man3/BIO_connect.pod

+5 −5
Original line number Diff line number Diff line
@@ -95,19 +95,19 @@ B<INVALID_SOCKET> (-1) on error. When an error has occurred, the 
OpenSSL error stack will hold the error data and errno has the system

error.



=head1 SEE ALSO



L<BIO_ADDR(3)>



=head1 HISTORY



BIO_gethostname(), BIO_get_port(), BIO_get_host_ip(),

BIO_get_accept_socket() and BIO_accept() were deprecated in

OpenSSL 1.1.0.  Use the functions described above instead.



=head1 SEE ALSO



L<BIO_ADDR(3)>



=head1 COPYRIGHT



Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.

Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved.



Licensed under the Apache License 2.0 (the "License").  You may not use

this file except in compliance with the License.  You can obtain a copy

doc/man3/BN_rand.pod

+10 −10
Original line number Diff line number Diff line
@@ -59,6 +59,15 @@ seeded with enough randomness to ensure an unpredictable byte sequence. 
The functions return 1 on success, 0 on error.

The error codes can be obtained by L<ERR_get_error(3)>.



=head1 SEE ALSO



L<ERR_get_error(3)>,

L<RAND_add(3)>,

L<RAND_bytes(3)>,

L<RAND_priv_bytes(3)>,

L<RAND(7)>,

L<RAND_DRBG(7)>



=head1 HISTORY



=over 2
@@ -78,18 +87,9 @@ BN_priv_rand() and BN_priv_rand_range() functions were added in OpenSSL 1.1.1. 


=back



=head1 SEE ALSO



L<ERR_get_error(3)>,

L<RAND_add(3)>,

L<RAND_bytes(3)>,

L<RAND_priv_bytes(3)>,

L<RAND(7)>,

L<RAND_DRBG(7)>



=head1 COPYRIGHT



Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.

Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.



Licensed under the Apache License 2.0 (the "License").  You may not use

this file except in compliance with the License.  You can obtain a copy

doc/man3/BN_security_bits.pod

+5 −5
Original line number Diff line number Diff line
@@ -31,17 +31,17 @@ Number of security bits. 
ECC (Elliptic Curve Cryptography) is not covered by the BN_security_bits()

function. The symmetric algorithms are not covered neither.



=head1 HISTORY



The BN_security_bits() function was added in OpenSSL 1.1.0.



=head1 SEE ALSO



L<DH_security_bits(3)>, L<DSA_security_bits(3)>, L<RSA_security_bits(3)>



=head1 HISTORY



The BN_security_bits() function was added in OpenSSL 1.1.0.



=head1 COPYRIGHT



Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.

Copyright 2017-2019 The OpenSSL Project Authors. All Rights Reserved.



Licensed under the Apache License 2.0 (the "License").  You may not use

this file except in compliance with the License.  You can obtain a copy

doc/man3/DES_random_key.pod

+6 −6
Original line number Diff line number Diff line
@@ -296,6 +296,11 @@ last 4 bytes of the checksum of the input. 
DES_fcrypt() returns a pointer to the caller-provided buffer and DES_crypt() -

to a static buffer on success; otherwise they return NULL.



=head1 SEE ALSO



L<des_modes(7)>,

L<EVP_EncryptInit(3)>



=head1 HISTORY



The requirement that the B<salt> parameter to DES_crypt() and DES_fcrypt()
@@ -304,14 +309,9 @@ OpenSSL 1.1.0. Previous versions tried to use the letter uppercase B<A> 
if both character were not present, and could crash when given non-ASCII

on some platforms.



=head1 SEE ALSO



L<des_modes(7)>,

L<EVP_EncryptInit(3)>



=head1 COPYRIGHT



Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.

Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.



Licensed under the Apache License 2.0 (the "License").  You may not use

this file except in compliance with the License.  You can obtain a copy

doc/man3/PEM_read_bio_PrivateKey.pod

+6 −6
Original line number Diff line number Diff line
@@ -459,20 +459,20 @@ Skeleton pass phrase callback: 
     return len;

 }



=head1 SEE ALSO



L<EVP_EncryptInit(3)>, L<EVP_BytesToKey(3)>,

L<passphrase-encoding(7)>



=head1 HISTORY



The old Netscape certificate sequences were no longer documented

in OpenSSL 1.1.0; applications should use the PKCS7 standard instead

as they will be formally deprecated in a future releases.



=head1 SEE ALSO



L<EVP_EncryptInit(3)>, L<EVP_BytesToKey(3)>,

L<passphrase-encoding(7)>



=head1 COPYRIGHT



Copyright 2001-2018 The OpenSSL Project Authors. All Rights Reserved.

Copyright 2001-2019 The OpenSSL Project Authors. All Rights Reserved.



Licensed under the Apache License 2.0 (the "License").  You may not use

this file except in compliance with the License.  You can obtain a copy