[GHC] #11603: Fix/clarify documentation in GHC.Stats
#11603: Fix/clarify documentation in GHC.Stats -------------------------------------+------------------------------------- Reporter: dcturner | Owner: Type: task | Status: new Priority: normal | Milestone: Component: Core | Version: 8.1 Libraries | Keywords: | Operating System: Unknown/Multiple Architecture: | Type of failure: Documentation Unknown/Multiple | bug Test Case: | Blocked By: Blocking: | Related Tickets: Differential Rev(s): | Wiki Page: -------------------------------------+------------------------------------- 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. -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/11603> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#11603: Fix/clarify documentation in GHC.Stats -------------------------------------+------------------------------------- Reporter: dcturner | Owner: Type: task | Status: new Priority: normal | Milestone: Component: Core Libraries | Version: 8.1 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D1929 Wiki Page: | -------------------------------------+------------------------------------- Changes (by dcturner): * differential: => Phab:D1929 -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/11603#comment:1> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#11603: Fix/clarify documentation in GHC.Stats -------------------------------------+------------------------------------- Reporter: dcturner | Owner: Type: task | Status: patch Priority: normal | Milestone: 8.0.1 Component: Core Libraries | Version: 8.1 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D1929 Wiki Page: | -------------------------------------+------------------------------------- Changes (by bgamari): * status: new => patch * milestone: => 8.0.1 -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/11603#comment:2> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#11603: Fix/clarify documentation in GHC.Stats -------------------------------------+------------------------------------- Reporter: dcturner | Owner: Type: task | Status: patch Priority: normal | Milestone: 8.0.1 Component: Core Libraries | Version: 8.1 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D1929 Wiki Page: | -------------------------------------+------------------------------------- Comment (by bgamari): Thanks dcturner! -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/11603#comment:3> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#11603: Fix/clarify documentation in GHC.Stats -------------------------------------+------------------------------------- Reporter: dcturner | Owner: Type: task | Status: patch Priority: normal | Milestone: 8.0.1 Component: Core Libraries | Version: 8.1 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D1929 Wiki Page: | -------------------------------------+------------------------------------- Comment (by Ben Gamari <ben@…>): In [changeset:"8e19d3a3066b883d9bc10a75c8d3183907272a9f/ghc" 8e19d3a/ghc]: {{{ #!CommitTicketReference repository="ghc" revision="8e19d3a3066b883d9bc10a75c8d3183907272a9f" base: A selection of fixes to the comments in GHC.Stats Use `-- |` comments throughout. Note that numByteUsageSamples is also the number of major GCs Note that numGcs counts GCs for all generations Note that 'current' really means 'at the end of the last major GC' Reviewers: ezyang, hvr, simonmar, austin, bgamari Reviewed By: ezyang, simonmar, bgamari Subscribers: thomie Differential Revision: https://phabricator.haskell.org/D1929 GHC Trac Issues: #11603 }}} -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/11603#comment:4> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#11603: Fix/clarify documentation in GHC.Stats -------------------------------------+------------------------------------- Reporter: dcturner | Owner: Type: task | Status: merge Priority: normal | Milestone: 8.0.1 Component: Core Libraries | Version: 8.1 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D1929 Wiki Page: | -------------------------------------+------------------------------------- Changes (by bgamari): * status: patch => merge -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/11603#comment:5> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
#11603: Fix/clarify documentation in GHC.Stats -------------------------------------+------------------------------------- Reporter: dcturner | Owner: Type: task | Status: closed Priority: normal | Milestone: 8.0.1 Component: Core Libraries | Version: 8.1 Resolution: fixed | Keywords: Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D1929 Wiki Page: | -------------------------------------+------------------------------------- Changes (by bgamari): * status: merge => closed * resolution: => fixed Comment: Merged. -- Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/11603#comment:6> GHC <http://www.haskell.org/ghc/> The Glasgow Haskell Compiler
participants (1)
-
GHC