[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: John Peacock <jpeacock_at_rowman.com>
Date: 2004-03-11 22:07:51 CET

kfogel@collab.net wrote:
> Note that we don't have this concept of "semi-public" right now.

That's not how I read this (from HACKING):

    * Signify internal variables by two underscores after the prefix.
       That is, when a symbol must (for technical reasons) reside in the
       global namespace despite not being part of a published interface,
       then use two underscores following the module prefix. For
       example:

          svn_fs_get_rev_prop () /* Part of published API. */
          svn_fs__parse_props () /* For internal use only. */

>
> If a function has two underscores ('svn_wc__foo_bar'), that means it
> is shared among different files in that library. But when functions
> are called from other libraries, then they're just public functions.

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?

John

-- 
John Peacock
Director of Information Research and Technology
Rowman & Littlefield Publishing Group
4501 Forbes Boulevard
Suite H
Lanham, MD  20706
301-459-3366 x.5010
fax 301-429-5748
---------------------------------------------------------------------
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:07:47 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.