From 54b1608b2dd04334b68acedccb20c733ced345dd Mon Sep 17 00:00:00 2001 From: Matt Brubeck Date: Thu, 21 May 2015 16:34:26 -0700 Subject: [PATCH] Document the debug_assertions cfg option --- src/doc/reference.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/doc/reference.md b/src/doc/reference.md index 0682c2003e3f6..8d1b93ce3c8b9 100644 --- a/src/doc/reference.md +++ b/src/doc/reference.md @@ -2003,6 +2003,10 @@ arbitrarily complex configurations through nesting. The following configurations must be defined by the implementation: +* `debug_assertions`. Enabled by default when compiling without optimizations. + This can be used to enable extra debugging code in development but not in + production. For example, it controls the behavior of the standard library's + `debug_assert!` macro. * `target_arch = "..."`. Target CPU architecture, such as `"x86"`, `"x86_64"` `"mips"`, `"powerpc"`, `"arm"`, or `"aarch64"`. * `target_endian = "..."`. Endianness of the target CPU, either `"little"` or