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

README.md: add Packaging and distribution section

Browse Source 
Add Packaging and distribution section that mentions the ability to
generate manual pages using the xtask crate in this workspace.

Signed-off-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
This commit is contained in:
Manos Pitsidianakis 2024-12-07 11:38:54 +02:00 committed by Viresh Kumar
parent 9f4df007db
commit bf1ae745b7
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -115,3 +115,11 @@ Supporting Xen requires special handling while mapping the guest memory. The
It was decided by the `rust-vmm` maintainers to keep the interface simple and
build the crate for either standard Unix memory mapping or Xen, and not both.
## Packaging and distribution
The [`xtask`](./xtask/) workspace crate provides support for generating ROFF manual pages.
If the binary you're interested in packaging does not have a manual page
generated you are encouraged to file a bug or even contribute the necessary
changes by filing a pull request.