nixpkgs/nixos/modules/programs
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
..
bash treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
command-not-found treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
digitalbitbox treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
zsh treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
_1password-gui.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
_1password.nix nixos/_1password{,-gui}: use a static gid 2022-05-15 22:15:11 +09:00
adb.nix nixos/adb: switch to android-tools built from source 2021-08-28 17:22:46 +02:00
appgate-sdp.nix appgate-sdp: minimize and improve derivation 2021-06-24 11:22:54 +02:00
atop.nix nixos/programs: invariant option docs MD conversions 2022-07-24 13:01:18 +02:00
autojump.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
bandwhich.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
bash-my-aws.nix
bcc.nix bcc: move from linux-kernels packages to normal packages 2021-12-04 21:07:09 +09:00
browserpass.nix
calls.nix programs/calls: enable dconf 2022-02-07 22:50:36 +01:00
captive-browser.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
ccache.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
cdemu.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
cfs-zen-tweaks.nix nixos/cfs-zen-tweaks: init 2021-12-04 13:06:22 +01:00
chromium.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
cnping.nix nixos/cnping: init 2021-10-14 21:27:38 +03:00
criu.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
dconf.nix nixos/programs: invariant option docs MD conversions 2022-07-24 13:01:18 +02:00
dmrconfig.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
droidcam.nix nixos/droidcam: init (#109267) 2021-04-05 21:32:21 +02:00
environment.nix nixos/environment: add GTK paths to pathsToLink 2022-03-14 18:01:16 +01:00
evince.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
extra-container.nix nixos/extra-container: init 2021-09-30 22:52:14 +02:00
feedbackd.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
file-roller.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
firejail.nix nixos/firejail: Fix order of extrsArgs before profile wrappedBinaries option 2022-03-03 21:35:37 -05:00
fish_completion-generator.patch nixos/fish: adapt completions patch to fish 3.2.0 2021-03-06 16:26:22 -08:00
fish.nix nixos/programs: invariant option docs MD conversions 2022-07-24 13:01:18 +02:00
flashrom.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
flexoptix-app.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
freetds.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
fuse.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
gamemode.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
geary.nix gnome: rename from gnome3 2021-05-08 09:47:42 +02:00
git.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
gnome-disks.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
gnome-documents.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
gnome-terminal.nix gnome: rename from gnome3 2021-05-08 09:47:42 +02:00
gnupg.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
gpaste.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
gphoto2.nix
haguichi.nix nixos/haguichi: init 2022-04-23 16:25:19 +02:00
hamster.nix nixos/hamster: fix programs.hamster.enable text 2021-07-04 23:18:23 +02:00
htop.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
iftop.nix nixos: explicitely set security.wrappers ownership 2021-09-13 13:48:13 +02:00
iotop.nix nixos: explicitely set security.wrappers ownership 2021-09-13 13:48:13 +02:00
java.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
k3b.nix nixos/k3b: init. Fixes #19154 missing permissions for k3b 2022-04-30 13:18:40 +02:00
k40-whisperer.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
kbdlight.nix nixos: explicitely set security.wrappers ownership 2021-09-13 13:48:13 +02:00
kclock.nix nixos/kclock: integrate with dbus 2022-03-05 12:38:36 +01:00
kdeconnect.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
less.nix nixos/programs: invariant option docs MD conversions 2022-07-24 13:01:18 +02:00
liboping.nix nixos: explicitely set security.wrappers ownership 2021-09-13 13:48:13 +02:00
light.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
mininet.nix nixos/mininet: telnet → inetutils 2022-04-17 02:46:33 +02:00
mosh.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
msmtp.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
mtr.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
nano.nix nixos/programs: invariant option docs MD conversions 2022-07-24 13:01:18 +02:00
nbd.nix nbd: add programs.nbd, services.nbd, and test 2022-03-09 12:00:47 +00:00
neovim.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
nethoscope.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
nix-ld.nix nix-ld: 1.0.0 -> 1.0.2 2022-05-15 21:06:05 +02:00
nm-applet.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
nncp.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
noisetorch.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
npm.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
oblogout.nix
openvpn3.nix nixos/openvpn3: add enable option 2022-06-12 01:19:51 +05:00
pantheon-tweaks.nix nixos/pantheon-tweaks: init 2021-09-18 22:49:53 +08:00
partition-manager.nix nixos/partition-manager: init 2021-03-05 00:29:47 +08:00
plotinus.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
plotinus.xml
proxychains.nix nixos/programs: invariant option docs MD conversions 2022-07-24 13:01:18 +02:00
qt5ct.nix nixos/qt5ct: remove enable option and suggests qt5.platformTheme 2022-07-05 13:50:42 -03:00
screen.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
seahorse.nix gnome: rename from gnome3 2021-05-08 09:47:42 +02:00
sedutil.nix
shadow.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
singularity.nix nixos: explicitely set security.wrappers ownership 2021-09-13 13:48:13 +02:00
slock.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
spacefm.nix nixos/programs: invariant option docs MD conversions 2022-07-24 13:01:18 +02:00
ssh.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
starship.nix nixos/programs: invariant option docs MD conversions 2022-07-24 13:01:18 +02:00
steam.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
streamdeck-ui.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
sway.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
sysdig.nix
system-config-printer.nix
systemtap.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
thefuck.nix nixos/thefuck: rename variable and move fishInitScript into its own variable 2022-05-01 18:08:36 +02:00
thunar.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
tmux.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
traceroute.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
tsm-client.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
turbovnc.nix turbovnc: Add programs.turbovnc, add test for headless software OpenGL 2021-03-14 06:27:43 +01:00
udevil.nix nixos: explicitely set security.wrappers ownership 2021-09-13 13:48:13 +02:00
usbtop.nix
vim.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
virtualbox.nix
wavemon.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
waybar.nix
weylus.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
wireshark.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
wshowkeys.nix nixos: explicitely set security.wrappers ownership 2021-09-13 13:48:13 +02:00
xfconf.nix nixos/xfconf: init 2022-06-26 14:29:01 -03:00
xfs_quota.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
xonsh.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
xss-lock.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
xwayland.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
yabar.nix treewide: automatically md-convert option descriptions 2022-07-30 15:16:34 +02:00
zmap.nix