aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard Brooksby2023-06-15 09:17:44 +0100
committerRichard Brooksby2023-06-15 09:17:44 +0100
commit537bfe8112d0c4050332a9cab20e881ec7d66edd (patch)
treef64d9cf0213ceb67faa19a6090f0ddc9e4670f92
parentbda0836c8182a21a1c916abc68b4bf13d6b506f5 (diff)
downloademacs-537bfe8112d0c4050332a9cab20e881ec7d66edd.tar.gz
emacs-537bfe8112d0c4050332a9cab20e881ec7d66edd.zip
Removing ambiguous use of "return" to mean passing back a value through an out argument, in response to review <https://github.com/ravenbrook/mps/pull/223#pullrequestreview-1432893665>.
-rw-r--r--mps/manual/source/topic/arena.rst6
1 files changed, 2 insertions, 4 deletions
diff --git a/mps/manual/source/topic/arena.rst b/mps/manual/source/topic/arena.rst
index 765a85a7a4f..77c24f26daf 100644
--- a/mps/manual/source/topic/arena.rst
+++ b/mps/manual/source/topic/arena.rst
@@ -1044,18 +1044,16 @@ Arena introspection and debugging
1044 1044
1045.. c:function:: mps_res_t mps_addr_object(mps_addr_t *p_o, mps_arena_t arena, mps_addr_t addr) 1045.. c:function:: mps_res_t mps_addr_object(mps_addr_t *p_o, mps_arena_t arena, mps_addr_t addr)
1046 1046
1047 Return the :term:`base pointer` of an :term:`object` if provided with an 1047 Find the :term:`base pointer` of an :term:`object` if provided with an
1048 :term:`interior pointer` to that object, or the object's base pointer, 1048 :term:`interior pointer` to that object, or the object's base pointer,
1049 provided the object exists in a pool that supports this feature. 1049 provided the object exists in a pool that supports this feature.
1050 1050
1051 ``p_o`` points to the :term:`address` to which the object's base pointer 1051 ``p_o`` points to a location that will hold the object's base pointer.
1052 should be returned.
1053 1052
1054 ``arena`` is an arena. 1053 ``arena`` is an arena.
1055 1054
1056 ``addr`` is an address that might be an interior or base pointer. 1055 ``addr`` is an address that might be an interior or base pointer.
1057 1056
1058
1059 Returns MPS_RES_OK if a base pointer to an object into which ``addr`` 1057 Returns MPS_RES_OK if a base pointer to an object into which ``addr``
1060 points was successfully returned. 1058 points was successfully returned.
1061 1059