LSARC/2008/059 - SQLite

[James Carlson]

David.Comay at Sun.COM writes:
> > James explained that this is not quite so.  I think we would need a
> > manpage for libsqlite with a URL to the actual docs, and a list of
> > interface stabilities for the various functions ("these are
> > Uncommitted," "these are Obsolete Volatile" and "the rest are
> > Volatile").
> 
> This is in fact what generally is done in SFW, particularly for
> components that deliver their documentation via HTML or some other
> format.

Right.  If you look at the interface taxonomy, it only says that you
have to have some kind of documentation for public (Committed,
Uncommitted, Volatile) interfaces.

  Adequate customer documentation must exist for all Public
  interfaces. It is strongly preferred that manual pages exist for all
  Public interfaces (supported on Solaris), even if only significant
  content of those pages are SYNOPSIS and ATTRIBUTES sections and a
  textual pointer to other documentation. Independent of the form of
  documentation delivery, the interface taxonomy commitment level must
  be presented to the consumer.

The usual rule is that Committed gets a man page, Uncommitted gets a
man page with warnings, and Volatile might not have a man page entry
at all, but instead could have a white paper, blog entry, or some
other less definitive specification.  Private intentionally doesn't
have documentation, and if it does (because the interface is
particularly "noticeable"), then it just says "no user serviceable
parts inside."

-- 
James Carlson, Solaris Networking              <james.d.carlson at sun.com>
Sun Microsystems / 35 Network Drive        71.232W   Vox +1 781 442 2084
MS UBUR02-212 / Burlington MA 01803-2757   42.496N   Fax +1 781 442 1677