Improve sparse documentation
authorMatthew Wilcox <willy@infradead.org>
Mon, 13 Feb 2017 19:16:02 +0000 (11:16 -0800)
committerJonathan Corbet <corbet@lwn.net>
Wed, 15 Feb 2017 22:09:13 +0000 (15:09 -0700)
Add documentation of -DCONFIG_SPARSE_RCU_POINTER.
I started to add documentation of -D__CHECK_ENDIAN__ as well, but
discovered I'm too late; that's now enabled by default.

Signed-off-by: Matthew Wilcox <mawilcox@microsoft.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/dev-tools/sparse.rst

index 78aa00a604a0090713615ff0dfad8c04ab60dc44..ffdcc97f6f5af218e96a6cbf5cce1e7c4cc071f4 100644 (file)
@@ -103,3 +103,9 @@ have already built it.
 
 The optional make variable CF can be used to pass arguments to sparse.  The
 build system passes -Wbitwise to sparse automatically.
+
+Checking RCU annotations
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+RCU annotations are not checked by default.  To enable RCU annotation
+checks, include -DCONFIG_SPARSE_RCU_POINTER in your CF flags.