diff options
| author | Tim Smith <tsmith84@gmail.com> | 2020-04-29 14:52:47 -0700 |
|---|---|---|
| committer | Tim Smith <tsmith84@gmail.com> | 2020-04-29 14:52:47 -0700 |
| commit | b21169152c458778a8d23b0bba5ebaafd568f364 (patch) | |
| tree | 97461635bb49d7bce8349479582609ea5d530572 /lib/chef/resource/archive_file.rb | |
| parent | d68d7eab64e47a1f42ddaffa6f8c85fec3c9830c (diff) | |
| download | chef-b21169152c458778a8d23b0bba5ebaafd568f364.tar.gz | |
Improve resource doc formatting
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/resource/archive_file.rb')
| -rw-r--r-- | lib/chef/resource/archive_file.rb | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/lib/chef/resource/archive_file.rb b/lib/chef/resource/archive_file.rb index b525286c06..b288cb4885 100644 --- a/lib/chef/resource/archive_file.rb +++ b/lib/chef/resource/archive_file.rb @@ -60,11 +60,11 @@ class Chef required: true property :options, [Array, Symbol], - description: "An array of symbols representing extraction flags. Example: :no_overwrite to prevent overwriting files on disk. By default, this properly sets :time which preserves the modification timestamps of files in the archive when writing them to disk.", + description: "An array of symbols representing extraction flags. Example: `:no_overwrite` to prevent overwriting files on disk. By default, this properly sets `:time` which preserves the modification timestamps of files in the archive when writing them to disk.", default: lazy { [:time] } property :overwrite, [TrueClass, FalseClass, :auto], - description: "Should the resource overwrite the destination file contents if they already exist? If set to :auto the date stamp of files within the archive will be compared to those on disk and disk contents will be overwritten if they differ. This may cause unintended consequences if disk date stamps are changed between runs, which will result in the files being overwritten during each client run. Make sure to properly test any change to this property.", + description: "Should the resource overwrite the destination file contents if they already exist? If set to `:auto` the date stamp of files within the archive will be compared to those on disk and disk contents will be overwritten if they differ. This may cause unintended consequences if disk date stamps are changed between runs, which will result in the files being overwritten during each client run. Make sure to properly test any change to this property.", default: false # backwards compatibility for the legacy cookbook names |