Linux-Sparse Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH] doc: add some info to the main page
@ 2020-06-21  9:39 Luc Van Oostenryck
  0 siblings, 0 replies; only message in thread
From: Luc Van Oostenryck @ 2020-06-21  9:39 UTC (permalink / raw)
  To: linux-sparse; +Cc: Luc Van Oostenryck

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

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, back to index

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-06-21  9:39 [PATCH] doc: add some info to the main page Luc Van Oostenryck

Linux-Sparse Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-sparse/0 linux-sparse/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-sparse linux-sparse/ https://lore.kernel.org/linux-sparse \
		linux-sparse@vger.kernel.org
	public-inbox-index linux-sparse

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-sparse


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git