3
0
Fork 0
forked from mirrors/nixpkgs
nixpkgs/nixos/lib/make-options-doc
pennae fc614c37c6 nixos/documentation: split options doc build
most modules can be evaluated for their documentation in a very
restricted environment that doesn't include all of nixpkgs. this
evaluation can then be cached and reused for subsequent builds, merging
only documentation that has changed into the cached set. since nixos
ships with a large number of modules of which only a few are used in any
given config this can save evaluation a huge percentage of nixos
options available in any given config.

in tests of this caching, despite having to copy most of nixos/, saves
about 80% of the time needed to build the system manual, or about two
second on the machine used for testing. build time for a full system
config shrank from 9.4s to 7.4s, while turning documentation off
entirely shortened the build to 7.1s.
2022-01-02 19:46:13 +01:00
..
default.nix nixos/documentation: split options doc build 2022-01-02 19:46:13 +01:00
generateAsciiDoc.py nixos/lib/make-options-doc: generate asciidoc/md in derivations 2021-12-06 16:12:30 +01:00
generateCommonMark.py nixos/lib/make-options-doc: generate asciidoc/md in derivations 2021-12-06 16:12:30 +01:00
mergeJSON.py nixos/documentation: split options doc build 2022-01-02 19:46:13 +01:00
options-to-docbook.xsl nixos/make-options-doc: fix invalid ':' in XML NCName (non-colonized name) 2021-12-28 22:18:16 -05:00
optionsJSONtoXML.nix nixos/lib/make-options-doc: generate options.xml from options.json 2021-12-06 16:12:32 +01:00
postprocess-option-descriptions.xsl
sortXML.py nix/lib/make-options-doc: remove nix-level sorting 2021-12-06 16:12:32 +01:00