kernelnewbies.kernelnewbies.org archive mirror
 help / color / mirror / Atom feed
From: martink@posteo.de (Martin Kepplinger)
To: kernelnewbies@lists.kernelnewbies.org
Subject: checkpatch.pl comment style warnings
Date: Mon, 14 Apr 2014 12:52:05 +0200	[thread overview]
Message-ID: <e4f90bd3961c62c5f6356c7327d686eb@posteo.de> (raw)
In-Reply-To: <CAO+WgCYUSF8bqhA2fvpicj3asvJ4u01n=2S=g3GE6fs2N_k_hQ@mail.gmail.com>

Am 13.04.2014 22:49 schrieb Greg Donald:
> When I run checkpatch.pl -f, it complains about comment blocks like
> 
> /*
>  * foo
>  * bar
>  */
> 
> with "networking block comments don't use an empty /* line, use /* 
> Comment..."
> 
> But I found this: http://fr.it-usenet.org/thread/18772/41342/, which
> makes me think that particular checkpatch.pl warning should possibly
> be ignored for code not in net or drivers/net.
> 
> 1) Are there different preferred commenting styles for networking code
> versus everything else?
> 
> 2) Assuming the comment code above does need fixing, would an example
> fix be as simple as this?
> 
> /* foo
>  * bar
>  */
> 
> 3) What about the very similar comment blocks checkpatch.pl doesn't
> currently complain about, do these need fixing too?
> 
> /**
>  * foo
>  * bar
>  */
> 
> 
> Thanks.

it's not necessary to write a codingstyle patch. that's why it also may 
get rejected by
maintainers. it's necessary to write new code in the kernel's coding 
style.

in https://www.kernel.org/doc/Documentation/CodingStyle everything is 
documented:

For files in net/ and drivers/net/ the preferred style for long 
(multi-line)
comments is a little different.

	/* 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.
	 */

      parent reply	other threads:[~2014-04-14 10:52 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-04-13 20:49 checkpatch.pl comment style warnings Greg Donald
2014-04-13 21:46 ` Greg Freemyer
2014-04-14  0:04   ` Greg Donald
2014-04-14  3:14     ` Greg Freemyer
2014-04-14 10:52 ` Martin Kepplinger [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=e4f90bd3961c62c5f6356c7327d686eb@posteo.de \
    --to=martink@posteo.de \
    --cc=kernelnewbies@lists.kernelnewbies.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).