From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751480AbdKUVcw (ORCPT ); Tue, 21 Nov 2017 16:32:52 -0500 Received: from mga09.intel.com ([134.134.136.24]:5582 "EHLO mga09.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751229AbdKUVcv (ORCPT ); Tue, 21 Nov 2017 16:32:51 -0500 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.44,432,1505804400"; d="scan'208";a="179041219" Subject: Re: [alsa-devel] [RFC PATCH 3/7] ASoC: Intel: document what Kconfig options do To: Takashi Iwai Cc: alsa-devel@alsa-project.org, arnd@arndb.de, vinod.koul@intel.com, linux-kernel@vger.kernel.org, liam.r.girdwood@linux.intel.com, broonie@kernel.org, andriy.shevchenko@linux.intel.com, torvalds@linux-foundation.org References: <20171118000202.22302-1-pierre-louis.bossart@linux.intel.com> <20171118000202.22302-4-pierre-louis.bossart@linux.intel.com> From: Pierre-Louis Bossart Message-ID: Date: Tue, 21 Nov 2017 15:32:48 -0600 User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.11; rv:52.0) Gecko/20100101 Thunderbird/52.4.0 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On 11/21/17 11:09 AM, Takashi Iwai wrote: > On Sat, 18 Nov 2017 01:01:58 +0100, > Pierre-Louis Bossart wrote: >> >> Document what the options are supposed to mean, before clean-up in >> next patch. >> >> No functionality change here. >> >> Signed-off-by: Pierre-Louis Bossart >> --- >> sound/soc/intel/Kconfig | 20 +++++++++++++++++--- >> 1 file changed, 17 insertions(+), 3 deletions(-) >> >> diff --git a/sound/soc/intel/Kconfig b/sound/soc/intel/Kconfig >> index 175b2965ca21..136426d60da0 100644 >> --- a/sound/soc/intel/Kconfig >> +++ b/sound/soc/intel/Kconfig >> @@ -15,16 +15,30 @@ if SND_SOC_INTEL_SST_TOPLEVEL >> >> config SND_SST_IPC >> tristate >> + help >> + This option controls the IPC core for HiFi2 platforms > > A help section for non-selectable config is fine, per se, but in most > cases it's written as a comment. yes, I can move back to a comment. the main point was to explain the simplifications in the next patch > > And, if we do add the help text, it's more important to do that for > selectable items. Currently the help texts are missing for the > platform configs like SND_SOC_INTEL_HASWELL. Ah, that's a miss, I did have a help but I didn't add it in the final RFC version. Will add in v2. > > > thanks, > > Takashi > _______________________________________________ > Alsa-devel mailing list > Alsa-devel@alsa-project.org > http://mailman.alsa-project.org/mailman/listinfo/alsa-devel > From mboxrd@z Thu Jan 1 00:00:00 1970 From: Pierre-Louis Bossart Subject: Re: [RFC PATCH 3/7] ASoC: Intel: document what Kconfig options do Date: Tue, 21 Nov 2017 15:32:48 -0600 Message-ID: References: <20171118000202.22302-1-pierre-louis.bossart@linux.intel.com> <20171118000202.22302-4-pierre-louis.bossart@linux.intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii"; Format="flowed" Content-Transfer-Encoding: 7bit Return-path: Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by alsa0.perex.cz (Postfix) with ESMTP id 59D89266F52 for ; Tue, 21 Nov 2017 22:32:51 +0100 (CET) In-Reply-To: Content-Language: en-US List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: alsa-devel-bounces@alsa-project.org Sender: alsa-devel-bounces@alsa-project.org To: Takashi Iwai Cc: alsa-devel@alsa-project.org, arnd@arndb.de, vinod.koul@intel.com, linux-kernel@vger.kernel.org, liam.r.girdwood@linux.intel.com, broonie@kernel.org, andriy.shevchenko@linux.intel.com, torvalds@linux-foundation.org List-Id: alsa-devel@alsa-project.org On 11/21/17 11:09 AM, Takashi Iwai wrote: > On Sat, 18 Nov 2017 01:01:58 +0100, > Pierre-Louis Bossart wrote: >> >> Document what the options are supposed to mean, before clean-up in >> next patch. >> >> No functionality change here. >> >> Signed-off-by: Pierre-Louis Bossart >> --- >> sound/soc/intel/Kconfig | 20 +++++++++++++++++--- >> 1 file changed, 17 insertions(+), 3 deletions(-) >> >> diff --git a/sound/soc/intel/Kconfig b/sound/soc/intel/Kconfig >> index 175b2965ca21..136426d60da0 100644 >> --- a/sound/soc/intel/Kconfig >> +++ b/sound/soc/intel/Kconfig >> @@ -15,16 +15,30 @@ if SND_SOC_INTEL_SST_TOPLEVEL >> >> config SND_SST_IPC >> tristate >> + help >> + This option controls the IPC core for HiFi2 platforms > > A help section for non-selectable config is fine, per se, but in most > cases it's written as a comment. yes, I can move back to a comment. the main point was to explain the simplifications in the next patch > > And, if we do add the help text, it's more important to do that for > selectable items. Currently the help texts are missing for the > platform configs like SND_SOC_INTEL_HASWELL. Ah, that's a miss, I did have a help but I didn't add it in the final RFC version. Will add in v2. > > > thanks, > > Takashi > _______________________________________________ > Alsa-devel mailing list > Alsa-devel@alsa-project.org > http://mailman.alsa-project.org/mailman/listinfo/alsa-devel >