summaryrefslogtreecommitdiff
path: root/includes/rts
diff options
context:
space:
mode:
Diffstat (limited to 'includes/rts')
-rw-r--r--includes/rts/Adjustor.h5
-rw-r--r--includes/rts/Bytecodes.h2
-rw-r--r--includes/rts/Config.h6
-rw-r--r--includes/rts/Constants.h5
-rw-r--r--includes/rts/FileLock.h7
-rw-r--r--includes/rts/Flags.h7
-rw-r--r--includes/rts/Globals.h5
-rw-r--r--includes/rts/Hooks.h7
-rw-r--r--includes/rts/Hpc.h5
-rw-r--r--includes/rts/IOManager.h5
-rw-r--r--includes/rts/Linker.h7
-rw-r--r--includes/rts/Messages.h7
-rw-r--r--includes/rts/OSThreads.h7
-rw-r--r--includes/rts/Parallel.h5
-rw-r--r--includes/rts/Signals.h5
-rw-r--r--includes/rts/SpinLock.h7
-rw-r--r--includes/rts/Stable.h7
-rw-r--r--includes/rts/TTY.h5
-rw-r--r--includes/rts/Threads.h5
-rw-r--r--includes/rts/Ticky.h5
-rw-r--r--includes/rts/Timer.h7
-rw-r--r--includes/rts/Types.h11
-rw-r--r--includes/rts/prof/CCS.h7
-rw-r--r--includes/rts/prof/LDV.h7
24 files changed, 127 insertions, 19 deletions
diff --git a/includes/rts/Adjustor.h b/includes/rts/Adjustor.h
index 71e15246c1..b65212d1c8 100644
--- a/includes/rts/Adjustor.h
+++ b/includes/rts/Adjustor.h
@@ -4,6 +4,11 @@
*
* Adjustor API
*
+ * 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 RTS_ADJUSTOR_H
diff --git a/includes/rts/Bytecodes.h b/includes/rts/Bytecodes.h
index 4aff907cfd..8764b180df 100644
--- a/includes/rts/Bytecodes.h
+++ b/includes/rts/Bytecodes.h
@@ -1,6 +1,6 @@
/* -----------------------------------------------------------------------------
*
- * (c) The GHC Team, 1998-2002
+ * (c) The GHC Team, 1998-2009
*
* Bytecode definitions.
*
diff --git a/includes/rts/Config.h b/includes/rts/Config.h
index ce332fa2a2..9e4d683857 100644
--- a/includes/rts/Config.h
+++ b/includes/rts/Config.h
@@ -1,12 +1,16 @@
/* -----------------------------------------------------------------------------
*
- * (c) The GHC Team, 1998-2004
+ * (c) The GHC Team, 1998-2009
*
* Rts settings.
*
* NOTE: assumes #include "ghcconfig.h"
*
* NB: THIS FILE IS INCLUDED IN NON-C CODE AND DATA! #defines only please.
+ *
+ * To understand the structure of the RTS headers, see the wiki:
+ * http://hackage.haskell.org/trac/ghc/wiki/Commentary/SourceTree/Includes
+ *
* ---------------------------------------------------------------------------*/
#ifndef RTS_CONFIG_H
diff --git a/includes/rts/Constants.h b/includes/rts/Constants.h
index b283befde2..071d094782 100644
--- a/includes/rts/Constants.h
+++ b/includes/rts/Constants.h
@@ -1,6 +1,6 @@
/* ----------------------------------------------------------------------------
*
- * (c) The GHC Team, 1998-2002
+ * (c) The GHC Team, 1998-2009
*
* Constants
*
@@ -12,6 +12,9 @@
* the system (eg. structure sizes) are generated into the file
* DerivedConstants.h by a C program (mkDerivedConstantsHdr).
*
+ * To understand the structure of the RTS headers, see the wiki:
+ * http://hackage.haskell.org/trac/ghc/wiki/Commentary/SourceTree/Includes
+ *
* -------------------------------------------------------------------------- */
#ifndef RTS_CONSTANTS_H
diff --git a/includes/rts/FileLock.h b/includes/rts/FileLock.h
index ab59173cef..17087db094 100644
--- a/includes/rts/FileLock.h
+++ b/includes/rts/FileLock.h
@@ -1,9 +1,14 @@
/* -----------------------------------------------------------------------------
*
- * (c) The GHC Team, 2007
+ * (c) The GHC Team, 2007-2009
*
* File locking support as required by Haskell 98
*
+ * 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 RTS_FILELOCK_H
diff --git a/includes/rts/Flags.h b/includes/rts/Flags.h
index 3f3a0a952f..dca727a1cd 100644
--- a/includes/rts/Flags.h
+++ b/includes/rts/Flags.h
@@ -1,9 +1,14 @@
/* -----------------------------------------------------------------------------
*
- * (c) The GHC Team, 1998-1999
+ * (c) The GHC Team, 1998-2009
*
* Datatypes that holds the command-line flag settings.
*
+ * 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 RTS_FLAGS_H
diff --git a/includes/rts/Globals.h b/includes/rts/Globals.h
index 71846e75a1..85d0acd4bd 100644
--- a/includes/rts/Globals.h
+++ b/includes/rts/Globals.h
@@ -7,6 +7,11 @@
* even when multiple versions of the library are loaded. e.g. see
* Data.Typeable and GHC.Conc.
*
+ * 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 RTS_GLOBALS_H
diff --git a/includes/rts/Hooks.h b/includes/rts/Hooks.h
index 4fe50b4b9f..f878dc6e10 100644
--- a/includes/rts/Hooks.h
+++ b/includes/rts/Hooks.h
@@ -1,9 +1,14 @@
/* -----------------------------------------------------------------------------
*
- * (c) The GHC Team, 1998-1999
+ * (c) The GHC Team, 1998-2009
*
* User-overridable RTS hooks.
*
+ * 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 RTS_HOOKS_H
diff --git a/includes/rts/Hpc.h b/includes/rts/Hpc.h
index c966e32cd9..26da35d4cd 100644
--- a/includes/rts/Hpc.h
+++ b/includes/rts/Hpc.h
@@ -4,6 +4,11 @@
*
* Haskell Program Coverage
*
+ * 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 RTS_HPC_H
diff --git a/includes/rts/IOManager.h b/includes/rts/IOManager.h
index 1c269ada6d..ef89f27a30 100644
--- a/includes/rts/IOManager.h
+++ b/includes/rts/IOManager.h
@@ -4,6 +4,11 @@
*
* IO Manager functionality in the RTS
*
+ * 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 RTS_IOMANAGER_H
diff --git a/includes/rts/Linker.h b/includes/rts/Linker.h
index df74e7eeb8..73d18cadbe 100644
--- a/includes/rts/Linker.h
+++ b/includes/rts/Linker.h
@@ -1,9 +1,14 @@
/* -----------------------------------------------------------------------------
*
- * (c) The GHC Team, 2000
+ * (c) The GHC Team, 2009
*
* RTS Object Linker
*
+ * 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 RTS_LINKER_H
diff --git a/includes/rts/Messages.h b/includes/rts/Messages.h
index e01eff47cf..6f59d1dc3e 100644
--- a/includes/rts/Messages.h
+++ b/includes/rts/Messages.h
@@ -1,12 +1,17 @@
/* -----------------------------------------------------------------------------
*
- * (c) The GHC Team, 1998-2004
+ * (c) The GHC Team, 1998-2009
*
* Message API for use inside the RTS. All messages generated by the
* RTS should go through one of the functions declared here, and we
* also provide hooks so that messages from the RTS can be redirected
* as appropriate.
*
+ * 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 RTS_MESSAGES_H
diff --git a/includes/rts/OSThreads.h b/includes/rts/OSThreads.h
index 2d32136379..106e1e7e9f 100644
--- a/includes/rts/OSThreads.h
+++ b/includes/rts/OSThreads.h
@@ -1,10 +1,15 @@
/* ---------------------------------------------------------------------------
*
- * (c) The GHC Team, 2001-2005
+ * (c) The GHC Team, 2001-2009
*
* Accessing OS threads functionality in a (mostly) OS-independent
* manner.
*
+ * 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 RTS_OSTHREADS_H
diff --git a/includes/rts/Parallel.h b/includes/rts/Parallel.h
index b6759819b1..f2b56469e7 100644
--- a/includes/rts/Parallel.h
+++ b/includes/rts/Parallel.h
@@ -4,6 +4,11 @@
*
* Parallelism-related functionality
*
+ * 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 RTS_PARALLEL_H
diff --git a/includes/rts/Signals.h b/includes/rts/Signals.h
index 8d9e0fd4b7..4bdd68c06f 100644
--- a/includes/rts/Signals.h
+++ b/includes/rts/Signals.h
@@ -4,6 +4,11 @@
*
* RTS signal handling
*
+ * 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 RTS_SIGNALS_H
diff --git a/includes/rts/SpinLock.h b/includes/rts/SpinLock.h
index ea992a3457..9bfb35bbac 100644
--- a/includes/rts/SpinLock.h
+++ b/includes/rts/SpinLock.h
@@ -1,6 +1,6 @@
/* ----------------------------------------------------------------------------
*
- * (c) The GHC Team, 2006-2008
+ * (c) The GHC Team, 2006-2009
*
* Spin locks
*
@@ -12,6 +12,11 @@
* TODO: measure whether we really need these, or whether Mutexes
* would do (and be a bit safer if a CPU becomes loaded).
*
+ * 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 RTS_SPINLOCK_H
diff --git a/includes/rts/Stable.h b/includes/rts/Stable.h
index 95a3f96156..ec867e486c 100644
--- a/includes/rts/Stable.h
+++ b/includes/rts/Stable.h
@@ -1,9 +1,14 @@
/* -----------------------------------------------------------------------------
*
- * (c) The GHC Team, 1998-2004
+ * (c) The GHC Team, 1998-2009
*
* Stable Pointers
*
+ * 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 RTS_STABLE_H
diff --git a/includes/rts/TTY.h b/includes/rts/TTY.h
index f1ef62eef6..647d88b118 100644
--- a/includes/rts/TTY.h
+++ b/includes/rts/TTY.h
@@ -4,6 +4,11 @@
*
* POSIX TTY-related functionality
*
+ * 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 RTS_TTY_H
diff --git a/includes/rts/Threads.h b/includes/rts/Threads.h
index 4f343b804c..ca3e8b2da0 100644
--- a/includes/rts/Threads.h
+++ b/includes/rts/Threads.h
@@ -5,6 +5,11 @@
* External API for the scheduler. For most uses, the functions in
* RtsAPI.h should be enough.
*
+ * 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 RTS_THREADS_H
diff --git a/includes/rts/Ticky.h b/includes/rts/Ticky.h
index d7e09fcd22..f46e802577 100644
--- a/includes/rts/Ticky.h
+++ b/includes/rts/Ticky.h
@@ -4,6 +4,11 @@
*
* TICKY_TICKY types
*
+ * 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 RTS_TICKY_H
diff --git a/includes/rts/Timer.h b/includes/rts/Timer.h
index e3a5c2dc69..39edeb2937 100644
--- a/includes/rts/Timer.h
+++ b/includes/rts/Timer.h
@@ -1,9 +1,14 @@
/* -----------------------------------------------------------------------------
*
- * (c) The GHC Team, 1995-2006
+ * (c) The GHC Team, 1995-2009
*
* Interface to the RTS timer signal (uses OS-dependent Ticker.h underneath)
*
+ * 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 RTS_TIMER_H
diff --git a/includes/rts/Types.h b/includes/rts/Types.h
index 6f399e083d..ff78402584 100644
--- a/includes/rts/Types.h
+++ b/includes/rts/Types.h
@@ -1,15 +1,16 @@
/* -----------------------------------------------------------------------------
*
- * (c) The GHC Team, 1998-2008
+ * (c) The GHC Team, 1998-2009
*
* RTS-specific types.
*
+ * 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
+ *
* ---------------------------------------------------------------------------*/
-/* -------------------------------------------------------------------------
- Generally useful typedefs
- ------------------------------------------------------------------------- */
-
#ifndef RTS_TYPES_H
#define RTS_TYPES_H
diff --git a/includes/rts/prof/CCS.h b/includes/rts/prof/CCS.h
index d56caf0be4..90224d72a0 100644
--- a/includes/rts/prof/CCS.h
+++ b/includes/rts/prof/CCS.h
@@ -1,9 +1,14 @@
/* -----------------------------------------------------------------------------
*
- * (c) The GHC Team, 2004
+ * (c) The GHC Team, 2009
*
* Macros for profiling operations in STG code
*
+ * 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 RTS_PROF_CCS_H
diff --git a/includes/rts/prof/LDV.h b/includes/rts/prof/LDV.h
index f54724652d..77d873cceb 100644
--- a/includes/rts/prof/LDV.h
+++ b/includes/rts/prof/LDV.h
@@ -1,9 +1,14 @@
/* -----------------------------------------------------------------------------
*
- * (c) The University of Glasgow, 2004
+ * (c) The University of Glasgow, 2009
*
* Lag/Drag/Void 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
+ *
* ---------------------------------------------------------------------------*/
#ifndef RTS_PROF_LDV_H