Fix/clarify documentation in GHC.Stats
The following were not clear to me until I read the source:
numByteUsageSamples is (also) the number of major GCs performed.
currentBytesUsed is the number of live bytes at the end of the last major GC.
Is currentBytesSlop also at the end of the last major GC? Can't see that it's actually set to anything nonzero anywhere...
The comments for cumulativeBytesUsed and parTotBytesCopied are in the wrong places.
Trac metadata
| Trac field | Value |
|---|---|
| Version | 8.1 |
| Type | Task |
| TypeOfFailure | OtherFailure |
| Priority | normal |
| Resolution | Unresolved |
| Component | Core Libraries |
| Test case | |
| Differential revisions | |
| BlockedBy | |
| Related | |
| Blocking | |
| CC | ekmett |
| Operating system | |
| Architecture |