You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@subversion.apache.org by ju...@apache.org on 2012/12/06 21:33:28 UTC

svn commit: r1418057 - /subversion/trunk/subversion/include/private/svn_wc_private.h

Author: julianfoad
Date: Thu Dec  6 20:33:27 2012
New Revision: 1418057

URL: http://svn.apache.org/viewvc?rev=1418057&view=rev
Log:
* subversion/include/private/svn_wc_private.h
  (svn_wc__get_diff_editor): Add a diagram showing how to use this function.

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

Modified: subversion/trunk/subversion/include/private/svn_wc_private.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/private/svn_wc_private.h?rev=1418057&r1=1418056&r2=1418057&view=diff
==============================================================================
--- subversion/trunk/subversion/include/private/svn_wc_private.h (original)
+++ subversion/trunk/subversion/include/private/svn_wc_private.h Thu Dec  6 20:33:27 2012
@@ -1629,6 +1629,25 @@ svn_wc__get_switch_editor(const svn_delt
  * the ambient depth filtering, so this doesn't have to be handled in the
  * editor.
  *
+ *
+ * A diagram illustrating how this function is used.
+ *
+ *   Steps 1 and 2 create the chain; step 3 drives it.
+ *
+ *   1.                    svn_wc__get_diff_editor(diff_cbs)
+ *                                       |           ^
+ *   2.         svn_ra_do_diff3(editor)  |           |
+ *                    |           ^      |           |
+ *                    v           |      v           |
+ *           +----------+       +----------+       +----------+
+ *           |          |       |          |       |          |
+ *      +--> | reporter | ----> |  editor  | ----> | diff_cbs | ----> text
+ *      |    |          |       |          |       |          |       out
+ *      |    +----------+       +----------+       +----------+
+ *      |
+ *   3. svn_wc_crawl_revisions5(WC,reporter)
+ *
+ *
  * @since New in 1.8.
  */
 svn_error_t *