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

Re: [PATCH] Fix API doc parameter reference

From: Julian Foad <julianfoad_at_btopenworld.com>
Date: 2006-07-29 23:00:59 CEST

Daniel Rall wrote:
> Perhaps the parameter should be renamed instead? We usually refer to
> its type of data as "copyfrom", as opposed to just "copy".

I agree, and here's the patch for review in case I'm wrong in thinking this
would not be an API or ABI change.

Rename some API parameters for consistency. This does not constitute an API
or ABI change, as the parameters are only within a pointer-to-function type.

* subversion/include/svn_delta.h
   (svn_delta_editor_t): Rename add_file()'s 'copy_path' and 'copy_revision'
     parameters to 'copyfrom_path' and 'copyfrom_revision' to match its doc
     string and for consistency with add_dir() and many (but not all) functions
     that implement this interface.

Index: subversion/include/svn_delta.h
--- subversion/include/svn_delta.h (revision 20897)
+++ subversion/include/svn_delta.h (working copy)
@@ -810,8 +810,8 @@ typedef struct svn_delta_editor_t
    svn_error_t *(*add_file)(const char *path,
                             void *parent_baton,
- const char *copy_path,
- svn_revnum_t copy_revision,
+ const char *copyfrom_path,
+ svn_revnum_t copyfrom_revision,
                             apr_pool_t *file_pool,
                             void **file_baton);

> On Sat, 29 Jul 2006, Madan S. wrote:
>>* subversion/include/svn_delta.h
>> (svn_delta_editor_t.add_file): Correct doc to refer to copy_path and
>> copy_revision instead of copyfrom_path and copyfrom_revision

Note that these parameters are also referenced in a more general comment
(earlier in the file) that assumes they are named the same in add_file() as in

- Julian

To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Sat Jul 29 23:00:20 2006

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

This site is subject to the Apache Privacy Policy and the Apache Public Forum Archive Policy.