lkml.org 
[lkml]   [2020]   [Oct]   [1]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH v4 04/52] scripts: kernel-doc: make it more compatible with Sphinx 3.x
On Wed, 30 Sep 2020 15:24:27 +0200
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:

> With Sphinx 3.x, the ".. c:type:" tag was changed to accept either:
>
> .. c:type:: typedef-like declaration
> .. c:type:: name
>
> Using it for other types (including functions) don't work anymore.
>
> So, there are newer tags for macro, enum, struct, union, and others,
> which doesn't exist on older versions.
>
> Add a check for the Sphinx version and change the produced tags
> accordingly.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> scripts/kernel-doc | 71 ++++++++++++++++++++++++++++++++++++++++++----
> 1 file changed, 65 insertions(+), 6 deletions(-)

So this seems generally good, but I do wonder if we shouldn't just pass
the sphinx version into kernel-doc as a parameter? We're already doing a
version check in the makefile, we should be able to capture the result and
pass it in, maybe?

jon

\
 
 \ /
  Last update: 2020-10-01 23:41    [W:0.369 / U:0.188 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site