Re: [PATCH] doc: add intro stolen from the wiki

[Ramsay Jones <ramsay@ramsayjones.plus.com>]

On 16/06/2020 01:11, Luc Van Oostenryck wrote:
> The wiki has a small into, perfectable but nice

s/into/intro/ or s/into/introduction/
s/perfectable but/which could be improved, but is/

> enough while the doc here has no such thing.

s/enough/enough,/

> 
> So, copy the intro from the wiki into the entrypoint

s/intro/introduction/ maybe.

ATB,
Ramsay Jones

> of the documentation (and convert the wikimedia markup
> into restructuredtext).
> 
> Signed-off-by: Luc Van Oostenryck <luc.vanoostenryck@gmail.com>
> ---
>  Documentation/index.rst | 37 +++++++++++++++++++++++++++++++++++++
>  1 file changed, 37 insertions(+)
> 
> diff --git a/Documentation/index.rst b/Documentation/index.rst
> index eb3de63c9ca7..415da4bb27af 100644
> --- a/Documentation/index.rst
> +++ b/Documentation/index.rst
> @@ -6,6 +6,43 @@ Welcome to sparse's documentation
>  .. toctree::
>     :maxdepth: 1
>  
> +About Sparse
> +------------
> +
> +Sparse, the semantic parser, provides a compiler frontend capable of
> +parsing most of ANSI C as well as many GCC extensions, and a collection
> +of sample compiler backends, including a static analyzer also called `sparse`.
> +Sparse provides a set of annotations designed to convey semantic information
> +about types, such as what address space pointers point to, or what locks
> +function acquires or releases.
> +
> +Linus Torvalds started writing Sparse in 2003, initially targeting issues such
> +as mixing pointers to user address space and pointers to kernel address space.
> +
> +Josh Triplett was Sparse's first maintainer in 2006. This role was taken over
> +by Christopher Li in 2009 and by Luc Van Oostenryck in late 2018.
> +
> +Getting Sparse
> +--------------
> +
> +You can find released versions of sparse at http://www.kernel.org/pub/software/devel/sparse/dist/
> +
> +Obtaining sparse via Git
> +~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +Sparse uses the `Git version control system <http://git-scm.com/>`_. You can obtain the most recent version of sparse directly from the Git repository with the command::
> +
> +	git clone git://git.kernel.org/pub/scm/devel/sparse/sparse.git
> +
> +You can also `browse the Git repository <https://git.kernel.org/pub/scm/devel/sparse/sparse.git>`_.
> +
> +Mailing list
> +~~~~~~~~~~~~
> +
> +Discussions about sparse occurs on the sparse mailing list, linux-sparse@vger.kernel.org. To subscribe to the list, send an email with ``subscribe linux-sparse`` in the body to ``majordomo@vger.kernel.org``.
> +
> +You can browse the list archives at https://marc.info/?l=linux-sparse.
> +
>  User documentation
>  ------------------
>  .. toctree::
>