Updates README per MODULES-1425
[puppet_vcsrepo.git] / README.markdown
index de6ae9a..cefa50b 100644 (file)
@@ -41,6 +41,10 @@ This module provides a single type with providers for each VCS, which can be use
 
 ##Setup
 
+Before you begin using vcsrepo, it's worth keeping in mind that this module will not install VCS software for you. If you are going to use this module, you must have already installed your preferred VCS.
+
+Also, this module, like Puppet generally, will not create parent directories for you. You will need to have your parent directories in place before you begin.
+
 ###Beginning with vcsrepo      
 
 To get started with the vcsrepo module, you must simply define the type `vcsrepo` with a path to your repository and the [type of VCS](#Usage) you're using in `provider` (in the below example, Git). 
@@ -489,7 +493,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.
+* `excludes` - Lists any files to be excluded from the repository. 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.