Remove extra READMEs
authorLauren Rother <lauren.rother@puppetlabs.com>
Tue, 17 Jun 2014 22:18:10 +0000 (15:18 -0700)
committerLauren Rother <lauren.rother@puppetlabs.com>
Tue, 17 Jun 2014 22:58:45 +0000 (15:58 -0700)
Delete the per-VCS readmes. They are all combined in the main readme now.

README.BZR.markdown [deleted file]
README.CVS.markdown [deleted file]
README.GIT.markdown [deleted file]
README.HG.markdown [deleted file]
README.SVN.markdown [deleted file]
README.markdown

diff --git a/README.BZR.markdown b/README.BZR.markdown
deleted file mode 100644 (file)
index cc257e9..0000000
+++ /dev/null
@@ -1,47 +0,0 @@
-Using vcsrepo with Bazaar
-=========================
-
-To create a blank repository
-----------------------------
-
-Define a `vcsrepo` without a `source` or `revision`:
-
-    vcsrepo { "/path/to/repo":
-      ensure   => present,
-      provider => bzr
-    }
-
-To branch from an existing repository
--------------------------------------
-
-Provide the `source` location:
-
-    vcsrepo { "/path/to/repo":
-        ensure   => present,
-        provider => bzr,
-        source   => 'lp:myproj'
-    }
-
-For a specific revision, use `revision` with a valid revisionspec
-(see `bzr help revisionspec` for more information on formatting a revision):
-
-    vcsrepo { "/path/to/repo":
-        ensure   => present,
-        provider => bzr,
-        source   => 'lp:myproj',
-        revision => 'menesis@pov.lt-20100309191856-4wmfqzc803fj300x'
-    }
-
-For sources that use SSH (eg, `bzr+ssh://...`, `sftp://...`)
-------------------------------------------------------------
-
-Manage your SSH keys with Puppet and use `require` in your `vcsrepo`
-to ensure they are present.  For more information, see the `require`
-metaparameter documentation[1].
-
-More Examples
--------------
-
-For examples you can run, see `examples/bzr/`
-
-[1]: http://docs.puppetlabs.com/references/stable/metaparameter.html#require
diff --git a/README.CVS.markdown b/README.CVS.markdown
deleted file mode 100644 (file)
index 3bdd59d..0000000
+++ /dev/null
@@ -1,66 +0,0 @@
-Using vcsrepo with CVS
-======================
-
-To create a blank repository
-----------------------------
-
-Define a `vcsrepo` without a `source` or `revision`:
-
-    vcsrepo { "/path/to/repo":
-      ensure => present,
-      provider => cvs
-    }
-
-To checkout/update from a repository
-------------------------------------
-
-To get the current mainline:
-
-    vcsrepo { "/path/to/workspace":
-        ensure => present,
-        provider => cvs,
-        source => ":pserver:anonymous@example.com:/sources/myproj"
-    }
-    
-To get a specific module on the current mainline:
-
-    vcsrepo {"/vagrant/lockss-daemon-source":
-        ensure   => present,
-        provider => cvs,
-        source   => ":pserver:anonymous@lockss.cvs.sourceforge.net:/cvsroot/lockss",
-        module   => "lockss-daemon",
-    }
-
-
-You can use the `compression` parameter (it works like CVS `-z`):
-
-    vcsrepo { "/path/to/workspace":
-        ensure => present,
-        provider => cvs,
-        compression => 3,
-        source => ":pserver:anonymous@example.com:/sources/myproj"
-    }
-
-For a specific tag, use `revision`:
-
-    vcsrepo { "/path/to/workspace":
-        ensure => present,
-        provider => cvs,
-        compression => 3,
-        source => ":pserver:anonymous@example.com:/sources/myproj",
-        revision => "SOMETAG"
-    }
-
-For sources that use SSH
-------------------------
-
-Manage your SSH keys with Puppet and use `require` in your `vcsrepo`
-to ensure they are present.  For more information, see the `require`
-metaparameter documentation[1].
-
-More Examples
--------------
-
-For examples you can run, see `examples/cvs/`
-
-[1]: http://docs.puppetlabs.com/references/stable/metaparameter.html#require
diff --git a/README.GIT.markdown b/README.GIT.markdown
deleted file mode 100644 (file)
index 846bdcc..0000000
+++ /dev/null
@@ -1,95 +0,0 @@
-Using vcsrepo with Git
-======================
-
-To create a blank repository
-----------------------------
-
-Define a `vcsrepo` without a `source` or `revision`:
-
-    vcsrepo { "/path/to/repo":
-      ensure => present,
-      provider => git
-    }
-
-If you're defining this for a central/"official" repository, you'll
-probably want to make it a "bare" repository.  Do this by setting
-`ensure` to `bare` instead of `present`:
-
-    vcsrepo { "/path/to/repo":
-        ensure => bare,
-        provider => git
-    }
-
-To clone/pull a repository
-----------------------------
-
-To get the current [master] HEAD:
-
-    vcsrepo { "/path/to/repo":
-        ensure => present,
-        provider => git,
-        source => "git://example.com/repo.git"
-    }
-
-For a specific revision or branch (can be a commit SHA, tag or branch name):
-
-    vcsrepo { "/path/to/repo":
-        ensure => present,
-        provider => git,
-        source => 'git://example.com/repo.git',
-        revision => '0c466b8a5a45f6cd7de82c08df2fb4ce1e920a31'
-    }
-
-    vcsrepo { "/path/to/repo":
-        ensure => present,
-        provider => git,
-        source => 'git://example.com/repo.git',
-        revision => '1.1.2rc1'
-    }
-
-    vcsrepo { "/path/to/repo":
-        ensure => present,
-        provider => git,
-        source => 'git://example.com/repo.git',
-        revision => 'development'
-    }
-
-Check out as a user:
-
-    vcsrepo { "/path/to/repo":
-        ensure => present,
-        provider => git,
-        source => 'git://example.com/repo.git',
-        revision => '0c466b8a5a45f6cd7de82c08df2fb4ce1e920a31',
-        user => 'someUser'
-    }
-
-Keep the repository at the latest revision (note: this will always overwrite local changes to the repository):
-
-    vcsrepo { "/path/to/repo":
-        ensure => latest,
-        provider => git,
-        source => 'git://example.com/repo.git',
-        revision => 'master',
-    }
-
-For sources that use SSH (eg, `username@server:...`)
-----------------------------------------------------
-
-If your SSH key is associated with a user, simply fill the `user` parameter to use his keys.
-
-Example:
-
-    user => 'toto'  # will use toto's $HOME/.ssh setup
-
-
-Otherwise, manage your SSH keys with Puppet and use `require` in your `vcsrepo` to ensure they are present.
-For more information, see the `require` metaparameter documentation[1].
-
-More Examples
--------------
-
-For examples you can run, see `examples/git/`
-
-[1]: http://docs.puppetlabs.com/references/stable/metaparameter.html#require
-
diff --git a/README.HG.markdown b/README.HG.markdown
deleted file mode 100644 (file)
index 55ceef4..0000000
+++ /dev/null
@@ -1,73 +0,0 @@
-Using vcsrepo with Mercurial
-============================
-
-To create a blank repository
-----------------------------
-
-Define a `vcsrepo` without a `source` or `revision`:
-
-    vcsrepo { "/path/to/repo":
-      ensure   => present,
-      provider => hg
-    }
-
-To clone/pull & update a repository
------------------------------------
-
-To get the default branch tip:
-
-    vcsrepo { "/path/to/repo":
-        ensure   => present,
-        provider => hg,
-        source   => "http://hg.example.com/myrepo"
-    }
-
-For a specific changeset, use `revision`:
-
-    vcsrepo { "/path/to/repo":
-        ensure   => present,
-        provider => hg,
-        source   => "http://hg.example.com/myrepo",
-        revision => '21ea4598c962'
-    }
-
-You can also set `revision` to a tag:
-
-    vcsrepo { "/path/to/repo":
-        ensure   => present,
-        provider => hg,
-        source   => "http://hg.example.com/myrepo",
-        revision => '1.1.2'
-    }
-
-Check out as a user:
-
-    vcsrepo { "/path/to/repo":
-        ensure   => present,
-        provider => hg,
-        source   => "http://hg.example.com/myrepo",
-        user     => 'user'
-    }
-
-Specify an SSH identity key:
-
-    vcsrepo { "/path/to/repo":
-        ensure   => present,
-        provider => hg,
-        source   => "ssh://hg@hg.example.com/myrepo",
-        identity => "/home/user/.ssh/id_dsa,
-    }
-
-For sources that use SSH (eg, `ssh://...`)
-------------------------------------------
-
-Manage your SSH keys with Puppet and use `require` in your `vcsrepo`
-to ensure they are present.  For more information, see the `require`
-metaparameter documentation[1].
-
-More Examples
--------------
-
-For examples you can run, see `examples/hg/`
-
-[1]: http://docs.puppetlabs.com/references/stable/metaparameter.html#require
diff --git a/README.SVN.markdown b/README.SVN.markdown
deleted file mode 100644 (file)
index f374094..0000000
+++ /dev/null
@@ -1,62 +0,0 @@
-Using vcsrepo with Subversion
-=============================
-
-To create a blank repository
-----------------------------
-
-To create a blank repository suitable for use as a central repository,
-define a `vcsrepo` without a `source` or `revision`:
-
-    vcsrepo { "/path/to/repo":
-      ensure   => present,
-      provider => svn
-    }
-
-To checkout from a repository
------------------------------
-
-Provide a `source` qualified to the branch/tag you want:
-
-    vcsrepo { "/path/to/repo":
-        ensure   => present,
-        provider => svn,
-        source   => "svn://svnrepo/hello/branches/foo"
-    }
-
-You can provide a specific `revision`:
-
-    vcsrepo { "/path/to/repo":
-        ensure   => present,
-        provider => svn,
-        source   => "svn://svnrepo/hello/branches/foo",
-        revision => '1234'
-    }
-
-
-Using a specified Subversion configuration directory 
------------------------------
-
-Provide a `configuration` parameter which should be a directory path on the local system where your svn configuration
-files are.  Typically, it is /path/to/.subversion:
-
-    vcsrepo { "/path/to/repo":
-        ensure        => present,
-        provider      => svn,
-        source        => "svn://svnrepo/hello/branches/foo",
-        configuration => "/path/to/.subversion"
-    }
-
-
-For sources that use SSH (eg, `svn+ssh://...`)
-----------------------------------------------
-
-Manage your SSH keys with Puppet and use `require` in your `vcsrepo`
-to ensure they are present.  For more information, see the `require`
-metaparameter documentation[1].
-
-More Examples
--------------
-
-For examples you can run, see `examples/svn/`
-
-[1]: http://docs.puppetlabs.com/references/stable/metaparameter.html#require
index d0b9169..39cd249 100644 (file)
@@ -25,7 +25,7 @@
 
 ##Overview
 
-The vcsrepo module allows you to use Puppet to easily deploy code from your version control system (VCS).
+The vcsrepo module allows you to use Puppet to easily deploy content from your version control system (VCS).
 
 ##Module Description
 
@@ -246,7 +246,7 @@ For SSH keys associated with a user, enter the username in the `user` parameter.
 
 #####Further Examples
 
-For for more examples using Git, see `examples/git/`.
+For more examples using Git, see `examples/git/`.
 
 ###Mercurial
 
@@ -415,7 +415,7 @@ The vcsrepo module is slightly unusual in that it is simply a type and providers
 * `module` - Specifies the repository module to manage. (Requires the `modules` feature.)
 * `owner` - Specifies the user/uid that owns the repository files.
 *  `path` - Specifies the absolute path to the repository. If omitted, the value defaults to the resource's title.
-* `provider` - The specific backend to use for this vcsrepo resource. Puppet will usually discover the appropriate provider for your platform.
+* `provider` - Specifies the backend to use for this vcsrepo resource. 
 * `remote` - Specifies the remote repository to track. (Requires the `multiple_remotes` feature.)
 * `revision` - Sets the revision of the repository. Values can match /^\S+$/.
 * `source` - Specifies the source URI for the repository.