Skip to contentSkip to conversation

dmaengine: doc : Fix warning "Title underline too short" while make xmldocs

PATCH Applied Masanari Iida 3 participants 3 messages Nov 28, 2017 – Dec 2, 2017

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

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
index 6245c99af8c1..fbbb2831f29f 100644
@@ -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
#1 lore raw
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:
------------

---
 Documentation/driver-api/dmaengine/client.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/driver-api/dmaengine/client.rst +1 -1
index 6245c99af8c1..fbbb2831f29f 100644
@@ -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
Signature · 1 line
~Vinod
maintainer Applied
#2 lore raw
In reply to Masanari Iida
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