Skip to content

Commit

Permalink
Fix GHC.Stats documentation markup (#11619)
Browse files Browse the repository at this point in the history
  • Loading branch information
thomie committed Feb 21, 2016
1 parent f451039 commit bb9cd45
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions libraries/base/GHC/Stats.hsc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -57,21 +58,25 @@ 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
, gcCpuSeconds :: !Double -- ^ CPU time spent running GC
, 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
Expand Down

0 comments on commit bb9cd45

Please sign in to comment.