Skip to content

feat: generate man pages using clap_mangen and xtask - #42

Merged
hyperfinitism merged 1 commit into
mainfrom
feature/manpage
Sep 7, 2026
Merged

feat: generate man pages using clap_mangen and xtask#42
hyperfinitism merged 1 commit into
mainfrom
feature/manpage

Conversation

@hyperfinitism

Copy link
Copy Markdown
Owner

This pull request adds functionality to generate man pages using the clap_mangen crate and the xtask idiom.

This enables man pages to be generated with the source code as the single source of truth (SSOT), thereby preventing discrepancies between the code and the documentation.

@hyperfinitism hyperfinitism self-assigned this Sep 7, 2026
@hyperfinitism hyperfinitism added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 7, 2026
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 7, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-09-07T15:02:40.901278Z e14cea8 PR opened
🔒 Security Review Completed 2026-09-07T15:02:45.958922Z e14cea8 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request restructures the project into a Cargo workspace, extracts the CLI logic into a library crate (tpm2-cli), and introduces an xtask package to generate man pages from the clap command definitions. The review feedback suggests creating temporary files inside the staging directory instead of the output directory to prevent cluttering the output directory during generation.

Comment thread xtask/src/main.rs Outdated
This commit adds functionality to generate man pages using the clap_mangen
crate and the xtask idiom.
This enables man pages to be generated with the source code as the single
source of truth (SSOT), thereby preventing discrepancies between the code
and the documentation.

Signed-off-by: Takuma IMAMURA <209989118+hyperfinitism@users.noreply.github.com>
@hyperfinitism
hyperfinitism merged commit 87174b8 into main Sep 7, 2026
43 checks passed
@hyperfinitism
hyperfinitism deleted the feature/manpage branch September 7, 2026 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant