summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--includes/rts/storage/ClosureMacros.h1
-rw-r--r--rts/ProfHeap.c1
-rw-r--r--rts/sm/Sanity.c1
-rw-r--r--rts/sm/Storage.c1
4 files changed, 4 insertions, 0 deletions
diff --git a/includes/rts/storage/ClosureMacros.h b/includes/rts/storage/ClosureMacros.h
index 17a0d5375b..c825d32d2b 100644
--- a/includes/rts/storage/ClosureMacros.h
+++ b/includes/rts/storage/ClosureMacros.h
@@ -475,6 +475,7 @@ INLINE_HEADER StgWord8 *mutArrPtrsCard (StgMutArrPtrs *a, W_ n)
overwritten.
Note [zeroing slop when overwriting closures]
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When we overwrite a closure in the heap with a smaller one, in some scenarios
we need to write zero words into "slop"; the memory that is left
diff --git a/rts/ProfHeap.c b/rts/ProfHeap.c
index 26f4de468d..8f7b65d7a4 100644
--- a/rts/ProfHeap.c
+++ b/rts/ProfHeap.c
@@ -1279,6 +1279,7 @@ heapCensusChain( Census *census, bdescr *bd )
/* skip over slop, see Note [slop on the heap] */
while (p < bd->free && !*p) p++;
/* Note [skipping slop in the heap profiler]
+ * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* We make sure to zero slop that can remain after a major GC so
* here we can assume any slop words we see until the block's free
diff --git a/rts/sm/Sanity.c b/rts/sm/Sanity.c
index 3ac926715a..ea64483418 100644
--- a/rts/sm/Sanity.c
+++ b/rts/sm/Sanity.c
@@ -797,6 +797,7 @@ static void checkGeneration (generation *gen,
#if defined(THREADED_RTS)
// Note [heap sanity checking with SMP]
+ // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
// heap sanity checking doesn't work with SMP for two reasons:
//
diff --git a/rts/sm/Storage.c b/rts/sm/Storage.c
index 554cb837c0..49c367fa8d 100644
--- a/rts/sm/Storage.c
+++ b/rts/sm/Storage.c
@@ -908,6 +908,7 @@ accountAllocation(Capability *cap, W_ n)
}
/* Note [slop on the heap]
+ * ~~~~~~~~~~~~~~~~~~~~~~~
*
* We use the term "slop" to refer to allocated memory on the heap which isn't
* occupied by any closure. Usually closures are packet tightly into the heap