mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-01-04 02:51:31 -08:00
Code Issues Projects Releases Wiki Activity

Documentation improvements suggests by bruce mitchener:

Browse source 
* Fix cross-references to mps_pool_debug_option_s
* Link pool classes in the header of the table of pool class properties 

Copied from Perforce
 Change: 186150
 ServerID: perforce.ravenbrook.com
This commit is contained in:
Gareth Rees 2014-05-17 09:30:45 +01:00
parent 6e7852e9a5
commit cc2dc227db
4 changed files with 42 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

8
mps/manual/source/pool/ams.rst
View file

@ -183,16 +183,16 @@ AMS interface
takes three keyword arguments: :c:macro:`MPS_KEY_FORMAT` and
:c:macro:`MPS_KEY_CHAIN` are as described above, and
:c:macro:`MPS_KEY_POOL_DEBUG_OPTIONS` specifies the debugging
options. See :c:type:`mps_debug_option_s`.
options. See :c:type:`mps_pool_debug_option_s`.
.. deprecated:: starting with version 1.112.
When using :c:func:`mps_pool_create`, pass the format,
chain, and debugging options like this::
When using :c:func:`mps_pool_create`, pass the arguments like
this::
mps_res_t mps_pool_create(mps_pool_t *pool_o, mps_arena_t arena,
mps_class_t mps_class_ams_debug(),
mps_debug_option_s debug_option,
mps_pool_debug_option_s debug_option,
mps_fmt_t fmt,
mps_chain_t chain,
mps_bool_t support_ambiguous)

58
mps/manual/source/pool/intro.rst
View file

@ -100,35 +100,35 @@ it makes no sense to ask whether they may contain :term:`weak
references (1)`.
============================================= ===== ===== ===== ===== ===== ===== ===== ===== ===== =====
Property AMC AMCZ AMS AWL LO MFS MV MVFF MVT SNC
============================================= ===== ===== ===== ===== ===== ===== ===== ===== ===== =====
Supports :c:func:`mps_alloc`? no no no no no yes yes yes no no
Supports :c:func:`mps_free`? no no no no no yes yes yes yes no
Supports allocation points? yes yes yes yes yes no yes yes yes yes
Supports allocation frames? yes yes yes yes yes no no yes yes yes
Supports segregated allocation caches? no no no no no yes yes yes no no
Timing of collections? [2]_ auto auto auto auto auto --- --- --- --- ---
May contain references? [3]_ yes no yes yes no no no no no yes
May contain exact references? [4]_ yes --- yes yes --- --- --- --- --- yes
May contain ambiguous references? [4]_ no --- no no --- --- --- --- --- no
May contain weak references? [4]_ no --- no yes --- --- --- --- --- no
Allocations fixed or variable in size? var var var var var fixed var var var var
Alignment? [5]_ conf conf conf conf conf [6]_ [6]_ [7]_ [7]_ conf
Dependent objects? [8]_ no --- no yes --- --- --- --- --- no
May use remote references? [9]_ no --- no no --- --- --- --- --- no
Blocks are automatically managed? [10]_ yes yes yes yes yes no no no no no
Blocks are promoted between generations yes yes no no no --- --- --- --- ---
Blocks are manually managed? [10]_ no no no no no yes yes yes yes yes
Blocks are scanned? [11]_ yes no yes yes no no no no no yes
Blocks support base pointers only? [12]_ no no yes yes yes --- --- --- --- yes
Blocks support internal pointers? [12]_ yes yes no no no --- --- --- --- no
Blocks may be protected by barriers? yes no yes yes yes no no no no yes
Blocks may move? yes yes no no no no no no no no
Blocks may be finalized? yes yes yes yes yes no no no no no
Blocks must be formatted? [11]_ yes yes yes yes yes no no no no yes
Blocks may use :term:`in-band headers`? yes yes yes yes yes --- --- --- --- no
============================================= ===== ===== ===== ===== ===== ===== ===== ===== ===== =====
.. csv-table::
:header: "Property", ":ref:`AMC <pool-amc>`", ":ref:`AMCZ <pool-amcz>`", ":ref:`AMS <pool-ams>`", ":ref:`AWL <pool-awl>`", ":ref:`LO <pool-lo>`", ":ref:`MFS <pool-mfs>`", ":ref:`MV <pool-mv>`", ":ref:`MVFF <pool-mvff>`", ":ref:`MVT <pool-mvt>`", ":ref:`SNC <pool-snc>`"
:widths: 6, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1
Supports :c:func:`mps_alloc`?, no, no, no, no, no, yes, yes, yes, no, no
Supports :c:func:`mps_free`?, no, no, no, no, no, yes, yes, yes, yes, no
Supports allocation points?, yes, yes, yes, yes, yes, no, yes, yes, yes, yes
Supports allocation frames?, yes, yes, yes, yes, yes, no, no, yes, yes, yes
Supports segregated allocation caches?, no, no, no, no, no, yes, yes, yes, no, no
Timing of collections? [2]_, auto, auto, auto, auto, auto, ---, ---, ---, ---, ---
May contain references? [3]_, yes, no, yes, yes, no, no, no, no, no, yes
May contain exact references? [4]_, yes, ---, yes, yes, ---, ---, ---, ---, ---, yes
May contain ambiguous references? [4]_, no, ---, no, no, ---, ---, ---, ---, ---, no
May contain weak references? [4]_, no, ---, no, yes, ---, ---, ---, ---, ---, no
Allocations fixed or variable in size?, var, var, var, var, var, fixed, var, var, var, var
Alignment? [5]_, conf, conf, conf, conf, conf, [6]_, [6]_, [7]_, [7]_, conf
Dependent objects? [8]_, no, ---, no, yes, ---, ---, ---, ---, ---, no
May use remote references? [9]_, no, ---, no, no, ---, ---, ---, ---, ---, no
Blocks are automatically managed? [10]_, yes, yes, yes, yes, yes, no, no, no, no, no
Blocks are promoted between generations, yes, yes, no, no, no, ---, ---, ---, ---, ---
Blocks are manually managed? [10]_, no, no, no, no, no, yes, yes, yes, yes, yes
Blocks are scanned? [11]_, yes, no, yes, yes, no, no, no, no, no, yes
Blocks support base pointers only? [12]_, no, no, yes, yes, yes, ---, ---, ---, ---, yes
Blocks support internal pointers? [12]_, yes, yes, no, no, no, ---, ---, ---, ---, no
Blocks may be protected by barriers?, yes, no, yes, yes, yes, no, no, no, no, yes
Blocks may move?, yes, yes, no, no, no, no, no, no, no, no
Blocks may be finalized?, yes, yes, yes, yes, yes, no, no, no, no, no
Blocks must be formatted? [11]_, yes, yes, yes, yes, yes, no, no, no, no, yes
Blocks may use :term:`in-band headers`?, yes, yes, yes, yes, yes, ---, ---, ---, ---, no
.. note::

