Since we're overriding retrieve anyhow, make all the values for ensure explicit
[puppet_vcsrepo.git] / README.HG.markdown
index 9585ea4..55ac88f 100644 (file)
@@ -7,26 +7,49 @@ To create a blank repository
 Define a `vcsrepo` without a `source` or `revision`:
 
     vcsrepo { "/path/to/repo":
-      ensure => present,
+      ensure   => present,
       provider => hg
     }
 
 To clone/pull & update a repository
-----------------------------
+-----------------------------------
 
 To get the default branch tip:
 
     vcsrepo { "/path/to/repo":
-        ensure => present,
+        ensure   => present,
         provider => hg,
-        source => "http://hg.example.com/myrepo"
+        source   => "http://hg.example.com/myrepo"
     }
 
 For a specific changeset, use `revision`:
 
     vcsrepo { "/path/to/repo":
-        ensure => present,
+        ensure   => present,
         provider => hg,
-        source => "http://hg.example.com/myrepo"
+        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'
+    }
+
+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.reductivelabs.com/references/stable/metaparameter.html#require