summaryrefslogtreecommitdiff
path: root/includes/Stg.h
diff options
context:
space:
mode:
authorSimon Marlow <marlowsd@gmail.com>2009-08-25 09:50:47 +0000
committerSimon Marlow <marlowsd@gmail.com>2009-08-25 09:50:47 +0000
commitd20d32d788e2d6c088e6b03776c428df5bb004d3 (patch)
tree5e2decf40aaf6777eec586a420f8183ee068501b /includes/Stg.h
parentf871cf1bf889704a4ec1f0063ad4d96f31453ea3 (diff)
downloadhaskell-d20d32d788e2d6c088e6b03776c428df5bb004d3.tar.gz
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.
Diffstat (limited to 'includes/Stg.h')
-rw-r--r--includes/Stg.h21
1 files changed, 12 insertions, 9 deletions
diff --git a/includes/Stg.h b/includes/Stg.h
index 0344b70fd2..b2051cbdd4 100644
--- a/includes/Stg.h
+++ b/includes/Stg.h
@@ -1,15 +1,12 @@
/* -----------------------------------------------------------------------------
*
- * (c) The GHC Team, 1998-2004
+ * (c) The GHC Team, 1998-2009
*
- * Top-level include file for everything STG-ish.
- *
- * This file is included *automatically* by all .hc files.
- *
- * NOTE: always include Stg.h *before* any other headers, because we
- * define some register variables which must be done before any inline
- * functions are defined (some system headers have been known to
- * define the odd inline function).
+ * Top-level include file for everything required when compiling .hc
+ * code. NOTE: in .hc files, Stg.h must be included *before* any
+ * other headers, because we define some register variables which must
+ * be done before any inline functions are defined (some system
+ * headers have been known to define the odd inline function).
*
* We generally try to keep as little visible as possible when
* compiling .hc files. So for example the definitions of the
@@ -18,6 +15,12 @@
* of these types to generate code which manipulates them directly
* with pointer arithmetic.
*
+ * In ordinary C 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 STG_H