Re: [PATCH] Fix API doc parameter reference

[Julian Foad <ju...@btopenworld.com>]

Daniel Rall wrote:
> On Mon, 31 Jul 2006, Malcolm Rowe wrote:
> 
> 
>>>On Sat, 29 Jul 2006, Julian Foad wrote:
>>>
>>>>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.

Committed in r21071.

>>(Does renaming arguments ever constitute an API/ABI change?)

Probably not, in C.  I removed the word "as" from the log message, so as not to 
imply that it does.


>>On Sun, Jul 30, 2006 at 11:07:21PM -0700, Daniel Rall wrote:
>>
>>>I'm guessing that our SWIG stuff doesn't expose this API, but if it
>>>does, it could have some impact there.
>>
>>Why's that?  Does SWIG depend upon the names of arguments used in
>>function declarations?
> 
> Yeah, it does depend on parameter names.
> 
> Alongside Julian's patch, should we also ditch the "copy_path"
> parameter from svn_delta.i?  add_file() is the only place I see it
> used in svn_delta.h.
> 
> Index: subversion/bindings/swig/svn_delta.i
> ===================================================================
> --- subversion/bindings/swig/svn_delta.i        (revision 20914)
> +++ subversion/bindings/swig/svn_delta.i        (working copy)
> @@ -34,7 +34,6 @@
>  %apply const char *MAY_BE_NULL {
>      const char *error_info,
>      const char *copyfrom_path,
> -    const char *copy_path,
>      const char *base_checksum,
>      const char *text_checksum
>  };

I have never looked at SWIG and have got no idea about the change you are 
suggesting here.

- Julian

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org

Re: [PATCH] Fix API doc parameter reference

[Garrett Rooney <ro...@electricjellyfish.net>]

On 8/14/06, Julian Foad <ju...@btopenworld.com> wrote:
> Daniel Rall wrote:
> > On Mon, 31 Jul 2006, Malcolm Rowe wrote:
> >
> >
> >>>On Sat, 29 Jul 2006, Julian Foad wrote:
> >>>
> >>>>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.
>
> Committed in r21071.
>
> >>(Does renaming arguments ever constitute an API/ABI change?)
>
> Probably not, in C.  I removed the word "as" from the log message, so as not to
> imply that it does.

It's not an API/ABI change, but you do have to be careful to not break
the swig bindings when you do it.

> >>On Sun, Jul 30, 2006 at 11:07:21PM -0700, Daniel Rall wrote:
> >>
> >>>I'm guessing that our SWIG stuff doesn't expose this API, but if it
> >>>does, it could have some impact there.
> >>
> >>Why's that?  Does SWIG depend upon the names of arguments used in
> >>function declarations?
> >
> > Yeah, it does depend on parameter names.
> >
> > Alongside Julian's patch, should we also ditch the "copy_path"
> > parameter from svn_delta.i?  add_file() is the only place I see it
> > used in svn_delta.h.
> >
> > Index: subversion/bindings/swig/svn_delta.i
> > ===================================================================
> > --- subversion/bindings/swig/svn_delta.i        (revision 20914)
> > +++ subversion/bindings/swig/svn_delta.i        (working copy)
> > @@ -34,7 +34,6 @@
> >  %apply const char *MAY_BE_NULL {
> >      const char *error_info,
> >      const char *copyfrom_path,
> > -    const char *copy_path,
> >      const char *base_checksum,
> >      const char *text_checksum
> >  };
>
> I have never looked at SWIG and have got no idea about the change you are
> suggesting here.

SWIG uses the names and types of arguments in order to tell which type
of rule to apply.  I believe this change is based on the fact that you
just removed the last instance of a copy_path char * argument, and
thus we don't need that rule anymore.

-garrett

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org