All of lore.kernel.org
 help / color / mirror / Atom feed
From: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
To: Adrien Thierry <athierry@redhat.com>
Cc: Nicolas Saenz Julienne <nsaenz@kernel.org>,
	Florian Fainelli <f.fainelli@gmail.com>,
	Ray Jui <rjui@broadcom.com>,
	Scott Branden <sbranden@broadcom.com>,
	bcm-kernel-feedback-list@broadcom.com,
	Maxime Ripard <mripard@kernel.org>, Takashi Iwai <tiwai@suse.com>,
	linux-staging@lists.linux.dev,
	linux-rpi-kernel@lists.infradead.org,
	linux-arm-kernel@lists.infradead.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH 1/2] staging: bcm2835-audio: fully describe config symbol
Date: Thu, 14 Apr 2022 18:21:22 +0200	[thread overview]
Message-ID: <YlhKAoWCdAKMqIht@kroah.com> (raw)
In-Reply-To: <20220414152340.68932-2-athierry@redhat.com>

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

WARNING: multiple messages have this Message-ID (diff)
From: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
To: Adrien Thierry <athierry@redhat.com>
Cc: Nicolas Saenz Julienne <nsaenz@kernel.org>,
	Florian Fainelli <f.fainelli@gmail.com>,
	Ray Jui <rjui@broadcom.com>,
	Scott Branden <sbranden@broadcom.com>,
	bcm-kernel-feedback-list@broadcom.com,
	Maxime Ripard <mripard@kernel.org>, Takashi Iwai <tiwai@suse.com>,
	linux-staging@lists.linux.dev,
	linux-rpi-kernel@lists.infradead.org,
	linux-arm-kernel@lists.infradead.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH 1/2] staging: bcm2835-audio: fully describe config symbol
Date: Thu, 14 Apr 2022 18:21:22 +0200	[thread overview]
Message-ID: <YlhKAoWCdAKMqIht@kroah.com> (raw)
In-Reply-To: <20220414152340.68932-2-athierry@redhat.com>

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

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

  reply	other threads:[~2022-04-14 16:21 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-04-14 15:23 [PATCH 0/2] staging: bcm2835-audio: minor code style cleanups Adrien Thierry
2022-04-14 15:23 ` Adrien Thierry
2022-04-14 15:23 ` [PATCH 1/2] staging: bcm2835-audio: fully describe config symbol Adrien Thierry
2022-04-14 15:23   ` Adrien Thierry
2022-04-14 16:21   ` Greg Kroah-Hartman [this message]
2022-04-14 16:21     ` Greg Kroah-Hartman
2022-04-14 15:23 ` [PATCH 2/2] staging: bcm2835-audio: clean code style warnings Adrien Thierry
2022-04-14 15:23   ` Adrien Thierry
2022-04-14 16:20   ` Greg Kroah-Hartman
2022-04-14 16:20     ` Greg Kroah-Hartman

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=YlhKAoWCdAKMqIht@kroah.com \
    --to=gregkh@linuxfoundation.org \
    --cc=athierry@redhat.com \
    --cc=bcm-kernel-feedback-list@broadcom.com \
    --cc=f.fainelli@gmail.com \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-rpi-kernel@lists.infradead.org \
    --cc=linux-staging@lists.linux.dev \
    --cc=mripard@kernel.org \
    --cc=nsaenz@kernel.org \
    --cc=rjui@broadcom.com \
    --cc=sbranden@broadcom.com \
    --cc=tiwai@suse.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.