svn commit: r346544 - head/sys/conf

[Mark Johnston]

Author: markj
Date: Mon Apr 22 11:31:13 2019
New Revision: 346544
URL: https://svnweb.freebsd.org/changeset/base/346544

Log:
  Clarify the relationship between INVARIANTS and DIAGNOSTIC a bit.
  
  MFC after:	1 week
  Sponsored by:	The FreeBSD Foundation

Modified:
  head/sys/conf/NOTES

Modified: head/sys/conf/NOTES
==============================================================================
--- head/sys/conf/NOTES	Mon Apr 22 11:23:35 2019	(r346543)
+++ head/sys/conf/NOTES	Mon Apr 22 11:31:13 2019	(r346544)
@@ -563,8 +563,10 @@ options 	KASSERT_PANIC_OPTIONAL
 
 #
 # The DIAGNOSTIC option is used to enable extra debugging information
-# from some parts of the kernel.  As this makes everything more noisy,
-# it is disabled by default.
+# and invariants checking.  The added checks are too expensive or noisy
+# for an INVARIANTS kernel and thus are disabled by default.  It is
+# expected that a kernel configured with DIAGNOSTIC will also have the
+# INVARIANTS option enabled.
 #
 options 	DIAGNOSTIC