Skip to content

Split the man page #15440

Open
Open
@straight-shoota

Description

@straight-shoota

The crystal(1) man page combines documentation for all compiler commands. At one hand it's nice to have everything consolidated in one place, but there are also some practical challenges.
For example, each command has its own set of options and searching through the document for an option (or any query string) you'll often have to skip through a few matches until you land on the one you're interested in. And figuring out which section you're looking at might not even be trivial when the section header is outside the viewport.
Another issue is the sheer size of the document. We're still missing documentation for some of the lesser used subcommands and even the prominent ones are often just listing the CLI options. So it should be expected that these man pages would grow with more content.

I'd like to extract individual man pages for each subcommand.
This is a common practice with similar tools that have a number of different subcommands in one CLI interface. For example git has individual man pages git-show(1), git-commit(1) etc. (even though these commands are only accessible as subcommands to git and do not exist as standalone executables).

This would give each subcommand its own scope. The general man page crystal(1) would then server only as an entrypoint with a list of subcommands and maybe some general information.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions