svn commit: r346886 - stable/12/sys/conf

[Mark Johnston]

Author: markj
Date: Mon Apr 29 13:20:24 2019
New Revision: 346886
URL: https://svnweb.freebsd.org/changeset/base/346886

Log:
  MFC r346544:
  Clarify the relationship between INVARIANTS and DIAGNOSTIC a bit.

Modified:
  stable/12/sys/conf/NOTES
Directory Properties:
  stable/12/   (props changed)

Modified: stable/12/sys/conf/NOTES
==============================================================================
--- stable/12/sys/conf/NOTES	Mon Apr 29 09:52:53 2019	(r346885)
+++ stable/12/sys/conf/NOTES	Mon Apr 29 13:20:24 2019	(r346886)
@@ -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