From: Vinod Koul <vinod.koul@intel.com>
To: Masanari Iida <standby24x7@gmail.com>
Cc: corbet@lwn.net, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] dmaengine: doc : Fix warning "Title underline too short" while make xmldocs
Date: Wed, 29 Nov 2017 19:21:34 +0530 [thread overview]
Message-ID: <20171129135133.GC32417@localhost> (raw)
In-Reply-To: <20171128151656.27369-1-standby24x7@gmail.com>
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
next prev parent reply other threads:[~2017-11-29 13:48 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
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 [this message]
2017-12-02 15:37 ` Jonathan Corbet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20171129135133.GC32417@localhost \
--to=vinod.koul@intel.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=standby24x7@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox