mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Alan Cox <alan@lxorguk.ukuu.org.uk>
To: Andrew Morton <akpm@linux-foundation.org>
Cc: Randy Dunlap <randy.dunlap@oracle.com>,
	rusty@rustcorp.com.au, rmk+lkml@arm.linux.org.uk,
	linux-kernel@vger.kernel.org, sfr@canb.auug.org.au
Subject: Re: Yet more ARM breakage in linux-next
Date: Thu, 4 Dec 2008 00:10:32 +0000	[thread overview]
Message-ID: <20081204001032.39d2a281@lxorguk.ukuu.org.uk> (raw)
In-Reply-To: <20081203154629.bba4e5e4.akpm@linux-foundation.org>

> For some reason, the act of typing in some kerneldoc makes people's
> brains turn off.  Perhaps it's because "oh, I am supposed to type some
> documentation here" instead of "gee, I think this code is unclear,
> let's clarify that".

Well prior to the kerneldoc stuff they didn't type anything at all to
clarify or document. Also kerneldoc is meant for documenting the APIs not
so much the internals of functions. When used sensibly it can be very
useful, especially if it documents API locking rules.

Alan

  reply	other threads:[~2008-12-04  0:14 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-12-03 19:29 Russell King
2008-12-03 20:41 ` Andrew Morton
2008-12-03 23:22   ` Rusty Russell
2008-12-03 23:37     ` Randy Dunlap
2008-12-03 23:46       ` Andrew Morton
2008-12-04  0:10         ` Alan Cox [this message]
2008-12-04  0:01       ` David Miller
2008-12-04  0:18         ` Randy Dunlap
2008-12-04  1:27       ` Rusty Russell
2008-12-04  2:56         ` Stephen Hemminger
2008-12-04  0:31     ` Russell King
2008-12-04  3:06       ` Nicolas Pitre
2008-12-04  1:33     ` Mike Frysinger
2008-12-04  2:15       ` Rusty Russell
2008-12-04  3:55         ` Mike Frysinger
2008-12-04  9:18   ` Geert Uytterhoeven
2008-12-04 14:12     ` Rusty Russell
2008-12-07 21:50       ` Geert Uytterhoeven
2008-12-08  6:20         ` Rusty Russell

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=20081204001032.39d2a281@lxorguk.ukuu.org.uk \
    --to=alan@lxorguk.ukuu.org.uk \
    --cc=akpm@linux-foundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=randy.dunlap@oracle.com \
    --cc=rmk+lkml@arm.linux.org.uk \
    --cc=rusty@rustcorp.com.au \
    --cc=sfr@canb.auug.org.au \
    /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

Powered by JetHome