Skip to content

Commit 291b9d7

Browse files
Matthew WilcoxJonathan Corbet
authored andcommitted
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 <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
1 parent c33dea1 commit 291b9d7

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

Documentation/dev-tools/sparse.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,3 +103,9 @@ have already built it.
103103

104104
The optional make variable CF can be used to pass arguments to sparse. The
105105
build system passes -Wbitwise to sparse automatically.
106+
107+
Checking RCU annotations
108+
~~~~~~~~~~~~~~~~~~~~~~~~
109+
110+
RCU annotations are not checked by default. To enable RCU annotation
111+
checks, include -DCONFIG_SPARSE_RCU_POINTER in your CF flags.

0 commit comments

Comments
 (0)