Skip to contentSkip to conversation

staging: speakup: checkpatch cleanups

PATCH Superseded Arushi Singhal 3 participants 6 messages Mar 13, 2017 Staging

v2 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

v2 cover staging: speakup: checkpatch cleanups

Improve readability by fixing multiple checkpatch.pl issues in speakup driver.

Arushi Singhal (2):
staging: speakup: Added blank line after function/struct/union/enum
declarations
staging: speakup: fix "Alignment match open parenthesis"

 drivers/staging/speakup/kobjects.c     | 2 +-
 drivers/staging/speakup/main.c         | 1 +
 drivers/staging/speakup/serialio.c     | 1 +
 drivers/staging/speakup/speakup_dtlk.c | 1 +
 4 files changed, 4 insertions(+), 1 deletion(-)
Signature · 1 line
2.11.0
#1 lore raw

PATCH v2 1/2 staging: speakup: Added blank line after function/struct/union/enum declarations

This patch fixes the warnings reported by checkpatch.pl for please use a blank line after function/struct/union/enum declarations.

---
changes in v2
- change the subject to make it more relevant.

 drivers/staging/speakup/main.c         | 1 +
 drivers/staging/speakup/serialio.c     | 1 +
 drivers/staging/speakup/speakup_dtlk.c | 1 +
 3 files changed, 3 insertions(+)
drivers/staging/speakup/main.c +1 -0
index 6786cfab7460..4b750ec8cd59 100644
@@ -108,6 +108,7 @@ enum {
 	CT_Window,
 	CT_Max
 };
+
 #define read_all_mode CT_Max
 
 static struct tty_struct *tty;
drivers/staging/speakup/serialio.c +1 -0
index aade52ee15a0..d51e382cb835 100644
@@ -21,6 +21,7 @@ static void start_serial_interrupt(int irq);
 static const struct old_serial_port rs_table[] = {
 	SERIAL_PORT_DFNS
 };
+
 static const struct old_serial_port *serstate;
 static int timeouts;
 
drivers/staging/speakup/speakup_dtlk.c +1 -0
index eede2d82183a..c0b2208aa8a7 100644
@@ -43,6 +43,7 @@ static int port_forced;
 static unsigned int synth_portlist[] = {
 		 0x25e, 0x29e, 0x2de, 0x31e, 0x35e, 0x39e, 0
 };
