summaryrefslogtreecommitdiff
path: root/compiler/prelude
diff options
context:
space:
mode:
authorBen Gamari <ben@smart-cactus.org>2018-09-26 16:03:44 -0400
committerBen Gamari <ben@smart-cactus.org>2018-10-01 11:52:43 -0400
commitd1577621519f7740a6cc9ecdebc70e3ba9098409 (patch)
tree01f698a17edb88bb2d8eac1d935d994c498474fa /compiler/prelude
parent99eb4595910f20c41734aa07a2da4db1f25512ae (diff)
downloadhaskell-d1577621519f7740a6cc9ecdebc70e3ba9098409.tar.gz
primops: Fix documentation of compactAllocateBlock#
Pointed out by @andrewthad.
Diffstat (limited to 'compiler/prelude')
-rw-r--r--compiler/prelude/primops.txt.pp8
1 files changed, 4 insertions, 4 deletions
diff --git a/compiler/prelude/primops.txt.pp b/compiler/prelude/primops.txt.pp
index 2f8ced7de8..9e14648c43 100644
--- a/compiler/prelude/primops.txt.pp
+++ b/compiler/prelude/primops.txt.pp
@@ -2818,11 +2818,11 @@ primop CompactGetNextBlockOp "compactGetNextBlock#" GenPrimOp
primop CompactAllocateBlockOp "compactAllocateBlock#" GenPrimOp
Word# -> Addr# -> State# RealWorld -> (# State# RealWorld, Addr# #)
{ Attempt to allocate a compact block with the given size (in
- bytes) at the given address. The first argument is a hint to
- the allocator, allocation might be satisfied at a different
- address (which is returned).
+ bytes, given by the first argument). The {\texttt Addr\#} is a pointer to
+ previous block of the compact or {\texttt nullAddr\#} to create a new compact.
+
The resulting block is not known to the GC until
- compactFixupPointers# is called on it, and care must be taken
+ {\texttt compactFixupPointers\#} is called on it, and care must be taken
so that the address does not escape or memory will be leaked.
}
with