You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@subversion.apache.org by da...@apache.org on 2012/10/15 17:46:44 UTC

svn commit: r1398346 - /subversion/trunk/subversion/include/svn_io.h

Author: danielsh
Date: Mon Oct 15 15:46:44 2012
New Revision: 1398346

URL: http://svn.apache.org/viewvc?rev=1398346&view=rev
Log:
Clarify docstring.

* subversion/include/svn_io.h
  (svn_io_filesizes_three_different_p): 
    Clarify encoding requirement and error condition.

Modified:
    subversion/trunk/subversion/include/svn_io.h

Modified: subversion/trunk/subversion/include/svn_io.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_io.h?rev=1398346&r1=1398345&r2=1398346&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_io.h (original)
+++ subversion/trunk/subversion/include/svn_io.h Mon Oct 15 15:46:44 2012
@@ -610,13 +610,13 @@ svn_io_filesizes_different_p(svn_boolean
 /** Set @a *different_p12 to non-zero if @a file1 and @a file2 have different
  * sizes, else set to zero.  Do the similar for @a *different_p23 with
  * @a file2 and @a file3, and @a *different_p13 for @a file1 and @a file3.
- * All three of @a file1, @a file2 and @a file3 are utf8-encoded.
+ * The filenames @a file1, @a file2 and @a file3 are utf8-encoded.
  *
  * Setting @a *different_p12 to zero does not mean the files definitely
  * have the same size, it merely means that the sizes are not
  * definitely different.  That is, if the size of one or both files
- * cannot be determined, then the sizes are not known to be different,
- * so @a *different_p12 is set to 0.
+ * cannot be determined (due to stat() returning an error), then the sizes
+ * are not known to be different, so @a *different_p12 is set to 0.
  */
 svn_error_t *
 svn_io_filesizes_three_different_p(svn_boolean_t *different_p12,



Re: svn commit: r1398346 - /subversion/trunk/subversion/include/svn_io.h

Posted by Greg Stein <gs...@gmail.com>.
Seems like tristate outputs might be handy on this API.
On Oct 15, 2012 11:47 AM, <da...@apache.org> wrote:

> Author: danielsh
> Date: Mon Oct 15 15:46:44 2012
> New Revision: 1398346
>
> URL: http://svn.apache.org/viewvc?rev=1398346&view=rev
> Log:
> Clarify docstring.
>
> * subversion/include/svn_io.h
>   (svn_io_filesizes_three_different_p):
>     Clarify encoding requirement and error condition.
>
> Modified:
>     subversion/trunk/subversion/include/svn_io.h
>
> Modified: subversion/trunk/subversion/include/svn_io.h
> URL:
> http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_io.h?rev=1398346&r1=1398345&r2=1398346&view=diff
>
> ==============================================================================
> --- subversion/trunk/subversion/include/svn_io.h (original)
> +++ subversion/trunk/subversion/include/svn_io.h Mon Oct 15 15:46:44 2012
> @@ -610,13 +610,13 @@ svn_io_filesizes_different_p(svn_boolean
>  /** Set @a *different_p12 to non-zero if @a file1 and @a file2 have
> different
>   * sizes, else set to zero.  Do the similar for @a *different_p23 with
>   * @a file2 and @a file3, and @a *different_p13 for @a file1 and @a file3.
> - * All three of @a file1, @a file2 and @a file3 are utf8-encoded.
> + * The filenames @a file1, @a file2 and @a file3 are utf8-encoded.
>   *
>   * Setting @a *different_p12 to zero does not mean the files definitely
>   * have the same size, it merely means that the sizes are not
>   * definitely different.  That is, if the size of one or both files
> - * cannot be determined, then the sizes are not known to be different,
> - * so @a *different_p12 is set to 0.
> + * cannot be determined (due to stat() returning an error), then the sizes
> + * are not known to be different, so @a *different_p12 is set to 0.
>   */
>  svn_error_t *
>  svn_io_filesizes_three_different_p(svn_boolean_t *different_p12,
>
>
>