[commit: ghc] wip/T16197: Documentation for StgRetFun (6aaa065)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/ghc

On branch  : wip/T16197
Link       : http://ghc.haskell.org/trac/ghc/changeset/6aaa0655a721605740f23e49c5b4bf6165bfe865/ghc

>---------------------------------------------------------------

commit 6aaa0655a721605740f23e49c5b4bf6165bfe865
Author: Ömer Sinan Ağacan <omeragacan at gmail.com>
Date:   Wed Jan 16 09:47:35 2019 +0300

    Documentation for StgRetFun


>---------------------------------------------------------------

6aaa0655a721605740f23e49c5b4bf6165bfe865
 includes/rts/storage/Closures.h | 3 +++
 utils/genapply/Main.hs          | 2 +-
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/includes/rts/storage/Closures.h b/includes/rts/storage/Closures.h
index 7db67c7..3e90306 100644
--- a/includes/rts/storage/Closures.h
+++ b/includes/rts/storage/Closures.h
@@ -260,6 +260,9 @@ typedef struct {
  * info table describes the pointerhood of the arguments).
  *
  * The stack frame size is also cached in the frame for convenience.
+ *
+ * The only RET_FUN is stg_gc_fun, which is created by __stg_gc_fun,
+ * both in HeapStackCheck.cmm.
  */
 typedef struct {
     const StgInfoTable* info;
diff --git a/utils/genapply/Main.hs b/utils/genapply/Main.hs
index 71b84fd..7038dc5 100644
--- a/utils/genapply/Main.hs
+++ b/utils/genapply/Main.hs
@@ -903,7 +903,7 @@ genStackApply regstatus args =
 --
 -- These code fragments are used to save registers on the stack at a heap
 -- check failure in the entry code for a function.  We also have to save R1
--- and the return address (stg_gc_fun_info) on the stack.  See stg_gc_fun_gen
+-- and the return address (stg_gc_fun_info) on the stack.  See __stg_gc_fun
 -- in HeapStackCheck.cmm for more details.
 
 mkStackSaveEntryLabel :: [ArgRep] -> Doc