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

Bug#874800: lintian: wish a lintian check for javadoc links



Package: lintian
Version: 2.5.50.4
Severity: wishlist

Packages of java libraries are often paired with *-doc packages
which include the matching javadoc.  This javadocs have links to
the javadocs of external referenced classes.  On the wild wild
internet, this usually links to the docs website of the package
that implements this external class but this is configurable.  In
Debian, these are configured to link to the javadocs of the local
filesystem.

However, it's very easy to misconfigure the links and would be
nice if lintian could identify this issue.  Two problems may
happen if these are misconfigured:

  1) links are not created

  2) links get created automatically to some website on the
     internet.  This is the case with maven --- a common build
     system for java projects --- which automatically guesses the
     links even in the absence of internet connection during the
     build.

However, I am unsure on how best to test this.  As far as I know,
there is no file listing the used external classes.  For the case
where links are created to external websites, the only method I
can see is to parse the html for href that end
in "?is-external=true" and check if they are an http link.

-- System Information:
Debian Release: 9.1
  APT prefers stable
  APT policy: (500, 'stable')
Architecture: amd64 (x86_64)

Kernel: Linux 4.9.0-3-amd64 (SMP w/32 CPU cores)
Locale: LANG=en_GB.UTF-8, LC_CTYPE=en_GB.UTF-8 (charmap=UTF-8), LANGUAGE=en_GB:en (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
Init: systemd (via /run/systemd/system)

Versions of packages lintian depends on:
ii  binutils                          2.28-5
ii  bzip2                             1.0.6-8.1
ii  diffstat                          1.61-1+b1
ii  file                              1:5.30-1+deb9u1
ii  gettext                           0.19.8.1-2
ii  intltool-debian                   0.35.0+20060710.4
ii  libapt-pkg-perl                   0.1.32
ii  libarchive-zip-perl               1.59-1
ii  libclass-accessor-perl            0.34-1
ii  libclone-perl                     0.38-2+b1
ii  libdpkg-perl                      1.18.24
ii  libemail-valid-perl               1.202-1
ii  libfile-basedir-perl              0.07-1
ii  libipc-run-perl                   0.94-1
ii  liblist-moreutils-perl            0.416-1+b1
ii  libparse-debianchangelog-perl     1.2.0-12
ii  libperl5.24 [libdigest-sha-perl]  5.24.1-3+deb9u1
ii  libtext-levenshtein-perl          0.13-1
ii  libtimedate-perl                  2.3000-2
ii  liburi-perl                       1.71-1
ii  libyaml-libyaml-perl              0.63-2
ii  man-db                            2.7.6.1-2
ii  patchutils                        0.3.4-2
ii  perl                              5.24.1-3+deb9u1
ii  t1utils                           1.39-2
ii  xz-utils                          5.2.2-1.2+b1

Versions of packages lintian recommends:
ii  dpkg                                 1.18.24
ii  libperlio-gzip-perl                  0.19-1+b2
ii  perl                                 5.24.1-3+deb9u1
ii  perl-modules-5.22 [libautodie-perl]  5.22.2-1
ii  perl-modules-5.24 [libautodie-perl]  5.24.1-3+deb9u1

Versions of packages lintian suggests:
pn  binutils-multiarch     <none>
ii  dpkg-dev               1.18.24
ii  libhtml-parser-perl    3.72-3
ii  libtext-template-perl  1.46-1

-- no debconf information


Reply to: