Document the path parameter and provide a small use case.

1 files changed, 28 insertions, 0 deletions

diff --git a/manifests/init.pp b/manifests/init.pp
index bd6358e..8398e92 100644
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -30,6 +30,30 @@
 # will have an number prefix of 10, you can use the order option
 # to control that and thus control the order the final file gets built in.
 #
+# You can also specify a path and use a different name for your resources:
+#
+# # You can make this something dynamic, based on whatever parameters your
+# # module/class for example.
+# $vhost_file = '/etc/httpd/vhosts/01-my-vhost.conf'
+#
+# concat{'apache-vhost-myvhost':
+#   path => $vhost_file,
+# }
+#
+# # We don't care where the file is located, just what to put in it.
+# concat::fragment {'apache-vhost-myvhost-main':
+#   target  => 'apache-vhost-myvhost',
+#   content => '<virtualhost *:80>',
+#   order   => 01,
+# }
+#
+# concat::fragment {'apache-vhost-myvhost-close':
+#   target  => 'apache-vhost-myvhost',
+#   content => '</virtualhost>',
+#   order   => 99,
+# }
+#
+#
 # SETUP:
 # The class concat::setup uses the fact concat_basedir to define the variable
 # $concatdir, where all the temporary files and fragments will be
@@ -66,6 +90,10 @@
 # Sets up so that you can use fragments to build a final config file,
 #
 # OPTIONS:
+#  - path       The path to the final file. Use this in case you want to
+#               differentiate between the name of a resource and the file path.
+#               Note: Use the name you provided in the target of your
+#               fragments.
 #  - mode       The mode of the final file
 #  - owner      Who will own the file
 #  - group      Who will own the file