summaryrefslogtreecommitdiff
path: root/doc/explan_bits.h.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/explan_bits.h.xml')
-rw-r--r--doc/explan_bits.h.xml22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/explan_bits.h.xml b/doc/explan_bits.h.xml
new file mode 100644
index 00000000..1cdd50cb
--- /dev/null
+++ b/doc/explan_bits.h.xml
@@ -0,0 +1,22 @@
+<sect1 id="bits.h"><title><filename>bits.h</filename></title>
+<informaltable frame='all' pgwide='1'>
+<tgroup cols='1'>
+<colspec colname='c1'></colspec>
+<colspec colname='c2'></colspec>
+<spanspec spanname='s1' namest='c1' nameend='c2'></spanspec>
+
+<tbody>
+<row>
+ <entry><para>This file only contains macros that convert data variables from the native format of the device output (MSB-first or LSB-first) into a standard form for <application>gpsd</application> use. This makes data parsing consistent regardless of the underlying format. If the device driver file makes no deliberate selection, the default is to assume the device emits data in big-endian (network byte) order.</para></entry>
+</row>
+</tbody>
+
+<tfoot>
+<row>
+ <entry spanname='s1' align='left'>Notes based on <function>$Id: bits.h 4030 2006-11-30 07:29:25Z esr $</function></entry>
+</row>
+</tfoot>
+
+</tgroup>
+</informaltable>
+</sect1>