docs: improve index.html generation

Include hypercall documentation, fixing link generation for top level links to
use the INDEX.

Allow subsection links to be renamedi in the INDEX too.

Strip .txt suffixes as well as .html ones by moving the regex to the right
place instead of placing the literal text "(?:html|txt)" into the backlink to
the top level page. (oops)

Signed-off-by: Ian Campbell <ian.campbell@citrix.com>
Committed-by: Ian Jackson <ian.jackson@eu.citrix.com>

diff --git a/docs/INDEX b/docs/INDEX
index 3ed1e99d090087a344f738bed937278d7bad3133..e238bcdc595fec6d5c37683d2efe36509e238a58 100644 (file)
--- a/docs/INDEX
+++ b/docs/INDEX
@@ -1,6 +1,10 @@
-misc/hvm-emulated-unplug       Xen HVM emulated device unplug protocol
+hypercall/index                        Hypercall Interfaces
+
+man                            Man Pages
 
-misc/console.txt               Xen PV Console notes
+misc                           Miscellaneous Documentation
+misc/hvm-emulated-unplug       Xen HVM emulated device unplug protocol
+misc/console                   Xen PV Console notes
 
 # These are not all that useful anymore, hide them from the index
 reference/interface/index      NO-INDEX

diff --git a/docs/gen-html-index b/docs/gen-html-index
index 06d7f62edbc559839a6b7533967ad85ee48145ba..0ce06601bd86e0babd8c2e9c1a841fac3656bb87 100644 (file)
--- a/docs/gen-html-index
+++ b/docs/gen-html-index
@@ -45,7 +45,7 @@ sub make_page ($$$) {
     }
     else
     {
-        $h1 = "<a href=\"../index.(?:html|txt)\">Xen Documentation</a> - $title";
+        $h1 = "<a href=\"../index.html\">Xen Documentation</a> - $title";
         $title = "Xen Documentation - $title";
     }
     $o .= <<END;
@@ -63,7 +63,7 @@ END
 sub make_linktext ($) {
     my ($l) = @_;
     return "$1($2)" if $l =~ m,^man/(.*)\.([0-9].*)\.html,;
-    $l =~ s/.(html)$//g;
+    $l =~ s/.(?:html|txt)$//g;
     return $index{$l} if exists $index{$l};
     return basename($l);
 }
@@ -109,13 +109,14 @@ foreach my $od (sort { $a cmp $b } uniq map { dirname($_) } @docs) {
     my @d = (grep /^\Q$od\E/, @docs);
     if ( @d == 1 and $d[0] eq "$od/index.html" )
     {
-        $top .= "<li><a href=\"${od}/index.html\">${od}/index.html</a></li>\n";
+        $top .= make_link("$od/index.html", 0);
     }
     else
     {
        my $links = make_links($od,0,@d);
+       my $secttitle = make_linktext($od);
        $top .= <<END;
-<li><a href=\"${od}/index.html\">$od</a></li>
+<li><a href=\"${od}/index.html\">$secttitle</a></li>
 <ul>
 $links
 </ul>
@@ -124,12 +125,12 @@ END
        $links = make_links($od,1,@d);
         my $idx = '';
        $idx .= <<END;
-<li>$od</li>
+<li>$secttitle</li>
 <ul>
 $links
 </ul>
 END
-        make_page("$outdir/$od/index.html", $od, $idx);
+        make_page("$outdir/$od/index.html", $secttitle, $idx);
     }
 }