projects / openssl-web.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: f6f50f5)
Don't try to hide section numbers / links in manpages
authorRichard Levitte <levitte@openssl.org>
Fri, 1 Mar 2019 09:11:51 +0000 (10:11 +0100)
committerRichard Levitte <levitte@openssl.org>
Mon, 4 Mar 2019 18:35:18 +0000 (19:35 +0100)
In previous times, we produced manpages in apps/, crypto/ and ssl/,
and having to deal with links containing '/man{n}/' was only tedious,
so we simply removed the section numbers from the L<> POD codes.

Now that we've switched to regular manpage layout, removing the
section numbers is not necessary any more, and also leads to incorrect
links when the L<> code refers to pages in a different man section.

Issue was reported on
[openssl-users](https://marc.info/?l=openssl-users&m=155138532927266&w=2).
Thank you Paul Smith

Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/web/pull/124)

bin/mk-manpages patch | blob | history

diff --git a/bin/mk-manpages b/bin/mk-manpages
index bc9c793b9c17690d0de8043e3c6255835ca6ed1e..efc95b1e15ff44e0bae8ed0997873d8463ce8e8d 100755 (executable)
--- a/bin/mk-manpages
+++ b/bin/mk-manpages
@@ -41,7 +41,6 @@ sub main {
                 #
                 #       release => "..."        # 
                 #       subdir  => "..."        # The original subdir
-                #       sect    => "..."        # Output section subdir
                 #       sectnum => n            # Default section number
                 #
                 my %data = (
@@ -52,7 +51,7 @@ sub main {
                 );
                 # These are for display
                 my $podfile = File::Spec->catfile( $subdir, $ent );
-                my $incfile = File::Spec->catfile( $data{sect},
+                my $incfile = File::Spec->catfile( "man$data{sectnum}",
                                                    "$origbase.inc" );
                 # These are files we're actually manipulating
                 my $inpod = File::Spec->catfile( $srcdir, $podfile );
@@ -68,7 +67,7 @@ sub main {
                 foreach my $htmlname (
                     map { (my $x = $_) =~ s|/|-|g; $x }
                         @{$data{names}}) {
-                    my $htmlfile = File::Spec->catdir( $data{sect},
+                    my $htmlfile = File::Spec->catdir( "man$data{sectnum}",
                                                        "$htmlname.html" );
                     my $outhtml = File::Spec->catfile( $wwwdir, $htmlfile );
                     $out = $class->genhtml( $release, $title, $origbase,
@@ -90,7 +89,7 @@ sub genhtml {
 <!DOCTYPE html>
 <html lang="en">
 <!-- OSSL: original subdir: $data{subdir} -->
-<!-- OSSL: subdir: $data{sect} -->
+<!-- OSSL: subdir: man$data{sectnum} -->
 <!-- OSSL: section: $data{sectnum} -->
 <!-- OSSL: description: $data{description} -->
 <!--#include virtual="/inc/head.shtml" -->
@@ -111,8 +110,8 @@ sub genhtml {
             : <a href="/docs">Docs</a>
             : <a href="/docs/manpages.html">Manpages</a>
             : <a href="/docs/man$release/">$release</a>
-            : <a href="/docs/man$release/$data{sect}">$data{sect}</a>
-            : <a href="/docs/man$release/$data{sect}/$htmlbase.html">$htmlbase</a>
+            : <a href="/docs/man$release/man$data{sectnum}">man$data{sectnum}</a>
+            : <a href="/docs/man$release/man$data{sectnum}/$htmlbase.html">$htmlbase</a>
             <br/><a href="/sitemap.txt">Sitemap</a>
           </footer>
         </article>
@@ -145,18 +144,12 @@ sub geninc {
     my $infile = do { local $/; <$fh>; };
     close( $fh );
 
-    # L<asdf...|qwer...> ==> L<qwer>
-    $infile =~ s/L<[^|>]*\|([^>]+)>/L<$1>/g;
-
-    # L<asdf(x)> --> L<asdf>
-    $infile =~ s/L<([^>]+)\(\d\)>/L<$1>/g;
-
     my $out;
     my $pod = Pod::Simple::XHTML->new;
     $pod->html_h_level(3);
-    $pod->perldoc_url_prefix("/docs/man$release/$data{sect}/");
+    $pod->perldoc_url_prefix("/docs/man$release/man$data{sectnum}/");
     $pod->perldoc_url_postfix(".html");
-    $pod->man_url_prefix("/docs/man$release/$data{sect}/");
+    $pod->man_url_prefix("/docs/man$release/man");
     $pod->man_url_postfix(".html");
     $pod->html_header('');
     $pod->html_footer('');
@@ -183,7 +176,6 @@ sub getdata {
             s/\n/ /gm;
             if (/^=for comment openssl_manual_section:\s*(\d+)/) {
                 $data{sectnum} = "$1";
-                $data{sect} = "man$1";
             }
             elsif (/^=head1\s/) {
                 $foundname = 0;
Unnamed repository; edit this file 'description' to name the repository.