zinit
zinit copied to clipboard
Copy zinit.1 to man1 directory for `man` to be able to open it
Description
Add a single conditional that checks if $ZPFX/man/man1/zinit.1
exists and copies it if not.
Motivation and Context
There is a manual page of zinit – in doc/zinit.1
. However I suppose that it's very rarely ever open, because its location under BIN_DIR
. So I thought that it should be copied to man1
dir under ZINIT[MAN_DIR]
so that simple man zinit
works fine.
Related Issue(s)
Usage examples
# After starting a new shell with the patch applied:
man zinit
How Has This Been Tested?
man zinit
Types of changes
- [x] Bug fix (non-breaking change which fixes an issue)
- [x] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
Checklist:
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have added tests to cover my changes.
- [x] All new and existing tests passed.
Can you fix the zshelldoc
check? $ make doc
should do it.
This looks good to me otherwise.
@alichtman make doc
didn't help, the generated docs still differ from container's docs.
I think that it is sufficient to copy man page to $ZPFX/man
, because man
searches in locations derived from PATH. If I remove $ZPFX/bin
from $PATH
then zinit.1
isn't found. Also man man
says that $MANPATH
shouldn't be used. Could someone update the docs correctly and merge the PR?
@psprint merge conflicts
@vladdoster: I've reset to skip the faulty zsdoc commit. There are no conflicts now.
:tada: This PR is included in version 3.8.0 :tada:
The release is available on GitHub release
Your semantic-release bot :package::rocket: