linux/Documentation/RCU/index.rst

.. _rcu_concepts:

============
RCU concepts
============

.. toctree::
   :maxdepth: 3

   arrayRCU
   rcu
   listRCU
   NMI-RCU
   UP

   Design/Memory-Ordering/Tree-RCU-Memory-Ordering
   Design/Expedited-Grace-Periods/Expedited-Grace-Periods
   Design/Requirements/Requirements
   Design/Data-Structures/Data-Structures

.. only:: subproject and html

   Indices
   =======

   * :ref:`genindex`
Documentation: RCU: Add TOC tree hooks Add TOC tree hooks for: - rcu - listRCU - UP Signed-off-by: Jiunn Chang <c0d1n61at3@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2019-06-26 23:07:05 +03:00			`.. _rcu_concepts:`

			`============`
			`RCU concepts`
			`============`

			`.. toctree::`
docs: rcu: Increase toctree to 3 These documents are long and have various sections. Provide a good toc nesting level. Signed-off-by: Joel Fernandes (Google) <joel@joelfernandes.org> Signed-off-by: Paul E. McKenney <paulmck@kernel.org> 2019-08-02 00:39:20 +03:00			`:maxdepth: 3`
Documentation: RCU: Add TOC tree hooks Add TOC tree hooks for: - rcu - listRCU - UP Signed-off-by: Jiunn Chang <c0d1n61at3@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2019-06-26 23:07:05 +03:00
doc: Convert arrayRCU.txt to arrayRCU.rst This patch converts arrayRCU from .txt to .rst format, and also adds it to the index.rst file. Signed-off-by: Madhuparna Bhowmik <madhuparnabhowmik04@gmail.com> [ paulmck: Trimmed trailing whitespace. ] Tested-by: Phong Tran <tranmanphong@gmail.com> Tested-by: Amol Grover <frextrite@gmail.com> Signed-off-by: Paul E. McKenney <paulmck@kernel.org> 2019-10-28 23:24:17 +03:00			`arrayRCU`
Documentation: RCU: Add TOC tree hooks Add TOC tree hooks for: - rcu - listRCU - UP Signed-off-by: Jiunn Chang <c0d1n61at3@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2019-06-26 23:07:05 +03:00			`rcu`
			`listRCU`
doc: Converted NMI-RCU.txt to NMI-RCU.rst. This patch converts NMI-RCU from txt to rst format. Also adds NMI-RCU in the index.rst file. Signed-off-by: Madhuparna Bhowmik <madhuparnabhowmik04@gmail.com> [ paulmck: Apply feedback from Phong Tran. ] Tested-by: Phong Tran <tranmanphong@gmail.com> Signed-off-by: Paul E. McKenney <paulmck@kernel.org> 2019-10-29 00:42:52 +03:00			`NMI-RCU`
Documentation: RCU: Add TOC tree hooks Add TOC tree hooks for: - rcu - listRCU - UP Signed-off-by: Jiunn Chang <c0d1n61at3@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2019-06-26 23:07:05 +03:00			`UP`

docs: rcu: convert some articles from html to ReST There are 4 RCU articles that are written on html format. The way they are, they can't be part of the Linux Kernel documentation body nor share the styles and pdf output. So, convert them to ReST format. This way, make htmldocs and make pdfdocs will produce a documentation output that will be like the original ones, but will be part of the Linux Kernel documentation body. Part of the conversion was done with the help of pandoc, but the result had some broken things that had to be manually fixed. Following are manual changes Mauro made when doing the automatic conversion: Quoting from: https://lore.kernel.org/rcu/20190726154550.5eeae294@coco.lan/ > > At least the pandoc's version I used here has a bug: its conversion > > from html to ReST on those files only start after a <body> tag - or > > when the first quiz table starts. I only discovered that adding a > > <body> at the beginning of the file solve this book at the last > > conversions. > > > > So, for most html->ReST conversions, I manually converted the first > > part of the document, basically stripping html paragraph tags and > > by replacing highlights by the ReST syntax. > > > > Also, all the quiz tables seem to assume some javascript macro or > > css style that would be hiding the answer part until the mouse moves > > to it. Such macro/css was not there at the kernel tree. So, the quiz > > answers have the same color as the background, making them invisible. > > Even if we had such macro/css, this is not portable for pdf/LaTeX output > > (and I'm not sure if this would work with ePub). > > > > So, I ended by manually doing the table conversion. > > > > Finally, I double-checked if the conversions ended ok, addressing any > > issues that might have heppened. > > > > So, after both automatic conversion and manual fixes, I opened both the > > html files produced by Sphinx and the original ones and compared them > > line per line (except for the indexes, as Sphinx produces them > > automatically), in order to see if all information from the original > > files will be there on a format close to what we have on other ReST > > files, fixing any pending issues if any. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Paul E. McKenney <paulmck@kernel.org> 2019-08-02 00:39:18 +03:00			`Design/Memory-Ordering/Tree-RCU-Memory-Ordering`
			`Design/Expedited-Grace-Periods/Expedited-Grace-Periods`
			`Design/Requirements/Requirements`
			`Design/Data-Structures/Data-Structures`

Documentation: RCU: Add TOC tree hooks Add TOC tree hooks for: - rcu - listRCU - UP Signed-off-by: Jiunn Chang <c0d1n61at3@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2019-06-26 23:07:05 +03:00			`.. only:: subproject and html`

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

			* :ref:`genindex`