movefasta/nixpkgs
0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-07-14 06:00:33 +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

12
nixos/modules/services/scheduling/atd.nix
View file

@ -19,19 +19,19 @@ in
services.atd.enable = mkOption {
type = types.bool;
default = false;
description = ''
Whether to enable the <command>at</command> daemon, a command scheduler.
description = lib.mdDoc ''
Whether to enable the {command}`at` daemon, a command scheduler.
'';
};
services.atd.allowEveryone = mkOption {
type = types.bool;
default = false;
description = ''
Whether to make <filename>/var/spool/at{jobs,spool}</filename>
description = lib.mdDoc ''
Whether to make {file}`/var/spool/at{jobs,spool}`
writeable by everyone (and sticky). This is normally not
needed since the <command>at</command> commands are
setuid/setgid <literal>atd</literal>.
needed since the {command}`at` commands are
setuid/setgid `atd`.
'';
};

10
nixos/modules/services/scheduling/cron.nix
View file

@ -40,13 +40,13 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = "Whether to enable the Vixie cron daemon.";
description = lib.mdDoc "Whether to enable the Vixie cron daemon.";
};
mailto = mkOption {
type = types.nullOr types.str;
default = null;
description = "Email address to which job output will be mailed.";
description = lib.mdDoc "Email address to which job output will be mailed.";
};
systemCronJobs = mkOption {
@ -57,11 +57,11 @@ in
"* * * * * eelco echo Hello World > /home/eelco/cronout"
]
'';
description = ''
description = lib.mdDoc ''
A list of Cron jobs to be appended to the system-wide
crontab. See the manual page for crontab for the expected
format. If you want to get the results mailed you must setuid
sendmail. See <option>security.wrappers</option>
sendmail. See {option}`security.wrappers`
If neither /var/cron/cron.deny nor /var/cron/cron.allow exist only root
is allowed to have its own crontab file. The /var/cron/cron.deny file
@ -76,7 +76,7 @@ in
cronFiles = mkOption {
type = types.listOf types.path;
default = [];
description = ''
description = lib.mdDoc ''
A list of extra crontab files that will be read and appended to the main
crontab file when the cron service starts.
'';

14
nixos/modules/services/scheduling/fcron.nix
View file

@ -40,40 +40,40 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = "Whether to enable the <command>fcron</command> daemon.";
description = lib.mdDoc "Whether to enable the {command}`fcron` daemon.";
};
allow = mkOption {
type = types.listOf types.str;
default = [ "all" ];
description = ''
description = lib.mdDoc ''
Users allowed to use fcrontab and fcrondyn (one name per
line, <literal>all</literal> for everyone).
line, `all` for everyone).
'';
};
deny = mkOption {
type = types.listOf types.str;
default = [];
description = "Users forbidden from using fcron.";
description = lib.mdDoc "Users forbidden from using fcron.";
};
maxSerialJobs = mkOption {
type = types.int;
default = 1;
description = "Maximum number of serial jobs which can run simultaneously.";
description = lib.mdDoc "Maximum number of serial jobs which can run simultaneously.";
};
queuelen = mkOption {
type = types.nullOr types.int;
default = null;
description = "Number of jobs the serial queue and the lavg queue can contain.";
description = lib.mdDoc "Number of jobs the serial queue and the lavg queue can contain.";
};
systab = mkOption {
type = types.lines;
default = "";
description = ''The "system" crontab contents.'';
description = lib.mdDoc ''The "system" crontab contents.'';
};
};