Skip to content

Generate man pages for Volta #1913

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
Open
dobleuber wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Generate man pages for Volta #1913

dobleuber wants to merge 2 commits into from

Conversation

@dobleuber
Copy link

@dobleuber dobleuber commented Oct 10, 2024

Implementation of man pages for Volta

Solution for #1709

This PR adds support for generating man pages in Volta, using the clap_mangen crate.

Key Changes

  • Added clap_mangen dependency to the project.
  • Created a new man_pages module in src/command/.
  • Implemented a new ManPages struct with Volta's Command trait.
  • Added a new ActivityKind for logging man page-related events.
  • Utilized the Man struct from clap_mangen to generate man pages from Volta's command.
  • Implemented logic to emit the generated roff content to the appropriate location based on the operating system.
  • Updated the installation script to include man page generation and placement during installation.

Special Considerations

  • Implemented support for Windows, despite the lack of a standard location for man pages on this operating system.(WIP)

@dobleuber
Generate man pages
8451af2 
Add clap_mangen dependency.
Add man_pages module.
Implement man pages generation
@dobleuber
Add man pages generation to install process
727445d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@dobleuber