Tidy up file headers and copyrights; point to the wiki for docs

I've updated the wiki page about the RTS headers
  http://hackage.haskell.org/trac/ghc/wiki/Commentary/SourceTree/Includes
to reflect the new layout and explain some of the rationale.  All the
header files now point to this page.

8 files changed, 74 insertions, 21 deletions

diff --git a/includes/stg/DLL.h b/includes/stg/DLL.h
index 5e824271bf..b7e7c5aaac 100644
--- a/includes/stg/DLL.h
+++ b/includes/stg/DLL.h
@@ -1,3 +1,16 @@
+/* -----------------------------------------------------------------------------
+ *
+ * (c) The GHC Team, 1998-2009
+ *
+ * Support for Windows DLLs.
+ *
+ * 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 __STGDLL_H__
 #define __STGDLL_H__ 1
 
diff --git a/includes/stg/MachRegs.h b/includes/stg/MachRegs.h
index d6075326db..cd9866671c 100644
--- a/includes/stg/MachRegs.h
+++ b/includes/stg/MachRegs.h
@@ -1,10 +1,15 @@
 /* -----------------------------------------------------------------------------
  *
- * (c) The GHC Team, 1998-1999
+ * (c) The GHC Team, 1998-2009
  *
  * Registers used in STG code.  Might or might not correspond to
  * actual machine registers.
  *
+ * 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 MACHREGS_H
diff --git a/includes/stg/MiscClosures.h b/includes/stg/MiscClosures.h
index 34bd95a550..031c74b45f 100644
--- a/includes/stg/MiscClosures.h
+++ b/includes/stg/MiscClosures.h
@@ -1,6 +1,6 @@
 /* ----------------------------------------------------------------------------
  *
- * (c) The GHC Team, 1998-2004
+ * (c) The GHC Team, 1998-2009
  *
  * Declarations for various symbols exported by the RTS.
  *
@@ -10,6 +10,11 @@
  *
  * See wiki:Commentary/Compiler/Backends/PprC#Prototypes
  *
+ * 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 STGMISCCLOSURES_H
diff --git a/includes/stg/Regs.h b/includes/stg/Regs.h
index fb26254d5a..d620bf1466 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;
diff --git a/includes/stg/SMP.h b/includes/stg/SMP.h
index 5d9d80169b..8297f5711c 100644
--- a/includes/stg/SMP.h
+++ b/includes/stg/SMP.h
@@ -1,9 +1,14 @@
 /* ----------------------------------------------------------------------------
  *
- * (c) The GHC Team, 2005-2008
+ * (c) The GHC Team, 2005-2009
  *
  * Macros for multi-CPU support
  *
+ * 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 SMP_H
diff --git a/includes/stg/TailCalls.h b/includes/stg/TailCalls.h
index 854c7b4b18..bffd39c674 100644
--- a/includes/stg/TailCalls.h
+++ b/includes/stg/TailCalls.h
@@ -1,9 +1,14 @@
 /* -----------------------------------------------------------------------------
  *
- * (c) The GHC Team, 1998-1999
+ * (c) The GHC Team, 1998-2009
  *
  * Stuff for implementing proper tail jumps.
  *
+ * 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 TAILCALLS_H
diff --git a/includes/stg/Ticky.h b/includes/stg/Ticky.h
index fd7edf85c5..001ab973f7 100644
--- a/includes/stg/Ticky.h
+++ b/includes/stg/Ticky.h
@@ -1,9 +1,14 @@
 /* -----------------------------------------------------------------------------
  *
- * (c) The GHC Team, 2007
+ * (c) The GHC Team, 2009
  *
  * Declarations for counters used by ticky-ticky profiling.
  *
+ * 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
+ *
  * -------------------------------------------------------------------------- */
 
 
diff --git a/includes/stg/Types.h b/includes/stg/Types.h
index 227356c9ea..e05690ac6e 100644
--- a/includes/stg/Types.h
+++ b/includes/stg/Types.h
@@ -5,6 +5,23 @@
  * Various C datatypes used in the run-time system.  This is the
  * lowest-level include file, after ghcconfig.h and RtsConfig.h.
  *
+ * 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
+ *
+ * NOTE: assumes #include "ghcconfig.h"
+ * 
+ * Works with or without _POSIX_SOURCE.
+ *
+ * WARNING: Keep this file, MachDeps.h, and HsFFI.h in synch!
+ *
+ * ---------------------------------------------------------------------------*/
+
+#ifndef STGTYPES_H
+#define STGTYPES_H
+
+/*
  * This module should define types *only*, all beginning with "Stg".
  *
  * Specifically:
@@ -22,17 +39,7 @@
 	StgBool, StgVoid, StgPtr, StgOffset, 
 	StgCode, StgStablePtr, StgFunPtr,
 	StgUnion.
-
- * WARNING: Keep this file, MachDeps.h, and HsFFI.h in synch!
- *
- * NOTE: assumes #include "ghcconfig.h"
- * 
- * Works with or without _POSIX_SOURCE.
- *
- * ---------------------------------------------------------------------------*/
-
-#ifndef STGTYPES_H
-#define STGTYPES_H
+ */
 
 /*
  * First, platform-dependent definitions of size-specific integers.