nix/2.home-manager
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4

treewide: remove now-redundant lib.mdDoc calls

Browse source 
These (and the `*MD` functions apart from `literalMD`) are now no-ops
in nixpkgs and serve no purpose other than to add additional noise and
potentially mislead people into thinking unmarked DocBook documentation
will still be accepted.

Note that if backporting changes including documentation to 23.05,
the `mdDoc` calls will need to be re-added.

To reproduce this commit, run:

    $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
      nix shell nixpkgs#coreutils \
      -c find . -name '*.nix' \
      -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
      --strip {} +
    $ ./format
This commit is contained in:
Emily 2023-07-02 00:45:18 +01:00
parent 7398af11b8
commit 9f9e277b60
360 changed files with 2672 additions and 2853 deletions
Download patch file Download diff file Expand all files Collapse all files

30
modules/accounts/calendar.nix
View file

@ -13,24 +13,24 @@ let
type = types.str;
default = "${cfg.basePath}/${name}";
defaultText = "‹accounts.calendar.basePath›/‹name›";
description = lib.mdDoc "The path of the storage.";
description = "The path of the storage.";
};
type = mkOption {
type = types.enum [ "filesystem" "singlefile" ];
description = lib.mdDoc "The type of the storage.";
description = "The type of the storage.";
};
fileExt = mkOption {
type = types.nullOr types.str;
default = null;
description = lib.mdDoc "The file extension to use.";
description = "The file extension to use.";
};
encoding = mkOption {
type = types.nullOr types.str;
default = null;
description = lib.mdDoc ''
description = ''
File encoding for items, both content and file name.
Defaults to UTF-8.
'';
@ -42,19 +42,19 @@ let
options = {
type = mkOption {
type = types.enum [ "caldav" "http" "google_calendar" ];
description = lib.mdDoc "The type of the storage.";
description = "The type of the storage.";
};
url = mkOption {
type = types.nullOr types.str;
default = null;
description = lib.mdDoc "The URL of the storage.";
description = "The URL of the storage.";
};
userName = mkOption {
type = types.nullOr types.str;
default = null;
description = lib.mdDoc "User name for authentication.";
description = "User name for authentication.";
};
# userNameCommand = mkOption {
@ -70,7 +70,7 @@ let
type = types.nullOr (types.listOf types.str);
default = null;
example = [ "pass" "caldav" ];
description = lib.mdDoc ''
description = ''
A command that prints the password to standard output.
'';
};
@ -82,7 +82,7 @@ let
name = mkOption {
type = types.str;
readOnly = true;
description = lib.mdDoc ''
description = ''
Unique identifier of the calendar. This is set to the
attribute name of the calendar configuration.
'';
@ -91,7 +91,7 @@ let
primary = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether this is the primary account. Only one account may be
set as primary.
'';
@ -99,7 +99,7 @@ let
primaryCollection = mkOption {
type = types.str;
description = lib.mdDoc ''
description = ''
The primary collection of the account. Required when an
account has multiple collections.
'';
@ -108,7 +108,7 @@ let
local = mkOption {
type = types.nullOr (localModule name);
default = null;
description = lib.mdDoc ''
description = ''
Local configuration for the calendar.
'';
};
@ -116,7 +116,7 @@ let
remote = mkOption {
type = types.nullOr remoteModule;
default = null;
description = lib.mdDoc ''
description = ''
Remote configuration for the calendar.
'';
};
@ -131,7 +131,7 @@ in {
type = types.str;
apply = p:
if hasPrefix "/" p then p else "${config.home.homeDirectory}/${p}";
description = lib.mdDoc ''
description = ''
The base directory in which to save calendars. May be a
relative path, in which case it is relative the home
directory.
@ -146,7 +146,7 @@ in {
(import ../programs/khal-calendar-accounts.nix)
]);
default = { };
description = lib.mdDoc "List of calendars.";
description = "List of calendars.";
};
};
config = mkIf (cfg.accounts != { }) {

26
modules/accounts/contacts.nix
View file

@ -13,24 +13,24 @@ let
type = types.str;
default = "${cfg.basePath}/${name}";
defaultText = "‹accounts.contact.basePath›/‹name›";
description = lib.mdDoc "The path of the storage.";
description = "The path of the storage.";
};
type = mkOption {
type = types.enum [ "filesystem" "singlefile" ];
description = lib.mdDoc "The type of the storage.";
description = "The type of the storage.";
};
fileExt = mkOption {
type = types.nullOr types.str;
default = null;
description = lib.mdDoc "The file extension to use.";
description = "The file extension to use.";
};
encoding = mkOption {
type = types.nullOr types.str;
default = null;
description = lib.mdDoc ''
description = ''
File encoding for items, both content and file name.
Defaults to UTF-8.
'';
@ -42,19 +42,19 @@ let
options = {
type = mkOption {
type = types.enum [ "carddav" "http" "google_contacts" ];
description = lib.mdDoc "The type of the storage.";
description = "The type of the storage.";
};
url = mkOption {
type = types.nullOr types.str;
default = null;
description = lib.mdDoc "The URL of the storage.";
description = "The URL of the storage.";
};
userName = mkOption {
type = types.nullOr types.str;
default = null;
description = lib.mdDoc "User name for authentication.";
description = "User name for authentication.";
};
# userNameCommand = mkOption {
@ -70,7 +70,7 @@ let
type = types.nullOr (types.listOf types.str);
default = null;
example = [ "pass" "caldav" ];
description = lib.mdDoc ''
description = ''
A command that prints the password to standard output.
'';
};
@ -82,7 +82,7 @@ let
name = mkOption {
type = types.str;
readOnly = true;
description = lib.mdDoc ''
description = ''
Unique identifier of the contact account. This is set to the
attribute name of the contact configuration.
'';
@ -91,7 +91,7 @@ let
local = mkOption {
type = types.nullOr (localModule name);
default = null;
description = lib.mdDoc ''
description = ''
Local configuration for the contacts.
'';
};
@ -99,7 +99,7 @@ let
remote = mkOption {
type = types.nullOr remoteModule;
default = null;
description = lib.mdDoc ''
description = ''
Remote configuration for the contacts.
'';
};
@ -114,7 +114,7 @@ in {
type = types.str;
apply = p:
if hasPrefix "/" p then p else "${config.home.homeDirectory}/${p}";
description = lib.mdDoc ''
description = ''
The base directory in which to save contacts. May be a
relative path, in which case it is relative the home
directory.
@ -128,7 +128,7 @@ in {
(import ../programs/khal-accounts.nix)
]);
default = { };
description = lib.mdDoc "List of contacts.";
description = "List of contacts.";
};
};
}

