3
0
Fork 0
forked from mirrors/nixpkgs
nixpkgs/nixos/modules/hardware
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
..
cpu treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
keyboard treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
network treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
onlykey treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
raid maintainers: remove volth 2022-06-29 00:52:12 +02:00
sensor treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
video treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
acpilight.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
all-firmware.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
bladeRF.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
brillo.nix
ckb-next.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
corectrl.nix
device-tree.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
digitalbitbox.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
flirc.nix nixos/flirc: init module 2021-10-28 12:33:27 -04:00
gkraken.nix
gpgsmartcards.nix treewide: remove usage of runCommandNoCC aliases 2022-06-07 16:57:06 +02:00
hackrf.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
i2c.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
ksm.nix nixos/hardware: invariant option docs MD conversions 2022-07-24 13:01:18 +02:00
ledger.nix
logitech.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
mcelog.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
new-lg4ff.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
nitrokey.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
opengl.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
openrazer.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
opentabletdriver.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
pcmcia.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
printers.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
rtl-sdr.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
saleae-logic.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
sata.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
steam-hardware.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
system-76.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
tuxedo-keyboard.nix
ubertooth.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
uinput.nix
usb-wwan.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
wooting.nix
xone.nix nixos/xone: init 2022-02-20 18:25:12 +13:00
xpadneo.nix