linux.git/Documentation/driver-api/dmaengine/client.rst, branch v5.7 Linux kernel source tree dmaengine: doc: fix warnings/issues of client.rst 2020-02-13T15:05:24+00:00 Changbin Du changbin.du@gmail.com 2020-02-04T12:51:15+00:00 83c49f734463980802d6dba376f69e787fb07a8e This fixed some warnings/issues of client.rst. o Need a blank line for enumerated lists. o Do not create section in enumerated list. o Remove suffix ':' from section title. Signed-off-by: Changbin Du <changbin.du@gmail.com> Link: https://lore.kernel.org/r/20200204125115.12128-1-changbin.du@gmail.com Signed-off-by: Vinod Koul <vkoul@kernel.org> 
This fixed some warnings/issues of client.rst.
 o Need a blank line for enumerated lists.
 o Do not create section in enumerated list.
 o Remove suffix ':' from section title.

Signed-off-by: Changbin Du <changbin.du@gmail.com>
Link: https://lore.kernel.org/r/20200204125115.12128-1-changbin.du@gmail.com
Signed-off-by: Vinod Koul <vkoul@kernel.org>
dmaengine: doc: Properly indent metadata title 2020-01-28T13:03:39+00:00 Vinod Koul vkoul@kernel.org 2020-01-28T12:50:32+00:00 08607e8319c76a8a37fc2a0ecac328833f4e9f39 The newly added metadata documentation title was not properly indented resulting in doc build break: Sphinx parallel build error: docutils.utils.SystemMessage: /linux/Documentation/driver-api/dmaengine/client.rst:155: (SEVERE/4) Unexpected section title. Optional: per descriptor metadata --------------------------------- Fix this by doing the right indent Reported-by: Michael Ellerman <mpe@ellerman.id.au> Fixes: 7d083ae98357 ("dmaengine: doc: Add sections for per descriptor metadata support") Link: https://lore.kernel.org/r/20200128125032.1650816-1-vkoul@kernel.org Signed-off-by: Vinod Koul <vkoul@kernel.org> 
The newly added metadata documentation title was not properly indented
resulting in doc build break:

  Sphinx parallel build error:
  docutils.utils.SystemMessage: /linux/Documentation/driver-api/dmaengine/client.rst:155: (SEVERE/4) Unexpected section title.

  Optional: per descriptor metadata
  ---------------------------------

Fix this by doing the right indent

Reported-by: Michael Ellerman <mpe@ellerman.id.au>
Fixes: 7d083ae98357 ("dmaengine: doc: Add sections for per descriptor metadata support")
Link: https://lore.kernel.org/r/20200128125032.1650816-1-vkoul@kernel.org
Signed-off-by: Vinod Koul <vkoul@kernel.org>
dmaengine: doc: Add sections for per descriptor metadata support 2020-01-21T05:36:12+00:00 Peter Ujfalusi peter.ujfalusi@ti.com 2019-12-23T11:04:43+00:00 7d083ae983573de16e3ab0bfd47486996d211417 Update the provider and client documentation with details about the metadata support. Signed-off-by: Peter Ujfalusi <peter.ujfalusi@ti.com> Reviewed-by: Tero Kristo <t-kristo@ti.com> Tested-by: Keerthy <j-keerthy@ti.com> Reviewed-by: Grygorii Strashko <grygorii.strashko@ti.com> Link: https://lore.kernel.org/r/20191223110458.30766-4-peter.ujfalusi@ti.com Signed-off-by: Vinod Koul <vkoul@kernel.org> 
Update the provider and client documentation with details about the
metadata support.

Signed-off-by: Peter Ujfalusi <peter.ujfalusi@ti.com>
Reviewed-by: Tero Kristo <t-kristo@ti.com>
Tested-by: Keerthy <j-keerthy@ti.com>
Reviewed-by: Grygorii Strashko <grygorii.strashko@ti.com>
Link: https://lore.kernel.org/r/20191223110458.30766-4-peter.ujfalusi@ti.com
Signed-off-by: Vinod Koul <vkoul@kernel.org>
Documentation :dmaengine: clarify DMA desc. pointer after submission 2019-02-11T11:53:32+00:00 Federico Vaga federico.vaga@cern.ch 2019-02-08T15:30:38+00:00 85ed4f43db866fe1ea90bcca8cd1e5e628f04a6f It clarifies that the DMA description pointer returned by `dmaengine_prep_*` function should not be used after submission. Signed-off-by: Federico Vaga <federico.vaga@cern.ch> Signed-off-by: Vinod Koul <vkoul@kernel.org> 
It clarifies that the DMA description pointer returned by
`dmaengine_prep_*` function should not be used after submission.

Signed-off-by: Federico Vaga <federico.vaga@cern.ch>
Signed-off-by: Vinod Koul <vkoul@kernel.org>
dmaengine: doc : Fix warning "Title underline too short" while make xmldocs 2017-12-02T15:36:50+00:00 Masanari Iida standby24x7@gmail.com 2017-11-28T15:16:56+00:00 e50806a9fd0132402a62cb3161d786335662072f This patch fix following warning during 'make xmldocs' Documentation/driver-api/dmaengine/client.rst:188: WARNING: Title underline too short. Further APIs: ------------ Signed-off-by: Masanari Iida <standby24x7@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 
This patch fix following warning during 'make xmldocs'

Documentation/driver-api/dmaengine/client.rst:188:
WARNING: Title underline too short.

Further APIs:
------------

Signed-off-by: Masanari Iida <standby24x7@gmail.com>

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
dmaengine: doc: ReSTize client API doc 2017-11-05T17:03:27+00:00 Vinod Koul vinod.koul@intel.com 2017-11-03T04:49:39+00:00 eeb1c6435293e9d3c30b21579bd5154c013f2843 This converts and moves client API file with some format changes for RST style Signed-off-by: Vinod Koul <vinod.koul@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 
This converts and moves client API file with some format
changes for RST style

Signed-off-by: Vinod Koul <vinod.koul@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>