summary refs log tree commit diff stats
path: root/docs/sphinx/kerneldoc.py
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>2020-11-17 17:53:00 +0100
committerPaolo Bonzini <pbonzini@redhat.com>2020-12-10 12:15:22 -0500
commit60ef7c1801b02cf6ec0fa12906e0f1386ca7ab00 (patch)
tree301679c2a1d695635d979c4aae57b1331f50509b /docs/sphinx/kerneldoc.py
parent6d3a3cfc2f1ca323b671ecdb48f4b9ec73583ea4 (diff)
downloadfocaccia-qemu-60ef7c1801b02cf6ec0fa12906e0f1386ca7ab00.tar.gz
focaccia-qemu-60ef7c1801b02cf6ec0fa12906e0f1386ca7ab00.zip
scripts: kernel-doc: use a less pedantic markup for funcs on Sphinx 3.x
Unfortunately, Sphinx 3.x parser for c functions is too pedantic:

	https://github.com/sphinx-doc/sphinx/issues/8241

While it could be relaxed with some configurations, there are
several corner cases that it would make it hard to maintain,
and will require teaching conf.py about several macros.

So, let's instead use the :c:macro notation. This will
produce an output that it is not as nice as currently, but it
should still be acceptable, and will provide cross-references,
removing thousands of warnings when building with newer
versions of Sphinx.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Message-Id: <20201117165312.118257-18-pbonzini@redhat.com>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Diffstat (limited to 'docs/sphinx/kerneldoc.py')
0 files changed, 0 insertions, 0 deletions