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/networking/openconnect.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/networking/openconnect.nix')
-rw-r--r-- | nixos/modules/services/networking/openconnect.nix | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/nixos/modules/services/networking/openconnect.nix b/nixos/modules/services/networking/openconnect.nix index bc873b2198bcc..c5313bb305a2d 100644 --- a/nixos/modules/services/networking/openconnect.nix +++ b/nixos/modules/services/networking/openconnect.nix @@ -11,25 +11,25 @@ let options = { autoStart = mkOption { default = true; - description = "Whether this VPN connection should be started automatically."; + description = lib.mdDoc "Whether this VPN connection should be started automatically."; type = types.bool; }; gateway = mkOption { - description = "Gateway server to connect to."; + description = lib.mdDoc "Gateway server to connect to."; example = "gateway.example.com"; type = types.str; }; protocol = mkOption { - description = "Protocol to use."; + description = lib.mdDoc "Protocol to use."; example = "anyconnect"; type = types.enum [ "anyconnect" "array" "nc" "pulse" "gp" "f5" "fortinet" ]; }; user = mkOption { - description = "Username to authenticate with."; + description = lib.mdDoc "Username to authenticate with."; example = "example-user"; type = types.nullOr types.str; }; @@ -49,14 +49,14 @@ let }; certificate = mkOption { - description = "Certificate to authenticate with."; + description = lib.mdDoc "Certificate to authenticate with."; default = null; example = "/var/lib/secrets/openconnect_certificate.pem"; type = with types; nullOr (either path pkcs11); }; privateKey = mkOption { - description = "Private key to authenticate with."; + description = lib.mdDoc "Private key to authenticate with."; example = "/var/lib/secrets/openconnect_private_key.pem"; default = null; type = with types; nullOr (either path pkcs11); @@ -118,7 +118,7 @@ in { package = mkPackageOption pkgs "openconnect" { }; interfaces = mkOption { - description = "OpenConnect interfaces."; + description = lib.mdDoc "OpenConnect interfaces."; default = { }; example = { openconnect0 = { |