Improve documentation for CreateBCOs Message.
authorMoritz Angermann <moritz.angermann@gmail.com>
Tue, 28 Feb 2017 16:08:55 +0000 (11:08 -0500)
committerBen Gamari <ben@smart-cactus.org>
Tue, 28 Feb 2017 20:43:38 +0000 (15:43 -0500)
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

libraries/ghci/GHCi/Message.hs

index 80a495f..37db062 100644 (file)
@@ -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