commit 24eb35390785e8ef8dc7adf26b6974766ae6562f · pyrox.dev/nixpkgs

+6 -2

nixos/lib/make-options-doc/default.nix

···

       83
        
         optionsListVisible = lib.filter (opt: opt.visible && !opt.internal) (lib.optionAttrSetToDocList options);

     

       84
        
       

     

       85
        
         # Customly sort option list for the man page.

     

       0
        
       
     

       86
        
         optionsList = lib.sort optionLess optionsListDesc;

     

       87
        
       

     

       88
        
         # Convert the list of options into an XML file.

     

       89
       -
         optionsXML = builtins.toFile "options.xml" (builtins.toXML optionsList);

     

       0
        
       
     

       0
        
       
     

       90
        
       

     

       91
        
         optionsNix = builtins.listToAttrs (map (o: { name = o.name; value = removeAttrs o ["name" "visible" "internal"]; }) optionsList);

     

       92
        
       

     
···

       185
        
             exit 1

     

       186
        
           fi

     

       187
        
       

     

       0
        
       
     

       188
        
           ${pkgs.libxslt.bin}/bin/xsltproc \

     

       189
        
             --stringparam revision '${revision}' \

     

       190
       -
             -o intermediate.xml ${./options-to-docbook.xsl} $optionsXML

     

       191
        
           ${pkgs.libxslt.bin}/bin/xsltproc \

     

       192
        
             -o "$out" ${./postprocess-option-descriptions.xsl} intermediate.xml

     

       193
        
         '';

···

       83
        
         optionsListVisible = lib.filter (opt: opt.visible && !opt.internal) (lib.optionAttrSetToDocList options);

     

       84
        
       

     

       85
        
         # Customly sort option list for the man page.

     

       86
       +
         # Always ensure that the sort order matches sortXML.py!

     

       87
        
         optionsList = lib.sort optionLess optionsListDesc;

     

       88
        
       

     

       89
        
         # Convert the list of options into an XML file.

     

       90
       +
         # This file is *not* sorted sorted to save on eval time, since the docbook XML

     

       91
       +
         # and the manpage depend on it and thus we evaluate this on every system rebuild.

     

       92
       +
         optionsXML = builtins.toFile "options.xml" (builtins.toXML optionsListDesc);

     

       93
        
       

     

       94
        
         optionsNix = builtins.listToAttrs (map (o: { name = o.name; value = removeAttrs o ["name" "visible" "internal"]; }) optionsList);

     

       95
        
       

     
···

       188
        
             exit 1

     

       189
        
           fi

     

       190
        
       

     

       191
       +
           ${pkgs.python3Minimal}/bin/python ${./sortXML.py} $optionsXML sorted.xml

     

       192
        
           ${pkgs.libxslt.bin}/bin/xsltproc \

     

       193
        
             --stringparam revision '${revision}' \

     

       194
       +
             -o intermediate.xml ${./options-to-docbook.xsl} sorted.xml

     

       195
        
           ${pkgs.libxslt.bin}/bin/xsltproc \

     

       196
        
             -o "$out" ${./postprocess-option-descriptions.xsl} intermediate.xml

     

       197
        
         '';

+28

nixos/lib/make-options-doc/sortXML.py

···

       1
       +
       import xml.etree.ElementTree as ET

     

       2
       +
       import sys

     

       3
       +
       

     

       4
       +
       tree = ET.parse(sys.argv[1])

     

       5
       +
       # the xml tree is of the form

     

       6
       +
       # <expr><list> {all options, each an attrs} </list></expr>

     

       7
       +
       options = list(tree.getroot().find('list'))

     

       8
       +
       

     

       9
       +
       def sortKey(opt):

     

       10
       +
           def order(s):

     

       11
       +
               if s.startswith("enable"):

     

       12
       +
                   return 0

     

       13
       +
               if s.startswith("package"):

     

       14
       +
                   return 1

     

       15
       +
               return 2

     

       16
       +
       

     

       17
       +
           return [

     

       18
       +
               (order(p.attrib['value']), p.attrib['value'])

     

       19
       +
               for p in opt.findall('attr[@name="loc"]/list/string')

     

       20
       +
           ]

     

       21
       +
       

     

       22
       +
       # always ensure that the sort order matches the order used in the nix expression!

     

       23
       +
       options.sort(key=sortKey)

     

       24
       +
       

     

       25
       +
       doc = ET.Element("expr")

     

       26
       +
       newOptions = ET.SubElement(doc, "list")

     

       27
       +
       newOptions.extend(options)

     

       28
       +
       ET.ElementTree(doc).write(sys.argv[2], encoding='utf-8')