linux-kernel - Re: [alsa-devel] [RFC PATCH 3/7] ASoC: Intel: document what Kconfig options do

Open Source and information security mailing list archives

Message-ID: <ad219e4f-7f54-27a9-3d07-01d9f3d5d223@linux.intel.com>
Date:   Tue, 21 Nov 2017 15:32:48 -0600
From:   Pierre-Louis Bossart <pierre-louis.bossart@...ux.intel.com>
To:     Takashi Iwai <tiwai@...e.de>
Cc:     alsa-devel@...a-project.org, arnd@...db.de, vinod.koul@...el.com,
        linux-kernel@...r.kernel.org, liam.r.girdwood@...ux.intel.com,
        broonie@...nel.org, andriy.shevchenko@...ux.intel.com,
        torvalds@...ux-foundation.org
Subject: Re: [alsa-devel] [RFC PATCH 3/7] ASoC: Intel: document what Kconfig
 options do

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 <pierre-louis.bossart@...ux.intel.com>
>> ---
>>   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@...a-project.org
> http://mailman.alsa-project.org/mailman/listinfo/alsa-devel
> 

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 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives