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

Bug#1020635: trustedqsl: Documentation should be installed in /usr/share/doc/trustedqsl/



Hello Mathias,

On Sat, Sep 24, 2022 at 02:51:57PM +0000, Mathias Gibbens wrote:
> Package: trustedqsl
> Version: 2.6.5-1
> Severity: normal
> 
>   I happened to build trustedqsl this morning, and linitian flagged
> that lots of documentation is being installed in an incorrect location
> (/usr/share/TrustedQSL/help/). Policy Section 12.3 states that
> "[a]dditional documentation included in the package should be installed
> under /usr/share/doc/package."

This will require patching the upstream source.  The help files are used
by the software at runtime and in this regard, I don't necessarily
consider them "additional documentation."  The files are part of the
program.

>   Please update the packaging so documentation is installed in the
> proper location.

Is there a usability concern or use case you are trying to address?
When you start TQSL, you should be able to access the documentation via
Help -> Display Documentation.

>   Also, it's a bit weird to have the trustedqsl package installing
> files to /usr/share/TrustedQSL/ (note the difference in
> capitalization).

I agree that the capitalization is not typical and perhaps a bit
unfortunate, but there are other precedents.  I can't find anything in
policy that indicates that this is a problem.  Looking at my system,
TrustedQSL is not the only example:

$ ls -1 /usr/share | grep -E '^[A-Z]'
AAVMF
FaustWorks
GConf
GraphicsMagick-1.4
ImageMagick-6
ModemManager
Nuand
OVMF
PackageKit
Thunar
TrustedQSL
X11

We can certainly update the package, but I am not sure what bug we are
trying to address.  For the lintian warning, we can add an entry to
lintian-overrides. 

In addition to that, perhaps adding a symlink from
/usr/share/doc/trustedqsl/help -> /usr/share/TrustedQSL/help/tqslapp
would help users find the documentation who would prefer to use another
mechanism to access it?  It appears to render correctly via a web
browser pointed at: file:///usr/share/TrustedQSL/help/tqslapp/index.htm

Thank you,
tony

Attachment: signature.asc
Description: PGP signature


Reply to: