summaryrefslogtreecommitdiff
path: root/lib/chef/resource/link.rb
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2018-03-17 19:03:47 -0700
committerTim Smith <tsmith@chef.io>2018-03-19 15:27:56 -0700
commit6d55193a85fbce552fc51cd71c21ef44093f3a52 (patch)
treeda8409a3191ae8ee3dc468c05934e35d1a6d4fbb /lib/chef/resource/link.rb
parent4e6c7972620e68753946abe109895762a6301efd (diff)
downloadchef-6d55193a85fbce552fc51cd71c21ef44093f3a52.tar.gz
Add more resource descriptions and convert more resources to use propertiesminor_resource_cleanup
More minor cleanup Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/resource/link.rb')
-rw-r--r--lib/chef/resource/link.rb20
1 files changed, 10 insertions, 10 deletions
diff --git a/lib/chef/resource/link.rb b/lib/chef/resource/link.rb
index b3f8819d2b..c4ab1e0a75 100644
--- a/lib/chef/resource/link.rb
+++ b/lib/chef/resource/link.rb
@@ -22,21 +22,21 @@ require "chef/mixin/securable"
class Chef
class Resource
- # Use the link resource to create symbolic or hard links.
- #
- # A symbolic link—sometimes referred to as a soft link—is a directory entry that associates a file name with a string
- # that contains an absolute or relative path to a file on any file system. In other words, “a file that contains a path
- # that points to another file.” A symbolic link creates a new file with a new inode that points to the inode location
- # of the original file.
- #
- # A hard link is a directory entry that associates a file with another file in the same file system. In other words,
- # “multiple directory entries to the same file.” A hard link creates a new file that points to the same inode as the
- # original file.
class Link < Chef::Resource
include Chef::Mixin::Securable
resource_name :link
provides :link
+ description "Use the link resource to create symbolic or hard links.\n\n"\
+ "A symbolic link—sometimes referred to as a soft link—is a directory entry"\
+ " that associates a file name with a string that contains an absolute or"\
+ " relative path to a file on any file system. In other words, “a file that"\
+ " contains a path that points to another file.” A symbolic link creates a new"\
+ " file with a new inode that points to the inode location of the original file.\n\n"\
+ "A hard link is a directory entry that associates a file with another file in the"\
+ " same file system. In other words, “multiple directory entries to the same file.”"\
+ " A hard link creates a new file that points to the same inode as the original file."
+
state_attrs :owner # required since it's not a property below
default_action :create