movefasta/nixpkgs
0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-07-11 21:06:19 +03:00
Code Activity

treewide: automatically md-convert option descriptions

Browse source 
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.
This commit is contained in:
pennae 2022-07-28 23:19:15 +02:00
parent 52b0ad17e3
commit 2e751c0772
1050 changed files with 9605 additions and 9605 deletions
Download patch file Download diff file Expand all files Collapse all files

18
nixos/modules/services/networking/ncdns.nix
View file

@ -59,7 +59,7 @@ in
address = mkOption {
type = types.str;
default = "[::1]";
description = ''
description = lib.mdDoc ''
The IP address the ncdns resolver will bind to. Leave this unchanged
if you do not wish to directly expose the resolver.
'';
@ -68,7 +68,7 @@ in
port = mkOption {
type = types.port;
default = 5333;
description = ''
description = lib.mdDoc ''
The port the ncdns resolver will bind to.
'';
};
@ -96,7 +96,7 @@ in
type = types.str;
default = "";
example = "root@example.com";
description = ''
description = lib.mdDoc ''
An email address for the SOA record at the bit zone.
If you are only using ncdns locally you can ignore this.
'';
@ -105,9 +105,9 @@ in
identity.address = mkOption {
type = types.str;
default = "127.127.127.127";
description = ''
description = lib.mdDoc ''
The IP address the hostname specified in
<option>services.ncdns.identity.hostname</option> should resolve to.
{option}`services.ncdns.identity.hostname` should resolve to.
If you are only using ncdns locally you can ignore this.
'';
};
@ -136,7 +136,7 @@ in
dnssec.keys.private = mkOption {
type = types.path;
default = defaultFiles.private;
description = ''
description = lib.mdDoc ''
Path to the file containing the KSK private key.
'';
};
@ -157,7 +157,7 @@ in
dnssec.keys.zonePrivate = mkOption {
type = types.path;
default = defaultFiles.zonePrivate;
description = ''
description = lib.mdDoc ''
Path to the file containing the ZSK private key.
'';
};
@ -189,8 +189,8 @@ in
services.pdns-recursor.resolveNamecoin = mkOption {
type = types.bool;
default = false;
description = ''
Resolve <literal>.bit</literal> top-level domains using ncdns and namecoin.
description = lib.mdDoc ''
Resolve `.bit` top-level domains using ncdns and namecoin.
'';
};