Skip to content

Commit

Permalink
Improve sparse documentation
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Matthew Wilcox authored and Jonathan Corbet committed Feb 15, 2017
1 parent c33dea1 commit 291b9d7
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions Documentation/dev-tools/sparse.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 291b9d7

Please sign in to comment.