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/bind.nix | |
parent | 52b0ad17e3727fe0c3ca028787128ede5fb86352 (diff) | |
download | nixpkgs-2e751c0772b9d48ff6923569adfa661b030ab6a2.tar nixpkgs-2e751c0772b9d48ff6923569adfa661b030ab6a2.tar.gz nixpkgs-2e751c0772b9d48ff6923569adfa661b030ab6a2.tar.bz2 nixpkgs-2e751c0772b9d48ff6923569adfa661b030ab6a2.tar.lz nixpkgs-2e751c0772b9d48ff6923569adfa661b030ab6a2.tar.xz nixpkgs-2e751c0772b9d48ff6923569adfa661b030ab6a2.tar.zst nixpkgs-2e751c0772b9d48ff6923569adfa661b030ab6a2.zip |
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/bind.nix')
-rw-r--r-- | nixos/modules/services/networking/bind.nix | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/nixos/modules/services/networking/bind.nix b/nixos/modules/services/networking/bind.nix index 2045612ec05..0966332f7d0 100644 --- a/nixos/modules/services/networking/bind.nix +++ b/nixos/modules/services/networking/bind.nix @@ -17,28 +17,28 @@ let name = mkOption { type = types.str; default = name; - description = "Name of the zone."; + description = lib.mdDoc "Name of the zone."; }; master = mkOption { - description = "Master=false means slave server"; + description = lib.mdDoc "Master=false means slave server"; type = types.bool; }; file = mkOption { type = types.either types.str types.path; - description = "Zone file resource records contain columns of data, separated by whitespace, that define the record."; + description = lib.mdDoc "Zone file resource records contain columns of data, separated by whitespace, that define the record."; }; masters = mkOption { type = types.listOf types.str; - description = "List of servers for inclusion in stub and secondary zones."; + description = lib.mdDoc "List of servers for inclusion in stub and secondary zones."; }; slaves = mkOption { type = types.listOf types.str; - description = "Addresses who may request zone transfers."; + description = lib.mdDoc "Addresses who may request zone transfers."; default = [ ]; }; extraConfig = mkOption { type = types.str; - description = "Extra zone config to be appended at the end of the zone section."; + description = lib.mdDoc "Extra zone config to be appended at the end of the zone section."; default = ""; }; }; @@ -111,7 +111,7 @@ in type = types.package; default = pkgs.bind; defaultText = literalExpression "pkgs.bind"; - description = "The BIND package to use."; + description = lib.mdDoc "The BIND package to use."; }; cacheNetworks = mkOption { @@ -178,7 +178,7 @@ in directory = mkOption { type = types.str; default = "/run/named"; - description = "Working directory of BIND."; + description = lib.mdDoc "Working directory of BIND."; }; zones = mkOption { @@ -209,7 +209,7 @@ in extraOptions = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra lines to be added verbatim to the options section of the generated named configuration file. ''; |