Re: [PATCH 1/2] staging: bcm2835-audio: fully describe config symbol

[Greg Kroah-Hartman]

On Thu, Apr 14, 2022 at 11:23:39AM -0400, Adrien Thierry wrote:
> Explain SND_BCM2835 config option in more detail, especially the
> implications of using the bcm2835-audio driver in conjunction with vc4
> for HDMI audio.
> 
> Reported by checkpatch:
> 
> WARNING: please write a help paragraph that fully describes the config
> symbol
> FILE: drivers/staging/vc04_services/bcm2835-audio/Kconfig:2
> 
> Signed-off-by: Adrien Thierry <athierry@xxxxxxxxxx>
> ---
>  drivers/staging/vc04_services/bcm2835-audio/Kconfig | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/staging/vc04_services/bcm2835-audio/Kconfig b/drivers/staging/vc04_services/bcm2835-audio/Kconfig
> index d32ea348e846..7cd0b3c0cae4 100644
> --- a/drivers/staging/vc04_services/bcm2835-audio/Kconfig
> +++ b/drivers/staging/vc04_services/bcm2835-audio/Kconfig
> @@ -5,5 +5,8 @@ config SND_BCM2835
>  	select SND_PCM
>  	select BCM2835_VCHIQ
>  	help
> -	  Say Y or M if you want to support BCM2835 built in audio
> +	  Say Y or M if you want to support BCM2835 built in audio.
> +	  This driver handles both 3.5mm and HDMI audio. However, please
> +	  note that when HDMI audio is enabled with this driver, the vc4
> +	  driver cannot be used simultaneously, otherwise HDMI will break.

"will break"?  What exactly do you mean by this?  What will fail?  How
will it fail?  Why does this matter in a Kconfig help text?

thanks,

greg k-h