nixpkgs/nixos/modules/config
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
..
fonts treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
gtk treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
krb5 treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
xdg treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
appstream.nix nixos/config: invariant option docs MD conversions 2022-07-24 13:01:18 +02:00
console.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
debug-info.nix treewide: attempt at markdown option docs 2022-06-12 12:44:38 +02:00
gnu.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
i18n.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
iproute2.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
ldap.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
locale.nix nixos/config: invariant option docs MD conversions 2022-07-24 13:01:18 +02:00
malloc.nix nixos/malloc: fix scudo on non-x86_64 machines 2021-10-29 19:56:17 +01:00
networking.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
no-x-libs.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
nsswitch.nix nixos/config: invariant option docs MD conversions 2022-07-24 13:01:18 +02:00
power-management.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
pulseaudio.nix nixos/config: invariant option docs MD conversions 2022-07-24 13:01:18 +02:00
qt5.nix nixos/qt5: convert option docs to MD 2022-07-19 16:23:56 +02:00
resolvconf.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
shells-environment.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
swap.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
sysctl.nix nixos/doc: clean up defaults and examples 2021-10-04 12:47:20 +02:00
system-environment.nix nixos: reduce pam files rebuilds on updates 2021-08-20 23:43:30 +02:00
system-path.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
terminfo.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
unix-odbc-drivers.nix nixos/config: invariant option docs MD conversions 2022-07-24 13:01:18 +02:00
update-users-groups.pl nixos/users-group: make homeMode respect is_dry and create home directly with right permissions 2022-05-23 07:47:11 +02:00
users-groups.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
vte.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
zram.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00