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

From: Takashi Iwai <tiwai@suse.de>
To: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
Cc: alsa-devel@alsa-project.org, arnd@arndb.de,
	linux-kernel@vger.kernel.org, liam.r.girdwood@linux.intel.com,
	vinod.koul@intel.com, broonie@kernel.org,
	andriy.shevchenko@linux.intel.com, torvalds@linux-foundation.org
Subject: Re: [alsa-devel] [RFC PATCH 3/7] ASoC: Intel: document what Kconfig    options do
Date: Tue, 21 Nov 2017 18:09:24 +0100	[thread overview]
Message-ID: <s5hy3mztv7f.wl-tiwai@suse.de> (raw)
In-Reply-To: <20171118000202.22302-4-pierre-louis.bossart@linux.intel.com>

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@linux.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.

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.

thanks,

Takashi