[PATCH] staging: gdm72xx: Split Kconfig descriptions into more lines

[PATCH] staging: gdm72xx: Split Kconfig descriptions into more lines

[Daniel Grimshaw]

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

I am a high school student trying to become familiar with linux kernel
development. This is my first patch.

checkpatch.pl throws a warning that config WIMAX_GDM72XX_QOS, config
WIMAX_GDM72XX_K_MODE, and config WIMAX_GDM72XX_USB do not have enough
of a description. By splitting the current description into multiple
lines, the warning is removed.

The module still worked with these changes when tested.

Signed-off-by: Daniel Grimshaw <grimshaw@linux.vnet.ibm.com>


[-- Attachment #2: patchfile --]
[-- Type: text/plain, Size: 1047 bytes --]

diff --git a/drivers/staging/gdm72xx/Kconfig b/drivers/staging/gdm72xx/Kconfig
index bf11a7f..bfbe3d6 100644
--- a/drivers/staging/gdm72xx/Kconfig
+++ b/drivers/staging/gdm72xx/Kconfig
@@ -14,14 +14,19 @@ config WIMAX_GDM72XX_QOS
 	bool "Enable QoS support"
 	default n
 	help
-	  Enable Quality of Service support based on the data protocol of
+	  Enable Quality of
+	  Service support based
+	  on the data protocol of
 	  transmitting packets.
 
 config WIMAX_GDM72XX_K_MODE
 	bool "Enable K mode"
 	default n
 	help
-	  Enable support for proprietary functions for KT (Korea Telecom).
+	  Enable support
+	  for proprietary
+	  functions for KT
+	  (Korea Telecom).
 
 config WIMAX_GDM72XX_WIMAX2
 	bool "Enable WiMAX2 support"
@@ -37,7 +42,9 @@ config WIMAX_GDM72XX_USB
 	bool "USB interface"
 	depends on (USB = y || USB = WIMAX_GDM72XX)
 	help
-	  Select this option if the WiMAX module interfaces with the host
+	  Select this option
+	  if the WiMAX module
+	  interfaces with the host
 	  processor via USB.
 
 config WIMAX_GDM72XX_SDIO

Re: [PATCH] staging: gdm72xx: Split Kconfig descriptions into more lines

[Dan Carpenter]

Heh.  No.  That's not useful.  :P

Checkpatch.pl warnings are only good if they make the code better for
humans.  Otherwise ignore them.

regards,
dan carpenter

Re: [PATCH] staging: gdm72xx: Split Kconfig descriptions into more lines

[Luis de Bethencourt]

On Thu, Jun 25, 2015 at 03:36:46PM -0700, Daniel Grimshaw wrote:
> I am a high school student trying to become familiar with linux kernel
> development. This is my first patch.
> 
> checkpatch.pl throws a warning that config WIMAX_GDM72XX_QOS, config
> WIMAX_GDM72XX_K_MODE, and config WIMAX_GDM72XX_USB do not have enough
> of a description. By splitting the current description into multiple
> lines, the warning is removed.
> 
> The module still worked with these changes when tested.
> 
> Signed-off-by: Daniel Grimshaw <grimshaw@linux.vnet.ibm.com>
> 

Hello Daniel,

Nice to see people submitting their first patch. Welcome :)

Besides what Dan Carpenter said, I wanted to add a comment about how to send
patches. Normally maintainers don't accept patches as attachments. You want to
send the patch inline.

I recommend these two resources to learn how:
http://kernelnewbies.org/FirstKernelPatch
Greg's talk "Write and Submit your first Linux kernel Patch"
  - https://www.youtube.com/watch?v=LLBrBBImJt4

There is a bit of a learning curve. It is normal to not get it right the first
time. Feel free to email me directly with any further questions about this.

Happy hacking,
Luis