Add note about non-incremental parsing of readHeader

haskell · Apr 8, 2017 · 53f2872 · 53f2872
1 parent d3a2789
commit 53f2872
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/GHC/RTS/Events/Incremental.hs b/src/GHC/RTS/Events/Incremental.hs
@@ -100,6 +100,9 @@ decodeEventLog = withHeader $ \header leftover ->
 
 -- | Read a header from a lazy bytestring and return the header and the
 -- leftover input for subsequent decoding.
+--
+-- Note that the input must contain a whole header in one go. If incremental
+-- parsing of a header is necessary, use 'decodeHeader' instead.
 readHeader :: BL.ByteString -> Either String (Header, BL.ByteString)
 readHeader = go $ Left decodeHeader
   where