Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

WIP: Man page generation #3174

Merged
merged 11 commits into from
Jan 28, 2022
Merged

WIP: Man page generation #3174

merged 11 commits into from
Jan 28, 2022

Commits on Jan 28, 2022

  1. feat(man): Create clap_man to generate manpages

    @sondr3
    sondr3 committed Jan 28, 2022
    Configuration menu
    Copy the full SHA
    e8647d5 View commit details
    Browse the repository at this point in the history

  2. fix: Update metadata, create Secion enum

    @sondr3
    sondr3 committed Jan 28, 2022
    Configuration menu
    Copy the full SHA
    66964d1 View commit details
    Browse the repository at this point in the history

  3. feat: Show environment variable and defaults

    @sondr3
    sondr3 committed Jan 28, 2022
    Configuration menu
    Copy the full SHA
    2e1b469 View commit details
    Browse the repository at this point in the history

  4. chore: Update contributing and sponsors link

    @sondr3
    sondr3 committed Jan 28, 2022
    Configuration menu
    Copy the full SHA
    504cf84 View commit details
    Browse the repository at this point in the history

  5. fix: Wrong name for section enum

    @sondr3
    sondr3 committed Jan 28, 2022
    Configuration menu
    Copy the full SHA
    9605d5c View commit details
    Browse the repository at this point in the history

  6. refactor(man): Use roff-rs crate to render manpage

    @sondr3
    sondr3 committed Jan 28, 2022
    Configuration menu
    Copy the full SHA
    ad9db15 View commit details
    Browse the repository at this point in the history

  7. chore: Use latest RC for clap

    @sondr3
    sondr3 committed Jan 28, 2022
    Configuration menu
    Copy the full SHA
    80b3683 View commit details
    Browse the repository at this point in the history

  8. feat(man): Wrap options correctly

    @sondr3
    sondr3 committed Jan 28, 2022
    Configuration menu
    Copy the full SHA
    91714f0 View commit details
    Browse the repository at this point in the history

  9. fix: Proper subcommand values, code review changes

    @sondr3
    sondr3 committed Jan 28, 2022
    Configuration menu
    Copy the full SHA
    c257bb4 View commit details
    Browse the repository at this point in the history

  10. feat: Port to roff 0.2.1 

    Use the new roff crate, from crates.io, not a local, modified version
of it. The roff 0.2 series changes that crate's API completely: it now
only concerns itself with ROFF, not with manual pages. This requires
manual page generating code to change significantly.

Separate manual page metadata (title, section, date, etc) to its own
struct so it's better isolated from the contents of the manual page.
This makes the clap__man code clearer, and isn't needed by users of
the crate, if they use the generate_manpage function.

Drop support for additional, custom sections that don't come from
clap:App. If someone needs that, they'll almost certainly want to
have more control over how manual pages are built, including the order
of the sections.
    @liwfi @sondr3
    liwfi authored and sondr3 committed Jan 28, 2022
    Configuration menu
    Copy the full SHA
    46a4eaf View commit details
    Browse the repository at this point in the history

  11. fix(man): Feedback from code review

    @sondr3
    sondr3 committed Jan 28, 2022
    Configuration menu
    Copy the full SHA
    0b7aab5 View commit details
    Browse the repository at this point in the history