public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Alan Cox <alan@lxorguk.ukuu.org.uk>
To: Paul Jackson <pj@sgi.com>
Cc: Randy Dunlap <rdunlap@xenotime.net>,
	miaox@cn.fujitsu.com, akpm@linux-foundation.org,
	linux-kernel@vger.kernel.org, menage@google.com
Subject: Re: [RFC] [PATCH 1/2] cpusets: restructure the function update_cpumask() and update_nodemask()
Date: Fri, 30 May 2008 10:46:58 +0100	[thread overview]
Message-ID: <20080530104658.26a3783f@core> (raw)
In-Reply-To: <20080530012537.87454a8d.pj@sgi.com>

> I have never seen or heard of a document using the "/**" kernel-doc
> entries of kernel/cpuset.c, and I have no idea who actually has (in
> the past or present, not just hypothetically) read such or why.

People wanting to generate things like function lists.

> being a stubborn retard, I continue to prefer that file static routines
> in kernel/cpuset.c not have "/**" kernel-doc markers on their comments,
> and I would still welcome a patch from Miao removing the ones already
> there.

And I'll join that by stubbonly NAKing such an approach. We want
consistent clear formats for documentation extraction. Simply getting
people to use the kerneldoc format materially improves the documentation
quality, so please don't set bad examples ;)

Alan


  reply	other threads:[~2008-05-30 10:01 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-05-29  7:07 [RFC] [PATCH 1/2] cpusets: restructure the function update_cpumask() and update_nodemask() Miao Xie
2008-05-29  8:16 ` Paul Jackson
2008-05-30  1:51   ` Miao Xie
2008-05-30  1:53     ` Paul Jackson
2008-05-30  2:16       ` Miao Xie
2008-05-30  2:22         ` Paul Jackson
2008-05-30  3:30           ` Randy Dunlap
2008-05-30  3:57             ` Paul Jackson
2008-05-30  4:27               ` Randy Dunlap
2008-05-30  5:24                 ` Paul Jackson
2008-05-30  6:25                 ` Paul Jackson
2008-05-30  9:46                   ` Alan Cox [this message]
2008-05-30 15:22                     ` Paul Jackson
2008-05-30 15:32                   ` Randy Dunlap
2008-05-30 15:39                   ` Randy Dunlap
2008-05-30 16:07                     ` Paul Jackson

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=20080530104658.26a3783f@core \
    --to=alan@lxorguk.ukuu.org.uk \
    --cc=akpm@linux-foundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=menage@google.com \
    --cc=miaox@cn.fujitsu.com \
    --cc=pj@sgi.com \
    --cc=rdunlap@xenotime.net \
    /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