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

6
nixos/modules/services/computing/boinc/client.nix
View File

@@ -19,7 +19,7 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether to enable the BOINC distributed computing client. If this
option is set to true, the boinc_client daemon will be run as a
background service. The boinccmd command can be used to control the
@@ -31,7 +31,7 @@ in
type = types.package;
default = pkgs.boinc;
defaultText = literalExpression "pkgs.boinc";
description = ''
description = lib.mdDoc ''
Which BOINC package to use.
'';
};
@@ -39,7 +39,7 @@ in
dataDir = mkOption {
type = types.path;
default = "/var/lib/boinc";
description = ''
description = lib.mdDoc ''
The directory in which to store BOINC's configuration and data files.
'';
};

12
nixos/modules/services/computing/foldingathome/client.nix
View File

@@ -24,7 +24,7 @@ in
type = types.package;
default = pkgs.fahclient;
defaultText = literalExpression "pkgs.fahclient";
description = ''
description = lib.mdDoc ''
Which Folding@home client to use.
'';
};
@@ -32,7 +32,7 @@ in
user = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
description = lib.mdDoc ''
The user associated with the reported computation results. This will
be used in the ranking statistics.
'';
@@ -41,7 +41,7 @@ in
team = mkOption {
type = types.int;
default = 236565;
description = ''
description = lib.mdDoc ''
The team ID associated with the reported computation results. This
will be used in the ranking statistics.
@@ -52,7 +52,7 @@ in
daemonNiceLevel = mkOption {
type = types.ints.between (-20) 19;
default = 0;
description = ''
description = lib.mdDoc ''
Daemon process priority for FAHClient.
0 is the default Unix process priority, 19 is the lowest.
'';
@@ -61,9 +61,9 @@ in
extraArgs = mkOption {
type = types.listOf types.str;
default = [];
description = ''
description = lib.mdDoc ''
Extra startup options for the FAHClient. Run
<literal>FAHClient --help</literal> to find all the available options.
`FAHClient --help` to find all the available options.
'';
};
};

62
nixos/modules/services/computing/slurm/slurm.nix
View File

@@ -66,11 +66,11 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether to enable the slurm control daemon.
Note that the standard authentication method is "munge".
The "munge" service needs to be provided with a password file in order for
slurm to work properly (see <literal>services.munge.password</literal>).
slurm to work properly (see `services.munge.password`).
'';
};
};
@@ -82,9 +82,9 @@ in
type = types.str;
default = config.networking.hostName;
defaultText = literalExpression "config.networking.hostName";
description = ''
Hostname of the machine where <literal>slurmdbd</literal>
is running (i.e. name returned by <literal>hostname -s</literal>).
description = lib.mdDoc ''
Hostname of the machine where `slurmdbd`
is running (i.e. name returned by `hostname -s`).
'';
};
@@ -92,7 +92,7 @@ in
type = types.str;
default = cfg.user;
defaultText = literalExpression "config.${opt.user}";
description = ''
description = lib.mdDoc ''
Database user name.
'';
};
@@ -100,9 +100,9 @@ in
storagePassFile = mkOption {
type = with types; nullOr str;
default = null;
description = ''
description = lib.mdDoc ''
Path to file with database password. The content of this will be used to
create the password for the <literal>StoragePass</literal> option.
create the password for the `StoragePass` option.
'';
};
@@ -124,10 +124,10 @@ in
enableStools = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether to provide a slurm.conf file.
Enable this option if you do not run a slurm daemon on this host
(i.e. <literal>server.enable</literal> and <literal>client.enable</literal> are <literal>false</literal>)
(i.e. `server.enable` and `client.enable` are `false`)
but you still want to run slurm commands from this host.
'';
};
@@ -137,7 +137,7 @@ in
default = pkgs.slurm.override { enableX11 = ! cfg.enableSrunX11; };
defaultText = literalExpression "pkgs.slurm";
example = literalExpression "pkgs.slurm-full";
description = ''
description = lib.mdDoc ''
The package to use for slurm binaries.
'';
};
@@ -146,7 +146,7 @@ in
type = types.nullOr types.str;
default = null;
example = null;
description = ''
description = lib.mdDoc ''
The short hostname of the machine where SLURM control functions are
executed (i.e. the name returned by the command "hostname -s", use "tux001"
rather than "tux001.my.com").
@@ -158,7 +158,7 @@ in
default = cfg.controlMachine;
defaultText = literalExpression "config.${opt.controlMachine}";
example = null;
description = ''
description = lib.mdDoc ''
Name that ControlMachine should be referred to in establishing a
communications path.
'';
@@ -168,7 +168,7 @@ in
type = types.str;
default = "default";
example = "myCluster";
description = ''
description = lib.mdDoc ''
Necessary to distinguish accounting records in a multi-cluster environment.
'';
};
@@ -177,7 +177,7 @@ in
type = types.listOf types.str;
default = [];
example = literalExpression ''[ "linux[1-32] CPUs=1 State=UNKNOWN" ];'';
description = ''
description = lib.mdDoc ''
Name that SLURM uses to refer to a node (or base partition for BlueGene
systems). Typically this would be the string that "/bin/hostname -s"
returns. Note that now you have to write node's parameters after the name.
@@ -188,7 +188,7 @@ in
type = types.listOf types.str;
default = [];
example = literalExpression ''[ "debug Nodes=linux[1-32] Default=YES MaxTime=INFINITE State=UP" ];'';
description = ''
description = lib.mdDoc ''
Name by which the partition may be referenced. Note that now you have
to write the partition's parameters after the name.
'';
@@ -197,17 +197,17 @@ in
enableSrunX11 = mkOption {
default = false;
type = types.bool;
description = ''
description = lib.mdDoc ''
If enabled srun will accept the option "--x11" to allow for X11 forwarding
from within an interactive session or a batch job. This activates the
slurm-spank-x11 module. Note that this option also enables
<option>services.openssh.forwardX11</option> on the client.
{option}`services.openssh.forwardX11` on the client.
This option requires slurm to be compiled without native X11 support.
The default behavior is to re-compile the slurm package with native X11
support disabled if this option is set to true.
To use the native X11 support add <literal>PrologFlags=X11</literal> in <option>extraConfig</option>.
To use the native X11 support add `PrologFlags=X11` in {option}`extraConfig`.
Note that this method will only work RSA SSH host keys.
'';
};
@@ -215,7 +215,7 @@ in
procTrackType = mkOption {
type = types.str;
default = "proctrack/linuxproc";
description = ''
description = lib.mdDoc ''
Plugin to be used for process tracking on a job step basis.
The slurmd daemon uses this mechanism to identify all processes
which are children of processes it spawns for a user job step.
@@ -225,7 +225,7 @@ in
stateSaveLocation = mkOption {
type = types.str;
default = "/var/spool/slurmctld";
description = ''
description = lib.mdDoc ''
Directory into which the Slurm controller, slurmctld, saves its state.
'';
};
@@ -233,7 +233,7 @@ in
user = mkOption {
type = types.str;
default = defaultUser;
description = ''
description = lib.mdDoc ''
Set this option when you want to run the slurmctld daemon
as something else than the default slurm user "slurm".
Note that the UID of this user needs to be the same
@@ -244,7 +244,7 @@ in
extraConfig = mkOption {
default = "";
type = types.lines;
description = ''
description = lib.mdDoc ''
Extra configuration options that will be added verbatim at
the end of the slurm configuration file.
'';
@@ -253,28 +253,28 @@ in
extraPlugstackConfig = mkOption {
default = "";
type = types.lines;
description = ''
Extra configuration that will be added to the end of <literal>plugstack.conf</literal>.
description = lib.mdDoc ''
Extra configuration that will be added to the end of `plugstack.conf`.
'';
};
extraCgroupConfig = mkOption {
default = "";
type = types.lines;
description = ''
Extra configuration for <literal>cgroup.conf</literal>. This file is
used when <literal>procTrackType=proctrack/cgroup</literal>.
description = lib.mdDoc ''
Extra configuration for `cgroup.conf`. This file is
used when `procTrackType=proctrack/cgroup`.
'';
};
extraConfigPaths = mkOption {
type = with types; listOf path;
default = [];
description = ''
description = lib.mdDoc ''
Slurm expects config files for plugins in the same path
as <literal>slurm.conf</literal>. Add extra nix store
as `slurm.conf`. Add extra nix store
paths that should be merged into same directory as
<literal>slurm.conf</literal>.
`slurm.conf`.
'';
};

2
nixos/modules/services/computing/torque/mom.nix
View File

@@ -21,7 +21,7 @@ in
serverNode = mkOption {
type = types.str;
description = "Hostname running pbs server.";
description = lib.mdDoc "Hostname running pbs server.";
};
};