Integrates clap_mangen to tremor-cli

[AllMight2099]

Integrates clap_mangen into tremor-cli and exports man pages to 'target/man-page/' directory

Pull request

Description

As discussed earlier with @mfelsche, this PR adds man page generation to tremor-cli by using the clap-mangen crate and exports the man page to the man-page directory under target. This PR adds a build.rs to the tremor-cli project and allows the pages to be generated when building the project

Related

• Related Issues: fixes Generate manpages from tremor-cli clap definition #1469
• Related repository clap-mangen example

Checklist

• The RFC, if required, has been submitted and approved
• Any user-facing impact of the changes is reflected in docs.tremor.rs
• The code is tested
• Use of unsafe code is reasoned about in a comment
• Update CHANGELOG.md appropriately, recording any changes, bug fixes, or other observable changes in behavior
• The performance impact of the change is measured (see below)

Performance

r? @mfelsche

[Licenser]

Do we really want to copy in the entire source here?

[mfelsche]

What else would you do? We can't use our code from the src dir, but we got to have the definition at hand somehow. I don't see another way and I don't dislike this one.

[AllMight2099]

Yeah, I couldn't find another way of importing the Cli object because we need it to generate the man-page, so I did it this way

[AllMight2099]

But is there another way of doing it?

[Licenser]

I did run this and take a look, it seems that the manfile is still missing quite a lot of content and not details the sub commands, perhaps they have to be generated additionally?

[mfelsche]

Worst case, we need to create one manpage per subcommand or adapt clap_mangen upstream to handle subcommands better. But on the other hand, i do recall that e.g. git has 1 manpage for the global git command, and 1 for each subcommand (e.g. man 1 git-branch ). My first guess is that the structure of a man page is not optimized for commands with many subcommands. I would like to follow the model of git here. Thoughts?

[AllMight2099]

Just looked at the way git has man pages and it does make a lot more sense. I initially thought having one page per subcommand was a bit too much. Perhaps if we could reference them in the tremor-cli manpage and then add more details to it's page, it would help users understand the subcommands better.

[AllMight2099]

On second thought, I see that the subcommands don't have that much information which would necessitate their own man page. Does it make sense to just keep them in one man page into sections?

[coveralls]

Pull Request Test Coverage Report for Build 1900886967

• 0 of 0 changed or added relevant lines in 0 files are covered.
• 1 unchanged line in 1 file lost coverage.
• Overall coverage increased (+0.01%) to 87.371%

---

Files with Coverage Reduction	New Missed Lines	%
tremor-script/src/ast/walkers.rs	1	75.35%

Totals
Change from base Build 1894057413:	0.01%
Covered Lines:	18735
Relevant Lines:	21443

---

💛 - Coveralls

[AllMight2099]

@Licenser @mfelsche I won't be available for 2 days cause I have my exams. I'll push in my updates and the final code after 2 days

[Licenser]

Thanks for the heads up! We appriciate it, and no worries Univerity, Family, life should always come first :)

[darach]

👋 @AllMight2099 Howdy, wondering if the final updates are ready to push/review? Looking forward to see what you've done with the final tweaks! 👍

[Licenser]

Closing this because of inactivity.