[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

[PATCH] svn_client_copy/move doc string additions

From: Julian Foad <julianfoad_at_btopenworld.com>
Date: 2005-11-17 02:11:34 CET

Does this doc string addition say the right thing?

- Julian

Add important details to doc strings for svn_client_copy/move.

* subversion/include/svn_client.h
  (svn_client_copy): Mention other aspects of its behaviour.
  (svn_client_move): Mention other aspects of its behaviour. Fix typos.

Index: subversion/include/svn_client.h
===================================================================
--- subversion/include/svn_client.h (revision 17263)
+++ subversion/include/svn_client.h (working copy)
@@ -1682,6 +1682,13 @@ svn_client_resolved (const char *path,
  * until a commit occurs. This scheduling can be removed with
  * svn_client_revert().
  *
+ * Attempt to create any parent directories for @a dst_path that do not exist.
+ *
+ * If @a dst_path already exists and is a directory, copy the item into that
+ * directory, keeping its name (the last component of @a src_path),
+ * otherwise copy the item to the new path and name @a dst_path.
+ * If @a dst_path already exists and is not a directory, fail.
+ *
  * @a ctx->log_msg_func/@a ctx->log_msg_baton are a callback/baton combo that
  * this function can use to query for a commit log message when one is
  * needed.
@@ -1741,13 +1748,20 @@ svn_client_copy (svn_client_commit_info_
  * repository until a commit occurs. This scheduling can be removed
  * with svn_client_revert(). If @a src_path is a file it is removed
  * from the working copy immediately. If @a src_path is a directory it
- * will remain n the working copy but all the files, and unversioned
+ * will remain in the working copy but all the files, and unversioned
  * items, it contains will be removed.
  *
  * - If @a src_path contains locally modified and/or unversioned items
- * and @a force is not set, the copy will fail. If @a force is set such
+ * and @a force is not set, the move will fail. If @a force is set such
  * items will be removed.
  *
+ * Attempt to create any parent directories for @a dst_path that do not exist.
+ *
+ * If @a dst_path already exists and is a directory, move the item into that
+ * directory, keeping its name (the last component of @a src_path),
+ * otherwise move the item to the new path and name @a dst_path.
+ * If @a dst_path already exists and is not a directory, fail.
+ *
  * @a ctx->log_msg_func/@a ctx->log_msg_baton are a callback/baton combo that
  * this function can use to query for a commit log message when one is needed.
  *

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Thu Nov 17 02:12:39 2005

This is an archived mail posted to the Subversion Dev mailing list.