commit 5cfd034af0afe55e4d25748ec986c71b3bfbe3dd · pyrox.dev/nixpkgs

+9 -97

nixos/doc/manual/default.nix

···

       5
       5
        
       let

     

       6
       6
        
         lib = pkgs.lib;

     

       7
       7
        
       

     

       8
       8
       -
         # Remove invisible and internal options.

     

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

     

       10
       10
       -
       

     

       11
       11
       -
         # Replace functions by the string <function>

     

       12
       12
       -
         substFunction = x:

     

       13
       13
       -
           if builtins.isAttrs x then lib.mapAttrs (name: substFunction) x

     

       14
       14
       -
           else if builtins.isList x then map substFunction x

     

       15
       15
       -
           else if lib.isFunction x then "<function>"

     

       16
       16
       -
           else x;

     

       17
       17
       -
       

     

       18
       18
       -
         # Generate DocBook documentation for a list of packages. This is

     

       19
       19
       -
         # what `relatedPackages` option of `mkOption` from

     

       20
       20
       -
         # ../../../lib/options.nix influences.

     

       21
       21
       -
         #

     

       22
       22
       -
         # Each element of `relatedPackages` can be either

     

       23
       23
       -
         # - a string:  that will be interpreted as an attribute name from `pkgs`,

     

       24
       24
       -
         # - a list:    that will be interpreted as an attribute path from `pkgs`,

     

       25
       25
       -
         # - an attrset: that can specify `name`, `path`, `package`, `comment`

     

       26
       26
       -
         #   (either of `name`, `path` is required, the rest are optional).

     

       27
       27
       -
         genRelatedPackages = packages:

     

       28
       28
       -
           let

     

       29
       29
       -
             unpack = p: if lib.isString p then { name = p; }

     

       30
       30
       -
                         else if lib.isList p then { path = p; }

     

       31
       31
       -
                         else p;

     

       32
       32
       -
             describe = args:

     

       33
       33
       -
               let

     

       34
       34
       -
                 title = args.title or null;

     

       35
       35
       -
                 name = args.name or (lib.concatStringsSep "." args.path);

     

       36
       36
       -
                 path = args.path or [ args.name ];

     

       37
       37
       -
                 package = args.package or (lib.attrByPath path (throw "Invalid package attribute path `${toString path}'") pkgs);

     

       38
       38
       -
               in "<listitem>"

     

       39
       39
       -
               + "<para><literal>${lib.optionalString (title != null) "${title} aka "}pkgs.${name} (${package.meta.name})</literal>"

     

       40
       40
       -
               + lib.optionalString (!package.meta.available) " <emphasis>[UNAVAILABLE]</emphasis>"

     

       41
       41
       -
               + ": ${package.meta.description or "???"}.</para>"

     

       42
       42
       -
               + lib.optionalString (args ? comment) "\n<para>${args.comment}</para>"

     

       43
       43
       -
               # Lots of `longDescription's break DocBook, so we just wrap them into <programlisting>

     

       44
       44
       -
               + lib.optionalString (package.meta ? longDescription) "\n<programlisting>${package.meta.longDescription}</programlisting>"

     

       45
       45
       -
               + "</listitem>";

     

       46
       46
       -
           in "<itemizedlist>${lib.concatStringsSep "\n" (map (p: describe (unpack p)) packages)}</itemizedlist>";

     

       47
       47
       -
       

     

       48
       48
       -
         optionsListDesc = lib.flip map optionsListVisible (opt: opt // {

     

       49
       49
       -
           # Clean up declaration sites to not refer to the NixOS source tree.

     

       50
       50
       -
           declarations = map stripAnyPrefixes opt.declarations;

     

       51
       51
       -
         }

     

       52
       52
       -
         // lib.optionalAttrs (opt ? example) { example = substFunction opt.example; }

     

       53
       53
       -
         // lib.optionalAttrs (opt ? default) { default = substFunction opt.default; }

     

       54
       54
       -
         // lib.optionalAttrs (opt ? type) { type = substFunction opt.type; }

     

       55
       55
       -
         // lib.optionalAttrs (opt ? relatedPackages && opt.relatedPackages != []) { relatedPackages = genRelatedPackages opt.relatedPackages; });

     

       56
       56
       -
       

     

       57
       8
        
         # We need to strip references to /nix/store/* from options,

     

       58
       9
        
         # including any `extraSources` if some modules came from elsewhere,

     

       59
       10
        
         # or else the build will fail.

     
