nixpkgs/nixos/modules/security
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
..
acme treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
apparmor apparmor: Fix cups-client typo 2021-08-23 00:50:15 -07:00
wrappers treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
apparmor.nix nixos/security/apparmor: utillinux -> util-linux 2021-05-17 17:14:08 +02:00
audit.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
auditd.nix
ca.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
chromium-suid-sandbox.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
dhparams.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
doas.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
duosec.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
google_oslogin.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
lock-kernel-modules.nix nixos/security: invariant option docs MD conversions 2022-07-24 13:01:18 +02:00
misc.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
oath.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
pam_mount.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
pam_usb.nix nixos: explicitely set security.wrappers ownership 2021-09-13 13:48:13 +02:00
pam.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
polkit.nix nixos/security: invariant option docs MD conversions 2022-07-24 13:01:18 +02:00
rngd.nix nixos/rngd: Remove module entirely, leave an explaination 2021-02-21 01:32:50 +01:00
rtkit.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
sudo.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
systemd-confinement.nix treewide: attempt at markdown option docs 2022-06-12 12:44:38 +02:00
tpm2.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00