[commit: ghc] ghc-8.0: Fix GHC.Stats documentation markup (#11619) (05e83aa)

git at git.haskell.org git at git.haskell.org
Sat Feb 27 14:39:51 UTC 2016


Repository : ssh://git@git.haskell.org/ghc

On branch  : ghc-8.0
Link       : http://ghc.haskell.org/trac/ghc/changeset/05e83aacf3e16adc22452a8247c89b80c976517c/ghc

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

commit 05e83aacf3e16adc22452a8247c89b80c976517c
Author: Thomas Miedema <thomasmiedema at gmail.com>
Date:   Sun Feb 21 18:31:00 2016 +0100

    Fix GHC.Stats documentation markup (#11619)
    
    (cherry picked from commit bb9cd45498b36be1624fbdccb4999bb45a776b4f)


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

05e83aacf3e16adc22452a8247c89b80c976517c
 libraries/base/GHC/Stats.hsc | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/libraries/base/GHC/Stats.hsc b/libraries/base/GHC/Stats.hsc
index 7bcc221..0e501da 100644
--- a/libraries/base/GHC/Stats.hsc
+++ b/libraries/base/GHC/Stats.hsc
@@ -47,6 +47,7 @@ data GCStats = GCStats
     , numGcs :: !Int64 -- ^ Number of garbage collections performed
     , maxBytesUsed :: !Int64 -- ^ Maximum number of live bytes seen so far
     , numByteUsageSamples :: !Int64 -- ^ Number of byte usage samples taken
+
     -- | Sum of all byte usage samples, can be used with
     -- 'numByteUsageSamples' to calculate averages with
     -- arbitrary weighting (if you are sampling this record multiple
@@ -57,9 +58,11 @@ data GCStats = GCStats
     , currentBytesSlop :: !Int64 -- ^ Current number of bytes lost to slop
     , maxBytesSlop :: !Int64 -- ^ Maximum number of bytes lost to slop at any one time so far
     , peakMegabytesAllocated :: !Int64 -- ^ Maximum number of megabytes allocated
+
     -- | CPU time spent running mutator threads.  This does not include
     -- any profiling overhead or initialization.
     , mutatorCpuSeconds :: !Double
+
     -- | Wall clock time spent running mutator threads.  This does not
     -- include initialization.
     , mutatorWallSeconds :: !Double
@@ -67,11 +70,13 @@ data GCStats = GCStats
     , gcWallSeconds :: !Double -- ^ Wall clock time spent running GC
     , cpuSeconds :: !Double -- ^ Total CPU time elapsed since program start
     , wallSeconds :: !Double -- ^ Total wall clock time elapsed since start
+
     -- | Number of bytes copied during GC, minus space held by mutable
     -- lists held by the capabilities.  Can be used with
     -- 'parMaxBytesCopied' to determine how well parallel GC utilized
     -- all cores.
     , parTotBytesCopied :: !Int64
+
     -- | Sum of number of bytes copied each GC by the most active GC
     -- thread each GC.  The ratio of 'parTotBytesCopied' divided by
     -- 'parMaxBytesCopied' approaches 1 for a maximally sequential



More information about the ghc-commits mailing list