| Message ID | 20240716134822.028c84bbd92f.Ic187fbc5ba452463ef28feebbd5c18668adb0fec@changeid (mailing list archive) |
|---|---|
| State | Superseded |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | [net-next] net: drop special comment style | expand |
On Tue, 16 Jul 2024 13:48:23 -0700 Johannes Berg <johannes@sipsolutions.net> wrote: > From: Johannes Berg <johannes.berg@intel.com> > > As we just discussed (in the room at netdevconf), 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. > > Signed-off-by: Johannes Berg <johannes.berg@intel.com> Agree, the less special cases the better. Acked-by: Stephen Hemminger <stephen@networkplumber.org>
On 16.07.24 22:48, Johannes Berg wrote: > From: Johannes Berg <johannes.berg@intel.com> > > As we just discussed (in the room at netdevconf), 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. > > Signed-off-by: Johannes Berg <johannes.berg@intel.com> > --- > Documentation/process/maintainer-netdev.rst | 17 ----------------- > scripts/checkpatch.pl | 10 ---------- > 2 files changed, 27 deletions(-) > > diff --git a/Documentation/process/maintainer-netdev.rst b/Documentation/process/maintainer-netdev.rst > index 5e1fcfad1c4c..5a411c52b466 100644 > --- a/Documentation/process/maintainer-netdev.rst > +++ b/Documentation/process/maintainer-netdev.rst I guess you should also remove the section in diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst index 7e768c65aa92..3ccda9f42cfa 100644 --- a/Documentation/process/coding-style.rst +++ b/Documentation/process/coding-style.rst @@ -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
diff --git a/Documentation/process/maintainer-netdev.rst b/Documentation/process/maintainer-netdev.rst index 5e1fcfad1c4c..5a411c52b466 100644 --- a/Documentation/process/maintainer-netdev.rst +++ b/Documentation/process/maintainer-netdev.rst @@ -356,23 +356,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") ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl index 2b812210b412..9a953b9169d6 100755 --- a/scripts/checkpatch.pl +++ b/scripts/checkpatch.pl @@ -3997,16 +3997,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 /*