···

       63
       14
        
         prefixesToStrip = map (p: "${toString p}/") ([ ../../.. ] ++ extraSources);

     

       64
       15
        
         stripAnyPrefixes = lib.flip (lib.fold lib.removePrefix) prefixesToStrip;

     

       65
       16
        
       

     

       66
       66
       -
         # Custom "less" that pushes up all the things ending in ".enable*"

     

       67
       67
       -
         # and ".package*"

     

       68
       68
       -
         optionLess = a: b:

     

       69
       69
       -
           let

     

       70
       70
       -
             ise = lib.hasPrefix "enable";

     

       71
       71
       -
             isp = lib.hasPrefix "package";

     

       72
       72
       -
             cmp = lib.splitByAndCompare ise lib.compare

     

       73
       73
       -
                                        (lib.splitByAndCompare isp lib.compare lib.compare);

     

       74
       74
       -
           in lib.compareLists cmp a.loc b.loc < 0;

     

       75
       75
       -
       

     

       76
       76
       -
         # Customly sort option list for the man page.

     

       77
       77
       -
         optionsList = lib.sort optionLess optionsListDesc;

     

       78
       78
       -
       

     

       79
       79
       -
         # Convert the list of options into an XML file.

     

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

     

       81
       81
       -
       

     

       82
       82
       -
         optionsDocBook = runCommand "options-db.xml" {} ''

     

       83
       83
       -
           optionsXML=${optionsXML}

     

       84
       84
       -
           if grep /nixpkgs/nixos/modules $optionsXML; then

     

       85
       85
       -
             echo "The manual appears to depend on the location of Nixpkgs, which is bad"

     

       86
       86
       -
             echo "since this prevents sharing via the NixOS channel.  This is typically"

     

       87
       87
       -
             echo "caused by an option default that refers to a relative path (see above"

     

       88
       88
       -
             echo "for hints about the offending path)."

     

       89
       89
       -
             exit 1

     

       90
       90
       -
           fi

     

       91
       91
       -
           ${buildPackages.libxslt.bin}/bin/xsltproc \

     

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

     

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

     

       94
       94
       -
           ${buildPackages.libxslt.bin}/bin/xsltproc \

     

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

     

       96
       96
       -
         '';

     

       17
       17
       +
         optionsDoc = buildPackages.nixosOptionsDoc {

     

       18
       18
       +
           inherit options revision;

     

       19
       19
       +
           transformOptions = opt: opt // {

     

       20
       20
       +
             # Clean up declaration sites to not refer to the NixOS source tree.

     

       21
       21
       +
             declarations = map stripAnyPrefixes opt.declarations;

     

       22
       22
       +
           };

     

       23
       23
       +
         };

     

       97
       24
        
       

     

       98
       25
        
         sources = lib.sourceFilesBySuffices ./. [".xml"];

     

       99
       26
        
       

     
···

       108
       35
        
         generatedSources = runCommand "generated-docbook" {} ''

     

       109
       36
        
           mkdir $out

     

       110
       37
        
           ln -s ${modulesDoc} $out/modules.xml

     

       111
       111
       -
           ln -s ${optionsDocBook} $out/options-db.xml

     

       38
       38
       +
           ln -s ${optionsDoc.optionsDocBook} $out/options-db.xml

     

       112
       39
        
           printf "%s" "${version}" > $out/version

     

       113
       40
        
         '';

     

       114
       41
        
       

     
