Bug#904852: lintian: package-contains-documentation-outside-usr-share-doc far too overzealous
On Tue, Aug 7, 2018 at 3:54 PM Chris Lamb wrote: > > Chris Lamb wrote: > > > > 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. > > > > I agree. Bastian, you added this in #901274 — can you chime in here? I > > am not the greatest fan of this tag, and have already skipped it in some > > of my own packages which is not the best sign from a Lintian maintainer... > > Gentle ping on this, Bastian? :) Done will check only this directory in README.* > > > Regards, > > -- > ,''`. > : :' : Chris Lamb > `. `'` la...@debian.org / chris-lamb.co.uk >`-
Bug#904852: lintian: package-contains-documentation-outside-usr-share-doc far too overzealous
Chris Lamb wrote: > > 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. > > I agree. Bastian, you added this in #901274 — can you chime in here? I > am not the greatest fan of this tag, and have already skipped it in some > of my own packages which is not the best sign from a Lintian maintainer... Gentle ping on this, Bastian? :) Regards, -- ,''`. : :' : Chris Lamb `. `'` la...@debian.org / chris-lamb.co.uk `-
Bug#904852: lintian: package-contains-documentation-outside-usr-share-doc far too overzealous
Hi Bastien, Bastien ROUCARIES wrote: > /etc should be already filtered, this is a plain bug Sorry, I just tried to give examples for the type of files which should not be reported, not (only) actual false positives. /etc/ seems filtered according to https://lintian.debian.org/tags/package-contains-documentation-outside-usr-share-doc.html so there is no bug wrt. to filtering /etc/. My point is though that the reason for which /etc/ is filtered (documenting directories I assume), also applies to /usr/ and especially /usr/local/ (plugin directories, template directories, theme directories, etc.). IMHO this tag causes too many false positives currently. I ran into it with the two cases (image set directory and some special and non-obvious directory for local monitoring check evaluation) inside the xymon package (not shown in the web because of too many tags). Here's what I have in my override files (currently only in git): xymon-client: package-contains-documentation-outside-usr-share-doc usr/lib/xymon/client/local/README xymon: package-contains-documentation-outside-usr-share-doc usr/share/xymon/gifs/README > the other one will do something Thanks! Regards, Axel -- ,''`. | Axel Beckert , https://people.debian.org/~abe/ : :' : | Debian Developer, ftp.ch.debian.org Admin `. `' | 4096R: 2517 B724 C5F6 CA99 5329 6E61 2FF9 CD59 6126 16B5 `-| 1024D: F067 EA27 26B9 C3FC 1486 202E C09E 1D89 9593 0EDE
Bug#904852: lintian: package-contains-documentation-outside-usr-share-doc far too overzealous
On Sun, Jul 29, 2018 at 1:44 AM, Axel Beckert 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 >
Bug#904852: lintian: package-contains-documentation-outside-usr-share-doc far too overzealous
Hi Axel, > 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. I agree. Bastian, you added this in #901274 — can you chime in here? I am not the greatest fan of this tag, and have already skipped it in some of my own packages which is not the best sign from a Lintian maintainer... Best wishes, -- ,''`. : :' : Chris Lamb `. `'` la...@debian.org / chris-lamb.co.uk `-
Bug#904852: lintian: package-contains-documentation-outside-usr-share-doc far too overzealous
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: --- $ 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
