From: Rich Salz <rsalz@openssl.org>
Date: Tue, 31 May 2016 16:20:08 +0000 (-0400)
Subject: Fix nits in crypto.pod,ssl.pod
X-Git-Tag: OpenSSL_1_1_0-pre6~613
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=ff3bb913cfe47104293138a17014d3bde9db5e32;p=oweals%2Fopenssl.git

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>
---

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)>,