[GHC] #8864: Document heap allocation functions in StgCmmMonad/StgCmmLayout

[GHC]

#8864: Document heap allocation functions in StgCmmMonad/StgCmmLayout
-------------------------------------+------------------------------------
        Reporter:  tibbe             |            Owner:
            Type:  feature request   |           Status:  new
        Priority:  normal            |        Milestone:
       Component:  Documentation     |          Version:  7.6.3
      Resolution:                    |         Keywords:
Operating System:  Unknown/Multiple  |     Architecture:  Unknown/Multiple
 Type of failure:  None/Unknown      |       Difficulty:  Unknown
       Test Case:                    |       Blocked By:
        Blocking:                    |  Related Tickets:
-------------------------------------+------------------------------------

Comment (by tibbe):

 Another question to help the documentation effort along: which functions
 change the real `Hp`? Knowing that would allow the programmer to reason
 about how long the value (a `CmmExpr`) returned by `getHpRelOffset` is
 valid.

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