2020-06-29 21:27:07

by Luc Van Oostenryck

[permalink] [raw]
Subject: [PATCH v2] doc: add link to sparse's home page/internal docs

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 <[email protected]>
---

Changes since v1:
* fix a typo (s/kernl/kernel/) thanks to Mike Rapoport.

Documentation/dev-tools/sparse.rst | 2 ++
1 file changed, 2 insertions(+)

diff --git a/Documentation/dev-tools/sparse.rst b/Documentation/dev-tools/sparse.rst
index 8a7055593c31..02102be7ff49 100644
--- a/Documentation/dev-tools/sparse.rst
+++ b/Documentation/dev-tools/sparse.rst
@@ -9,6 +9,8 @@ Sparse is a semantic checker for C programs; it can be used to find a
number of potential problems with kernel code. See
https://lwn.net/Articles/689907/ for an overview of sparse; this document
contains some kernel-specific sparse information.
+More information on sparse, mainly about its internals, can be found in
+its official pages at https://sparse.docs.kernel.org.


Using sparse for typechecking
--
2.27.0


2020-07-05 20:34:31

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH v2] doc: add link to sparse's home page/internal docs

On Mon, 29 Jun 2020 18:13:10 +0200
Luc Van Oostenryck <[email protected]> wrote:

> 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 <[email protected]>
> ---
>
> Changes since v1:
> * fix a typo (s/kernl/kernel/) thanks to Mike Rapoport.
>
> Documentation/dev-tools/sparse.rst | 2 ++
> 1 file changed, 2 insertions(+)

When I answered saying I'd applied the v1 patch, I meant I'd really
applied this one, of course...sorry for the noise.

jon