svn commit: r1574450 - /subversion/trunk/subversion/tests/libsvn_repos/dir-delta-editor.h

[ju...@apache.org]

Author: julianfoad
Date: Wed Mar  5 12:10:47 2014
New Revision: 1574450

URL: http://svn.apache.org/r1574450
Log:
* subversion/tests/libsvn_repos/dir-delta-editor.h
  (dir_delta_get_editor): Add a doc string.

Modified:
    subversion/trunk/subversion/tests/libsvn_repos/dir-delta-editor.h

Modified: subversion/trunk/subversion/tests/libsvn_repos/dir-delta-editor.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/tests/libsvn_repos/dir-delta-editor.h?rev=1574450&r1=1574449&r2=1574450&view=diff
==============================================================================
--- subversion/trunk/subversion/tests/libsvn_repos/dir-delta-editor.h (original)
+++ subversion/trunk/subversion/tests/libsvn_repos/dir-delta-editor.h Wed Mar  5 12:10:47 2014
@@ -40,7 +40,18 @@
 extern "C" {
 #endif /* __cplusplus */
 
-
+
+/* Get an editor that will edit an FS transaction via the libsvn_fs API.
+ *
+ * Set *EDITOR and *EDIT_BATON to a new editor that edits the subtree at
+ * PATH of the existing, open transaction TXN_ROOT in filesystem FS.
+ *
+ * Note: Related but more complex functions in the regular API include
+ * svn_fs__editor_create_for() and svn_repos_get_commit_editor*().
+ *
+ * Note: The only connection with dir-deltas is that a test for dir-deltas
+ * was the first user of this editor.
+ */
 svn_error_t *
 dir_delta_get_editor(const svn_delta_editor_t **editor,
                      void **edit_baton,