gador/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki 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

12
nixos/modules/services/networking/pppd.nix
View File

@@ -18,12 +18,12 @@ in
default = pkgs.ppp;
defaultText = literalExpression "pkgs.ppp";
type = types.package;
description = "pppd package to use.";
description = lib.mdDoc "pppd package to use.";
};
peers = mkOption {
default = {};
description = "pppd peers.";
description = lib.mdDoc "pppd peers.";
type = types.attrsOf (types.submodule (
{ name, ... }:
{
@@ -32,27 +32,27 @@ in
type = types.str;
default = name;
example = "dialup";
description = "Name of the PPP peer.";
description = lib.mdDoc "Name of the PPP peer.";
};
enable = mkOption {
type = types.bool;
default = true;
example = false;
description = "Whether to enable this PPP peer.";
description = lib.mdDoc "Whether to enable this PPP peer.";
};
autostart = mkOption {
type = types.bool;
default = true;
example = false;
description = "Whether the PPP session is automatically started at boot time.";
description = lib.mdDoc "Whether the PPP session is automatically started at boot time.";
};
config = mkOption {
type = types.lines;
default = "";
description = "pppd configuration for this peer, see the pppd(8) man page.";
description = lib.mdDoc "pppd configuration for this peer, see the pppd(8) man page.";
};
};
}));