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/misc/errbot.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/misc/errbot.nix')
-rw-r--r-- | nixos/modules/services/misc/errbot.nix | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/nixos/modules/services/misc/errbot.nix b/nixos/modules/services/misc/errbot.nix index b447ba5d438d2..a650bc5bbd921 100644 --- a/nixos/modules/services/misc/errbot.nix +++ b/nixos/modules/services/misc/errbot.nix @@ -27,48 +27,48 @@ in { options = { services.errbot.instances = mkOption { default = {}; - description = "Errbot instance configs"; + description = lib.mdDoc "Errbot instance configs"; type = types.attrsOf (types.submodule { options = { dataDir = mkOption { type = types.nullOr types.path; default = null; - description = "Data directory for errbot instance."; + description = lib.mdDoc "Data directory for errbot instance."; }; plugins = mkOption { type = types.listOf types.package; default = []; - description = "List of errbot plugin derivations."; + description = lib.mdDoc "List of errbot plugin derivations."; }; logLevel = mkOption { type = types.str; default = "INFO"; - description = "Errbot log level"; + description = lib.mdDoc "Errbot log level"; }; admins = mkOption { type = types.listOf types.str; default = []; - description = "List of identifiers of errbot admins."; + description = lib.mdDoc "List of identifiers of errbot admins."; }; backend = mkOption { type = types.str; default = "XMPP"; - description = "Errbot backend name."; + description = lib.mdDoc "Errbot backend name."; }; identity = mkOption { type = types.attrs; - description = "Errbot identity configuration"; + description = lib.mdDoc "Errbot identity configuration"; }; extraConfig = mkOption { type = types.lines; default = ""; - description = "String to be appended to the config verbatim"; + description = lib.mdDoc "String to be appended to the config verbatim"; }; }; }); |