From: Matthew Wilcox <willy@infradead.org>
Date: Mon, 13 Feb 2017 19:16:02 +0000 (-0800)
Subject: Improve sparse documentation
X-Git-Tag: v5.15~11419^2~84
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=291b9d73681f3e0123b8954eb20be22342987afc;p=platform%2Fkernel%2Flinux-starfive.git

Improve sparse documentation

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>
---

diff --git a/Documentation/dev-tools/sparse.rst b/Documentation/dev-tools/sparse.rst
index 78aa00a..ffdcc97 100644
--- a/Documentation/dev-tools/sparse.rst
+++ b/Documentation/dev-tools/sparse.rst
@@ -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.