svn commit: r1303743 - /subversion/trunk/subversion/include/private/svn_client_private.h

[ju...@apache.org]

Author: julianfoad
Date: Thu Mar 22 12:15:01 2012
New Revision: 1303743

URL: http://svn.apache.org/viewvc?rev=1303743&view=rev
Log:
* subversion/include/private/svn_client_private.h
  (svn_client__do_symmetric_merge): Add a bit more documentation.

Modified:
    subversion/trunk/subversion/include/private/svn_client_private.h

Modified: subversion/trunk/subversion/include/private/svn_client_private.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/private/svn_client_private.h?rev=1303743&r1=1303742&r2=1303743&view=diff
==============================================================================
--- subversion/trunk/subversion/include/private/svn_client_private.h (original)
+++ subversion/trunk/subversion/include/private/svn_client_private.h Thu Mar 22 12:15:01 2012
@@ -134,6 +134,18 @@ svn_client__find_symmetric_merge(svn_cli
 /* Perform a symmetric merge.
  *
  * Merge according to MERGE into the WC at TARGET_WCPATH.
+ *
+ * The other parameters are as in svn_client_merge4().  IGNORE_ANCESTRY
+ * only controls the diffing of files, it doesn't prevent mergeinfo from
+ * being used.
+ *
+ * ### TODO: There's little point in this function being the only way the
+ * caller can use the result of svn_client__find_symmetric_merge().  The
+ * contents of MERGE should be more public, or there should be other ways
+ * the caller can use it, or these two functions should be combined into
+ * one.  I want to make it more public, and also possibly have more ways
+ * to use it in future (for example, do_symmetric_merge_with_step_by_-
+ * step_confirmation).
  */
 svn_error_t *
 svn_client__do_symmetric_merge(const svn_client__symmetric_merge_t *merge,