[m-dev.] documenting parts of Mercury's C runtime interface

[Julien Fischer]

Hi,

Most Mercury bindings to C (or C++) libraries need to make some use of the
facilities provided by the runtime, e.g. for memory allocation in C code using
the GC, making aligned string copies, or extracting an underlying C file
stream from a Mercury one.

Currently, none of this stuff is really documented outside of runtime
code itself.  For most of the runtime this is desirable since we want
the freedom to change it without respect to backwards compatability,
but some usage of the runtime functionality has become some prevalent
in library bindings and other code that makes heavy use of the C interface
  that it really does need to be documented properly.

Should this be done in the reference manual, the user's guide, or a separate
guide to the runtime?  Which would people prefer?

Julien.
--------------------------------------------------------------------------
mercury-developers mailing list
Post messages to:       mercury-developers at csse.unimelb.edu.au
Administrative Queries: owner-mercury-developers at csse.unimelb.edu.au
Subscriptions:          mercury-developers-request at csse.unimelb.edu.au
--------------------------------------------------------------------------