Author: julianfoad
Date: Mon Nov 26 19:08:07 2012
New Revision: 1413783
URL: http://svn.apache.org/viewvc?rev=1413783&view=rev
Log:
* subversion/include/svn_delta.h
(svn_delta_path_driver_cb_func_t, svn_delta_path_driver2): Clarify doc
strings: specify that each path is relative to the root path of the edit.
Modified:
subversion/trunk/subversion/include/svn_delta.h
Modified: subversion/trunk/subversion/include/svn_delta.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_delta.h?rev=1413783&r1=1413782&r2=1413783&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_delta.h (original)
+++ subversion/trunk/subversion/include/svn_delta.h Mon Nov 26 19:08:07 2012
@@ -1290,7 +1290,8 @@ svn_delta_depth_filter_editor(const svn_
/** Callback function type for svn_delta_path_driver().
*
* The handler of this callback is given the callback baton @a
- * callback_baton, @a path, and the @a parent_baton which represents
+ * callback_baton, @a path which is a relpath relative to the
+ * root of the edit, and the @a parent_baton which represents
* path's parent directory as created by the editor passed to
* svn_delta_path_driver().
*
@@ -1321,7 +1322,8 @@ typedef svn_error_t *(*svn_delta_path_dr
* @a callback_func and @a callback_baton to allow the caller to handle
* the portion of the editor drive related to that path.
*
- * Each path in @a paths is a const char *. The editor drive will be
+ * Each path in @a paths is a (const char *) relpath, relative
+ * to the root path of the @a edit. The editor drive will be
* performed in the same order as @a paths. The paths should be sorted
* using something like svn_sort_compare_paths to ensure that a depth-first
* pattern is observed for directory/file baton creation. If @a sort_paths
