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

Re: Documenting use of canonical paths in external APIs

From: Hyrum K. Wright <hyrum_wright_at_mail.utexas.edu>
Date: 2007-04-11 23:39:30 CEST

Daniel Rall wrote:
> On Wed, 11 Apr 2007, Hyrum K. Wright wrote:
>> Daniel Rall wrote:
> ...
>>> I asked Erik where we document this important API usage fact, but he
>>> wasn't sure. Do we document this anywhere? If not, I suggest
>>> documenting it in hacking.html.
>> Would documenting it in the header files also be useful? After all, it
>> is something which the API consumers should be aware of. The header
>> files are what outlines our API specification, and this seems part of
>> that spec.
> I first thought of the header files (I'd personally like to see it
> documented there). I suppose a sweep through svn_client.h would be a
> sufficient, combined with a note in hacking.html?

Or even just a note at the top of svn_client.h. Something similar to
"you must call apr_initialize() before using any of this stuff." Come
to think of it, that's not documented in svn_client.h either.

I agree that it should also be mentioned in hacking.html.

-Hyrum (who has often thought it might be nice to have a separate
"hacking with Subversion" document, in addition to the existing "hacking
on Subversion" document)

Received on Wed Apr 11 23:39:57 2007

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.