lib/sod.h: Introduce `SOD_RECKLESS' feature macro to inhibit checking.
[sod] / lib / sod.3
index 9f95c78..de46128 100644 (file)
--- a/lib/sod.3
+++ b/lib/sod.3
@@ -147,6 +147,16 @@ instances and classes inherit from the standard
 root object.
 While the translator can (at some effort) support alternative roots,
 they will require different run-time support machinery.
+.PP
+Some of Sod's macros include runtime checking by default.
+This checking can be disabled if you value performance
+more than early diagnosis of problems.
+Define
+.B SOD_RECKLESS
+to a nonzero value
+before including
+.B <sod/sod.h>
+to inhibit the runtime checking.
 .
 .SS Layout utilities
 The following macros are useful in