X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;ds=sidebyside;f=docs%2Findex.rst;h=d49abc0708d915c4d96808eeeaa1d5812fd76125;hb=420265d39bab7f1de051e108f7123b8c3b844f89;hp=27840f7d9f91972bb5b59bf21d3be578b29a98c5;hpb=73142ba082e56b8c5ba75c055a20c200b623da83;p=apps%2Fagl-service-can-low-level.git diff --git a/docs/index.rst b/docs/index.rst index 27840f7d..d49abc07 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -47,7 +47,6 @@ Features and limitations **Limitations** -#) User must provide callbacks when decoding arrays or strings without maximum size. Malloc support could be added as a separate module. #) Some speed has been sacrificed for code size. #) Encoding is focused on writing to streams. For memory buffers only it could be made more efficient. #) The deprecated Protocol Buffers feature called "groups" is not supported. @@ -104,11 +103,12 @@ requires a few header files to be available: #) *stdbool.h*, for definition of *bool* If these header files do not come with your compiler, you can use the -file *compat/pb_syshdr.h* instead. It contains an example of how to provide +file *extra/pb_syshdr.h* instead. It contains an example of how to provide the dependencies. You may have to edit it a bit to suit your custom platform. -To use the pb_syshdr.h, define *PB_SYSTEM_HEADER* to be the name of your custom -header file. It should provide all the dependencies listed above. +To use the pb_syshdr.h, define *PB_SYSTEM_HEADER* as *"pb_syshdr.h"* (including the quotes). +Similarly, you can provide a custom include file, which should provide all the dependencies +listed above. Running the test cases ======================