Skip to content

Commit a8c7261

Browse files
committed
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 <[email protected]>
1 parent 90d13c6 commit a8c7261

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -114,3 +114,11 @@ Supporting Xen requires special handling while mapping the guest memory. The
114114

115115
It was decided by the `rust-vmm` maintainers to keep the interface simple and
116116
build the crate for either standard Unix memory mapping or Xen, and not both.
117+
118+
## Packaging and distribution
119+
120+
The [`xtask`](./xtask/) workspace crate provides support for generating ROFF manual pages.
121+
122+
If the binary you're interested in packaging does not have a manual page
123+
generated you are encouraged to file a bug or even contribute the necessary
124+
changes by filing a pull request.

0 commit comments

Comments
 (0)