You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@subversion.apache.org by "C. Michael Pilato" <cm...@collab.net> on 2008/06/04 14:55:20 UTC

[PATCH] log-related public API docstring clarifications

(See the "SVN-DEV HELP NEEDED: What to do about the ra-get-log interface" 
thread for background information.)

C. Michael Pilato wrote:
 > Fortunately (for us), I think the docstrings in the RA and repos layers
 > are sufficiently vague as to not imply *what* would happen if you passed
 > an empty array.  So, in my opinion, we have the opportunity in 1.5.0 to
 > define that behavior (which we effectively have:  empty paths == NULL
 > paths == paths with one "" member), and (now) in 1.5.1 to fix the
 > docstrings for the repos and RA functions so that this is all made clear.

Attached is a quickie patch to our public API which, I think, accurately 
describes the state of the world.  Note the @note on svn_ra_get_logs2() -- 
is that cool?  Can we do this?

-- 
C. Michael Pilato <cm...@collab.net>
CollabNet   <>   www.collab.net   <>   Distributed Development On Demand

Re: [PATCH] log-related public API docstring clarifications

Posted by "C. Michael Pilato" <cm...@collab.net>.
C. Michael Pilato wrote:
> (See the "SVN-DEV HELP NEEDED: What to do about the ra-get-log 
> interface" thread for background information.)
> 
> C. Michael Pilato wrote:
>  > Fortunately (for us), I think the docstrings in the RA and repos layers
>  > are sufficiently vague as to not imply *what* would happen if you passed
>  > an empty array.  So, in my opinion, we have the opportunity in 1.5.0 to
>  > define that behavior (which we effectively have:  empty paths == NULL
>  > paths == paths with one "" member), and (now) in 1.5.1 to fix the
>  > docstrings for the repos and RA functions so that this is all made 
> clear.
> 
> Attached is a quickie patch to our public API which, I think, accurately 
> describes the state of the world.  Note the @note on svn_ra_get_logs2() 
> -- is that cool?  Can we do this?
> 

I committed this patch in r31590.

-- 
C. Michael Pilato <cm...@collab.net>
CollabNet   <>   www.collab.net   <>   Distributed Development On Demand