summaryrefslogtreecommitdiff
path: root/bits.h
diff options
context:
space:
mode:
authorEric S. Raymond <esr@thyrsus.com>2006-10-27 16:43:41 +0000
committerEric S. Raymond <esr@thyrsus.com>2006-10-27 16:43:41 +0000
commit58587ee0c2e89de39dd1b531443cff91e9aad12d (patch)
treea176a0863b9daa05033fcd263d003d386dabca6a /bits.h
parentf8e265f53368b6f667a695e73d1e82707307b1e5 (diff)
downloadgpsd-58587ee0c2e89de39dd1b531443cff91e9aad12d.tar.gz
Correct an erroneous comment.
Diffstat (limited to 'bits.h')
-rw-r--r--bits.h9
1 files changed, 6 insertions, 3 deletions
diff --git a/bits.h b/bits.h
index 50a1b8ad..077c0c31 100644
--- a/bits.h
+++ b/bits.h
@@ -3,9 +3,12 @@
* bits.h - extract binary data from message buffer
*
* These macros extract bytes, words, longwords, floats or doubles from
- * a message that contains these items in MSB-first byte order.
- * By defining the GET_ORIGIN and PUT_ORIGIN macros, it's possible to
- * change the origin of the indexing.
+ * a message that contains these items in either MSB-first or LSB-first
+ * byte order. To specify which, define one of LITTLE_ENDIAN_PROTOCOL
+ * or BIG_ENDIAN_PROTOCOL before including this header.
+ *
+ * By defining the GET_ORIGIN and PUT_ORIGIN macros before including
+ * this header, it's possible to change the origin of the indexing.
*
* Assumptions:
* char is 8 bits, short is 16 bits, int is 32 bits, long long is 64 bits,