Message ID | 20200930195850.278104-1-pbonzini@redhat.com |
---|---|
State | New |
Headers | show |
On Wed, 30 Sep 2020 at 21:04, Paolo Bonzini <pbonzini@redhat.com> wrote: > > The following changes since commit cbba3dc6ea3fc9aa66e9f9eb41051536e3ad7cd0: > > Merge remote-tracking branch 'remotes/mst/tags/for_upstream' into staging (2020-09-30 11:40:38 +0100) > > are available in the Git repository at: > > https://gitlab.com/bonzini/qemu.git tags/for-upstream > > for you to fetch changes up to 37aeb7a28ddbf52dd25dd53ae1b8391bc2287858: > > hw/net/can: Correct Kconfig dependencies (2020-09-30 19:11:37 +0200) > > ---------------------------------------------------------------- > * SCSI fix (Dmitry, Li Feng, Li Qiang) > * memory API fixes (Eduardo) > * removal of deprecated '-numa node', 'cpu-add', '-smp' (Igor) > * ACPI fix for VMBus (Jon) > * relocatable install (myself) > * always remove docker containers (myself) > * serial cleanups (Philippe) > * vmware cpuid leaf for tsc and apic frequency (Sunil) > * KVM_FEATURE_ASYNC_PF_INT support (Vitaly) > * i386 XSAVE bugfix (Xiaoyao) > * QOM developer documentation in docs/devel (Eduardo) > * new checkpatch tests (Dov) > * x86_64 syscall fix (Douglas) > * interrupt-based APF fix (Vitaly) > * always create kvmclock (Vitaly) > * fix bios-tables-test (Eduardo) > * KVM PV features cleanup (myself) > * CAN FD (Pavel) > > meson: > * fixes (Marc-André, Max, Stefan, Alexander, myself) > * moved libmpathpersist, cocoa, malloc tests (myself) > * support for 0.56 introspected test dependencies (myself) > Applied, thanks. Please update the changelog at https://wiki.qemu.org/ChangeLog/5.2 for any user-visible changes. -- PMM
On Thu, Oct 1, 2020 at 10:36 PM Peter Maydell <peter.maydell@linaro.org> wrote: > > On Wed, 30 Sep 2020 at 21:04, Paolo Bonzini <pbonzini@redhat.com> wrote: > > > > The following changes since commit cbba3dc6ea3fc9aa66e9f9eb41051536e3ad7cd0: > > > > Merge remote-tracking branch 'remotes/mst/tags/for_upstream' into staging (2020-09-30 11:40:38 +0100) > > > > are available in the Git repository at: > > > > https://gitlab.com/bonzini/qemu.git tags/for-upstream > > > > for you to fetch changes up to 37aeb7a28ddbf52dd25dd53ae1b8391bc2287858: > > > > hw/net/can: Correct Kconfig dependencies (2020-09-30 19:11:37 +0200) > > > > ---------------------------------------------------------------- > > * SCSI fix (Dmitry, Li Feng, Li Qiang) > > * memory API fixes (Eduardo) > > * removal of deprecated '-numa node', 'cpu-add', '-smp' (Igor) > > * ACPI fix for VMBus (Jon) > > * relocatable install (myself) > > * always remove docker containers (myself) > > * serial cleanups (Philippe) > > * vmware cpuid leaf for tsc and apic frequency (Sunil) > > * KVM_FEATURE_ASYNC_PF_INT support (Vitaly) > > * i386 XSAVE bugfix (Xiaoyao) > > * QOM developer documentation in docs/devel (Eduardo) > > * new checkpatch tests (Dov) > > * x86_64 syscall fix (Douglas) > > * interrupt-based APF fix (Vitaly) > > * always create kvmclock (Vitaly) > > * fix bios-tables-test (Eduardo) > > * KVM PV features cleanup (myself) > > * CAN FD (Pavel) > > > > meson: > > * fixes (Marc-André, Max, Stefan, Alexander, myself) > > * moved libmpathpersist, cocoa, malloc tests (myself) > > * support for 0.56 introspected test dependencies (myself) > > > > > Applied, thanks. > > Please update the changelog at https://wiki.qemu.org/ChangeLog/5.2 > for any user-visible changes. > > -- PMM > Long awating, wonderfull -- 此致 礼 罗勇刚 Yours sincerely, Yonggang Luo
On 9/30/20 9:58 PM, Paolo Bonzini wrote: > > Eduardo Habkost (10): <snip/> > docs: Create docs/devel/qom.rst cd442a45db60a1a72fcf980c24bd1227f13f8a87 is the first bad commit Sorry for noticing this earlier, but is this known? The build starts failing for me after this commit: /usr/bin/sphinx-build -Dversion=5.1.50 -Drelease= -W -Ddepfile=docs/devel.d -Ddepfile_stamp=docs/devel.stamp -b html -d /home/zippy/work/qemu/qemu.git/build/docs/devel.p /home/zippy/work/qemu/qemu.git/docs/devel /home/zippy/work/qemu/qemu.git/build/docs/devel Running Sphinx v3.2.1 building [mo]: targets for 0 po files that are out of date building [html]: targets for 20 source files that are out of date updating environment: [new config] 20 added, 0 changed, 0 removed reading sources... [100%] testing Warning, treated as error: /home/zippy/work/qemu/qemu.git/docs/../include/qom/object.h:747:Error in declarator If declarator-id with parameters (e.g., 'void f(int arg)'): Invalid C declaration: Expected identifier in nested name. [error at 24] object_initialize_child ( parent, propname, child, type) ------------------------^ If parenthesis in noptr-declarator (e.g., 'void (*f(int arg))(double)'): Error in declarator or parameters Invalid C declaration: Expecting "(" in parameters. [error at 32] object_initialize_child ( parent, propname, child, type) --------------------------------^ make[1]: *** [Makefile.ninja:9898: docs/devel.stamp] Error 2 make[1]: *** Deleting file 'docs/devel.stamp' make[1]: Leaving directory '/home/zippy/work/qemu/qemu.git/build' make: *** [GNUmakefile:11: all] Error 2 Michal
On Fri, Oct 02, 2020 at 05:58:55PM +0200, Michal Prívozník wrote: > On 9/30/20 9:58 PM, Paolo Bonzini wrote: > > > > Eduardo Habkost (10): > <snip/> > > docs: Create docs/devel/qom.rst > > cd442a45db60a1a72fcf980c24bd1227f13f8a87 is the first bad commit > > Sorry for noticing this earlier, but is this known? The build starts failing > for me after this commit: > > /usr/bin/sphinx-build -Dversion=5.1.50 -Drelease= -W -Ddepfile=docs/devel.d > -Ddepfile_stamp=docs/devel.stamp -b html -d > /home/zippy/work/qemu/qemu.git/build/docs/devel.p > /home/zippy/work/qemu/qemu.git/docs/devel > /home/zippy/work/qemu/qemu.git/build/docs/devel > Running Sphinx v3.2.1 > building [mo]: targets for 0 po files that are out of date > building [html]: targets for 20 source files that are out of date > updating environment: [new config] 20 added, 0 changed, 0 removed > reading sources... [100%] testing > > > > > Warning, treated as error: > /home/zippy/work/qemu/qemu.git/docs/../include/qom/object.h:747:Error in > declarator > If declarator-id with parameters (e.g., 'void f(int arg)'): > Invalid C declaration: Expected identifier in nested name. [error at 24] > object_initialize_child ( parent, propname, child, type) > ------------------------^ > If parenthesis in noptr-declarator (e.g., 'void (*f(int arg))(double)'): > Error in declarator or parameters > Invalid C declaration: Expecting "(" in parameters. [error at 32] > object_initialize_child ( parent, propname, child, type) > --------------------------------^ > > make[1]: *** [Makefile.ninja:9898: docs/devel.stamp] Error 2 > make[1]: *** Deleting file 'docs/devel.stamp' > make[1]: Leaving directory '/home/zippy/work/qemu/qemu.git/build' > make: *** [GNUmakefile:11: all] Error 2 I can't reproduce it using Sphinx v2.2.2. I'm still trying to understand what exactly the error means. I really wish we used virtualenv + requirements.txt to require a specific version of Sphinx instead of wasting time dealing a wide range of Sphinx versions.
On 02/10/20 17:58, Michal Prívozník wrote: >> > > cd442a45db60a1a72fcf980c24bd1227f13f8a87 is the first bad commit > > Sorry for noticing this earlier, but is this known? The build starts > failing for me after this commit: > > /usr/bin/sphinx-build -Dversion=5.1.50 -Drelease= -W > -Ddepfile=docs/devel.d -Ddepfile_stamp=docs/devel.stamp -b html -d > /home/zippy/work/qemu/qemu.git/build/docs/devel.p > /home/zippy/work/qemu/qemu.git/docs/devel > /home/zippy/work/qemu/qemu.git/build/docs/devel > Running Sphinx v3.2.1 > building [mo]: targets for 0 po files that are out of date > building [html]: targets for 20 source files that are out of date > updating environment: [new config] 20 added, 0 changed, 0 removed > reading sources... [100%] testing No, this is new. It works with older versions of Sphinx (I have 2.2.2 despite being on Fedora 32 which is pretty recent). For now Sphinx 3 is not supported by kerneldoc, we probably should apply a patch like https://www.spinics.net/lists/linux-doc/msg83277.html Paolo
On Fri, Oct 02, 2020 at 06:27:35PM +0200, Paolo Bonzini wrote: > On 02/10/20 17:58, Michal Prívozník wrote: > >> > > > > cd442a45db60a1a72fcf980c24bd1227f13f8a87 is the first bad commit > > > > Sorry for noticing this earlier, but is this known? The build starts > > failing for me after this commit: > > > > /usr/bin/sphinx-build -Dversion=5.1.50 -Drelease= -W > > -Ddepfile=docs/devel.d -Ddepfile_stamp=docs/devel.stamp -b html -d > > /home/zippy/work/qemu/qemu.git/build/docs/devel.p > > /home/zippy/work/qemu/qemu.git/docs/devel > > /home/zippy/work/qemu/qemu.git/build/docs/devel > > Running Sphinx v3.2.1 > > building [mo]: targets for 0 po files that are out of date > > building [html]: targets for 20 source files that are out of date > > updating environment: [new config] 20 added, 0 changed, 0 removed > > reading sources... [100%] testing > > No, this is new. It works with older versions of Sphinx (I have 2.2.2 > despite being on Fedora 32 which is pretty recent). > > For now Sphinx 3 is not supported by kerneldoc, we probably should apply > a patch like > > https://www.spinics.net/lists/linux-doc/msg83277.html Weird, because we don't use the cdomain extension, and the patch above only disables the cdomain extension. In either case, supporting only Sphinx 2.x by now sounds reasonable. virtualenv+pip makes it simple to install and run a specific Sphinx version, for people who really need it.
On 10/2/20 6:22 PM, Eduardo Habkost wrote: > On Fri, Oct 02, 2020 at 05:58:55PM +0200, Michal Prívozník wrote: >> On 9/30/20 9:58 PM, Paolo Bonzini wrote: >>> >>> Eduardo Habkost (10): >> <snip/> >>> docs: Create docs/devel/qom.rst >> >> cd442a45db60a1a72fcf980c24bd1227f13f8a87 is the first bad commit >> >> Sorry for noticing this earlier, but is this known? The build starts failing >> for me after this commit: >> >> /usr/bin/sphinx-build -Dversion=5.1.50 -Drelease= -W -Ddepfile=docs/devel.d >> -Ddepfile_stamp=docs/devel.stamp -b html -d >> /home/zippy/work/qemu/qemu.git/build/docs/devel.p >> /home/zippy/work/qemu/qemu.git/docs/devel >> /home/zippy/work/qemu/qemu.git/build/docs/devel >> Running Sphinx v3.2.1 >> building [mo]: targets for 0 po files that are out of date >> building [html]: targets for 20 source files that are out of date >> updating environment: [new config] 20 added, 0 changed, 0 removed >> reading sources... [100%] testing >> >> >> >> >> Warning, treated as error: >> /home/zippy/work/qemu/qemu.git/docs/../include/qom/object.h:747:Error in >> declarator >> If declarator-id with parameters (e.g., 'void f(int arg)'): >> Invalid C declaration: Expected identifier in nested name. [error at 24] >> object_initialize_child ( parent, propname, child, type) >> ------------------------^ >> If parenthesis in noptr-declarator (e.g., 'void (*f(int arg))(double)'): >> Error in declarator or parameters >> Invalid C declaration: Expecting "(" in parameters. [error at 32] >> object_initialize_child ( parent, propname, child, type) >> --------------------------------^ >> >> make[1]: *** [Makefile.ninja:9898: docs/devel.stamp] Error 2 >> make[1]: *** Deleting file 'docs/devel.stamp' >> make[1]: Leaving directory '/home/zippy/work/qemu/qemu.git/build' >> make: *** [GNUmakefile:11: all] Error 2 > > I can't reproduce it using Sphinx v2.2.2. I'm still trying to > understand what exactly the error means. > Same here. > I really wish we used virtualenv + requirements.txt to require a > specific version of Sphinx instead of wasting time dealing a wide > range of Sphinx versions. > I already have a patch that I keep locally to build with v3: diff --git a/docs/qemu-option-trace.rst.inc b/docs/qemu-option-trace.rst.inc index 7e09773a9c..ae83f6a1a8 100644 --- a/docs/qemu-option-trace.rst.inc +++ b/docs/qemu-option-trace.rst.inc @@ -1,7 +1,7 @@ Specify tracing options. -.. option:: [enable=]PATTERN +.. option:: enable=PATTERN Immediately enable events matching *PATTERN* (either event name or a globbing pattern). This option is only That said, I'm not objecting to requiring v2 for now and switching to v3 later. But interestingly, through trial and error I've came across this hack, which allows me to build again. I have no idea why it works: diff --git i/include/qom/object.h w/include/qom/object.h index 27aaa67e63..59c729ebb7 100644 --- i/include/qom/object.h +++ w/include/qom/object.h @@ -762,13 +762,14 @@ bool object_initialize_child_with_propsv(Object *parentobj, * child, sizeof(*child), type, * &error_abort, NULL) */ -#define object_initialize_child(parent, propname, child, type) \ - object_initialize_child_internal((parent), (propname), \ - (child), sizeof(*(child)), (type)) void object_initialize_child_internal(Object *parent, const char *propname, void *child, size_t size, const char *type); +#define object_initialize_child(parent, propname, child, type) \ + object_initialize_child_internal((parent), (propname), \ + (child), sizeof(*(child)), (type)) + /** * object_dynamic_cast: * @obj: The object to cast.
On 02/10/20 19:26, Michal Prívozník wrote: > On 10/2/20 6:22 PM, Eduardo Habkost wrote: >> On Fri, Oct 02, 2020 at 05:58:55PM +0200, Michal Prívozník wrote: >>> On 9/30/20 9:58 PM, Paolo Bonzini wrote: >>>> >>>> Eduardo Habkost (10): >>> <snip/> >>>> docs: Create docs/devel/qom.rst >>> >>> cd442a45db60a1a72fcf980c24bd1227f13f8a87 is the first bad commit >>> >>> Sorry for noticing this earlier, but is this known? The build starts >>> failing >>> for me after this commit: >>> >>> /usr/bin/sphinx-build -Dversion=5.1.50 -Drelease= -W >>> -Ddepfile=docs/devel.d >>> -Ddepfile_stamp=docs/devel.stamp -b html -d >>> /home/zippy/work/qemu/qemu.git/build/docs/devel.p >>> /home/zippy/work/qemu/qemu.git/docs/devel >>> /home/zippy/work/qemu/qemu.git/build/docs/devel >>> Running Sphinx v3.2.1 >>> building [mo]: targets for 0 po files that are out of date >>> building [html]: targets for 20 source files that are out of date >>> updating environment: [new config] 20 added, 0 changed, 0 removed >>> reading sources... [100%] testing >>> >>> >>> >>> >>> Warning, treated as error: >>> /home/zippy/work/qemu/qemu.git/docs/../include/qom/object.h:747:Error in >>> declarator >>> If declarator-id with parameters (e.g., 'void f(int arg)'): >>> Invalid C declaration: Expected identifier in nested name. [error >>> at 24] >>> object_initialize_child ( parent, propname, child, type) >>> ------------------------^ >>> If parenthesis in noptr-declarator (e.g., 'void (*f(int arg))(double)'): >>> Error in declarator or parameters >>> Invalid C declaration: Expecting "(" in parameters. [error at 32] >>> object_initialize_child ( parent, propname, child, type) >>> --------------------------------^ >>> >>> make[1]: *** [Makefile.ninja:9898: docs/devel.stamp] Error 2 >>> make[1]: *** Deleting file 'docs/devel.stamp' >>> make[1]: Leaving directory '/home/zippy/work/qemu/qemu.git/build' >>> make: *** [GNUmakefile:11: all] Error 2 >> >> I can't reproduce it using Sphinx v2.2.2. I'm still trying to >> understand what exactly the error means. >> > > Same here. > >> I really wish we used virtualenv + requirements.txt to require a >> specific version of Sphinx instead of wasting time dealing a wide >> range of Sphinx versions. >> > > I already have a patch that I keep locally to build with v3: > > diff --git a/docs/qemu-option-trace.rst.inc > b/docs/qemu-option-trace.rst.inc > index 7e09773a9c..ae83f6a1a8 100644 > --- a/docs/qemu-option-trace.rst.inc > +++ b/docs/qemu-option-trace.rst.inc > @@ -1,7 +1,7 @@ > > Specify tracing options. > > -.. option:: [enable=]PATTERN > +.. option:: enable=PATTERN > > Immediately enable events matching *PATTERN* > (either event name or a globbing pattern). This option is only > > > That said, I'm not objecting to requiring v2 for now and switching to v3 > later. > > > But interestingly, through trial and error I've came across this hack, > which allows me to build again. I have no idea why it works: > > diff --git i/include/qom/object.h w/include/qom/object.h > index 27aaa67e63..59c729ebb7 100644 > --- i/include/qom/object.h > +++ w/include/qom/object.h > @@ -762,13 +762,14 @@ bool object_initialize_child_with_propsv(Object > *parentobj, > * child, sizeof(*child), type, > * &error_abort, NULL) > */ > -#define object_initialize_child(parent, propname, child, type) \ > - object_initialize_child_internal((parent), (propname), \ > - (child), sizeof(*(child)), (type)) > void object_initialize_child_internal(Object *parent, const char > *propname, > void *child, size_t size, > const char *type); > > +#define object_initialize_child(parent, propname, child, type) \ > + object_initialize_child_internal((parent), (propname), \ > + (child), sizeof(*(child)), (type)) > + The error is due to kerneldoc treating the macro definition like a function, so that makes sense. If the docs look good (no reference to object_initialize_child_internal) then the patch can be applied. Paolo
On Fri, Oct 02, 2020 at 07:30:17PM +0200, Paolo Bonzini wrote: > On 02/10/20 19:26, Michal Prívozník wrote: > > On 10/2/20 6:22 PM, Eduardo Habkost wrote: > >> On Fri, Oct 02, 2020 at 05:58:55PM +0200, Michal Prívozník wrote: > >>> On 9/30/20 9:58 PM, Paolo Bonzini wrote: > >>>> > >>>> Eduardo Habkost (10): > >>> <snip/> > >>>> docs: Create docs/devel/qom.rst > >>> > >>> cd442a45db60a1a72fcf980c24bd1227f13f8a87 is the first bad commit > >>> > >>> Sorry for noticing this earlier, but is this known? The build starts > >>> failing > >>> for me after this commit: > >>> > >>> /usr/bin/sphinx-build -Dversion=5.1.50 -Drelease= -W > >>> -Ddepfile=docs/devel.d > >>> -Ddepfile_stamp=docs/devel.stamp -b html -d > >>> /home/zippy/work/qemu/qemu.git/build/docs/devel.p > >>> /home/zippy/work/qemu/qemu.git/docs/devel > >>> /home/zippy/work/qemu/qemu.git/build/docs/devel > >>> Running Sphinx v3.2.1 > >>> building [mo]: targets for 0 po files that are out of date > >>> building [html]: targets for 20 source files that are out of date > >>> updating environment: [new config] 20 added, 0 changed, 0 removed > >>> reading sources... [100%] testing > >>> > >>> > >>> > >>> > >>> Warning, treated as error: > >>> /home/zippy/work/qemu/qemu.git/docs/../include/qom/object.h:747:Error in > >>> declarator > >>> If declarator-id with parameters (e.g., 'void f(int arg)'): > >>> Invalid C declaration: Expected identifier in nested name. [error > >>> at 24] > >>> object_initialize_child ( parent, propname, child, type) > >>> ------------------------^ > >>> If parenthesis in noptr-declarator (e.g., 'void (*f(int arg))(double)'): > >>> Error in declarator or parameters > >>> Invalid C declaration: Expecting "(" in parameters. [error at 32] > >>> object_initialize_child ( parent, propname, child, type) > >>> --------------------------------^ > >>> > >>> make[1]: *** [Makefile.ninja:9898: docs/devel.stamp] Error 2 > >>> make[1]: *** Deleting file 'docs/devel.stamp' > >>> make[1]: Leaving directory '/home/zippy/work/qemu/qemu.git/build' > >>> make: *** [GNUmakefile:11: all] Error 2 > >> > >> I can't reproduce it using Sphinx v2.2.2. I'm still trying to > >> understand what exactly the error means. > >> > > > > Same here. > > > >> I really wish we used virtualenv + requirements.txt to require a > >> specific version of Sphinx instead of wasting time dealing a wide > >> range of Sphinx versions. > >> > > > > I already have a patch that I keep locally to build with v3: > > > > diff --git a/docs/qemu-option-trace.rst.inc > > b/docs/qemu-option-trace.rst.inc > > index 7e09773a9c..ae83f6a1a8 100644 > > --- a/docs/qemu-option-trace.rst.inc > > +++ b/docs/qemu-option-trace.rst.inc > > @@ -1,7 +1,7 @@ > > > > Specify tracing options. > > > > -.. option:: [enable=]PATTERN > > +.. option:: enable=PATTERN > > > > Immediately enable events matching *PATTERN* > > (either event name or a globbing pattern). This option is only > > > > > > That said, I'm not objecting to requiring v2 for now and switching to v3 > > later. > > > > > > But interestingly, through trial and error I've came across this hack, > > which allows me to build again. I have no idea why it works: > > > > diff --git i/include/qom/object.h w/include/qom/object.h > > index 27aaa67e63..59c729ebb7 100644 > > --- i/include/qom/object.h > > +++ w/include/qom/object.h > > @@ -762,13 +762,14 @@ bool object_initialize_child_with_propsv(Object > > *parentobj, > > * child, sizeof(*child), type, > > * &error_abort, NULL) > > */ > > -#define object_initialize_child(parent, propname, child, type) \ > > - object_initialize_child_internal((parent), (propname), \ > > - (child), sizeof(*(child)), (type)) > > void object_initialize_child_internal(Object *parent, const char > > *propname, > > void *child, size_t size, > > const char *type); > > > > +#define object_initialize_child(parent, propname, child, type) \ > > + object_initialize_child_internal((parent), (propname), \ > > + (child), sizeof(*(child)), (type)) > > + > > The error is due to kerneldoc treating the macro definition like a > function, so that makes sense. If the docs look good (no reference to > object_initialize_child_internal) then the patch can be applied. The patch makes the document show object_initialize_child_internal().
On Fri, Oct 02, 2020 at 06:27:35PM +0200, Paolo Bonzini wrote: > On 02/10/20 17:58, Michal Prívozník wrote: > >> > > > > cd442a45db60a1a72fcf980c24bd1227f13f8a87 is the first bad commit > > > > Sorry for noticing this earlier, but is this known? The build starts > > failing for me after this commit: > > > > /usr/bin/sphinx-build -Dversion=5.1.50 -Drelease= -W > > -Ddepfile=docs/devel.d -Ddepfile_stamp=docs/devel.stamp -b html -d > > /home/zippy/work/qemu/qemu.git/build/docs/devel.p > > /home/zippy/work/qemu/qemu.git/docs/devel > > /home/zippy/work/qemu/qemu.git/build/docs/devel > > Running Sphinx v3.2.1 > > building [mo]: targets for 0 po files that are out of date > > building [html]: targets for 20 source files that are out of date > > updating environment: [new config] 20 added, 0 changed, 0 removed > > reading sources... [100%] testing > > No, this is new. It works with older versions of Sphinx (I have 2.2.2 > despite being on Fedora 32 which is pretty recent). > > For now Sphinx 3 is not supported by kerneldoc, we probably should apply > a patch like > > https://www.spinics.net/lists/linux-doc/msg83277.html We already have Sphinx 3.x hacks inside our fork of kernel-doc, see commit 152d1967f650 ("kernel-doc: Use c:struct for Sphinx 3.0 and later"). If we want to keep deviating from upstream kernel-doc, the following patch seems to work. Do we want to? Signed-off-by: Eduardo Habkost <ehabkost@redhat.com> --- diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 40ad782e342..03b49380426 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -838,6 +838,13 @@ sub output_function_rst(%) { $lineprefix = ""; output_highlight_rst($args{'purpose'}); $start = "\n\n**Syntax**\n\n ``"; + } elsif ($args{'functiontype'} eq "") { + # this is a macro, Sphinx 3.x requires c:macro:: + if ((split(/\./, $sphinx_version))[0] >= 3) { + print ".. c:macro:: "; + } else { + print ".. c:function:: "; + } } else { print ".. c:function:: "; } > > Paolo >
On 02/10/20 20:24, Eduardo Habkost wrote: > On Fri, Oct 02, 2020 at 06:27:35PM +0200, Paolo Bonzini wrote: >> On 02/10/20 17:58, Michal Prívozník wrote: >>>> >>> >>> cd442a45db60a1a72fcf980c24bd1227f13f8a87 is the first bad commit >>> >>> Sorry for noticing this earlier, but is this known? The build starts >>> failing for me after this commit: >>> >>> /usr/bin/sphinx-build -Dversion=5.1.50 -Drelease= -W >>> -Ddepfile=docs/devel.d -Ddepfile_stamp=docs/devel.stamp -b html -d >>> /home/zippy/work/qemu/qemu.git/build/docs/devel.p >>> /home/zippy/work/qemu/qemu.git/docs/devel >>> /home/zippy/work/qemu/qemu.git/build/docs/devel >>> Running Sphinx v3.2.1 >>> building [mo]: targets for 0 po files that are out of date >>> building [html]: targets for 20 source files that are out of date >>> updating environment: [new config] 20 added, 0 changed, 0 removed >>> reading sources... [100%] testing >> >> No, this is new. It works with older versions of Sphinx (I have 2.2.2 >> despite being on Fedora 32 which is pretty recent). >> >> For now Sphinx 3 is not supported by kerneldoc, we probably should apply >> a patch like >> >> https://www.spinics.net/lists/linux-doc/msg83277.html > > We already have Sphinx 3.x hacks inside our fork of kernel-doc, > see commit 152d1967f650 ("kernel-doc: Use c:struct for Sphinx 3.0 > and later"). > > If we want to keep deviating from upstream kernel-doc, the > following patch seems to work. Do we want to? > > Signed-off-by: Eduardo Habkost <ehabkost@redhat.com> > --- > diff --git a/scripts/kernel-doc b/scripts/kernel-doc > index 40ad782e342..03b49380426 100755 > --- a/scripts/kernel-doc > +++ b/scripts/kernel-doc > @@ -838,6 +838,13 @@ sub output_function_rst(%) { > $lineprefix = ""; > output_highlight_rst($args{'purpose'}); > $start = "\n\n**Syntax**\n\n ``"; > + } elsif ($args{'functiontype'} eq "") { > + # this is a macro, Sphinx 3.x requires c:macro:: > + if ((split(/\./, $sphinx_version))[0] >= 3) { > + print ".. c:macro:: "; > + } else { > + print ".. c:function:: "; > + } > } else { > print ".. c:function:: "; > } >> >> Paolo >> > I can try sending these to upstream Linux, too. Paolo
On Fri, 2 Oct 2020 at 19:45, Paolo Bonzini <pbonzini@redhat.com> wrote: > On 02/10/20 20:24, Eduardo Habkost wrote: > > We already have Sphinx 3.x hacks inside our fork of kernel-doc, > > see commit 152d1967f650 ("kernel-doc: Use c:struct for Sphinx 3.0 > > and later"). > > > > If we want to keep deviating from upstream kernel-doc, the > > following patch seems to work. Do we want to? > I can try sending these to upstream Linux, too. I did mention the c:struct change we're carrying to Jon Corbet when I sent him the missing-close-paren fix to kernel-doc earlier this year: http://lkml.iu.edu/hypermail/linux/kernel/2004.1/08760.html I think it probably mostly needs somebody to try these changes in the context of producing the kernel docs and see if they are sufficient to fix kernel doc production too... thanks -- PMM
On 10/2/20 8:24 PM, Eduardo Habkost wrote: > On Fri, Oct 02, 2020 at 06:27:35PM +0200, Paolo Bonzini wrote: >> On 02/10/20 17:58, Michal Prívozník wrote: >>>> >>> >>> cd442a45db60a1a72fcf980c24bd1227f13f8a87 is the first bad commit >>> >>> Sorry for noticing this earlier, but is this known? The build starts >>> failing for me after this commit: >>> >>> /usr/bin/sphinx-build -Dversion=5.1.50 -Drelease= -W >>> -Ddepfile=docs/devel.d -Ddepfile_stamp=docs/devel.stamp -b html -d >>> /home/zippy/work/qemu/qemu.git/build/docs/devel.p >>> /home/zippy/work/qemu/qemu.git/docs/devel >>> /home/zippy/work/qemu/qemu.git/build/docs/devel >>> Running Sphinx v3.2.1 >>> building [mo]: targets for 0 po files that are out of date >>> building [html]: targets for 20 source files that are out of date >>> updating environment: [new config] 20 added, 0 changed, 0 removed >>> reading sources... [100%] testing >> >> No, this is new. It works with older versions of Sphinx (I have 2.2.2 >> despite being on Fedora 32 which is pretty recent). >> >> For now Sphinx 3 is not supported by kerneldoc, we probably should apply >> a patch like >> >> https://www.spinics.net/lists/linux-doc/msg83277.html > > We already have Sphinx 3.x hacks inside our fork of kernel-doc, > see commit 152d1967f650 ("kernel-doc: Use c:struct for Sphinx 3.0 > and later"). > > If we want to keep deviating from upstream kernel-doc, the > following patch seems to work. Do we want to? > > Signed-off-by: Eduardo Habkost <ehabkost@redhat.com> > --- > diff --git a/scripts/kernel-doc b/scripts/kernel-doc > index 40ad782e342..03b49380426 100755 > --- a/scripts/kernel-doc > +++ b/scripts/kernel-doc > @@ -838,6 +838,13 @@ sub output_function_rst(%) { > $lineprefix = ""; > output_highlight_rst($args{'purpose'}); > $start = "\n\n**Syntax**\n\n ``"; > + } elsif ($args{'functiontype'} eq "") { > + # this is a macro, Sphinx 3.x requires c:macro:: > + if ((split(/\./, $sphinx_version))[0] >= 3) { > + print ".. c:macro:: "; > + } else { > + print ".. c:function:: "; > + } > } else { > print ".. c:function:: "; > } >> >> Paolo >> > I can confirm that this fixes the build for me. Michal