From a9614a81c679d9c1bcc406f0174d9b9e9680500f Mon Sep 17 00:00:00 2001 From: Rich Salz Date: Thu, 23 Mar 2017 13:04:52 -0400 Subject: [PATCH] Look for comma before - in POD pages Reviewed-by: Richard Levitte (Merged from https://github.com/openssl/openssl/pull/3021) (cherry picked from commit 3ba4dac67a63c2d2589d46095d989b301cd62650) --- doc/crypto/ASN1_INTEGER_get_int64.pod | 3 ++- doc/crypto/CMS_add0_cert.pod | 3 ++- doc/crypto/CMS_get0_SignerInfos.pod | 2 +- doc/crypto/X509_digest.pod | 2 +- doc/ssl/SSL_SESSION_get_time.pod | 4 ++-- doc/ssl/SSL_SESSION_has_ticket.pod | 4 ++-- doc/ssl/SSL_library_init.pod | 4 ++-- util/find-doc-nits | 1 + 8 files changed, 13 insertions(+), 10 deletions(-) diff --git a/doc/crypto/ASN1_INTEGER_get_int64.pod b/doc/crypto/ASN1_INTEGER_get_int64.pod index 6fa1428c42..f61268d6ac 100644 --- a/doc/crypto/ASN1_INTEGER_get_int64.pod +++ b/doc/crypto/ASN1_INTEGER_get_int64.pod @@ -3,7 +3,8 @@ =head1 NAME ASN1_INTEGER_get_uint64, ASN1_INTEGER_set_uint64, -ASN1_INTEGER_get_int64, ASN1_INTEGER_get, ASN1_INTEGER_set_int64, ASN1_INTEGER_set, BN_to_ASN1_INTEGER, ASN1_INTEGER_to_BN, ASN1_ENUMERATED_get_int64, ASN1_ENUMERATED_get, ASN1_ENUMERATED_set_int64, ASN1_ENUMERATED_set, BN_to_ASN1_ENUMERATED, ASN1_ENUMERATED_to_BN, - ASN.1 INTEGER and ENUMERATED utilities +ASN1_INTEGER_get_int64, ASN1_INTEGER_get, ASN1_INTEGER_set_int64, ASN1_INTEGER_set, BN_to_ASN1_INTEGER, ASN1_INTEGER_to_BN, ASN1_ENUMERATED_get_int64, ASN1_ENUMERATED_get, ASN1_ENUMERATED_set_int64, ASN1_ENUMERATED_set, BN_to_ASN1_ENUMERATED, ASN1_ENUMERATED_to_BN +- ASN.1 INTEGER and ENUMERATED utilities =head1 SYNOPSIS diff --git a/doc/crypto/CMS_add0_cert.pod b/doc/crypto/CMS_add0_cert.pod index 5b0cc2a25c..a5be002de4 100644 --- a/doc/crypto/CMS_add0_cert.pod +++ b/doc/crypto/CMS_add0_cert.pod @@ -2,7 +2,8 @@ =head1 NAME -CMS_add0_cert, CMS_add1_cert, CMS_get1_certs, CMS_add0_crl, CMS_add1_crl, CMS_get1_crls, - CMS certificate and CRL utility functions +CMS_add0_cert, CMS_add1_cert, CMS_get1_certs, CMS_add0_crl, CMS_add1_crl, CMS_get1_crls +- CMS certificate and CRL utility functions =head1 SYNOPSIS diff --git a/doc/crypto/CMS_get0_SignerInfos.pod b/doc/crypto/CMS_get0_SignerInfos.pod index c8071591f3..e5532c96f4 100644 --- a/doc/crypto/CMS_get0_SignerInfos.pod +++ b/doc/crypto/CMS_get0_SignerInfos.pod @@ -4,7 +4,7 @@ CMS_SignerInfo_set1_signer_cert, CMS_get0_SignerInfos, CMS_SignerInfo_get0_signer_id, -CMS_SignerInfo_get0_signature, CMS_SignerInfo_cert_cmp, +CMS_SignerInfo_get0_signature, CMS_SignerInfo_cert_cmp - CMS signedData signer functions =head1 SYNOPSIS diff --git a/doc/crypto/X509_digest.pod b/doc/crypto/X509_digest.pod index 07cfda4908..6f78a5cbb1 100644 --- a/doc/crypto/X509_digest.pod +++ b/doc/crypto/X509_digest.pod @@ -6,7 +6,7 @@ X509_digest, X509_CRL_digest, X509_pubkey_digest, X509_NAME_digest, X509_REQ_digest -PKCS7_ISSUER_AND_SERIAL_digest, +PKCS7_ISSUER_AND_SERIAL_digest - get digest of various objects =head1 SYNOPSIS diff --git a/doc/ssl/SSL_SESSION_get_time.pod b/doc/ssl/SSL_SESSION_get_time.pod index d92a8efb10..ca08937eef 100644 --- a/doc/ssl/SSL_SESSION_get_time.pod +++ b/doc/ssl/SSL_SESSION_get_time.pod @@ -4,7 +4,7 @@ SSL_SESSION_get_time, SSL_SESSION_set_time, SSL_SESSION_get_timeout, SSL_SESSION_set_timeout -SSL_get_time, SSL_set_time, SSL_get_timeout, SSL_set_timeout, +SSL_get_time, SSL_set_time, SSL_get_timeout, SSL_set_timeout - retrieve and manipulate session time and timeout settings =head1 SYNOPSIS @@ -60,7 +60,7 @@ If any of the function is passed the NULL pointer for the session B, =head1 SEE ALSO -L, +L, L, L diff --git a/doc/ssl/SSL_SESSION_has_ticket.pod b/doc/ssl/SSL_SESSION_has_ticket.pod index 9e37255299..a84440b5ab 100644 --- a/doc/ssl/SSL_SESSION_has_ticket.pod +++ b/doc/ssl/SSL_SESSION_has_ticket.pod @@ -3,7 +3,7 @@ =head1 NAME SSL_SESSION_get0_ticket, -SSL_SESSION_has_ticket, SSL_SESSION_get_ticket_lifetime_hint, +SSL_SESSION_has_ticket, SSL_SESSION_get_ticket_lifetime_hint - get details about the ticket associated with a session =head1 SYNOPSIS @@ -31,7 +31,7 @@ may also become invalid as a result of a call to SSL_CTX_flush_sessions(). =head1 SEE ALSO -L, +L, L, L, L diff --git a/doc/ssl/SSL_library_init.pod b/doc/ssl/SSL_library_init.pod index 6b921f66e7..85768a1028 100644 --- a/doc/ssl/SSL_library_init.pod +++ b/doc/ssl/SSL_library_init.pod @@ -2,7 +2,7 @@ =head1 NAME -SSL_library_init, OpenSSL_add_ssl_algorithms, +SSL_library_init, OpenSSL_add_ssl_algorithms - initialize SSL library by registering algorithms =head1 SYNOPSIS @@ -37,7 +37,7 @@ value. =head1 SEE ALSO -L, +L, L =head1 HISTORY diff --git a/util/find-doc-nits b/util/find-doc-nits index cd2d32e04a..f14e36ed4a 100755 --- a/util/find-doc-nits +++ b/util/find-doc-nits @@ -59,6 +59,7 @@ sub name_synopsis() return unless $contents =~ /=head1 NAME(.*)=head1 SYNOPSIS/ms; my $tmp = $1; $tmp =~ tr/\n/ /; + print "$id trailing comma before - in NAME\n" if $tmp =~ /, *-/; $tmp =~ s/-.*//g; $tmp =~ s/,//g; -- 2.40.0