linux-sparse.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Luc Van Oostenryck <luc.vanoostenryck@gmail.com>
To: linux-sparse@vger.kernel.org
Cc: Luc Van Oostenryck <luc.vanoostenryck@gmail.com>
Subject: [PATCH] doc: add some info to the main page
Date: Sun, 21 Jun 2020 11:39:28 +0200	[thread overview]
Message-ID: <20200621093928.40272-1-luc.vanoostenryck@gmail.com> (raw)

Add some info about:
* how to get sparse
* how to install it,
* the mailing list and how to report bugs.

Signed-off-by: Luc Van Oostenryck <luc.vanoostenryck@gmail.com>
---
 Documentation/index.rst | 40 ++++++++++++++++++++++++++++++----------
 1 file changed, 30 insertions(+), 10 deletions(-)

diff --git a/Documentation/index.rst b/Documentation/index.rst
index 415da4bb27af..737f442323b5 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -25,23 +25,43 @@ 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/
+You can find tarballs of 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::
+The most recent version can be obtained 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>`_.
+You can also `browse the Git repository <https://git.kernel.org/pub/scm/devel/sparse/sparse.git>`_
+or use the mirror at https://github.com/lucvoo/sparse.
+
+Once you have the sources, to build Sparse and install it in your ~/bin
+directory, just do::
+
+	cd sparse
+	make
+	make install
+
+To install it in another directory, use::
+
+	make PREFIX=<some directory> install
+
+Contributing and reporting bugs
+-------------------------------
 
-Mailing list
-~~~~~~~~~~~~
+Submission of patches and reporting of bugs, as well as discussions
+related to Sparse, should be done via the mailing list:
+linux-sparse@vger.kernel.org.
+You do not have to be subscribed to the list to send a message there.
+Previous discussions and bug reports are available on the list
+archives at https://marc.info/?l=linux-sparse.
 
-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``.
+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.
+Bugs can also be reported and tracked via the Linux kernel's bugzilla:
+http://bugzilla.kernel.org/enter_bug.cgi?component=Sparse&product=Tools.
 
 User documentation
 ------------------
-- 
2.27.0

                 reply	other threads:[~2020-06-21  9:39 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200621093928.40272-1-luc.vanoostenryck@gmail.com \
    --to=luc.vanoostenryck@gmail.com \
    --cc=linux-sparse@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).