lists.openwall.net   lists  /  announce  owl-users  owl-dev  john-users  john-dev  passwdqc-users  yescrypt  popa3d-users  /  oss-security  kernel-hardening  musl  sabotage  tlsify  passwords  /  crypt-dev  xvendor  /  Bugtraq  Full-Disclosure  linux-kernel  linux-netdev  linux-ext4  PHC 
Open Source and information security mailing list archives
 
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Date:   Wed, 29 Nov 2017 19:21:34 +0530
From:   Vinod Koul <vinod.koul@...el.com>
To:     Masanari Iida <standby24x7@...il.com>
Cc:     corbet@....net, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [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@...il.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

Powered by blists - more mailing lists