From 9f4df007dbb297ebd4dc29b48bc7807e0ae3f238 Mon Sep 17 00:00:00 2001 From: Manos Pitsidianakis Date: Sat, 7 Dec 2024 11:38:26 +0200 Subject: [PATCH] xtask: add README.md Add documentation in a README.md file. Signed-off-by: Manos Pitsidianakis --- xtask/README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 xtask/README.md diff --git a/xtask/README.md b/xtask/README.md new file mode 100644 index 0000000..c54d67f --- /dev/null +++ b/xtask/README.md @@ -0,0 +1,22 @@ +# `xtask` - Run tasks with `cargo` + +This binary crate provides support for running useful tasks with `cargo xtask <..>`. + +## `mangen` + +The `mangen` task which is enabled by the `mangen` cargo feature, builds ROFF manual pages for binary crates in this repository. It uses the [`clap_mangen`](https://crates.io/crates/clap_mangen) crate to generate ROFF from the crate's argument types which implement the `clap::CommandFactory` trait, through the `clap::Parser` derive macro. + +```session +$ cargo xtask mangen + Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.04s + Running `target/debug/xtask mangen` +Generated the following manual pages: +/path/to/rust-vmm/vhost-device/target/dist/man/vhost-device-sound.1 +/path/to/rust-vmm/vhost-device/target/dist/man/vhost-device-scmi.1 +``` + +The following crates have manual pages built by default: + +- [`vhost-device-sound`](../vhost-device-sound), enabled by the default feature `vhost-device-sound`. + - It can further be fine-tuned with the features `vhost-device-sound-pipewire` and `vhost-device-sound-alsa`. +- [`vhost-device-scmi`](../vhost-device-scmi), enabled by the default feature `vhost-device-scmi`.