From 2e751c0772b9d48ff6923569adfa661b030ab6a2 Mon Sep 17 00:00:00 2001 From: pennae Date: Thu, 28 Jul 2022 23:19:15 +0200 Subject: 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 and , so any option using such tags will not be converted at all. --- nixos/modules/i18n/input-method/fcitx5.nix | 2 +- nixos/modules/i18n/input-method/kime.nix | 4 ++-- nixos/modules/i18n/input-method/uim.nix | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) (limited to 'nixos/modules/i18n') diff --git a/nixos/modules/i18n/input-method/fcitx5.nix b/nixos/modules/i18n/input-method/fcitx5.nix index 9ef0285f7b93..7cdef9ae9321 100644 --- a/nixos/modules/i18n/input-method/fcitx5.nix +++ b/nixos/modules/i18n/input-method/fcitx5.nix @@ -15,7 +15,7 @@ in { type = with types; listOf package; default = []; example = literalExpression "with pkgs; [ fcitx5-rime ]"; - description = '' + description = lib.mdDoc '' Enabled Fcitx5 addons. ''; }; diff --git a/nixos/modules/i18n/input-method/kime.nix b/nixos/modules/i18n/input-method/kime.nix index 729a665614ae..29224a6bf75f 100644 --- a/nixos/modules/i18n/input-method/kime.nix +++ b/nixos/modules/i18n/input-method/kime.nix @@ -27,8 +27,8 @@ in }; } ''; - description = '' - kime configuration. Refer to for details on supported values. + description = lib.mdDoc '' + kime configuration. Refer to for details on supported values. ''; }; }; diff --git a/nixos/modules/i18n/input-method/uim.nix b/nixos/modules/i18n/input-method/uim.nix index 459294657e0a..9491ab2640fc 100644 --- a/nixos/modules/i18n/input-method/uim.nix +++ b/nixos/modules/i18n/input-method/uim.nix @@ -13,7 +13,7 @@ in type = types.enum [ "gtk" "gtk3" "gtk-systray" "gtk3-systray" "qt4" ]; default = "gtk"; example = "gtk-systray"; - description = '' + description = lib.mdDoc '' selected UIM toolbar. ''; }; -- cgit 1.4.1