document changes in module_dir usage

diff --git a/manifests/defines/modules_dir.pp b/manifests/defines/modules_dir.pp
index c7cde5bbbbf686157bec018b1e19c29f4c485440..02398ea594d970ca26829c956fdc2b9c97ceb608 100644 (file)
--- a/manifests/defines/modules_dir.pp
+++ b/manifests/defines/modules_dir.pp
@@ -5,12 +5,17 @@
 # See LICENSE for the full license granted to you.
 
 # Usage:
+# include common::moduledir
 # modules_dir { ["common", "common/dir1", "common/dir2" ]: }
+#
+# You may refer to a file in module_dir by using :
+# file { "${common::moduledir::module_dir_path}/somedir/somefile": }
+
 define modules_dir (
                $mode = 0644, $owner = root, $group = 0
        )
 {
-    include common::moduledir
+  include common::moduledir
        $dir = "$common::moduledir::module_dir_path/${name}"
        if defined(File[$dir]) {
                debug("${dir} already defined")