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

From: Pierre-Louis Bossart
Date: Tue Nov 21 2017 - 16:32:55 EST

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@xxxxxxxxxxxxxxx>
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
+ 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.


Alsa-devel mailing list