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.

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

devenv: generate and ship manpages #1319

Merged
merged 1 commit into from
Jul 5, 2024
Merged

devenv: generate and ship manpages #1319

merged 1 commit into from
Jul 5, 2024

Conversation

sandydoo
Copy link
Member

@sandydoo sandydoo commented Jul 4, 2024

Usage:

cargo xtask generate-manpages --out-dir OPTIONAL_PATH

@sandydoo sandydoo added documentation Improvements or additions to documentation cli Related to the devenv CLI labels Jul 4, 2024
Copy link

cloudflare-pages bot commented Jul 4, 2024

Deploying devenv with  Cloudflare Pages  Cloudflare Pages

Latest commit: f263bde
Status: ✅  Deploy successful!
Preview URL: https://f9bd9ca4.devenv.pages.dev
Branch Preview URL: https://generate-manpages.devenv.pages.dev

View logs

@sandydoo sandydoo marked this pull request as ready for review July 5, 2024 11:26
@sandydoo sandydoo requested a review from domenkozar July 5, 2024 11:26
@@ -3,6 +3,7 @@ resolver = "2"
members = [
"devenv",
"devenv-run-tests",
"xtask",
Copy link
Member

Choose a reason for hiding this comment

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

Why not devenv-generate-manpages?

Copy link
Member Author

Choose a reason for hiding this comment

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

Sort of a convention https://github.com/matklad/cargo-xtask?tab=readme-ov-file. You could add other tasks to this crate to avoid slowing down builds of the main package.

Copy link
Member Author

Choose a reason for hiding this comment

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

Cargo has separate crates for each task and then sets aliases for them in .cargo/config.toml. Others use a single crate with subcommands. Same thing.

@domenkozar
Copy link
Member

We should also make a PR to nixpkgs to generate manpages as part of the next release

@domenkozar domenkozar merged commit 7b3ed61 into main Jul 5, 2024
268 of 276 checks passed
@domenkozar domenkozar mentioned this pull request Jul 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli Related to the devenv CLI documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants