[PATCH] staging: vme: enhance the help paragraphs for clarity

[PATCH] staging: vme: enhance the help paragraphs for clarity

[Dorine Tipo]

- Revise the help paragraphs to fully describe the config symbol

These changes were made to enhance the clarity of the help text, ensuring
users can better understand the configuration options, their purposes, and
their relevance to their specific hardware setups.

Signed-off-by: Dorine Tipo <dorine.a.tipo@gmail.com>
---
 drivers/staging/vme_user/Kconfig | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/drivers/staging/vme_user/Kconfig b/drivers/staging/vme_user/Kconfig
index d65cc5510649..65a3e769090d 100644
--- a/drivers/staging/vme_user/Kconfig
+++ b/drivers/staging/vme_user/Kconfig
@@ -4,6 +4,11 @@ menuconfig VME_BUS
 	depends on PCI
 	help
 	  If you say Y here you get support for the VME bridge Framework.
+          The VME Bridge Framework provides a set of tools and drivers
+          for VMEbus systems, allowing seamless integration of VME devices
+          with your PCI-enabled hardware. Select 'Y' to enable this feature
+          if you have VMEbus-based hardware or intend to use VME devices in
+          your system.
 
 if VME_BUS
 
@@ -14,7 +19,10 @@ config VME_TSI148
 	depends on HAS_DMA
 	help
 	 If you say Y here you get support for the Tundra TSI148 VME bridge
-	 chip.
+	 chip. This bridge chip provides compatibility for VMEbus systems, allowing
+         communication with various VME devices. If you have hardware that
+         includes the Tundra TSI148 VME bridge, or if you plan to use VME
+         devices with your system, choose 'Y' to enable this feature.
 
 config VME_FAKE
 	tristate "Fake"
-- 
2.25.1

Re: [PATCH] staging: vme: enhance the help paragraphs for clarity

[Julia Lawall]

On Sun, 29 Oct 2023, Dorine Tipo wrote:

> - Revise the help paragraphs to fully describe the config symbol
>
> These changes were made to enhance the clarity of the help text, ensuring
> users can better understand the configuration options, their purposes, and
> their relevance to their specific hardware setups.

Where did you get the information from?

julia

>
> Signed-off-by: Dorine Tipo <dorine.a.tipo@gmail.com>
> ---
>  drivers/staging/vme_user/Kconfig | 10 +++++++++-
>  1 file changed, 9 insertions(+), 1 deletion(-)
>
> diff --git a/drivers/staging/vme_user/Kconfig b/drivers/staging/vme_user/Kconfig
> index d65cc5510649..65a3e769090d 100644
> --- a/drivers/staging/vme_user/Kconfig
> +++ b/drivers/staging/vme_user/Kconfig
> @@ -4,6 +4,11 @@ menuconfig VME_BUS
>  	depends on PCI
>  	help
>  	  If you say Y here you get support for the VME bridge Framework.
> +          The VME Bridge Framework provides a set of tools and drivers
> +          for VMEbus systems, allowing seamless integration of VME devices
> +          with your PCI-enabled hardware. Select 'Y' to enable this feature
> +          if you have VMEbus-based hardware or intend to use VME devices in
> +          your system.
>
>  if VME_BUS
>
> @@ -14,7 +19,10 @@ config VME_TSI148
>  	depends on HAS_DMA
>  	help
>  	 If you say Y here you get support for the Tundra TSI148 VME bridge
> -	 chip.
> +	 chip. This bridge chip provides compatibility for VMEbus systems, allowing
> +         communication with various VME devices. If you have hardware that
> +         includes the Tundra TSI148 VME bridge, or if you plan to use VME
> +         devices with your system, choose 'Y' to enable this feature.
>
>  config VME_FAKE
>  	tristate "Fake"
> --
> 2.25.1
>
>
>

Re: [PATCH] staging: vme: enhance the help paragraphs for clarity

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 1688 bytes --]

[Cc'ing driver contributors found via get_maintainer.pl. Also Cc: Charles from
linux-doc mailing list as wording patches like this one most likely suit him.]

On Sun, Oct 29, 2023 at 06:03:46PM +0000, Dorine Tipo wrote:
> diff --git a/drivers/staging/vme_user/Kconfig b/drivers/staging/vme_user/Kconfig
> index d65cc5510649..65a3e769090d 100644
> --- a/drivers/staging/vme_user/Kconfig
> +++ b/drivers/staging/vme_user/Kconfig
> @@ -4,6 +4,11 @@ menuconfig VME_BUS
>  	depends on PCI
>  	help
>  	  If you say Y here you get support for the VME bridge Framework.
> +          The VME Bridge Framework provides a set of tools and drivers
> +          for VMEbus systems, allowing seamless integration of VME devices
> +          with your PCI-enabled hardware. Select 'Y' to enable this feature
> +          if you have VMEbus-based hardware or intend to use VME devices in
> +          your system.
>  
>  if VME_BUS
>  
> @@ -14,7 +19,10 @@ config VME_TSI148
>  	depends on HAS_DMA
>  	help
>  	 If you say Y here you get support for the Tundra TSI148 VME bridge
> -	 chip.
> +	 chip. This bridge chip provides compatibility for VMEbus systems, allowing
> +         communication with various VME devices. If you have hardware that
> +         includes the Tundra TSI148 VME bridge, or if you plan to use VME
> +         devices with your system, choose 'Y' to enable this feature.

Dorine,

Are you sure that your description properly describes what these modules
are doing? And most importantly, when users select them as module (choose
M), what will the modules be named?

Confused...

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH] staging: vme: enhance the help paragraphs for clarity

[Greg KH]

On Wed, Nov 01, 2023 at 02:39:53PM +0700, Bagas Sanjaya wrote:
> [Cc'ing driver contributors found via get_maintainer.pl. Also Cc: Charles from
> linux-doc mailing list as wording patches like this one most likely suit him.]

Please do not, that's the responsibility of the outreachy applicant to
do, as it is documented very well what needs to happen here.

thanks,

greg k-h

Re: [PATCH] staging: vme: enhance the help paragraphs for clarity

[Bagas Sanjaya]

On 01/11/2023 15:09, Greg KH wrote:
> On Wed, Nov 01, 2023 at 02:39:53PM +0700, Bagas Sanjaya wrote:
>> [Cc'ing driver contributors found via get_maintainer.pl. Also Cc: Charles from
>> linux-doc mailing list as wording patches like this one most likely suit him.]
> 
> Please do not, that's the responsibility of the outreachy applicant to
> do, as it is documented very well what needs to happen here.
> 

OK, thanks!

-- 
An old man doll... just what I always wanted! - Clara

[PATCH] staging: vme: enhance the help paragraphs for clarity

[Dorine Tipo]

>
Please do not, that's the responsibility of the outreachy applicant to
do, as it is documented very well what needs to happen here.
>

Hello, 

I have CC'd all the driver contributors for this driver.