Bug#940999: lintian: warn about missing ${sphinxdoc:Depends} when dh_sphinxdoc is used
Package: lintian
Version: 2.22.0
Severity: wishlist
Dear Maintainer,
If dh_sphinxdoc is used, either explicitly in d/rules or added to the
debhelper sequence using `--with sphinxdoc`, the relevant -doc package should
have `Depends: ${sphinxdoc:Depends}`. Not doing so will leave a symlink farm
of dangling symlinks and non-functional documentation.
Something like…
Condition: 'sphinxdoc' included in d/rules and ${sphinxdoc:Depends} not in
d/control.
Message: The package is building documentation using sphinx and the
dh_sphinxdoc helper is being used to make links to various common files
from the documentation theme. To be fully functional, the documentation
package relies on files from other binary packages; these dependencies
are normally handled via the ${sphinxdoc:Depends} substitution variable
but ${sphinxdoc:Depends} is not used within the debian/control file.
See dh_sphinxdoc(1) for further details.
Associated question: should there be a check for a build-dep on python3-sphinx
without use of dh_sphinxdoc?
A not-quite correct check implies 43 Python packages have a _static
directory but not a dependency on the libjs-sphinxdoc or libjs-jquery which
is where the symlink farm points:
$ apt-cache show $(apt-file search -x -l usr/share/doc/python.*/_static/) | grep-dctrl -FDepends -v libjs-sphinxdoc -o -FDepends -v libjs-jquery -sPackage,Depends
(suggesting this because I had managed to forget it was ${sphinxdoc:Depends}
and not ${sphinx:Depends} and so spent time puzzling over why the relevant
dependencies weren't be added!)
regards
Stuart
Reply to: