X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=includes%2Fstg%2FRegs.h;h=d620bf1466238ff611bf15020ed9d597947f14f0;hp=fb26254d5a54d7769cf56b5afa05a6d75b78123a;hb=d20d32d788e2d6c088e6b03776c428df5bb004d3;hpb=f871cf1bf889704a4ec1f0063ad4d96f31453ea3

diff --git a/includes/stg/Regs.h b/includes/stg/Regs.h
index fb26254..d620bf1 100644
--- a/includes/stg/Regs.h
+++ b/includes/stg/Regs.h
@@ -1,9 +1,20 @@
 /* -----------------------------------------------------------------------------
  *
- * (c) The GHC Team, 1998-2004
+ * (c) The GHC Team, 1998-2009
  *
  * Registers in the STG machine.
  *
+ * Do not #include this file directly: #include "Rts.h" instead.
+ *
+ * To understand the structure of the RTS headers, see the wiki:
+ *   http://hackage.haskell.org/trac/ghc/wiki/Commentary/SourceTree/Includes
+ *
+ * ---------------------------------------------------------------------------*/
+
+#ifndef REGS_H
+#define REGS_H
+
+/*
  * The STG machine has a collection of "registers", each one of which
  * may or may not correspond to an actual machine register when
  * running code.  
@@ -17,10 +28,7 @@
  * BaseReg is not in a machine register, then the register table is
  * used from an absolute location (MainCapability).
  *
- * ---------------------------------------------------------------------------*/
-
-#ifndef REGS_H
-#define REGS_H
+ */
 
 typedef struct {
   StgWord        stgEagerBlackholeInfo;