[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: svn commit: r956941 - /subversion/trunk/subversion/libsvn_subr/io.c

From: Julian Foad <julian.foad_at_wandisco.com>
Date: Wed, 23 Jun 2010 11:05:32 +0100

On Tue, 2010-06-22 at 23:18 +0300, Daniel Shahaf wrote:
> julianfoad_at_apache.org wrote on Tue, 22 Jun 2010 at 19:18 -0000:
> > @@ -3665,7 +3667,7 @@ temp_file_create(apr_file_t **new_file,
> > #endif
> > }
> >
> > -/* Wrapper for apr_file_name_get(). */
> > +/* Wrapper for apr_file_name_get(), passing out a UTF8-encoded filename. */
> > svn_error_t *
> > svn_io_file_name_get(const char **filename,
> > apr_file_t *file,
>
> Doesn't this also belong in the public docs of this function?

Yes, thanks. Will commit when svn.a.o comes back on line.

(At first, I thought "No, we don't document when strings are UTF-8,
because that's normal", but then I looked in svn_io.h and saw that we do
document it on the "wrapper" functions because it's not obvious.)

- Julian

> [[[
> Index: subversion/include/svn_io.h
> ===================================================================
> --- subversion/include/svn_io.h (revision 956596)
> +++ subversion/include/svn_io.h (working copy)
> @@ -1921,7 +1921,8 @@
> int version,
> apr_pool_t *pool);
>
> -/** Wrapper for apr_file_name_get().
> +/** Wrapper for apr_file_name_get(). The encoding of @a *filename
> + * is UTF-8.
> *
> * @since New in 1.7. */
> svn_error_t *
> ]]]
>
> While here, thanks for continually ensuring that we have proper docs
> for our internal functions.
>
> Daniel
Received on 2010-06-23 12:06:18 CEST

This is an archived mail posted to the Subversion Dev mailing list.