You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@subversion.apache.org by kf...@collab.net on 2005/05/30 14:24:16 UTC
Re: svn commit: r14873 - in trunk/subversion: libsvn_client
lundblad@tigris.org writes:
> --- trunk/subversion/include/svn_client.h (original)
> +++ trunk/subversion/include/svn_client.h Sat May 28 16:31:37 2005
> @@ -2091,6 +2091,22 @@
> svn_client_ctx_t *ctx,
> apr_pool_t *pool);
>
> +
> +/* Opening RA sessions. */
> +
> +/** Open an RA session rooted at @a url, and return it in @a *session.
> + *
> + * Use the authentication baton stored in @a ctx for authentication.
> + * @a *session is allocated in @a pool.
> + *
> + * @since New in 1.3.
> + */
> +svn_error_t *
> +svn_client_open_ra_session (svn_ra_session_t **session,
> + const char *url,
> + svn_client_ctx_t *ctx,
> + apr_pool_t *pool);
> +
I think the doc string here should say why one might prefer this to
svn_ra_open(). And the doc string for svn_ra_open() should say why
one might prefer svn_client_open_ra_session().
This is the main way people will find out about this new interface.
> --- trunk/subversion/libsvn_client/client.h (original)
> +++ trunk/subversion/libsvn_client/client.h Sat May 28 16:31:37 2005
> @@ -227,15 +227,16 @@
>
> The calling application's authentication baton is provided in CTX,
> and allocations related to this session are performed in POOL. */
> -svn_error_t * svn_client__open_ra_session (svn_ra_session_t **ra_session,
> - const char *base_url,
> - const char *base_dir,
> - svn_wc_adm_access_t *base_access,
> - apr_array_header_t *commit_items,
> - svn_boolean_t use_admin,
> - svn_boolean_t read_only_wc,
> - svn_client_ctx_t *ctx,
> - apr_pool_t *pool);
> +svn_error_t *
> +svn_client__open_ra_session_internal (svn_ra_session_t **ra_session,
> + const char *base_url,
> + const char *base_dir,
> + svn_wc_adm_access_t *base_access,
> + apr_array_header_t *commit_items,
> + svn_boolean_t use_admin,
> + svn_boolean_t read_only_wc,
> + svn_client_ctx_t *ctx,
> + apr_pool_t *pool);
People might wonder why the "_internal", since this is already a
double-underscore function. You might want to explain that it is to
avoid confusion with the public function svn_client_open_ra_session().
However, this is a very minor point -- please ignore if you do not
find it compelling :-).
-Karl
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: svn commit: r14873 - in trunk/subversion: libsvn_client
Posted by "Peter N. Lundblad" <pe...@famlundblad.se>.
On Mon, 30 May 2005 kfogel@collab.net wrote:
> lundblad@tigris.org writes:
> > --- trunk/subversion/include/svn_client.h (original)
> > +++ trunk/subversion/include/svn_client.h Sat May 28 16:31:37 2005
> I think the doc string here should say why one might prefer this to
> svn_ra_open(). And the doc string for svn_ra_open() should say why
> one might prefer svn_client_open_ra_session().
>
Good idea. I added cross-references and an explanation in r14884.
> > --- trunk/subversion/libsvn_client/client.h (original)
> > +++ trunk/subversion/libsvn_client/client.h Sat May 28 16:31:37 2005
> > @@ -227,15 +227,16 @@
> >
> > The calling application's authentication baton is provided in CTX,
> > and allocations related to this session are performed in POOL. */
> > -svn_error_t * svn_client__open_ra_session (svn_ra_session_t **ra_session,
> > - const char *base_url,
> > - const char *base_dir,
> > - svn_wc_adm_access_t *base_access,
> > - apr_array_header_t *commit_items,
> > - svn_boolean_t use_admin,
> > - svn_boolean_t read_only_wc,
> > - svn_client_ctx_t *ctx,
> > - apr_pool_t *pool);
> > +svn_error_t *
> > +svn_client__open_ra_session_internal (svn_ra_session_t **ra_session,
> > + const char *base_url,
> > + const char *base_dir,
> > + svn_wc_adm_access_t *base_access,
> > + apr_array_header_t *commit_items,
> > + svn_boolean_t use_admin,
> > + svn_boolean_t read_only_wc,
> > + svn_client_ctx_t *ctx,
> > + apr_pool_t *pool);
>
> People might wonder why the "_internal", since this is already a
> double-underscore function. You might want to explain that it is to
> avoid confusion with the public function svn_client_open_ra_session().
> However, this is a very minor point -- please ignore if you do not
> find it compelling :-).
>
Well, while I'm here...
Thanks,
//Peter
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org