lintian: override package-contains-documentation-outside-usr-share-doc for the default site pages #6

New issue

Open

opened 2026-10-03 10:59:19 -03:00 by marcos-mendez · 0 comments

marcos-mendez commented

2026-10-03 10:59:19 -03:00

(Migrated from github.com)

Context
The packages check runs lintian on the keel-web package. It reports three informational tags:

I: keel-web: package-contains-documentation-outside-usr-share-doc [usr/share/keel-web/default-site/404.html]
I: keel-web: package-contains-documentation-outside-usr-share-doc [usr/share/keel-web/default-site/50x.html]
I: keel-web: package-contains-documentation-outside-usr-share-doc [usr/share/keel-web/default-site/index.html]

These files are the pages the default site serves, not documentation, so the tag is a false positive.

What to do

Add packages/keel-web/debian/keel-web.lintian-overrides with one override for that tag on usr/share/keel-web/default-site/*, and a comment line above it saying why (the pages are served by Nginx; debian/rules explains why they live under /usr/share).
tests/package.bats checks the exact list of files in the package (the test "it installs the manifest, the two sites, the three pages, ..."). Add ./usr/share/lintian/overrides/keel-web to its expected list and update the test name to mention it.
Add an entry to packages/keel-web/debian/changelog with a new, higher version, in the style of the entries already there.
Build locally if you can (cd packages/keel-web && dpkg-buildpackage -us -uc, then lintian --info ../keel-web_*.changes) or rely on CI.

Done when
The packages check is green and its lintian output no longer lists the tag.

Help
Ask in https://github.com/orgs/Keel-Linux/discussions

**Context** The `packages` check runs lintian on the `keel-web` package. It reports three informational tags: ``` I: keel-web: package-contains-documentation-outside-usr-share-doc [usr/share/keel-web/default-site/404.html] I: keel-web: package-contains-documentation-outside-usr-share-doc [usr/share/keel-web/default-site/50x.html] I: keel-web: package-contains-documentation-outside-usr-share-doc [usr/share/keel-web/default-site/index.html] ``` These files are the pages the default site serves, not documentation, so the tag is a false positive. **What to do** 1. Add `packages/keel-web/debian/keel-web.lintian-overrides` with one override for that tag on `usr/share/keel-web/default-site/*`, and a comment line above it saying why (the pages are served by Nginx; `debian/rules` explains why they live under `/usr/share`). 2. `tests/package.bats` checks the exact list of files in the package (the test "it installs the manifest, the two sites, the three pages, ..."). Add `./usr/share/lintian/overrides/keel-web` to its `expected` list and update the test name to mention it. 3. Add an entry to `packages/keel-web/debian/changelog` with a new, higher version, in the style of the entries already there. 4. Build locally if you can (`cd packages/keel-web && dpkg-buildpackage -us -uc`, then `lintian --info ../keel-web_*.changes`) or rely on CI. **Done when** The `packages` check is green and its lintian output no longer lists the tag. **Help** Ask in https://github.com/orgs/Keel-Linux/discussions