[commit: base] master: Document that -T RTS flag is necessary. (8020e1e)

[Edward Z. Yang]

Repository : ssh://darcs.haskell.org//srv/darcs/packages/base

On branch  : master

http://hackage.haskell.org/trac/ghc/changeset/8020e1e5eba5acf52af3b055422f93a738f95740

>---------------------------------------------------------------

commit 8020e1e5eba5acf52af3b055422f93a738f95740
Author: Edward Z. Yang <ezyang at mit.edu>
Date:   Fri Dec 16 14:50:40 2011 -0500

    Document that -T RTS flag is necessary.
    
    Signed-off-by: Edward Z. Yang <ezyang at mit.edu>

>---------------------------------------------------------------

 GHC/Stats.hsc |    8 ++++++++
 1 files changed, 8 insertions(+), 0 deletions(-)

diff --git a/GHC/Stats.hsc b/GHC/Stats.hsc
index 92b33e2..9be4331 100644
--- a/GHC/Stats.hsc
+++ b/GHC/Stats.hsc
@@ -4,6 +4,14 @@
 {-# LANGUAGE RecordWildCards #-}
 {-# OPTIONS_GHC -funbox-strict-fields #-}
 
+-----------------------------------------------------------------------------
+-- | This module provides access to internal garbage collection and
+-- memory usage statistics.  These statistics are not available unless
+-- a program is run with the @-T@ RTS flag.
+--
+-- This module is GHC-only and should not be considered portable.
+--
+-----------------------------------------------------------------------------
 module GHC.Stats
     ( GCStats(..)
     , getGCStats