mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-03-26 08:41:47 -07:00
Code Issues Projects Releases Wiki Activity

Remove duplicate documentation for mps_key_chain argument to ams.

Browse source 
Write "takes" instead of "requires" when documenting keyword arguments for debugging pool classes.

Copied from Perforce
 Change: 184540
 ServerID: perforce.ravenbrook.com
This commit is contained in:
Gareth Rees 2014-02-26 12:23:21 +00:00
parent 5fd80f897b
commit dcdd1d4840
3 changed files with 4 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -103,17 +103,13 @@ AMS interface
:term:`pool`.
When creating an AMS pool, :c:func:`mps_pool_create_k` requires
two :term:`keyword arguments`:
one :term:`keyword argument`:
* :c:macro:`MPS_KEY_FORMAT` (type :c:type:`mps_fmt_t`) specifies
the :term:`object format` for the objects allocated in the pool.
The format must provide a :term:`scan method` and a :term:`skip
method`.
* :c:macro:`MPS_KEY_CHAIN` (type :c:type:`mps_chain_t`) specifies
the :term:`generation chain` for the pool. It must have a single
generation.
It accepts three optional keyword arguments:
* :c:macro:`MPS_KEY_CHAIN` (type :c:type:`mps_chain_t`) specifies
@ -186,7 +182,7 @@ AMS interface
class.
When creating a debugging AMS pool, :c:func:`mps_pool_create_k`
requires three keyword arguments: :c:macro:`MPS_KEY_FORMAT` and
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`.

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

@ -118,7 +118,7 @@ MV interface
class.
When creating a debugging MV pool, :c:func:`mps_pool_create_k`
requires four keyword arguments: :c:macro:`MPS_KEY_EXTEND_SIZE`,
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`.

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

@ -195,7 +195,7 @@ MVFF interface
class.
When creating a debugging MVFF pool, :c:func:`mps_pool_create_k`
requires seven :term:`keyword arguments`.
takes seven :term:`keyword arguments`.
* :c:macro:`MPS_KEY_EXTEND_BY`, :c:macro:`MPS_KEY_MEAN_SIZE`,
:c:macro:`MPS_KEY_ALIGN`, :c:macro:`MPS_KEY_MVFF_ARENA_HIGH`,