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/services/x11/desktop-managers/phosh.nix | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'nixos/modules/services/x11/desktop-managers/phosh.nix') diff --git a/nixos/modules/services/x11/desktop-managers/phosh.nix b/nixos/modules/services/x11/desktop-managers/phosh.nix index 5efe645d8aa..0ff5d6fd1b1 100644 --- a/nixos/modules/services/x11/desktop-managers/phosh.nix +++ b/nixos/modules/services/x11/desktop-managers/phosh.nix @@ -132,7 +132,7 @@ in enable = mkOption { type = types.bool; default = false; - description = "Enable the Phone Shell."; + description = lib.mdDoc "Enable the Phone Shell."; }; package = mkOption { @@ -140,25 +140,25 @@ in default = pkgs.phosh; defaultText = literalExpression "pkgs.phosh"; example = literalExpression "pkgs.phosh"; - description = '' + description = lib.mdDoc '' Package that should be used for Phosh. ''; }; user = mkOption { - description = "The user to run the Phosh service."; + description = lib.mdDoc "The user to run the Phosh service."; type = types.str; example = "alice"; }; group = mkOption { - description = "The group to run the Phosh service."; + description = lib.mdDoc "The group to run the Phosh service."; type = types.str; example = "users"; }; phocConfig = mkOption { - description = '' + description = lib.mdDoc '' Configurations for the Phoc compositor. ''; type = types.oneOf [ types.lines types.path phocConfigType ]; -- cgit 1.4.1