Merge pull request #269 from monai/develop

Add feature 'depth' and parameter 'trust_server_cert' to svn

1 files changed, 153 insertions, 147 deletions

diff --git a/README.markdown b/README.markdown
index badb1ce..4c65bbc 100644
--- a/README.markdown
+++ b/README.markdown
@@ -180,7 +180,7 @@ vcsrepo { '/path/to/repo':
 }

 ~~~

 

-**Note:** if you set `source` to a hash, one of the names you specify must match the value of the `remote` parameter. That remote serves as the upstream of your managed repository.
+**Note:** if you set `source` to a hash, one of the names you specify must match the value of the `remote` parameter. That remote serves as the upstream of your managed repository.

 

 ####Connect via SSH

 

@@ -196,7 +196,7 @@ vcsrepo { '/path/to/repo':
   user       => 'toto', #uses toto's $HOME/.ssh setup

   require    => File['/home/toto/.ssh/id_rsa'],

 }

-~~~
+~~~

 

 ###Bazaar

 

@@ -235,7 +235,7 @@ vcsrepo { '/path/to/repo':
 ####Connect via SSH

 

 To connect to your source repository via SSH (e.g., `'bzr+ssh://...'` or `'sftp://...,'`), we recommend using the [`require`](http://docs.puppetlabs.com/references/stable/metaparameter.html#require) metaparameter to make sure your SSH keys are present before the `vcsrepo` resource is applied:

-
+

 ~~~

 vcsrepo { '/path/to/repo':

   ensure     => latest,

@@ -244,7 +244,7 @@ vcsrepo { '/path/to/repo':
   user       => 'toto', #uses toto's $HOME/.ssh setup

   require    => File['/home/toto/.ssh/id_rsa'],

 }

-~~~
+~~~

 

 ###CVS

 

@@ -301,10 +301,10 @@ vcsrepo { '/path/to/workspace':
   source      => ':pserver:anonymous@example.com:/sources/myproj',

   revision    => '1.2',

 }

-~~~
-
+~~~

+

 You can also set `revision` to a tag:

-
+

 ~~~

 vcsrepo { '/path/to/workspace':

   ensure      => present,

@@ -313,12 +313,12 @@ vcsrepo { '/path/to/workspace':
   source      => ':pserver:anonymous@example.com:/sources/myproj',

   revision    => 'SOMETAG',

 }

-~~~
+~~~

 

 ####Connect via SSH

 

 To connect to your source repository via SSH, we recommend using the [`require`](http://docs.puppetlabs.com/references/stable/metaparameter.html#require) metaparameter to make sure your SSH keys are present before the `vcsrepo` resource is applied:

-
+

 ~~~

 vcsrepo { '/path/to/repo':

   ensure     => latest,

@@ -413,7 +413,7 @@ vcsrepo { '/path/to/repo':
 ####Connect via SSH 

 

 To connect to your source repository via SSH (e.g., `'ssh://...'`), we recommend using the [`require` metaparameter](http://docs.puppetlabs.com/references/stable/metaparameter.html#require) to make sure your SSH keys are present before the `vcsrepo` resource is applied:

-
+

 ~~~

 vcsrepo { '/path/to/repo':

   ensure     => latest,

@@ -425,11 +425,11 @@ vcsrepo { '/path/to/repo':
 ~~~

 

 ###Perforce

-
-####Create an empty workspace
-
-To set up the connection to your Perforce service, set `p4config` to the location of a valid Perforce [config file](http://www.perforce.com/perforce/doc.current/manuals/p4guide/chapter.configuration.html#configuration.settings.configfiles) stored on the node: 
-
+

+####Create an empty workspace

+

+To set up the connection to your Perforce service, set `p4config` to the location of a valid Perforce [config file](http://www.perforce.com/perforce/doc.current/manuals/p4guide/chapter.configuration.html#configuration.settings.configfiles) stored on the node: 

+

 ~~~

 vcsrepo { '/path/to/repo':

   ensure     => present,

@@ -437,9 +437,9 @@ vcsrepo { '/path/to/repo':
   p4config   => '/root/.p4config'

 }

 ~~~

-
-**Note:** If you don't include the `P4CLIENT` setting in your config file, the provider generates a workspace name based on the digest of `path` and the node's hostname (e.g., `puppet-91bc00640c4e5a17787286acbe2c021c`):
-
+

+**Note:** If you don't include the `P4CLIENT` setting in your config file, the provider generates a workspace name based on the digest of `path` and the node's hostname (e.g., `puppet-91bc00640c4e5a17787286acbe2c021c`):

+

 ####Create/update and sync a Perforce workspace

 

 To sync a depot path to head, set `ensure` to 'latest':

@@ -524,7 +524,7 @@ vcsrepo { '/path/to/repo':
 ####Connect via SSH 

 

 To connect to your source repository via SSH (e.g., `'svn+ssh://...'`), we recommend using the [`require` metaparameter](http://docs.puppetlabs.com/references/stable/metaparameter.html#require) to make sure your SSH keys are present before the `vcsrepo` resource is applied:

-
+

 ~~~

 vcsrepo { '/path/to/repo':

   ensure     => latest,

@@ -547,7 +547,7 @@ The vcsrepo module adds only one type with several providers. Each provider abst
 

 #####`git` - Supports the Git VCS.

 

-Features: `bare_repositories`, `depth`, `multiple_remotes`, `reference_tracking`, `ssh_identity`, `submodules`, `user`
+Features: `bare_repositories`, `depth`, `multiple_remotes`, `reference_tracking`, `ssh_identity`, `submodules`, `user`

 

 Parameters: `depth`, `ensure`, `excludes`, `force`, `group`, `identity`, `owner`, `path`, `provider`, `remote`, `revision`, `source`, `user`

 

@@ -555,42 +555,42 @@ Parameters: `depth`, `ensure`, `excludes`, `force`, `group`, `identity`, `owner`
 

 Features: `reference_tracking`

 

-Parameters: `ensure`, `excludes`, `force`, `group`, `owner`, `path`, `provider`, `revision`, `source`
+Parameters: `ensure`, `excludes`, `force`, `group`, `owner`, `path`, `provider`, `revision`, `source`

 

 #####`cvs` - Supports the CVS VCS.

 

 Features: `cvs_rsh`, `gzip_compression`, `modules`, `reference_tracking`, `user`

-
-Parameters: `compression`, `cvs_rsh`, `ensure`, `excludes`, `force`, `group`, `module`, `owner`, `path`, `provider`
+

+Parameters: `compression`, `cvs_rsh`, `ensure`, `excludes`, `force`, `group`, `module`, `owner`, `path`, `provider`

 

 #####`hg` - Supports the Mercurial VCS.

 

-Features: `reference_tracking`, `ssh_identity`, `user`
+Features: `reference_tracking`, `ssh_identity`, `user`

 

-Parameters: `ensure`, `excludes`, `force`, `group`, `identity`, `owner`, `path`, `provider`, `revision`, `source`, `user`
+Parameters: `ensure`, `excludes`, `force`, `group`, `identity`, `owner`, `path`, `provider`, `revision`, `source`, `user`

 

 #####`p4` - Supports the Perforce VCS.

 

-Features: `p4config`, `reference_tracking`
+Features: `p4config`, `reference_tracking`

 

-Parameters: `ensure`, `excludes`, `force`, `group`, `owner`, `p4config`, `path`, `provider`, `revision`, `source`
+Parameters: `ensure`, `excludes`, `force`, `group`, `owner`, `p4config`, `path`, `provider`, `revision`, `source`

 

 #####`svn` - Supports the Subversion VCS.

 

-Features: `basic_auth`, `configuration`, `conflict`, `filesystem_types`, `reference_tracking`
-
-Parameters: `basic_auth_password`, `basic_auth_username`, `configuration`, `conflict`, `ensure`, `excludes`, `force`, `fstype`, `group`, `owner`, `path`, `provider`, `revision`, `source`

+Features: `basic_auth`, `configuration`, `conflict`, `depth`, `filesystem_types`, `reference_tracking`

+

+Parameters: `basic_auth_password`, `basic_auth_username`, `configuration`, `conflict`, `ensure`, `excludes`, `force`, `fstype`, `group`, `owner`, `path`, `provider`, `revision`, `source`, `trust_server_cert`

 

 ####Features

 

 **Note:** Not all features are available with all providers.

 

 * `bare_repositories` - Differentiates between bare repositories and those with working copies. (Available with `git`.)

-* `basic_auth` -  Supports HTTP Basic authentication. (Available with `svn`.)
+* `basic_auth` -  Supports HTTP Basic authentication. (Available with `svn`.)

 * `conflict` - Lets you decide how to resolve any conflicts between the source repository and your working copy. (Available with `svn`.)

 * `configuration` - Lets you specify the location of your configuration files. (Available with `svn`.)

 * `cvs_rsh` - Understands the `CVS_RSH` environment variable. (Available with `cvs`.)

-* `depth` - Supports shallow clones. (Available with `git`.)

+* `depth` - Supports shallow clones in `git` or sets scope limit in `svn`. (Available with `git` and `svn`.)

 * `filesystem_types` - Supports multiple types of filesystem. (Available with `svn`.)

 * `gzip_compression` - Supports explicit GZip compression levels. (Available with `cvs`.)

 * `modules` - Lets you choose a specific repository module. (Available with `cvs`.)

@@ -603,116 +603,122 @@ Parameters: `basic_auth_password`, `basic_auth_username`, `configuration`, `conf
 

 ####Parameters

 

-All parameters are optional, except where specified otherwise.
-
-##### `basic_auth_password`
-
-Specifies the password for HTTP Basic authentication. (Requires the `basic_auth` feature.) Valid options: a string. Default: none. 
-
-##### `basic_auth_username`
-
-Specifies the username for HTTP Basic authentication. (Requires the `basic_auth` feature.) Valid options: a string. Default: none. 
-
-##### `compression`
-
-Sets the GZIP compression level for the repository history. (Requires the `gzip_compression` feature.) Valid options: an integer between 0 and 6. Default: none. 
-
-##### `configuration`
-
-Sets the configuration directory to use. (Requires the `configuration` feature.) Valid options: a string containing an absolute path. Default: none. 
-
-##### `conflict`
-
-Tells Subversion how to resolve any conflicts between the source repository and your working copy. (Requires the `conflict` feature.) Valid options: 'base', 'mine-full', 'theirs-full', and 'working'. Default: none. 
-
-##### `cvs_rsh`
-
-Provides a value for the `CVS_RSH` environment variable. (Requires the `cvs_rsh` feature.) Valid options: a string. Default: none. 
-
-##### `depth`
-
-Sets the number of commits to include when creating a shallow clone. (Requires the `depth` feature.) Valid options: an integer. Default: none. 
-
-##### `ensure`
-
-Specifies whether the repository should exist. Valid options: 'present', 'bare', 'absent', and 'latest'. Default: 'present'. 
-
-##### `excludes`
-
-Lists any files the repository shouldn't track (similar to .gitignore). Valid options: a string (separate multiple values with the newline character). Default: none. 
-
-##### `force`
-
-Specifies whether to delete any existing files in the repository path if creating a new repository. **Use with care.** Valid options: 'true' and 'false'. Default: 'false'. 
-
-##### `fstype`
-
-Sets the filesystem type. (Requires the `filesystem_types` feature.) Valid options: 'fsfs' or 'bdb'. Default: none. 
-
-##### `group`
-
-Specifies a group to own the repository files. Valid options: a string containing a group name or GID. Default: none. 
-
-##### `identity`
-
-Specifies an identity file to use for SSH authentication. (Requires the `ssh_identity` feature.) Valid options: a string containing an absolute path. Default: none. 
-
-##### `module`
-
-Specifies the repository module to manage. (Requires the `modules` feature.) Valid options: a string containing the name of a CVS module. Default: none. 
-
-##### `owner`
-
-Specifies a user to own the repository files. Valid options: a string containing a username or UID. Default: none. 
-
-##### `p4config`
-
-Specifies a config file that contains settings for connecting to the Perforce service. (Requires the `p4config` feature.) Valid options: a string containing the absolute path to a valid [Perforce config file](http://www.perforce.com/perforce/doc.current/manuals/p4guide/chapter.configuration.html#configuration.settings.configfiles). Default: none. 
-
-##### `path`
-
-Specifies a location for the managed repository. Valid options: a string containing an absolute path. Default: the title of your declared resource. 
-
-##### `provider`
-
-*Required.* Specifies the backend to use for this vcsrepo resource. Valid options: 'bzr', 'cvs', 'git', 'hg', 'p4', and 'svn'. 
-
-##### `remote`
-
-Specifies the remote repository to track. (Requires the `multiple_remotes` feature.) Valid options: a string containing one of the remote names specified in `source`. Default: 'origin'. 
-
-##### `revision`
-
-Sets the revision of the repository. Valid options vary by provider:
-
-* `git` - a string containing a Git branch name, or a commit SHA or tag
-* `bzr` - a string containing a Bazaar [revision spec](http://wiki.bazaar.canonical.com/BzrRevisionSpec)
-* `cvs` - a string containing a CVS [tag or revision number](http://www.thathost.com/wincvs-howto/cvsdoc/cvs_4.html)
-* `hg` - a string containing a Mercurial [changeset ID](http://mercurial.selenic.com/wiki/ChangeSetID) or [tag](http://mercurial.selenic.com/wiki/Tag)
-* `p4` - a string containing a Perforce [change number, label name, client name, or date spec](http://www.perforce.com/perforce/r12.1/manuals/cmdref/o.fspecs.html)
-* `svn` - a string containing a Subversion [revision number](http://svnbook.red-bean.com/en/1.7/svn.basic.in-action.html#svn.basic.in-action.revs), [revision keyword, or revision date](http://svnbook.red-bean.com/en/1.7/svn.tour.revs.specifiers.html)
-
-Default: none. 
-
-##### `source`
-
-Specifies a source repository to serve as the upstream for your managed repository. Default: none. Valid options vary by provider:
-
-* `git` - a string containing a [Git repository URL](https://www.kernel.org/pub/software/scm/git/docs/git-clone.html#_git_urls_a_id_urls_a) or a hash of name => URL mappings. See also [`remote`](#remote).
-* `bzr` - a string containing a Bazaar branch location
-* `cvs` - a string containing a CVS root
-* `hg` - a string containing the local path or URL of a Mercurial repository
-* `p4` - a string containing a Perforce depot path
-* `svn` - a string containing a Subversion repository URL
-
-Default: none. 
-
-##### `submodules`
-
-Specifies whether to initialize and update each submodule in the repository. (Requires the `submodules` feature.) Valid options: 'true' and 'false'. Default: 'true'. 
-
-##### `user`
-
+All parameters are optional, except where specified otherwise.

+

+##### `basic_auth_password`

+

+Specifies the password for HTTP Basic authentication. (Requires the `basic_auth` feature.) Valid options: a string. Default: none. 

+

+##### `basic_auth_username`

+

+Specifies the username for HTTP Basic authentication. (Requires the `basic_auth` feature.) Valid options: a string. Default: none. 

+

+##### `compression`

+

+Sets the GZIP compression level for the repository history. (Requires the `gzip_compression` feature.) Valid options: an integer between 0 and 6. Default: none. 

+

+##### `configuration`

+

+Sets the configuration directory to use. (Requires the `configuration` feature.) Valid options: a string containing an absolute path. Default: none. 

+

+##### `conflict`

+

+Tells Subversion how to resolve any conflicts between the source repository and your working copy. (Requires the `conflict` feature.) Valid options: 'base', 'mine-full', 'theirs-full', and 'working'. Default: none. 

+

+##### `cvs_rsh`

+

+Provides a value for the `CVS_RSH` environment variable. (Requires the `cvs_rsh` feature.) Valid options: a string. Default: none. 

+

+##### `depth`

+

+In `git` sets the number of commits to include when creating a shallow clone. (Requires the `depth` feature.) Valid options: an integer. Default: none. 

+

+In `svn` instructs Subversion to limit the scope of an operation to a particular tree depth. (Requires the `depth` feature.) Valid options: 'empty', 'files', 'immediates', 'infinity'. Default: none. 

+

+##### `ensure`

+

+Specifies whether the repository should exist. Valid options: 'present', 'bare', 'absent', and 'latest'. Default: 'present'. 

+

+##### `excludes`

+

+Lists any files the repository shouldn't track (similar to .gitignore). Valid options: a string (separate multiple values with the newline character). Default: none. 

+

+##### `force`

+

+Specifies whether to delete any existing files in the repository path if creating a new repository. **Use with care.** Valid options: 'true' and 'false'. Default: 'false'. 

+

+##### `fstype`

+

+Sets the filesystem type. (Requires the `filesystem_types` feature.) Valid options: 'fsfs' or 'bdb'. Default: none. 

+

+##### `group`

+

+Specifies a group to own the repository files. Valid options: a string containing a group name or GID. Default: none. 

+

+##### `identity`

+

+Specifies an identity file to use for SSH authentication. (Requires the `ssh_identity` feature.) Valid options: a string containing an absolute path. Default: none. 

+

+##### `module`

+

+Specifies the repository module to manage. (Requires the `modules` feature.) Valid options: a string containing the name of a CVS module. Default: none. 

+

+##### `owner`

+

+Specifies a user to own the repository files. Valid options: a string containing a username or UID. Default: none. 

+

+##### `p4config`

+

+Specifies a config file that contains settings for connecting to the Perforce service. (Requires the `p4config` feature.) Valid options: a string containing the absolute path to a valid [Perforce config file](http://www.perforce.com/perforce/doc.current/manuals/p4guide/chapter.configuration.html#configuration.settings.configfiles). Default: none. 

+

+##### `path`

+

+Specifies a location for the managed repository. Valid options: a string containing an absolute path. Default: the title of your declared resource. 

+

+##### `provider`

+

+*Required.* Specifies the backend to use for this vcsrepo resource. Valid options: 'bzr', 'cvs', 'git', 'hg', 'p4', and 'svn'. 

+

+##### `remote`

+

+Specifies the remote repository to track. (Requires the `multiple_remotes` feature.) Valid options: a string containing one of the remote names specified in `source`. Default: 'origin'. 

+

+##### `revision`

+

+Sets the revision of the repository. Valid options vary by provider:

+

+* `git` - a string containing a Git branch name, or a commit SHA or tag

+* `bzr` - a string containing a Bazaar [revision spec](http://wiki.bazaar.canonical.com/BzrRevisionSpec)

+* `cvs` - a string containing a CVS [tag or revision number](http://www.thathost.com/wincvs-howto/cvsdoc/cvs_4.html)

+* `hg` - a string containing a Mercurial [changeset ID](http://mercurial.selenic.com/wiki/ChangeSetID) or [tag](http://mercurial.selenic.com/wiki/Tag)

+* `p4` - a string containing a Perforce [change number, label name, client name, or date spec](http://www.perforce.com/perforce/r12.1/manuals/cmdref/o.fspecs.html)

+* `svn` - a string containing a Subversion [revision number](http://svnbook.red-bean.com/en/1.7/svn.basic.in-action.html#svn.basic.in-action.revs), [revision keyword, or revision date](http://svnbook.red-bean.com/en/1.7/svn.tour.revs.specifiers.html)

+

+Default: none. 

+

+##### `source`

+

+Specifies a source repository to serve as the upstream for your managed repository. Default: none. Valid options vary by provider:

+

+* `git` - a string containing a [Git repository URL](https://www.kernel.org/pub/software/scm/git/docs/git-clone.html#_git_urls_a_id_urls_a) or a hash of name => URL mappings. See also [`remote`](#remote).

+* `bzr` - a string containing a Bazaar branch location

+* `cvs` - a string containing a CVS root

+* `hg` - a string containing the local path or URL of a Mercurial repository

+* `p4` - a string containing a Perforce depot path

+* `svn` - a string containing a Subversion repository URL

+

+Default: none. 

+

+##### `submodules`

+

+Specifies whether to initialize and update each submodule in the repository. (Requires the `submodules` feature.) Valid options: 'true' and 'false'. Default: 'true'. 

+

+##### `trust_server_cert`

+

+Instructs Subversion to accept SSL server certificates issued by unknown certificate authorities. Valid options: 'true' and 'false'. Default: 'false'. 

+

+##### `user`

+

 Specifies the user to run as for repository operations. (Requires the `user` feature.) Valid options: a string containing a username or UID. Default: none.

 

 ##Limitations

@@ -723,12 +729,12 @@ This module has been tested with Puppet 2.7 and higher.
 

 The module has been tested on:

 

-* CentOS 5/6/7
-* Debian 6/7
+* CentOS 5/6/7

+* Debian 6/7

 * Oracle 5/6/7

 * Red Hat Enterprise Linux 5/6/7

-* Scientific Linux 5/6/7
-* SLES 10/11/12
+* Scientific Linux 5/6/7

+* SLES 10/11/12

 * Ubuntu 10.04/12.04/14.04

 

 Testing on other platforms has been light and cannot be guaranteed.

@@ -739,4 +745,4 @@ Puppet Labs modules on the Puppet Forge are open projects, and community contrib
 

 We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

 

-You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
+You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)