dmaengine: doc : Fix warning "Title underline too short" while make xmldocs
Subsystems (2)
PATCH 1/1 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:
------------
--- Documentation/driver-api/dmaengine/client.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/driver-api/dmaengine/client.rst +1 -1
@@ -185,7 +185,7 @@ The details of these operations are: void dma_async_issue_pending(struct dma_chan *chan); Further APIs: ------------- +------------- 1. Terminate APIs
Signature · 1 line
2.15.0.374.g5f9953d2c365
Quoted 1 line · Masanari Iida
This patch fix following warning during 'make xmldocs'
The patch title should not document why but should document what the patch does. Checkpatch warns about that.
Perhpas this would make a better title: "fix short topic underline"
Quoted 27 lines
Documentation/driver-api/dmaengine/client.rst:188:
WARNING: Title underline too short.Further APIs:
------------Signed-off-by Masanari Iida <[email protected]>--- Documentation/driver-api/dmaengine/client.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)Documentation/driver-api/dmaengine/client.rst +1
-1@@ -185,7 +185,7 @@ The details of these operations are: void dma_async_issue_pending(struct dma_chan *chan); Further APIs: ------------- +------------- 1. Terminate APIsSignature · 1 line
2.15.0.374.g5f9953d2c365
Signature · 1 line
~Vinod
Quoted 7 lines · On Wed, 29 Nov 2017 00:16:56 +0900 Masanari Iida <[email protected]> wrote:
This patch fix following warning during 'make xmldocs'
Documentation/driver-api/dmaengine/client.rst:188:
WARNING: Title underline too short.Further APIs:
------------
Applied to the docs tree, thanks.
jon