From: Jerome Charaoui <jcharaoui@cmaisonneuve.qc.ca>
Date: Fri, 7 May 2010 20:55:38 +0000 (-0400)
Subject: document changes in module_dir usage
X-Git-Url: https://gitweb.fluxo.info/?a=commitdiff_plain;h=109311524e3d63bb082b40db4caa25d650202511;p=puppet-common.git

document changes in module_dir usage
---

diff --git a/manifests/defines/modules_dir.pp b/manifests/defines/modules_dir.pp
index c7cde5b..02398ea 100644
--- 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")