Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1470372

Re: [PATCH 2/3] docs: split up the driver book

Show all headers | View raw

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

Back to linux.kernel | Previous | Next — Previous in thread | Next in thread | Find similar | Unroll thread

Thread

[PATCH 0/3] RFC: The beginning of a proper driver-api book Jonathan Corbet <corbet@lwn.net> - 2016-08-22 23:00 +0200
  [PATCH 3/3] docs: Pull HSI documentation together Jonathan Corbet <corbet@lwn.net> - 2016-08-22 23:00 +0200
    Re: [PATCH 3/3] docs: Pull HSI documentation together Sebastian Reichel <sre@kernel.org> - 2016-08-23 02:30 +0200
      Re: [PATCH 3/3] docs: Pull HSI documentation together Jonathan Corbet <corbet@lwn.net> - 2016-09-06 17:20 +0200
  [PATCH 1/3] Docs: sphinxify device-drivers.tmpl Jonathan Corbet <corbet@lwn.net> - 2016-08-22 23:00 +0200
  [PATCH 2/3] docs: split up the driver book Jonathan Corbet <corbet@lwn.net> - 2016-08-22 23:00 +0200
    Re: [PATCH 2/3] docs: split up the driver book Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-08-23 16:40 +0200
      Re: [PATCH 2/3] docs: split up the driver book Jonathan Corbet <corbet@lwn.net> - 2016-08-25 00:50 +0200
        Re: [PATCH 2/3] docs: split up the driver book Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-08-25 07:40 +0200
      Re: [PATCH 2/3] docs: split up the driver book Jonathan Corbet <corbet@lwn.net> - 2016-08-25 22:10 +0200
  Re: [PATCH 0/3] RFC: The beginning of a proper driver-api book Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-08-23 16:50 +0200
    Re: [PATCH 0/3] RFC: The beginning of a proper driver-api book Markus Heiser <markus.heiser@darmarit.de> - 2016-08-26 11:40 +0200
      Re: [PATCH 0/3] RFC: The beginning of a proper driver-api book Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-08-26 12:10 +0200
        Re: [PATCH 0/3] RFC: The beginning of a proper driver-api book Jani Nikula <jani.nikula@intel.com> - 2016-08-26 12:20 +0200

csiph-web