diff options
| author | Moritz Angermann <moritz.angermann@gmail.com> | 2017-02-28 11:08:55 -0500 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2017-02-28 15:43:38 -0500 |
| commit | aa2143e0541908c6e168ae326e89216c49593d29 (patch) | |
| tree | d24e18d3c67b094c7f95bf2147a75ef9e24f2126 | |
| parent | 23aca13255729a4649a800bbc36dc61e0816a05e (diff) | |
| download | haskell-aa2143e0541908c6e168ae326e89216c49593d29.tar.gz | |
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
| -rw-r--r-- | libraries/ghci/GHCi/Message.hs | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/libraries/ghci/GHCi/Message.hs b/libraries/ghci/GHCi/Message.hs index 80a495f9f4..37db0627e1 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 |