Warn if PB_MAX_REQUIRED_FIELDS is not large enough.

[apps/agl-service-can-low-level.git] / docs / reference.rst

diff --git a/docs/reference.rst b/docs/reference.rst
index 8846ce1..81251fe 100644 (file)
--- a/docs/reference.rst
+++ b/docs/reference.rst
@@ -6,6 +6,17 @@ Nanopb: API reference
 
 .. contents ::
 
+Compilation options
+===================
+The following options can be specified using -D switch given to the C compiler:
+
+============================  ==============================================================================================
+__BIG_ENDIAN__                 Set this if your platform stores integers and floats in big-endian format.
+                               Mixed-endian systems (different layout for ints and floats) are currently not supported.
+NANOPB_INTERNALS               Set this to expose the field encoder functions that are hidden since nanopb-0.1.3.
+PB_MAX_REQUIRED_FIELDS         Maximum number of required fields to check for presence. Default value is 64.
+============================  ==============================================================================================
+
 pb.h
 ====
 
@@ -300,8 +311,6 @@ In addition to EOF, the pb_decode implementation supports terminating a message
 
 For optional fields, this function applies the default value and sets *has_<field>* to false if the field is not present.
 
-Because of memory concerns, the detection of missing required fields is not perfect if the structure contains more than 32 fields.
-
 pb_decode_varint
 ----------------
 Read and decode a varint_ encoded integer. ::