From ecff19832ba3da633004316fa71ddaba20c6ffde Mon Sep 17 00:00:00 2001 From: Richard Brooksby Date: Fri, 5 Feb 2016 12:10:03 +0000 Subject: [PATCH] Using "cold end" rather than "bottom" of the stack, to avoid ambiguity. Copied from Perforce Change: 189106 ServerID: perforce.ravenbrook.com --- mps/manual/source/topic/root.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/mps/manual/source/topic/root.rst b/mps/manual/source/topic/root.rst index e120aa7e925..71258c3f64f 100644 --- a/mps/manual/source/topic/root.rst +++ b/mps/manual/source/topic/root.rst @@ -148,12 +148,13 @@ Every thread's :term:`registers` and :term:`control stack` potentially contain references to allocated objects, so should be registered as a root by calling :c:func:`mps_root_create_stack`. -The MPS's stack scanner needs to know how to find the bottom of the -part of the stack to scan. The bottom 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. +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. .. index:: single: Scheme; thread root