Subject: Improved help text for rtl8712
Subsystems (2)
PATCH 1/1 Subject: Improved help text for rtl8712
From df9050d0dff9e4160172dbc910f718c16095fc8d Mon Sep 17 00:00:00 2001
From: Ayaan Mirza Baig <[email protected]>
Date: Wed, 6 Mar 2024 19:53:12 +0530
Rewrote the help text paragraph for R8712U and R8712_TX_AGGR
--- drivers/staging/rtl8712/Kconfig | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-)
(quoted diff) +0 -0
b/drivers/staging/rtl8712/Kconfig
index 8de26425225b..c3ea29003fc6 100644
drivers/staging/rtl8712/Kconfig +0 -1
@@ -6,16 +6,17 @@ config R8712U select WEXT_PRIV select FW_LOADER help - This option adds the Realtek RTL8712 USB device such as
the
- D-Link DWA-130.
-
- If built as a module, it will be called r8712u.
+ This is a driver for the RealTek RTL8712U USB 802.11n
wireless
+ network card. It is also known as the RTL8192SU. + Used in devices like the D-Link DWA-130 + If built as a module, it will be called r8712u.
config R8712_TX_AGGR
bool "Realtek RTL8712U Transmit Aggregation code" depends on R8712U && BROKEN
help
- This option provides transmit aggregation for the Realtek
- RTL8712 USB device.
-
+ This option enables Realtek RTL8712U transmit aggregation,
+ which can improve performance by combining multiple small
packets into fewer,
+ larger ones for transmission.
+ This can be especially beneficial for large data transfers.
Signature · 1 line
2.34.1
Hi Ayaan,
This patch obviously got a bit mangled in transmission as you can see. Read the first paragraph of Documentation/process/email-clients.rst, but then do a google search on how to use git send-email. Send patches to yourself until you figure it out.
After that use scripts/get_maintainer.pl to create the correct CC list.
Quoted 7 lines · Ayaan Mirza Baig
Quoted 2 lines
From
df9050d0dff9e4160172dbc910f718c16095fc8dMon Sep 17 00:00:00 2001From: Ayaan Mirza Baig <[email protected]>
Date: Wed, 6 Mar 2024 19:53:12 +0530Rewrote the help text paragraph for R8712U and
R8712_TX_AGGR
The commit message needs to say what wrong with the original help text and why you are re-writing it.
I suspect that you're re-writing it just to make it longer than the 4 (?) line minimum. Don't bother with that. Checkpatch is overly strict. People can understand the help text fine even though it's just 3 lines.
regards,
dan carpenter
Also the subject is wrong. You left out the subsystem prefix. It should be:
Subject: [PATCH] Staging: rtl8712: Improve help text for rtl8712
regards,
dan carpenter
Thanks for the tip! Will keep in mind!
Quoted 9 lines · Dan Carpenter
Also the subject is wrong. You left out the subsystem prefix. It should be:
Subject: [PATCH] Staging: rtl8712: Improve help text for rtl8712
regards,
dan carpenter
Signature · 2 lines
Regards, Ayaan Mirza Baig