Skip to content

Add manual page. Fixes #9612 - #9774

Open
hiukkanen wants to merge 1 commit into
jruby:jruby-10.0from
hiukkanen:add-manual-page
Open

hiukkanen wants to merge 1 commit into
jruby:jruby-10.0from
hiukkanen:add-manual-page

Conversation

@hiukkanen

Copy link
Copy Markdown

One suggestion how to add kind of similar man page as cruby uses. Fixes #9612.

@headius headius left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice! Is the utility code here sourced from somewhere else? You mention this is similar to what CRuby does. I'm wondering if a common gem could be pulled out, if one hasn't been already.

I'm not sure what the dev process would be. Do we generate the man at release time (and always in CI to keep it working) or do we generate periodically and keep the most recent copy in the repository?

@hiukkanen

Copy link
Copy Markdown
Author

With "Similar to cruby" I ment that the manual page header is kind of similar now.

For me it seems that there is not too much code shared for a gem. Code that converts data to man page friendly is small and easy and same goes for the erb.

About dev process I think @jcharaoui can give feedback that if this way that man page is in release only is ok?

@jcharaoui

Copy link
Copy Markdown
Contributor

There's a lot of moving parts in there, I'm not sure it's ideal maintenance-wise? Have we considered a solution that uses something like ronn to convert a plain Markdown template to a manpage.

@hiukkanen

Copy link
Copy Markdown
Author

How would we generate Markdown template? What would render the template to final markdown (maybe you didn't mean to say template but just Markdown file)?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants