summaryrefslogtreecommitdiff
path: root/includes/rts/Threads.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/rts/Threads.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/rts/Threads.h')
-rw-r--r--includes/rts/Threads.h5
1 files changed, 5 insertions, 0 deletions
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