[PATCH] staging: vchiq: Reformat Kconfig help texts

[PATCH] staging: vchiq: Reformat Kconfig help texts

[Stefan Wahren]

The lines in the VCHIQ Kconfig help texts are too long, which makes
it hard to read the menuconfig. So shorten them to restore the
readability.

Signed-off-by: Stefan Wahren <wahrenst@gmx.net>
---
 drivers/staging/vc04_services/Kconfig | 33 +++++++++++++++------------
 1 file changed, 18 insertions(+), 15 deletions(-)

diff --git a/drivers/staging/vc04_services/Kconfig b/drivers/staging/vc04_services/Kconfig
index 31e58c9d1a11..982445dd317b 100644
--- a/drivers/staging/vc04_services/Kconfig
+++ b/drivers/staging/vc04_services/Kconfig
@@ -16,27 +16,30 @@ config BCM2835_VCHIQ
 	depends on HAS_DMA
 	imply VCHIQ_CDEV
 	help
-		Broadcom BCM2835 and similar SoCs have a VPU called VideoCore. This config
-		enables the VCHIQ driver, which implements a messaging interface between
-		the kernel and the firmware running on VideoCore. Other drivers use this
-		interface to communicate to the VPU. More specifically, the VCHIQ driver is
-		used by audio/video and camera drivers as well as for implementing MMAL
-		API, which is in turn used by several multimedia services on the BCM2835
-		family of SoCs.
-		Defaults to Y when the Broadcom Videocore services are included in
-		the build, N otherwise.
+		Broadcom BCM2835 and similar SoCs have a VPU called VideoCore.
+		This config enables the VCHIQ driver, which implements a
+		messaging interface between the kernel and the firmware running
+		on VideoCore. Other drivers use this interface to communicate to
+		the VPU. More specifically, the VCHIQ driver is used by
+		audio/video and camera drivers as well as for implementing MMAL
+		API, which is in turn used by several multimedia services on the
+		BCM2835 family of SoCs.
+		Defaults to Y when the Broadcom Videocore services are included
+		in the build, N otherwise.

 if BCM2835_VCHIQ

 config VCHIQ_CDEV
 	bool "VCHIQ Character Driver"
 	help
-		Enable the creation of VCHIQ character driver. The cdev exposes ioctls used
-		by userspace libraries and testing tools to interact with VideoCore, via
-		the VCHIQ core driver (Check BCM2835_VCHIQ for more info).
-		This can be set to 'N' if the VideoCore communication is not needed by
-		userspace but only by other kernel modules (like bcm2835-audio).  If not
-		sure, set this to 'Y'.
+		Enable the creation of VCHIQ character driver. The cdev exposes
+		ioctls used by userspace libraries and testing tools to interact
+		with VideoCore, via the VCHIQ core driver (Check BCM2835_VCHIQ
+		for more info).
+		This can be set to 'N' if the VideoCore communication is not
+		needed by userspace but only by other kernel modules
+		(like bcm2835-audio).
+		If not sure, set this to 'Y'.

 endif

--
2.34.1


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

Re: [PATCH] staging: vchiq: Reformat Kconfig help texts

[Laurent Pinchart]

Hi Stefan,

Thank you for the patch.

On Sun, Apr 14, 2024 at 04:45:15PM +0200, Stefan Wahren wrote:
> The lines in the VCHIQ Kconfig help texts are too long, which makes
> it hard to read the menuconfig. So shorten them to restore the
> readability.
> 
> Signed-off-by: Stefan Wahren <wahrenst@gmx.net>
> ---
>  drivers/staging/vc04_services/Kconfig | 33 +++++++++++++++------------
>  1 file changed, 18 insertions(+), 15 deletions(-)
> 
> diff --git a/drivers/staging/vc04_services/Kconfig b/drivers/staging/vc04_services/Kconfig
> index 31e58c9d1a11..982445dd317b 100644
> --- a/drivers/staging/vc04_services/Kconfig
> +++ b/drivers/staging/vc04_services/Kconfig
> @@ -16,27 +16,30 @@ config BCM2835_VCHIQ
>  	depends on HAS_DMA
>  	imply VCHIQ_CDEV
>  	help
> -		Broadcom BCM2835 and similar SoCs have a VPU called VideoCore. This config
> -		enables the VCHIQ driver, which implements a messaging interface between
> -		the kernel and the firmware running on VideoCore. Other drivers use this
> -		interface to communicate to the VPU. More specifically, the VCHIQ driver is
> -		used by audio/video and camera drivers as well as for implementing MMAL
> -		API, which is in turn used by several multimedia services on the BCM2835
> -		family of SoCs.
> -		Defaults to Y when the Broadcom Videocore services are included in
> -		the build, N otherwise.
> +		Broadcom BCM2835 and similar SoCs have a VPU called VideoCore.
> +		This config enables the VCHIQ driver, which implements a
> +		messaging interface between the kernel and the firmware running
> +		on VideoCore. Other drivers use this interface to communicate to
> +		the VPU. More specifically, the VCHIQ driver is used by
> +		audio/video and camera drivers as well as for implementing MMAL
> +		API, which is in turn used by several multimedia services on the
> +		BCM2835 family of SoCs.

If you want two paragraphs, you should add a blank line here. Otherwise,
you should remove the line break. Same below.

> +		Defaults to Y when the Broadcom Videocore services are included
> +		in the build, N otherwise.
> 
>  if BCM2835_VCHIQ
> 
>  config VCHIQ_CDEV
>  	bool "VCHIQ Character Driver"
>  	help
> -		Enable the creation of VCHIQ character driver. The cdev exposes ioctls used
> -		by userspace libraries and testing tools to interact with VideoCore, via
> -		the VCHIQ core driver (Check BCM2835_VCHIQ for more info).
> -		This can be set to 'N' if the VideoCore communication is not needed by
> -		userspace but only by other kernel modules (like bcm2835-audio).  If not
> -		sure, set this to 'Y'.
> +		Enable the creation of VCHIQ character driver. The cdev exposes
> +		ioctls used by userspace libraries and testing tools to interact
> +		with VideoCore, via the VCHIQ core driver (Check BCM2835_VCHIQ
> +		for more info).
> +		This can be set to 'N' if the VideoCore communication is not
> +		needed by userspace but only by other kernel modules
> +		(like bcm2835-audio).
> +		If not sure, set this to 'Y'.

This should be paired with a "default y", although I think it would be
better to disable it by default. That's unrelated to this patch though,
so

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

> 
>  endif
> 

-- 
Regards,

Laurent Pinchart

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