Skip to contentSkip to conversation

net: Fix comment block per style guide

PATCH Superseded Travis Davies 2 participants 2 messages Nov 18, 2019 – Nov 19, 2019

Subsystems (3)

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 net: Fix comment block per style guide

This patch places /* and */ on separate lines for a multiline block comment, in order to keep code style consistant with majority of blocks throughout the file.

This will prevent a checkpatch.pl warning:
'Block comments use a trailing */ on a separate line'

---
-v2: Fix commit description, and subject line as suggested by
Julie Lawall

 include/linux/netdevice.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
include/linux/netdevice.h +4 -2
index c20f190b4c18..a2605e043fa2 100644
@@ -95,9 +95,11 @@ void netdev_set_default_ethtool_ops(struct net_device *dev,
 #define NET_XMIT_CN		0x02	/* congestion notification	*/
 #define NET_XMIT_MASK		0x0f	/* qdisc flags in net/sch_generic.h */
 
-/* NET_XMIT_CN is special. It does not guarantee that this packet is lost. It
+/*
+ * NET_XMIT_CN is special. It does not guarantee that this packet is lost. It
  * indicates that the device will soon be dropping packets, or already drops
- * some packets of the same priority; prompting us to send less aggressively. */
+ * some packets of the same priority; prompting us to send less aggressively.
+ */
 #define net_xmit_eval(e)	((e) = NET_XMIT_CN ? 0 : (e))
 #define net_xmit_errno(e)	((e) != NET_XMIT_CN ? -ENOBUFS : 0)
 
Signature · 1 line
2.21.0
maintainer
#1 lore raw

From: Travis Davies <[email protected]>
Date: Mon, 18 Nov 2019 14:06:09 -0800

Quoted 11 lines

This patch places /* and */ on separate lines for a multiline block comment, in order to keep code style consistant with majority of blocks throughout the file.

This will prevent a checkpatch.pl warning:
'Block comments use a trailing */ on a separate line'

---
-v2: Fix commit description, and subject line as suggested by
Julie Lawall

The comment style used here is so pervasive in the kernel networking, I'm really not thrilled to start seeing these picked away one by one. So much churn...

Sorry I'm not applying this...