Split combined manpage into individual ones for each command#15509
Merged
straight-shoota merged 2 commits intocrystal-lang:masterfrom Feb 26, 2025
Merged
Split combined manpage into individual ones for each command#15509straight-shoota merged 2 commits intocrystal-lang:masterfrom
straight-shoota merged 2 commits intocrystal-lang:masterfrom
Conversation
ysbaddaden
approved these changes
Feb 23, 2025
ysbaddaden
approved these changes
Feb 25, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This patch extracts the documentation for each crystal subcommand into its own manpage. This is just shifting content around, without chaning contents. I'm only adding/adjusting the header information for each command structured into name, synopsis, description and options sections.
Some commands are missing documentation entirely, they're not getting their own manpage right now.
The page
crystal(1)still contains some content that'll need to be moved to other places. That'll be addressed in follow-ups.If you want to review the generated manpages, you'll need asciidoctor installed. Then you can run
make man/to build andman man/*to open all pages.