[lkml]   [2016]   [May]   [4]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
Messages in this thread
SubjectRe: Kernel docs: muddying the waters a bit
On Wed, 04 May 2016, Markus Heiser <> wrote:
> but I think this will not by very helpful, as long as you miss
> a similar ".tmpl" workflow for reST documents.
> I'am working on a reST directive (named: "kernel-doc") to provide a
> similar ".tmpl" workflow within plain reST. The first step towards
> is done with (my) modified kernel-doc script ...
> *
> which produce reST from source code comments. E.g. this content is
> generated with it.

What do you mean by ".tmpl workflow"?

I'd be *very* hesitant about adding the kind of things you do in
reformat_block_rst to kernel-doc. IMO the extraction from kernel-doc
comments must be as simple as possible with basically pass-through of
the comment blocks to sphinx. Specifically, do not attempt to detect and
parse elements like lists in kernel-doc.


Jani Nikula, Intel Open Source Technology Center

 \ /
  Last update: 2016-05-04 12:21    [W:0.144 / U:14.004 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site