Note about __BIG_ENDIAN__ compilation option
authorPetteri Aimonen <jpa@git.mail.kapsi.fi>
Mon, 25 Jun 2012 18:45:40 +0000 (21:45 +0300)
committerPetteri Aimonen <jpa@git.mail.kapsi.fi>
Mon, 25 Jun 2012 18:45:40 +0000 (21:45 +0300)
docs/reference.rst

index 8846ce1..8c1af77 100644 (file)
@@ -6,6 +6,12 @@ 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.
+
 pb.h
 ====