+
 static u_char synth_status;
 
 static struct var_t vars[] = {
Signature · 1 line
2.11.0
#2 lore raw

Re: [Outreachy kernel] [PATCH v2 1/2] staging: speakup: Added blank line after function/struct/union/enum declarations

Remember to use the imperative. "Add blank line...". You could just drop function/struct/union/enum. Just declarations is fine.

Quoted 3 lines · Arushi Singhal

This patch fixes the warnings reported by checkpatch.pl for please use a blank line after function/struct/union/enum declarations.

Again, it does not say what you have done, and only focuses on the message you have fixed.

julia

Quoted 56 lines

---
changes in v2
- change the subject to make it more relevant.

 drivers/staging/speakup/main.c         | 1 +
 drivers/staging/speakup/serialio.c     | 1 +
 drivers/staging/speakup/speakup_dtlk.c | 1 +
 3 files changed, 3 insertions(+)
drivers/staging/speakup/main.c +1 -0
index 6786cfab7460..4b750ec8cd59 100644
@@ -108,6 +108,7 @@ enum {
 	CT_Window,
 	CT_Max
 };
+
 #define read_all_mode CT_Max
 
 static struct tty_struct *tty;
drivers/staging/speakup/serialio.c +1 -0
index aade52ee15a0..d51e382cb835 100644
@@ -21,6 +21,7 @@ static void start_serial_interrupt(int irq);
 static const struct old_serial_port rs_table[] = {
 	SERIAL_PORT_DFNS
 };
+
 static const struct old_serial_port *serstate;
 static int timeouts;
 
drivers/staging/speakup/speakup_dtlk.c +1 -1
index eede2d82183a..c0b2208aa8a7 100644
@@ -43,6 +43,7 @@ static int port_forced;
 static unsigned int synth_portlist[] = {
 		 0x25e, 0x29e, 0x2de, 0x31e, 0x35e, 0x39e, 0
 };
+
 static u_char synth_status;
 
 static struct var_t vars[] = {
--

2.11.0

--
You received this message because you are subscribed to the Google Groups "outreachy-kernel" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected].
To view this discussion on the web visit https://groups.google.com/d/msgid/outreachy-kernel/20170313204018.24601-2-arushisinghal19971997%40gmail.com.
For more options, visit https://groups.google.com/d/optout.

#3 lore raw

Re: [PATCH v2 1/2] staging: speakup: Added blank line after function/struct/union/enum declarations

In reply to Arushi Singhal

Hello,

Quoted 3 lines · Arushi Singhal

This patch fixes the warnings reported by checkpatch.pl for please use a blank line after function/struct/union/enum declarations.

I haven't seen this pointed out by others before: starting a commit message with "This patch..." is redundant (it is a commit message, thus what it describes is surely a patch) and most times leads to bad style commit messages.

In this case the commit message can simply be:

Add a blank line after enum and struct declarations.

or

Ensure that enum and struct declarations are followed by a blank line.

Cheers,
Daniele

Quoted 48 lines

---
changes in v2
- change the subject to make it more relevant.

 drivers/staging/speakup/main.c         | 1 +
 drivers/staging/speakup/serialio.c     | 1 +
 drivers/staging/speakup/speakup_dtlk.c | 1 +
 3 files changed, 3 insertions(+)
drivers/staging/speakup/main.c +1 -0
index 6786cfab7460..4b750ec8cd59 100644
@@ -108,6 +108,7 @@ enum {
 	CT_Window,
 	CT_Max
 };
+
 #define read_all_mode CT_Max
 
 static struct tty_struct *tty;
drivers/staging/speakup/serialio.c +1 -0
index aade52ee15a0..d51e382cb835 100644
@@ -21,6 +21,7 @@ static void start_serial_interrupt(int irq);
 static const struct old_serial_port rs_table[] = {
 	SERIAL_PORT_DFNS
 };
+
 static const struct old_serial_port *serstate;
 static int timeouts;
 
drivers/staging/speakup/speakup_dtlk.c +1 -0
index eede2d82183a..c0b2208aa8a7 100644
@@ -43,6 +43,7 @@ static int port_forced;
 static unsigned int synth_portlist[] = {
 		 0x25e, 0x29e, 0x2de, 0x31e, 0x35e, 0x39e, 0
 };
+
 static u_char synth_status;
 
 static struct var_t vars[] = {
#4 lore raw

PATCH v2 2/2 staging: speakup: fix "Alignment match open parenthesis"

In reply to Arushi Singhal

Fix checkpatch issues: "CHECK: Alignment should match open parenthesis".

---
 drivers/staging/speakup/kobjects.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/staging/speakup/kobjects.c +1 -1
index 8a586323b728..ca85476e3ff7 100644
@@ -93,7 +93,7 @@ static void report_char_chartab_status(int reset, int received, int used,
 	} else if (received) {
 		len = snprintf(buf, sizeof(buf),
 			       " updated %d of %d %s\n",
-				used, received, object_type[do_characters]);
+			       used, received, object_type[do_characters]);
 		if (rejected)
 			snprintf(buf + (len - 1), sizeof(buf) - (len - 1),
 				 " with %d reject%s\n",
Signature · 1 line
2.11.0
#5 lore raw

Re: [Outreachy kernel] [PATCH v2 2/2] staging: speakup: fix "Alignment match open parenthesis"

Quoted 1 line · Arushi Singhal

Fix checkpatch issues: "CHECK: Alignment should match open parenthesis".

You don't have to send another revision just for this issue, but the commit message would be better as "Align arguments with open parenthesis". Something that explains what you did, rather than what warning message you fixed. In this case, the thing you did is pretty obvious from the warning message, but that might not always be the case. So it is better to get used to writing commit messages that explain what you did and why, rather than what error message you fixed. If you force yourself to write a commit message without using the word fix, you will probably come up with a good solution.

julia

Quoted 29 lines
---
 drivers/staging/speakup/kobjects.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/staging/speakup/kobjects.c +1 -2
index 8a586323b728..ca85476e3ff7 100644
@@ -93,7 +93,7 @@ static void report_char_chartab_status(int reset, int received, int used,
 	} else if (received) {
 		len = snprintf(buf, sizeof(buf),
 			       " updated %d of %d %s\n",
-				used, received, object_type[do_characters]);
+			       used, received, object_type[do_characters]);
 		if (rejected)
 			snprintf(buf + (len - 1), sizeof(buf) - (len - 1),
 				 " with %d reject%s\n",
--

2.11.0

--
You received this message because you are subscribed to the Google Groups "outreachy-kernel" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected].
To view this discussion on the web visit https://groups.google.com/d/msgid/outreachy-kernel/20170313204018.24601-3-arushisinghal19971997%40gmail.com.
For more options, visit https://groups.google.com/d/optout.