net: Fix comment block per style guide
Subsystems (3)
PATCH v2 1/1 net: Fix comment block per style guide
Signed-off-by Travis Davies <[email protected]>
---
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'
include/linux/netdevice.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
include/linux/netdevice.h +4 -2
@@ -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
Quoted 10 lines · Travis Davies
Signed-off-by Travis Davies <[email protected]>---
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'
The comments and the signed off by both go above the ---. Comments first. Look at lkml to see what others do.
julia
Quoted 26 lines
include/linux/netdevice.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)include/linux/netdevice.h +4
-3@@ -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) --2.21.0