9
mps/manual/source/pool/mv.rst
View file

@ -122,16 +122,17 @@ MV interface
takes four keyword arguments: :c:macro:`MPS_KEY_EXTEND_SIZE`,
:c:macro:`MPS_KEY_MEAN_SIZE`, :c:macro:`MPS_KEY_MAX_SIZE` are as
described above, and :c:macro:`MPS_KEY_POOL_DEBUG_OPTIONS`
specifies the debugging options. See :c:type:`mps_debug_option_s`.
specifies the debugging options. See
:c:type:`mps_pool_debug_option_s`.
.. deprecated:: starting with version 1.112.
When using :c:func:`mps_pool_create`, pass the debugging
options, segment size, mean size, and maximum size like this::
When using :c:func:`mps_pool_create`, pass the arguments like
this::
mps_res_t mps_pool_create(mps_pool_t *pool_o, mps_arena_t arena,
mps_class_t mps_class_mv_debug(),
mps_debug_option_s debug_option,
mps_pool_debug_option_s debug_option,
mps_size_t extend_size,
mps_size_t average_size,
mps_size_t maximum_size)

8
mps/manual/source/pool/mvff.rst
View file

@ -201,16 +201,16 @@ MVFF interface
:c:macro:`MPS_KEY_MVFF_SLOT_HIGH`, and
:c:macro:`MPS_KEY_MVFF_FIRST_FIT` are as described above, and
:c:macro:`MPS_KEY_POOL_DEBUG_OPTIONS` specifies the debugging
options. See :c:type:`mps_debug_option_s`.
options. See :c:type:`mps_pool_debug_option_s`.
.. deprecated:: starting with version 1.112.
When using :c:func:`mps_pool_create`, pass the debugging
options, and other arguments like this::
When using :c:func:`mps_pool_create`, pass the arguments like
this::
mps_res_t mps_pool_create(mps_pool_t *pool_o, mps_arena_t arena,
mps_class_t mps_class_mvff_debug(),
mps_debug_option_s debug_option,
mps_pool_debug_option_s debug_option,
size_t extend_size,
size_t average_size,
mps_align_t alignment,