summaryrefslogtreecommitdiffstats
path: root/docs/reference.rst
diff options
context:
space:
mode:
authorPetteri Aimonen <jpa@git.mail.kapsi.fi>2013-08-08 20:05:30 +0300
committerPetteri Aimonen <jpa@git.mail.kapsi.fi>2013-08-08 20:05:30 +0300
commitb663909fb6e86f0ae0f450523e72fb7fbfb719ab (patch)
treed76ad5282b58a8293883eac3af20ae47373b5d76 /docs/reference.rst
parentba40cacd3c4a60ccc9108d6acf7e813b1757dfd1 (diff)
Document PB_SYSTEM_HEADER
Diffstat (limited to 'docs/reference.rst')
-rw-r--r--docs/reference.rst7
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/reference.rst b/docs/reference.rst
index 42f4864f..6c38f6b4 100644
--- a/docs/reference.rst
+++ b/docs/reference.rst
@@ -49,6 +49,11 @@ PB_BUFFER_ONLY Disables the support for custom streams. Only
PB_OLD_CALLBACK_STYLE Use the old function signature (void\* instead
of void\*\*) for callback fields. This was the
default until nanopb-0.2.1.
+PB_SYSTEM_HEADER Replace the standard header files with a single
+ header file. It should define all the required
+ functions and typedefs listed on the
+ `overview page`_. Value must include quotes,
+ for example *#define PB_SYSTEM_HEADER "foo.h"*.
============================ ================================================
The PB_MAX_REQUIRED_FIELDS, PB_FIELD_16BIT and PB_FIELD_32BIT settings allow
@@ -56,7 +61,7 @@ raising some datatype limits to suit larger messages. Their need is recognized
automatically by C-preprocessor #if-directives in the generated .pb.h files.
The default setting is to use the smallest datatypes (least resources used).
-
+.. _`overview page`: index.html#compiler-requirements
Proto file options