search

melmothx / amusewiki

Text::Amuse-based publishing platform
https://amusewiki.org
Other
169 stars 26 forks source link

A Lintian CI and some POD patches. #431

Closed guest20 closed 1 year ago

guest20 commented 1 year ago

Since the last ball of yaml was so well received, please find attached: more YAML.

I'm not sure if deleting the whole test directory is the cleanest way to get a built .deb to point lintian at without waiting for the tests to run.

This is related to #352, but does not fix them all. It gets these easy(ish) pod-related ones:

Sadly these boys have dbic sums in 'em, so i'm not sure how to sneak a description in without DBIc getting upset:

W: amusewiki: bad-whatis-entry usr/share/man/man3/AmuseWikiFarm::Schema::Result::SiteCategoryType.3pm.gz
W: amusewiki: bad-whatis-entry usr/share/man/man3/AmuseWikiMeta.3pm.gz

I'm also not sure what Lintian means when it says one should use a packaged jquery stuff, it seems like dpkg doesn't love the idea of installing multiple versions of the same package...

melmothx commented 1 year ago

I think you can set the DEB_BUILD_OPTIONS to build the deb without running the tests.

DEB_BUILD_OPTIONS=nocheck debuild -i -us -uc -b

melmothx commented 1 year ago

guest20 @.***> writes:

Since the last ball of yaml was so well received, please find attached: more YAML.

Well, this looks great, thanks!

I'm not sure if deleting the whole test directory is the cleanest way to get a built .deb to point lintian at without waiting for the tests to run.

I think exporting this variable will do:

DEB_BUILD_OPTIONS=nocheck

This is related to #352, but does not fix them all. It gets these easy(ish) pod-related ones:

  • manpage-has-bad-whatis-entry
  • manpage-has-errors-from-pod2man
  • binary-without-manpage

Great, thanks.

Sadly these boys have dbic sums in 'em, so i'm not sure how to sneak a description in without DBIc getting upset:

W: amusewiki: bad-whatis-entry usr/share/man/man3/AmuseWikiFarm::Schema::Result::SiteCategoryType.3pm.gz
W: amusewiki: bad-whatis-entry usr/share/man/man3/AmuseWikiMeta.3pm.gz

They can be set pretty easily (sql/sqlite.sql with an entry in table comments) without getting DBIC upset. I'll look at those.

I'm also not sure what Lintian means when it says one should use a packaged jquery stuff, it seems like dpkg doesn't love the idea of installing multiple versions of the same package...

Yeah, I'm aware of that, but I think that can be ignored. We (mostly) know what we're doing.

You can view, comment on, or merge this pull request online at:

https://github.com/melmothx/amusewiki/pull/431

-- Commit Summary --

  • Create lintian.yaml
  • manpage-has-bad-whatis-entry: amusewiki-set-site-variable
  • manpage-has-bad-whatis-entry: AmuseWikiFarm::Archive::Xapian::Result
  • lintian --verbose
  • binary-without-manpage: amusewiki-generate-meta-config
  • manpage-has-errors-from-pod2man: AmuseWikiMeta
  • Update lintian.yaml
  • pod-conversion-message: AmuseWikiFarm::Controller::Remote

-- File Changes --

A .github/workflows/lintian.yaml (66)
M lib/AmuseWikiFarm/Archive/Xapian/Result.pm (10)
M lib/AmuseWikiFarm/Controller/Remote.pm (32)
M lib/AmuseWikiMeta.pm (12)
M script/amusewiki-generate-meta-config (16)
M script/amusewiki-set-site-variable (2)

-- Patch Links --

https://github.com/melmothx/amusewiki/pull/431.patch https://github.com/melmothx/amusewiki/pull/431.diff

-- Marco

melmothx commented 1 year ago

Thanks @guest20 for another great contribution!