summaryrefslogtreecommitdiff
path: root/lib/chef/resource/link.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/chef/resource/link.rb')
-rw-r--r--lib/chef/resource/link.rb24
1 files changed, 19 insertions, 5 deletions
diff --git a/lib/chef/resource/link.rb b/lib/chef/resource/link.rb
index c4ab1e0a75..487befde2e 100644
--- a/lib/chef/resource/link.rb
+++ b/lib/chef/resource/link.rb
@@ -47,11 +47,25 @@ class Chef
super
end
- property :target_file, String, name_property: true, identity: true
- property :to, String
- property :link_type, [String, Symbol], coerce: proc { |arg| arg.kind_of?(String) ? arg.to_sym : arg }, equal_to: [ :symbolic, :hard ], default: :symbolic
- property :group, [String, Integer], regex: [Chef::Config[:group_valid_regex]]
- property :user, [String, Integer], regex: [Chef::Config[:user_valid_regex]]
+ property :target_file, String,
+ description: "The name of the link. Default value: the name of the resource block See “Syntax” section above for more information.",
+ name_property: true, identity: true
+
+ property :to, String,
+ description: "The actual file to which the link is to be created."
+
+ property :link_type, [String, Symbol],
+ description: "The type of link: :symbolic or :hard.",
+ coerce: proc { |arg| arg.kind_of?(String) ? arg.to_sym : arg },
+ equal_to: [ :symbolic, :hard ], default: :symbolic
+
+ property :group, [String, Integer],
+ description: "A string or ID that identifies the group associated with a symbolic link.",
+ regex: [Chef::Config[:group_valid_regex]]
+
+ property :owner, [String, Integer],
+ description: "The owner associated with a symbolic link.",
+ regex: [Chef::Config[:user_valid_regex]]
# make link quack like a file (XXX: not for public consumption)
def path