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

Add doc key to btrfsmaintenance-refresh.service #92

Closed
wants to merge 1 commit into from

Conversation

sten0
Copy link
Contributor

@sten0 sten0 commented Jun 19, 2021

This enables systemctl help servicename to function correctly by
displaying the documentation associated with the service.

Closes #83

Sorry for the delay, I had thought I had already created the PR. Please let me know if SUSE systems don't compress READMEs and I'd be happy to s/README.md.gz/README.md/.

This enables `systemctl help servicename` to function correctly by
displaying the documentation associated with the service.

Closes kdave#83
@kdave kdave added this to the v0.5.1 milestone Jul 21, 2021
@kdave
Copy link
Owner

kdave commented Jul 21, 2021

The README.md file is not compressed and is also installed to a different path /usr/share/doc/packages/btrfsmaintenance/README.md, can this be made more generic like referencing some variable? I think the packaging will vary among distros so this won't work everywhere.

kdave pushed a commit that referenced this pull request Jul 21, 2021
This enables `systemctl help servicename` to function correctly by
displaying the documentation associated with the service.

The path may be different due to packaging guidelines, the Documentation
key can be specified multiple times.

Issue: #83
Pull-request: #92
Author: Nicholas D Steeves <nsteeves@gmail.com>
Signed-off-by: David Sterba <dsterba@suse.com>
@kdave
Copy link
Owner

kdave commented Jul 21, 2021

The documentation key can be specified multiple times so this should fix it, though I don't know if a missing file works. I've pushed it to a new devel branch in case it needs to be revised/reverted.

@kdave
Copy link
Owner

kdave commented Nov 29, 2021

Any file that's not readable is only reported and skipped, so it should work on all distros. Closing.

@kdave kdave closed this Nov 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[wishlist] Please add documentation key to btrfsmaintenance-refresh.service
2 participants