Package: lintian Version: 2.140.0 Severity: normal X-Debbugs-Cc: [email protected]
Dear Maintainer, lintian looks for documentation outside /usr/share/doc and emits the package-contains-documentation-outside-usr-share-doc tag if it finds some. Of course there are some files that might look like documentation but are actually in the right place and so should not cause this tag to be emitted. One such set of files are in the `dist-info` directory of a python module, where various pieces of metadata that represent how the module was built, its dependencies (for the Python world) and licence data are stored. For example: /usr/lib/python3/dist-packages/python_debian-1.1.1.dist-info /usr/lib/python3/dist-packages/python_debian-1.1.1.dist-info/INSTALLER /usr/lib/python3/dist-packages/python_debian-1.1.1.dist-info/METADATA /usr/lib/python3/dist-packages/python_debian-1.1.1.dist-info/top_level.txt However, lintian has started flagging these files with package-contains-documentation-outside-usr-share-doc. I: python3-debian: package-contains-documentation-outside-usr-share-doc [usr/lib/python3/dist-packages/python_debian-1.1.1.dist-info/top_level.txt] N: N: This package ships a documentation file outside /usr/share/doc N: Documentation files are normally installed inside /usr/share/doc. N: N: If this file doesn't describe the contents or purpose of the directory it N: is in, please consider moving this file to /usr/share/doc/ or maybe even N: removing it. If this file does describe the contents or purpose of the N: directory it is in, please add a lintian override. N: N: Visibility: info N: Show-Always: no N: Check: documentation N: N: Screen: python/egg/metadata N: Advocates: "Scott Kitterman" <[email protected]> N: Reason: The folders XXX.dist-info/ and XXX.egg-info/ hold metadata for N: Python modules. Those files are not documentation even though N: some of their names carry the .txt file extension. N: N: Python modules can be both public and private. N: N: Read more in N: https://www.python.org/dev/peps/pep-0427/#the-dist-info-directory, N: https://www.python.org/dev/peps/pep-0376/#id16, N: https://www.python.org/dev/peps/pep-0610/, N: https://www.python.org/dev/peps/pep-0639/, N: https://setuptools.pypa.io/en/latest/deprecated/python_eggs.html, N: and Bug#1003913. (I leave the details of the intended streen in the output.) This is a regression - up until recently, lintian did not complain about these text files within the Python module definition. thanks for your work on lintian! Stuart
