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

[master] rpmlint: fix "W: no-documentation" #690

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

thaJeztah
Copy link
Member

@thaJeztah thaJeztah commented May 12, 2022

These packages were causing a warning that they didn't contain documentation.
For some of these, we need to add man-pages, but at least we can add some of
the files we have. Also adding AUTHORS and SECURITY.md to existing packages:

docker-ce.x86_64: W: no-documentation
docker-ce-rootless-extras.x86_64: W: no-documentation
docker-compose-plugin.x86_64: W: no-documentation
docker-scan-plugin.x86_64: W: no-documentation
The package contains no documentation (README, doc, etc). You have to include
documentation files.

I'm using unique directory names for each package to collect the docs in, as
we build the packages in the same environment (so possibly they would trip over
each-other), but possibly this is not needed (so "just to be sure").

These packages were causing a warning that they didn't contain documentation.
For some of these, we need to add man-pages, but at least we can add some of
the files we have. Also adding `AUTHORS` and `SECURITY.md` to existing packages:

    docker-ce.x86_64: W: no-documentation
    docker-ce-rootless-extras.x86_64: W: no-documentation
    docker-compose-plugin.x86_64: W: no-documentation
    docker-scan-plugin.x86_64: W: no-documentation
    The package contains no documentation (README, doc, etc). You have to include
    documentation files.

I'm using unique directory names for each package to collect the docs in, as
we build the packages in the same environment (so possibly they would trip over
each-other), but possibly this is not needed (so "just to be sure").

Signed-off-by: Sebastiaan van Stijn <[email protected]>
@thaJeztah
Copy link
Member Author

Looks like this wasn't finished yet (found it locally) 😂

+ for f in AUTHORS LICENSE MAINTAINERS NOTICE README.md
+ install -D -p -m 0644 engine/AUTHORS build-docs/AUTHORS
install: cannot stat 'engine/AUTHORS': No such file or directory
error: Bad exit status from /var/tmp/rpm-tmp.SnUM42 (%install)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant