[commit: ghc] master: Improve documentation for CreateBCOs Message. (aa2143e)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/ghc

On branch  : master
Link       : http://ghc.haskell.org/trac/ghc/changeset/aa2143e0541908c6e168ae326e89216c49593d29/ghc

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

commit aa2143e0541908c6e168ae326e89216c49593d29
Author: Moritz Angermann <moritz.angermann at gmail.com>
Date:   Tue Feb 28 11:08:55 2017 -0500

    Improve documentation for CreateBCOs Message.
    
    After falling over the CreateBCOs message, and expecting it to contain
    ByteStrings encoding `ResolvedBCO`s instead of `[ResolvedBCO]`s, when
    deubbing issues with iserv, I'd like to extend the documentation here
    a bit, so the next one won't fall over it.
    
    Reviewers: simonmar, austin, rwbarton, bgamari
    
    Reviewed By: bgamari
    
    Subscribers: thomie
    
    Differential Revision: https://phabricator.haskell.org/D3234


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

aa2143e0541908c6e168ae326e89216c49593d29
 libraries/ghci/GHCi/Message.hs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/libraries/ghci/GHCi/Message.hs b/libraries/ghci/GHCi/Message.hs
index 80a495f..37db062 100644
--- a/libraries/ghci/GHCi/Message.hs
+++ b/libraries/ghci/GHCi/Message.hs
@@ -85,6 +85,9 @@ data Message a where
   -- Interpreter -------------------------------------------
 
   -- | Create a set of BCO objects, and return HValueRefs to them
+  -- Note: Each ByteString contains a Binary-encoded [ResolvedBCO], not
+  -- a ResolvedBCO. The list is to allow us to serialise the ResolvedBCOs
+  -- in parallel. See @createBCOs@ in compiler/ghci/GHCi.hsc.
   CreateBCOs :: [LB.ByteString] -> Message [HValueRef]
 
   -- | Release 'HValueRef's