diff options
author | pennae <github@quasiparticle.net> | 2022-07-28 23:19:15 +0200 |
---|---|---|
committer | pennae <github@quasiparticle.net> | 2022-07-30 15:16:34 +0200 |
commit | 2e751c0772b9d48ff6923569adfa661b030ab6a2 (patch) | |
tree | 0accd740380b7b7fe3ea5965a3a4517674e79260 /nixos/modules/services/hardware/triggerhappy.nix | |
parent | 52b0ad17e3727fe0c3ca028787128ede5fb86352 (diff) |
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.
Diffstat (limited to 'nixos/modules/services/hardware/triggerhappy.nix')
-rw-r--r-- | nixos/modules/services/hardware/triggerhappy.nix | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/nixos/modules/services/hardware/triggerhappy.nix b/nixos/modules/services/hardware/triggerhappy.nix index c2fa87875e115..54eac70643ffc 100644 --- a/nixos/modules/services/hardware/triggerhappy.nix +++ b/nixos/modules/services/hardware/triggerhappy.nix @@ -22,18 +22,18 @@ let keys = mkOption { type = types.listOf types.str; - description = "List of keys to match. Key names as defined in linux/input-event-codes.h"; + description = lib.mdDoc "List of keys to match. Key names as defined in linux/input-event-codes.h"; }; event = mkOption { type = types.enum ["press" "hold" "release"]; default = "press"; - description = "Event to match."; + description = lib.mdDoc "Event to match."; }; cmd = mkOption { type = types.str; - description = "What to run."; + description = lib.mdDoc "What to run."; }; }; @@ -52,8 +52,8 @@ in enable = mkOption { type = types.bool; default = false; - description = '' - Whether to enable the <command>triggerhappy</command> hotkey daemon. + description = lib.mdDoc '' + Whether to enable the {command}`triggerhappy` hotkey daemon. ''; }; @@ -61,8 +61,8 @@ in type = types.str; default = "nobody"; example = "root"; - description = '' - User account under which <command>triggerhappy</command> runs. + description = lib.mdDoc '' + User account under which {command}`triggerhappy` runs. ''; }; @@ -72,16 +72,16 @@ in example = lib.literalExpression '' [ { keys = ["PLAYPAUSE"]; cmd = "''${pkgs.mpc-cli}/bin/mpc -q toggle"; } ] ''; - description = '' - Key bindings for <command>triggerhappy</command>. + description = lib.mdDoc '' + Key bindings for {command}`triggerhappy`. ''; }; extraConfig = mkOption { type = types.lines; default = ""; - description = '' - Literal contents to append to the end of <command>triggerhappy</command> configuration file. + description = lib.mdDoc '' + Literal contents to append to the end of {command}`triggerhappy` configuration file. ''; }; |