rustowl icon indicating copy to clipboard operation
rustowl copied to clipboard
verified publisher icon cordx56

chore(man): Generate man pages for subcommands

Open sorairolake opened this issue 7 months ago • 4 comments

Related Issue(s)

Description

When cargo build is executed, generates man pages for subcommands as well.

sorairolake avatar May 26 '25 10:05 sorairolake

There will be multiple manpages, right?

MuntasirSZN avatar May 26 '25 12:05 MuntasirSZN

After looking at docs.rs, I think it outputs only one file. So the * in PKGBUILD is unnecessary.

MuntasirSZN avatar May 26 '25 12:05 MuntasirSZN

There will be multiple manpages, right?

@MuntasirSZN Yes, currently only rustowl(1) are generated. This does not include usages for subcommands. This change will also generate man pages such as rustowl-check(1) and rustowl-toolchain-install(1).

sorairolake avatar May 26 '25 13:05 sorairolake

I am really skeptical about this, running man rustowl and the user knows about everything, looks better.

MuntasirSZN avatar May 27 '25 12:05 MuntasirSZN

Agree with @MuntasirSZN . I would like to bring all of them into one man page. The current RustOwl man page is short enough to do this.

cordx56 avatar Jun 09 '25 06:06 cordx56

@cordx56 That may be possible using clap::Command::flatten_help, so I'll try this later.

sorairolake avatar Jun 09 '25 07:06 sorairolake

@cordx56 That may be possible using clap::Command::flatten_help, so I'll try this later.

I tried this but it didn't work as I expected. According to clap-rs/clap#5761, this is not yet supported.

sorairolake avatar Jun 09 '25 09:06 sorairolake