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/config/console.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/config/console.nix')
-rw-r--r-- | nixos/modules/config/console.nix | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/nixos/modules/config/console.nix b/nixos/modules/config/console.nix index 97e6405db91e1..ed686ec7310a4 100644 --- a/nixos/modules/config/console.nix +++ b/nixos/modules/config/console.nix @@ -58,7 +58,7 @@ in type = with types; either str path; default = "us"; example = "fr"; - description = '' + description = lib.mdDoc '' The keyboard mapping table for the virtual consoles. ''; }; @@ -72,7 +72,7 @@ in "002b36" "cb4b16" "586e75" "657b83" "839496" "6c71c4" "93a1a1" "fdf6e3" ]; - description = '' + description = lib.mdDoc '' The 16 colors palette used by the virtual consoles. Leave empty to use the default colors. Colors must be in hexadecimal format and listed in @@ -84,7 +84,7 @@ in packages = mkOption { type = types.listOf types.package; default = [ ]; - description = '' + description = lib.mdDoc '' List of additional packages that provide console fonts, keymaps and other resources for virtual consoles use. ''; @@ -93,7 +93,7 @@ in useXkbConfig = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If set, configure the virtual console keymap from the xserver keyboard settings. ''; @@ -102,7 +102,7 @@ in earlySetup = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable setting virtual console options as early as possible (in initrd). ''; }; |