linux/Documentation/locking/index.rst

.. SPDX-License-Identifier: GPL-2.0

=======
locking
=======

.. toctree::
    :maxdepth: 1

    locktypes
    lockdep-design
    lockstat
    locktorture
    mutex-design
    rt-mutex-design
    rt-mutex
    spinlocks
    ww-mutex-design

.. only::  subproject and html

   Indices
   =======

   * :ref:`genindex`
docs: locking: add it to the main index The locking directory is part of the Kernel API bookset. Add it to the index file. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> 2019-06-28 10:29:15 +00:00			`.. SPDX-License-Identifier: GPL-2.0`
docs: locking: convert docs to ReST and rename to *.rst Convert the locking documents to ReST and add them to the kernel development book where it belongs. Most of the stuff here is just to make Sphinx to properly parse the text file, as they're already in good shape, not requiring massive changes in order to be parsed. The conversion is actually: - add blank lines and identation in order to identify paragraphs; - fix tables markups; - add some lists markups; - mark literal blocks; - adjust title markups. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Federico Vaga <federico.vaga@vaga.pv.it> 2019-04-10 11:32:41 +00:00
			`=======`
			`locking`
			`=======`

			`.. toctree::`
			`:maxdepth: 1`

Documentation: Add lock ordering and nesting documentation The kernel provides a variety of locking primitives. The nesting of these lock types and the implications of them on RT enabled kernels is nowhere documented. Add initial documentation. Signed-off-by: Thomas Gleixner <tglx@linutronix.de> Signed-off-by: Peter Zijlstra (Intel) <peterz@infradead.org> Link: https://lkml.kernel.org/r/20200321113242.026561244@linutronix.de 2020-03-21 11:25:57 +00:00			`locktypes`
docs: locking: convert docs to ReST and rename to *.rst Convert the locking documents to ReST and add them to the kernel development book where it belongs. Most of the stuff here is just to make Sphinx to properly parse the text file, as they're already in good shape, not requiring massive changes in order to be parsed. The conversion is actually: - add blank lines and identation in order to identify paragraphs; - fix tables markups; - add some lists markups; - mark literal blocks; - adjust title markups. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Federico Vaga <federico.vaga@vaga.pv.it> 2019-04-10 11:32:41 +00:00			`lockdep-design`
			`lockstat`
			`locktorture`
			`mutex-design`
			`rt-mutex-design`
			`rt-mutex`
			`spinlocks`
			`ww-mutex-design`

			`.. only:: subproject and html`

			`Indices`
			`=======`

			* :ref:`genindex`