Some packaged versions of Sphinx (fedora33/alpine so far) have issues
with the annotated C code that kernel-doc spits out. Without knowing
about things like QEMU_PLUGIN_EXPORT it chokes trying to understand
the code. Evidently this is a problem for the kernel as well as the
long stream of regex substitutions we add to in this patch can attest.

Fortunately we have a fairly common format for all our compiler
shenanigans as applied to functions so lets just filter them all out.

Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
---
 scripts/kernel-doc | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 4b19851b2d..240923d509 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -1745,6 +1745,9 @@ sub dump_function($$) {
             )+
           \)\)\s+//x;
 
+    # Strip QEMU specific compiler annotations
+    $prototype =~ s/QEMU_[A-Z_]+ +//;
+
     # Yes, this truly is vile.  We are looking for:
     # 1. Return type (may be nothing if we're looking at a macro)
     # 2. Function name
-- 
2.20.1

On 3/20/21 7:36 AM, Alex Bennée wrote:
> Some packaged versions of Sphinx (fedora33/alpine so far) have issues
> with the annotated C code that kernel-doc spits out. Without knowing
> about things like QEMU_PLUGIN_EXPORT it chokes trying to understand
> the code. Evidently this is a problem for the kernel as well as the
> long stream of regex substitutions we add to in this patch can attest.
> 
> Fortunately we have a fairly common format for all our compiler
> shenanigans as applied to functions so lets just filter them all out.
> 
> Signed-off-by: Alex Bennée<alex.bennee@linaro.org>
> ---

Reviewed-by: Richard Henderson <richard.henderson@linaro.org>

r~