From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752835AbdLHIu5 (ORCPT ); Fri, 8 Dec 2017 03:50:57 -0500 Received: from mga18.intel.com ([134.134.136.126]:54999 "EHLO mga18.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752530AbdLHIuz (ORCPT ); Fri, 8 Dec 2017 03:50:55 -0500 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.45,377,1508828400"; d="scan'208";a="184813330" Date: Fri, 8 Dec 2017 14:14:54 +0530 From: Vinod Koul To: Srinivas Kandagatla Cc: Jonathan Corbet , Mark Rutland , devicetree@vger.kernel.org, alsa-devel@alsa-project.org, linux-doc@vger.kernel.org, Greg Kroah-Hartman , linux-arm-msm@vger.kernel.org, j.neuschaefer@gmx.net, Rob Herring , linux-kernel@vger.kernel.org, Mark Brown , pombredanne@nexb.com, sdharia@codeaurora.org Subject: Re: [alsa-devel] [PATCH v9 01/13] Documentation: Add SLIMbus summary Message-ID: <20171208084454.GD18649@localhost> References: <20171207102720.21071-1-srinivas.kandagatla@linaro.org> <20171207102720.21071-2-srinivas.kandagatla@linaro.org> <20171207103253.25834a68@lwn.net> <138216ca-4351-f895-fae2-0289cf2a3872@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <138216ca-4351-f895-fae2-0289cf2a3872@linaro.org> 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 Thu, Dec 07, 2017 at 11:22:51PM +0000, Srinivas Kandagatla wrote: > Thankyou for taking time to review the patch, > > On 07/12/17 17:32, Jonathan Corbet wrote: > >On Thu, 7 Dec 2017 10:27:08 +0000 > >srinivas.kandagatla@linaro.org wrote: > > > >A couple of overall comments... > > > >> Documentation/driver-api/index.rst | 1 + > >> Documentation/driver-api/slimbus/index.rst | 15 ++++ > >> Documentation/driver-api/slimbus/summary.rst | 106 +++++++++++++++++++++++++++ > >> 3 files changed, 122 insertions(+) > >> create mode 100644 Documentation/driver-api/slimbus/index.rst > >> create mode 100644 Documentation/driver-api/slimbus/summary.rst > > > >Do we really need a separate subdirectory for a single file? > > > May be not, TBH, I did take some inspiration from soundwire patches. FWIW, SoundWire patches have more Documentation. We have 4 files atm, though they are not part of current series, so a directory looks apt for that > I can drop that in next version. We can think of adding directory if we end > up adding more apis for the new features in future. > > >It seems you have kerneldoc comments for your data structures and at least > >some of your exported symbols. If you really want to document this stuff > >well, I'd suggest finishing out those comments, then pulling them into the > >documentation in the appropriate places. > Am sure all the exported symbols have kernel doc, I will pull them into > relevant sub sections. > > Do you think something like this http://paste.ubuntu.com/26135862/ makes > sense? > > thanks, > srini > > > >Thanks, > > > >jon > > > _______________________________________________ > Alsa-devel mailing list > Alsa-devel@alsa-project.org > http://mailman.alsa-project.org/mailman/listinfo/alsa-devel -- ~Vinod