xiaomi-sm8450/android_kernel_xiaomi_sm8450
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
935,158 Commits 2 Branches 0 Tags
b51cd7c834dba0ec9300337e16e5aa5bf65bd04c
Commit Graph

6 Commits

Author SHA1 Message Date
Changbin Du
83c49f7344 dmaengine: doc: fix warnings/issues of client.rst 
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>
 2020-02-13 20:35:24 +05:30
Vinod Koul
08607e8319 dmaengine: doc: Properly indent metadata title 
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: 7d083ae983 ("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>
 2020-01-28 18:33:39 +05:30
Peter Ujfalusi
7d083ae983 dmaengine: doc: Add sections for per descriptor metadata support 
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>
 2020-01-21 11:06:12 +05:30
Federico Vaga
85ed4f43db Documentation :dmaengine: clarify DMA desc. pointer after submission 
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>
 2019-02-11 17:23:32 +05:30
Masanari Iida
e50806a9fd dmaengine: doc : Fix warning "Title underline too short" while make xmldocs 
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>
 2017-12-02 08:36:50 -07:00
Vinod Koul
eeb1c64352 dmaengine: doc: ReSTize client API doc 
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>
 2017-11-05 10:03:27 -07:00