* subversion/libsvn_client/client.h
(svn_client__arbitrary_nodes_diff): Document better.
@@ -1112,14 +1112,34 @@ svn_client__resolve_conflicts(svn_boolean_t *conflicts_remain,
svn_client_ctx_t *ctx,
apr_pool_t *scratch_pool);
-/* Produce a diff with depth DEPTH between two files or two directories at
- * LEFT_ABSPATH1 and RIGHT_ABSPATH, using the provided diff callbacks to
- * show changes in files. The files and directories involved may be part of
- * a working copy or they may be unversioned. For versioned files, show
- * property changes, too.
+/* Produce a diff with depth DEPTH between the file or directory at
+ * LEFT_ABSPATH and the file or directory at RIGHT_ABSPATH, reporting
+ * differences to DIFF_PROCESSOR.
*
- * If ANCHOR_ABSPATH is not null, set it to the anchor of the diff before
- * the first processor call. (The anchor is LEFT_ABSPATH or an ancestor of it)
+ * The files and directories involved may be part of a working copy or
+ * they may be unversioned. For versioned files, show property changes,
+ * too.
+ *
+ * No copy or move information is reported to the diff processor.
+ *
+ * If both LEFT_ABSPATH and RIGHT_ABSPATH are directories on disk:
+ * set *ROOT_RELPATH to "" and
+ * set *ROOT_IS_DIR to TRUE and
+ * send diff processor relpaths relative to LEFT_ABSPATH
+ * (which is the same as relative to RIGHT_ABSPATH);
+ * else:
+ * set *ROOT_RELPATH to the basename of LEFT_ABSPATH and
+ * set *ROOT_IS_DIR to FALSE and
+ * send diff processor relpaths relative to the parent of LEFT_ABSPATH
+ * (so they all start with a basename(LEFT_ABSPATH) component).
+ *
+ * As any children reached by recursion are matched by name, a diff
+ * processor relpath applies equally to both sides of the diff, except
+ * for its first component in the latter case above.
+ *
+ * Assignments to *ROOT_RELPATH and *ROOT_IS_DIR are made before the first
+ * call to DIFF_PROCESSOR. Each of ROOT_RELPATH and ROOT_IS_DIR may be NULL
+ * if not wanted.
*/
svn_error_t *
svn_client__arbitrary_nodes_diff(const char **root_relpath,
