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

Documenting use of canonical paths in external APIs

From: Daniel Rall <dlr_at_collab.net>
Date: 2007-04-11 23:32:07 CEST

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?

  • application/pgp-signature attachment: stored
Received on Wed Apr 11 23:32:40 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.