Hey guys,
It took me about an hour to fix all the documentation, pod2man fails in
several files.
The patch file is attached.
If the file can't be opened for whatever reasons, it's also on pastebin:
http://pastebin.com/7Qy5RcpN
Used the download link from yesterday for openssl-1.0.1g and applied the
fixes there.
Cheers,
~Christoph
diff -ur openssl-1.0.1g/doc/apps/cms.pod openssl-1.0.1g-docfixes/doc/apps/cms.pod
--- openssl-1.0.1g/doc/apps/cms.pod 2014-03-17 17:14:20.000000000 +0100
+++ openssl-1.0.1g-docfixes/doc/apps/cms.pod 2014-04-08 11:31:50.557385038 +0200
@@ -450,28 +450,28 @@
=over 4
-=item 0
+=item C<0>
the operation was completely successfully.
-=item 1
+=item C<1>
an error occurred parsing the command options.
-=item 2
+=item C<2>
one of the input files could not be read.
-=item 3
+=item C<3>
an error occurred creating the CMS file or when reading the MIME
message.
-=item 4
+=item C<4>
an error occurred decrypting or verifying the message.
-=item 5
+=item C<5>
the message was verified correctly but an error occurred writing out
the signers certificates.
diff -ur openssl-1.0.1g/doc/apps/smime.pod openssl-1.0.1g-docfixes/doc/apps/smime.pod
--- openssl-1.0.1g/doc/apps/smime.pod 2014-03-17 17:14:20.000000000 +0100
+++ openssl-1.0.1g-docfixes/doc/apps/smime.pod 2014-04-08 11:32:59.981382586 +0200
@@ -308,28 +308,28 @@
=over 4
-=item 0
+=item C<0>
the operation was completely successfully.
-=item 1
+=item C<1>
an error occurred parsing the command options.
-=item 2
+=item C<2>
one of the input files could not be read.
-=item 3
+=item C<3>
an error occurred creating the PKCS#7 file or when reading the MIME
message.
-=item 4
+=item C<4>
an error occurred decrypting or verifying the message.
-=item 5
+=item C<5>
the message was verified correctly but an error occurred writing out
the signers certificates.
diff -ur openssl-1.0.1g/doc/apps/ts.pod openssl-1.0.1g-docfixes/doc/apps/ts.pod
--- openssl-1.0.1g/doc/apps/ts.pod 2014-03-17 17:14:20.000000000 +0100
+++ openssl-1.0.1g-docfixes/doc/apps/ts.pod 2014-04-08 11:34:46.245378834 +0200
@@ -58,19 +58,19 @@
=over 4
-=item 1.
+=item C<1>
The TSA client computes a one-way hash value for a data file and sends
the hash to the TSA.
-=item 2.
+=item C<2>
The TSA attaches the current date and time to the received hash value,
signs them and sends the time stamp token back to the client. By
creating this token the TSA certifies the existence of the original
data file at the time of response generation.
-=item 3.
+=item C<3>
The TSA client receives the time stamp token and verifies the
signature on it. It also checks if the token contains the same hash
diff -ur openssl-1.0.1g/doc/crypto/rand.pod openssl-1.0.1g-docfixes/doc/crypto/rand.pod
--- openssl-1.0.1g/doc/crypto/rand.pod 2014-03-17 17:14:20.000000000 +0100
+++ openssl-1.0.1g-docfixes/doc/crypto/rand.pod 2014-04-08 11:36:57.005374217 +0200
@@ -74,16 +74,16 @@
=over 4
-=item 1
+=item C<1>
A good hashing algorithm to mix things up and to convert the RNG 'state'
to random numbers.
-=item 2
+=item C<2>
An initial source of random 'state'.
-=item 3
+=item C<3>
The state should be very large. If the RNG is being used to generate
4096 bit RSA keys, 2 2048 bit random strings are required (at a minimum).
@@ -93,13 +93,13 @@
a bad idea to keep quite a lot of RNG state. It should be easier to
break a cipher than guess the RNG seed data.
-=item 4
+=item C<4>
Any RNG seed data should influence all subsequent random numbers
generated. This implies that any random seed data entered will have
an influence on all subsequent random numbers generated.
-=item 5
+=item C<5>
When using data to seed the RNG state, the data used should not be
extractable from the RNG state. I believe this should be a
@@ -108,12 +108,12 @@
not be disclosed by either subsequent random numbers or a
'core' dump left by a program crash.
-=item 6
+=item C<6>
Given the same initial 'state', 2 systems should deviate in their RNG state
(and hence the random numbers generated) over time if at all possible.
-=item 7
+=item C<7>
Given the random number output stream, it should not be possible to determine
the RNG state or the next random number.
diff -ur openssl-1.0.1g/doc/ssl/SSL_accept.pod openssl-1.0.1g-docfixes/doc/ssl/SSL_accept.pod
--- openssl-1.0.1g/doc/ssl/SSL_accept.pod 2014-03-17 17:14:20.000000000 +0100
+++ openssl-1.0.1g-docfixes/doc/ssl/SSL_accept.pod 2014-04-08 11:48:55.717348839 +0200
@@ -44,13 +44,13 @@
=over 4
-=item 0
+=item C<0>
The TLS/SSL handshake was not successful but was shut down controlled and
by the specifications of the TLS/SSL protocol. Call SSL_get_error() with the
return value B<ret> to find out the reason.
-=item 1
+=item C<1>
The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been
established.
diff -ur openssl-1.0.1g/doc/ssl/SSL_clear.pod openssl-1.0.1g-docfixes/doc/ssl/SSL_clear.pod
--- openssl-1.0.1g/doc/ssl/SSL_clear.pod 2014-03-17 17:14:20.000000000 +0100
+++ openssl-1.0.1g-docfixes/doc/ssl/SSL_clear.pod 2014-04-08 11:44:00.941359248 +0200
@@ -56,12 +56,12 @@
=over 4
-=item 0
+=item C<0>
The SSL_clear() operation could not be performed. Check the error stack to
find out the reason.
-=item 1
+=item C<1>
The SSL_clear() operation was successful.
diff -ur openssl-1.0.1g/doc/ssl/SSL_COMP_add_compression_method.pod openssl-1.0.1g-docfixes/doc/ssl/SSL_COMP_add_compression_method.pod
--- openssl-1.0.1g/doc/ssl/SSL_COMP_add_compression_method.pod 2014-03-17 17:14:20.000000000 +0100
+++ openssl-1.0.1g-docfixes/doc/ssl/SSL_COMP_add_compression_method.pod 2014-04-08 11:39:40.476368445 +0200
@@ -53,11 +53,11 @@
=over 4
-=item 0
+=item C<0>
The operation succeeded.
-=item 1
+=item C<1>
The operation failed. Check the error queue to find out the reason.
diff -ur openssl-1.0.1g/doc/ssl/SSL_connect.pod openssl-1.0.1g-docfixes/doc/ssl/SSL_connect.pod
--- openssl-1.0.1g/doc/ssl/SSL_connect.pod 2014-03-17 17:14:20.000000000 +0100
+++ openssl-1.0.1g-docfixes/doc/ssl/SSL_connect.pod 2014-04-08 11:49:41.845347210 +0200
@@ -41,13 +41,13 @@
=over 4
-=item 0
+=item C<0>
The TLS/SSL handshake was not successful but was shut down controlled and
by the specifications of the TLS/SSL protocol. Call SSL_get_error() with the
return value B<ret> to find out the reason.
-=item 1
+=item C<1>
The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been
established.
diff -ur openssl-1.0.1g/doc/ssl/SSL_CTX_add_session.pod openssl-1.0.1g-docfixes/doc/ssl/SSL_CTX_add_session.pod
--- openssl-1.0.1g/doc/ssl/SSL_CTX_add_session.pod 2014-03-17 17:14:20.000000000 +0100
+++ openssl-1.0.1g-docfixes/doc/ssl/SSL_CTX_add_session.pod 2014-04-08 11:41:12.405365199 +0200
@@ -52,13 +52,13 @@
=over 4
-=item 0
+=item C<0>
The operation failed. In case of the add operation, it was tried to add
the same (identical) session twice. In case of the remove operation, the
session was not found in the cache.
-=item 1
+=item C<1>
The operation succeeded.
diff -ur openssl-1.0.1g/doc/ssl/SSL_CTX_load_verify_locations.pod openssl-1.0.1g-docfixes/doc/ssl/SSL_CTX_load_verify_locations.pod
--- openssl-1.0.1g/doc/ssl/SSL_CTX_load_verify_locations.pod 2014-03-17 17:14:20.000000000 +0100
+++ openssl-1.0.1g-docfixes/doc/ssl/SSL_CTX_load_verify_locations.pod 2014-04-08 11:42:28.485362513 +0200
@@ -100,13 +100,13 @@
=over 4
-=item 0
+=item C<0>
The operation failed because B<CAfile> and B<CApath> are NULL or the
processing at one of the locations specified failed. Check the error
stack to find out the reason.
-=item 1
+=item C<1>
The operation succeeded.
diff -ur openssl-1.0.1g/doc/ssl/SSL_CTX_set_client_CA_list.pod openssl-1.0.1g-docfixes/doc/ssl/SSL_CTX_set_client_CA_list.pod
--- openssl-1.0.1g/doc/ssl/SSL_CTX_set_client_CA_list.pod 2014-03-17 17:14:20.000000000 +0100
+++ openssl-1.0.1g-docfixes/doc/ssl/SSL_CTX_set_client_CA_list.pod 2014-04-08 11:43:39.661359999 +0200
@@ -66,13 +66,13 @@
=over 4
-=item 0
+=item C<0>
A failure while manipulating the STACK_OF(X509_NAME) object occurred or
the X509_NAME could not be extracted from B<cacert>. Check the error stack
to find out the reason.
-=item 1
+=item C<1>
The operation succeeded.
diff -ur openssl-1.0.1g/doc/ssl/SSL_CTX_set_session_id_context.pod openssl-1.0.1g-docfixes/doc/ssl/SSL_CTX_set_session_id_context.pod
--- openssl-1.0.1g/doc/ssl/SSL_CTX_set_session_id_context.pod 2014-03-17 17:14:20.000000000 +0100
+++ openssl-1.0.1g-docfixes/doc/ssl/SSL_CTX_set_session_id_context.pod 2014-04-08 11:44:37.141357970 +0200
@@ -64,13 +64,13 @@
=over 4
-=item 0
+=item C<0>
The length B<sid_ctx_len> of the session id context B<sid_ctx> exceeded
the maximum allowed length of B<SSL_MAX_SSL_SESSION_ID_LENGTH>. The error
is logged to the error stack.
-=item 1
+=item C<1>
The operation succeeded.
diff -ur openssl-1.0.1g/doc/ssl/SSL_CTX_set_ssl_version.pod openssl-1.0.1g-docfixes/doc/ssl/SSL_CTX_set_ssl_version.pod
--- openssl-1.0.1g/doc/ssl/SSL_CTX_set_ssl_version.pod 2014-03-17 17:14:20.000000000 +0100
+++ openssl-1.0.1g-docfixes/doc/ssl/SSL_CTX_set_ssl_version.pod 2014-04-08 11:46:14.389354536 +0200
@@ -42,11 +42,11 @@
=over 4
-=item 0
+=item C<0>
The new choice failed, check the error stack to find out the reason.
-=item 1
+=item C<1>
The operation succeeded.
diff -ur openssl-1.0.1g/doc/ssl/SSL_CTX_use_psk_identity_hint.pod openssl-1.0.1g-docfixes/doc/ssl/SSL_CTX_use_psk_identity_hint.pod
--- openssl-1.0.1g/doc/ssl/SSL_CTX_use_psk_identity_hint.pod 2014-03-17 17:14:20.000000000 +0100
+++ openssl-1.0.1g-docfixes/doc/ssl/SSL_CTX_use_psk_identity_hint.pod 2014-04-08 11:47:58.725350852 +0200
@@ -96,7 +96,7 @@
connection will fail with decryption_error before it will be finished
completely.
-=item 0
+=item C<0>
PSK identity was not found. An "unknown_psk_identity" alert message
will be sent and the connection setup fails.
diff -ur openssl-1.0.1g/doc/ssl/SSL_do_handshake.pod openssl-1.0.1g-docfixes/doc/ssl/SSL_do_handshake.pod
--- openssl-1.0.1g/doc/ssl/SSL_do_handshake.pod 2014-03-17 17:14:20.000000000 +0100
+++ openssl-1.0.1g-docfixes/doc/ssl/SSL_do_handshake.pod 2014-04-08 11:50:35.581345313 +0200
@@ -45,13 +45,13 @@
=over 4
-=item 0
+=item C<0>
The TLS/SSL handshake was not successful but was shut down controlled and
by the specifications of the TLS/SSL protocol. Call SSL_get_error() with the
return value B<ret> to find out the reason.
-=item 1
+=item C<1>
The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been
established.
diff -ur openssl-1.0.1g/doc/ssl/SSL_read.pod openssl-1.0.1g-docfixes/doc/ssl/SSL_read.pod
--- openssl-1.0.1g/doc/ssl/SSL_read.pod 2014-03-17 17:14:20.000000000 +0100
+++ openssl-1.0.1g-docfixes/doc/ssl/SSL_read.pod 2014-04-08 11:49:15.221348151 +0200
@@ -86,7 +86,7 @@
The read operation was successful; the return value is the number of
bytes actually read from the TLS/SSL connection.
-=item 0
+=item C<0>
The read operation was not successful. The reason may either be a clean
shutdown due to a "close notify" alert sent by the peer (in which case
diff -ur openssl-1.0.1g/doc/ssl/SSL_session_reused.pod openssl-1.0.1g-docfixes/doc/ssl/SSL_session_reused.pod
--- openssl-1.0.1g/doc/ssl/SSL_session_reused.pod 2014-03-17 17:14:20.000000000 +0100
+++ openssl-1.0.1g-docfixes/doc/ssl/SSL_session_reused.pod 2014-04-08 11:50:00.093346566 +0200
@@ -27,11 +27,11 @@
=over 4
-=item 0
+=item C<0>
A new session was negotiated.
-=item 1
+=item C<1>
A session was reused.
diff -ur openssl-1.0.1g/doc/ssl/SSL_set_fd.pod openssl-1.0.1g-docfixes/doc/ssl/SSL_set_fd.pod
--- openssl-1.0.1g/doc/ssl/SSL_set_fd.pod 2014-03-17 17:14:20.000000000 +0100
+++ openssl-1.0.1g-docfixes/doc/ssl/SSL_set_fd.pod 2014-04-08 11:50:14.141346070 +0200
@@ -35,11 +35,11 @@
=over 4
-=item 0
+=item C<0>
The operation failed. Check the error stack to find out why.
-=item 1
+=item C<1>
The operation succeeded.
diff -ur openssl-1.0.1g/doc/ssl/SSL_set_session.pod openssl-1.0.1g-docfixes/doc/ssl/SSL_set_session.pod
--- openssl-1.0.1g/doc/ssl/SSL_set_session.pod 2014-03-17 17:14:20.000000000 +0100
+++ openssl-1.0.1g-docfixes/doc/ssl/SSL_set_session.pod 2014-04-08 11:44:15.917358719 +0200
@@ -37,11 +37,11 @@
=over 4
-=item 0
+=item C<0>
The operation failed; check the error stack to find out the reason.
-=item 1
+=item C<1>
The operation succeeded.
diff -ur openssl-1.0.1g/doc/ssl/SSL_shutdown.pod openssl-1.0.1g-docfixes/doc/ssl/SSL_shutdown.pod
--- openssl-1.0.1g/doc/ssl/SSL_shutdown.pod 2014-03-17 17:14:20.000000000 +0100
+++ openssl-1.0.1g-docfixes/doc/ssl/SSL_shutdown.pod 2014-04-08 11:46:45.621353433 +0200
@@ -92,14 +92,14 @@
=over 4
-=item 0
+=item C<0>
The shutdown is not yet finished. Call SSL_shutdown() for a second time,
if a bidirectional shutdown shall be performed.
The output of L<SSL_get_error(3)|SSL_get_error(3)> may be misleading, as an
erroneous SSL_ERROR_SYSCALL may be flagged even though no error occurred.
-=item 1
+=item C<1>
The shutdown was successfully completed. The "close notify" alert was sent
and the peer's "close notify" alert was received.
diff -ur openssl-1.0.1g/doc/ssl/SSL_write.pod openssl-1.0.1g-docfixes/doc/ssl/SSL_write.pod
--- openssl-1.0.1g/doc/ssl/SSL_write.pod 2014-03-17 17:14:20.000000000 +0100
+++ openssl-1.0.1g-docfixes/doc/ssl/SSL_write.pod 2014-04-08 11:49:25.341347793 +0200
@@ -79,7 +79,7 @@
The write operation was successful, the return value is the number of
bytes actually written to the TLS/SSL connection.
-=item 0
+=item C<0>
The write operation was not successful. Probably the underlying connection
was closed. Call SSL_get_error() with the return value B<ret> to find out,
