Chekpatch reports a warning in Kconfig

WARNING: please write a help paragraph that fully describes the config symbol
         with at least 4 lines

To fix this , more accurate description is added.

Signed-off-by: Jules Irenge <jbi.octave@gmail.com>
---
 drivers/staging/gpib/Kconfig | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/drivers/staging/gpib/Kconfig b/drivers/staging/gpib/Kconfig
index aa01538d5beb..1255035a995a 100644
--- a/drivers/staging/gpib/Kconfig
+++ b/drivers/staging/gpib/Kconfig
@@ -41,10 +41,11 @@ config GPIB_AGILENT_82357A
 	select GPIB_COMMON
 	depends on USB
 	help
-	  Enable support for Agilent/Keysight 82357x USB dongles.
+	  Enable support for the Agilent/Keysight 82357A and 82357B USB-to-GPIB adapters.
+	  This device allows GPIB instruments to be controlled over a USB connection.
 
-	  To compile this driver as a module, choose M here: the module will be
-	  called agilent_82357a.
+	  To compile this driver as a module, choose M here. The resulting module will be
+	  named agilent_82357a.
 
 config GPIB_CEC_PCI
 	tristate "CEC PCI board"
-- 
2.49.0

On Wed, Apr 16, 2025 at 02:07:44PM +0100, Jules Irenge wrote:
> Chekpatch reports a warning in Kconfig
> 
> WARNING: please write a help paragraph that fully describes the config symbol
>          with at least 4 lines
> 
> To fix this , more accurate description is added.
> 
> Signed-off-by: Jules Irenge <jbi.octave@gmail.com>
> ---
>  drivers/staging/gpib/Kconfig | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/staging/gpib/Kconfig b/drivers/staging/gpib/Kconfig
> index aa01538d5beb..1255035a995a 100644
> --- a/drivers/staging/gpib/Kconfig
> +++ b/drivers/staging/gpib/Kconfig
> @@ -41,10 +41,11 @@ config GPIB_AGILENT_82357A
>  	select GPIB_COMMON
>  	depends on USB
>  	help
> -	  Enable support for Agilent/Keysight 82357x USB dongles.
> +	  Enable support for the Agilent/Keysight 82357A and 82357B USB-to-GPIB adapters.
> +	  This device allows GPIB instruments to be controlled over a USB connection.
>  
> -	  To compile this driver as a module, choose M here: the module will be
> -	  called agilent_82357a.
> +	  To compile this driver as a module, choose M here. The resulting module will be
> +	  named agilent_82357a.
>  
>  config GPIB_CEC_PCI
>  	tristate "CEC PCI board"
> -- 
> 2.49.0
> 
> 

Hi,

This is the friendly patch-bot of Greg Kroah-Hartman.  You have sent him
a patch that has triggered this response.  He used to manually respond
to these common problems, but in order to save his sanity (he kept
writing the same thing over and over, yet to different people), I was
created.  Hopefully you will not take offence and will fix the problem
in your patch and resubmit it so that it can be accepted into the Linux
kernel tree.

You are receiving this message because of the following common error(s)
as indicated below:

- You did not specify a description of why the patch is needed, or
  possibly, any description at all, in the email body.  Please read the
  section entitled "The canonical patch format" in the kernel file,
  Documentation/process/submitting-patches.rst for what is needed in
  order to properly describe the change.

- You did not write a descriptive Subject: for the patch, allowing Greg,
  and everyone else, to know what this patch is all about.  Please read
  the section entitled "The canonical patch format" in the kernel file,
  Documentation/process/submitting-patches.rst for what a proper
  Subject: line should look like.

If you wish to discuss this problem further, or you have questions about
how to resolve this issue, please feel free to respond to this email and
Greg will reply once he has dug out from the pending patches received
from other developers.

thanks,

greg k-h's patch email bot