From: "Alex Bennée" <alex.bennee@linaro.org>
To: Peter Maydell <peter.maydell@linaro.org>
Cc: Paolo Bonzini <pbonzini@redhat.com>, qemu-devel@nongnu.org
Subject: Re: [PATCH for-5.0? 3/3] kernel-doc: Use c:struct for Sphinx 3.0 and later
Date: Tue, 14 Apr 2020 16:53:51 +0100 [thread overview]
Message-ID: <871roq9i7k.fsf@linaro.org> (raw)
In-Reply-To: <20200411182934.28678-4-peter.maydell@linaro.org>
Peter Maydell <peter.maydell@linaro.org> writes:
> The kernel-doc Sphinx plugin and associated script currently emit
> 'c:type' directives for "struct foo" documentation.
>
> Sphinx 3.0 warns about this:
> /home/petmay01/linaro/qemu-from-laptop/qemu/docs/../include/exec/memory.h:3: WARNING: Type must be either just a name or a typedef-like declaration.
> If just a name:
> Error in declarator or parameters
> Invalid C declaration: Expected identifier in nested name, got keyword: struct [error at 6]
> struct MemoryListener
> ------^
> If typedef-like declaration:
> Error in declarator or parameters
> Invalid C declaration: Expected identifier in nested name. [error at 21]
> struct MemoryListener
> ---------------------^
>
> because it wants us to use the new-in-3.0 'c:struct' instead.
>
> Plumb the Sphinx version through to the kernel-doc script
> and use it to select 'c:struct' for newer versions than 3.0.
>
> Fixes: LP:1872113
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Looks reasonable although I don't have a way of testing it on my system.
Any idea what systems have the latest sphinx 3 on them? I tried fedora
but that still has 1.8.4 so it's not that bleeding edge.
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
--
Alex Bennée
next prev parent reply other threads:[~2020-04-14 16:39 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-04-11 18:29 [PATCH for-5.0? 0/3] Make docs build work with Sphinx 3 Peter Maydell
2020-04-11 18:29 ` [PATCH for-5.0? 1/3] configure: Honour --disable-werror for Sphinx Peter Maydell
2020-04-11 20:11 ` Richard Henderson
2020-04-14 14:48 ` Alex Bennée
2020-04-11 18:29 ` [PATCH for-5.0? 2/3] scripts/kernel-doc: Add missing close-paren in c:function directives Peter Maydell
2020-04-11 20:11 ` Richard Henderson
2020-04-14 14:56 ` Alex Bennée
2020-04-11 18:29 ` [PATCH for-5.0? 3/3] kernel-doc: Use c:struct for Sphinx 3.0 and later Peter Maydell
2020-04-14 12:45 ` Peter Maydell
2020-04-14 15:53 ` Alex Bennée [this message]
2020-04-14 15:57 ` Peter Maydell
2020-04-13 7:13 ` [PATCH for-5.0? 0/3] Make docs build work with Sphinx 3 Paolo Bonzini
2020-04-13 18:08 ` Supported Sphinx Versions (was: Re: [PATCH for-5.0? 0/3] Make docs build work with Sphinx 3) John Snow
2020-04-13 18:22 ` Peter Maydell
2020-04-13 19:24 ` John Snow
2020-04-14 7:53 ` Supported Sphinx Versions Markus Armbruster
2020-04-15 16:43 ` Supported Build Platforms (Again) (Was Re: Supported Sphinx Versions) John Snow
2020-04-15 17:37 ` Daniel P. Berrangé
2020-04-16 6:02 ` Markus Armbruster
2020-04-14 10:28 ` Supported Sphinx Versions (was: Re: [PATCH for-5.0? 0/3] Make docs build work with Sphinx 3) Peter Maydell
2020-04-14 12:22 ` Peter Maydell
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=871roq9i7k.fsf@linaro.org \
--to=alex.bennee@linaro.org \
--cc=pbonzini@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).