[commit: base] master: Rename parAvgBytesCopied to parTotBytesCopied (ff2c4c4)

[Duncan Coutts]

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

On branch  : master

http://hackage.haskell.org/trac/ghc/changeset/ff2c4c41d1b2b0437ef27c663cf8cb998b290102

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

commit ff2c4c41d1b2b0437ef27c663cf8cb998b290102
Author: Mikolaj Konarski <mikolaj at well-typed.com>
Date:   Thu Mar 8 16:33:46 2012 +0100

    Rename parAvgBytesCopied to parTotBytesCopied
    
    This follows a change in GHC and ghc-events. The previous name was misleading.
    
    From commit "Change the presentation of parallel GC work balance in +RTS -s":
    
        Also rename internal variables to make the names match what they hold.
        The parallel GC work balance is calculated using the total amount of
        memory copied by all GC threads, and the maximum copied by any
        individual thread. You have serial GC when the max is the same as
        copied, and perfectly balanced GC when total/max == n_caps.

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

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

diff --git a/GHC/Stats.hsc b/GHC/Stats.hsc
index 9be4331..2020ddd 100644
--- a/GHC/Stats.hsc
+++ b/GHC/Stats.hsc
@@ -58,9 +58,9 @@ data GCStats = GCStats
     -- lists held by the capabilities.  Can be used with
     -- 'parMaxBytesCopied' to determine how well parallel GC utilized
     -- all cores.
-    , parAvgBytesCopied :: !Int64
+    , parTotBytesCopied :: !Int64
     -- | Sum of number of bytes copied each GC by the most active GC
-    -- thread each GC.  The ratio of 'parAvgBytesCopied' divided by
+    -- thread each GC.  The ratio of 'parTotBytesCopied' divided by
     -- 'parMaxBytesCopied' approaches 1 for a maximally sequential
     -- run and approaches the number of threads (set by the RTS flag
     -- @-N@) for a maximally parallel run.
@@ -98,7 +98,7 @@ getGCStats = allocaBytes (#size GCStats) $ \p -> do
     gcWallSeconds <- (# peek GCStats, gc_wall_seconds) p
     cpuSeconds <- (# peek GCStats, cpu_seconds) p
     wallSeconds <- (# peek GCStats, wall_seconds) p
-    parAvgBytesCopied <- (# peek GCStats, par_avg_bytes_copied) p
+    parTotBytesCopied <- (# peek GCStats, par_tot_bytes_copied) p
     parMaxBytesCopied <- (# peek GCStats, par_max_bytes_copied) p
     return GCStats { .. }