search

kdave / btrfsmaintenance

Scripts for btrfs maintenance tasks like periodic scrub, balance, trim or defrag on selected mountpoints or directories.
GNU General Public License v2.0
897 stars 79 forks source link

Add doc key to btrfsmaintenance-refresh.service #92

Closed sten0 closed 2 years ago

sten0 commented 3 years ago

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/.

kdave commented 3 years ago

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 commented 3 years ago

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 commented 2 years ago

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