From: Ricky Ng <dummey@gmail.com>
Date: Thu, 12 Feb 2015 20:49:41 +0000 (-0600)
Subject: Update README.markdown
X-Git-Url: https://gitweb.fluxo.info/?a=commitdiff_plain;h=6bf794483ac41d2cffebec338eb926682897cef8;p=puppet-vcsrepo.git

Update README.markdown

Clarified what the parameter 'excludes' is intended to do.
---

diff --git a/README.markdown b/README.markdown
index 34a51e2..9671fc5 100644
--- a/README.markdown
+++ b/README.markdown
@@ -517,7 +517,7 @@ The vcsrepo module is slightly unusual in that it is simply a type and providers
 * `cvs_rsh` -  The value to be used for the CVS_RSH environment variable. (Requires the `cvs_rsh` feature.)
 * `depth` - The value to be used to do a shallow clone. (Requires the `depth` feature.)
 * `ensure` - Determines the state of the repository. Valid values are 'present', 'bare', 'absent', 'latest'.
-* `excludes` - Lists any files to be excluded from the repository. Can be an array or string.
+* `excludes` - Lists any files to be excluded from being tracked by the repository (similiar to .gitignore). Can be an array or string.
 * `force` - Forces repository creation. Valid values are 'true' and 'false'. **WARNING** Forcing will destroy any files in the path.
 * `fstype` - Sets the filesystem type. (Requires the `filesystem_types` feature.)
 * `group` - Determines the group/gid that owns the repository files.