staging: vme: enhance the help paragraphs for clarity
PATCH 1/1 staging: vme: enhance the help paragraphs for clarity
- 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.
--- drivers/staging/vme_user/Kconfig | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-)
drivers/staging/vme_user/Kconfig +9 -1
@@ -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"
Signature · 1 line
2.25.1
Quoted 5 lines · 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.
Where did you get the information from?
julia
Quoted 39 lines
Signed-off-by Dorine Tipo <[email protected]>--- drivers/staging/vme_user/Kconfig | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-)drivers/staging/vme_user/Kconfig +9
-2@@ -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
[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.]
Quoted 17 lines · Dorine Tipo
drivers/staging/vme_user/Kconfig +5
-0@@ -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
drivers/staging/vme_user/Kconfig config VME_TSI148 · line 25
Quoted 8 lines
drivers/staging/vme_user/Kconfig +4
-1@@ -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...
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Greg KH
maintainerQuoted 2 lines · Bagas Sanjaya
[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
Quoted 7 lines · Greg KH
Quoted 2 lines · Bagas Sanjaya
[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!
Signature · 1 line
An old man doll... just what I always wanted! - Clara
PATCH 1/1 staging: vme: enhance the help paragraphs for clarity
In reply to Bagas SanjayaQuoted 1 line
Please do not, that's the responsibility of the outreachy applicant to do, as it is documented very well what needs to happen here.
Quoted 1 line
Hello,
I have CC'd all the driver contributors for this driver.