mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2026-01-12 01:20:14 +00:00
c44166fe5f
Changeset 58ad30cf91f0 ("docs: fix reference to core-api/namespaces.rst")
enabled a new feature at Sphinx: it will now generate index for each
document title, plus to each chapter inside it.
There's a drawback, though: one document cannot have two sections
with the same name anymore.
A followup patch will change the logic of autosectionlabel to
avoid most creating references for every single section title,
but still we need to be able to reference the chapters inside
a document.
There are a few places where there are two chapters with the
same name. This patch renames one of the chapters, in order to
avoid symbol conflict within the same document.
PS.: as I don't speach Chinese, I had some help from a friend
(Wen Liu) at the Chinese translation for "publishing patches"
for this document:
Documentation/translations/zh_CN/process/5.Posting.rst
Fixes: 58ad30cf91f0 ("docs: fix reference to core-api/namespaces.rst")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/2bffb91e4a63d41bf5fae1c23e1e8b3bba0b8806.1584716446.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
56 lines
983 B
ReStructuredText
56 lines
983 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
|
|
|
|
.. only:: subproject and html
|
|
|
|
Indices
|
|
=======
|
|
|
|
* :ref:`genindex`
|