Merge branch 'master' into dummy-provider
[puppet_vcsrepo.git] / README.GIT.markdown
index b63d90b..d6b8afe 100644 (file)
@@ -54,6 +54,25 @@ For a specific revision or branch (can be a commit SHA, tag or branch name):
         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:...`)
 ----------------------------------------------------
 
@@ -66,5 +85,5 @@ More Examples
 
 For examples you can run, see `examples/git/`
 
-[1]: http://docs.reductivelabs.com/references/stable/metaparameter.html#require
+[1]: http://docs.puppetlabs.com/references/stable/metaparameter.html#require