utils/bits.h: Support compiler magic for unaligned loads and stores.

[mLib] / utils / bits.3

diff --git a/utils/bits.3 b/utils/bits.3
index 7b1c715..a002e24 100644 (file)
--- a/utils/bits.3
+++ b/utils/bits.3
@@ -112,6 +112,11 @@ bits \- portable bit manipulation macros
 .\" HTOB64
 .\" HTOL64
 .\"
+.\" RAW8
+.\" RAW16
+.\" RAW32
+.\" RAW64
+.\"
 .\" @GETBYTE
 .\" @PUTBYTE
 .\"
@@ -485,6 +490,22 @@ These macros always operate on byte offsets regardless of the type of
 the pointer
 .IR p .
 .PP
+For each size suffix
+.IR w ,
+there may be a macro such that the invocation
+.BI RAW w ( p )
+is an lvalue designating the
+.IR w /8
+octets starting at address
+.IR p ,
+interpreted according to the environment's preferred representation,
+except that
+.I p
+need not be aligned in any particular fashion.  There are many reasons
+why this might not be possible; programmers are not normally expected to
+use these macros directly, and they are documented in case they are
+useful for special effects.
+.PP
 For each size-and-endian suffix
 .IR we ,
 the macro invocation