]> xenbits.xensource.com Git - people/iwj/xen.git/commitdiff
docs/parse-support-md: Correctly process caveats in multi-status sections
authorIan Jackson <ian.jackson@eu.citrix.com>
Tue, 15 May 2018 14:41:14 +0000 (15:41 +0100)
committerIan Jackson <Ian.Jackson@eu.citrix.com>
Tue, 15 May 2018 15:41:45 +0000 (16:41 +0100)
When SUPPORT.md uses the syntax
  Status, <some thing>: <support status>
the caveats were lost (not footnoted) because they were attached
only to <some thing>.

Caveats occur in running text, so they are necessarily part of a real
section, not an individual status line like that.  So attach them to
the RealSectNode, and look there for them.

Reported-by: Lars Kurth <lars.kurth@citrix.com>
Signed-off-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
Acked-by: Lars Kurth <Lars.kurth@citrix.com>
Release-acked-by: Juergen Gross <jgross@suse.com>
docs/parse-support-md

index 278072f583fb38587b071f93f57138a191064c72..99ce547c118e1d60abd9f3cb1d8592e72acb14c8 100755 (executable)
@@ -34,7 +34,7 @@ our $toplevel_sectlist = new_sectlist();
 # $sectlist->{KEY}{Children} = a further $sectlist
 # $sectlist->{KEY}{Key} = KEY
 # $sectlist->{KEY}{RealSectNode} = us, or our parent
-# $sectlist->{KEY}{HasCaveat}[VI] = trueish iff other in a Para
+# $sectlist->{KEY}{RealSectNode}{HasCaveat}[VI] = trueish iff other in a Para
 # $sectlist->{KEY}{RealInSect} = containing real section in @insections, so
 # $sectlist->{KEY}{RealInSect}{HasDescription} = VI for some Emph in Para
 # $sectlist->{KEY}{RealInSect}{Anchor} = value for < id="" > in the pandoc html
@@ -123,7 +123,7 @@ sub ri_Para {
 
     if ($had_feature) {
         my $sectnode = find_current_sectnode();
-        $sectnode->{HasCaveat}[$version_index] = 1;
+        $sectnode->{RealSectNode}{HasCaveat}[$version_index] = 1;
     } else {
         $insection->{HasDescription} //= $version_index;
     }
@@ -402,7 +402,7 @@ sub write_output_row ($) {
         my $nextcell = '';
         if (!defined $colspan) { # first row of this RealInSect
             $colspan= ' colspan="2"';
-            if ($sectnode->{HasCaveat}[$i] && $st
+            if ($sectnode->{RealSectNode}{HasCaveat}[$i] && $st
                 && $sectnode->{RealInSect}{Anchor}) {
                 my $rows = $sectnode->{RealInSect}{OwnRows};
                 $nextcell = '<td';