Bug#995457: libucx0: broken symlink: /usr/share/doc/libucx0/README

[Paul Wise]

Package: libucx0
Version: 1.11.2~rc1-2
Severity: normal
File: /usr/share/doc/libucx0/README
User: debian-qa at lists.debian.org
Usertags: adequate broken-symlink

There is now a broken symlink in the libucx0 package:

   $ adequate libucx0 | grep broken-symlink
   libucx0:amd64: broken-symlink /usr/share/doc/libucx0/README -> README.md

It looks like what happened is that the upstream maintainer turned the
README file into a symbolic link and that was not noticed on upgrade:

   $ chronic apt source ucx
   $ ls -l ucx*/*README*
   lrwxrwxrwx 1 pabs pabs    9 Sep 25 19:44 ucx-1.11.2~rc1/README -> README.md
   -rw-r----- 1 pabs pabs 7.0K Sep 25 19:44 ucx-1.11.2~rc1/README.md

Since this file is only in the shared library package and that is only
installed as a dependency, and dependency-only packages don't generally 
need documentation, and build-dependency-only packages don't either,
and the README/etc do not contain API docs suitable for libucx-dev,
I think that the right solution is to install the documentation only
into the ucx-utils package, so rename libucx0.docs to ucx-utils.docs.

   $ grep -r README ucx*/debian/
   ucx-1.11.2~rc1/debian/libucx0.docs:README
   
   $ cat ucx*/debian/libucx0.docs
   AUTHORS
   NEWS
   README
   
   $ ls -l ucx*/debian/*docs
   -rw-r----- 1 pabs pabs 20 Sep 26 17:51 ucx-1.11.2~rc1/debian/libucx0.docs

More information about the missing symlink:

   $ chase /usr/share/doc/libucx0/README
   chase: /usr/share/doc/libucx0/README.md: No such file or directory
   
   $ ls -l /usr/share/doc/libucx0/README{,.md}
   ls: cannot access '/usr/share/doc/libucx0/README.md': No such file or directory
   lrwxrwxrwx 1 root root 9 Sep 26 17:51 /usr/share/doc/libucx0/README -> README.md

-- System Information:
Debian Release: bookworm/sid
  APT prefers testing-debug
  APT policy: (900, 'testing-debug'), (900, 'testing'), (800, 'unstable-debug'), (800, 'unstable'), (790, 'buildd-unstable'), (700, 'experimental-debug'), (700, 'experimental'), (690, 'buildd-experimental')
Architecture: amd64 (x86_64)

Kernel: Linux 5.14.0-1-amd64 (SMP w/8 CPU threads)
Locale: LANG=en_AU.utf8, LC_CTYPE=en_AU.utf8 (charmap=UTF-8), LANGUAGE=en_AU:en
Shell: /bin/sh linked to /bin/dash
Init: systemd (via /run/systemd/system)
LSM: AppArmor: enabled

Versions of packages libucx0:amd64 depends on:
ii  ibverbs-providers  36.0-1
ii  libc6              2.32-4
ii  libibverbs1        36.0-1
ii  libnuma1           2.0.14-3
ii  librdmacm1         36.0-1

libucx0:amd64 recommends no packages.

libucx0:amd64 suggests no packages.

-- no debconf information

-- 
bye,
pabs

https://wiki.debian.org/PaulWise
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: This is a digitally signed message part
URL: <http://alioth-lists.debian.net/pipermail/debian-science-maintainers/attachments/20211001/e4e9dab9/attachment.sig>