-
Notifications
You must be signed in to change notification settings - Fork 1.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Tidy docs for Device API #4361
base: main
Are you sure you want to change the base?
Tidy docs for Device API #4361
Conversation
59077a3
to
5376f38
Compare
Signed-off-by: Tim Bannister <tim@scalefactory.com>
5376f38
to
5d099cf
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @sftim, thx for the PR. Unfortunately changes here seem not very accurate/correct.
Can you describe why did you think they were necessary?
Firecracker provides the _Device_ API to let you manage the virtual hardware | ||
available inside each microVM. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is no Device
API. The Device-API means Device <-> API matrix.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
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 applicableTODO
s link to an issue. not applicablerust-vmm
.