Messages in this thread | | | Date | Thu, 25 Aug 2016 14:09:30 -0600 | From | Jonathan Corbet <> | Subject | Re: [PATCH 2/3] docs: split up the driver book |
| |
On Tue, 23 Aug 2016 11:30:16 -0300 Mauro Carvalho Chehab <mchehab@s-opensource.com> wrote:
> I noticed several issues on the converted document. Just commenting > a few of them, as they all follow a pattern: kernel-doc markups > needs review during the conversion to RST, because, unfortunately, > the conversion is not transparent, as we would want to.
So getting to a couple of others here...
> Also, you should notice that it added several references to > kthread_create(), with is actually a define: > > include/linux/kthread.h:#define kthread_create(threadfn, data, namefmt, arg...) \ > > It probably makes sense to add some markup for kernel-doc to parse it.
I have a patch for that now, will send it shortly.
> The description for: > > int KickStart(MPT_ADAPTER * ioc, int force, int sleepFlag) > > Looked weird on my eyes. The original kernel-nano tag is:
I thought about fixing these up, but, in the end, the bulk of the funky stuff from the fusion driver is pulled in with :internal:. That, I think, makes little sense for a "driver API" book. So I'm really inclined to just remove those includes altogether; they can be added in the future if somebody puts together an internals book for that driver.
Thanks,
jon
| |