Skip to content

Commit bf1ae74

Browse files
epilysvireshk
authored andcommitted
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 9f4df00 commit bf1ae74

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,3 +115,11 @@ Supporting Xen requires special handling while mapping the guest memory. The
115115

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

0 commit comments

Comments
 (0)