Bug#886120: Doxygen makes ctpp2 randomly FTBFS, syntax errors, hides problems
On Sat, Dec 01, 2018 at 04:17:13PM +0100, Agustin Henze wrote:
> Control: tag -1 +moreinfo +unreproducible
> Control: severity -1 normal
>
> Hi Adam,
>
> I have been trying to reproduce the FTBFS of the cttp2 package (more than 20
> times) you are saying without success. I've used the following script to do that
That's the whole problem! The FTBFS is random -- comes and goes; on current
unstable I can't seem to reproduce the build failure on either the amd64
machine nor the armhf one; when something else changes the issue will come
back. Whether it ends up in a build failure or not depends on _something_
that might be phase of the moon, some race inside the build that
semi-reliably gets won by one of the sides for a given state of the
toolchain, etc.
But that's only a symptom, not the cause.
The cause reproduces reliably:
Running dot for graph 763/1263
Running dot for graphError: /<<PKGBUILDDIR>>/doc/html/a01347_a236ee5e58731c059affd0e50b4d0aee4_cgraph.dot: syntax error in line 18 near '-'
error: Problems running dot: exit code=1, command='dot', arguments='"/<<PKGBUILDDIR>>/doc/html/a01347_a236ee5e58731c059affd0e50b4d0aee4_cgraph.dot" -Tsvg -o "/<<PKGBUILDDIR>>/doc/html/a01347_a236ee5e58731c059affd0e50b4d0aee4_cgraph.svg"'
error: Problems running dot: exit code=1, command='dot', arguments='"/<<PKGBUILDDIR>>/doc/html/a01347_ab353c212082bbd71bd9c3c69f136f3bf_cgraph.dot" -Tsvg -o "/<<PKGBUILDDIR>>/doc/html/a01347_ab353c212082bbd71bd9c3c69f136f3bf_cgraph.svg"'
Error: /<<PKGBUILDDIR>>/doc/html/a01347_a39915107bcf5ac712b6a28163a2653e2_cgraph.dot: syntax error in line 14 near '-'
error: Problems running dot: exit code=1, command='dot', arguments='"/<<PKGBUILDDIR>>/doc/html/a01347_a39915107bcf5ac712b6a28163a2653e2_cgraph.dot" -Tsvg -o "/<<PKGBUILDDIR>>/doc/html/a01347_a39915107bcf5ac712b6a28163a2653e2_cgraph.svg"'
Error: /<<PKGBUILDDIR>>/doc/html/a01347_ad9290c6979f4d804ed33483beb548c14_cgraph.dot: syntax error in line 34 near '-'
error: Problems running dot: exit code=1, command='dot', arguments='"/<<PKGBUILDDIR>>/doc/html/a01347_ad9290c6979f4d804ed33483beb548c14_cgraph.dot" -Tsvg -o "/<<PKGBUILDDIR>>/doc/html/a01347_ad9290c6979f4d804ed33483beb548c14_cgraph.svg"'
Error: /<<PKGBUILDDIR>>/doc/html/a01359_ae99959d42c4f7f886dd420aa119b29e2_cgraph.dot: syntax error in line 75 near '-'
error: Problems running dot: exit code=1, command='dot', arguments='"/<<PKGBUILDDIR>>/doc/html/a01359_ae99959d42c4f7f886dd420aa119b29e2_cgraph.dot" -Tsvg -o "/<<PKGBUILDDIR>>/doc/html/a01359_ae99959d42c4f7f886dd420aa119b29e2_cgraph.svg"'
Error: /<<PKGBUILDDIR>>/doc/html/a01359_a98233ab4534754a671fae8ab588ef5e7_cgraph.dot: syntax error in line 49 near '-'
error: Problems running dot: exit code=1, command='dot', arguments='"/<<PKGBUILDDIR>>/doc/html/a01359_a98233ab4534754a671fae8ab588ef5e7_cgraph.dot" -Tsvg -o "/<<PKGBUILDDIR>>/doc/html/a01359_a98233ab4534754a671fae8ab588ef5e7_cgraph.svg"'
Error: /<<PKGBUILDDIR>>/doc/html/a01359_aa0295dae085e2be96737ed0fd19ad714_cgraph.dot: syntax error in line 49 near '-'
(and so on)
> For this reason I'm changing the severity, feel free to provide more
> information about the FTBFS and what environment are you using to get them.
The proper severity is RC: silently ignoring errors here:
* is a violation of a "must" clause of the Policy
* notoriously wastes maintainers' and QA's time dealing with heisenbugs like
this FTBFS of ctpp2
> Also, please find more answer below
>
> On Fri, 2 Feb 2018 02:45:00 +0100 Adam Borowski <kilobyte@angband.pl> wrote:
> [...]
> > As I don't see anything obvious in the way ctpp2 calls doxygen + graphviz,
> > there's no point in having the bug stay here. The culprit here is doxygen
> > as it's where the syntax errors come from.
> >
> > Generating calError: /<<PKGBUILDDIR>>/doc/html/a00332_a3c04138a5bfe5d72780bb7e82a18e627_cgraph.dot: syntax error in line 67 near '-'
> > error: Problems running dot: exit code=1, command='dot', arguments='"/<<PKGBUILDDIR>>/doc/html/a00332_a3c04138a5bfe5d72780bb7e82a18e627_cgraph.dot" -Tsvg -o "/<<PKGBUILDDIR>>/doc/html/a00332_a3c04138a5bfe5d72780bb7e82a18e627_cgraph.svg"'
> > Running Error: /<<PKGBUILDDIR>>/doc/html/a00603_a6824947e6525f4afddb3bfa083f950d9_icgraph.dot: syntax error in line 8 near '-'
> > error: Problems running dot: exit code=1, command='dot', arguments='"/<<PKGBUILDDIR>>/doc/html/a00603_a6824947e6525f4afddb3bfa083f950d9_icgraph.dot" -Tsvg -o "/<<PKGBUILDDIR>>/doc/html/a00603_a6824947e6525f4afddb3bfa083f950d9_icgraph.svg"'
> > ... and many others.
> >
>
> I could reproduce them, and I think it's not a doxygen job ensure that you
> write correct `dot` syntax in your comments. Doxygen process its commands
> (that's all) and for the strings you have to ensure they are accepted by dot
> later. At least, I couldn't find anything about Doxygen will escape the strings
> for you in the documentation. But maybe it was me reading too quickly. For this
> reason I think we should close this bug, because you have to forward these
> issues to upstream to get the strings fixed in the documentation. I've tried
> fixing one of them and it worked, so...
As far as I know (but I don't know doxygen), no other tool produces these
strings, thus they come from doxygen and thus need to be sane. If I'm wrong
and it's some other package what's the culprit, please reassign.
> Please if you think we should need digging into it, provide more information
> about why do you believe that Doxygen should be the responsible for sanitizing
> the strings in the code. Otherwise I'll close this bug soon.
Closing this bug (or keeping it at an ignorable severity) means we'll run
into this very problem again for some other random package. And waste time
once again.
Meow!
--
⢀⣴⠾⠻⢶⣦⠀
⣾⠁⢠⠒⠀⣿⡁ Ivan was a wordly man: born in St. Petersburg, raised in
⢿⡄⠘⠷⠚⠋⠀ Petrograd, lived most of his life in Leningrad, then returned
⠈⠳⣄⠀⠀⠀⠀ to the city of his birth to die.
Reply to: