lkml.org 
[lkml]   [2017]   [Nov]   [29]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH] dmaengine: doc : Fix warning "Title underline too short" while make xmldocs
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

\
 
 \ /
  Last update: 2017-11-29 14:49    [W:0.036 / U:0.704 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site