1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-03-26 16:51:46 -07:00

Move porting topics into their own manual: they are more internal and less public, so don't belong with the rest of the mps reference.

Copied from Perforce
 Change: 180051
 ServerID: perforce.ravenbrook.com
This commit is contained in:
Gareth Rees 2012-10-24 13:37:07 +01:00
parent 19234a67f2
commit a135afc082
5 changed files with 22 additions and 11 deletions

View file

@ -11,6 +11,7 @@ Memory Pool System
guide/index
topic/index
pool/index
topic/porting
Appendices

View file

@ -87,22 +87,24 @@ Outstanding
:c:func:`mps_arena_collect`, :c:func:`mps_arena_start_collect`,
or :c:func:`mps_arena_step`?
106. :c:func:`mps_arena_unsafe_expose_protection` and
107. :c:func:`mps_arena_unsafe_expose_remember_protection` and
:c:func:`mps_arena_unsafe_restore_protection` are kind of hairy
(as well as having absurd names). What's the use case? Exposing
the MPS "is expected only to be useful for debugging" so why have
special unsafe functions for optimizing the expose/restore
procedure? Maybe these should be left undocumented?
107. Have I correctly explained why the documentation is not very
108. Have I correctly explained why the documentation is not very
forthcoming about the set of result codes a function might
return?
108. NB's `MPS Format Protocol
<http://info.ravenbrook.com/project/mps/doc/2002-06-18/obsolete-mminfo/mmdoc/protocol/mps/format/index.html>`
109. NB's `MPS Format Protocol
<http://info.ravenbrook.com/project/mps/doc/2002-06-18/obsolete-mminfo/mmdoc/protocol/mps/format/index.html>`_
says that formats A and B are deprecated. Surely this isn't the
case? That would leave only auto_header supported.
110. Say something about assertions in the error chapter.
Complete
--------

View file

@ -18,8 +18,6 @@ Reference
cache
pattern
finalization
plinth
platform
telemetry
message
debugging

View file

@ -1,12 +1,12 @@
.. _topic-interface:
Memory Pool System interface conventions
========================================
Interface conventions
=====================
This document describes the C programming language interface
conventions used by the MPS. It also contains our :ref:`policy for
support for the public identifiers <topic-interface-support>` and
This document describes the conventions used in the programming
interface to the Memory Pool System. It also contains our :ref:`policy
for support for the public identifiers <topic-interface-support>` and
:ref:`definitions of general types <topic-interface-general>` that
appear throughout the interface.

View file

@ -0,0 +1,10 @@
.. _internals:
Porting
*******
.. toctree::
:numbered:
plinth
platform