kernel/linux.git/Documentation/dev-tools/sparse.rst, branch v6.18.21

Documentation/sparse: add hints about CHECKER

2022-03-24T02:00:33+00:00

Several attributes depend on __CHECKER__, but previously there was no clue in the tree about when __CHECKER__ might be defined. Add hints at the most common places (__kernel, __user, __iomem, __bitwise) and in the sparse documentation. Link: https://lkml.kernel.org/r/20220310220927.245704-3-helgaas@kernel.org Signed-off-by: Bjorn Helgaas Cc: Jonathan Corbet Cc: Nathan Chancellor Cc: Nick Desaulniers Cc: "Michael S . Tsirkin" Signed-off-by: Andrew Morton Signed-off-by: Linus Torvalds

doc: add link to sparse's home page/internal docs

2020-07-05T20:32:56+00:00

Sparse's home page used to be a wiki (sparse.wiki.kernel.org) but this wiki only contained a short intro and the release notes. But nowadays, sparse's main page is sparse.docs.kernel.org, which contains all what was in the wiki but also other documentation, mainly oriented about sparse's internals. So, add a link to this in the kernel documentation. Signed-off-by: Luc Van Oostenryck Acked-by: Mike Rapoport Link: https://lore.kernel.org/r/20200629161310.89783-1-luc.vanoostenryck@gmail.com Signed-off-by: Jonathan Corbet

doc: update URL for sparse's tarballs

2020-06-26T17:22:56+00:00

The URL given to get sparse's tarballs is sparse.wiki.kernel.org but the wiki will is deprecated in favor of sparse.docs.kernel.org. So, update this URL to the one where the tarballs can directly be found. Signed-off-by: Luc Van Oostenryck Link: https://lore.kernel.org/r/20200621153330.54480-1-luc.vanoostenryck@gmail.com Signed-off-by: Jonathan Corbet

Remove references to dead website.

2019-07-19T19:22:04+00:00

This fell into disrepair a while ago, and the majority of hits to the snapshots were from bots, so it's more trouble to keep running than it's worth. Signed-off-by: Dave Jones Signed-off-by: Linus Torvalds

Documentation/sparse: fix typo

2018-03-21T15:17:56+00:00

Signed-off-by: Eric Engestrom Signed-off-by: Jonathan Corbet

rcu: Remove SPARSE_RCU_POINTER Kconfig option

2017-06-09T01:52:41+00:00

The sparse-based checking for non-RCU accesses to RCU-protected pointers has been around for a very long time, and it is now the only type of sparse-based checking that is optional. This commit therefore makes it unconditional. Reported-by: Ingo Molnar Signed-off-by: Paul E. McKenney Cc: Fengguang Wu

Improve sparse documentation

2017-02-15T22:09:13+00:00

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 Signed-off-by: Jonathan Corbet

Documentation/sparse: drop __CHECK_ENDIAN__

2016-12-15T22:13:41+00:00

It's no longer used. Signed-off-by: Michael S. Tsirkin

Documentation/sparse: drop bitwise

2016-12-15T22:13:40+00:00

We dropped __CHECK_ENDIAN__ so __bitwise__ is now an implementation detail. People should use __bitwise everywhere. Signed-off-by: Michael S. Tsirkin

docs: sphinxify sparse.txt and move to dev-tools

2016-08-18T23:39:24+00:00

Fold the sparse document into the development tools set; no changes to the text itself beyond formatting. Signed-off-by: Jonathan Corbet