Skip to content

Commit

Permalink
README.md: add Packaging and distribution section
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
epilys committed Dec 7, 2024
1 parent 90d13c6 commit a8c7261
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,3 +114,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.

0 comments on commit a8c7261

Please sign in to comment.