nixos/*: automatically convert option descriptions

conversions were done using https://github.com/pennae/nix-doc-munge
using (probably) rev f34e145 running

    nix-doc-munge nixos/**/*.nix
    nix-doc-munge --import nixos/**/*.nix

the tool ensures that only changes that could affect the generated
manual *but don't* are committed, other changes require manual review
and are discarded.
This commit is contained in:
pennae
2022-08-28 21:18:44 +02:00
parent 5a643387ec
commit ef176dcf7e
808 changed files with 1523 additions and 1523 deletions

View File

@@ -143,7 +143,7 @@ in
{
options.services.public-inbox = {
enable = mkEnableOption "the public-inbox mail archiver";
enable = mkEnableOption (lib.mdDoc "the public-inbox mail archiver");
package = mkOption {
type = types.package;
default = pkgs.public-inbox;
@@ -218,10 +218,10 @@ in
}));
};
imap = {
enable = mkEnableOption "the public-inbox IMAP server";
enable = mkEnableOption (lib.mdDoc "the public-inbox IMAP server");
} // publicInboxDaemonOptions "imap" 993;
http = {
enable = mkEnableOption "the public-inbox HTTP server";
enable = mkEnableOption (lib.mdDoc "the public-inbox HTTP server");
mounts = mkOption {
type = with types; listOf str;
default = [ "/" ];
@@ -247,16 +247,16 @@ in
};
};
mda = {
enable = mkEnableOption "the public-inbox Mail Delivery Agent";
enable = mkEnableOption (lib.mdDoc "the public-inbox Mail Delivery Agent");
args = mkOption {
type = with types; listOf str;
default = [];
description = lib.mdDoc "Command-line arguments to pass to {manpage}`public-inbox-mda(1)`.";
};
};
postfix.enable = mkEnableOption "the integration into Postfix";
postfix.enable = mkEnableOption (lib.mdDoc "the integration into Postfix");
nntp = {
enable = mkEnableOption "the public-inbox NNTP server";
enable = mkEnableOption (lib.mdDoc "the public-inbox NNTP server");
} // publicInboxDaemonOptions "nntp" 563;
spamAssassinRules = mkOption {
type = with types; nullOr path;
@@ -339,7 +339,7 @@ in
};
};
};
openFirewall = mkEnableOption "opening the firewall when using a port option";
openFirewall = mkEnableOption (lib.mdDoc "opening the firewall when using a port option");
};
config = mkIf cfg.enable {
assertions = [