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

Author: rinrab
Date: Sun Oct 27 20:28:54 2024
New Revision: 1921607

URL: http://svn.apache.org/viewvc?rev=1921607&view=rev
Log:
Update docstring of the svn_client__get_diff_writer_svn function with adding
the explanation for the ddi_p argument.

* subversion/include/private/svn_client_private.h
  (svn_client__get_diff_writer_svn): Explain what does ddi_p argument do.

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=1921607&r1=1921606&r2=1921607&view=diff
==============================================================================
--- subversion/trunk/subversion/include/private/svn_client_private.h (original)
+++ subversion/trunk/subversion/include/private/svn_client_private.h Sun Oct 27 20:28:54 2024
@@ -348,6 +348,10 @@ svn_client__mergeinfo_log(svn_boolean_t
 /** Return a diff processor that will print a diff in Subversion-style
  *  or git-style, based on @a use_git_diff_format value.
  *
+ * @a ddi_p will be initialized with a svn_client__diff_driver_info_t,
+ * which should describe some settings of the diff writer. It can be modified
+ * in future as required, and the writer should accept with them.
+ *
  * @a anchor is optional (may be null), and is the 'anchor' path to prefix
  * to the diff-processor paths before displaying.
  *