From: Davidlohr Bueso <dave@gnu.org>
To: kernel-janitors@vger.kernel.org
Subject: Re: Coding style questions
Date: Mon, 14 Dec 2009 19:01:26 +0000 [thread overview]
Message-ID: <20091214190126.GA17084@fencepost.gnu.org> (raw)
In-Reply-To: <4B19C331.3080805@picohost.net>
On Fri, Dec 04, 2009 at 06:19:29PM -0800, Radu Voicilas wrote:
> 1. When you have a function prototype with a comment following it (which obviously it's a bad thing), like this one
>
> u32 eprom_read(struct net_device *dev,u32 addr); //reads a 16 bits word
>
> and want to fix it, how would one do it:
>
> /* Read a 16 bits word. */
> u32 eprom_read(struct net_device *dev, u32 addr);
>
> or the comment should go into the implementation file ?
It should go in the implementation file, but common sense is always best.
Be sure to read Documentation/CodingStyle.
Davidlohr
prev parent reply other threads:[~2009-12-14 19:01 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2009-12-05 2:19 Coding style questions Radu Voicilas
2009-12-14 19:01 ` Davidlohr Bueso [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=20091214190126.GA17084@fencepost.gnu.org \
--to=dave@gnu.org \
--cc=kernel-janitors@vger.kernel.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