Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve handling/wording of package-with-huge-docs on javadocs #555

Open
jengelh opened this issue Nov 11, 2020 · 1 comment
Open

Improve handling/wording of package-with-huge-docs on javadocs #555

jengelh opened this issue Nov 11, 2020 · 1 comment

Comments

@jengelh
Copy link
Contributor

jengelh commented Nov 11, 2020

[   40s] xz-java-javadoc.noarch: W: package-with-huge-docs: 100%

The 100% documentation ratio is sort of expected with such a package. Options I see:

  • Add an explanatory line to rpmlint pointing to the policy, e.g. Documentation should be in a package ending in "-doc"
  • Whitelist -javadoc as a suffix in rpmlint

(I am kind of in favor of the first, because javadoc is redundant when there is already a -java substring.)

@Conan-Kudo
Copy link
Member

We should probably do the latter regardless, as -doc and -javadoc can be two different types.

@scarabeusiv scarabeusiv added this to the 2.1 milestone Nov 11, 2020
@marxin marxin removed this from the 2.1 milestone May 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants