From 5af85f5dce1396f983547dff04b09cdab42f42f1 Mon Sep 17 00:00:00 2001 From: "Edward Z. Yang" Date: Thu, 21 Jun 2007 04:20:30 +0000 Subject: [PATCH] Add PECL Subversion extension documentation. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238178 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/svn/configure.xml | 48 ++ reference/svn/constants.xml | 418 +++++++++++++++++ reference/svn/functions/svn-add.xml | 167 +++++++ .../svn/functions/svn-auth-get-parameter.xml | 148 ++++++ .../svn/functions/svn-auth-set-parameter.xml | 140 ++++++ reference/svn/functions/svn-cat.xml | 144 ++++++ reference/svn/functions/svn-checkout.xml | 162 +++++++ reference/svn/functions/svn-cleanup.xml | 139 ++++++ .../svn/functions/svn-client-version.xml | 120 +++++ reference/svn/functions/svn-commit.xml | 194 ++++++++ reference/svn/functions/svn-diff.xml | 248 ++++++++++ reference/svn/functions/svn-fs-abort-txn.xml | 147 ++++++ reference/svn/functions/svn-fs-apply-text.xml | 156 +++++++ reference/svn/functions/svn-fs-begin-txn2.xml | 156 +++++++ .../svn/functions/svn-fs-change-node-prop.xml | 174 +++++++ reference/svn/functions/svn-fs-check-path.xml | 156 +++++++ .../svn/functions/svn-fs-contents-changed.xml | 174 +++++++ reference/svn/functions/svn-fs-copy.xml | 174 +++++++ reference/svn/functions/svn-fs-delete.xml | 156 +++++++ .../svn/functions/svn-fs-dir-entries.xml | 156 +++++++ .../svn/functions/svn-fs-file-contents.xml | 156 +++++++ .../svn/functions/svn-fs-file-length.xml | 156 +++++++ reference/svn/functions/svn-fs-is-dir.xml | 156 +++++++ reference/svn/functions/svn-fs-is-file.xml | 156 +++++++ reference/svn/functions/svn-fs-make-dir.xml | 156 +++++++ reference/svn/functions/svn-fs-make-file.xml | 156 +++++++ .../svn/functions/svn-fs-node-created-rev.xml | 156 +++++++ reference/svn/functions/svn-fs-node-prop.xml | 165 +++++++ .../svn/functions/svn-fs-props-changed.xml | 174 +++++++ .../svn/functions/svn-fs-revision-prop.xml | 165 +++++++ .../svn/functions/svn-fs-revision-root.xml | 156 +++++++ reference/svn/functions/svn-fs-txn-root.xml | 147 ++++++ .../svn/functions/svn-fs-youngest-rev.xml | 147 ++++++ reference/svn/functions/svn-import.xml | 155 +++++++ reference/svn/functions/svn-log.xml | 283 ++++++++++++ reference/svn/functions/svn-ls.xml | 158 +++++++ reference/svn/functions/svn-repos-create.xml | 165 +++++++ .../svn-repos-fs-begin-txn-for-commit.xml | 174 +++++++ .../svn/functions/svn-repos-fs-commit-txn.xml | 147 ++++++ reference/svn/functions/svn-repos-fs.xml | 147 ++++++ reference/svn/functions/svn-repos-hotcopy.xml | 165 +++++++ reference/svn/functions/svn-repos-open.xml | 147 ++++++ reference/svn/functions/svn-repos-recover.xml | 147 ++++++ reference/svn/functions/svn-status.xml | 432 ++++++++++++++++++ reference/svn/functions/svn-update.xml | 159 +++++++ reference/svn/reference.xml | 65 +++ 46 files changed, 7767 insertions(+) create mode 100644 reference/svn/configure.xml create mode 100644 reference/svn/constants.xml create mode 100644 reference/svn/functions/svn-add.xml create mode 100644 reference/svn/functions/svn-auth-get-parameter.xml create mode 100644 reference/svn/functions/svn-auth-set-parameter.xml create mode 100644 reference/svn/functions/svn-cat.xml create mode 100644 reference/svn/functions/svn-checkout.xml create mode 100644 reference/svn/functions/svn-cleanup.xml create mode 100644 reference/svn/functions/svn-client-version.xml create mode 100644 reference/svn/functions/svn-commit.xml create mode 100644 reference/svn/functions/svn-diff.xml create mode 100644 reference/svn/functions/svn-fs-abort-txn.xml create mode 100644 reference/svn/functions/svn-fs-apply-text.xml create mode 100644 reference/svn/functions/svn-fs-begin-txn2.xml create mode 100644 reference/svn/functions/svn-fs-change-node-prop.xml create mode 100644 reference/svn/functions/svn-fs-check-path.xml create mode 100644 reference/svn/functions/svn-fs-contents-changed.xml create mode 100644 reference/svn/functions/svn-fs-copy.xml create mode 100644 reference/svn/functions/svn-fs-delete.xml create mode 100644 reference/svn/functions/svn-fs-dir-entries.xml create mode 100644 reference/svn/functions/svn-fs-file-contents.xml create mode 100644 reference/svn/functions/svn-fs-file-length.xml create mode 100644 reference/svn/functions/svn-fs-is-dir.xml create mode 100644 reference/svn/functions/svn-fs-is-file.xml create mode 100644 reference/svn/functions/svn-fs-make-dir.xml create mode 100644 reference/svn/functions/svn-fs-make-file.xml create mode 100644 reference/svn/functions/svn-fs-node-created-rev.xml create mode 100644 reference/svn/functions/svn-fs-node-prop.xml create mode 100644 reference/svn/functions/svn-fs-props-changed.xml create mode 100644 reference/svn/functions/svn-fs-revision-prop.xml create mode 100644 reference/svn/functions/svn-fs-revision-root.xml create mode 100644 reference/svn/functions/svn-fs-txn-root.xml create mode 100644 reference/svn/functions/svn-fs-youngest-rev.xml create mode 100644 reference/svn/functions/svn-import.xml create mode 100644 reference/svn/functions/svn-log.xml create mode 100644 reference/svn/functions/svn-ls.xml create mode 100644 reference/svn/functions/svn-repos-create.xml create mode 100644 reference/svn/functions/svn-repos-fs-begin-txn-for-commit.xml create mode 100644 reference/svn/functions/svn-repos-fs-commit-txn.xml create mode 100644 reference/svn/functions/svn-repos-fs.xml create mode 100644 reference/svn/functions/svn-repos-hotcopy.xml create mode 100644 reference/svn/functions/svn-repos-open.xml create mode 100644 reference/svn/functions/svn-repos-recover.xml create mode 100644 reference/svn/functions/svn-status.xml create mode 100644 reference/svn/functions/svn-update.xml create mode 100644 reference/svn/reference.xml diff --git a/reference/svn/configure.xml b/reference/svn/configure.xml new file mode 100644 index 0000000000..92e9a9d44f --- /dev/null +++ b/reference/svn/configure.xml @@ -0,0 +1,48 @@ + + +
+ &reftitle.install; + + &pecl.info; + http://pecl.php.net/package/svn + + + If ./configure is having trouble finding the + SVN files (for example, Subversion was installed with a + different prefix directory), use + ./configure --with-svn=$USR_PATH + to specify the directory where the + include/subversion-1/ folder is located. + + + &pecl.windows.download; + + + + If the extension is compiled against libsvn 1.3, + functions that work with working copies will fail + when used on working copies created by Subversion 1.4. + + +
+ + diff --git a/reference/svn/constants.xml b/reference/svn/constants.xml new file mode 100644 index 0000000000..d75c74a25c --- /dev/null +++ b/reference/svn/constants.xml @@ -0,0 +1,418 @@ + + +
+ &reftitle.constants; + &extension.constants; + + + + SVN_REVISON_HEAD + (integer) + + + + Magic number (-1) specifying the HEAD revision + + + + + + Constants usable with <function>svn_auth_set_parameter</function> + + + SVN_AUTH_PARAM_DEFAULT_USERNAME + (string) + + + + Property for default username to use when performing basic authentication + + + + + + SVN_AUTH_PARAM_DEFAULT_PASSWORD + (string) + + + + Property for default password to use when performing basic authentication + + + + + + SVN_AUTH_PARAM_NON_INTERACTIVE + (string) + + + + + + SVN_AUTH_PARAM_DONT_STORE_PASSWORDS + (string) + + + + + + SVN_AUTH_PARAM_NO_AUTH_CACHE + (string) + + + + + + SVN_AUTH_PARAM_SSL_SERVER_FAILURES + (string) + + + + + + SVN_AUTH_PARAM_SSL_SERVER_CERT_INFO + (string) + + + + + SVN_AUTH_PARAM_CONFIG + (string) + + + + + + SVN_AUTH_PARAM_SERVER_GROUP + (string) + + + + + + SVN_AUTH_PARAM_CONFIG_DIR + (string) + + + + + + PHP_SVN_AUTH_PARAM_IGNORE_SSL_VERIFY_ERRORS + (string) + + + + Custom property for ignoring SSL cert verification errors + + + + + + Filesystem constants + + + SVN_FS_CONFIG_FS_TYPE + (string) + + + + Configuration key that determines filesystem type + + + + + + SVN_FS_TYPE_BDB + (string) + + + + Filesystem is Berkeley-DB implementation + + + + + + SVN_FS_TYPE_FSFS + (string) + + + + Filesystem is native-filesystem implementation + + + + + + Reserved property constants + + + SVN_PROP_REVISION_DATE + (string) + + + + svn:date + + + + + + SVN_PROP_REVISION_ORIG_DATE + (string) + + + + svn:original-date + + + + + + SVN_PROP_REVISION_AUTHOR + (string) + + + + svn:author + + + + + + SVN_PROP_REVISION_LOG + (string) + + + + svn:log + + + + + + Working copy status constants + + + svn_wc_status_none + (int) + + + + Status does not exist + + + + + + svn_wc_status_unversioned + (int) + + + + Item is not versioned in working copy + + + + + + svn_wc_status_normal + (int) + + + + Item exists, nothing else is happening + + + + + + svn_wc_status_added + (int) + + + + Item is scheduled for addition + + + + + + svn_wc_status_missing + (int) + + + + Item is versioned but missing from the working copy + + + + + + svn_wc_status_deleted + (int) + + + + Item is scheduled for deletion + + + + + + svn_wc_status_replaced + (int) + + + + Item was deleted and then re-added + + + + + + svn_wc_status_modified + (int) + + + + Item (text or properties) was modified + + + + + + svn_wc_status_merged + (int) + + + + Item's local modifications were merged with repository modifications + + + + + + svn_wc_status_conflicted + (int) + + + + Item's local modifications conflicted with repository modifications + + + + + + svn_wc_status_ignored + (int) + + + + Item is unversioned but configured to be ignored + + + + + + svn_wc_status_obstructed + (int) + + + + Unversioned item is in the way of a versioned resource + + + + + + svn_wc_status_external + (int) + + + + Unversioned path that is populated using svn:externals + + + + + + svn_wc_status_incomplete + (int) + + + + Directory does not contain complete entries list + + + + + + Node type constants + + + svn_node_none + (int) + + + + Absent + + + + + + svn_node_file + (int) + + + + File + + + + + + svn_node_dir + (int) + + + + Directory + + + + + + svn_node_unknown + (int) + + + + Something Subversion cannot identify + + + + +
+ + diff --git a/reference/svn/functions/svn-add.xml b/reference/svn/functions/svn-add.xml new file mode 100644 index 0000000000..99486c7d1d --- /dev/null +++ b/reference/svn/functions/svn-add.xml @@ -0,0 +1,167 @@ + + + + + svn_add + Schedules the addition of an item in a working directory + + + + &reftitle.description; + + boolsvn_add + stringpath + boolrecursive + boolforce + + + Adds the file, directory or symbolic link at path + to the working directory. The item will be added to the repository + the next time you call svn_commit on the working + copy. + + + + + &reftitle.parameters; + + + + path + + + Path of item to add. + + &svn.relativepath; + + + + recursive + + + If item is directory, whether or not to recursively add + all of its contents. Default is &true; + + + + + force + + + If true, Subversion will recurse into already versioned directories + in order to add unversioned files that may be hiding in those + directories. Default is &false; + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + &reftitle.examples; + + + <function>svn_add</function> example + + In a working directory where svn status + returns: + + + + + ...this code: + + +]]> + + + ...will schedule foobar.txt for addition into + the repository. + + + + + + + &reftitle.seealso; + + + SVN documentation on svn add + + + + + + + diff --git a/reference/svn/functions/svn-auth-get-parameter.xml b/reference/svn/functions/svn-auth-get-parameter.xml new file mode 100644 index 0000000000..bb6cea8ba4 --- /dev/null +++ b/reference/svn/functions/svn-auth-get-parameter.xml @@ -0,0 +1,148 @@ + + + + + svn_auth_get_parameter + Retrieves authentication parameter + + + + &reftitle.description; + + stringsvn_auth_get_parameter + stringkey + + + Retrieves authentication parameter at key. + For a list of valid keys and their meanings, consult the + authentication constants list. + + + + + &reftitle.parameters; + + + + key + + + String key name. Use the authentication constants + defined by this extension to specify a key. + + + + + + + + + &reftitle.returnvalues; + + Returns the string value of the parameter at key; + returns &null; if parameter does not exist. + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + &reftitle.seealso; + + + svn_auth_set_parameter + Authentication constants + + + + + + + diff --git a/reference/svn/functions/svn-auth-set-parameter.xml b/reference/svn/functions/svn-auth-set-parameter.xml new file mode 100644 index 0000000000..cd5271c99a --- /dev/null +++ b/reference/svn/functions/svn-auth-set-parameter.xml @@ -0,0 +1,140 @@ + + + + + svn_auth_set_parameter + Sets an authentication parameter + + + + &reftitle.description; + + voidsvn_auth_set_parameter + stringkey + stringvalue + + + Sets authentication parameter at key to value. + For a list of valid keys and their meanings, consult the + authentication constants list. + + + + + &reftitle.parameters; + + + + key + + + String key name. Use the authentication constants + defined by this extension to specify a key. + + + + + value + + + String value to set to parameter at key. Format of value varies + with the parameter. + + + + + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + &reftitle.examples; + + + Default authentication example + + This example configures SVN so that the default username to use + is 'Bob' and the default password is 'abc123': + + + +]]> + + + + + + + &reftitle.seealso; + + + svn_auth_get_parameter + Authentication constants + + + + + + + diff --git a/reference/svn/functions/svn-cat.xml b/reference/svn/functions/svn-cat.xml new file mode 100644 index 0000000000..499dbef174 --- /dev/null +++ b/reference/svn/functions/svn-cat.xml @@ -0,0 +1,144 @@ + + + + + svn_cat + Returns the contents of a file in a repository + + + + &reftitle.description; + + stringsvn_cat + stringrepos_url + intrevision_no + + + Returns the contents of the URL repos_url to + a file in the repository, optionally at revision number + revision_no. + + + + + &reftitle.parameters; + + + + repos_url + + + String URL path to item in a repository. + + + + + revision_no + + + Integer revision number of item to retrieve, default is the HEAD + revision. + + + + + + + + + &reftitle.returnvalues; + + Returns the string contents of the item from the repository on + success, and &false; on failure. + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + &reftitle.examples; + + + Basic example + + This example retrieves the contents of a file at revision 28: + + + +]]> + + + + + + + &reftitle.seealso; + + + svn_list + SVN documentation on svn cat + + + + + + + diff --git a/reference/svn/functions/svn-checkout.xml b/reference/svn/functions/svn-checkout.xml new file mode 100644 index 0000000000..cd0eb880a1 --- /dev/null +++ b/reference/svn/functions/svn-checkout.xml @@ -0,0 +1,162 @@ + + + + + svn_checkout + Checks out a working copy from the repository + + + + &reftitle.description; + + boolsvn_checkout + stringrepos + stringtargetpath + intrevision + + + Checks out a working copy from the repository at repos + to targetpath at revision revision. + + + + + &reftitle.parameters; + + + + repos + + + String URL path to directory in repository to check out. + + + + + targetpath + + + String local path to directory to check out in to + + &svn.relativepath; + + + + revision + + + Integer revision number of repository to check out. Default is + HEAD, the most recent revision. + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + &reftitle.examples; + + + Basic example + + This example demonstrates how to check out a directory from + a repository to a directory named calc: + + + +]]> + + + The dirname(__FILE__) call is necessary in order + to convert the calc relative path into an absolute one. If calc + exists, you can also use realpath to retrieve + an absolute path. + + + + + + + &reftitle.seealso; + + + svn_add + svn_commit + svn_status + svn_update + SVN documentation on svn checkout + + + + + + + diff --git a/reference/svn/functions/svn-cleanup.xml b/reference/svn/functions/svn-cleanup.xml new file mode 100644 index 0000000000..93848a3242 --- /dev/null +++ b/reference/svn/functions/svn-cleanup.xml @@ -0,0 +1,139 @@ + + + + + svn_cleanup + Recursively cleanup a working copy directory, finishing incomplete operations and removing locks + + + + &reftitle.description; + + boolsvn_cleanup + stringworkingdir + + + Recursively cleanup working copy directory workingdir, + finishing any incomplete operations and removing working copy locks. Use + when a working copy is in limbo and needs to be usable again. + + + + + &reftitle.parameters; + + + + workingdir + + + String path to local working directory to cleanup + + &svn.relativepath; + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + &reftitle.examples; + + + Basic example + + This example demonstrates clean up of a working copy in a + directory named help-me: + + + +]]> + + + The realpath call is necessary due to + SVN's quirky handling of relative paths. + + + + + + + &reftitle.seealso; + + + update + SVN documentation on svn cleanup + + + + + + + diff --git a/reference/svn/functions/svn-client-version.xml b/reference/svn/functions/svn-client-version.xml new file mode 100644 index 0000000000..fcf8566173 --- /dev/null +++ b/reference/svn/functions/svn-client-version.xml @@ -0,0 +1,120 @@ + + + + + svn_client_version + Returns the version of the SVN client libraries + + + + &reftitle.description; + + stringsvn_client_version + + + + Returns the version of the SVN client libraries + + + + + &reftitle.returnvalues; + + String version number, usually in form of x.y.z. + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + &reftitle.examples; + + Basic example + + + +]]> + + &example.outputs.similar; + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-commit.xml b/reference/svn/functions/svn-commit.xml new file mode 100644 index 0000000000..62e4f2b383 --- /dev/null +++ b/reference/svn/functions/svn-commit.xml @@ -0,0 +1,194 @@ + + + + + svn_commit + Sends changes from the local working copy to the repository + + + + &reftitle.description; + + arraysvn_commit + stringlog + arraytargets + booldontrecurse + + + Commits changes made in the local working copy files enumerated in + the targets array to the repository, with the + log message log. Directories in the targets + array will be recursively committed unless dontrecurse + is set to true. + + + + This function does not have any parameters for specifying authentication, + so a username and password must be set using svn_auth_set_parameter + + + + + + &reftitle.parameters; + + + + log + + + String log text to commit + + + + + targets + + + Array of local paths of files to be committed + + + + This parameter must be an array, a string for a single + target is not acceptable. + + + &svn.relativepath; + + + + dontrecurse + + + Boolean flag to disable recursive committing of + directories in the targets array. + Default is &false;. + + + + + + + + + &reftitle.returnvalues; + + Returns array in form of: + + + integer revision number of commit + 1 => string ISO 8601 date and time of commit + 2 => name of committer +) +]]> + + + Returns &false; on failure. + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + &reftitle.examples; + + + Basic example + + This example commits the calculator directory to a repository, using + the username Bob and the password abc123 (hopefully, his password is + stronger): + + + +]]> + + &example.outputs; + + 1415, + 1 => '2007-05-26T01:44:28.453125Z', + 2 => 'Bob' +) +]]> + + + + + + + &reftitle.seealso; + + + svn_auth_set_parameter + SVN documentation on svn commit + + + + + + + diff --git a/reference/svn/functions/svn-diff.xml b/reference/svn/functions/svn-diff.xml new file mode 100644 index 0000000000..588cd9f5de --- /dev/null +++ b/reference/svn/functions/svn-diff.xml @@ -0,0 +1,248 @@ + + + + + svn_diff + Recursively diffs two paths + + + + &reftitle.description; + + arraysvn_diff + stringpath1 + intrev1 + stringpath2 + intrev2 + + + Recursively diffs two paths, path1 and + path2. + + + + This is not a general-purpose diff utility. Only local files + that are versioned may be diffed: other files will fail. + + + + + + &reftitle.parameters; + + + + path1 + + + First path to diff. This can be a URL to a file/directory in an SVN + repository or a local file/directory path. + + &svn.relativepath; + + + If a local file path has only backslashes and no forward slashes, + this extension will fail to find the path. Always + replace all backslashes with forward slashes when using this + function. + + + + + + rev1 + + + First path's revision number. Use SVN_REVISON_HEAD + to specify the most recent revision. + + + + + path2 + + + Second path to diff. See path1 for description. + + + + + rev2 + + + Second path's revision number. See rev2 + for description. + + + + + + + + + &reftitle.returnvalues; + + Returns an array-list consisting of two streams: the first is the diff output + and the second contains error stream output. The streams can be + read using fread. Returns &false; or &null; on + error. + + + The diff output will, by default, be in the form of Subversion's + custom unified diff format, but an + external + diff engine may be + used depending on Subversion's configuration. + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + &reftitle.examples; + + + Basic example + + This example demonstrates the basic usage of this function, and + the retrieval of contents from the stream: + + + +]]> + + &example.outputs; + + + + + + + + Diffing two revisions of a repository path + + This example implements a wrapper function that allows a user + to easily diff two revisions of the same item using an external + repository path (the default syntax is somewhat verbose): + + + +]]> + + + + + + Portably diffing two local files + + This example implements a wrapper function that portably + diffs two local files, compensating for the realpath + fix and the backslashes bug: + + + +]]> + + + + + + + &reftitle.seealso; + + + SVN documentation on svn diff + + + + + + + diff --git a/reference/svn/functions/svn-fs-abort-txn.xml b/reference/svn/functions/svn-fs-abort-txn.xml new file mode 100644 index 0000000000..8c30fb85eb --- /dev/null +++ b/reference/svn/functions/svn-fs-abort-txn.xml @@ -0,0 +1,147 @@ + + + + + svn_fs_abort_txn + Abort a transaction, returns true if everything is ok, false othewise + + + + &reftitle.description; + + boolsvn_fs_abort_txn + resourcetxn + + &warn.undocumented.func; + + Abort a transaction, returns true if everything is ok, false othewise + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-fs-apply-text.xml b/reference/svn/functions/svn-fs-apply-text.xml new file mode 100644 index 0000000000..1ec29534b4 --- /dev/null +++ b/reference/svn/functions/svn-fs-apply-text.xml @@ -0,0 +1,156 @@ + + + + + svn_fs_apply_text + Creates and returns a stream that will be used to replace + + + + &reftitle.description; + + resourcesvn_fs_apply_text + resourceroot + stringpath + + &warn.undocumented.func; + + Creates and returns a stream that will be used to replace + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-fs-begin-txn2.xml b/reference/svn/functions/svn-fs-begin-txn2.xml new file mode 100644 index 0000000000..c258ccd2b3 --- /dev/null +++ b/reference/svn/functions/svn-fs-begin-txn2.xml @@ -0,0 +1,156 @@ + + + + + svn_fs_begin_txn2 + Create a new transaction + + + + &reftitle.description; + + resourcesvn_fs_begin_txn2 + resourcerepos + intrev + + &warn.undocumented.func; + + Create a new transaction + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-fs-change-node-prop.xml b/reference/svn/functions/svn-fs-change-node-prop.xml new file mode 100644 index 0000000000..7a5e0768f6 --- /dev/null +++ b/reference/svn/functions/svn-fs-change-node-prop.xml @@ -0,0 +1,174 @@ + + + + + svn_fs_change_node_prop + Return true if everything is ok, false otherwise + + + + &reftitle.description; + + boolsvn_fs_change_node_prop + resourceroot + stringpath + stringname + stringvalue + + &warn.undocumented.func; + + Return true if everything is ok, false otherwise + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-fs-check-path.xml b/reference/svn/functions/svn-fs-check-path.xml new file mode 100644 index 0000000000..b112a05b42 --- /dev/null +++ b/reference/svn/functions/svn-fs-check-path.xml @@ -0,0 +1,156 @@ + + + + + svn_fs_check_path + Determines what kind of item lives at path in a given repository fsroot + + + + &reftitle.description; + + intsvn_fs_check_path + resourcefsroot + stringpath + + &warn.undocumented.func; + + Determines what kind of item lives at path in a given repository fsroot + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-fs-contents-changed.xml b/reference/svn/functions/svn-fs-contents-changed.xml new file mode 100644 index 0000000000..f7c2cf614e --- /dev/null +++ b/reference/svn/functions/svn-fs-contents-changed.xml @@ -0,0 +1,174 @@ + + + + + svn_fs_contents_changed + Return true if content is different, false otherwise + + + + &reftitle.description; + + boolsvn_fs_contents_changed + resourceroot1 + stringpath1 + resourceroot2 + stringpath2 + + &warn.undocumented.func; + + Return true if content is different, false otherwise + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-fs-copy.xml b/reference/svn/functions/svn-fs-copy.xml new file mode 100644 index 0000000000..94a2ce02ad --- /dev/null +++ b/reference/svn/functions/svn-fs-copy.xml @@ -0,0 +1,174 @@ + + + + + svn_fs_copy + Copies a file or a directory, returns true if all is ok, false otherwise + + + + &reftitle.description; + + boolsvn_fs_copy + resourcefrom_root + stringfrom_path + resourceto_root + stringto_path + + &warn.undocumented.func; + + Copies a file or a directory, returns true if all is ok, false otherwise + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-fs-delete.xml b/reference/svn/functions/svn-fs-delete.xml new file mode 100644 index 0000000000..52842a70a2 --- /dev/null +++ b/reference/svn/functions/svn-fs-delete.xml @@ -0,0 +1,156 @@ + + + + + svn_fs_delete + Deletes a file or a directory, return true if all is ok, false otherwise + + + + &reftitle.description; + + boolsvn_fs_delete + resourceroot + stringpath + + &warn.undocumented.func; + + Deletes a file or a directory, return true if all is ok, false otherwise + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-fs-dir-entries.xml b/reference/svn/functions/svn-fs-dir-entries.xml new file mode 100644 index 0000000000..deead6c130 --- /dev/null +++ b/reference/svn/functions/svn-fs-dir-entries.xml @@ -0,0 +1,156 @@ + + + + + svn_fs_dir_entries + Enumerates the directory entries under path; returns a hash of dir names to file type + + + + &reftitle.description; + + arraysvn_fs_dir_entries + resourcefsroot + stringpath + + &warn.undocumented.func; + + Enumerates the directory entries under path; returns a hash of dir names to file type + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-fs-file-contents.xml b/reference/svn/functions/svn-fs-file-contents.xml new file mode 100644 index 0000000000..40288cfecf --- /dev/null +++ b/reference/svn/functions/svn-fs-file-contents.xml @@ -0,0 +1,156 @@ + + + + + svn_fs_file_contents + Returns a stream to access the contents of a file from a given version of the fs + + + + &reftitle.description; + + resourcesvn_fs_file_contents + resourcefsroot + stringpath + + &warn.undocumented.func; + + Returns a stream to access the contents of a file from a given version of the fs + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-fs-file-length.xml b/reference/svn/functions/svn-fs-file-length.xml new file mode 100644 index 0000000000..78859a4235 --- /dev/null +++ b/reference/svn/functions/svn-fs-file-length.xml @@ -0,0 +1,156 @@ + + + + + svn_fs_file_length + Returns the length of a file from a given version of the fs + + + + &reftitle.description; + + intsvn_fs_file_length + resourcefsroot + stringpath + + &warn.undocumented.func; + + Returns the length of a file from a given version of the fs + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-fs-is-dir.xml b/reference/svn/functions/svn-fs-is-dir.xml new file mode 100644 index 0000000000..c5aabf14ec --- /dev/null +++ b/reference/svn/functions/svn-fs-is-dir.xml @@ -0,0 +1,156 @@ + + + + + svn_fs_is_dir + Return true if the path points to a directory, false otherwise + + + + &reftitle.description; + + boolsvn_fs_is_dir + resourceroot + stringpath + + &warn.undocumented.func; + + Return true if the path points to a directory, false otherwise + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-fs-is-file.xml b/reference/svn/functions/svn-fs-is-file.xml new file mode 100644 index 0000000000..389313ff26 --- /dev/null +++ b/reference/svn/functions/svn-fs-is-file.xml @@ -0,0 +1,156 @@ + + + + + svn_fs_is_file + Return true if the path points to a file, false otherwise + + + + &reftitle.description; + + boolsvn_fs_is_file + resourceroot + stringpath + + &warn.undocumented.func; + + Return true if the path points to a file, false otherwise + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-fs-make-dir.xml b/reference/svn/functions/svn-fs-make-dir.xml new file mode 100644 index 0000000000..2364dbcc84 --- /dev/null +++ b/reference/svn/functions/svn-fs-make-dir.xml @@ -0,0 +1,156 @@ + + + + + svn_fs_make_dir + Creates a new empty directory, returns true if all is ok, false otherwise + + + + &reftitle.description; + + boolsvn_fs_make_dir + resourceroot + stringpath + + &warn.undocumented.func; + + Creates a new empty directory, returns true if all is ok, false otherwise + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-fs-make-file.xml b/reference/svn/functions/svn-fs-make-file.xml new file mode 100644 index 0000000000..e3a12be947 --- /dev/null +++ b/reference/svn/functions/svn-fs-make-file.xml @@ -0,0 +1,156 @@ + + + + + svn_fs_make_file + Creates a new empty file, returns true if all is ok, false otherwise + + + + &reftitle.description; + + boolsvn_fs_make_file + resourceroot + stringpath + + &warn.undocumented.func; + + Creates a new empty file, returns true if all is ok, false otherwise + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-fs-node-created-rev.xml b/reference/svn/functions/svn-fs-node-created-rev.xml new file mode 100644 index 0000000000..ed1901009e --- /dev/null +++ b/reference/svn/functions/svn-fs-node-created-rev.xml @@ -0,0 +1,156 @@ + + + + + svn_fs_node_created_rev + Returns the revision in which path under fsroot was created + + + + &reftitle.description; + + intsvn_fs_node_created_rev + resourcefsroot + stringpath + + &warn.undocumented.func; + + Returns the revision in which path under fsroot was created + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-fs-node-prop.xml b/reference/svn/functions/svn-fs-node-prop.xml new file mode 100644 index 0000000000..616e0ef18e --- /dev/null +++ b/reference/svn/functions/svn-fs-node-prop.xml @@ -0,0 +1,165 @@ + + + + + svn_fs_node_prop + Returns the value of a property for a node + + + + &reftitle.description; + + intsvn_fs_node_prop + resourcefsroot + stringpath + stringpropname + + &warn.undocumented.func; + + Returns the value of a property for a node + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-fs-props-changed.xml b/reference/svn/functions/svn-fs-props-changed.xml new file mode 100644 index 0000000000..bcf68066a0 --- /dev/null +++ b/reference/svn/functions/svn-fs-props-changed.xml @@ -0,0 +1,174 @@ + + + + + svn_fs_props_changed + Return true if props are different, false otherwise + + + + &reftitle.description; + + boolsvn_fs_props_changed + resourceroot1 + stringpath1 + resourceroot2 + stringpath2 + + &warn.undocumented.func; + + Return true if props are different, false otherwise + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-fs-revision-prop.xml b/reference/svn/functions/svn-fs-revision-prop.xml new file mode 100644 index 0000000000..ad4b0816c3 --- /dev/null +++ b/reference/svn/functions/svn-fs-revision-prop.xml @@ -0,0 +1,165 @@ + + + + + svn_fs_revision_prop + Fetches the value of a named property + + + + &reftitle.description; + + stringsvn_fs_revision_prop + resourcefs + intrevnum + stringpropname + + &warn.undocumented.func; + + Fetches the value of a named property + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-fs-revision-root.xml b/reference/svn/functions/svn-fs-revision-root.xml new file mode 100644 index 0000000000..b84a82ecc1 --- /dev/null +++ b/reference/svn/functions/svn-fs-revision-root.xml @@ -0,0 +1,156 @@ + + + + + svn_fs_revision_root + Get a handle on a specific version of the repository root + + + + &reftitle.description; + + resourcesvn_fs_revision_root + resourcefs + intrevnum + + &warn.undocumented.func; + + Get a handle on a specific version of the repository root + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-fs-txn-root.xml b/reference/svn/functions/svn-fs-txn-root.xml new file mode 100644 index 0000000000..b1bf4cb6a5 --- /dev/null +++ b/reference/svn/functions/svn-fs-txn-root.xml @@ -0,0 +1,147 @@ + + + + + svn_fs_txn_root + Creates and returns a transaction root + + + + &reftitle.description; + + resourcesvn_fs_txn_root + resourcetxn + + &warn.undocumented.func; + + Creates and returns a transaction root + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-fs-youngest-rev.xml b/reference/svn/functions/svn-fs-youngest-rev.xml new file mode 100644 index 0000000000..c1f149516c --- /dev/null +++ b/reference/svn/functions/svn-fs-youngest-rev.xml @@ -0,0 +1,147 @@ + + + + + svn_fs_youngest_rev + Returns the number of the youngest revision in the filesystem + + + + &reftitle.description; + + intsvn_fs_youngest_rev + resourcefs + + &warn.undocumented.func; + + Returns the number of the youngest revision in the filesystem + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-import.xml b/reference/svn/functions/svn-import.xml new file mode 100644 index 0000000000..cfd0d5d369 --- /dev/null +++ b/reference/svn/functions/svn-import.xml @@ -0,0 +1,155 @@ + + + + + svn_import + Imports an unversioned path into a repository + + + + &reftitle.description; + + boolsvn_import + stringpath + stringurl + boolnonrecursive + + + Commits unversioned path into repository at + url. If path is a + directory and nonrecursive is &false;, + the directory will be imported recursively. + + + + + &reftitle.parameters; + + + + path + + + Path of file or directory to import. + + &svn.relativepath; + + + + url + + + Repository URL to import into. + + + + + nonrecursive + + + Whether or not to refrain from recursively processing directories. + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + &reftitle.examples; + + + Basic example + + This example demonstrates a basic use-case of this function. To import + a directory named new-files into the repository at + http://www.example.com/svnroot/incoming/abc, use: + + + +]]> + + + + + + + &reftitle.seealso; + + + svn_add + SVN documentation for svn import + + + + + + + diff --git a/reference/svn/functions/svn-log.xml b/reference/svn/functions/svn-log.xml new file mode 100644 index 0000000000..7de94d4fc8 --- /dev/null +++ b/reference/svn/functions/svn-log.xml @@ -0,0 +1,283 @@ + + + + + svn_log + Returns the commit log messages of a repository URL + + + + &reftitle.description; + + arraysvn_log + stringrepos_url + intrevision_no + + + svn_log returns the complete history of the item at the repository URL + repos_url, or the history of a specific revision + if revision_no is set. This function is equivalent + to svn log --verbose -r $revision_no $repos_url. + + + + For repositories with large histories, the output may + be quite large (one array item for every revision of the item). + This function does not support the + --limit NUM flag, nor does it support revision + ranges (revision_no must be an integer). + + + + + + &reftitle.parameters; + + + + repos_url + + + Repository URL of the item to retrieve log history from. + + + + + revision_no + + + Revision number of the log to retrieve. Use + SVN_REVISON_HEAD to retrieve the log for + the most recent revision. + + + + + + + + + &reftitle.returnvalues; + + On success, this function returns an array file listing in the format + of: + + Array, ordered most recent (highest) revision first +( + [rev] => integer revision number + [author] => string author name + [msg] => string log message + [date] => string date formatted per ISO 8601, i.e. date('c') + [paths] => Array, describing changed files + ( + [0] => Array + ( + [action] => string letter signifying change + [path] => absolute repository path of changed file + ) + [1] => ... + ) +) +[1] => ... +]]> + + + + + The output will always be a numerically indexed array of arrays, + even when there are none or only one log message(s). + + + + The value of action is a subset of the + status output + in the first column, where possible values are: + + + Actions + + + + Letter + Description + + + + + M + Item/props was modified + + + A + Item was added + + + D + Item was deleted + + + R + Item was replaced + + + +
+ + If no changes were made to the item, an empty array is returned. + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + &reftitle.examples; + + + <function>svn_log</function> example + + +]]> + + &example.outputs.similar; + + Array + ( + [rev] => 23 + [author] => 'joe' + [msg] => 'Add cheese and salami to our sandwich.' + [date] => '2007-04-06T16:00:27-04:00' + [paths] => Array + ( + [0] => Array + ( + [action] => 'M' + [path] => '/sandwich.txt' + ) + ) + ) +) +]]> + + + + + + Simulating <userinput>--limit</userinput> with <userinput>svn</userinput> and <function>svn_log</function> + + This sample function simulates the --limit switch + by using the SVN executable to return a list of revisions, which + are then losslessly accessed using svn_log. + + + + This function will perform a total of limit + 1 + requests: the first request to pull the required revisions, and + each one after to retrieve the log item for that request. + + + + +]]> + + + + + + + &reftitle.seealso; + + + + + SVN documentation on svn log + + + + + + + + + diff --git a/reference/svn/functions/svn-ls.xml b/reference/svn/functions/svn-ls.xml new file mode 100644 index 0000000000..45d369a036 --- /dev/null +++ b/reference/svn/functions/svn-ls.xml @@ -0,0 +1,158 @@ + + + + + svn_ls + Returns list of directory contents in repository URL, optionally at revision number + + + &reftitle.description; + + arraysvn_ls + stringrepos_url + intrevision_no + + + This function queries the repository URL and returns a list of + files and directories, optionally from a specific revision. This + is equivalent to svn list $repos_url[@$revision_no] + + + + This function does not work with working copies. repos_url + must be a repository URL. + + + + + + &reftitle.parameters; + + + + url + + + URL of the repository, eg. http://www.example.com/svnroot. + To access a local Subversion repository via filesystem, use the + file URI scheme, eg. file:///home/user/svn-repos + + + + + revision + + + Integer revision number to retrieve listing of. When omitted, + the HEAD revision is used. + + + + + + + + &reftitle.returnvalues; + + On success, this function returns an array file listing in the format + of: + + Array + ( + [created_rev] => integer revision number of last edit + [last_author] => string author name of last edit + [size] => integer byte file size of file + [time] => string date of last edit in form 'M d H:i' + or 'M d Y', depending on how old the file is + [time_t] => integer unix timestamp of last edit + [name] => name of file/directory + [type] => type, can be 'file' or 'dir' + ) +[1] => ... +]]> + + + + + + &reftitle.notes; + &warn.experimental.func; + + + + &reftitle.examples; + + + <function>svn_ls</function> example + + +]]> + + &example.outputs.similar; + + Array + ( + [created_rev] => 20 + [last_author] => Joe + [size] => 0 + [time] => Apr 02 09:28 + [time_t] => 1175520529 + [name] => tags + [type] => dir + ) + [1] => Array + ( + [created_rev] => 23 + [last_author] => Bob + [size] => 0 + [time] => Apr 02 15:15 + [time_t] => 1175541322 + [name] => trunk + [type] => dir + ) +) +]]> + + + + + + + &reftitle.seealso; + + + + SVN documentation on svn list + + + + + + + diff --git a/reference/svn/functions/svn-repos-create.xml b/reference/svn/functions/svn-repos-create.xml new file mode 100644 index 0000000000..a3839e4668 --- /dev/null +++ b/reference/svn/functions/svn-repos-create.xml @@ -0,0 +1,165 @@ + + + + + svn_repos_create + Create a new subversion repository at path + + + + &reftitle.description; + + resourcesvn_repos_create + stringpath + arrayconfig + arrayfsconfig + + &warn.undocumented.func; + + Create a new subversion repository at path + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-repos-fs-begin-txn-for-commit.xml b/reference/svn/functions/svn-repos-fs-begin-txn-for-commit.xml new file mode 100644 index 0000000000..9f17c558da --- /dev/null +++ b/reference/svn/functions/svn-repos-fs-begin-txn-for-commit.xml @@ -0,0 +1,174 @@ + + + + + svn_repos_fs_begin_txn_for_commit + Create a new transaction + + + + &reftitle.description; + + resourcesvn_repos_fs_begin_txn_for_commit + resourcerepos + intrev + stringauthor + stringlog_msg + + &warn.undocumented.func; + + Create a new transaction + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-repos-fs-commit-txn.xml b/reference/svn/functions/svn-repos-fs-commit-txn.xml new file mode 100644 index 0000000000..09a0c40889 --- /dev/null +++ b/reference/svn/functions/svn-repos-fs-commit-txn.xml @@ -0,0 +1,147 @@ + + + + + svn_repos_fs_commit_txn + Commits a transaction and returns the new revision + + + + &reftitle.description; + + intsvn_repos_fs_commit_txn + resourcetxn + + &warn.undocumented.func; + + Commits a transaction and returns the new revision + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-repos-fs.xml b/reference/svn/functions/svn-repos-fs.xml new file mode 100644 index 0000000000..9b7df5bf0e --- /dev/null +++ b/reference/svn/functions/svn-repos-fs.xml @@ -0,0 +1,147 @@ + + + + + svn_repos_fs + Gets a handle on the filesystem for a repository + + + + &reftitle.description; + + resourcesvn_repos_fs + resourcerepos + + &warn.undocumented.func; + + Gets a handle on the filesystem for a repository + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-repos-hotcopy.xml b/reference/svn/functions/svn-repos-hotcopy.xml new file mode 100644 index 0000000000..9402d92204 --- /dev/null +++ b/reference/svn/functions/svn-repos-hotcopy.xml @@ -0,0 +1,165 @@ + + + + + svn_repos_hotcopy + Make a hot-copy of the repos at repospath; copy it to destpath + + + + &reftitle.description; + + boolsvn_repos_hotcopy + stringrepospath + stringdestpath + boolcleanlogs + + &warn.undocumented.func; + + Make a hot-copy of the repos at repospath; copy it to destpath + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-repos-open.xml b/reference/svn/functions/svn-repos-open.xml new file mode 100644 index 0000000000..ac9f330632 --- /dev/null +++ b/reference/svn/functions/svn-repos-open.xml @@ -0,0 +1,147 @@ + + + + + svn_repos_open + Open a shared lock on a repository. + + + + &reftitle.description; + + resourcesvn_repos_open + stringpath + + &warn.undocumented.func; + + Open a shared lock on a repository. + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-repos-recover.xml b/reference/svn/functions/svn-repos-recover.xml new file mode 100644 index 0000000000..8387f17e38 --- /dev/null +++ b/reference/svn/functions/svn-repos-recover.xml @@ -0,0 +1,147 @@ + + + + + svn_repos_recover + Run recovery procedures on the repository located at path. + + + + &reftitle.description; + + boolsvn_repos_recover + stringpath + + &warn.undocumented.func; + + Run recovery procedures on the repository located at path. + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + + + + + + diff --git a/reference/svn/functions/svn-status.xml b/reference/svn/functions/svn-status.xml new file mode 100644 index 0000000000..b4f185f568 --- /dev/null +++ b/reference/svn/functions/svn-status.xml @@ -0,0 +1,432 @@ + + + + + svn_status + Returns the status of working copy files and directories + + + + &reftitle.description; + + arraysvn_status + stringpath + boolrecursive + boolget_all + boolupdate + boolno_ignore + + + Returns the status of working copy files and directories, giving modifications, + additions, deletions and other changes to items in the working copy. + + + + + &reftitle.parameters; + + + + path + + + Local path to file or directory to retrieve status of. + + &svn.relativepath; + + + + recursive + + + Whether or not to recursively descend into directories to + retrieve status. Default is &true;. + + + + + get_all + + + Whether or not to return all items, regardless of modification + status. Default is &false;. + + + + + update + + + Whether or not to return information from the server on + whether or not the working copy is up-to-date (specifically, + entries will be added for items that are out-of-date along with + the regular modification checks). Default is &false;. + + + + + no_ignore + + + Whether or not to disregard svn:ignore properties when scanning + for new files. Default is &false;. + + + + + + + + + &reftitle.returnvalues; + + Returns a numerically indexed array of associative arrays detailing + the status of items in the repository: + + + Array ( + // information on item + ) + [1] => ... +) +]]> + + + The information on the item is an associative array that can contain + the following keys: + + + + path + + + String path to file/directory of this entry on local filesystem. + + + + + text_status + + + Status of item's text. &svn.referto.status; + + + + + repos_text_status + + + Status of item's text in repository. Only accurate if + update was set to &true;. + &svn.referto.status; + + + + + prop_status + + + Status of item's properties. &svn.referto.status; + + + + + repos_prop_status + + + Status of item's property in repository. Only accurate if + update was set to &true;. &svn.referto.status; + + + + + locked + + + Whether or not the item is locked. (Only set if &true;.) + + + + + copied + + + Whether or not the item was copied (scheduled for addition with + history). (Only set if &true;.) + + + + + switched + + + Whether or not the item was switched using the switch command. + (Only set if &true;) + + + + + + These keys are only set if the item is versioned: + + + + name + + + Base name of item in repository. + + + + + url + + + URL of item in repository. + + + + + repos + + + Base URL of repository. + + + + + revision + + + Integer revision of item in working copy. + + + + + kind + + + Type of item, i.e. file or directory. &svn.referto.type; + + + + + schedule + + + Scheduled action for item, i.e. addition or deletion. Constants + for these magic numbers are not available, they can + be emulated by using: + + + +]]> + + + + + deleted + + + Whether or not the item was deleted, but parent revision lags + behind. (Only set if &true;.) + + + + + absent + + + Whether or not the item is absent, that is, Subversion knows that + there should be something there but there isn't. (Only set if + &true;.) + + + + + incomplete + + + Whether or not the entries file for a directory is incomplete. + (Only set if &true;.) + + + + + cmt_date + + + Integer Unix timestamp of last commit date. (Unaffected by update.) + + + + + cmt_rev + + + Integer revision of last commit. (Unaffected by update.) + + + + + cmt_author + + + String author of last commit. (Unaffected by update.) + + + + + prop_time + + + Integer Unix timestamp of last up-to-date time for properties + + + + + text_time + + + Integer Unix timestamp of last up-to-date time for text + + + + + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + &reftitle.examples; + + + Basic example + + This example demonstrates a basic, theoretical usage of this function. + + + +]]> + + &example.outputs.similar; + + Array ( + [path] => /home/bob/wc/sandwich.txt + [text_status] => 8 // item was modified + [repos_text_status] => 1 // no information available, use update + [prop_status] => 3 // no changes + [repos_prop_status] => 1 // no information available, use update + [name] => sandwich.txt + [url] => http://www.example.com/svnroot/deli/trunk/sandwich.txt + [repos] => http://www.example.com/svnroot/ + [revision] => 123 + [kind] => 1 // file + [schedule] => 0 // no special actions scheduled + [cmt_date] => 1165543135 + [cmt_rev] => 120 + [cmt_author] => Alice + [prop_time] => 1180201728 + [text_time] => 1180201729 + ) +) +]]> + + + + + + + &reftitle.seealso; + + + svn_update + svn_log + SVN documentation for svn status + + + + + + + diff --git a/reference/svn/functions/svn-update.xml b/reference/svn/functions/svn-update.xml new file mode 100644 index 0000000000..c4d2f42e0a --- /dev/null +++ b/reference/svn/functions/svn-update.xml @@ -0,0 +1,159 @@ + + + + + svn_update + Update working copy + + + + &reftitle.description; + + intsvn_update + stringpath + intrevno + boolrecurse + + + Update working copy at path to revision + revno. If recurse is true, + directories will be recursively updated. + + + + + &reftitle.parameters; + + + + path + + + Path to local working copy. + + &svn.relativepath; + + + + revno + + + Revision number to update to, default is SVN_REVISION_HEAD. + + + + + recurse + + + Whether or not to recursively update directories, default is &true;. + + + + + + + + + &reftitle.returnvalues; + + Returns new revision number on success, returns &false; on failure. + + + + + &reftitle.notes; + &warn.experimental.func; + + + + + + + + &reftitle.examples; + + + Basic example + + This example demonstrates basic usage of this function: + + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + svn_checkout + svn_commit + SVN documentation for svn update + + + + + + + diff --git a/reference/svn/reference.xml b/reference/svn/reference.xml new file mode 100644 index 0000000000..741807f574 --- /dev/null +++ b/reference/svn/reference.xml @@ -0,0 +1,65 @@ + + + + + + + Subversion &Functions; + SVN + +
+ &reftitle.intro; + &warn.experimental; + + This extension implements PHP bindings for + Subversion (SVN), a version + control system, allowing PHP scripts to communicate with SVN repositories + and working copies without direct command line calls to the + svn + executable. + +
+
+ &reftitle.required; + + The Subversion binaries are not necessary to use this + extension. However, when compiling the extension, libsvn + (the Subversion headers) must be available. + +
+ &reference.svn.configure; +
+ &reftitle.resources; + + Subversion's lower-level svn_fs_* functions make use of resources + that reference local file-system repositories. They can probably be + created using svn_repos_fs and + svn_fs_revision_root. (verify?) + + &no.resource; +
+ &reference.svn.constants; + + &reference.svn.functions; + + +