public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Rolf Eike Beer <eike-kernel@sf-tec.de>
To: Arjan van de Ven <arjan@infradead.org>
Cc: Diego Calleja <diegocg@gmail.com>,
	Jesper Juhl <jesper.juhl@gmail.com>,
	Linus Torvalds <torvalds@osdl.org>, Andrew Morton <akpm@osdl.org>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	Adrian Bunk <bunk@stusta.de>
Subject: Re: A proposal; making 2.6.20 a bugfix only version.
Date: Thu, 9 Nov 2006 13:45:46 +0100	[thread overview]
Message-ID: <200611091345.51940.eike-kernel@sf-tec.de> (raw)
In-Reply-To: <1163054902.3138.454.camel@laptopd505.fenrus.org>

[-- Attachment #1: Type: text/plain, Size: 1471 bytes --]

Arjan van de Ven wrote:
> On Thu, 2006-11-09 at 00:28 +0100, Diego Calleja wrote:
> > El Wed, 08 Nov 2006 23:22:11 +0100,
> >
> > Arjan van de Ven <arjan@infradead.org> escribió:
> > > > There are many parts of the kernel that are not documented.
> > >
> > > this is where the OSDL Documentation Person will help a lot; a full
> > > time person.
> >
> > Maybe it's just me, but wouldn't be this fixed by just asking developers
> > to document their code?
>
> it's a matter of skills. Someone can be awesome at coding a feature but
> his english and writing skills may be waaaaay down there.

Yes, that's maybe part of the problem. Nevertheless I think we should reject 
every patch that adds new functions of global use (everything that might get 
called from outside this module) without proper kerneldoc comments on it. At 
least everything that comes with EXPORT_SYMBOl_*.

I just remember that digging out all this cdev_* stuff from inside the code 
was just pain. If your new feature is _that_ cool that it has to be 
immediately merged than there will be surely someone out there to help you 
with the documentation if your English is a bit poor. Someone has to review 
that code anyway. If you can give him hints even in bad English what is going 
on it will surely help him (or her) to understand what you're doing, review 
your code and write up some nice comments to make life for the next one to 
touch it a _lot_ easier.

Eike

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

  reply	other threads:[~2006-11-09 12:46 UTC|newest]

Thread overview: 43+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2006-11-08 22:09 A proposal; making 2.6.20 a bugfix only version Jesper Juhl
2006-11-08 22:22 ` Arjan van de Ven
2006-11-08 22:40   ` Jesper Juhl
2006-11-08 23:05     ` Andreas Mohr
2006-11-08 23:54       ` Jan Engelhardt
2006-11-10 15:15     ` Pavel Machek
2006-11-10 15:48     ` Horst H. von Brand
2006-11-15 21:04       ` Jesper Juhl
2006-11-08 22:51   ` Andrew Morton
2006-11-09  9:26     ` Arjan van de Ven
2006-11-09  9:36       ` Andrew Morton
2006-11-09  9:52         ` Arjan van de Ven
2006-11-09 19:12           ` Andrew Morton
2006-11-09 19:21             ` Arjan van de Ven
2006-11-09 21:11               ` Adrian Bunk
2006-11-09 21:31                 ` Arjan van de Ven
2006-11-09 23:56                   ` Thomas Gleixner
2006-11-10  0:18                     ` Andrew Morton
2006-11-10 17:45                     ` Stefan Richter
2006-11-11 11:00                     ` Martin J. Bligh
2006-11-08 23:28   ` Diego Calleja
2006-11-09  6:48     ` Arjan van de Ven
2006-11-09 12:45       ` Rolf Eike Beer [this message]
  -- strict thread matches above, loose matches on Subject: below --
2006-11-09  4:57 Al Boldi
2006-11-09 17:05 ` Stephen Hemminger
2006-11-10 15:52   ` Al Boldi
2006-11-10 16:16     ` Jesper Juhl
2006-11-10 16:42       ` Stephen Hemminger
2006-11-10 16:53         ` Randy Dunlap
2006-11-10 19:33           ` Al Boldi
2006-11-10 19:49             ` Arjan van de Ven
2006-11-10 21:22               ` Al Boldi
2006-11-10 21:31                 ` Stephen Hemminger
2006-11-11  4:15                   ` Al Boldi
2006-11-11  5:09                     ` Stephen Hemminger
2006-11-11  7:23                       ` David Miller
2006-11-11 11:15                         ` Al Boldi
2006-11-11  6:31                     ` Valdis.Kletnieks
2006-11-11 11:15                       ` Al Boldi
2006-11-11  7:15           ` Willy Tarreau
2006-11-11 12:03             ` Neil Brown
2006-11-11 19:16           ` Krzysztof Halasa
2006-11-11 19:15         ` Adrian Bunk

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=200611091345.51940.eike-kernel@sf-tec.de \
    --to=eike-kernel@sf-tec.de \
    --cc=akpm@osdl.org \
    --cc=arjan@infradead.org \
    --cc=bunk@stusta.de \
    --cc=diegocg@gmail.com \
    --cc=jesper.juhl@gmail.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=torvalds@osdl.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