linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v2 1/1] net: Fix comment block per style guide
@ 2019-11-18 22:48 Travis Davies
  0 siblings, 0 replies; 5+ messages in thread
From: Travis Davies @ 2019-11-18 22:48 UTC (permalink / raw)
  To: Andrew Morton, David S. Miller, Julia Lawall
  Cc: kernel-janitors, linux-kernel

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 
     Julia Lawall.

 include/linux/netdevice.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h
index c20f190b4c18..a2605e043fa2 100644
--- a/include/linux/netdevice.h
+++ b/include/linux/netdevice.h
@@ -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


^ permalink raw reply related	[flat|nested] 5+ messages in thread

* Re: [PATCH v2 1/1] net: Fix comment block per style guide
  2019-11-18 22:06 Travis Davies
@ 2019-11-19  0:47 ` David Miller
  0 siblings, 0 replies; 5+ messages in thread
From: David Miller @ 2019-11-19  0:47 UTC (permalink / raw)
  To: tdavies; +Cc: akpm, julia.lawall, kernel-janitors, linux-kernel

From: Travis Davies <tdavies@darkphysics.net>
Date: Mon, 18 Nov 2019 14:06:09 -0800

> 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'
> 
> Signed-off-by: Travis Davies <tdavies@darkphysics.net>
> ---
> -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...


^ permalink raw reply	[flat|nested] 5+ messages in thread

* [PATCH v2 1/1] net: Fix comment block per style guide
@ 2019-11-18 22:06 Travis Davies
  2019-11-19  0:47 ` David Miller
  0 siblings, 1 reply; 5+ messages in thread
From: Travis Davies @ 2019-11-18 22:06 UTC (permalink / raw)
  To: Andrew Morton, David S. Miller, Julia Lawall
  Cc: kernel-janitors, linux-kernel

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'

Signed-off-by: Travis Davies <tdavies@darkphysics.net>
---
-v2: Fix commit description, and subject line as suggested by 
     Julie Lawall

 include/linux/netdevice.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h
index c20f190b4c18..a2605e043fa2 100644
--- a/include/linux/netdevice.h
+++ b/include/linux/netdevice.h
@@ -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


^ permalink raw reply related	[flat|nested] 5+ messages in thread

* Re: [PATCH v2 1/1] net: Fix comment block per style guide
  2019-11-18 18:57 Travis Davies
@ 2019-11-18 20:55 ` Julia Lawall
  0 siblings, 0 replies; 5+ messages in thread
From: Julia Lawall @ 2019-11-18 20:55 UTC (permalink / raw)
  To: Travis Davies
  Cc: Andrew Morton, David S. Miller, kernel-janitors, linux-kernel



On Mon, 18 Nov 2019, Travis Davies wrote:

> Signed-off-by: Travis Davies <tdavies@darkphysics.net>
>
> ---
>
> 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

>
>  include/linux/netdevice.h | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
>
> diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h
> index c20f190b4c18..a2605e043fa2 100644
> --- a/include/linux/netdevice.h
> +++ b/include/linux/netdevice.h
> @@ -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
>
>

^ permalink raw reply	[flat|nested] 5+ messages in thread

* [PATCH v2 1/1] net: Fix comment block per style guide
@ 2019-11-18 18:57 Travis Davies
  2019-11-18 20:55 ` Julia Lawall
  0 siblings, 1 reply; 5+ messages in thread
From: Travis Davies @ 2019-11-18 18:57 UTC (permalink / raw)
  To: Andrew Morton, David S. Miller, Julia Lawall
  Cc: kernel-janitors, linux-kernel

Signed-off-by: Travis Davies <tdavies@darkphysics.net>

---

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(-)

diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h
index c20f190b4c18..a2605e043fa2 100644
--- a/include/linux/netdevice.h
+++ b/include/linux/netdevice.h
@@ -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


^ permalink raw reply related	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2019-11-19  0:47 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-11-18 22:48 [PATCH v2 1/1] net: Fix comment block per style guide Travis Davies
  -- strict thread matches above, loose matches on Subject: below --
2019-11-18 22:06 Travis Davies
2019-11-19  0:47 ` David Miller
2019-11-18 18:57 Travis Davies
2019-11-18 20:55 ` Julia Lawall

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).