[GHC] #11799: Legend for hpc markup colors

[GHC]

#11799: Legend for hpc markup colors
-------------------------------------+-------------------------------------
           Reporter:  drathier       |             Owner:
               Type:  feature        |            Status:  new
  request                            |
           Priority:  normal         |         Milestone:
          Component:  Test Suite     |           Version:  7.10.3
           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 hpc markup colors are not documented anywhere. Coming from an
 imperative background, red means never executed and green means executed
 at least once.

 Here, green means always true, red means always false, yellow means never
 executed.

 Adding a one-line legend at the top of the output file(s) describing the
 colours would help a lot. Suggesting `never executed` `always true` and
 `always false` on a single line at the top with the same yellow, green and
 red background as the respective highlighted code would have.

--
Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/11799>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler