summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorPaul Allen <pallen@perforce.com>2014-06-23 15:51:28 +0100
committerPaul Allen <pallen@perforce.com>2014-06-23 15:51:28 +0100
commit319f9fbe1954fd172da638f3ccd76e58c3ec8c7f (patch)
tree24f0bcc88c3b2ed927e7698a1b5b290f4f7e5768 /README.markdown
parentac4e14770fc04db02be2f48f6de675e90e3f6b29 (diff)
downloadpuppet-vcsrepo-319f9fbe1954fd172da638f3ccd76e58c3ec8c7f.tar.gz
puppet-vcsrepo-319f9fbe1954fd172da638f3ccd76e58c3ec8c7f.tar.bz2
Added support for p4config.
- Removed p4port, p4client, p4user to keep name space clean. - Changed notify to Puppet.debug - Updated markdown and examples - Updated unit tests
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown45
1 files changed, 10 insertions, 35 deletions
diff --git a/README.markdown b/README.markdown
index 6dc36d2..5f8aa9d 100644
--- a/README.markdown
+++ b/README.markdown
@@ -329,18 +329,19 @@ connection settings.
provider => p4
}
-If no `p4client` name is provided a workspace generated name is calculated based on the
-Digest of path. For example:
+If no `P4CLIENT` environment name is provided a workspace generated name is calculated
+based on the Digest of path. For example:
puppet-91bc00640c4e5a17787286acbe2c021c
-Providing a `p4client` name will create/update the client workspace in Perforce. The
-value replaces the P4CLIENT environment variable.
+A Perforce configuration file can be used by setting the `P4CONFIG` environment or
+defining `p4config`. If a configuration is defined, then the environment variable for
+`P4CLIENT` is replaced.
vcsrepo { "/path/to/repo":
ensure => present,
- provider => p4
- p4client => "my_client_ws"
+ provider => p4,
+ p4config => '.p4config'
}
#####To create/update and sync a Perforce workspace
@@ -371,36 +372,10 @@ You can also set `revision` to a label:
revision => 'my_label'
}
-Check out as a user by setting `p4user`:
-
- vcsrepo { "/path/to/repo":
- ensure => present,
- provider => p4,
- source => '//depot/branch/...',
- p4user => 'user'
- }
-
-You can set `p4port` to specify a Perforce server:
-
- vcsrepo { "/path/to/repo":
- ensure => present,
- provider => p4,
- source => '//depot/branch/...',
- p4port => 'ssl:perforce.com:1666'
- }
-
-You can set `p4passwd` for authentication :
-
- vcsrepo { "/path/to/repo":
- ensure => present,
- provider => p4,
- source => '//depot/branch/...',
- p4port => 'ssl:perforce.com:1666'
- }
+#####To authenticate against the Perforce server
-If `p4port`, `p4user`, `p4charset`, `p4passwd` or `p4client` are specified they will
-override the environment variabels P4PORT, P4USER, etc... If a P4CONFIG file is defined,
-the config file settings will take precedence.
+Either set the environment variables `P4USER` and `P4PASSWD` or use a configuration file.
+For secure servers set the `P4PASSWD` with a valid ticket generated using `p4 login -p`.
#####Further Examples