movefasta/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-15 22:19:17 +03:00
Code Issues Projects Releases Packages Wiki Activity

nixos/public-inbox: convert option descriptions to MD

Browse source 
no change to manpage or html.
This commit is contained in:
pennae 2022-08-21 00:05:09 +02:00 • committed by pennae
parent 429ae9ff3d
commit 0046b457d5
1 changed files with 11 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

24
nixos/modules/services/mail/public-inbox.nix
View file

@ -6,8 +6,6 @@ let
cfg = config.services.public-inbox; cfg = config.services.public-inbox;
stateDir = "/var/lib/public-inbox"; stateDir = "/var/lib/public-inbox";
manref = name: vol: "<citerefentry><refentrytitle>${name}</refentrytitle><manvolnum>${toString vol}</manvolnum></citerefentry>";
gitIni = pkgs.formats.gitIni { listsAsDuplicateKeys = true; }; gitIni = pkgs.formats.gitIni { listsAsDuplicateKeys = true; };
iniAtom = elemAt gitIni.type/*attrsOf*/.functor.wrapped/*attrsOf*/.functor.wrapped/*either*/.functor.wrapped 0; iniAtom = elemAt gitIni.type/*attrsOf*/.functor.wrapped/*attrsOf*/.functor.wrapped/*either*/.functor.wrapped 0;
@ -18,7 +16,7 @@ let
args = mkOption { args = mkOption {
type = with types; listOf str; type = with types; listOf str;
default = []; default = [];
description = "Command-line arguments to pass to ${manref "public-inbox-${proto}d" 1}."; description = lib.mdDoc "Command-line arguments to pass to {manpage}`public-inbox-${proto}d(1)`.";
}; };
port = mkOption { port = mkOption {
type = with types; nullOr (either str port); type = with types; nullOr (either str port);
@ -34,13 +32,13 @@ let
type = with types; nullOr str; type = with types; nullOr str;
default = null; default = null;
example = "/path/to/fullchain.pem"; example = "/path/to/fullchain.pem";
description = "Path to TLS certificate to use for connections to ${manref "public-inbox-${proto}d" 1}."; description = lib.mdDoc "Path to TLS certificate to use for connections to {manpage}`public-inbox-${proto}d(1)`.";
}; };
key = mkOption { key = mkOption {
type = with types; nullOr str; type = with types; nullOr str;
default = null; default = null;
example = "/path/to/key.pem"; example = "/path/to/key.pem";
description = "Path to TLS key to use for connections to ${manref "public-inbox-${proto}d" 1}."; description = lib.mdDoc "Path to TLS key to use for connections to {manpage}`public-inbox-${proto}d(1)`.";
}; };
}; };
@ -198,15 +196,15 @@ in
options.watch = mkOption { options.watch = mkOption {
type = with types; listOf str; type = with types; listOf str;
default = []; default = [];
description = "Paths for ${manref "public-inbox-watch" 1} to monitor for new mail."; description = lib.mdDoc "Paths for {manpage}`public-inbox-watch(1)` to monitor for new mail.";
example = [ "maildir:/path/to/test.example.com.git" ]; example = [ "maildir:/path/to/test.example.com.git" ];
}; };
options.watchheader = mkOption { options.watchheader = mkOption {
type = with types; nullOr str; type = with types; nullOr str;
default = null; default = null;
example = "List-Id:<test@example.com>"; example = "List-Id:<test@example.com>";
description = '' description = lib.mdDoc ''
If specified, ${manref "public-inbox-watch" 1} will only process If specified, {manpage}`public-inbox-watch(1)` will only process
mail containing a matching header. mail containing a matching header.
''; '';
}; };
@ -253,7 +251,7 @@ in
args = mkOption { args = mkOption {
type = with types; listOf str; type = with types; listOf str;
default = []; default = [];
description = "Command-line arguments to pass to ${manref "public-inbox-mda" 1}."; description = lib.mdDoc "Command-line arguments to pass to {manpage}`public-inbox-mda(1)`.";
}; };
}; };
postfix.enable = mkEnableOption "the integration into Postfix"; postfix.enable = mkEnableOption "the integration into Postfix";
@ -302,16 +300,16 @@ in
options.publicinboxmda.spamcheck = mkOption { options.publicinboxmda.spamcheck = mkOption {
type = with types; enum [ "spamc" "none" ]; type = with types; enum [ "spamc" "none" ];
default = "none"; default = "none";
description = '' description = lib.mdDoc ''
If set to spamc, ${manref "public-inbox-watch" 1} will filter spam If set to spamc, {manpage}`public-inbox-watch(1)` will filter spam
using SpamAssassin. using SpamAssassin.
''; '';
}; };
options.publicinboxwatch.spamcheck = mkOption { options.publicinboxwatch.spamcheck = mkOption {
type = with types; enum [ "spamc" "none" ]; type = with types; enum [ "spamc" "none" ];
default = "none"; default = "none";
description = '' description = lib.mdDoc ''
If set to spamc, ${manref "public-inbox-watch" 1} will filter spam If set to spamc, {manpage}`public-inbox-watch(1)` will filter spam
using SpamAssassin. using SpamAssassin.
''; '';
}; };