Bug#929922: Broken links to documentation in warning and READMEs

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

Bug#929922: Broken links to documentation in warning and READMEs

Peter Palfrader
Package: cryptsetup-initramfs
Version: 2:2.1.0-4
Severity: normal

Hi!

## 1 ##

| root@intrepid:~# update-initramfs -u
| update-initramfs: Generating /boot/initrd.img-4.19.0-5-amd64
| cryptsetup: WARNING: Option 'cipher' missing in crypttab for plain dm-crypt
|     mapping cswap. Please read /usr/share/doc/cryptsetup/README.initramfs and add
|     the correct 'cipher' option to your crypttab(5).
| cryptsetup: WARNING: Option 'size' missing in crypttab for plain dm-crypt
|     mapping cswap. Please read /usr/share/doc/cryptsetup/README.initramfs and add
|     the correct 'size' option to your crypttab(5).
..

However, that file does not exist:

} # ls /usr/share/doc/cryptsetup/README.initramfs
} ls: cannot access '/usr/share/doc/cryptsetup/README.initramfs': No such file or directory

} # ls /usr/share/doc/cryptsetup*/README.initramf*
} /usr/share/doc/cryptsetup-initramfs/README.initramfs.gz

Probably should point to that one instead.

## 2 ##

Also, that file then points to /usr/share/doc/cryptsetup/README.Debian
which also does not exist.  It should probably be
/usr/share/doc/cryptsetup-run/README.Debian.gz.

Cheers!
--
                            |  .''`.       ** Debian **
      Peter Palfrader       | : :' :      The  universal
 https://www.palfrader.org/ | `. `'      Operating System
                            |   `-    https://www.debian.org/

Reply | Threaded
Open this post in threaded view
|

Bug#929922: Broken links to documentation in warning and READMEs

Guilhem Moulin-2
Control: reassign 904916 -1 cryptsetup
Control: forcemerge 904916 -1

Hi Peter,

I guess #904916 would be #0 so I'm (force)merging with that bug.  We'll
need to chase which files dh_installdocs(1) installs compressed but
appear without ‘.gz’ suffix in user messages and/or documentation.

dh_compress(1) claims it compresses all changelog files plus all files
larger than 4kiB, and since AFAICT we don't have anything in debian/*
that is right at the limit I suppose we could hardcode suffixes.

On Mon, 03 Jun 2019 at 09:00:54 +0000, Peter Palfrader wrote:
> Also, that file then points to /usr/share/doc/cryptsetup/README.Debian
> which also does not exist.  It should probably be
> /usr/share/doc/cryptsetup-run/README.Debian.gz.

We'll rename ‘cryptsetup-run’ to ‘cryptsetup’ (the former will become a
transitional dummy package for the latter) once Buster is released, so
that will become /usr/share/doc/cryptsetup/README.Debian.gz :-)

Cheers,
--
Guilhem.

signature.asc (849 bytes) Download Attachment