Re: [Xen-devel] [PATCH for-4.11 v2 0/9] Provide support matrix generator

[Lars Kurth <lars.kurth@xxxxxxxxxx>]

On 11/04/2018, 16:36, "Ian Jackson" <ian.jackson@xxxxxxxxxxxxx> wrote:

    This series provides code to generate a feature support matrix, to
    replace the one on the wiki.  You can see an example of the output
    here:
      http://xenbits.xen.org/people/iwj/2018/support-matrix-example-v2/t.html
    There is also an accompanying SUPPORT.html to make the links for 4.11
    work.
    
    Patches 1-3 fix syntax trouble in SUPPORT.md (and commit us to using
    pandoc format for it).  Patches 4-7 arrange to generate a SUPPORT.html
    at the toplevel of the generated docs.  These should all be backported
    to 4.10.
    
    Patches 8 and 9 are the support matrix generator.  They are not hooked
    into any of the xen.git makefiles but it seemed best to have them here
    in xen.git/docs rather than floating about in some ad hoc crontab
    repo.
    
      ar 1/9 SUPPORT.md: Syntax: Fix some bullet lists
      ar 2/9 SUPPORT.md: Syntax: Fix a typo "States"
     m r 3/9 SUPPORT.md: Syntax: Provide a title rather than a
       r 4/9 docs/gen-html-index: Extract titles from HTML documents
       r 5/9 docs/gen-html-index: Support documents at the toplevel
       r 6/9 docs/Makefile: Introduce GENERATE_PANDOC_RULE_RAW
       r 7/9 docs/Makefile: Format SUPPORT.md into the toplevel
     +   8/9 docs: Provide parse-support-md
     +   9/9 docs: Provide support-matrix-generate, to generate ...
    
     a = acked (by a tools or REST maintainer)
     r = release-acked for 4.11
     + = new patch
     m = modified commit message
    
    I think if the output is tolerably accurate, it would be valuable to
    get this set up as a cron job ASAP.  Stylistic and formatting
    improvements etc. can be done on top.
    
    My plan is that the cron job will use the matrix generator from
    xen.git#master.
    
    For my reference, this was generated with
       docs/support-matrix-generate HEAD SUPPORT.html 
refs/heads/wip.support-stmt-NN 
https://xenbits.xen.org/docs/NN-testing/SUPPORT.html >t.html
      rsync -vP t.html SUPPORT.html 
xenbits:public_html/2018/support-matrix-example-v1/

Acked-by: Lars Kurth <lars.kurth@xxxxxxxxxx>

Ian, this looks good. 

Only a small comment: for table entries such as
x86/PCI Device Passthrough      x86 PV          Supported, with caveats 
Supported, with caveats
x86 HVM                                 Supported, with caveats[*]      
Supported, with caveats[*]

The footnote [*] should probably apply to all items in the tree, not just the 
last one. Also, the 4.10 link didn't work (probably because the SUPPORT.md 
format changes need backporting)

Regards
Lars

_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxxxxxxxxx
https://lists.xenproject.org/mailman/listinfo/xen-devel