From e4f9be70f93cc74b3a7fdbd8817f2e3023199841 Mon Sep 17 00:00:00 2001 From: Manos Pitsidianakis Date: Sat, 7 Dec 2024 11:38:54 +0200 Subject: [PATCH] README.md: add Packaging and distribution section 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 --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 34a896562..ad75b2cd9 100644 --- a/README.md +++ b/README.md @@ -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.