Merge pull request #77 from arnoudj/hg_identity

Add user and ssh identity to the Mercurial provider.

1 files changed, 20 insertions, 2 deletions

diff --git a/README.HG.markdown b/README.HG.markdown
index b1680c8..55ceef4 100644
--- a/README.HG.markdown
+++ b/README.HG.markdown
@@ -27,7 +27,7 @@ For a specific changeset, use `revision`:
     vcsrepo { "/path/to/repo":
         ensure   => present,
         provider => hg,
-        source   => "http://hg.example.com/myrepo"
+        source   => "http://hg.example.com/myrepo",
         revision => '21ea4598c962'
     }
 
@@ -36,10 +36,28 @@ You can also set `revision` to a tag:
     vcsrepo { "/path/to/repo":
         ensure   => present,
         provider => hg,
-        source   => "http://hg.example.com/myrepo"
+        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://...`)
 ------------------------------------------