On Mon, Nov 05, 2007 at 09:35:05PM -0500, Stefan Teleman wrote:
> 3.3. Exported Interfaces
>
> NAME STABILITY NOTES
>
> SUNWgnu-mp Uncommitted Package Name
>
> /usr/lib/libgmp.so.3.4.2 Uncommitted Shared Library
> /usr/lib/libgmp.so.3 Uncommitted Symbolic Link
> /usr/lib/libgmp.so Uncommitted Symbolic Link
The fully numbered library names are probably not interfaces at all, since
nothing ever uses them. The filename-based interfaces a library provides
are the .so form (for -lgmp) and the .so.MAJOR form (as the SONAME built
into a binary).
You needn't feel compelled to put something in the NOTES column for every
entry -- it's there to clarify the entry, if it's not immediately obvious.
For instance, you could use it to distinguish between the path to the
library and the contents of the library, which might have different
stability levels.
I also note that none of the interfaces you're exporting are Committed,
which reminds me of a rule of thumb that several PSARC members have
mentioned in the past, which is that if your case has no Committed
interfaces, you may be doing something wrong.
I'd suggest that while you're not committing to the precise contents
(version) of the library, you probably don't have any reason to yank the
library, which suggests that the .so and .so.MAJOR interfaces could be
Committed.
> /usr/lib/${MACH64}/libgmp.so.3.4.2 Uncommitted Shared Library
> /usr/lib/${MACH64}/libgmp.so.3 Uncommitted Symbolic Link
> /usr/lib/${MACH64}/libgmp.so Uncommitted Symbolic Link
I'm not sure that the 64-bit versions are useful to list, as (once they're
in /usr/lib) you don't have to specify the paths explicitly.
> /usr/share/man/man3/gmp.3 Uncommitted Manual Page
> [ ... + info + doc ... ]
Again, I don't think these rise to the level of interface. Perhaps they're
supplemental materials for the obsessive PSARC member, but even then I
wouldn't include them until asked (except maybe the man page, if it's
useful).
But the case looks fine in general.
Thanks,
Danek
