Updates to the getting started sections of the openvmm developer guide #216
Conversation
This file contains 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
* Move the Linux compiler / linker prereqs to the Linux / WSL2 setup page. These are necessary before the xflowey restore. * Use the fancy new admonish plugin for the cross compile tip.
smalis-msft
approved these changes
Oct 30, 2024
daprilik
reviewed
Oct 31, 2024
| @@ -43,6 +43,23 @@ over to it. | |||
|
|
|||
| Please follow the [official instructions](https://www.rust-lang.org/tools/install) to do so. | |||
|
|
|||
| ## \[Linux] Additional Dependencies | |||
There was a problem hiding this comment.
there was intentionality behind having this section live in build_openvmm rather than in getting_started/linux.
Namely: these deps are only needed when building openvmm, but not openhcl. build-igvm will make sure all necessary apt commands are invoked as part of the build... but since there is no equivalent tool for openvmm, this manual invocation is required. (tihs is what the restore-packages comment alluded to).
I might look into reverting this move in a future PR, and rewriting some of the comments to better communicate intent behind this organization
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is a collection of several small changes to the OpenVMM developer guide. I am setting up a new clone of this environment and following the instructions in linear order. What prompted me to first make this change is that I encountered an error running
cargo xflowey restore-packages: it seemed to need a linker. I found going "out of order" a bit jarring. Since the same core dependencies are required to build OpenVMM and OpenHCL (I think), and we expect contributors to set up their environment first, I moved this up. And, I noticed a broken link.