Skip to content

Commit

Permalink
Update README per cd03959
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
psoloway committed Apr 20, 2015
1 parent 30cb251 commit 2d64759
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand All @@ -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'.
Expand All @@ -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`
Expand Down

0 comments on commit 2d64759

Please sign in to comment.