Commit graph

13 commits

Author SHA1 Message Date
pennae 2e751c0772 treewide: automatically md-convert option descriptions
the conversion procedure is simple:

 - find all things that look like options, ie calls to either `mkOption`
   or `lib.mkOption` that take an attrset. remember the attrset as the
   option
 - for all options, find a `description` attribute who's value is not a
   call to `mdDoc` or `lib.mdDoc`
 - textually convert the entire value of the attribute to MD with a few
   simple regexes (the set from mdize-module.sh)
 - if the change produced a change in the manual output, discard
 - if the change kept the manual unchanged, add some text to the
   description to make sure we've actually found an option. if the
   manual changes this time, keep the converted description

this procedure converts 80% of nixos options to markdown. around 2000
options remain to be inspected, but most of those fail the "does not
change the manual output check": currently the MD conversion process
does not faithfully convert docbook tags like <code> and <package>, so
any option using such tags will not be converted at all.
2022-07-30 15:16:34 +02:00
Taeer Bar-Yam 13e35662cc add a defaultText 2022-02-23 16:19:10 -05:00
Taeer Bar-Yam b5ec72fc13 tweaks 2022-02-23 10:41:28 -05:00
Taeer Bar-Yam 005769ee13 whitespace 2022-02-23 10:41:28 -05:00
Taeer Bar-Yam 74dcaf5784 zammad: test passes! 2022-02-23 10:41:28 -05:00
Taeer Bar-Yam 00e74ad907 minor changes 2022-02-23 10:41:28 -05:00
Taeer Bar-Yam 4d38b6460f zammad: reformat 2022-02-23 10:41:27 -05:00
Taeer Bar-Yam 75fe105a3d Zammad: more fixes 2022-02-23 10:41:27 -05:00
Taeer Bar-Yam aac7f85483 zammad: fix module databases 2022-02-23 10:41:27 -05:00
Taeer Bar-Yam e1009112b6 minor tweaks 2022-02-23 10:41:26 -05:00
Taeer Bar-Yam 34e0a1a1f1 fix zammad service 2022-02-23 10:41:26 -05:00
Taeer Bar-Yam e7aba931e2 zammad: fix module/test 2022-02-23 10:41:26 -05:00
Taeer Bar-Yam 9bc86d946b zammad: init module
Co-authored-by: garbas <rok@garbas.si>
2022-02-23 10:41:25 -05:00