[Python-modules-team] Bug#963639: pygame: FTBFS with Sphinx 3.1: Invalid C declaration: Expected identifier in nested name. [error at 9] PyObject \*pgExc_BufferError

[Lucas Nussbaum]

Source: pygame
Version: 1.9.6+dfsg-3
Severity: important
Tags: ftbfs
User: python-modules-team at lists.alioth.debian.org
Usertags: sphinx3.1

Hi,

pygame fails to build with Sphinx 3.1, currently available in
experimental.

Relevant part (hopefully):
> make[1]: Entering directory '/<<PKGBUILDDIR>>'
> python3 setup.py build_sphinx
> running build_sphinx
> Running Sphinx v3.1.1
> making output directory... done
> building [mo]: targets for 0 po files that are out of date
> building [html]: targets for 68 source files that are out of date
> updating environment: [new config] 68 added, 0 changed, 0 removed
> reading sources... [  1%] c_api
> reading sources... [  2%] c_api/base
> reading sources... [  4%] c_api/bufferproxy
> reading sources... [  5%] c_api/cdrom
> reading sources... [  7%] c_api/color
> reading sources... [  8%] c_api/display
> reading sources... [ 10%] c_api/event
> reading sources... [ 11%] c_api/freetype
> reading sources... [ 13%] c_api/mixer
> reading sources... [ 14%] c_api/rect
> reading sources... [ 16%] c_api/rwobject
> reading sources... [ 17%] c_api/surface
> reading sources... [ 19%] c_api/surflock
> reading sources... [ 20%] c_api/version
> reading sources... [ 22%] filepaths
> reading sources... [ 23%] index
> reading sources... [ 25%] ref/bufferproxy
> /<<PKGBUILDDIR>>/docs/reST/c_api/base.rst:113: WARNING: Error in declarator or parameters
> Invalid C declaration: Expected identifier in nested name. [error at 9]
>   PyObject \*pgExc_BufferError
>   ---------^
> /<<PKGBUILDDIR>>/docs/reST/c_api/event.rst:25: WARNING: Error in declarator or parameters
> Invalid C declaration: Expected identifier in nested name. [error at 12]
>   pgEvent_Type
>   ------------^
> /<<PKGBUILDDIR>>/docs/reST/c_api/mixer.rst:31: WARNING: Error in declarator or parameters
> Invalid C declaration: Expecting "," or ")" in parameters, got "\". [error at 27]
>   int pgSound_Check(PyObject \*obj)
>   ---------------------------^
> /<<PKGBUILDDIR>>/docs/reST/c_api/mixer.rst:57: WARNING: Error in declarator or parameters
> Invalid C declaration: Expecting "," or ")" in parameters, got "\". [error at 29]
>   int pgChannel_Check(PyObject \*obj)
>   -----------------------------^
> /<<PKGBUILDDIR>>/docs/reST/c_api/mixer.rst:63: WARNING: Error in declarator or parameters
> Invalid C declaration: Expected identifier in nested name. [error at 10]
>   Mix_Chunk \*pgChannel_AsInt(PyObject \*x)
>   ----------^
> /<<PKGBUILDDIR>>/docs/reST/c_api/version.rst:24: WARNING: Error in declarator
> If declarator-id with parameters (e.g., 'void f(int arg)'):
>   Invalid C declaration: Expected identifier in nested name. [error at 13]
>     PG_VERSIONNUM(MAJOR, MINOR, PATCH)
>     -------------^
> 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 19]
>     PG_VERSIONNUM(MAJOR, MINOR, PATCH)
>     -------------------^
> 
> /<<PKGBUILDDIR>>/docs/reST/c_api/version.rst:28: WARNING: Error in declarator
> If declarator-id with parameters (e.g., 'void f(int arg)'):
>   Invalid C declaration: Expected identifier in nested name. [error at 18]
>     PG_VERSION_ATLEAST(MAJOR, MINOR, PATCH)
>     ------------------^
> 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 24]
>     PG_VERSION_ATLEAST(MAJOR, MINOR, PATCH)
>     ------------------------^
> 
> 
> Extension error:
> Handler <function collect_document_info at 0x7f92f14cb5e0> for event 'doctree-read' threw an exception
> ---
> For help with compilation see:
>     https://www.pygame.org/wiki/Compilation
> To contribute to pygame development see:
>     https://www.pygame.org/contribute.html
> ---
> make[1]: *** [debian/rules:46: override_dh_installdocs] Error 1

The full build log is available from:
   http://qa-logs.debian.net/2020/06/23/pygame_1.9.6+dfsg-3_unstable_sphinx-exp.log

Please see [1] for Sphinx changelog, which may give a hint of what changes in
Sphinx caused this error.

Also see [2] for the list of deprecated/removed APIs and possible alternatives
to them.

Sphinx 3.1 is going to be uploaded to unstable in a couple of weeks. When that
happens, the severity of this bug will be bumped to serious.

In case you have questions, please Cc sphinx at packages.debian.org on reply.

[1]: https://www.sphinx-doc.org/en/3.x/changes.html
[2]: https://www.sphinx-doc.org/en/3.x/extdev/deprecated.html

A list of current common problems and possible solutions is available at
http://wiki.debian.org/qa.debian.org/FTBFS . You're welcome to contribute!

About the archive rebuild: The rebuild was done on EC2 VM instances from
Amazon Web Services, using a clean, minimal and up-to-date chroot. Every
failed build was retried once to eliminate random failures.