Allow alternative manual sections to be embedded in .pod file comments.
authorDr. Stephen Henson <steve@openssl.org>
Thu, 25 Nov 2004 17:47:31 +0000 (17:47 +0000)
committerDr. Stephen Henson <steve@openssl.org>
Thu, 25 Nov 2004 17:47:31 +0000 (17:47 +0000)
CHANGES
Makefile.org
doc/apps/config.pod
doc/apps/x509v3_config.pod
doc/crypto/EVP_BytesToKey.pod
doc/crypto/des_modes.pod
util/extract-section.pl [new file with mode: 0644]

diff --git a/CHANGES b/CHANGES
index ef77f88..28bd44a 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -4,6 +4,17 @@
 
  Changes between 0.9.7e and 0.9.8  [xx XXX xxxx]
 
+  *) New utility extract-section.pl. This can be used specify an alternative
+     section number in a pod file instead of having to treat each file as
+     a separate case in Makefile. This can be done by adding two lines to the
+     pod file:
+
+     =for comment openssl_section:XXX
+
+     The blank line is mandatory.
+
+     [Steve Henson]
+
   *) New arguments -certform, -keyform and -pass for s_client and s_server
      to allow alternative format key and certificate files and passphrase
      sources.
index 57f71f5..bd952e3 100644 (file)
@@ -609,7 +609,7 @@ install_docs:
        fi; \
        set -e; for i in doc/apps/*.pod; do \
                fn=`basename $$i .pod`; \
-               if [ "$$fn" = "config" ]; then sec=5; else sec=1; fi; \
+               sec=`$(PERL) util/extract-section.pl 1 < $$i`; \
                echo "installing man$$sec/$$fn.$${sec}$(MANSUFFIX)"; \
                (cd `$(PERL) util/dirname.pl $$i`; \
                sh -c "$$pod2man \
@@ -626,7 +626,7 @@ install_docs:
        done; \
        set -e; for i in doc/crypto/*.pod doc/ssl/*.pod; do \
                fn=`basename $$i .pod`; \
-               if [ "$$fn" = "des_modes" ]; then sec=7; else sec=3; fi; \
+               sec=`$(PERL) util/extract-section.pl 3 < $$i`; \
                echo "installing man$$sec/$$fn.$${sec}$(MANSUFFIX)"; \
                (cd `$(PERL) util/dirname.pl $$i`; \
                sh -c "$$pod2man \
index 2158cf4..ace34b6 100644 (file)
@@ -1,6 +1,8 @@
 
 =pod
 
+=for comment openssl_manual_section:5
+
 =head1 NAME
 
 config - OpenSSL CONF library configuration files
index 049e854..0995469 100644 (file)
@@ -1,5 +1,7 @@
 =pod
 
+=for comment openssl_manual_section:5
+
 =head1 NAME
 
 x509v3_config - X509 V3 certificate extension configuration format
index 016381f..d375c46 100644 (file)
@@ -60,7 +60,7 @@ EVP_BytesToKey() returns the size of the derived key in bytes.
 =head1 SEE ALSO
 
 L<evp(3)|evp(3)>, L<rand(3)|rand(3)>,
-L<EVP_EncryptInit(3)|EVP_EncryptInit(3)>,
+L<EVP_EncryptInit(3)|EVP_EncryptInit(3)>
 
 =head1 HISTORY
 
index da75e80..0266403 100644 (file)
@@ -1,5 +1,7 @@
 =pod
 
+=for comment openssl_manual_section:7
+
 =head1 NAME
 
 Modes of DES - the variants of DES and other crypto algorithms of OpenSSL
diff --git a/util/extract-section.pl b/util/extract-section.pl
new file mode 100644 (file)
index 0000000..7a0ba4f
--- /dev/null
@@ -0,0 +1,12 @@
+#!/usr/bin/perl
+
+while(<STDIN>) {
+       if (/=for\s+comment\s+openssl_manual_section:(\S+)/)
+               {
+               print "$1\n";
+               exit 0;
+               }
+}
+
+print "$ARGV[0]\n";
+