From 46613ccecdd18aa7c09345038725c637470fdedb Mon Sep 17 00:00:00 2001 From: Matthew Flatt Date: Sun, 10 Apr 2011 16:08:43 -0600 Subject: [PATCH] document scheme_malloc_stubborn which is obsolete by referenced by the docs for `malloc' --- collects/scribblings/inside/memory.scrbl | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/collects/scribblings/inside/memory.scrbl b/collects/scribblings/inside/memory.scrbl index 095acfcfae..d96e0c89df 100644 --- a/collects/scribblings/inside/memory.scrbl +++ b/collects/scribblings/inside/memory.scrbl @@ -663,6 +663,22 @@ Like @cpp{scheme_malloc}, but in 3m, the object never moves, and pointers are al Like @cpp{scheme_malloc_atomic}, but in 3m, the object never moves, and pointers are allowed to reference the middle of the object; see @secref["im:memoryalloc"].} +@function[(void* scheme_malloc_stubborn + [size_t n])]{ + +An obsolete variant of @cpp{scheme_malloc}, where + @cpp{scheme_end_stubborn_change} can be called on the allocated + pointer when no further changes will be made to the allocated + memory. Stubborn allocation is potentially useful as a hint for + generational collection, but the hint is normally ignored and unlikely + to be used more in future version.} + +@function[(void* scheme_end_stubborn_change + [void* p])]{ + +Declares the end of changes to the memory at @var{p} as allocated via +@cpp{scheme_malloc_stubborn}.} + @function[(char* scheme_strdup [char* str])]{