Re: [PATCH] Fix doc string of svn_repos_fs_get_mergeinfo()

Commit away!

Julian Foad wrote:
> [[[
> Fix a doc string.
>
> * subversion/include/svn_repos.h
> (svn_repos_fs_get_mergeinfo): Fix argument names and description
> of the return value. Mention the "repos" argument.
> ]]]
>
> [[[
> Index: subversion/include/svn_repos.h
> ===================================================================
> --- subversion/include/svn_repos.h (revision 32171)
> +++ subversion/include/svn_repos.h (working copy)
> @@ -1414,33 +1414,34 @@
>
> /* ---------------------------------------------------------------*/
>
>
> /* Retrieving mergeinfo. */
>
> /**
> - * Fetch the mergeinfo for @a paths at @a rev, and save it to @a
> - * *catalog. It will never be @c NULL but may be empty.
> + * Fetch the mergeinfo for @a paths at @a revision in @a repos, and
> + * set @a *catalog to a catalog of this mergeinfo. @a *catalog will
> + * never be @c NULL but may be empty.
> *
> * @a inherit indicates whether explicit, explicit or inherited, or
> * only inherited mergeinfo for @a paths is fetched.
> *
> * If @a revision is @c SVN_INVALID_REVNUM, it defaults to youngest.
> *
> * If @a include_descendants is TRUE, then additionally return the
> * mergeinfo for any descendant of any element of @a paths which has
> * the @c SVN_PROP_MERGEINFO property explicitly set on it. (Note
> * that inheritance is only taken into account for the elements in @a
> * paths; descendants of the elements in @a paths which get their
> - * mergeinfo via inheritance are not included in @a *mergeoutput.)
> + * mergeinfo via inheritance are not included in @a *catalog.)
> *
> * If optional @a authz_read_func is non-NULL, then use this function
> * (along with optional @a authz_read_baton) to check the readability
> * of each path which mergeinfo was requested for (from @a paths).
> * Silently omit unreadable paths from the request for mergeinfo.
> *
> - * Use @a pool for temporary allocations.
> + * Use @a pool for all allocations.
> *
> * @since New in 1.5.
> */
> svn_error_t *
> svn_repos_fs_get_mergeinfo(svn_mergeinfo_catalog_t *catalog,
> svn_repos_t *repos,
> ]]]
>
> - Julian
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe_at_subversion.tigris.org
> For additional commands, e-mail: dev-help_at_subversion.tigris.org
>

-- 
C. Michael Pilato <cmpilato_at_collab.net>
CollabNet   <>   www.collab.net   <>   Distributed Development On Demand