diff options
| author | Tim Smith <tsmith@chef.io> | 2018-02-21 09:01:26 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-02-21 09:01:26 -0800 |
| commit | 8d081dc08f86b384f43e4f7dd72646b4c0c7a743 (patch) | |
| tree | 82bcedabc78bbc60b797fe027faf87882bb12a6f /lib/chef/resource/cookbook_file.rb | |
| parent | 054b7dcad329138b6f153f73cf33a180021e79db (diff) | |
| parent | 5c2b9e201f65d04252a86b1ad89d756f3e73792f (diff) | |
| download | chef-8d081dc08f86b384f43e4f7dd72646b4c0c7a743.tar.gz | |
Merge pull request #6854 from chef/resource_docs
Add new introduced and description resource properties to many resources
Diffstat (limited to 'lib/chef/resource/cookbook_file.rb')
| -rw-r--r-- | lib/chef/resource/cookbook_file.rb | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/lib/chef/resource/cookbook_file.rb b/lib/chef/resource/cookbook_file.rb index 8c3de119e9..593cb5e137 100644 --- a/lib/chef/resource/cookbook_file.rb +++ b/lib/chef/resource/cookbook_file.rb @@ -24,20 +24,23 @@ require "chef/mixin/securable" class Chef class Resource - # Use the cookbook_file resource to transfer files from a sub-directory of COOKBOOK_NAME/files/ to a specified path - # located on a host that is running the chef-client. The file is selected according to file specificity, which allows - # different source files to be used based on the hostname, host platform (operating system, distro, or as appropriate), - # or platform version. Files that are located in the COOKBOOK_NAME/files/default sub-directory may be used on any - # platform. - # - # During a chef-client run, the checksum for each local file is calculated and then compared against the checksum for - # the same file as it currently exists in the cookbook on the Chef server. A file is not transferred when the checksums - # match. Only files that require an update are transferred from the Chef server to a node. class CookbookFile < Chef::Resource::File include Chef::Mixin::Securable resource_name :cookbook_file + description "Use the cookbook_file resource to transfer files from a sub-directory"\ + " of COOKBOOK_NAME/files/ to a specified path located on a host that is"\ + " running the chef-client. The file is selected according to file specificity,"\ + " which allows different source files to be used based on the hostname, host"\ + " platform (operating system, distro, or as appropriate), or platform version."\ + " Files that are located in the COOKBOOK_NAME/files/default sub-directory may be"\ + " used on any platform.\n\n"\ + "During a chef-client run, the checksum for each local file is calculated and then"\ + " compared against the checksum for the same file as it currently exists in the"\ + " cookbook on the Chef server. A file is not transferred when the checksums match."\ + " Only files that require an update are transferred from the Chef server to a node." + property :source, [ String, Array ], default: lazy { ::File.basename(name) } property :cookbook, String |