X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Fmigration.rst;h=d5ded6431d63c76b3bab2bbdc483d300c70740bb;hb=8d12fecc7e4fb6899eb0d013abe0d6a5e03447ce;hp=67f97b341d24f0fc5118fe7ed71981cdfba09d84;hpb=e60dee698a617882659c84624d6a63d7941c4624;p=apps%2Fagl-service-can-low-level.git diff --git a/docs/migration.rst b/docs/migration.rst index 67f97b34..d5ded643 100644 --- a/docs/migration.rst +++ b/docs/migration.rst @@ -11,6 +11,25 @@ are included, in order to make it easier to find this document. .. contents :: +Nanopb-0.3.2 (2015-01-xx) +========================= + +Add support for OneOfs +---------------------- +**Rationale:** Previously nanopb did not support the *oneof* construct in +*.proto* files. Those fields were generated as regular *optional* fields. + +**Changes:** OneOfs are now generated as C unions. Callback fields are not +supported inside oneof and generator gives an error. + +**Required actions:** The generator option *no_unions* can be used to restore old +behaviour and to allow callbacks to be used. To use unions, one change is +needed: use *which_xxxx* field to detect which field is present, instead +of *has_xxxx*. Compare the value against *MyStruct_myfield_tag*. + +**Error indications:** Generator error: "Callback fields inside of oneof are +not supported". Compiler error: "Message" has no member named "has_xxxx". + Nanopb-0.3.0 (2014-08-26) ========================= @@ -151,12 +170,12 @@ Callback function signature as *void\**. This allowed passing of any data, but made it unnecessarily complex to return a pointer from callback. -**Changes:** The callback function parameter was changed to *void\**. +**Changes:** The callback function parameter was changed to *void\*\**. **Required actions:** You can continue using the old callback style by defining *PB_OLD_CALLBACK_STYLE*. Recommended action is to: - * Change the callback signatures to contain *void\** for decoders and + * Change the callback signatures to contain *void\*\** for decoders and *void \* const \** for encoders. * Change the callback function body to use *\*arg* instead of *arg*.