acrn-kernel/Documentation/target/index.rst

.. SPDX-License-Identifier: GPL-2.0

==================
TCM Virtual Device
==================

.. toctree::
    :maxdepth: 1

    tcmu-design
    tcm_mod_builder
    scripts

.. only::  subproject and html

   Indices
   =======

   * :ref:`genindex`
docs: add some directories to the main documentation index The contents of those directories were orphaned at the documentation body. While those directories could likely be moved to be inside some guide, I'm opting to just adding their indexes to the main one, removing the :orphan: and adding the SPDX header. For the drivers, the rationale is that the documentation contains a mix of Kernelspace, uAPI and admin-guide. So, better to keep them on separate directories, as we've be doing with similar subsystem-specific docs that were not split yet. For the others, well... I'm too lazy to do the move. Also, it seems to make sense to keep at least some of those at the main dir (like kbuild, for example). In any case, a latter patch could do the move. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com> 2019-06-28 19:36:50 +08:00			`.. SPDX-License-Identifier: GPL-2.0`
docs: target: convert docs to ReST and rename to *.rst Convert the TCM docs to ReST format and add them to the bookset. This has a mix of userspace-faced and Kernelspace faced docs. Still, it sounds a better candidate to be added at the kernel API set of docs. 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> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2019-06-13 01:52:59 +08:00
			`==================`
			`TCM Virtual Device`
			`==================`

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

			`tcmu-design`
			`tcm_mod_builder`
			`scripts`

			`.. only:: subproject and html`

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

			* :ref:`genindex`