Bug#904852: lintian: package-contains-documentation-outside-usr-share-doc far too overzealous
On Sun, Jul 29, 2018 at 1:44 AM, Axel Beckert <abe@debian.org> wrote:
> Package: lintian
> Version: 2.5.94
> Severity: normal
>
> Hi,
>
> the phrase "Please move this files to /usr/share/doc/ or remove it."
> sounds very final, but completely ignores that there are quite a lot of
> files (often named README or so) documenting the purpose or contents of
> the directory they're in.
>
> Examples:
/etc should be already filtered, this is a plain bug
the other one will do something
Bastien
> ---------------------------------------------------------------------------
> $ cat /usr/lib/xymon/client/local/README
> This directory - the client/local/ directory - can be used to
> install Xymon client add-on scripts. The Xymon client will run
> all files in this directory that are executable, and include the
> output from each script in a separate section in the Xymon client
> message which is sent to the Xymon server.
>
> This output will have to be processed on the Xymon server; there
> is no default processing done by Xymon on the output from these
> scripts. They are merely added to the client data.
>
> If you want to install an add-on script that direcly generates a
> status column in Xymon, this should go in the client/ext/ directory
> instead.
> ---------------------------------------------------------------------------
> $ cat /etc/sudoers.d/README
> #
> # As of Debian version 1.7.2p1-1, the default /etc/sudoers file created on
> # installation of the package now includes the directive:
> #
> # #includedir /etc/sudoers.d
> #
> # This will cause sudo to read and parse any files in the /etc/sudoers.d
> # directory that do not end in '~' or contain a '.' character.
> #
> # Note that there must be at least one file in the sudoers.d directory (this
> # one will do), and all files in this directory should be mode 0440.
> #
> # Note also, that because sudoers contents can vary widely, no attempt is
> # made to add this directive to existing sudoers files on upgrade. Feel free
> # to add the above directive to the end of your /etc/sudoers file to enable
> # this functionality for existing installations if you wish!
> #
> # Finally, please note that using the visudo command is the recommended way
> # to update sudoers content, since it protects against many failure modes.
> # See the man page for visudo for more information.
> ---------------------------------------------------------------------------
> $ cat /usr/share/rlwrap/filters/README
> The filters in this directory have been written to test rlwrap,
> not to be practical.
> ---------------------------------------------------------------------------
>
> If you do a "find /etc /var /usr -name README -not -path
> '/usr/share/doc/*'" you'll find tons more of such cases, but also cases
> like these, where it definitely doesn't make sense to rename (!) all
> these files and put them elsewhere (didn't check if lintian complains
> about them, but according to the tag description it probably will):
>
> /usr/share/themes/Agualemon/xfwm4/README
> /usr/share/themes/BlackMATE/README
> /usr/share/themes/Moheli/xfwm4/README
> /usr/share/themes/Daloa/xfwm4/README
> /usr/share/themes/Default-4.2/xfwm4/README
> /usr/share/themes/Xfce/xfwm4/README
> /usr/share/themes/Perl/xfwm4/README
> /usr/share/themes/Tgc-large/xfwm4/README
> /usr/share/themes/Curve/xfwm4/README
> /usr/share/themes/Eazel-blue/xfwm4/README
> /usr/share/themes/ukui-theme-jun/gtk-2.0/widgets/README
> /usr/share/themes/Wallis/xfwm4/README
> /usr/share/themes/TraditionalOk/xfwm4/README
> /usr/share/themes/Defcon-IV/xfwm4/README
> /usr/share/themes/TUX/xfwm4/README
> /usr/share/themes/Tabs/xfwm4/README
> /usr/share/themes/Redmond/xfwm4/README
> /usr/share/themes/Kokodi/xfwm4/README
> /usr/share/themes/Retro/xfwm4/README
> /usr/share/themes/Alternate/xfwm4/README
> /usr/share/themes/Default/xfwm4/README
> /usr/share/themes/Gnububble/xfwm4/README
> /usr/share/themes/MurrinaBlue/xfwm4/README
> /usr/share/themes/Exocet/xfwm4/README
> /usr/share/themes/Platinum/xfwm4/README
> /usr/share/themes/Tubular/xfwm4/README
> /usr/share/themes/R9X/xfwm4/README
> /usr/share/themes/CortlandChicken/README
> /usr/share/themes/Microcurve/xfwm4/README
> /usr/share/themes/Symphony/xfwm4/README
> /usr/share/themes/Prune/xfwm4/README
> /usr/share/themes/RedmondXP/xfwm4/README
> /usr/share/themes/Wildbush/xfwm4/README
> /usr/share/themes/MurrinaAzul/xfwm4/README
> /usr/share/themes/Biz/xfwm4/README
> /usr/share/themes/Meenee/xfwm4/README
> /usr/share/themes/Slimline/xfwm4/README
> /usr/share/themes/BBS/xfwm4/README
> /usr/share/themes/Kde/xfwm4/README
> /usr/share/themes/Keramik/xfwm4/README
> /usr/share/themes/MurrinaBleu/xfwm4/README
> /usr/share/themes/Gtk/xfwm4/README
> /usr/share/themes/Coolclean/xfwm4/README
> /usr/share/themes/Default-4.0/xfwm4/README
> /usr/share/themes/Ops/xfwm4/README
> /usr/share/themes/Crux/xfwm4/README
> /usr/share/themes/Tgc/xfwm4/README
> /usr/share/themes/Elberg/xfwm4/README
> /usr/share/themes/Default-4.6/xfwm4/README
> /usr/share/themes/ukui-theme-black/gtk-2.0/widgets/README
> /usr/share/themes/Synthetic/xfwm4/README
> /usr/share/themes/MurrinaDark/xfwm4/README
> /usr/share/themes/Linea/xfwm4/README
> /usr/share/themes/Cruxish/xfwm4/README
> /usr/share/themes/Quiet-purple/xfwm4/README
> /usr/share/themes/Beastie/xfwm4/README
> /usr/share/themes/Kiwi/xfwm4/README
> /usr/share/themes/Galaxy/xfwm4/README
> /usr/share/themes/Coldsteel/xfwm4/README
> /usr/share/themes/ukui-theme-red/gtk-2.0/widgets/README
> /usr/share/themes/Iceg/xfwm4/README
> /usr/share/themes/Buzz/xfwm4/README
> /usr/share/themes/B6/xfwm4/README
> /usr/share/themes/ukui-theme-orange/gtk-2.0/widgets/README
> /usr/share/themes/Mofit/xfwm4/README
> /usr/share/themes/Agua/xfwm4/README
> /usr/share/themes/Microdeck/xfwm4/README
> /usr/share/themes/Quinx/xfwm4/README
> /usr/share/themes/Gorilla/xfwm4/README
> /usr/share/themes/Koynacity/xfwm4/README
> /usr/share/themes/Gelly/xfwm4/README
> /usr/share/themes/Basix/xfwm4/README
> /usr/share/themes/Triviality/xfwm4/README
> [...]
> /usr/share/emacs/25.2/lisp/international/README
> /usr/share/emacs/25.2/lisp/README
> /usr/share/emacs/25.2/lisp/term/README
> /usr/share/emacs/25.2/etc/forms/README
> /usr/share/emacs/25.2/etc/README
> /usr/share/emacs/25.2/etc/nxml/README
> /usr/share/emacs/25.2/etc/schema/README
> /usr/share/emacs/25.2/etc/org/README
> /usr/share/emacs/25.2/etc/e/README
> /usr/share/emacs/25.2/etc/charsets/README
> /usr/share/emacs/25.2/etc/refcards/README
> /usr/share/emacs/25.2/etc/images/README
> /usr/share/emacs/25.2/etc/images/low-color/README
> /usr/share/emacs/25.2/etc/images/gnus/README
> /usr/share/emacs/25.2/etc/images/tree-widget/default/README
> /usr/share/emacs/25.2/etc/images/tree-widget/folder/README
> /usr/share/emacs/25.2/etc/images/icons/README
> /usr/share/emacs/25.2/etc/images/mail/README
> /usr/share/emacs/25.2/etc/images/gud/README
> /usr/share/emacs/25.2/etc/images/newsticker/README
> /usr/share/emacs/25.2/etc/images/mpc/README
> /usr/share/emacs/25.2/etc/images/smilies/README
> /usr/share/emacs/25.2/etc/images/smilies/grayscale/README
> /usr/share/emacs/25.2/etc/images/smilies/medium/README
> /usr/share/emacs/25.2/etc/images/custom/README
> /usr/share/emacs/25.2/etc/images/ezimage/README
> /usr/share/inkscape/fonts/README
> /usr/share/inkscape/examples/README
> /usr/share/inkscape/filters/README
> /usr/share/inkscape/gradients/README
> /usr/share/inkscape/screens/README
> /usr/share/inkscape/icons/README
> /usr/share/inkscape/patterns/README
> /usr/share/inkscape/attributes/README
> /usr/share/inkscape/extensions/README
> /usr/share/inkscape/tutorials/README
> /usr/share/inkscape/templates/README
> /usr/share/inkscape/symbols/README
> /usr/share/inkscape/palettes/README
> /usr/share/inkscape/branding/README
> /usr/share/texlive/texmf-dist/fonts/vf/cs/cs-a35/README
> /usr/share/texlive/texmf-dist/fonts/source/public/semaphor/README
> /usr/share/texlive/texmf-dist/fonts/tfm/cs/cs-a35/README
> /usr/share/texlive/texmf-dist/fonts/misc/xetex/fontmapping/xetex-devanagari/README
> /usr/share/texlive/texmf-dist/fonts/cmap/dvipdfmx/README
> /usr/share/texlive/texmf-dist/fonts/map/dvips/tetex/README
> /usr/share/texlive/texmf-dist/fonts/type1/public/cs/README
> /usr/share/texlive/texmf-dist/mft/base/README
> /usr/share/texlive/texmf-dist/tex/fontinst/afm2pl/README
> /usr/share/texlive/texmf-dist/tex/plain/cyrplain/README
> /usr/share/texlive/texmf-dist/tex/latex/lhcyr/lhcyrkoi/README
> /usr/share/texlive/texmf-dist/tex/latex/lhcyr/lhcyralt/README
> /usr/share/texlive/texmf-dist/tex/latex/lhcyr/lhcyrwin/README
> /usr/share/texlive/texmf-dist/tex/generic/pst-geo/data/README
> /usr/share/texlive/texmf-dist/tex/generic/t2/cyrfinst/README
> /usr/share/texlive/texmf-dist/dvips/dvipsconfig/README
> /usr/share/fvwm-crystal/fvwm/decorations/Dawn of a Terminal/Red/README
> /usr/share/fvwm-crystal/fvwm/decorations/Dawn of a Terminal/Blue/README
> /usr/share/fvwm-crystal/fvwm/decorations/Dawn of a Terminal/Green/README
> /usr/share/fvwm-crystal/fvwm/decorations/Dawn of a Terminal/Purple/README
> /usr/share/fvwm-crystal/fvwm/decorations/Aqua/Blank buttons/README
> /usr/share/fvwm-crystal/fvwm/decorations/Aqua/Buttons with icons/README
> /usr/share/fvwm-crystal/fvwm/decorations/Mist/Default/README
> /usr/share/fvwm-crystal/fvwm/decorations/Ish/Aqua/README
> /usr/share/fvwm-crystal/fvwm/decorations/Ish/Pink/README
> /usr/share/fvwm-crystal/fvwm/decorations/Ish/Red/README
> /usr/share/fvwm-crystal/fvwm/decorations/Ish/Black/README
> /usr/share/fvwm-crystal/fvwm/decorations/Ish/Lite/README
> /usr/share/fvwm-crystal/fvwm/decorations/Ish/Blue/README
> /usr/share/fvwm-crystal/fvwm/decorations/Ish/Green/README
> /usr/share/fvwm-crystal/fvwm/decorations/Ish/Purple/README
> /usr/share/fvwm-crystal/fvwm/decorations/Ish/Orange/README
> /usr/share/fvwm-crystal/fvwm/decorations/Crystal/RedDesktop/README
> /usr/share/fvwm-crystal/fvwm/decorations/Crystal/Red - Cyan/README
> /usr/share/fvwm-crystal/fvwm/decorations/Crystal/IrishDesktop/README
> /usr/share/fvwm-crystal/fvwm/decorations/Crystal/DarkGreen/README
> /usr/share/fvwm-crystal/fvwm/decorations/Crystal/Original/README
> /usr/share/fvwm-crystal/fvwm/decorations/Crystal/CIOS-blue/README
> /usr/share/fvwm-crystal/fvwm/decorations/Crystal/CIOS/README
> /usr/share/fvwm-crystal/fvwm/decorations/Crystal/WhiteDesktop/README
> /usr/share/fvwm-crystal/fvwm/decorations/Crystal/CrystalZono/README
> /usr/share/fvwm-crystal/fvwm/decorations/Crystal/DarkDesktop/README
> /usr/share/fvwm-crystal/fvwm/decorations/Elberg/Default/README
> /usr/share/fvwm-crystal/fvwm/decorations/Amiga/Aqua/README
> /usr/share/fvwm-crystal/fvwm/decorations/Amiga/DarkAqua/README
> /usr/share/fvwm-crystal/fvwm/decorations/Amiga/AmigaOS 4/README
> /usr/share/fvwm-crystal/fvwm/decorations/MicroClear/Default/README
> /usr/share/fvwm-crystal/fvwm/decorations/Clearlooks/Default/README
> /usr/share/fvwm-crystal/fvwm/decorations/Clearlooks/DeepSky/README
> /usr/share/fvwm-crystal/fvwm/decorations/Clearlooks/Olive/README
> /usr/share/fvwm-crystal/fvwm/decorations/DawnSky/Default/README
> /usr/share/fvwm-crystal/fvwm/decorations/Clear/Red/README
> /usr/share/fvwm-crystal/fvwm/decorations/Clear/Blue/README
> /usr/share/fvwm-crystal/fvwm/decorations/Clear/Violet/README
> /usr/share/fvwm-crystal/fvwm/decorations/Clear/Green/README
> /usr/share/fvwm-crystal/fvwm/decorations/Clear/Mono/README
> /usr/share/fvwm-crystal/fvwm/decorations/Clear/Navy/README
> /usr/share/fvwm-crystal/fvwm/decorations/Clear/Orange/README
> /usr/share/fvwm-crystal/fvwm/decorations/Gentoo/Alternative/README
> /usr/share/fvwm-crystal/fvwm/decorations/Gentoo/Default/README
> /usr/share/fvwm-crystal/fvwm/decorations/Gentoo/Gray/README
> /usr/share/fvwm-crystal/fvwm/decorations/Motif/Pink Navy/README
> /usr/share/fvwm-crystal/fvwm/decorations/Motif/Cyan Gray/README
> /usr/share/fvwm-crystal/fvwm/decorations/Winter/Default/README
> /usr/share/fvwm-crystal/fvwm/decorations/SystemG/Default/README
> /usr/share/fvwm-crystal/fvwm/decorations/SystemG/Dusk/README
> /usr/share/fvwm-crystal/fvwm/decorations/SystemG/Crux/README
> /usr/share/fvwm-crystal/fvwm/decorations/SystemG/Dawn/README
> /usr/share/fvwm-crystal/fvwm/decorations/SystemG/SaltLake/README
> /usr/share/fvwm-crystal/fvwm/decorations/SystemG/Debian/README
> /usr/share/fvwm-crystal/fvwm/decorations/SystemG/BlueCurve/README
> /usr/share/fvwm-crystal/fvwm/decorations/SystemG/Geramik/README
> /usr/share/fvwm-crystal/fvwm/decorations/Fear/Default/README
> /usr/share/fvwm-crystal/fvwm/decorations/DarkSky/Black/README
> /usr/share/fvwm-crystal/fvwm/decorations/DarkSky/Gray/README
> /usr/share/games/flightgear/Input/Joysticks/ThrustMaster/Warthog/README
> /usr/share/games/flightgear/Aircraft/Instruments-3d/chronograph/README
> /usr/share/games/flightgear/Aircraft/Instruments-3d/cdu/README
> /usr/share/games/flightgear/Aircraft/Instruments-3d/mk-viii/README
> /usr/share/games/flightgear/Aircraft/Instruments-3d/mk-viii/assembly/README
> /usr/share/games/flightgear/Aircraft/Instruments-3d/RAF_Mk9_bubble_sextant/README
> /usr/share/games/flightgear/Aircraft/Instruments-3d/SCR-522C/README
> /usr/share/games/flightgear/Aircraft/Instruments-3d/garmin196/README
> /usr/share/games/flightgear/Aircraft/Instruments-3d/FG1000/README
> /usr/share/games/flightgear/Aircraft/Generic/README
> /usr/share/games/flightgear/Aircraft/Generic/Engines/README
> /usr/share/games/flightgear/Aircraft/c172p/dev/fdm/gerris/README
> /usr/share/games/flightgear/Fonts/README
> /usr/share/games/flightgear/Fonts/DSEG/README
> /usr/share/games/micropolis/manual/README
>
> etc.
>
> And if I look at
> https://lintian.debian.org/tags/package-contains-documentation-outside-usr-share-doc.html
> nearly every package I checked which is listed there with the same file
> name in multiple directories is is obviously a false positive of the
> "describes the directory" case.
>
> So please ignore at least _all_ such files which contain phrases like
> "this directory" and replace the phrase
>
>> Please move this files to /usr/share/doc/ or remove it.
>
> with e.g.
>
>> If this file doesn't describe the contents or purpose of the directory
>> it is in, please consider moving this file to /usr/share/doc/ or maybe
>> even removing it. If this file does describe the contents or purpose
>> of the directory it is in, please add a lintian override.
>
> -- System Information:
> Debian Release: buster/sid
> APT prefers unstable
> APT policy: (990, 'unstable'), (600, 'testing'), (500, 'unstable-debug'), (500, 'buildd-unstable'), (110, 'experimental'), (1, 'experimental-debug'), (1, 'buildd-experimental')
> Architecture: amd64 (x86_64)
>
> Kernel: Linux 4.17.0-1-amd64 (SMP w/8 CPU cores)
> Locale: LANG=C.UTF-8, LC_CTYPE=C.UTF-8 (charmap=UTF-8), LANGUAGE=C.UTF-8 (charmap=UTF-8)
> Shell: /bin/sh linked to /bin/dash
> Init: sysvinit (via /sbin/init)
> LSM: AppArmor: enabled
>
> Versions of packages lintian depends on:
> ii binutils 2.31.1-2
> ii bzip2 1.0.6-8.1
> ii diffstat 1.61-1+b1
> ii dpkg 1.19.0.5+b1
> ii file 1:5.33-3
> ii gettext 0.19.8.1-6+b1
> ii intltool-debian 0.35.0+20060710.4
> ii libapt-pkg-perl 0.1.34
> ii libarchive-zip-perl 1.60-1
> ii libclass-accessor-perl 0.51-1
> ii libclone-perl 0.39-1
> ii libdigest-sha-perl 6.02-1
> ii libdpkg-perl 1.19.0.5
> ii libemail-valid-perl 1.202-1
> ii libfile-basedir-perl 0.08-1
> ii libipc-run-perl 20180523.0-1
> ii liblist-moreutils-perl 0.416-1+b3
> ii libparse-debianchangelog-perl 1.2.0-12
> ii libtext-levenshtein-perl 0.13-1
> ii libtimedate-perl 2.3000-2
> ii liburi-perl 1.74-1
> ii libxml-simple-perl 2.25-1
> ii libyaml-libyaml-perl 0.72+repack-1
> ii man-db 2.8.4-1
> ii patchutils 0.3.4-2
> ii perl [libdigest-sha-perl] 5.26.2-6
> ii t1utils 1.41-2
> ii xz-utils 5.2.2-1.3
>
> Versions of packages lintian recommends:
> ii libperlio-gzip-perl 0.19-1+b4
>
> Versions of packages lintian suggests:
> ii binutils-multiarch 2.31.1-2
> ii dpkg-dev 1.19.0.5
> ii libhtml-parser-perl 3.72-3+b2
> ii libtext-template-perl 1.53-1
>
> -- no debconf information
>
Reply to: