mirror of
https://github.com/torvalds/linux.git
synced 2026-03-08 04:24:31 +01:00
a592a36e49
The root document usually has a special :ref:`genindex` link to the generated index. This is also the case for Documentation/index.rst. The other index.rst files deeper in the directory hierarchy usually don't. For SPHINXDIRS builds, the root document isn't Documentation/index.rst, but some other index.rst in the hierarchy. Currently they have a ".. only::" block to add the index link when doing SPHINXDIRS html builds. This is obviously very tedious and repetitive. The link is also added to all index.rst files in the hierarchy for SPHINXDIRS builds, not just the root document. Put the boilerplate in a sphinx-includes/subproject-index.rst file, and include it at the end of the root document for subproject builds in an ad-hoc source-read extension defined in conf.py. For now, keep having the boilerplate in translations, because this approach currently doesn't cover translated index link headers. Cc: Jonathan Corbet <corbet@lwn.net> Cc: Mauro Carvalho Chehab <mchehab@kernel.org> Cc: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jani Nikula <jani.nikula@intel.com> Tested-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> [jc: did s/doctree/kern_doc_dir/ ] Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260123143149.2024303-1-jani.nikula@intel.com>
48 lines
906 B
ReStructuredText
48 lines
906 B
ReStructuredText
=======================
|
|
DMAEngine documentation
|
|
=======================
|
|
|
|
DMAEngine documentation provides documents for various aspects of DMAEngine
|
|
framework.
|
|
|
|
DMAEngine development documentation
|
|
-----------------------------------
|
|
|
|
This book helps with DMAengine internal APIs and guide for DMAEngine device
|
|
driver writers.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
provider
|
|
|
|
DMAEngine client documentation
|
|
------------------------------
|
|
|
|
This book is a guide to device driver writers on how to use the Slave-DMA
|
|
API of the DMAEngine. This is applicable only for slave DMA usage only.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
client
|
|
|
|
DMA Test documentation
|
|
----------------------
|
|
|
|
This book introduces how to test DMA drivers using dmatest module.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
dmatest
|
|
|
|
PXA DMA documentation
|
|
----------------------
|
|
|
|
This book adds some notes about PXA DMA
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
pxa_dma
|