[PATCH 1/3] Documentation/CodingGuidelines: explain why assert is bad

From: Stefan Beller <sbeller@google.com>
Date: Nov 22, 2017, 22:38 UTC
Message-ID: <20171122223827.26773-2-sbeller@google.com>
In-Reply-To: <20171122223827.26773-1-sbeller@google.com>

Signed-off-by: Stefan Beller <sbeller@google.com>
---
 Documentation/CodingGuidelines | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index c4cb5ff0d4..4f8791895b 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -386,6 +386,9 @@ For C programs:
  - Use Git's gettext wrappers to make the user interface
    translatable. See "Marking strings for translation" in po/README.
 
+ - Prefer the BUG() macro over asserts, as asserts requires that the
+   NDEBUG flag is unset on compilation to work.
+
 For Perl programs:
 
  - Most of the C guidelines above apply.

-- 
2.15.0.448.gf294e3d99a-goog