From 2d64759c5755c562747c7936b58552b215f893a5 Mon Sep 17 00:00:00 2001 From: Pete Soloway Date: Fri, 17 Apr 2015 13:02:12 -0700 Subject: [PATCH] Update README per cd03959116f7b27ab3ec7ccace98bd10be435397 The concat `force` and fragment `ensure` parameters have been added back and deprecated. The `warn_header` parameter has changed back to `warn`. Updating README to reflect this. --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index aba73b42c..291375481 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ The concat module lets you gather `concat::fragment` resources from your other m ###What concat affects -The concat module requires the [file_concat module](https://forge.puppetlabs.com/ispavailability/file_concat). If you don't have file_concat installed, concat installs it for you. +The concat module requires the [file_concat module](https://forge.puppetlabs.com/electrical/file_concat). If you don't have file_concat installed, concat installs it for you. ###Beginning with concat @@ -140,6 +140,10 @@ Specifies whether (and how) to back up the destination file before overwriting i Specifies whether the destination file should exist. Setting to 'absent' tells Puppet to delete the destination file if it exists, and negates the effect of any other parameters. Valid options: 'present' and 'absent'. Default value: 'present'. +#####`force` + +Deprecated as of concat v2.0.0. Has no effect. + #####`group` Specifies a permissions group for the destination file. Valid options: a string containing a group name. Default value: undefined. @@ -170,11 +174,11 @@ Specifies whether to overwrite the destination file if it already exists. Valid Specifies a validation command to apply to the destination file. Requires Puppet version 3.5 or newer. Valid options: a string to be passed to a file resource. Default value: undefined. -#####`warn_header` +#####`warn` -Specifies whether to add a header message at the top of the destination file so users know it was autogenerated by Puppet. In earlier versions of the concat module, this parameter was called `warn`. Valid options: the booleans 'true' and 'false', or a string to serve as the header. Default value: 'false'. +Specifies whether to add a header message at the top of the destination file. Valid options: the booleans 'true' and 'false', or a string to serve as the header. Default value: 'false'. -If you set 'warn_header' to 'true', `concat` adds the following message: +If you set 'warn' to 'true', `concat` adds the following message: ~~~ # This file is managed by Puppet. DO NOT EDIT. @@ -188,6 +192,10 @@ Except where noted, all the below parameters are optional. Supplies the content of the fragment. **Note**: You must supply either a `content` parameter or a `source` parameter. Valid options: a string. Default value: undef. +#####`ensure` + +Deprecated as of concat v2.0.0. Has no effect. + #####`order` Reorders your fragments within the destination file. Fragments that share the same order number are ordered by name. Valid options: a string (recommended) or an integer. Default value: '10'. @@ -206,11 +214,8 @@ The following functionality existed in previous versions of the concat module, b Parameters removed from `concat`: * `ensure_newline` -* `force` -* `warn` (replaced by `warn_header`) Parameters removed from `concat::fragment`: -* `ensure` * `gnu` * `backup` * `group`