[openssl-dev] [openssl.org #3718] Broken NAME header in doc/crypto/d2i_ECPKParameters.pod (master and 1.0.2)

Rainer Jung via RT rt at openssl.org
Tue Feb 24 16:21:34 UTC 2015


File doc/crypto/d2i_ECPKParameters.pod starts with

=pod

=head1 NAME

d2i_ECPKParameters, i2d_ECPKParameters, d2i_ECPKParameters_bio, 
i2d_ECPKParameters_bio, d2i_ECPKParameters_fp, 
i2d_ECPKParameters_fp(fp,x), ECPKParameters_print, 
ECPKParameters_print_fp - Functions for decoding and encoding ASN1 
representations of elliptic curve entities

=head1 SYNOPSIS


The argument syntax (fp,x) breaks util/extract-names.pl which is used in 
the Makefile to determine which symlinks to create in the man pages 
directory:

% perl util/extract-names.pl < doc/crypto/d2i_ECPKParameters.pod
d2i_ECPKParameters
i2d_ECPKParameters
d2i_ECPKParameters_bio
i2d_ECPKParameters_bio
d2i_ECPKParameters_fp
i2d_ECPKParameters_fp(fp
x)
ECPKParameters_print
ECPKParameters_print_fp

After installation there are broken symlinks:

lrwxrwxrwx   ... i2d_ECPKParameters_fp(fp.3 -> d2i_ECPKParameters.3
lrwxrwxrwx   ... x).3 -> d2i_ECPKParameters.3

The script util/extract-names.pl is unchanged since 11 years (master and 
1.0.2 branch), the pod file doc/crypto/d2i_ECPKParameters.pod is new in 
1.0.2 and contains the broken syntax in 1.0.2 and master.

Solution: drop "(fp,x)" in the NAME header:

--- doc/crypto/d2i_ECPKParameters.pod      2014-08-07 06:28:31.000000000 
+0200
+++ doc/crypto/d2i_ECPKParameters.pod   2015-02-23 23:02:57.481128000 +0100
@@ -2,7 +2,7 @@

  =head1 NAME

-d2i_ECPKParameters, i2d_ECPKParameters, d2i_ECPKParameters_bio, 
i2d_ECPKParameters_bio, d2i_ECPKParameters_fp, 
i2d_ECPKParameters_fp(fp,x), ECPKParameters_print, 
ECPKParameters_print_fp - Functions for decoding and encoding ASN1 
representations of elliptic curve entities
+d2i_ECPKParameters, i2d_ECPKParameters, d2i_ECPKParameters_bio, 
i2d_ECPKParameters_bio, d2i_ECPKParameters_fp, i2d_ECPKParameters_fp, 
ECPKParameters_print, ECPKParameters_print_fp - Functions for decoding 
and encoding ASN1 representations of elliptic curve entities

  =head1 SYNOPSIS


Thanks!

Rainer




More information about the openssl-dev mailing list