Documentation/index.rst

.. sparse documentation master file.

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.

Maintainer
----------

1. 2006 - 2009, Josh Triplett
2. 2009 - 2018, Chris Li
3. 2018 - 2025, Luc Van Oostenryck
4. 2025 - present, Chris Li

Getting Sparse
--------------

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>`_
or use the mirror at https://github.com/lucvoo/sparse.
The tarballs of released versions of Sparse and their signatures can be found at
https://www.kernel.org/pub/software/devel/sparse/dist/.

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
-------------------------------

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.

To subscribe to the list, send an email to ``linux-sparse+subscribe@vger.kernel.org``,
check `Subspace <https://subspace.kernel.org/subscribing.html>`_ for details.

Bugs can also be reported and tracked via the `Linux kernel's bugzilla for sparse
<https://bugzilla.kernel.org/enter_bug.cgi?component=Sparse&product=Tools>`_.


.. toctree::
   :caption: User Documentation
   :maxdepth: 1

   annotations

Some interesting external documentation:

* `Sparse: a look under the hood <https://lwn.net/Articles/689907/>`_
* `Sparse: a short overview <https://sil2.osadl.org/events/ewc-2019-hands-on/sparse_slides.pdf>`_

.. toctree::
   :caption: Development
   :maxdepth: 1

   submitting-patches
   types
   api
   dev-options
   IR
   test-suite
   doc-guide
   TODO

.. toctree::
   :caption: Release Notes
   :maxdepth: 1

   release-notes/index

Indices and tables
==================

* :ref:`genindex`