ilyakooo0/nixpkgs
1
0
Fork 0
mirror of https://github.com/ilyakooo0/nixpkgs.git synced 2024-12-26 04:43:09 +03:00
Code Issues Projects Releases Wiki Activity

Improve description of the users.extraUsers.*.description option

Browse Source 
Fixes NixOS/nixos#278.
This commit is contained in:
Eelco Dolstra 2013-10-31 08:41:51 +01:00
parent d9ba437875
commit a840dae935
1 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
nixos/modules/config/users-groups.nix
View File

@ -19,7 +19,12 @@ let
description = mkOption { description = mkOption {
type = types.str; type = types.str;
default = ""; default = "";
description = "A short description of the user account."; example = "Alice Q. User";
description = ''
A short description of the user account, typically the
user's full name. This is actually the “GECOS” or “comment”
field in <filename>/etc/passwd</filename>.
'';
}; };
uid = mkOption { uid = mkOption {
@ -67,7 +72,13 @@ let
password = mkOption { password = mkOption {
type = with types; uniq (nullOr str); type = with types; uniq (nullOr str);
default = null; default = null;
description = "The user's password. If undefined, no password is set for the user. Warning: do not set confidential information here because this data would be readable by all. This option should only be used for public account such as guest."; description = ''
The user's password. If undefined, no password is set for
the user. Warning: do not set confidential information here
because it is world-readable in the Nix store. This option
should only be used for public accounts such as
<literal>guest</literal>.
'';
}; };
isSystemUser = mkOption { isSystemUser = mkOption {
@ -79,11 +90,11 @@ let
createUser = mkOption { createUser = mkOption {
type = types.bool; type = types.bool;
default = true; default = true;
description = " description = ''
Indicates if the user should be created automatically as a local user. Indicates if the user should be created automatically as a local user.
Set this to false if the user for instance is an LDAP user. NixOS will Set this to false if the user for instance is an LDAP user. NixOS will
then not modify any of the basic properties for the user account. then not modify any of the basic properties for the user account.
"; '';
}; };
isAlias = mkOption { isAlias = mkOption {
@ -149,13 +160,12 @@ in
example = { example = {
alice = { alice = {
uid = 1234; uid = 1234;
description = "Alice"; description = "Alice Q. User";
home = "/home/alice"; home = "/home/alice";
createHome = true; createHome = true;
group = "users"; group = "users";
extraGroups = ["wheel"]; extraGroups = ["wheel"];
shell = "/bin/sh"; shell = "/bin/sh";
password = "foobar";
}; };
}; };
description = '' description = ''