mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-04-20 21:11:18 -07:00
Code Issues Projects Releases Wiki Activity

Add cross-references from mps_arena_has_addr to mps_addr_pool (and vice versa), to decrease the likelihood that developers will miss these functions.

Browse source 
Copied from Perforce
 Change: 193721
This commit is contained in:
Gareth Rees 2018-06-13 10:56:47 +01:00
parent 57e2dbccf3
commit ed39d66d77
2 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
mps/manual/source/topic/arena.rst
View file

@ -1024,3 +1024,10 @@ Arena introspection and debugging
return storage to the operating system). For reliable results
call this function and interpret the result while the arena is
in the :term:`parked state`.
.. seealso::
To find out which :term:`pool` the address belongs to, use
:c:func:`mps_addr_pool`, and to find out which :term:`object
format` describes the object at the address, use
:c:func:`mps_addr_fmt`.

7
mps/manual/source/topic/pool.rst
View file

@ -163,3 +163,10 @@ Pool introspection
may immediately become invalidated. For reliable results call
this function and interpret the result while the arena is in
the :term:`parked state`.
.. seealso::
To find out which :term:`object format` describes the object
at the address, use :c:func:`mps_addr_fmt`. If you only care
whether the address belongs to a particular :term:`arena`, use
:c:func:`mps_arena_has_addr`.