linux-kernel - Re: [PATCH] pci kernel-doc fatal error

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <1216693765.8479.6.camel@localhost>
Date:	Tue, 22 Jul 2008 12:29:25 +1000
From:	Michael Ellerman <michael@...erman.id.au>
To:	Randy Dunlap <randy.dunlap@...cle.com>
Cc:	lkml <linux-kernel@...r.kernel.org>,
	torvalds <torvalds@...ux-foundation.org>,
	jbarnes@...tuousgeek.org, linux-pci@...r.kernel.org
Subject: Re: [PATCH] pci kernel-doc fatal error

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@...cle.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?).

cheers

-- 
Michael Ellerman
OzLabs, IBM Australia Development Lab

wwweb: http://michael.ellerman.id.au
phone: +61 2 6212 1183 (tie line 70 21183)

We do not inherit the earth from our ancestors,
we borrow it from our children. - S.M.A.R.T Person

Download attachment "signature.asc" of type "application/pgp-signature" (190 bytes)