From 31e09c6630c47d0aa1c1ec3909a936ba5674254f Mon Sep 17 00:00:00 2001 From: Tobba Date: Wed, 21 Dec 2016 21:02:53 +0100 Subject: Fix closing a non-empty substream resulting in an incorrect stream state --- docs/migration.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'docs') diff --git a/docs/migration.rst b/docs/migration.rst index cd5911f5..2d9ce38c 100644 --- a/docs/migration.rst +++ b/docs/migration.rst @@ -11,6 +11,19 @@ are included, in order to make it easier to find this document. .. contents :: +Nanopb-0.3.8 (2017-xx-xx) +========================= +Fully drain substreams before closing + +**Rationale:** If the substream functions were called directly and the caller +did not completely empty the substring before closing it, the parent stream +would be put into an incorrect state. + +**Changes:** *pb_close_string_substream* can now error and returns a boolean. + +**Required actions:** Add error checking onto any call to +*pb_close_string_substream*. + Nanopb-0.3.5 (2016-02-13) ========================= -- cgit 1.2.3-korg