rts: Add note reference to SET_PROF_HDR for profiling 'flip' bit
authorDaniel Gröber <dxld@darkboxed.org>
Thu, 20 Jun 2019 17:59:53 +0000 (19:59 +0200)
committerDaniel Gröber <dxld@darkboxed.org>
Sun, 22 Sep 2019 13:18:10 +0000 (15:18 +0200)
includes/rts/storage/ClosureMacros.h

index 6943200..a3873cc 100644 (file)
@@ -126,6 +126,8 @@ INLINE_HEADER StgHalfWord GET_TAG(const StgClosure *con)
  retainer profiling code will just set 'rs' to NULL upon visiting a closure with
  an invalid 'flip' bit anyways.
 
+ See Note [Profiling heap traversal visited bit] for details.
+
  [1]: Technically we should set 'rs' to `NULL | flip`.
  */
 #define SET_PROF_HDR(c,ccs_)            \