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.

Sign up for GitHub

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

Jump to bottom

Show the man pages in the docs #315

Merged
merged 1 commit into from
May 25, 2023
Merged

Show the man pages in the docs #315

merged 1 commit into from
May 25, 2023

Conversation

pypingou
Copy link
Member

No description provided.

mwperina
mwperina reviewed May 25, 2023
View reviewed changes
Copy link
Member

@mwperina mwperina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't the existing markdown files just be linked? If not wouldn't it be nicer to generate HTML files directly (similar what we do with man format) from markdown sources during the build?

doc/docs/man/meson.build Outdated Show resolved Hide resolved
engelmi
engelmi reviewed May 25, 2023
View reviewed changes
Copy link
Member

@engelmi engelmi left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Could you also
- update the path https://github.com/containers/hirte/blob/main/.markdownlint-cli2.yaml#L10 (this fixes also the linter errors)
- update the path https://github.com/containers/hirte/blob/main/meson.build#L67
- remove the directory https://github.com/containers/hirte/tree/main/doc/man

@pypingou pypingou force-pushed the man_pages_doc branch 3 times, most recently from d66508b to 78203c0 Compare May 25, 2023 10:22
@pypingou
Show the man pages in the docs
6920b28 
Signed-off-by: Pierre-Yves Chibon <pingou@pingoured.fr>
@pypingou
Copy link
Member Author

Can't the existing markdown files just be linked?

You mean link with symlink or so? We could but with the approach taken here, we exclude the first two lines from the man pages (ie: the %hirte 1 that shows in https://github.com/containers/hirte/blob/main/doc/man/hirte.1.md). Something we would not be able to do with simple symlink

@engelmi
Copy link
Member

engelmi commented May 25, 2023

Can't the existing markdown files just be linked?

You mean link with symlink or so? We could but with the approach taken here, we exclude the first two lines from the man pages (ie: the %hirte 1 that shows in https://github.com/containers/hirte/blob/main/doc/man/hirte.1.md). Something we would not be able to do with simple symlink

Wait... my mistake. I thought the actual man pages were copied 😓 Please ignore my previous comments.

engelmi
engelmi approved these changes May 25, 2023
View reviewed changes
Copy link
Member

@engelmi engelmi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

mwperina
mwperina approved these changes May 25, 2023
View reviewed changes
Copy link
Member

@mwperina mwperina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@engelmi engelmi merged commit 37fb6ad into eclipse-bluechi:main May 25, 2023
@pypingou pypingou deleted the man_pages_doc branch May 25, 2023 13:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@engelmi engelmi engelmi approved these changes

@mwperina mwperina mwperina approved these changes

@alexlarsson alexlarsson Awaiting requested review from alexlarsson alexlarsson is a code owner

@mkemel mkemel Awaiting requested review from mkemel mkemel is a code owner

@rhatdan rhatdan Awaiting requested review from rhatdan rhatdan is a code owner

@sdunnagan sdunnagan Awaiting requested review from sdunnagan

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@pypingou @engelmi @mwperina