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

Re: API/Interface design questions

From: C. Michael Pilato <cmpilato_at_collab.net>
Date: 2004-03-11 22:16:44 CET

John Peacock <jpeacock@rowman.com> writes:

> Even though the paragraph above discusses variables, the examples are
> clearly functions, and they strongely suggest that the double
> underscore functions are not part of the public API (for compatibility
> purposes).
>
> If I have misunderstood, please enlighten me. Is the "published API"
> simply the collection of all functions defined in the .h files?

The published API lives in subversion/include, where all functions
have single underscores. These are highly impacted by our versioning
requirements.

"Semi-public" (which is a term I too use) would be stuff in .h files
scattered amongst the library subdirs themselves
(clients/cmdline/cl.h, libsvn_wc/wc.h, etc.). These functions have
double underscores and are not impacted by our versioning
requirements.

Finally, I used "private" to mean those functions that don't live in
any .h files, are marked "static", and are visible only to the other
functions in their particular .c file.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Thu Mar 11 22:18:17 2004

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.