From: Dr. Stephen Henson <steve@openssl.org>
Date: Thu, 25 Nov 2004 17:47:31 +0000 (+0000)
Subject: Allow alternative manual sections to be embedded in .pod file comments.
X-Git-Tag: BEN_FIPS_TEST_6~14^2~27
X-Git-Url: https://git.openssl.org/gitweb/?p=openssl.git;a=commitdiff_plain;h=401ee37a3e3d414567e7fa7e683fc176cb12411e

Allow alternative manual sections to be embedded in .pod file comments.
---

diff --git a/CHANGES b/CHANGES
index ef77f885fd..28bd44aeb3 100644
--- 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.
diff --git a/Makefile.org b/Makefile.org
index 57f71f5abc..bd952e3593 100644
--- a/Makefile.org
+++ b/Makefile.org
@@ -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 \
diff --git a/doc/apps/config.pod b/doc/apps/config.pod
index 2158cf4253..ace34b62bd 100644
--- a/doc/apps/config.pod
+++ b/doc/apps/config.pod
@@ -1,6 +1,8 @@
 
 =pod
 
+=for comment openssl_manual_section:5
+
 =head1 NAME
 
 config - OpenSSL CONF library configuration files
diff --git a/doc/apps/x509v3_config.pod b/doc/apps/x509v3_config.pod
index 049e854ee8..09954693a3 100644
--- a/doc/apps/x509v3_config.pod
+++ b/doc/apps/x509v3_config.pod
@@ -1,5 +1,7 @@
 =pod
 
+=for comment openssl_manual_section:5
+
 =head1 NAME
 
 x509v3_config - X509 V3 certificate extension configuration format
diff --git a/doc/crypto/EVP_BytesToKey.pod b/doc/crypto/EVP_BytesToKey.pod
index 016381f3e9..d375c46e03 100644
--- a/doc/crypto/EVP_BytesToKey.pod
+++ b/doc/crypto/EVP_BytesToKey.pod
@@ -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
 
diff --git a/doc/crypto/des_modes.pod b/doc/crypto/des_modes.pod
index da75e8007d..02664036fc 100644
--- a/doc/crypto/des_modes.pod
+++ b/doc/crypto/des_modes.pod
@@ -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
index 0000000000..7a0ba4f69a
--- /dev/null
+++ b/util/extract-section.pl
@@ -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";
+