[commit: ghc] master: Add a comment about stack checks (081ef2f)

[git at git.haskell.org]

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

On branch  : master
Link       : http://ghc.haskell.org/trac/ghc/changeset/081ef2fb351831081bf6851fd3907679b1b98405/ghc

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

commit 081ef2fb351831081bf6851fd3907679b1b98405
Author: Simon Marlow <marlowsd at gmail.com>
Date:   Tue Nov 4 21:32:26 2014 +0000

    Add a comment about stack checks


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

081ef2fb351831081bf6851fd3907679b1b98405
 rts/StgMiscClosures.cmm | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/rts/StgMiscClosures.cmm b/rts/StgMiscClosures.cmm
index 42ef39e..f57fc04 100644
--- a/rts/StgMiscClosures.cmm
+++ b/rts/StgMiscClosures.cmm
@@ -199,6 +199,8 @@ INFO_TABLE_FUN( stg_BCO, 4, 0, BCO, "BCO", "BCO", ARG_BCO )
 {
   /* entering a BCO means "apply it", same as a function */
   Sp_adj(-2);
+  // Skip the stack check; the interpreter will do one before using
+  // the stack anyway.
   Sp(1) = R1;
   Sp(0) = stg_apply_interp_info;
   jump stg_yield_to_interpreter [];