Re: Javadoc comments in kernel source?

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Fri, Jun 11, 2004 at 09:58:34AM -0500, Timur Tabi wrote:
> Greg KH wrote:
> 
> >If not, feel free to ask specific questions.  Also take a look at some
> >code that implements it (like the public functions in
> >drivers/usb/core/usb.c for example.)
> 
> What about things like prefixes for variable names?  For instance,
> I like to specify i_, o_, or io_ as prefixes for a function parameter to
> indicate that this parameter is input only, output only, or both, 
> respectively.

Ick ick ick.

Did you read the section about variable names?

Have you ever seen variable names like this in the core kernel code?

In short, no, don't do this.

> If I try to submit a driver to the official kernel tree with code like 
> this, will it count against me?

It will be rejected as you obviously didn't read and follow the kernel
coding style guidelines :)

As to why it is important that you do follow the guidelines, again, see
my OLS paper on the subject.

Good luck,

greg k-h

--
Kernelnewbies: Help each other learn about the Linux kernel.
Archive:       http://mail.nl.linux.org/kernelnewbies/
FAQ:           http://kernelnewbies.org/faq/


[Index of Archives]     [Newbies FAQ]     [Linux Kernel Mentors]     [Linux Kernel Development]     [IETF Annouce]     [Git]     [Networking]     [Security]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux SCSI]     [Linux ACPI]
  Powered by Linux