Add a man page about git-cliff HOT 6 CLOSED

One potential alternative would be to port from structopt to Clap — which can work very nearly the same but is also a bit more flexible. There are already ways to convert the --help output it generates to man pages, but there is also progress on it's internal manpage generation: clap-rs/clap#552

from git-cliff.

There is clap_mangen now. 🎉

from git-cliff.

Updates on my comment above:

• Clap v3 is out. It now directly consumes StructOpt structs, so porting should be easy.
• Man page generation isn't there yet, but there is WIP.

from git-cliff.

I added a man page generation script in 03d55c8. Man page can be generated and viewed like this:

OUT_DIR=$(pwd) cargo run --bin git-cliff-mangen
man ./git-cliff.1

from git-cliff.

I think this should probably go in build.rs, possibly behind an on-by-default feature flag so people that don't want to compile the dependency crates don't have to. The matching man page can then be considered a standard artifact of the build process.

... of course if you follow my logic too far you have to wrap Rust projects in a proper build system like autoconf so everything gets installed to the right places depending on the system without putting the burden on distro packages to reinvent the wheel to spin up everything by hand in each upstream project.

from git-cliff.

I think this should probably go in build.rs, possibly behind an on-by-default feature flag so people that don't want to compile the dependency crates don't have to. The matching man page can then be considered a standard artifact of the build process.

I think I'm going to leave it as is for now. Completions are also generated with the same approach.

from git-cliff.