Author: gbg
Date: Tue May 21 08:24:04 2013
New Revision: 1484692
URL: http://svn.apache.org/r1484692
Log:
On the invoke-diff-cmd branch: Fix mistakes and formatting in doc
string.
* subversion/include/svn_client.h
(svn_client_diff_peg6): Fix doc string.
Modified:
subversion/branches/invoke-diff-cmd-feature/subversion/include/svn_client.h
subversion/branches/invoke-diff-cmd-feature/subversion/include/svn_io.h
Modified:
subversion/branches/invoke-diff-cmd-feature/subversion/include/svn_client.h
URL:
http://svn.apache.org/viewvc/subversion/branches/invoke-diff-cmd-feature/subversion/include/svn_client.h?rev=1484692&r1=1484691&r2=1484692&view=diff
==============================================================================
--- subversion/branches/invoke-diff-cmd-feature/subversion/include/svn_client.h
(original)
+++ subversion/branches/invoke-diff-cmd-feature/subversion/include/svn_client.h
Tue May 21 08:24:04 2013
@@ -3242,12 +3242,13 @@ svn_client_diff_peg7(const apr_array_hea
apr_pool_t *pool);
-/** Similar to svn_client_peg5(), but with @a no_diff_added set to
- * FALSE, @a ignore_properties set to FALSE and @a properties_only
- * set to FALSE.
+/**
+ * Similar to svn_client_peg7(), but with @a no_diff_added set to
+ * FALSE, @a ignore_properties set to FALSE and @a properties_only
+ * set to FALSE.
*
* @deprecated Provided for backward compatibility with the 1.7 API.
- * @since New in 1.9.
+ * @since New in 1.8.
*/
SVN_DEPRECATED
svn_error_t *
@@ -3273,7 +3274,8 @@ svn_client_diff_peg6(const apr_array_hea
svn_client_ctx_t *ctx,
apr_pool_t *pool);
-/** Similar to svn_client_diff6_peg6(), but with @a outfile and @a errfile,
+/**
+ * Similar to svn_client_diff6_peg6(), but with @a outfile and @a errfile,
* instead of @a outstream and @a errstream, and with @a
* no_diff_added, @a ignore_properties, and @a properties_only always
* passed as @c FALSE (which means that additions and property changes
Modified:
subversion/branches/invoke-diff-cmd-feature/subversion/include/svn_io.h
URL:
http://svn.apache.org/viewvc/subversion/branches/invoke-diff-cmd-feature/subversion/include/svn_io.h?rev=1484692&r1=1484691&r2=1484692&view=diff
==============================================================================
--- subversion/branches/invoke-diff-cmd-feature/subversion/include/svn_io.h
(original)
+++ subversion/branches/invoke-diff-cmd-feature/subversion/include/svn_io.h Tue
May 21 08:24:04 2013
@@ -2279,8 +2279,37 @@ svn_io_file_readline(apr_file_t *file,
/** @} */
/** Parse a user defined command to contain dynamically created labels
- * and filenames.
- *
+ * and filenames. This function serves both diff and diff3 parsing
+ * requirements.
+ *
+ * When used in a diff context: (responding parse tokens in braces)
+ *
+ * @a label1 (%l1%) refers to the label of @a tmpfile1 (%f1) which is
+ * the pristine copy.
+ *
+ * @a label2 (%l2%) refers to the label of @a tmpfile2 (%f2%) which
+ * is the altered copy.
+ *
+ * When used in a diff3 context:
+ *
+ * @a label1 refers to the label of @a tmpfile1 which is the 'mine'
+ * copy.
+ *
+ * @a label2 refers to the label of @a tmpfile2 which is the 'older'
+ * copy.
+ *
+ * @a label3 (%l3%) refers to the label of @a base (%f3%) which is
+ * the 'base' copy.
+ *
+ * In general:
+ *
+ * @a cmd is a user defined string containing 0 or more parse tokens
+ * which are expanded by the required labels and filenames.
+ *
+ * @a scratch_pool is used for temporary allocations.
+ *
+ * @return A NULL-terminated character array.
+ *
* @since New in 1.9.
*/
const char **