···

       234
       161
        
       in rec {

     

       235
       162
        
         inherit generatedSources;

     

       236
       163
        
       

     

       237
       237
       -
         # The NixOS options in JSON format.

     

       238
       238
       -
         optionsJSON = runCommand "options-json"

     

       239
       239
       -
           { meta.description = "List of NixOS options in JSON format";

     

       240
       240
       -
           }

     

       241
       241
       -
           ''

     

       242
       242
       -
             # Export list of options in different format.

     

       243
       243
       -
             dst=$out/share/doc/nixos

     

       244
       244
       -
             mkdir -p $dst

     

       245
       245
       -
       

     

       246
       246
       -
             cp ${builtins.toFile "options.json" (builtins.unsafeDiscardStringContext (builtins.toJSON

     

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

     

       248
       248
       -
             } $dst/options.json

     

       249
       249
       -
       

     

       250
       250
       -
             mkdir -p $out/nix-support

     

       251
       251
       -
             echo "file json $dst/options.json" >> $out/nix-support/hydra-build-products

     

       252
       252
       -
           ''; # */

     

       164
       164
       +
         inherit (optionsDoc) optionsJSON optionsXML optionsDocBook;

     

       253
       165
        
       

     

       254
       166
        
         # Generate the NixOS manual.

     

       255
       167
        
         manualHTML = runCommand "nixos-manual-html"

nixos/doc/manual/options-to-docbook.xsl nixos/lib/make-options-doc/options-to-docbook.xsl

nixos/doc/manual/postprocess-option-descriptions.xsl nixos/lib/make-options-doc/postprocess-option-descriptions.xsl

+125

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

···

       1
       1
       +
       /* Generate JSON, XML and DocBook documentation for given NixOS options.

     

       2
       2
       +
       

     

       3
       3
       +
          Minimal example:

     

       4
       4
       +
       

     

       5
       5
       +
           { pkgs,  }:

     

       6
       6
       +
       

     

       7
       7
       +
           let

     

       8
       8
       +
             eval = import (pkgs.path + "/nixos/lib/eval-config.nix") {

     

       9
       9
       +
               baseModules = [

     

       10
       10
       +
                 ../module.nix

     

       11
       11
       +
               ];

     

       12
       12
       +
               modules = [];

     

       13
       13
       +
             };

     

       14
       14
       +
           in pkgs.nixosOptionsDoc {

     

       15
       15
       +
             options = eval.options;

     

       16
       16
       +
           }

     

       17
       17
       +
       

     

       18
       18
       +
       */

     

       19
       19
       +
       { pkgs

     

       20
       20
       +
       , lib

     

       21
       21
       +
       , options

     

       22
       22
       +
       , transformOptions ? lib.id  # function for additional tranformations of the options

     

       23
       23
       +
       , revision ? "" # Specify revision for the options

     

       24
       24
       +
       }:

     

       25
       25
       +
       

     

       26
       26
       +
       let

     

       27
       27
       +
         # Replace functions by the string <function>

     

       28
       28
       +
         substFunction = x:

     

       29
       29
       +
           if builtins.isAttrs x then lib.mapAttrs (name: substFunction) x

     

       30
       30
       +
           else if builtins.isList x then map substFunction x

     

       31
       31
       +
           else if lib.isFunction x then "<function>"

     

       32
       32
       +
           else x;

     

       33
       33
       +
       

     

       34
       34
       +
         optionsListDesc = lib.flip map optionsListVisible

     

       35
       35
       +
          (opt: transformOptions opt

     

       36
       36
       +
           // lib.optionalAttrs (opt ? example) { example = substFunction opt.example; }

     

       37
       37
       +
           // lib.optionalAttrs (opt ? default) { default = substFunction opt.default; }

     

       38
       38
       +
           // lib.optionalAttrs (opt ? type) { type = substFunction opt.type; }

     

       39
       39
       +
           // lib.optionalAttrs (opt ? relatedPackages && opt.relatedPackages != []) { relatedPackages = genRelatedPackages opt.relatedPackages; }

     

       40
       40
       +
          );

     

       41
       41
       +
       

     

       42
       42
       +
         # Generate DocBook documentation for a list of packages. This is

     

       43
       43
       +
         # what `relatedPackages` option of `mkOption` from

     

       44
       44
       +
         # ../../../lib/options.nix influences.

     

       45
       45
       +
         #

     

       46
       46
       +
         # Each element of `relatedPackages` can be either

     

       47
       47
       +
         # - a string:  that will be interpreted as an attribute name from `pkgs`,

     

       48
       48
       +
         # - a list:    that will be interpreted as an attribute path from `pkgs`,

     

       49
       49
       +
         # - an attrset: that can specify `name`, `path`, `package`, `comment`

     

       50
       50
       +
         #   (either of `name`, `path` is required, the rest are optional).

     

       51
       51
       +
         genRelatedPackages = packages:

     

       52
       52
       +
           let

     

       53
       53
       +
             unpack = p: if lib.isString p then { name = p; }

     

       54
       54
       +
                         else if lib.isList p then { path = p; }

     

       55
       55
       +
                         else p;

     

       56
       56
       +
             describe = args:

     

       57
       57
       +
               let

     

       58
       58
       +
                 title = args.title or null;

     

       59
       59
       +
                 name = args.name or (lib.concatStringsSep "." args.path);

     

       60
       60
       +
                 path = args.path or [ args.name ];

     

       61
       61
       +
                 package = args.package or (lib.attrByPath path (throw "Invalid package attribute path `${toString path}'") pkgs);

     

       62
       62
       +
               in "<listitem>"

     

       63
       63
       +
               + "<para><literal>${lib.optionalString (title != null) "${title} aka "}pkgs.${name} (${package.meta.name})</literal>"

     

       64
       64
       +
               + lib.optionalString (!package.meta.available) " <emphasis>[UNAVAILABLE]</emphasis>"

     

       65
       65
       +
               + ": ${package.meta.description or "???"}.</para>"

     

       66
       66
       +
               + lib.optionalString (args ? comment) "\n<para>${args.comment}</para>"

     

       67
       67
       +
               # Lots of `longDescription's break DocBook, so we just wrap them into <programlisting>

     

       68
       68
       +
               + lib.optionalString (package.meta ? longDescription) "\n<programlisting>${package.meta.longDescription}</programlisting>"

     

       69
       69
       +
               + "</listitem>";

     

       70
       70
       +
           in "<itemizedlist>${lib.concatStringsSep "\n" (map (p: describe (unpack p)) packages)}</itemizedlist>";

     

       71
       71
       +
       

     

       72
       72
       +
         # Custom "less" that pushes up all the things ending in ".enable*"

     

       73
       73
       +
         # and ".package*"

     

       74
       74
       +
         optionLess = a: b:

     

       75
       75
       +
           let

     

       76
       76
       +
             ise = lib.hasPrefix "enable";

     

       77
       77
       +
             isp = lib.hasPrefix "package";

     

       78
       78
       +
             cmp = lib.splitByAndCompare ise lib.compare

     

       79
       79
       +
                                        (lib.splitByAndCompare isp lib.compare lib.compare);

     

       80
       80
       +
           in lib.compareLists cmp a.loc b.loc < 0;

     

       81
       81
       +
       

     

       82
       82
       +
         # Remove invisible and internal options.

     

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

     

       84
       84
       +
       

     

       85
       85
       +
         # Customly sort option list for the man page.

     

       86
       86
       +
         optionsList = lib.sort optionLess optionsListDesc;

     

       87
       87
       +
       

     

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

     

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

     

       90
       90
       +
       

     

       91
       91
       +
       in rec {

     

       92
       92
       +
         # The NixOS options in JSON format.

     

       93
       93
       +
         optionsJSON = pkgs.runCommand "options.json"

     

       94
       94
       +
           { meta.description = "List of NixOS options in JSON format";

     

       95
       95
       +
           }

     

       96
       96
       +
           ''

     

       97
       97
       +
             # Export list of options in different format.

     

       98
       98
       +
             dst=$out/share/doc/nixos

     

       99
       99
       +
             mkdir -p $dst

     

       100
       100
       +
       

     

       101
       101
       +
             cp ${builtins.toFile "options.json" (builtins.unsafeDiscardStringContext (builtins.toJSON

     

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

     

       103
       103
       +
             } $dst/options.json

     

       104
       104
       +
       

     

       105
       105
       +
             mkdir -p $out/nix-support

     

       106
       106
       +
             echo "file json $dst/options.json" >> $out/nix-support/hydra-build-products

     

       107
       107
       +
           ''; # */

     

       108
       108
       +
       

     

       109
       109
       +
         optionsDocBook = pkgs.runCommand "options-docbook.xml" {} ''

     

       110
       110
       +
           optionsXML=${optionsXML}

     

       111
       111
       +
           if grep /nixpkgs/nixos/modules $optionsXML; then

     

       112
       112
       +
             echo "The manual appears to depend on the location of Nixpkgs, which is bad"

     

       113
       113
       +
             echo "since this prevents sharing via the NixOS channel.  This is typically"

     

       114
       114
       +
             echo "caused by an option default that refers to a relative path (see above"

     

       115
       115
       +
             echo "for hints about the offending path)."

     

       116
       116
       +
             exit 1

     

       117
       117
       +
           fi

     

       118
       118
       +
       

     

       119
       119
       +
           ${pkgs.libxslt.bin}/bin/xsltproc \

     

       120
       120
       +
             --stringparam revision '${revision}' \

     

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

     

       122
       122
       +
           ${pkgs.libxslt.bin}/bin/xsltproc \

     

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

     

       124
       124
       +
         '';

     

       125
       125
       +
       }

pkgs/top-level/all-packages.nix

···

       23876
       23876
        
               in

     

       23877
       23877
        
                 nixosTesting.makeTest calledTest;

     

       23878
       23878
        
       

     

       23879
       23879
       +
         nixosOptionsDoc = attrs: 

     

       23880
       23880
       +
           (import ../../nixos/lib/make-options-doc/default.nix)

     

       23881
       23881
       +
           ({ inherit pkgs lib; } // attrs);

     

       23882
       23882
       +
       

     

       23879
       23883
        
         nixui = callPackage ../tools/package-management/nixui { node_webkit = nwjs_0_12; };

     

       23880
       23884
        
       

     

       23881
       23885
        
         nixdoc = callPackage ../tools/nix/nixdoc {};