aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRich Salz <rsalz@openssl.org>2016-05-31 12:20:08 -0400
committerRich Salz <rsalz@openssl.org>2016-06-01 11:31:14 -0400
commitff3bb913cfe47104293138a17014d3bde9db5e32 (patch)
tree28986f84c51f73f8cc91040969ecf6dfa2721b76 /doc
parent0634424f7c65d76e342eee4e3359f48d3fe2fa9a (diff)
downloadopenssl-ff3bb913cfe47104293138a17014d3bde9db5e32.tar.gz
Fix nits in crypto.pod,ssl.pod
After this merge, the only things left (from doc-nit-check) is 74 pages without a "RETURN VALUES" section. Reviewed-by: Richard Levitte <levitte@openssl.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/crypto/crypto.pod12
-rw-r--r--doc/ssl/ssl.pod8
2 files changed, 16 insertions, 4 deletions
diff --git a/doc/crypto/crypto.pod b/doc/crypto/crypto.pod
index 7870fb80e2..819cc892d5 100644
--- a/doc/crypto/crypto.pod
+++ b/doc/crypto/crypto.pod
@@ -4,6 +4,10 @@
crypto - OpenSSL cryptographic library
+=head1 SYNOPSIS
+
+See the individual manual pages for details.
+
=head1 DESCRIPTION
The OpenSSL B<crypto> library implements a wide range of cryptographic
@@ -12,8 +16,6 @@ by this library are used by the OpenSSL implementations of SSL, TLS
and S/MIME, and they have also been used to implement SSH, OpenPGP, and
other cryptographic standards.
-=head1 OVERVIEW
-
B<libcrypto> consists of a number of sub-libraries that implement the
individual algorithms.
@@ -22,8 +24,6 @@ cryptography and key agreement, certificate handling, cryptographic
hash functions, cryptographic pseudo-random number generator, and
various utilities.
-See the individual manual pages for details.
-
=head1 NOTES
Some of the newer functions follow a naming convention using the numbers
@@ -40,6 +40,10 @@ The B<1> function uses a copy of the supplied structure pointer
(or in some cases increases its link count) in the parent and
so both (B<x> and B<obj> above) should be freed up.
+=head1 RETURN VALUES
+
+See the individual manual pages for details.
+
=head1 SEE ALSO
L<openssl(1)>, L<ssl(3)>
diff --git a/doc/ssl/ssl.pod b/doc/ssl/ssl.pod
index ee147810fd..9a95019930 100644
--- a/doc/ssl/ssl.pod
+++ b/doc/ssl/ssl.pod
@@ -4,6 +4,10 @@
SSL - OpenSSL SSL/TLS library
+=head1 SYNOPSIS
+
+See the individual manual pages for details.
+
=head1 DESCRIPTION
The OpenSSL B<ssl> library implements the Secure Sockets Layer (SSL v2/v3) and
@@ -718,6 +722,10 @@ Returns the current handshake state.
=back
+=head1 RETURN VALUES
+
+See the individual manual pages for details.
+
=head1 SEE ALSO
L<openssl(1)>, L<crypto(3)>,