svn commit: r1582241 - in /subversion/trunk/subversion/include: svn_fs.h svn_repos.h

[ju...@apache.org]

Author: julianfoad
Date: Thu Mar 27 10:27:25 2014
New Revision: 1582241

URL: http://svn.apache.org/r1582241
Log:
Tweak doc strings.

* subversion/include/svn_fs.h
  (svn_fs_lock2, svn_fs_unlock2): Document result_pool and scratch_pool
    consistently.

* subversion/include/svn_repos.h
  (svn_repos_fs_lock2, svn_repos_fs_unlock2): Same.

Modified:
    subversion/trunk/subversion/include/svn_fs.h
    subversion/trunk/subversion/include/svn_repos.h

Modified: subversion/trunk/subversion/include/svn_fs.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_fs.h?rev=1582241&r1=1582240&r2=1582241&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_fs.h (original)
+++ subversion/trunk/subversion/include/svn_fs.h Thu Mar 27 10:27:25 2014
@@ -2502,7 +2502,7 @@ svn_fs_set_uuid(svn_fs_t *fs,
  * mainly due to the serialization for tokens for pre-commit hook.
  *
  * Locks are not secret; anyone can view existing locks in a
- * filesystem.  Locks are not omnipotent: they can broken and stolen
+ * filesystem.  Locks are not omnipotent: they can be broken and stolen
  * by people who don't "own" the lock.  (Though admins can tailor a
  * custom break/steal policy via libsvn_repos pre-lock hook script.)
  *
@@ -2538,8 +2538,7 @@ typedef struct svn_fs_lock_result_t
 } svn_fs_lock_result_t;
 
 /** Lock the paths in @a targets in @a fs, and set @a *results to the
- * locks or errors representing each new lock, allocated in @a
- * result_pool.
+ * locks or errors representing each new lock.
  *
  * @warning You may prefer to use svn_repos_fs_lock2() instead,
  * which see.
@@ -2586,6 +2585,9 @@ typedef struct svn_fs_lock_result_t
  * associated with each path is returned as #svn_fs_lock_result_t->lock,
  * this will be @c NULL if no lock was created.
  *
+ * Allocate @a *results in @a result_pool. Use @a scratch_pool for
+ * temporary allocations.
+ *
  * @note At this time, only files can be locked.
  *
  * @since New in 1.9.
@@ -2632,7 +2634,7 @@ svn_fs_generate_lock_token(const char **
 
 
 /** Remove the locks on the paths in @a targets in @a fs, and return
- * the results in @a *results allocated in @a result_pool.
+ * the results in @a *results.
  *
  * The paths to be unlocked are passed as <tt>const char *</tt> keys
  * of the @a targets hash with <tt>svn_fs_lock_target_t *</tt> values.
@@ -2663,7 +2665,8 @@ svn_fs_generate_lock_token(const char **
  * be returned (it is not possible to return @c SVN_NO_ERROR as a hash
  * value directly), #svn_fs_lock_result_t->lock is always NULL.
  *
- * Use @a scratch_pool for temporary allocations.
+ * Allocate @a *results in @a result_pool. Use @a scratch_pool for
+ * temporary allocations.
  *
  * @since New in 1.9.
  */

Modified: subversion/trunk/subversion/include/svn_repos.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_repos.h?rev=1582241&r1=1582240&r2=1582241&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_repos.h (original)
+++ subversion/trunk/subversion/include/svn_repos.h Thu Mar 27 10:27:25 2014
@@ -2185,8 +2185,7 @@ svn_repos_fs_begin_txn_for_update(svn_fs
  */
 
 /** Like svn_fs_lock2(), but invoke the @a repos's pre- and
- * post-lock hooks before and after the locking action.  Use @a pool
- * for any necessary allocations.
+ * post-lock hooks before and after the locking action.
  *
  * The pre-lock is run for every path in @a targets. Those entries in
  * @a targets for which the pre-lock is successful are passed to
@@ -2204,6 +2203,9 @@ svn_repos_fs_begin_txn_for_update(svn_fs
  * lock, instead of @a token; see the pre-lock-hook documentation for
  * more.
  *
+ * Allocate @a *results in @a result_pool. Use @a scratch_pool for
+ * temporary allocations.
+ *
  * @since New in 1.9.
  */
 svn_error_t *
@@ -2235,8 +2237,7 @@ svn_repos_fs_lock(svn_lock_t **lock,
 
 
 /** Like svn_fs_unlock(), but invoke the @a repos's pre- and
- * post-unlock hooks before and after the unlocking action.  Use @a
- * pool for any necessary allocations.
+ * post-unlock hooks before and after the unlocking action.
  *
  * The pre-unlock hook is run for every path in @a targets. Those
  * entries in @a targets for which the pre-unlock is successful are
@@ -2251,6 +2252,9 @@ svn_repos_fs_lock(svn_lock_t **lock,
  * cases the caller must handle all error in @a results to avoid
  * leaks.
  *
+ * Allocate @a *results in @a result_pool. Use @a scratch_pool for
+ * temporary allocations.
+ *
  * @since New in 1.9.
  */
 svn_error_t *