Author: gstein
Date: Fri May 18 19:57:25 2012
New Revision: 1340226
URL: http://svn.apache.org/viewvc?rev=1340226&view=rev
Log:
Clarify a docstring.
* subversion/include/svn_fs.h:
(svn_fs_closest_copy): it was unclear that non-NULL meant that
values were returned; it may have also applied to the OUT param
values or to pool itself. Fact is: all params must be non-NULL.
Tweak the docstring for clarity.
Modified:
subversion/trunk/subversion/include/svn_fs.h
Modified: subversion/trunk/subversion/include/svn_fs.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_fs.h?rev=1340226&r1=1340225&r2=1340226&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_fs.h (original)
+++ subversion/trunk/subversion/include/svn_fs.h Fri May 18 19:57:25 2012
@@ -1639,7 +1639,6 @@ svn_fs_copied_from(svn_revnum_t *rev_p,
/** Set @a *root_p and @a *path_p to the revision root and path of the
* destination of the most recent copy event that caused @a path to
* exist where it does in @a root, or to NULL if no such copy exists.
- * When non-NULL, allocate @a *root_p and @a *path_p in @a pool.
*
* @a *path_p might be a parent of @a path, rather than @a path
* itself. However, it will always be the deepest relevant path.
@@ -1647,6 +1646,9 @@ svn_fs_copied_from(svn_revnum_t *rev_p,
* this function makes sure to set @a *path_p to the longest copy
* destination path that is still a parent of or equal to @a path.
*
+ * Values returned in @a *root_p and @a *path_p will be allocated
+ * from @a pool.
+ *
* @since New in 1.3.
*/
svn_error_t *
