linux/Documentation/core-api/index.rst

======================
Core API Documentation
======================

This is the beginning of a manual for core kernel APIs.  The conversion
(and writing!) of documents for this manual is much appreciated!

Core utilities
==============

.. toctree::
   :maxdepth: 1

   workqueue

Interfaces for kernel debugging
===============================

.. toctree::
   :maxdepth: 1

   debug-objects	      

.. only::  subproject

   Indices
   =======

   * :ref:`genindex`
Documentation/00-index: update for new core-api folder Signed-off-by: Silvio Fricke <silvio.fricke@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2016-10-28 08:14:10 +00:00			`======================`
doc: Convert the debugobjects DocBook template to sphinx A couple of the most minor heading tweaks, otherwise no changes to the text itself beyond the mechanical conversion. Note that the inclusion of the kerneldoc comments from the source has never worked, since exported symbols were asked for and none of those functions are exported to modules. It doesn't work here either :) Cc: Thomas Gleixner <tglx@linutronix.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2016-11-19 00:06:13 +00:00			`Core API Documentation`
Documentation/00-index: update for new core-api folder Signed-off-by: Silvio Fricke <silvio.fricke@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2016-10-28 08:14:10 +00:00			`======================`

doc: Convert the debugobjects DocBook template to sphinx A couple of the most minor heading tweaks, otherwise no changes to the text itself beyond the mechanical conversion. Note that the inclusion of the kerneldoc comments from the source has never worked, since exported symbols were asked for and none of those functions are exported to modules. It doesn't work here either :) Cc: Thomas Gleixner <tglx@linutronix.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2016-11-19 00:06:13 +00:00			`This is the beginning of a manual for core kernel APIs. The conversion`
			`(and writing!) of documents for this manual is much appreciated!`

			`Core utilities`
			`==============`
Documentation/00-index: update for new core-api folder Signed-off-by: Silvio Fricke <silvio.fricke@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2016-10-28 08:14:10 +00:00
			`.. toctree::`
			`:maxdepth: 1`

Documentation/workqueue.txt: convert to ReST markup ... and move to Documentation/core-api folder. Signed-off-by: Silvio Fricke <silvio.fricke@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2016-10-28 08:14:11 +00:00			`workqueue`

doc: Convert the debugobjects DocBook template to sphinx A couple of the most minor heading tweaks, otherwise no changes to the text itself beyond the mechanical conversion. Note that the inclusion of the kerneldoc comments from the source has never worked, since exported symbols were asked for and none of those functions are exported to modules. It doesn't work here either :) Cc: Thomas Gleixner <tglx@linutronix.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2016-11-19 00:06:13 +00:00			`Interfaces for kernel debugging`
			`===============================`

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

			`debug-objects`

Documentation/00-index: update for new core-api folder Signed-off-by: Silvio Fricke <silvio.fricke@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2016-10-28 08:14:10 +00:00			`.. only:: subproject`

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

			* :ref:`genindex`