Skip to content
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

doc: clarify cross-kernel snapshot compatibility #5022

Merged
merged 2 commits into from
Feb 6, 2025

Conversation

roypat
Copy link
Contributor

@roypat roypat commented Jan 31, 2025

Update the explanation text to refer to the "working?" column instead of some mystical "all", which doesnt exist. Also expand a bit on the explanation to make it clearer what works and what doesnt.

Closes #4912
Signed-off-by: Patrick Roy [email protected]

(Am admittedly not 100% happy with what I came up with - if someone has ideas how to make the "same hardware" thingy clearer, please let me know!)

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

  • I have read and understand CONTRIBUTING.md.
  • I have run tools/devtool checkstyle to verify that the PR passes the
    automated style checks.
  • I have described what is done in these changes, why they are needed, and
    how they are solving the problem in a clear and encompassing way.
  • I have updated any relevant documentation (both in code and in the docs)
    in the PR.
  • I have mentioned all user-facing changes in CHANGELOG.md.
  • If a specific issue led to this PR, this PR closes the issue.
  • When making API changes, I have followed the
    Runbook for Firecracker API changes.
  • I have tested all new and changed functionalities in unit tests and/or
    integration tests.
  • I have linked an issue to every new TODO.

  • This functionality cannot be added in rust-vmm.

@roypat roypat added the Status: Awaiting review Indicates that a pull request is ready to be reviewed label Jan 31, 2025
@roypat roypat force-pushed the update-snapshot-docs branch 2 times, most recently from 8aef374 to a9eefde Compare February 6, 2025 10:15
Manciukic
Manciukic previously approved these changes Feb 6, 2025
Simplify by just making the statement that we do not recommend it, and
it generally doesnt work except for one limited case. Simplify the table
by only listing what's working, an by having the first column directly
refer to instance types (instead of cpu architectures, which we later
map to instance types in the text).

While we're at it, also update the table of contents at the top to
include two sections it was missing.

Closes firecracker-microvm#4912
Signed-off-by: Patrick Roy <[email protected]>
@roypat roypat force-pushed the update-snapshot-docs branch from aeb5f49 to c1a7f2c Compare February 6, 2025 10:18
Copy link
Contributor

@xmarcalx xmarcalx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for the changes :)

@roypat roypat merged commit 567b1ea into firecracker-microvm:main Feb 6, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Awaiting review Indicates that a pull request is ready to be reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants