[openssl] master update
Richard Levitte
levitte at openssl.org
Fri Jul 19 18:17:15 UTC 2019
The branch master has been updated
via 3cb45a55853db05d5af1b564a55491a22f592305 (commit)
via f6800e37b762563e79115ebdb233c0c07afc23e5 (commit)
from 76ca35e7246b0071040cd242de06154c0195bcff (commit)
- Log -----------------------------------------------------------------
commit 3cb45a55853db05d5af1b564a55491a22f592305
Author: Richard Levitte <levitte at openssl.org>
Date: Thu Jul 18 09:19:43 2019 +0200
doc: fix some links
Some links are aged and need an adjustment.
Reviewed-by: Matt Caswell <matt at openssl.org>
(Merged from https://github.com/openssl/openssl/pull/9407)
commit f6800e37b762563e79115ebdb233c0c07afc23e5
Author: Richard Levitte <levitte at openssl.org>
Date: Thu Jul 18 09:03:18 2019 +0200
util/find-doc-nits: fixups
- Treat .pod.in files as well, and parse out the base name for those
too.
- Correct the detection of the description part in the NAME section
(the separating dash MUST be preceeded with a space)
- Allow slahes in names of the NAME section (convert them to dashes
for file name comparison). This allows manual pages for some of our
header files, such as openssl/core.h.
- Properly detect repeated names in the NAME section.
Reviewed-by: Matt Caswell <matt at openssl.org>
(Merged from https://github.com/openssl/openssl/pull/9407)
-----------------------------------------------------------------------
Summary of changes:
doc/man3/EVP_KDF_CTX.pod | 2 +-
doc/man3/EVP_MD_fetch.pod | 2 +-
doc/man3/EVP_PKEY_CTX_set_scrypt_N.pod | 7 +++++--
doc/man3/OSSL_PARAM.pod | 2 +-
doc/man3/OSSL_trace_set_channel.pod | 2 ++
doc/man7/x509.pod | 1 -
util/find-doc-nits | 29 +++++++++++++++++------------
7 files changed, 27 insertions(+), 18 deletions(-)
diff --git a/doc/man3/EVP_KDF_CTX.pod b/doc/man3/EVP_KDF_CTX.pod
index e65becf..1ae79bc 100644
--- a/doc/man3/EVP_KDF_CTX.pod
+++ b/doc/man3/EVP_KDF_CTX.pod
@@ -278,7 +278,7 @@ L<EVP_KDF_HKDF(7)>
L<EVP_KDF_SS(7)>
L<EVP_KDF_SSHKDF(7)>
L<EVP_KDF_X963(7)>
-L<EVP_KDF_X942KDF(7)>
+L<EVP_KDF_X942(7)>
=head1 HISTORY
diff --git a/doc/man3/EVP_MD_fetch.pod b/doc/man3/EVP_MD_fetch.pod
index 11390d0..98e4c84 100644
--- a/doc/man3/EVP_MD_fetch.pod
+++ b/doc/man3/EVP_MD_fetch.pod
@@ -69,7 +69,7 @@ the default provider unless the default search criteria have been changed and/or
different providers have been loaded.
Implicit fetching can also occur with functions such as
-L<EVP_PKEY_CTX_derive_init_ex(3)> where a NULL algorithm parameter is supplied.
+L<EVP_PKEY_derive_init_ex(3)> where a NULL algorithm parameter is supplied.
In this case an algorithm implementation is implicitly fetched using default
search criteria and an algorithm name that is consistent with the type of
EVP_PKEY being used.
diff --git a/doc/man3/EVP_PKEY_CTX_set_scrypt_N.pod b/doc/man3/EVP_PKEY_CTX_set_scrypt_N.pod
index e9ca351..dfde4ff 100644
--- a/doc/man3/EVP_PKEY_CTX_set_scrypt_N.pod
+++ b/doc/man3/EVP_PKEY_CTX_set_scrypt_N.pod
@@ -29,7 +29,7 @@ EVP_PKEY_CTX_set_scrypt_maxmem_bytes
These functions are used to set up the necessary data to use the
scrypt KDF.
-For more information on scrypt, see L<scrypt(7)>.
+For more information on scrypt, see L<EVP_KDF_SCRYPT(7)>.
EVP_PKEY_CTX_set1_scrypt_salt() sets the B<saltlen> bytes long salt
value.
@@ -54,6 +54,9 @@ respectively.
=head1 NOTES
+There is a newer generic API for KDFs, L<EVP_KDF(3)>, which is
+preferred over the EVP_PKEY method.
+
The scrypt KDF also uses EVP_PKEY_CTX_set1_pbe_pass() as well as
the value from the string controls "pass" and "hexpass".
See L<EVP_PKEY_CTX_set1_pbe_pass(3)>.
@@ -69,7 +72,7 @@ supported by the public key algorithm.
=head1 SEE ALSO
-L<scrypt(7)>,
+L<EVP_KDF(3)>
L<EVP_PKEY_CTX_new(3)>,
L<EVP_PKEY_CTX_ctrl_str(3)>,
L<EVP_PKEY_derive(3)>
diff --git a/doc/man3/OSSL_PARAM.pod b/doc/man3/OSSL_PARAM.pod
index fbe37b4..0f6358c 100644
--- a/doc/man3/OSSL_PARAM.pod
+++ b/doc/man3/OSSL_PARAM.pod
@@ -285,7 +285,7 @@ could fill in the parameters like this:
=head1 SEE ALSO
-L<openssl-core.h(7)>, L<OSSL_PARAM_get_int32_t(3)>
+L<openssl-core.h(7)>, L<OSSL_PARAM_get_int(3)>
=head1 HISTORY
diff --git a/doc/man3/OSSL_trace_set_channel.pod b/doc/man3/OSSL_trace_set_channel.pod
index 9c03218..6a88fe7 100644
--- a/doc/man3/OSSL_trace_set_channel.pod
+++ b/doc/man3/OSSL_trace_set_channel.pod
@@ -1,5 +1,7 @@
=pod
+=for comment foreign manuals: atexit(3)
+
=head1 NAME
OSSL_trace_set_channel, OSSL_trace_set_prefix, OSSL_trace_set_suffix,
diff --git a/doc/man7/x509.pod b/doc/man7/x509.pod
index 2d4edaa..095203c 100644
--- a/doc/man7/x509.pod
+++ b/doc/man7/x509.pod
@@ -58,7 +58,6 @@ L<d2i_X509_CRL(3)>,
L<d2i_X509_NAME(3)>,
L<d2i_X509_REQ(3)>,
L<d2i_X509_SIG(3)>,
-L<X509v3(3)>,
L<crypto(7)>
=head1 COPYRIGHT
diff --git a/util/find-doc-nits b/util/find-doc-nits
index ecd9f9a..499a68f 100755
--- a/util/find-doc-nits
+++ b/util/find-doc-nits
@@ -79,8 +79,7 @@ sub name_synopsis()
print "$id missing comma in NAME\n" if $tmp =~ /[^,] /;
my $dirname = dirname($filename);
- my $simplename = basename($filename);
- $simplename =~ s/.pod$//;
+ my $simplename = basename(basename($filename, ".in"), ".pod");
my $foundfilename = 0;
my %foundfilenames = ();
my %names;
@@ -92,9 +91,10 @@ sub name_synopsis()
$names{$n} = 1;
$foundfilename++ if $n eq $simplename;
$foundfilenames{$n} = 1
- if -f "$dirname/$n.pod" && $n ne $simplename;
+ if ((-f "$dirname/$n.pod.in" || -f "$dirname/$n.pod")
+ && $n ne $simplename);
}
- print "$id the following exist as other .pod files:\n",
+ print "$id the following exist as other .pod or .pod.in files:\n",
join(" ", sort keys %foundfilenames), "\n"
if %foundfilenames;
print "$id $simplename (filename) missing from NAME section\n"
@@ -283,7 +283,7 @@ sub getdocced
my $dir = shift;
my %return;
- foreach my $pod ( glob("$dir/*.pod") ) {
+ foreach my $pod ( glob("$dir/*.pod"), glob("$dir/*.pod.in") ) {
my %podinfo = extract_pod_info($pod);
foreach my $n ( @{$podinfo{names}} ) {
$return{$n} = $pod;
@@ -394,7 +394,7 @@ sub collectnames {
my $filename = shift;
$filename =~ m|man(\d)/|;
my $section = $1;
- my $simplename = basename($filename, ".pod");
+ my $simplename = basename(basename($filename, ".in"), ".pod");
my $id = "${filename}:1:";
my $contents = '';
@@ -412,9 +412,12 @@ sub collectnames {
return;
}
$tmp =~ tr/\n/ /;
- $tmp =~ s/-.*//g;
+ $tmp =~ s/ -.*//g;
- my @names = map { s/^\s+//g; s/\s+$//g; $_ } split(/,/, $tmp);
+ my @names =
+ map { s|/|-|g; $_ } # Treat slash as dash
+ map { s/^\s+//g; s/\s+$//g; $_ } # Trim prefix and suffix blanks
+ split(/,/, $tmp);
unless (grep { $simplename eq $_ } @names) {
print "$id missing $simplename\n";
push @names, $simplename;
@@ -427,8 +430,10 @@ sub collectnames {
my $name_sec = "$name($section)";
if (! exists $name_collection{$name_sec}) {
$name_collection{$name_sec} = $filename;
- } else { #elsif ($filename ne $name_collection{$name_sec}) {
- print "$id $name_sec also in $name_collection{$name_sec}\n";
+ } elsif ($filename eq $name_collection{$name_sec}) {
+ print "$id $name_sec repeated in NAME section of $name_collection{$name_sec}\n"
+ } else {
+ print "$id $name_sec also in NAME section of $name_collection{$name_sec}\n";
}
}
@@ -600,7 +605,7 @@ if ( $opt_c ) {
}
if ( $opt_l ) {
- foreach (@ARGV ? @ARGV : (glob('doc/*/*.pod'),
+ foreach (@ARGV ? @ARGV : (glob('doc/*/*.pod'), glob('doc/*/*.pod.in'),
glob('doc/internal/*/*.pod'))) {
collectnames($_);
}
@@ -609,7 +614,7 @@ if ( $opt_l ) {
if ( $opt_n ) {
&publicize() if $opt_p;
- foreach (@ARGV ? @ARGV : glob('doc/*/*.pod')) {
+ foreach (@ARGV ? @ARGV : (glob('doc/*/*.pod'), glob('doc/*/*.pod.in'))) {
&check($_);
}
{
More information about the openssl-commits
mailing list