Tidy docs for Device API #4361
Draft
Tidy docs for Device API #4361
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
sftim
force-pushed
the
20240112_docs_tidy_device_api
branch
from
59077a3
to
5376f38
Compare
Signed-off-by: Tim Bannister <tim@scalefactory.com>
sftim
force-pushed
the
20240112_docs_tidy_device_api
branch
from
5376f38
to
5d099cf
Compare
ShadowCurse
reviewed
Jan 15, 2024
There was a problem hiding this comment.
Hi @sftim, thx for the PR. Unfortunately changes here seem not very accurate/correct.
Can you describe why did you think they were necessary?
Comment on lines
+3
to
+4
| Firecracker provides the _Device_ API to let you manage the virtual hardware | ||
| available inside each microVM. |
There was a problem hiding this comment.
There is no Device API. The Device-API means Device <-> API matrix.
There was a problem hiding this comment.
OK. Good to know. The existing doc is confusing.
| required for an API call to be usable. | ||
|
|
||
| **O** - Optional: The device (column) **is not required** for a Firecracker | ||
| microVM API call to succeed. If the device (column) is omitted from a uVM | ||
| microVM API call to succeed. If the device (column) is omitted from a μVM |
There was a problem hiding this comment.
We prefer to use either microvm or uVM to describe VM. Adding third type of wording will only increase the confusion.
There was a problem hiding this comment.
Let's use microVM. The docs don't use “uVM” outside this page.
(μ is an abbreviation for micro, which is why I suggested it).
|
I haven't found time yet to redo this. |
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.
Changes
Tidying for https://github.com/firecracker-microvm/firecracker/blob/main/docs/device-api.md
Reason
Minor cleanups for readability and context.
License Acceptance
By submitting this pull request, I confirm that my contribution is made under
the terms of the Apache 2.0 license. For more information on following
Developer Certificate of Origin and signing off your commits, please check
CONTRIBUTING.md.PR Checklist
CHANGELOG.md. not applicableTODOs link to an issue. not applicablerust-vmm.