[GHC] #8491: Make BlockAlloc.c comments slightly more accurate

[GHC]

#8491: Make BlockAlloc.c comments slightly more accurate
------------------------------------+-------------------------------------
       Reporter:  ezyang            |             Owner:
           Type:  bug               |            Status:  new
       Priority:  normal            |         Milestone:
      Component:  Compiler          |           Version:  7.6.3
       Keywords:                    |  Operating System:  Unknown/Multiple
   Architecture:  Unknown/Multiple  |   Type of failure:  None/Unknown
     Difficulty:  Unknown           |         Test Case:
     Blocked By:                    |          Blocking:
Related Tickets:                    |
------------------------------------+-------------------------------------
 I think this patch makes the comments for BlockAlloc slightly more
 accurate, but I'd like someone to double check for me.

 {{{
 diff --git a/rts/sm/BlockAlloc.c b/rts/sm/BlockAlloc.c
 index 18c167f..41a2279 100644
 --- a/rts/sm/BlockAlloc.c
 +++ b/rts/sm/BlockAlloc.c
 @@ -45,7 +45,7 @@ static void  initMBlock(void *mblock);
     bd->free is either:
        - zero for a non-group-head; bd->link points to the head
        - (-1) for the head of a free block group
 -      - or it points within the block
 +      - or it points within the block (group)

     bd->blocks is either:
        - zero for a non-group-head; bd->link points to the head
 }}}

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