You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@subversion.apache.org by cm...@apache.org on 2013/03/29 20:09:29 UTC
svn commit: r1462610 - /subversion/trunk/subversion/include/svn_repos.h
Author: cmpilato
Date: Fri Mar 29 19:09:28 2013
New Revision: 1462610
URL: http://svn.apache.org/r1462610
Log:
* subversion/include/svn_repos.h
(svn_repos_hotcopy, svn_repos_freeze, svn_repos_hooks_setenv,
svn_repos_begin_report3, svn_repos_begin_report2): Tweak docstrings
for clarity.
(svn_repos_authz_read2): Per convention, move this declaration ahead
of the function it replaces (svn_repos_authz_read).
Modified:
subversion/trunk/subversion/include/svn_repos.h
Modified: subversion/trunk/subversion/include/svn_repos.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_repos.h?rev=1462610&r1=1462609&r2=1462610&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_repos.h (original)
+++ subversion/trunk/subversion/include/svn_repos.h Fri Mar 29 19:09:28 2013
@@ -536,8 +536,8 @@ svn_repos_hotcopy2(const char *src_path,
apr_pool_t *pool);
/**
- * Like svn_repos_hotcopy2(), but without the @a incremental parameter
- * and without cancellation support.
+ * Like svn_repos_hotcopy2(), but with @a incremental always passed as
+ * @c FALSE and without cancellation support.
*
* @deprecated Provided for backward compatibility with the 1.6 API.
*/
@@ -658,11 +658,11 @@ svn_repos_recover(const char *path,
/**
* Take an exclusive lock on each of the repositories in @a paths to
- * prevent commits and then while holding all the locks invoke
- * @a freeze_body passing @a baton. The repositories may be readable
- * by Subversion while frozen, or it may be unreadable, depending on
- * which FS backend the repository uses. Repositories are locked
- * in array order from zero.
+ * prevent commits and then while holding all the locks invoke @a
+ * freeze_body passing @a baton. Each repository may be readable by
+ * Subversion while frozen, or may be unreadable, depending on which
+ * FS backend the repository uses. Repositories are locked in the
+ * order in which they are specified in the array.
*
* @since New in 1.8.
*/
@@ -783,20 +783,23 @@ const char *
svn_repos_post_unlock_hook(svn_repos_t *repos,
apr_pool_t *pool);
-/** Set the environment that @a repos's hooks will inherit.
- * The environment is specified in a file at @a hooks_env_path.
- * If @a hooks_env_path is @c NULL, the file is searched at its
- * default location in the repository. If @a hooks_env_path is
- * not absolute, it specifies a path relative to the parent of
- * the file's default location in the repository.
+/** Specify that Subversion should consult the configuration file
+ * located at @a hooks_env_path to determine how to setup the
+ * environment for hook scripts invoked for the repository @a repos.
+ * As a special case, if @a hooks_env_path is @c NULL, look for the
+ * file in its default location within the repository disk structure.
+ * If @a hooks_env_path is not absolute, it specifies a path relative
+ * to the parent of the file's default location.
+ *
+ * @a result_pool should be the same pool that @a repos was allocated in.
+ * Use @a scratch_pool for temporary allocations.
+ *
+ * If this function is not called, or if the specified configuration
+ * file does not define any environment variables, hooks will run in
+ * an empty environment.
*
- * The @a result_pool should be the same pool that @a repos was allocated in.
- * The @a scratch_pool is used for temporary allocations.
- *
- * If this function is not called, or if the file does not list any
- * environment variables, hooks will run in an empty environment.
- *
- * @since New in 1.8. */
+ * @since New in 1.8.
+ */
svn_error_t *
svn_repos_hooks_setenv(svn_repos_t *repos,
const char *hooks_env_path,
@@ -847,12 +850,13 @@ svn_repos_hooks_setenv(svn_repos_t *repo
* avoid sending data through @a editor/@a edit_baton which is not
* authorized for transmission.
*
- * @a zero_copy_limit controls up to which size in bytes data blocks may
- * be sent using the zero-copy code path. On that path, a number of
- * in-memory copy operations have been eliminated to maximize throughput.
- * However, until the whole block has been pushed to the network stack,
- * other clients may get blocked. Thus, be careful when using larger
- * values here. 0 disables the optimization.
+ * @a zero_copy_limit controls the maximum size (in bytes) at which
+ * data blocks may be sent using the zero-copy code path. On that
+ * path, a number of in-memory copy operations have been eliminated to
+ * maximize throughput. However, until the whole block has been
+ * pushed to the network stack, other clients block, so be careful
+ * when using larger values here. Pass 0 for @a zero_copy_limit to
+ * disable this optimization altogether.
*
* @a note Never activate this optimization if @a editor might access
* any FSFS data structures (and, hence, caches). So, it is basically
@@ -911,8 +915,8 @@ svn_repos_begin_report3(void **report_ba
apr_pool_t *pool);
/**
- * The same as svn_repos_begin_report3(), but setting the @a zero_copy_limit
- * to 0.
+ * The same as svn_repos_begin_report3(), but with @a zero_copy_limit
+ * always passed as 0.
*
* @since New in 1.5.
*
@@ -3163,21 +3167,6 @@ svn_repos_get_fs_build_parser(const svn_
*/
typedef struct svn_authz_t svn_authz_t;
-/**
- * Similar to svn_repos_authz_read2(), but without support for
- * authz files stored in a Subversion repository (absolute or
- * relative URLs) and without the @a repos_root argument.
- *
- * @since New in 1.3.
- * @deprecated Provided for backward compatibility with the 1.7 API.
- */
-SVN_DEPRECATED
-svn_error_t *
-svn_repos_authz_read(svn_authz_t **authz_p,
- const char *file,
- svn_boolean_t must_exist,
- apr_pool_t *pool);
-
/**
* Read authz configuration data from @a path (a file, repos relative
* url, an absolute file url, or a registry path) into @a *authz_p,
@@ -3196,7 +3185,7 @@ svn_repos_authz_read(svn_authz_t **authz
* the root of the repository the authz configuration will be used with.
* The same applies to @a groups_path if it is being used.
*
- * @since New in 1.8
+ * @since New in 1.8.
*/
svn_error_t *
svn_repos_authz_read2(svn_authz_t **authz_p,
@@ -3207,13 +3196,27 @@ svn_repos_authz_read2(svn_authz_t **auth
apr_pool_t *pool);
+/**
+ * Similar to svn_repos_authz_read2(), but with @a groups_path and @a
+ * repos_root always passed as @c NULL.
+ *
+ * @since New in 1.3.
+ * @deprecated Provided for backward compatibility with the 1.7 API.
+ */
+SVN_DEPRECATED
+svn_error_t *
+svn_repos_authz_read(svn_authz_t **authz_p,
+ const char *file,
+ svn_boolean_t must_exist,
+ apr_pool_t *pool);
+
/**
* Read authz configuration data from @a stream into @a *authz_p,
* allocated in @a pool.
*
* If @a groups_stream is set, use the global groups parsed from it.
*
- * @since New in 1.8
+ * @since New in 1.8.
*/
svn_error_t *
svn_repos_authz_parse(svn_authz_t **authz_p,