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] [day] [month] [year] [list]

Message-ID: <28878868.1216702283977.JavaMail.oracle@acsmt301.oracle.com>
Date:	Mon, 21 Jul 2008 23:51:23 -0500 (CDT)
From:	Randy Dunlap <randy.dunlap@...cle.com>
To:	michael@...erman.id.au
Cc:	jbarnes@...tuousgeek.org, torvalds <torvalds@...ux-foundation.org>,
	lkml <linux-kernel@...r.kernel.org>, linux-pci@...r.kernel.org
Subject: Re: [PATCH] pci kernel-doc fatal error

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

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

~Randy

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/