From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id A40587A for ; Thu, 14 Apr 2022 16:21:25 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id CA412C385A5; Thu, 14 Apr 2022 16:21:24 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=linuxfoundation.org; s=korg; t=1649953285; bh=VfHrJD3Nz0ZjdlZiEWgIt64kysymj8lJEi2ZpJKeQCQ=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=zIGcEsJHdFirNEXRfXkkgsn8xZbYHTC80OtiTRTWC8b8h9fB5udNZAqlHRkYFfgTm 9rPCM0hVyJyhyJNlreNvcHGTH20eybGzQ2EUzNN9I7efMngHmJDDnWIPmg+tCQuW/B 6LFZ5DdXC9+hg30esoB+KTtDiS0X6r4g/2MQSvi8= Date: Thu, 14 Apr 2022 18:21:22 +0200 From: Greg Kroah-Hartman To: Adrien Thierry Cc: Nicolas Saenz Julienne , Florian Fainelli , Ray Jui , Scott Branden , bcm-kernel-feedback-list@broadcom.com, Maxime Ripard , Takashi Iwai , 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 Message-ID: References: <20220414152340.68932-1-athierry@redhat.com> <20220414152340.68932-2-athierry@redhat.com> Precedence: bulk X-Mailing-List: linux-staging@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline 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 > --- > 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 From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 0D564C433F5 for ; Thu, 14 Apr 2022 16:22:29 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:In-Reply-To:MIME-Version:References: Message-ID:Subject:Cc:To:From:Date:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=OUBMWzFxnclExQs/kW/CcKGb+OMiGhnKlTZyYqtfIAU=; b=anyCGOpkFNZ67R OS1gNXTJ6yOoxW4tdAkAXq5W5ZDg+owVmZxmAwLSKBRqzKLSP9HSIfeREqQGVXSeBv9D8qyhTRLDh 5BYAbVRNMasflB8DxvCIeKDq7MYBI0lmB/XocetrcEmEAJCsBYLIdGn1oEd3qUKWQmRuOqmiu5gYG 1lzpRfpWgG1ok77k3/3ItxgsiH5QTE3MbAGlKAQe5EqTEJYQed+HjQNdMq7/bchwnTkqXLMvHzj3x llvpQfO+OPTfpXHT4HdH0BaddGDQmP6nnNUV5Nerl4+h46e7RUe1vrcrrw80k3gBL6ReZz44Y3E5y 81oPL/y3cIPoiMTGehig==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.94.2 #2 (Red Hat Linux)) id 1nf2Dr-006QXc-QL; Thu, 14 Apr 2022 16:21:31 +0000 Received: from ams.source.kernel.org ([2604:1380:4601:e00::1]) by bombadil.infradead.org with esmtps (Exim 4.94.2 #2 (Red Hat Linux)) id 1nf2Do-006QVf-7D; Thu, 14 Apr 2022 16:21:29 +0000 Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ams.source.kernel.org (Postfix) with ESMTPS id AAC2EB82AA6; Thu, 14 Apr 2022 16:21:26 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id CA412C385A5; Thu, 14 Apr 2022 16:21:24 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=linuxfoundation.org; s=korg; t=1649953285; bh=VfHrJD3Nz0ZjdlZiEWgIt64kysymj8lJEi2ZpJKeQCQ=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=zIGcEsJHdFirNEXRfXkkgsn8xZbYHTC80OtiTRTWC8b8h9fB5udNZAqlHRkYFfgTm 9rPCM0hVyJyhyJNlreNvcHGTH20eybGzQ2EUzNN9I7efMngHmJDDnWIPmg+tCQuW/B 6LFZ5DdXC9+hg30esoB+KTtDiS0X6r4g/2MQSvi8= Date: Thu, 14 Apr 2022 18:21:22 +0200 From: Greg Kroah-Hartman To: Adrien Thierry Cc: Nicolas Saenz Julienne , Florian Fainelli , Ray Jui , Scott Branden , bcm-kernel-feedback-list@broadcom.com, Maxime Ripard , Takashi Iwai , 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 Message-ID: References: <20220414152340.68932-1-athierry@redhat.com> <20220414152340.68932-2-athierry@redhat.com> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20220414152340.68932-2-athierry@redhat.com> X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20220414_092128_453246_75910210 X-CRM114-Status: GOOD ( 19.66 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org 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 > --- > 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