pxcloud/vhost-device
5
0
Fork 0
mirror of https://github.com/rust-vmm/vhost-device.git synced 2025-12-26 06:32:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
bf1ae745b7
vhost-device/xtask
History
Manos Pitsidianakis 9f4df007db xtask: add README.md 
Add documentation in a README.md file.

Signed-off-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
2025-04-15 14:25:32 +05:30
..
src xtask: generate manpage for vhost-device-scmi 2025-04-15 14:25:32 +05:30
build.rs Add an xtask crate to generate manpages 2025-04-15 14:25:32 +05:30
Cargo.toml xtask: generate manpage for vhost-device-scmi 2025-04-15 14:25:32 +05:30
README.md xtask: add README.md 2025-04-15 14:25:32 +05:30

README.md

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 crate to generate ROFF from the crate's argument types which implement the clap::CommandFactory trait, through the clap::Parser derive macro.

$ 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, 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, enabled by the default feature vhost-device-scmi.