public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Randy Dunlap <randy.dunlap@oracle.com>
To: michael@ellerman.id.au
Cc: jbarnes@virtuousgeek.org,
	torvalds <torvalds@linux-foundation.org>,
	lkml <linux-kernel@vger.kernel.org>,
	linux-pci@vger.kernel.org
Subject: Re: [PATCH] pci kernel-doc fatal error
Date: Mon, 21 Jul 2008 23:51:23 -0500 (CDT)	[thread overview]
Message-ID: <28878868.1216702283977.JavaMail.oracle@acsmt301.oracle.com> (raw)
In-Reply-To: <1216693765.8479.6.camel@localhost>

--- Original Message ---
> On Mon, 2008-07-21 at 16:14 -0700, Randy Dunlap wrote:
> > On Tue, 22 Jul 2008 09:07:45 +1000 Michael Ellerman wrote:
> > 
> > > On Mon, 2008-07-21 at 09:27 -0700, Randy Dunlap wrote:
> > > > From: Randy Dunlap <randy.dunlap@oracle.com>
> > > > 
> > > > Fix kernel-doc comments so that they don't produce errors.
> > > > Also cut some extraneous copy-paste text.
> > > > 
> > > > Error(linhead//drivers/pci/pci.c:1133): duplicate section name 'Description'
> > > > Error(linhead//drivers/pci/pci.c:1189): duplicate section name 'Description'
> > > 
> > > But now the description lines exceed 80 columns, and with longer
> > 
> > Yes, I'm pretty well aware of that.  :(
> > This is one of the places where we tolerate that, while not enjoying it.
> > 
> > This is a request that akpm has also made, and it makes some sense, and it's
> > on my long list of (volunteer) doc work to do...
> 
> Sure.
> 
> > > ps. I did look at changing kerneldoc to do that myself, but whereas
> > > previously I thought I didn't really know perl, now I /know/ I totally
> > > don't know perl ;)
> > 
> > Yes, I understand that comment.  ;)
> > That's part of the problem, of course.
> > I.e., if it were straightforward, it would probably already be done.
> 
> I guess there's also a good reason why the kernel implements
> its own
> doco-from-c-comments extraction tool, rather than using something
> that already exists (doxygen?).

I don't know the history behind it.  I.e., it happened before I began caring
about it.

~Randy


      reply	other threads:[~2008-07-22  4:51 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-07-21 16:27 [PATCH] pci kernel-doc fatal error Randy Dunlap
2008-07-21 23:07 ` Michael Ellerman
2008-07-21 23:14   ` Randy Dunlap
2008-07-22  2:29     ` Michael Ellerman
2008-07-22  4:51       ` Randy Dunlap [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=28878868.1216702283977.JavaMail.oracle@acsmt301.oracle.com \
    --to=randy.dunlap@oracle.com \
    --cc=jbarnes@virtuousgeek.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pci@vger.kernel.org \
    --cc=michael@ellerman.id.au \
    --cc=torvalds@linux-foundation.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