From 137c8f00a03ac196358ae89b32363ac11d912214 Mon Sep 17 00:00:00 2001 From: Richard Brooksby Date: Sat, 8 Jun 2013 13:30:06 +0100 Subject: [PATCH] Correcting statement that mvt doesn't accept an alignment. Using MPS_PF_ALIGN reference to describe the default value of MPS_KEY_ALIGN in MVT and MVFF. Copied from Perforce Change: 182623 ServerID: perforce.ravenbrook.com --- mps/manual/source/pool/mvff.rst | 2 +- mps/manual/source/pool/mvt.rst | 8 ++------ 2 files changed, 3 insertions(+), 7 deletions(-) diff --git a/mps/manual/source/pool/mvff.rst b/mps/manual/source/pool/mvff.rst index 4f105bffc28..1ceae617f2b 100644 --- a/mps/manual/source/pool/mvff.rst +++ b/mps/manual/source/pool/mvff.rst @@ -125,7 +125,7 @@ MVFF interface efficient if this is wrong, but nothing will break. * :c:macro:`MPS_KEY_ALIGN` (type :c:type:`mps_align_t`, default is - smallest general purpose alignment for the architecture) is the + :c:macro:`MPS_PF_ALIGN`) is the :term:`alignment` of addresses for allocation (and freeing) in the pool. If an unaligned size is passed to :c:func:`mps_alloc` or :c:func:`mps_free`, it will be rounded up to the pool's alignment. diff --git a/mps/manual/source/pool/mvt.rst b/mps/manual/source/pool/mvt.rst index fd56d1a299c..695538597c8 100644 --- a/mps/manual/source/pool/mvt.rst +++ b/mps/manual/source/pool/mvt.rst @@ -78,10 +78,6 @@ MVT properties * Allocations may be variable in size. -* The :term:`alignment` of blocks is not configurable: it is the - :term:`natural alignment` of the platform (see - :c:macro:`MPS_PF_ALIGN`). - * Blocks do not have :term:`dependent objects`. * Blocks are not automatically :term:`reclaimed`. @@ -116,7 +112,7 @@ MVT interface six :term:`keyword arguments`: * :c:macro:`MPS_KEY_ALIGN` (type :c:type:`mps_align_t`, default is - smallest general purpose alignment for the architecture) is the + :c:macro:`MPS_PF_ALIGN`) is the :term:`alignment` of addresses for allocation (and freeing) in the pool. If an unaligned size is passed to :c:func:`mps_alloc` or :c:func:`mps_free`, it will be rounded up to the pool's alignment. @@ -124,7 +120,7 @@ MVT interface ``sizeof(void *)``. * :c:macro:`MPS_KEY_MIN_SIZE` (type :c:type:`size_t`, default is - smallest general purpose alignment for the architecture) is the + :c:macro:`MPS_PF_ALIGN`) is the predicted minimum size of blocks that will be allocated from the pool.