[m-rev.] for review: re-organise reference manual w.r.t foreign language / C interface

[Julien Fischer]

Hi, could someone please review this - I have other changes waiting on it.

Julien.

On Tue, 29 Jan 2008, Julien Fischer wrote:

>
> For review by anyone.
>
> Estimated hours taken: 1.5
> Branches: main
>
> Re-organise sections of the reference manual concerning the old C interface
> and the "new" foreign language interface.
>
> doc/reference_manual.texi:
> 	Add a new introduction to the ``Foreign language interface'' section
> 	that makes it more clear that the old C interface is deprecated and
> 	will be removed in a future release.
>
> 	Recommend that code which uses the old interface be rewritten to
> 	use the new interface.  The reasons given in the old introduction
> 	for not using the new interface are long since invalid - for some
> 	of them the opposite is now true.
>
> 	Shift the section ``Memory management'' from the ``C interface''
> 	chapter to the section covering the language specific binding
> 	for C in the new foreign language interface chapter.
> 	Rename it to ``Memory management for C''.
>
> 	Shift the section ``Trailing'' from the ``C interface'' chapter
> 	into the chapter ``Implementation-dependent extensions''.
>
> 	Recommend against the use of the c_pointer type in favour
> 	of foreign_type pragma instead.  (We have had a similar 
> recommendation
> 	in the Library Reference for some time.)
>
> 	Refer to pragma foreign_export rather than pragma export.
>
> 	Fix spelling errors and a doubled-up word.
--------------------------------------------------------------------------
mercury-reviews mailing list
Post messages to:       mercury-reviews at csse.unimelb.edu.au
Administrative Queries: owner-mercury-reviews at csse.unimelb.edu.au
Subscriptions:          mercury-reviews-request at csse.unimelb.edu.au
--------------------------------------------------------------------------