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

Re: [PATCH] Correct svn_wc_get_pristine_copy_path() comment.

From: Julian Foad <julianfoad_at_btopenworld.com>
Date: 2006-06-20 22:30:58 CEST

Madan U Sreenivasan wrote:
> On Mon, 19 Jun 2006 18:23:26 +0530, Malcolm Rowe
> <malcolm-svn-dev@farside.org.uk> wrote:
>
>> On Mon, Jun 19, 2006 at 06:30:32PM +0530, Madan U Sreenivasan wrote:
>
>>> I spoke with eh on irc sometime back, and eh felt that this API might
>>> be used in places where the text-base does not exist, but has to be
>>> created. For example in case of a cp/mv.

I'm not sure exactly what you mean by "has to be created".

> [[[
> Correct comment for svn_wc_get_pristine_copy_path().
>
> * subversion/include/svn_wc.h
> (svn_wc_get_pristine_copy_path): Remove incorrect statements from the
> doc-comments.
> ]]]

> Index: subversion/include/svn_wc.h
> ===================================================================
> --- subversion/include/svn_wc.h (revision 20165)
> +++ subversion/include/svn_wc.h (working copy)
> @@ -3034,9 +3034,7 @@
>
>
> /** Given a @a path to a wc file, return a @a pristine_path which points to a
> - * pristine version of the file. This is needed so clients can do
> - * diffs. If the WC has no text-base, return a @c NULL instead of a
> - * path.
> + * BASE version of the file.
> */
> svn_error_t *svn_wc_get_pristine_copy_path(const char *path,
> const char **pristine_path,

I don't see how this function can guarantee to return a path to a pristine
version of the file if it is possible for a file not to have a text-base.
Therefore I assume it returns an error in that case. If a caller wants to take
special action in that case, rather than just aborting, the caller needs to
know what error will be returned and therefore this interface needs to document it.

- Julian

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Tue Jun 20 22:31:21 2006

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