[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#886120: Doxygen makes ctpp2 randomly FTBFS, syntax errors, hides problems



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

#!/bin/bash

set -e
count=0

while true; do
    sbuild -A -s --force-orig-source -j4 -d sid-amd64 ./ctpp2-2.8.3
    count=$((count + 1))
done

function finish {
    echo $count
}
trap finish EXIT

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.

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...
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.

Cheers,

-- 
TiN

Attachment: signature.asc
Description: OpenPGP digital signature


Reply to: