lintian: package-contains-documentation-outside-usr-share-doc

[arif-ali]

As part of Debian packaging, lintian reports that we are shipping documentation outside of /usr/share/doc, primarily 2 README files

Below is the warning we get from the lintian program in Debian

I: python3-avocado: package-contains-documentation-outside-usr-share-doc [usr/lib/python3/dist-packages/avocado/etc/avocado/scripts/job/post.d/README]
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" <debian@kitterman.com>
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.
N: 
N:
I: python3-avocado: package-contains-documentation-outside-usr-share-doc [usr/lib/python3/dist-packages/avocado/etc/avocado/scripts/job/pre.d/README]

[arif-ali]

I've created a lintian-override for this, as this doesn't make sense to add to the wider /usr/share/doc