|Open||None||T233788 Doxygen output should strip @suppress annotations|
|Open||None||T241182 Doxygen: Ignore `@phan` notation (and more)|
|Open||holger.knust||T248706 Resolve Doxygen warnings thrown when the Mediawiki Core documentation is being generated|
|Resolved||• hashar||T242155 Update Doxygen in CI to 1.8.17 or greater|
|Duplicate||• hashar||T250424 Update operations/debs/doxygen to 1.8.17 or later and release into apt.wikimedia.org|
- Mentioned In
- T253793: Update Doxygen to 1.8.18
T253723: mwext-doxygen-publish fails: corrupted size vs. prev_size
T250467: Document how to backport Doxygen from Debian
- Mentioned Here
- T253723: mwext-doxygen-publish fails: corrupted size vs. prev_size
T233788: Doxygen output should strip @suppress annotations
T239482: Update Doxygen in CI to 1.8.15 or greater
Doxygen 1.8.17 is being packaged in Debian under the experimental branch so it is not entirely ready. A few days ago it got some build failure fixed, unfortunately that lacks a debian tag to build from. I have contacted the developer to have it added.
- 12dcaa1 - (debian/master, debian/HEAD) release to experimental (9 days ago) <Paolo Greppi>
- 3c56103 - Fix sass compilation error (9 days ago) <Paolo Greppi>
- 6586480 - (tag: debian/1.8.17-1_exp1) release to experimental (3 months ago) <Paolo Greppi>
The fix is for a build failure with unstable ( https://bugs.debian.org/954677 ) but maybe we are not affected under Buster.
I will have merge their debian work into our Buster backport branch debian/buster-wikimedia
Good news, the few modifications I had to do to build on Buster got fixed upstream, so our fork is a bit simpler now.
The missing tag is not needed (T242155#6064021 above), the fix is for unstable and does not affect Buster.
The CI build passed: https://integration.wikimedia.org/ci/job/debian-glue/1852/ and has the resulting debian package attached if one wanna try it on Buster: https://integration.wikimedia.org/ci/job/debian-glue/1852/artifact/doxygen_1.8.17-1%7Eexp4%7Edeb10+wmf1+0%7E20200416203000.1852+buster+wikimedia%7E1.gbpd455f1_amd64.deb
So I guess we can test it, review my backport patch (Gerrit 589416) then handle it to SRE :]
1.8.17 has been tagged for Debian unstable and I have rebased my patch on it.
I build the MediaWiki documentation with the CI generated package and it seems to work. Recipe:
FROM docker-registry.wikimedia.org/releng/doxygen:0.6.1-s1 COPY doxygen_1.8.17-1~deb10+wmf1+0~20200504173100.1872+buster+wikimedia~1.gbp62715f_amd64.deb doxygen.deb USER root RUN dpkg -i doxygen.deb && rm doxygen.deb USER nobody
<?php $wgServer = "http://127.0.0.1";
$ docker build -t foo . $ install --directory --mode 777 docs $ docker run \ -v "$(pwd)/docs":/docs \ -v ~/projects/mediawiki/core:/src \ -v "$(pwd)/LocalSettings.php":/src/LocalSettings.php \ --workdir /src \ --entrypoint=/usr/bin/php foo:latest \ maintenance/mwdocgen.php --output /docs
Then I have browsed the generated html and dot files ;)
The update is https://gerrit.wikimedia.org/r/#/c/operations/debs/doxygen/+/589416/ and is for Buster. I have tested the CI generated package and it works.
Once rebuild, the package should be uploaded on apt.wikimedia.org buster-wikimedia component/ci.