oneof migration note

1 files changed, 15 insertions, 0 deletions

diff --git a/docs/migration.rst b/docs/migration.rst
index d6b32b5..4fe3b3e 100644
--- a/docs/migration.rst
+++ b/docs/migration.rst
@@ -13,7 +13,9 @@ are included, in order to make it easier to find this document.
 
 Nanopb-0.3.8 (2017-03-05)
 =========================
+
 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
@@ -24,6 +26,19 @@ would be put into an incorrect state.
 **Required actions:** Add error checking onto any call to
 *pb_close_string_substream*.
 
+Change oneof format in .pb.c files
+----------------------------------
+
+**Rationale:** Previously two oneofs in a single message would be erroneously
+handled as part of the same union.
+
+**Changes:** Oneofs fields now use special *PB_DATAOFFSET_UNION* offset type
+in generated .pb.c files to distinguish whether they are the first or following
+field inside an union.
+
+**Required actions:** Regenerate *.pb.c/.pb.h* files with new nanopb version if
+oneofs are used.
+
 Nanopb-0.3.5 (2016-02-13)
 =========================