summaryrefslogtreecommitdiff
path: root/modules/users
diff options
context:
space:
mode:
authorWeijia Wang <9713184+wegank@users.noreply.github.com>2024-04-14 23:02:32 +0200
committerWeijia Wang <9713184+wegank@users.noreply.github.com>2024-04-19 04:05:50 +0200
commitdef1e23be848848400d1d097d4f044e3c401f9dd (patch)
tree7a69686dea36e304c788531fda90bc3edeee86fd /modules/users
parent99b3f9a1f5d2604d542f367d38001dfa40eea7b9 (diff)
treewide: remove lib.mdDoc
Diffstat (limited to 'modules/users')
-rw-r--r--modules/users/default.nix10
-rw-r--r--modules/users/group.nix8
-rw-r--r--modules/users/user.nix18
3 files changed, 18 insertions, 18 deletions
diff --git a/modules/users/default.nix b/modules/users/default.nix
index 25cc97e..cd0986d 100644
--- a/modules/users/default.nix
+++ b/modules/users/default.nix
@@ -39,7 +39,7 @@ in
users.knownGroups = mkOption {
type = types.listOf types.str;
default = [];
- description = lib.mdDoc ''
+ description = ''
List of groups owned and managed by nix-darwin. Used to indicate
what users are safe to create/delete based on the configuration.
Don't add system groups to this.
@@ -49,7 +49,7 @@ in
users.knownUsers = mkOption {
type = types.listOf types.str;
default = [];
- description = lib.mdDoc ''
+ description = ''
List of users owned and managed by nix-darwin. Used to indicate
what users are safe to create/delete based on the configuration.
Don't add the admin user or other system users to this.
@@ -59,13 +59,13 @@ in
users.groups = mkOption {
type = types.attrsOf (types.submodule group);
default = {};
- description = lib.mdDoc "Configuration for groups.";
+ description = "Configuration for groups.";
};
users.users = mkOption {
type = types.attrsOf (types.submodule user);
default = {};
- description = lib.mdDoc "Configuration for users.";
+ description = "Configuration for users.";
};
users.gids = mkOption {
@@ -84,7 +84,7 @@ in
internal = true;
type = types.bool;
default = false;
- description = lib.mdDoc "Remove and recreate existing groups/users.";
+ description = "Remove and recreate existing groups/users.";
};
};
diff --git a/modules/users/group.nix b/modules/users/group.nix
index cfda76f..1dc26f1 100644
--- a/modules/users/group.nix
+++ b/modules/users/group.nix
@@ -6,7 +6,7 @@ with lib;
options = {
name = mkOption {
type = types.str;
- description = lib.mdDoc ''
+ description = ''
The group's name. If undefined, the name of the attribute set
will be used.
'';
@@ -17,19 +17,19 @@ with lib;
name = "gid";
check = t: isInt t && t > 501;
};
- description = lib.mdDoc "The group's GID.";
+ description = "The group's GID.";
};
members = mkOption {
type = types.listOf types.str;
default = [];
- description = lib.mdDoc "The group's members.";
+ description = "The group's members.";
};
description = mkOption {
type = types.str;
default = "";
- description = lib.mdDoc "The group's description.";
+ description = "The group's description.";
};
};
diff --git a/modules/users/user.nix b/modules/users/user.nix
index 60592fc..4e3f1c9 100644
--- a/modules/users/user.nix
+++ b/modules/users/user.nix
@@ -6,7 +6,7 @@ with lib;
options = {
name = mkOption {
type = types.str;
- description = lib.mdDoc ''
+ description = ''
The name of the user account. If undefined, the name of the
attribute set will be used.
'';
@@ -16,7 +16,7 @@ with lib;
type = types.str;
default = "";
example = "Alice Q. User";
- description = lib.mdDoc ''
+ description = ''
A short description of the user account, typically the
user's full name.
'';
@@ -24,19 +24,19 @@ with lib;
uid = mkOption {
type = types.int;
- description = lib.mdDoc "The user's UID.";
+ description = "The user's UID.";
};
gid = mkOption {
type = types.int;
default = 20;
- description = lib.mdDoc "The user's primary group.";
+ description = "The user's primary group.";
};
isHidden = mkOption {
type = types.bool;
default = true;
- description = lib.mdDoc "Whether to make the user account hidden.";
+ description = "Whether to make the user account hidden.";
};
# extraGroups = mkOption {
@@ -48,27 +48,27 @@ with lib;
home = mkOption {
type = types.path;
default = "/var/empty";
- description = lib.mdDoc "The user's home directory.";
+ description = "The user's home directory.";
};
createHome = mkOption {
type = types.bool;
default = false;
- description = lib.mdDoc "Create the home directory when creating the user.";
+ description = "Create the home directory when creating the user.";
};
shell = mkOption {
type = types.either types.shellPackage types.path;
default = "/sbin/nologin";
example = literalExpression "pkgs.bashInteractive";
- description = lib.mdDoc "The user's shell.";
+ description = "The user's shell.";
};
packages = mkOption {
type = types.listOf types.package;
default = [];
example = literalExpression "[ pkgs.firefox pkgs.thunderbird ]";
- description = lib.mdDoc ''
+ description = ''
The set of packages that should be made availabe to the user.
This is in contrast to {option}`environment.systemPackages`,
which adds packages to all users.