public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH]The patch fixes the following warning generated by running the
@ 2024-08-21 16:15 Sayyad Abid
  2024-08-21 16:56 ` Dan Carpenter
  2024-08-21 16:57 ` Dan Carpenter
  0 siblings, 2 replies; 4+ messages in thread
From: Sayyad Abid @ 2024-08-21 16:15 UTC (permalink / raw)
  To: philipp.g.hortmann; +Cc: gregkh, linux-staging, linux-kernel, abid-sayyad

From: abid-sayyad <sayyad.abid16@gmail.com>

drivers/staging/vt6656/Kconfig

WARNING: please write a help paragraph that fully describes the config symbol
2: FILE: drivers/staging/vt6656/Kconfig:2:
config VT6656
	tristate "VIA Technologies VT6656 support"
	depends on MAC80211 && USB && WLAN && m
	select FW_LOADER
	help

total: 0 errors, 1 warnings, 0 checks, 7 lines checked

NOTE: For some of the reported defects, checkpatch may be able to
   mechanically convert to the typical style using --fix or --fix-inplace.

drivers/staging/vt6656/Kconfig has style problems, please review.


Signed-off-by: abid-sayyad <sayyad.abid16@gmail.com>
---

 drivers/staging/vt6656/Kconfig | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/drivers/staging/vt6656/Kconfig b/drivers/staging/vt6656/Kconfig
index f52a3f1d9a2e..a37dc3c921ea 100644
--- a/drivers/staging/vt6656/Kconfig
+++ b/drivers/staging/vt6656/Kconfig
@@ -4,4 +4,10 @@ config VT6656
 	depends on MAC80211 && USB && WLAN && m
 	select FW_LOADER
 	help
-	  This is a vendor-written driver for VIA VT6656.
+	  This is a vendor-written driver for VIA VT6656. VIA Technology VT6656
+	  is a wireless network controller that operates on the 2.4GHz band.
+
+	  If you have this hardware and wish to use it, set 'Y' or 'M' here to
+	  compile the driver either directly in the kernel or as a module
+	  respectively. If you are unsure, it is safe to set it to 'M'.
+	  If enabled it loads the firmware for the mentioned device.
--
2.39.2


^ permalink raw reply related	[flat|nested] 4+ messages in thread

* Re: [PATCH]The patch fixes the following warning generated by running the
  2024-08-21 16:15 [PATCH]The patch fixes the following warning generated by running the Sayyad Abid
@ 2024-08-21 16:56 ` Dan Carpenter
  2024-08-21 16:57 ` Dan Carpenter
  1 sibling, 0 replies; 4+ messages in thread
From: Dan Carpenter @ 2024-08-21 16:56 UTC (permalink / raw)
  To: Sayyad Abid; +Cc: philipp.g.hortmann, gregkh, linux-staging, linux-kernel

On Wed, Aug 21, 2024 at 09:45:39PM +0530, Sayyad Abid wrote:
> From: abid-sayyad <sayyad.abid16@gmail.com>
> 

Your email from header is better than this From header.

> diff --git a/drivers/staging/vt6656/Kconfig b/drivers/staging/vt6656/Kconfig
> index f52a3f1d9a2e..a37dc3c921ea 100644
> --- a/drivers/staging/vt6656/Kconfig
> +++ b/drivers/staging/vt6656/Kconfig
> @@ -4,4 +4,10 @@ config VT6656
>  	depends on MAC80211 && USB && WLAN && m
>  	select FW_LOADER
>  	help
> -	  This is a vendor-written driver for VIA VT6656.
> +	  This is a vendor-written driver for VIA VT6656. VIA Technology VT6656
> +	  is a wireless network controller that operates on the 2.4GHz band.
> +
> +	  If you have this hardware and wish to use it, set 'Y' or 'M' here to
> +	  compile the driver either directly in the kernel or as a module
> +	  respectively. If you are unsure, it is safe to set it to 'M'.
> +	  If enabled it loads the firmware for the mentioned device.

I feel like this second paragraph doesn't add any value.  Just ignore checkpatch
when it tells you to do stuff like this.

regards,
dan carpenter


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH]The patch fixes the following warning generated by running the
  2024-08-21 16:15 [PATCH]The patch fixes the following warning generated by running the Sayyad Abid
  2024-08-21 16:56 ` Dan Carpenter
@ 2024-08-21 16:57 ` Dan Carpenter
       [not found]   ` <ZsYiwZDh3yegyERk@debian>
  1 sibling, 1 reply; 4+ messages in thread
From: Dan Carpenter @ 2024-08-21 16:57 UTC (permalink / raw)
  To: Sayyad Abid; +Cc: philipp.g.hortmann, gregkh, linux-staging, linux-kernel

Also the subject is not in the correct format.

regards,
dan carpenter


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH]The patch fixes the following warning generated by running the
       [not found]     ` <00cc036e-6e12-4c9d-9c97-953c452606f3@stanley.mountain>
@ 2024-08-21 17:44       ` Sayyad Abid
  0 siblings, 0 replies; 4+ messages in thread
From: Sayyad Abid @ 2024-08-21 17:44 UTC (permalink / raw)
  To: Dan Carpenter; +Cc: linux-kernel

On Wed, Aug 21, 2024 at 08:37:26PM +0300, Dan Carpenter wrote:
> On Wed, Aug 21, 2024 at 10:54:17PM +0530, Sayyad Abid wrote:
> > On Wed, Aug 21, 2024 at 07:57:30PM +0300, Dan Carpenter wrote:
> > > Also the subject is not in the correct format.
> > >
> > > regards,
> > > dan carpenter
> > >
> > Noted, I'll keep this in mind from further patches. Also could you please guide
> > to a fairly updated TODO list or somewhere from where I could look for tasks to
> > start. The lists I found in the kernel tree all are too old to be left with any
> > task, I apologise if I am asking a stupid thing.
>
> Please always keep the mailing lists in the CC.
>
> Try searching for KTODO on lore.  Maybe that will produce some useful ideas.
> https://lore.kernel.org/all/?q=KTODO
>
> Try running checkpatch or Smatch on drivers/staging/media/atomisp/
>
> regards,
> dan carpenter
Thank you for mentioning the TODOs. I'll look into the KTODO and checkpatch.
I'll also make sure to keep the list in the cc.

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2024-08-21 17:44 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-08-21 16:15 [PATCH]The patch fixes the following warning generated by running the Sayyad Abid
2024-08-21 16:56 ` Dan Carpenter
2024-08-21 16:57 ` Dan Carpenter
     [not found]   ` <ZsYiwZDh3yegyERk@debian>
     [not found]     ` <00cc036e-6e12-4c9d-9c97-953c452606f3@stanley.mountain>
2024-08-21 17:44       ` Sayyad Abid

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox