From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932846AbdK2NsD (ORCPT ); Wed, 29 Nov 2017 08:48:03 -0500 Received: from mga11.intel.com ([192.55.52.93]:61263 "EHLO mga11.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753102AbdK2NsB (ORCPT ); Wed, 29 Nov 2017 08:48:01 -0500 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.44,473,1505804400"; d="scan'208";a="10988926" Date: Wed, 29 Nov 2017 19:21:34 +0530 From: Vinod Koul To: Masanari Iida 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 Message-ID: <20171129135133.GC32417@localhost> References: <20171128151656.27369-1-standby24x7@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20171128151656.27369-1-standby24x7@gmail.com> User-Agent: Mutt/1.5.24 (2015-08-30) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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 > --- > 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