Re: [PATCH] ktime/hrtimer: fix kernel-doc comments

From: Randy.Dunlap
Date: Mon Jun 19 2006 - 17:36:55 EST


On Mon, 19 Jun 2006 23:30:57 +0200 Thomas Gleixner wrote:

> On Mon, 2006-06-19 at 14:20 -0700, Randy.Dunlap wrote:
> > > Seriously, is it hard to fix ? I'm not good with perl, so its likely
> > > that I would make more mess than fixups.
> >
> > I don't know for sure. I have looked at it a bit and
> > it's messy code IMHO. Might be easier/better just to rewrite
> > the function (comment) header parsing.
>
> I would do that, but I have no idea how to mix python into perl :)

so rewrite scripts/kernel-doc in python. ;)

> > Andrew also wants the short function description to be able to be
> > more than one line. That could/should be incorporated at the same time.
>
> That would be a really nice feature.

It's just a convenience factor. There is another way to have a
multi-line function description.

> > OTOH, it's a defined doc. language and these files contain errors...
>
> No objections, but it would be cool if some perl experts would remove
> those restrictions before the patches finally hit mainline.

I plan to work on it, but it's not super high priority.
Someone else can do the same...


This is just one example of many files that have similar kernel-doc
problems. I wasn't picking on your files. :)

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