scripts: kernel-doc: use a less pedantic markup for funcs on Sphinx 3.x
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Tue, 17 Nov 2020 16:53:00 +0000 (17:53 +0100)
committerPaolo Bonzini <pbonzini@redhat.com>
Thu, 10 Dec 2020 17:15:22 +0000 (12:15 -0500)
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>
scripts/kernel-doc

index 771367a6ab0745445b99d289af6cebfab330d022..75ddd3b5e60928770268f937453b289583e597e8 100755 (executable)
@@ -886,19 +886,29 @@ sub output_function_rst(%) {
     my $oldprefix = $lineprefix;
     my $start = "";
 
-    if ($args{'typedef'}) {
-       if ($sphinx_major < 3) {
+    if ($sphinx_major < 3) {
+       if ($args{'typedef'}) {
            print ".. c:type:: ". $args{'function'} . "\n\n";
+           print_lineno($declaration_start_line);
+           print "   **Typedef**: ";
+           $lineprefix = "";
+           output_highlight_rst($args{'purpose'});
+           $start = "\n\n**Syntax**\n\n  ``";
        } else {
-           print ".. c:function:: ". $args{'function'} . "\n\n";
+           print ".. c:function:: ";
        }
-       print_lineno($declaration_start_line);
-       print "   **Typedef**: ";
-       $lineprefix = "";
-       output_highlight_rst($args{'purpose'});
-       $start = "\n\n**Syntax**\n\n  ``";
     } else {
-       print ".. c:function:: ";
+       print ".. c:macro:: ". $args{'function'} . "\n\n";
+
+       if ($args{'typedef'}) {
+           print_lineno($declaration_start_line);
+           print "   **Typedef**: ";
+           $lineprefix = "";
+           output_highlight_rst($args{'purpose'});
+           $start = "\n\n**Syntax**\n\n  ``";
+       } else {
+           print "``";
+       }
     }
     if ($args{'functiontype'} ne "") {
        $start .= $args{'functiontype'} . " " . $args{'function'} . " (";
@@ -925,7 +935,11 @@ sub output_function_rst(%) {
     if ($args{'typedef'}) {
        print ");``\n\n";
     } else {
-       print ")\n\n";
+       if ($sphinx_major < 3) {
+           print ")\n\n";
+       } else {
+           print ")``\n";
+       }
        print_lineno($declaration_start_line);
        $lineprefix = "   ";
        output_highlight_rst($args{'purpose'});