about summary refs log tree commit diff
path: root/src/doc/reference.md
diff options
context:
space:
mode:
authorMatt Brubeck <mbrubeck@limpet.net>2015-05-21 16:34:26 -0700
committerMatt Brubeck <mbrubeck@limpet.net>2015-05-21 16:34:26 -0700
commit54b1608b2dd04334b68acedccb20c733ced345dd (patch)
treec8787470fec43e31f0e99a90cc0347439152dc0f /src/doc/reference.md
parentc3d60aba6c86883c79055c1a3923d4db116b644e (diff)
downloadrust-54b1608b2dd04334b68acedccb20c733ced345dd.tar.gz
rust-54b1608b2dd04334b68acedccb20c733ced345dd.zip
Document the debug_assertions cfg option
Diffstat (limited to 'src/doc/reference.md')
-rw-r--r--src/doc/reference.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/doc/reference.md b/src/doc/reference.md
index 0682c2003e3..8d1b93ce3c8 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