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

More docs at your finger tips #2990

Merged
merged 3 commits into from
Sep 5, 2024
Merged

Conversation

behrmann
Copy link
Contributor

This adds the feature to pass an argument to the documentation command, so that the man page we've grown in addition can be viewed easily as well.

@keszybz
Copy link
Member

keszybz commented Aug 31, 2024

Looks reasonable…

@DaanDeMeyer
Copy link
Contributor

We discussed this in chat but I'd prefer mkosi-initrd learns a --documentation switch to show its documentation.

Doing the same for mkosi-sandbox is harder without introducing dependencies on the rest of mkosi but it could be done if show_docs() is made independent of the rest of mkosi and is implemented using only stdlib stuff.

@behrmann
Copy link
Contributor Author

I'll rework it next week. I think it's fine to do this both for mkosi-initrd and mkosi-sandbox by lazily using the show_docs stuff, which in the case of mkosi-sandbox will just not work within the sandbox, but I think that's fine, people will usually have another terminal open.

DaanDeMeyer added a commit that referenced this pull request Sep 5, 2024
Also let's leave out errors if things don't work, but we're still trying. This
way the last message "No manual entry for foo" will bubble up.
mkosi/documentation.py Fixed Show fixed Hide fixed
mkosi/sandbox.py Fixed Show fixed Hide fixed
mkosi/sandbox.py Fixed Show fixed Hide fixed
@behrmann behrmann force-pushed the allthemanuals branch 3 times, most recently from b359527 to 266f4c9 Compare September 5, 2024 15:44
mkosi/initrd.py Outdated Show resolved Hide resolved
mkosi/config.py Outdated Show resolved Hide resolved
@DaanDeMeyer DaanDeMeyer merged commit 671708a into systemd:main Sep 5, 2024
31 of 36 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants