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/video/mirakurun.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/video/mirakurun.nix')
-rw-r--r-- | nixos/modules/services/video/mirakurun.nix | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/nixos/modules/services/video/mirakurun.nix b/nixos/modules/services/video/mirakurun.nix index 35303b2332c67..90119361afabc 100644 --- a/nixos/modules/services/video/mirakurun.nix +++ b/nixos/modules/services/video/mirakurun.nix @@ -29,8 +29,8 @@ in port = mkOption { type = with types; nullOr port; default = 40772; - description = '' - Port to listen on. If <literal>null</literal>, it won't listen on + description = lib.mdDoc '' + Port to listen on. If `null`, it won't listen on any port. ''; }; @@ -54,8 +54,8 @@ in unixSocket = mkOption { type = with types; nullOr path; default = "/var/run/mirakurun/mirakurun.sock"; - description = '' - Path to unix socket to listen on. If <literal>null</literal>, it + description = lib.mdDoc '' + Path to unix socket to listen on. If `null`, it won't listen on any unix sockets. ''; }; @@ -63,7 +63,7 @@ in allowSmartCardAccess = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Install polkit rules to allow Mirakurun to access smart card readers which is commonly used along with tuner devices. ''; @@ -78,11 +78,11 @@ in overflowTimeLimit = 30000; }; ''; - description = '' + description = lib.mdDoc '' Options for server.yml. Documentation: - <link xlink:href="https://github.com/Chinachu/Mirakurun/blob/master/doc/Configuration.md"/> + <https://github.com/Chinachu/Mirakurun/blob/master/doc/Configuration.md> ''; }; @@ -98,12 +98,12 @@ in } ]; ''; - description = '' + description = lib.mdDoc '' Options which are added to tuners.yml. If none is specified, it will automatically be generated at runtime. Documentation: - <link xlink:href="https://github.com/Chinachu/Mirakurun/blob/master/doc/Configuration.md"/> + <https://github.com/Chinachu/Mirakurun/blob/master/doc/Configuration.md> ''; }; @@ -119,12 +119,12 @@ in } ]; ''; - description = '' + description = lib.mdDoc '' Options which are added to channels.yml. If none is specified, it will automatically be generated at runtime. Documentation: - <link xlink:href="https://github.com/Chinachu/Mirakurun/blob/master/doc/Configuration.md"/> + <https://github.com/Chinachu/Mirakurun/blob/master/doc/Configuration.md> ''; }; }; |