[Pkg-xen-devel] Bug#942611: Bug#942611: xen-doc: Various text files stored as .txt.gz, but index references .txt

[Hans van Kranenburg]

tags 942611 + pending
thanks

Hi Diederik,

On 10/19/19 2:19 AM, Diederik de Haas wrote:
> Package: xen-doc
> Version: 4.11.1+92-g6c33308a8d-2+b1
> Severity: normal
> 
> file:///usr/share/doc/xen/html/index.html contains a link to
> file:///usr/share/doc/xen/html/misc/vtd.txt (VT-d HOWTO), but that file
> doesn't exist. There is a .../misc/vtd.txt.gz file though.
> A similar pattern can be found with various other .txt files, but not all.
> Since this is HTML documentation and presumably meant to be read in a browser 
> (which is what I did), I think those .txt.gz files should be stored as .txt, so
> they can be viewed in the browser and it would make the hyperlink actually work.

Yes, you are right. I do agree.

We already have the html documentation collection in a separate package,
xen-doc.

So, when someone installs that package, they explicitly choose to do so.
If they want to browse around at file:///usr/share/doc/xen/html/ then
there should not be broken links all over the place.

The difference between compressing or not compressing is 5.1M vs 5.2M
measured by doing dpkg-deb -x on the xen-doc .deb before and after and
then doing du -sch on the directory in which it was unpacked.

https://salsa.debian.org/xen-team/debian-xen/-/commit/38cde19f59ee4121e048b23cfe7e9ea4ddcbdf60
(commit id will vanish because of heavily rebasing later, it's "d/rules:
do not compress /usr/share/doc/xen/html")

> (Sidenote: I doubt including a file mentioning how to compile your own 2.6.18 kernel 
> to include support for VT-d is useful, and it is 10+ y/o, but that's probably an 
> upstream issue)

Heh, yes. Patches to remove obsolete documentation can be sent upstream
directly.

Have fun,
Hans