vhost: Fix building docs #304
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kleinweby
requested review from
Ablu,
eryugey,
germag,
jiangliu,
sboeuf,
slp and
stefano-garzarella
as code owners
Building docs (as on docs.rs) has been broken since 8ee8739. This commit introduces POSTCOPY and made this feature mutually exclusive with xen. As docs are build for all features the corresponding check will be triggered and the docs can not be built. This patch extends the check to allow both "postcopy" and "xen" to be enabled when building docs. Signed-off-by: Christian Speich <christian@spei.ch>
stefano-garzarella
approved these changes
Jun 25, 2025
germag
approved these changes
Jun 25, 2025
Member
|
Thanks! would be nice to add a CI step for that ;-) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Building docs (as on docs.rs) has been broken since 8ee8739. This commit introduces POSTCOPY and made this feature mutually exclusive with xen.
As docs are build for all features the corresponding check will be triggered and the docs can not be built.
This patch extends the check to allow both "postcopy" and "xen" to be enabled when building docs.
Summary of the PR
docs.rs is useful when working with any rust crate. This PR fixes building the docs.
Requirements
Before submitting your PR, please make sure you addressed the following
requirements:
git commit -s), and the commit message has max 60 characters for thesummary and max 75 characters for each description line.
test.
Release" section of CHANGELOG.md (if no such section exists, please create one).
unsafecode is properly documented.