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

Miscellaneous minor documentation improvements from review.

Browse source 
Copied from Perforce
 Change: 189529
 ServerID: perforce.ravenbrook.com
This commit is contained in:
Richard Brooksby 2016-03-02 10:06:04 +00:00
parent 4fa2d25ada
commit deb5d5b9af
2 changed files with 11 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

10
mps/manual/source/topic/root.rst
View file

@ -150,11 +150,11 @@ root by calling :c:func:`mps_root_create_thread`.
The MPS's stack scanner needs to know how to find the :term:`cold end`
of the part of the stack to scan. The :term:`cold end` of the relevant
part of stack can be found by taking the address of a local variable
in the function that calls the main work function of your thread. You
should take care to ensure that the work function is not inlined so
that the address is definitely in the stack frame below any potential
roots.
part of the stack can be found by taking the address of a local
variable in the function that calls the main work function of your
thread. You should take care to ensure that the work function is not
inlined so that the address is definitely in the stack frame below any
potential roots.
.. index::
single: Scheme; thread root

11
mps/manual/source/topic/scanning.rst
View file

@ -505,6 +505,7 @@ Fixing interface
.. index::
single: scanning; area scanners
single: area; scanning
.. _topic-scanning-area:
@ -512,8 +513,8 @@ Area scanners
-------------
An area scanner :term:`scans` an area of memory for
:term:`references <reference>`. Various functions in the MPS interface,
such as :c:func:`mps_root_create_thread_tagged`, accept area scanners as
:term:`references`. Various functions in the MPS interface, such as
:c:func:`mps_root_create_thread_tagged`, accept area scanners as
arguments so that the :term:`client program` can specify how to scan
special areas such as the :term:`control stack`.
@ -584,7 +585,7 @@ the scanners, found in ``scan.c`` in the MPS source code.
Scan an area of memory :term:`fixing <fix>` every word, but remove
tag bits before fixing references, and restore them afterwards.
``closure`` should point to an :c:type:`mps_scan_tag_s`. Expects
``closure`` must point to an :c:type:`mps_scan_tag_s`. Expects
``base`` and ``limit`` to be word-aligned.
For example, if ``mask`` is 0b111 (decimal 7), then this scanner
@ -600,7 +601,7 @@ the scanners, found in ``scan.c`` in the MPS source code.
.. c:function:: mps_res_t mps_scan_area_tagged(mps_ss_t ss, void *base, void *limit, void *closure)
Scan an area of memory :term:`fixing <fix>` only words whose
masked bits match a particular tag pattern. ``closure`` should
masked bits match a particular tag pattern. ``closure`` must
point to a :c:type:`mps_scan_tag_s`. Expects ``base`` and
``limit`` to be word-aligned.
@ -624,7 +625,7 @@ the scanners, found in ``scan.c`` in the MPS source code.
Scan an area of memory :term:`fixing <fix>` only words whose
masked bits are zero or match a particular tag pattern.
``closure`` should point to a :c:type:`mps_scan_tag_s`. Expects
``closure`` must point to a :c:type:`mps_scan_tag_s`. Expects
``base`` and ``limit`` to be word-aligned.
For example, if ``mask`` is 7 and ``pattern`` is 3, then this