diff options
| author | Tim Smith <tsmith@chef.io> | 2019-02-08 16:28:19 -0800 |
|---|---|---|
| committer | Tim Smith <tsmith@chef.io> | 2019-02-19 10:06:11 -0800 |
| commit | 994b3411c72ebe0639c16f0920a46dfcf259d593 (patch) | |
| tree | f4423a3f722d3dfc3a39dac087d66cb67a716ac1 | |
| parent | e2f1323d57ad9366ec1c0328713b618c2e6e6418 (diff) | |
| download | chef-994b3411c72ebe0639c16f0920a46dfcf259d593.tar.gz | |
Add descriptions to the user properties
This helps our documentation effort
Signed-off-by: Tim Smith <tsmith@chef.io>
| -rw-r--r-- | lib/chef/resource/user.rb | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/lib/chef/resource/user.rb b/lib/chef/resource/user.rb index 8e8f6b61a1..a188b13d2c 100644 --- a/lib/chef/resource/user.rb +++ b/lib/chef/resource/user.rb @@ -28,51 +28,51 @@ class Chef allowed_actions :create, :remove, :modify, :manage, :lock, :unlock property :username, String, - description: "", + description: "An optional property to set the username value if it differs from the resource block's name.", name_property: true, identity: true property :comment, String, - description: "" + description: "The contents of the user comments field." property :home, String, - description: "" + description: "The location of the home directory." property :salt, String, - description: "", + description: "A SALTED-SHA512-PBKDF2 hash.", desired_state: false property :shell, String, - description: "" + description: "The login shell." property :password, String, - description: "", + description: "The password shadow hash", desired_state: false property :iterations, Integer, - description: "", + description: "macOS platform only. The number of iterations for a password with a SALTED-SHA512-PBKDF2 shadow hash.", default: 27855, desired_state: false property :non_unique, [ TrueClass, FalseClass ], - description: "", + description: "Create a duplicate (non-unique) user account.", default: false, desired_state: false property :manage_home, [ TrueClass, FalseClass ], - description: "", + description: "Manage a user’s home directory.\nWhen used with the :create action, a user’s home directory is created based on HOME_DIR. If the home directory is missing, it is created unless CREATE_HOME in /etc/login.defs is set to no. When created, a skeleton set of files and subdirectories are included within the home directory.\nWhen used with the :modify action, a user’s home directory is moved to HOME_DIR. If the home directory is missing, it is created unless CREATE_HOME in /etc/login.defs is set to no. The contents of the user’s home directory are moved to the new location.", default: false, desired_state: false property :force, [ TrueClass, FalseClass ], - description: "", + description: "Force the removal of a user. May be used only with the :remove action.", default: false, desired_state: false property :system, [ TrueClass, FalseClass ], - description: "", + description: "Create a system user. This property may be used with useradd as the provider to create a system user which passes the -r flag to useradd.", default: false property :uid, [ String, Integer, NilClass ], # nil for backwards compat - description: "" + description: "The numeric user identifier." property :gid, [ String, Integer, NilClass ], # nil for backwards compat - description: "" + description: "The numeric group identifier." alias_method :group, :gid end |