]> www.infradead.org Git - linux.git/commitdiff
net: drop special comment style
authorJohannes Berg <johannes.berg@intel.com>
Mon, 19 Aug 2024 09:09:43 +0000 (11:09 +0200)
committerDavid S. Miller <davem@davemloft.net>
Fri, 23 Aug 2024 09:21:02 +0000 (10:21 +0100)
As we discussed in the room at netdevconf earlier this week,
drop the requirement for special comment style for netdev.

For checkpatch, the general check accepts both right now, so
simply drop the special request there as well.

Acked-by: Stephen Hemminger <stephen@networkplumber.org>
Signed-off-by: Johannes Berg <johannes.berg@intel.com>
Acked-by: Jakub Kicinski <kuba@kernel.org>
Signed-off-by: David S. Miller <davem@davemloft.net>
Documentation/process/coding-style.rst
Documentation/process/maintainer-netdev.rst
scripts/checkpatch.pl

index 04f6aa377a5db1d2c232f39f7a1a74895c413978..8e30c8f7697d5ebd704b02065f0678efb36e917a 100644 (file)
@@ -629,18 +629,6 @@ The preferred style for long (multi-line) comments is:
         * with beginning and ending almost-blank lines.
         */
 
-For files in net/ and drivers/net/ the preferred style for long (multi-line)
-comments is a little different.
-
-.. code-block:: c
-
-       /* The preferred comment style for files in net/ and drivers/net
-        * looks like this.
-        *
-        * It is nearly the same as the generally preferred comment style,
-        * but there is no initial almost-blank line.
-        */
-
 It's also important to comment data, whether they are basic types or derived
 types.  To this end, use just one data declaration per line (no commas for
 multiple data declarations).  This leaves you room for a small comment on each
index fe8616397d63bef3520e909e899d55aa796c279e..30d24eecdaaa97441b9fdf216afa92eb16cbd175 100644 (file)
@@ -355,23 +355,6 @@ just do it. As a result, a sequence of smaller series gets merged quicker and
 with better review coverage. Re-posting large series also increases the mailing
 list traffic.
 
-Multi-line comments
-~~~~~~~~~~~~~~~~~~~
-
-Comment style convention is slightly different for networking and most of
-the tree.  Instead of this::
-
-  /*
-   * foobar blah blah blah
-   * another line of text
-   */
-
-it is requested that you make it look like this::
-
-  /* foobar blah blah blah
-   * another line of text
-   */
-
 Local variable ordering ("reverse xmas tree", "RCS")
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
index 39032224d504f13b9139ffa1b00f76761aaf5902..4427572b24771ddb1f2bf3de3176f9437f643951 100755 (executable)
@@ -4015,16 +4015,6 @@ sub process {
                        }
                }
 
-# Block comment styles
-# Networking with an initial /*
-               if ($realfile =~ m@^(drivers/net/|net/)@ &&
-                   $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
-                   $rawline =~ /^\+[ \t]*\*/ &&
-                   $realline > 3) { # Do not warn about the initial copyright comment block after SPDX-License-Identifier
-                       WARN("NETWORKING_BLOCK_COMMENT_STYLE",
-                            "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
-               }
-
 # Block comments use * on subsequent lines
                if ($prevline =~ /$;[ \t]*$/ &&                 #ends in comment
                    $prevrawline =~ /^\+.*?\/\*/ &&             #starting /*