aboutsummaryrefslogtreecommitdiffstats
path: root/docs/concepts.rst
AgeCommit message (Collapse)AuthorFilesLines
2016-09-02Fix typo in docs (thanks to @alecdavis)Petteri Aimonen1-1/+1
2016-08-06Fix formatting error in docsPetteri Aimonen1-1/+1
2016-08-04Add inline allocation of bytes fieldsTom Roeder1-1/+3
This commit adds a new FT_INLINE allocation type that forces bytes fields to be inlined into the struct. E.g., pb_byte_t my_bytes[32]. This requires max_size for the bytes field. The FT_INLINE type is represented as a new LTYPE: FT_LTYPE_FIXED_LENGTH_BYTES. This commit also updates the documentation with FT_INLINE and FT_LTYPE_FIXED_LENGTH_BYTES. Added an AUTHORS file in apparent order of appearance in the git log history from $(git log --all).
2016-05-05Added explanation of `oneof` section usageYaniv Mordekhay1-0/+55
2015-04-03Add basic docs for msgid functionalityPetteri Aimonen1-0/+19
2013-08-08Document field extensions supportPetteri Aimonen1-0/+44
Update issue 17 Status: FixedInGit
2013-07-06Document the .options file usage.Petteri Aimonen1-27/+20
Also add note about the 'packed' message option being incompatible with CPUs that do not support unaligned access. Update issue 12 Status: FixedInGit Update issue 77 Status: FixedInGit
2013-04-02Change the callback function to use void**.Petteri Aimonen1-5/+7
NOTE: This change breaks backwards-compatibility by default. If you have old callback functions, you can define PB_OLD_CALLBACK_STYLE to retain the old behaviour. If you want to convert your old callbacks to new signature, you need to do the following: 1) Change decode callback argument to void **arg and encode callback argument to void * const *arg. 2) Change any reference to arg into *arg. The rationale for making the new behaviour the default is that it simplifies the common case of "allocate some memory in decode callback". Update issue 69 Status: FixedInGit
2013-03-02Update documentationPetteri Aimonen1-12/+4
2012-10-29Document new generator optionsPetteri Aimonen1-0/+14
2012-10-18Remove the "buf = NULL" => skip requirement from pb_istream_t callbacks.Petteri Aimonen1-2/+1
Rationale: it's easy to implement the callback wrong. Doing so introduces io errors when unknown fields are present in the input. If code is not tested with unknown fields, these bugs can remain hidden for long time. Added a special case for the memory buffer stream, where it gives a small speed benefit. Added testcase for skipping fields with test_decode2 implementation. Update issue 37 Status: FixedInGit
2012-08-24Add note that stream callbacks must read the whole requested length.Petteri Aimonen1-0/+1
Fixes issue #22.
2012-08-24Implement error messages in the decoder side.Petteri Aimonen1-9/+5
Update issue 7 Status: Started
2012-01-12Fixed issue 1 reported by Erik Rosen:Petteri Aimonen1-1/+4
The size of non-callback bytes-fields was miscalculated, which caused all following fields in a message to contain garbage. Previous commit contains a testcase for this. This fix changes the generated message description. If your protocol uses bytes-fields, you should regenerate *.pb.c.
2011-09-18Documentation outdated phrasePetteri Aimonen1-1/+1
git-svn-id: https://svn.kapsi.fi/jpa/nanopb@980 e3a754e5-d11d-0410-8d38-ebb782a927b9
2011-09-12Tests for callback fieldsPetteri Aimonen1-1/+1
git-svn-id: https://svn.kapsi.fi/jpa/nanopb@974 e3a754e5-d11d-0410-8d38-ebb782a927b9
2011-08-23More unittestsPetteri Aimonen1-2/+6
git-svn-id: https://svn.kapsi.fi/jpa/nanopb@966 e3a754e5-d11d-0410-8d38-ebb782a927b9
2011-08-17ExamplePetteri Aimonen1-2/+2
git-svn-id: https://svn.kapsi.fi/jpa/nanopb@957 e3a754e5-d11d-0410-8d38-ebb782a927b9
2011-08-16DocsPetteri Aimonen1-10/+95
git-svn-id: https://svn.kapsi.fi/jpa/nanopb@956 e3a754e5-d11d-0410-8d38-ebb782a927b9
2011-08-14More documentation, small improvementsPetteri Aimonen1-27/+112
git-svn-id: https://svn.kapsi.fi/jpa/nanopb@955 e3a754e5-d11d-0410-8d38-ebb782a927b9
2011-08-11Documenting and improving stream behaviourPetteri Aimonen1-0/+98
git-svn-id: https://svn.kapsi.fi/jpa/nanopb@954 e3a754e5-d11d-0410-8d38-ebb782a927b9