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

Re: svn commit: r17362 - in trunk/subversion: libsvn_wc

From: Malcolm Rowe <malcolm_at_farside.org.uk>
Date: 2005-11-15 21:17:44 CET

Couple of comments on the documentation changes (only), inline:

On Tue, Nov 15, 2005 at 01:36:57PM -0600, dionisos@tigris.org wrote:
> Author: dionisos
> Date: Tue Nov 15 13:36:57 2005
> New Revision: 17362
>

> * subversion/libsvn_wc/update_editor.c
> Update callers to svn_wc_translated_file and
> svn_wc_translated_file2, removing superseeded static functions.
"superseded"

> --- trunk/subversion/include/svn_wc.h (original)
> +++ trunk/subversion/include/svn_wc.h Tue Nov 15 13:36:57 2005
> + /** Translate from Normal Format; excludes SVN_WC_TRANSLATE_TO_NF */
> +#define SVN_WC_TRANSLATE_FROM_NF 0x00000000
> +
> + /** Translate to Normal Format; excludes SVN_WC_TRANSLATE_FROM_NF */
> +#define SVN_WC_TRANSLATE_TO_NF 0x00000001

What is 'Normal Form(at)'? I guess (from later) that it's the format
that the text-base is stored in: LF line termination and unexpanded
keywords. But it'd be good to document it here, since we don't
use the phrase elsewhere. (Hmm, would something even clearer like
SVN_WC_TRANSLATE_TEXTBASE_TO_WORKING be better? Probably too long.)

> +
> + /** Only do translation associated with the svn:special property only */
> +#define SVN_WC_TRANSLATE_SPECIAL_ONLY 0x00000002

Offhand, I don't know what kind of translation we'd do with respect to the
svn:special property at all. Could we have some more information here?

> +
> + /** Translate the special property only */
> +#define SVN_WC_TRANSLATE_DEL_TMP_ON_POOL_CLEANUP 0x00000004

Comment is wrong.

> +/** Set @a *xlated_path to a path to translated copy of @src
> + * or to @a src itself if no translation is necessary.
"(unless SVN_WC_TRANSLATE_FORCE_COPY is set)"? I know, you mention it
further down, maybe it's unimportant.

> + * If @c SVN_WC_TRANSLATE_DEL_TEMP_ON_POOL_CLEANUP is specified,
> + * a pool cleanup handler is registered on *xlated_p if it points to a
> + * temporary file.
> *
> * If an error is returned, the effect on @a *xlated_p is undefined.

"xlated_path", both times.

Regards,
Malcolm

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Wed Nov 16 00:30:52 2005

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