doc/list-exports: Use `documentation' to find more categories.

[sod] / lib / sod.3

diff --git a/lib/sod.3 b/lib/sod.3
index 9f95c78..c49378a 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.
 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
 .
 .SS Layout utilities
 The following macros are useful in


@@ -484,6 +494,13 @@ It may be appropriate to
 .BR assert (3)
 that the object is ready for deallocation at this time.
 .PP
 .BR assert (3)
 that the object is ready for deallocation at this time.
 .PP

+By default, this macro will abort the program
+if the size allocated for the instance doesn't match
+the size required by the class object;
+set
+.B SOD_RECKLESS
+to inhibit this check.
+.PP

 The
 .B SOD_MAKE
 macro,
 The
 .B SOD_MAKE
 macro,