Re: [PATCH 3/9] genericirq.tmpl: convert it to ReST

Mauro Carvalho Chehab
2017-03-31T18:04:41Z

Em Fri, 31 Mar 2017 08:57:11 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> On Thu, 30 Mar 2017 17:11:30 -0300
> Mauro Carvalho Chehab <mchehab@s-opensource.com> wrote:
>
> [Reordering things a bit]
>
> > +==========================
> > +Linux generic IRQ handling
> > +==========================
> > +
> > +:Copyright: |copy| 2005-2010: Thomas Gleixner
> > +:Copyright: |copy| 2005-2006: Ingo Molnar
>
> It seems maybe they should have been CC'd on this one? Adding them now
> (and leaving the full patch for their amusement).
>
> > Brainless conversion of genericirq.tmpl book to ReST, via
> > Documentation/sphinx/tmplcvt
>
> In general this seems good, but I have to wonder how current this material
> is at this point? The last substantive change was in 2013 (3.11), and I've
> seen a certain amount of IRQ work going by since then. I'm not opposed to
> this move at all, but perhaps if it's outdated we should add a note to that
> effect?

Looking on the amount of c:func: references that got solved:
http://www.infradead.org/~mchehab/kernel_docs/core-api/genericirq.html

I'd say that it doesn't seem outdated.

It mentions a __do_IRQ() function, with I was unable to found, but
I was able to find arch-dependent do_IRQ() functions, with seems to
match the concepts explained at the doc. I almost did a
s/__do_IRQ/do_IRQ/
but, as I wasn't 100% sure, I opted to keep it as-is for others to touch.

It also mentions a request_irq() function, with is there, just without
kernel-doc markups.

Finally, it includes several core-api files with kernel-doc markups.

So, IMHO, it is worth merging it. Yet, it would be great if the ones
working on that part of the core could review and update it.

Regards,
Mauro