Automatic manapge generation with vg help --man - #5018
Open
faithokamoto wants to merge 5 commits into
Open
Conversation
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
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.
Changelog Entry
To be copied to the draft changelog by merger:
vg help --manwill output a fully formed Markdown manpagevg help subcommandwill output the same thing as runningvg subcommand, i.e. the default helptextDescription
BEHOLD MY WORKS. Ahem. Extension of #4979 but now the Better (TM) manpage is generated by
vg help --maninstead of a separate script. I've diffed it against the current manpage and what changed were:vg giraffe's dropped the "short" from before "read alignment")Because
vg helpnow needs to be able to print helptexts for other commands, I haveSubcommands save a helptext function. Some subcommands' helptext functions require extra arguments. I worked around this by defining extra standard-argument functions, e.g. seehelp_augment_default().The main thing I'm worried about here is
vg giraffe. I did some terrible no good very bad hacks to make its default helptext function work because the previous one really wanted to be passed a list of presets. If you have a better way to do that I'm all ears.