[GHC] #11619: GHC.Stats documentation error
GHC
ghc-devs at haskell.org
Sun Feb 21 07:42:09 UTC 2016
#11619: GHC.Stats documentation error
-------------------------------------+-------------------------------------
Reporter: orion | Owner:
Type: bug | Status: new
Priority: low | Milestone:
Component: | Version: 7.10.3
libraries/base |
Keywords: | Operating System: Unknown/Multiple
Architecture: | Type of failure: None/Unknown
Unknown/Multiple |
Test Case: | Blocked By:
Blocking: | Related Tickets:
Differential Rev(s): | Wiki Page:
-------------------------------------+-------------------------------------
The [https://hackage.haskell.org/package/base-4.8.2.0/docs/GHC-
Stats.html#t:GCStats documentation] for GCStats is not formatted properly:
{{{
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 times).
}}}
{{{
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.
}}}
--
Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/11619>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler
More information about the ghc-tickets
mailing list