* [PATCH] dmaengine: doc : Fix warning "Title underline too short" while make xmldocs
@ 2017-11-28 15:16 Masanari Iida
2017-11-29 13:51 ` Vinod Koul
2017-12-02 15:37 ` Jonathan Corbet
0 siblings, 2 replies; 3+ messages in thread
From: Masanari Iida @ 2017-11-28 15:16 UTC (permalink / raw)
To: corbet, vinod.koul, linux-doc, linux-kernel; +Cc: Masanari Iida
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>
---
Documentation/driver-api/dmaengine/client.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/driver-api/dmaengine/client.rst b/Documentation/driver-api/dmaengine/client.rst
index 6245c99af8c1..fbbb2831f29f 100644
--- a/Documentation/driver-api/dmaengine/client.rst
+++ b/Documentation/driver-api/dmaengine/client.rst
@@ -185,7 +185,7 @@ The details of these operations are:
void dma_async_issue_pending(struct dma_chan *chan);
Further APIs:
-------------
+-------------
1. Terminate APIs
--
2.15.0.374.g5f9953d2c365
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] dmaengine: doc : Fix warning "Title underline too short" while make xmldocs
2017-11-28 15:16 [PATCH] dmaengine: doc : Fix warning "Title underline too short" while make xmldocs Masanari Iida
@ 2017-11-29 13:51 ` Vinod Koul
2017-12-02 15:37 ` Jonathan Corbet
1 sibling, 0 replies; 3+ messages in thread
From: Vinod Koul @ 2017-11-29 13:51 UTC (permalink / raw)
To: Masanari Iida; +Cc: corbet, linux-doc, linux-kernel
On Wed, Nov 29, 2017 at 12:16:56AM +0900, Masanari Iida wrote:
> 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"
> Documentation/driver-api/dmaengine/client.rst:188:
> WARNING: Title underline too short.
>
> Further APIs:
> ------------
>
> Signed-off-by: Masanari Iida <standby24x7@gmail.com>
> ---
> Documentation/driver-api/dmaengine/client.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/driver-api/dmaengine/client.rst b/Documentation/driver-api/dmaengine/client.rst
> index 6245c99af8c1..fbbb2831f29f 100644
> --- a/Documentation/driver-api/dmaengine/client.rst
> +++ b/Documentation/driver-api/dmaengine/client.rst
> @@ -185,7 +185,7 @@ The details of these operations are:
> void dma_async_issue_pending(struct dma_chan *chan);
>
> Further APIs:
> -------------
> +-------------
>
> 1. Terminate APIs
>
> --
> 2.15.0.374.g5f9953d2c365
>
--
~Vinod
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] dmaengine: doc : Fix warning "Title underline too short" while make xmldocs
2017-11-28 15:16 [PATCH] dmaengine: doc : Fix warning "Title underline too short" while make xmldocs Masanari Iida
2017-11-29 13:51 ` Vinod Koul
@ 2017-12-02 15:37 ` Jonathan Corbet
1 sibling, 0 replies; 3+ messages in thread
From: Jonathan Corbet @ 2017-12-02 15:37 UTC (permalink / raw)
To: Masanari Iida; +Cc: vinod.koul, linux-doc, linux-kernel
On Wed, 29 Nov 2017 00:16:56 +0900
Masanari Iida <standby24x7@gmail.com> 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
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2017-12-02 15:37 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-11-28 15:16 [PATCH] dmaengine: doc : Fix warning "Title underline too short" while make xmldocs Masanari Iida
2017-11-29 13:51 ` Vinod Koul
2017-12-02 15:37 ` Jonathan Corbet
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox