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

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

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Thu, 14 Apr 2022 18:21:22 +0200
From:   Greg Kroah-Hartman <gregkh@...uxfoundation.org>
To:     Adrien Thierry <athierry@...hat.com>
Cc:     Nicolas Saenz Julienne <nsaenz@...nel.org>,
        Florian Fainelli <f.fainelli@...il.com>,
        Ray Jui <rjui@...adcom.com>,
        Scott Branden <sbranden@...adcom.com>,
        bcm-kernel-feedback-list@...adcom.com,
        Maxime Ripard <mripard@...nel.org>,
        Takashi Iwai <tiwai@...e.com>, linux-staging@...ts.linux.dev,
        linux-rpi-kernel@...ts.infradead.org,
        linux-arm-kernel@...ts.infradead.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 1/2] staging: bcm2835-audio: fully describe config symbol

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@...hat.com>
> ---
>  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