docs: Add description of BUILD_BUG_ON().

Signed-off-by: Keir Fraser <keir.fraser@citrix.com>

1 files changed, 7 insertions, 0 deletions

diff --git a/docs/misc/xen-error-handling.txt b/docs/misc/xen-error-handling.txt
index 61cc67261b..7728787092 100644
--- a/docs/misc/xen-error-handling.txt
+++ b/docs/misc/xen-error-handling.txt
@@ -79,3 +79,10 @@ interesting.
 A possible approach to dealing with boot-time errors, rather than
 crashing the hypervisor. It's particularly appropriate when parsing
 non-critical BIOS tables and detecting extended hardware features.
+
+
+7. BUILD_BUG_ON()
+-----------------
+Useful for assertions which can be evaluated at compile time. For
+example, making explicit assumptions about size and alignment of C
+structures.