84
modules/accounts/email.nix
View file

@ -10,7 +10,7 @@ let
options = {
key = mkOption {
type = types.str;
description = lib.mdDoc ''
description = ''
The key to use as listed in {command}`gpg --list-keys`.
'';
};
@ -18,13 +18,13 @@ let
signByDefault = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Sign messages by default.";
description = "Sign messages by default.";
};
encryptByDefault = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "Encrypt outgoing messages by default.";
description = "Encrypt outgoing messages by default.";
};
};
};
@ -39,7 +39,7 @@ let
Luke Skywalker
May the force be with you.
'';
description = lib.mdDoc ''
description = ''
Signature content.
'';
};
@ -52,7 +52,7 @@ let
example = literalExpression ''
~*~*~*~*~*~*~*~*~*~*~*~
'';
description = lib.mdDoc ''
description = ''
The delimiter used between the document and the signature.
'';
};
@ -63,13 +63,13 @@ let
example = literalExpression ''
pkgs.writeScript "signature" "echo This is my signature"
'';
description = lib.mdDoc "A command that generates a signature.";
description = "A command that generates a signature.";
};
showSignature = mkOption {
type = types.enum [ "append" "attach" "none" ];
default = "none";
description = lib.mdDoc "Method to communicate the signature.";
description = "Method to communicate the signature.";
};
};
};
@ -79,7 +79,7 @@ let
enable = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
description = ''
Whether to enable TLS/SSL.
'';
};
@ -87,7 +87,7 @@ let
useStartTls = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to use STARTTLS.
'';
};
@ -96,7 +96,7 @@ let
type = types.nullOr types.path;
default = config.accounts.email.certificatesFile;
defaultText = "config.accounts.email.certificatesFile";
description = lib.mdDoc ''
description = ''
Path to file containing certificate authorities that should
be used to validate the connection authenticity. If
`null` then the system default is used.
@ -111,7 +111,7 @@ let
host = mkOption {
type = types.str;
example = "imap.example.org";
description = lib.mdDoc ''
description = ''
Hostname of IMAP server.
'';
};
@ -120,7 +120,7 @@ let
type = types.nullOr types.port;
default = null;
example = 993;
description = lib.mdDoc ''
description = ''
The port on which the IMAP server listens. If
`null` then the default port is used.
'';
@ -129,7 +129,7 @@ let
tls = mkOption {
type = tlsModule;
default = { };
description = lib.mdDoc ''
description = ''
Configuration for secure connections.
'';
};
@ -142,7 +142,7 @@ let
type = types.nullOr types.str;
default = null;
example = "jmap.example.org";
description = lib.mdDoc ''
description = ''
Hostname of JMAP server.
If both this option and [](#opt-accounts.email.accounts._name_.jmap.sessionUrl) are specified,
@ -155,7 +155,7 @@ let
type = types.nullOr types.str;
default = null;
example = "https://jmap.example.org:443/.well-known/jmap";
description = lib.mdDoc ''
description = ''
URL for the JMAP Session resource.
If both this option and [](#opt-accounts.email.accounts._name_.jmap.host) are specified,
@ -171,7 +171,7 @@ let
host = mkOption {
type = types.str;
example = "smtp.example.org";
description = lib.mdDoc ''
description = ''
Hostname of SMTP server.
'';
};
@ -180,7 +180,7 @@ let
type = types.nullOr types.port;
default = null;
example = 465;
description = lib.mdDoc ''
description = ''
The port on which the SMTP server listens. If
`null` then the default port is used.
'';
@ -189,7 +189,7 @@ let
tls = mkOption {
type = tlsModule;
default = { };
description = lib.mdDoc ''
description = ''
Configuration for secure connections.
'';
};
@ -200,7 +200,7 @@ let
options = {
path = mkOption {
type = types.str;
description = lib.mdDoc ''
description = ''
Path to maildir directory where mail for this account is
stored. This is relative to the base maildir path.
'';
@ -211,7 +211,7 @@ let
readOnly = true;
internal = true;
default = "${cfg.maildirBasePath}/${config.path}";
description = lib.mdDoc ''
description = ''
A convenience option whose value is the absolute path of
this maildir.
'';
@ -224,7 +224,7 @@ let
name = mkOption {
type = types.str;
readOnly = true;
description = lib.mdDoc ''
description = ''
Unique identifier of the account. This is set to the
attribute name of the account configuration.
'';
@ -233,7 +233,7 @@ let
primary = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether this is the primary account. Only one account may be
set as primary.
'';
@ -249,7 +249,7 @@ let
"outlook.office365.com"
];
default = "plain";
description = lib.mdDoc ''
description = ''
Some email providers have peculiar behavior that require
special treatment. This option is therefore intended to
indicate the nature of the provider.
@ -263,26 +263,26 @@ let
address = mkOption {
type = types.strMatching ".*@.*";
example = "jane.doe@example.org";
description = lib.mdDoc "The email address of this account.";
description = "The email address of this account.";
};
aliases = mkOption {
type = types.listOf (types.strMatching ".*@.*");
default = [ ];
example = [ "webmaster@example.org" "admin@example.org" ];
description = lib.mdDoc "Alternative email addresses of this account.";
description = "Alternative email addresses of this account.";
};
realName = mkOption {
type = types.str;
example = "Jane Doe";
description = lib.mdDoc "Name displayed when sending mails.";
description = "Name displayed when sending mails.";
};
userName = mkOption {
type = types.nullOr types.str;
default = null;
description = lib.mdDoc ''
description = ''
The server username of this account. This will be used as
the SMTP, IMAP, and JMAP user name.
'';
@ -293,7 +293,7 @@ let
default = null;
apply = p: if isString p then splitString " " p else p;
example = "secret-tool lookup email me@example.org";
description = lib.mdDoc ''
description = ''
A command, which when run writes the account password on
standard output.
'';
@ -305,7 +305,7 @@ let
inbox = mkOption {
type = types.str;
default = "Inbox";
description = lib.mdDoc ''
description = ''
Relative path of the inbox mail.
'';
};
@ -313,7 +313,7 @@ let
sent = mkOption {
type = types.nullOr types.str;
default = "Sent";
description = lib.mdDoc ''
description = ''
Relative path of the sent mail folder.
'';
};
@ -321,7 +321,7 @@ let
drafts = mkOption {
type = types.nullOr types.str;
default = "Drafts";
description = lib.mdDoc ''
description = ''
Relative path of the drafts mail folder.
'';
};
@ -329,14 +329,14 @@ let
trash = mkOption {
type = types.str;
default = "Trash";
description = lib.mdDoc ''
description = ''
Relative path of the deleted mail folder.
'';
};
};
};
default = { };
description = lib.mdDoc ''
description = ''
Standard email folders.
'';
};
@ -344,7 +344,7 @@ let
imap = mkOption {
type = types.nullOr imapModule;
default = null;
description = lib.mdDoc ''
description = ''
The IMAP configuration to use for this account.
'';
};
@ -352,7 +352,7 @@ let
jmap = mkOption {
type = types.nullOr jmapModule;
default = null;
description = lib.mdDoc ''
description = ''
The JMAP configuration to use for this account.
'';
};
@ -360,7 +360,7 @@ let
signature = mkOption {
type = signatureModule;
default = { };
description = lib.mdDoc ''
description = ''
Signature configuration.
'';
};
@ -368,7 +368,7 @@ let
gpg = mkOption {
type = types.nullOr gpgModule;
default = null;
description = lib.mdDoc ''
description = ''
GPG configuration.
'';
};
@ -376,7 +376,7 @@ let
smtp = mkOption {
type = types.nullOr smtpModule;
default = null;
description = lib.mdDoc ''
description = ''
The SMTP configuration to use for this account.
'';
};
@ -384,7 +384,7 @@ let
maildir = mkOption {
type = types.nullOr maildirModule;
defaultText = { path = "\${name}"; };
description = lib.mdDoc ''
description = ''
Maildir configuration for this account.
'';
};
@ -477,7 +477,7 @@ in {
certificatesFile = mkOption {
type = types.nullOr types.path;
default = "/etc/ssl/certs/ca-certificates.crt";
description = lib.mdDoc ''
description = ''
Path to default file containing certificate authorities that
should be used to validate the connection authenticity. This
path may be overridden on a per-account basis.
@ -490,7 +490,7 @@ in {
defaultText = "$HOME/Maildir";
apply = p:
if hasPrefix "/" p then p else "${config.home.homeDirectory}/${p}";
description = lib.mdDoc ''
description = ''
The base directory for account maildir directories. May be a
relative path, in which case it is relative the home
directory.
@ -500,7 +500,7 @@ in {
accounts = mkOption {
type = types.attrsOf (types.submodule mailAccountOpts);
default = { };
description = lib.mdDoc "List of email accounts.";
description = "List of email accounts.";
};
};