You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@subversion.apache.org by ju...@apache.org on 2012/03/13 16:39:21 UTC

svn commit: r1300197 - /subversion/trunk/subversion/include/svn_repos.h

Author: julianfoad
Date: Tue Mar 13 15:39:21 2012
New Revision: 1300197

URL: http://svn.apache.org/viewvc?rev=1300197&view=rev
Log:
* subversion/include/svn_repos.h
  (svn_repos_fs_get_mergeinfo): Clarify that paths start with '/'.

Modified:
    subversion/trunk/subversion/include/svn_repos.h

Modified: subversion/trunk/subversion/include/svn_repos.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_repos.h?rev=1300197&r1=1300196&r2=1300197&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_repos.h (original)
+++ subversion/trunk/subversion/include/svn_repos.h Tue Mar 13 15:39:21 2012
@@ -1780,6 +1780,8 @@ svn_repos_get_logs(svn_repos_t *repos,
  * set @a *catalog to a catalog of this mergeinfo.  @a *catalog will
  * never be @c NULL but may be empty.
  *
+ * The paths in @a paths, and the keys of @a catalog, start with '/'.
+ *
  * @a inherit indicates whether explicit, explicit or inherited, or
  * only inherited mergeinfo for @a paths is fetched.
  *



Re: svn commit: r1300197 - /subversion/trunk/subversion/include/svn_repos.h

Posted by "C. Michael Pilato" <cm...@collab.net>.
On 03/13/2012 01:04 PM, Julian Foad wrote:
> C. Michael Pilato wrote:
>> On 03/13/2012 11:39 AM, julianfoad@apache.org wrote:
>>> * subversion/include/svn_repos.h
>>>    (svn_repos_fs_get_mergeinfo): Clarify that paths start with '/'.
>>
>> Explicitly mentioned the "fspath" term?
>>
>>    The paths in @a paths, and the keys of @a catalog, are fspaths (that is,
>>    they start with '/').
>>
>> Or perhaps mention the term, omit its parenthesized distinguishing feature,
>> and just trust that our glossary penetration is good enough.
>>
>> There's no point in creating such terms if we don't use them.
> 
> Sure, and also we could rename the parameter to 'prefix_fspath', since a
> clue in the function prototype is even more helpful than in the doc
> string.

Agreed!

> But I also thought we might want to relax the function to allow either
> fspaths or relpaths (maybe requiring the prefix kind to match the cat
> keys kind, maybe not).  Specifically, I've written some uncommitted code
> which needs this function to be so relaxed, and also I noticed that the
> complementary 'add_prefix' function seems to be so relaxed as well.
> Didn't want to delay the commit because of such thoughts.

Fair 'nuff.

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


Re: svn commit: r1300197 - /subversion/trunk/subversion/include/svn_repos.h

Posted by Julian Foad <ju...@btopenworld.com>.
[CC -= commits@]

C. Michael Pilato wrote:
> On 03/13/2012 11:39 AM, julianfoad@apache.org wrote:
>> * subversion/include/svn_repos.h
>>   (svn_repos_fs_get_mergeinfo): Clarify that paths start with '/'.
> 
> Explicitly mentioned the "fspath" term?
> 
>   The paths in @a paths, and the keys of @a catalog, are fspaths (that is,
>   they start with '/').
> 
> Or perhaps mention the term, omit its parenthesized distinguishing feature,
> and just trust that our glossary penetration is good enough.
> 
> There's no point in creating such terms if we don't use them.


Sure, and also we could rename the parameter to 'prefix_fspath', since a clue in the function prototype is even more helpful than in the doc string.

But I also thought we might want to relax the function to allow either fspaths or relpaths (maybe requiring the prefix kind to match the cat keys kind, maybe not).  Specifically, I've written some uncommitted code which needs this function to be so relaxed, and also I noticed that the complementary 'add_prefix' function seems to be so relaxed as well.  Didn't want to delay the commit because of such thoughts.

- Julian


Re: svn commit: r1300197 - /subversion/trunk/subversion/include/svn_repos.h

Posted by "C. Michael Pilato" <cm...@collab.net>.
On 03/13/2012 11:39 AM, julianfoad@apache.org wrote:
> Author: julianfoad
> Date: Tue Mar 13 15:39:21 2012
> New Revision: 1300197
> 
> URL: http://svn.apache.org/viewvc?rev=1300197&view=rev
> Log:
> * subversion/include/svn_repos.h
>   (svn_repos_fs_get_mergeinfo): Clarify that paths start with '/'.

Explicitly mentioned the "fspath" term?

   The paths in @a paths, and the keys of @a catalog, are fspaths (that is,
   they start with '/').

Or perhaps mention the term, omit its parenthesized distinguishing feature,
and just trust that our glossary penetration is good enough.

There's no point in creating such terms if we don't use them.

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


Re: svn commit: r1300197 - /subversion/trunk/subversion/include/svn_repos.h

Posted by "C. Michael Pilato" <cm...@collab.net>.
On 03/13/2012 11:39 AM, julianfoad@apache.org wrote:
> Author: julianfoad
> Date: Tue Mar 13 15:39:21 2012
> New Revision: 1300197
> 
> URL: http://svn.apache.org/viewvc?rev=1300197&view=rev
> Log:
> * subversion/include/svn_repos.h
>   (svn_repos_fs_get_mergeinfo): Clarify that paths start with '/'.

Explicitly mentioned the "fspath" term?

   The paths in @a paths, and the keys of @a catalog, are fspaths (that is,
   they start with '/').

Or perhaps mention the term, omit its parenthesized distinguishing feature,
and just trust that our glossary penetration is good enough.

There's no point in creating such terms if we don't use them.

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