Merge pull request redhat-openstack#291 from psoloway/readme

Updates README per 936dc29

Author: hunner

README.md

@@ -9,9 +9,9 @@
     * [Beginning with concat](#beginning-with-concat)
 4. [Usage - Configuration options and additional functionality](#usage)
 5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
-    * [Public Defines](#public-defines)
+    * [Defines](#defines)
     * [Parameters](#parameters)
-    * [Deprecations](#deprecations)
+    * [Removed functionality](#removed-functionality)
 6. [Limitations - OS compatibility, etc.](#limitations)
 7. [Development - Guide for contributing to the module](#development)
 
@@ -21,14 +21,13 @@ The concat module lets you construct files from multiple ordered fragments of te
 
 ##Module Description
 
-The concat module lets you gather `concat::fragment` resources from your other modules and order them through a single `concat` resource into a coherent file. It does this through a Ruby script and a temporary holding space for the fragments.
+The concat module lets you gather `concat::fragment` resources from your other modules and order them into a coherent file through a single `concat` resource.
 
 ##Setup
 
 ###What concat affects
 
-* Installs `concatfragments.rb`.
-* Adds a `concat/` directory into Puppet's `vardir`.
+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.
 
 ###Beginning with concat
 
@@ -123,9 +122,7 @@ When you're finished, the motd file will look something like this:
 
 ##Reference
 
-**Note**: Several of this module's parameters and features have been deprecated. See the [Deprecations](#deprecations) section below.
-
-###Public defines
+###Defines
 * `concat`: Manages a file, compiled from one or more text fragments.
 * `concat::fragment`: Manages a fragment of text to be compiled into a file.
 
@@ -143,15 +140,6 @@ 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'.
 
-
-#####`ensure_newline`
-
-Specifies whether to ensure there's a new line at the end of each fragment. Valid options: 'true' and 'false'. Default value: 'false'.
-
-#####`force`
-
-In case no fragments have been added, this parameter specifies whether to go ahead and create a potentially empty file. Valid options: 'true' and 'false'. Default value: 'false'.
-
 #####`group`
 
 Specifies a permissions group for the destination file. Valid options: a string containing a group name. Default value: undefined.
@@ -168,12 +156,10 @@ You can override this setting for individual fragments by adjusting the `order`
 
 #####`owner`
 
-
 Specifies the owner of the destination file. Valid options: a string containing a username. Default value: undefined.
 
 #####`path`
 
-
 Specifies a destination file for the combined fragments. Valid options: a string containing an absolute path. Default value: the title of your declared resource.
 
 #####`replace`
@@ -184,30 +170,24 @@ 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`
-
-Specifies whether to add a warning message at the top of the destination file so users know it was autogenerated by Puppet. Valid options: 'true', 'false', or a string to be delivered as a warning message. Default value: 'false'.
+#####`warn_header`
 
+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'.
 
-If you set this parameter to 'true', Puppet adds the following message:
+If you set 'warn_header' to 'true', `concat` adds the following message:
 
 ~~~
 # This file is managed by Puppet. DO NOT EDIT.
 ~~~
 
 ####`concat::fragment`
 
-
 Except where noted, all the below parameters are optional.
 
 #####`content`
 
 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`
-
-Specifies whether the fragment should be included in the destination file or discarded. Valid options: 'present' and 'absent'. Default value: 'present'.
-
 #####`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'.
@@ -220,51 +200,26 @@ Specifies a file to read into the content of the fragment. **Note**: You must su
 
 *Required.* Specifies the destination file of the fragment. Valid options: a string containing an absolute path.
 
-###Deprecations
-
-**`concat` has the following deprecations**
-
-#####`gnu`
-
-Generates a catalog compile time warning and has no effect. This parameter was silently ignored in version `1.0.0` and will be removed in a future release.
-
-#####stringified 'true'/'false' values deprecated in `warn`
-
-Passing stringified boolean values (strings of 'true' and 'false') to the `warn` parameter of `concat` is deprecated. Generates a catalog compile time warning, and will be silently treated as the concatenated file header/warning message in a future release.
-
-Please migrate to using the Puppet DSL's native [Boolean data
-type](http://docs.puppetlabs.com/puppet/3/reference/lang_datatypes.html#booleans).
-
-
-**`concat::fragment` has the following deprecations**
-
-#####`backup`
-
-Generates a catalog compile time warning and has no effect. In the `1.0.0` release this parameter controlled file bucketing of the file fragment. Bucketing the fragment(s) is redundant with bucketing the final concatenated file and this feature has been removed.
-
-
-#####`group`
-
-Generates a catalog compile time warning and has no effect. Had no user-visible effect in version `1.0.0` and will be removed in a future release.
-
-#####`mode`
-
-Generates a catalog compile time warning and has no effect. Had no user-visible effect in version `1.0.0` and will be removed in a future release.
-
-
-#####`owner`
-
-Generates a catalog compile time warning and has no effect. Had no user-visible effect in version `1.0.0` and will be removed in a future release.
+###Removed functionality
 
-#####file paths are deprecated in `ensure`
+The following functionality existed in previous versions of the concat module, but were removed in version 2.0.0:
 
-Passing a value other than 'present' or 'absent' in the `ensure` parameter of `concat::fragment` is **deprecated**, and generates a catalog compile time warning. The warning will become a catalog compilation failure in a future release.
+Parameters removed from `concat`:
+* `ensure_newline`
+* `force`
+* `warn` (replaced by `warn_header`)
 
-If you want to use the content of a file as a fragment please use the [`source`](#source) parameter.
+Parameters removed from `concat::fragment`:
+* `ensure`
+* `gnu`
+* `backup`
+* `group`
+* `mode`
+* `owner`
 
-####`concat::setup`
+The `concat::setup` class has also been removed.
 
-The `concat::setup` class should no longer be directly included in the manifest. It will be removed in a future release.
+Prior to concat version 2.0.0, if you set the `warn` parameter to a string value of 'true', 'false', 'yes', 'no', 'on', or 'off', the module translated the string to the corresponding boolean value. In concat version 2.0.0 and newer, the `warn_header` parameter treats those values the same as other strings and uses them as the content of your header message. To avoid that, pass the 'true' and 'false' values as booleans instead of strings.
 
 ##Limitations