kata-containers/cloud-hypervisor
1
0
Fork 0
mirror of https://github.com/cloud-hypervisor/cloud-hypervisor.git synced 2026-08-05 02:19:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Document supported targets

Browse Source 
Move supported architecture and backend guidance from AGENTS.md into
README.md and CONTRIBUTING.md.

On-behalf-of: SAP philipp.schuster@sap.com
Signed-off-by: Philipp Schuster <philipp.schuster@cyberus-technology.de>
This commit is contained in:
Philipp Schuster
2026-05-13 21:47:57 +02:00
committed by Rob Bradford
parent 8ff6114c46
commit a07097af1f
3 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
AGENTS.md
View File

@@ -11,9 +11,6 @@ reviewable, and compatible with the project's normal engineering constraints.
- Start with `README.md` for the project shape and `CONTRIBUTING.md` for the - Start with `README.md` for the project shape and `CONTRIBUTING.md` for the
contribution rules, coding style, commit message guidance, and LLM assistance contribution rules, coding style, commit message guidance, and LLM assistance
disclosure policy. Following `CONTRIBUTING.md` is crucial! disclosure policy. Following `CONTRIBUTING.md` is crucial!
- The main supported architectures are `x86_64` and `aarch64`; the main
hypervisor backends are KVM and MSHV. `x86_64` with KVM gets the most regular
exercise, but changes must not make the other first-class targets worse.
### Change Guidelines ### Change Guidelines
@@ -78,4 +75,3 @@ reviewable, and compatible with the project's normal engineering constraints.
- Temporary allowances such as `#[allow(unused)]` or ignored tests are only - Temporary allowances such as `#[allow(unused)]` or ignored tests are only
acceptable if resolved within the same commit series or paired with a clear acceptable if resolved within the same commit series or paired with a clear
TODO referencing a ticket. Ask the developer if in doubt. TODO referencing a ticket. Ask the developer if in doubt.

5
CONTRIBUTING.md
View File

@@ -11,6 +11,11 @@ license of those projects.
New code should be under the [Apache v2 New code should be under the [Apache v2
License](https://opensource.org/licenses/Apache-2.0). License](https://opensource.org/licenses/Apache-2.0).
Cloud Hypervisor's main supported architectures are `x86_64` and `aarch64`,
and the main hypervisor backends are KVM and MSHV. `x86_64` with KVM gets the
most regular exercise, but changes should not make the other supported
architecture and backend combinations worse.
## Coding Style & Code Comments ## Coding Style & Code Comments
We use the [Rust Style] guide and enforce formatting and linting in CI, We use the [Rust Style] guide and enforce formatting and linting in CI,

8
README.md
View File

@@ -59,10 +59,10 @@ based on the [Rust VMM](https://github.com/rust-vmm) crates.
### Architectures ### Architectures
Cloud Hypervisor supports the `x86-64`, `AArch64` and `riscv64` Cloud Hypervisor's main supported architectures are `x86-64` and `AArch64`,
architectures, with functionality varying across these platforms. The with functionality varying across these platforms. The functionality
functionality differences between `x86-64` and `AArch64` are documented differences between `x86-64` and `AArch64` are documented in
in [#1125](https://github.com/cloud-hypervisor/cloud-hypervisor/issues/1125). [#1125](https://github.com/cloud-hypervisor/cloud-hypervisor/issues/1125).
The `riscv64` architecture support is experimental and offers limited The `riscv64` architecture support is experimental and offers limited
functionality. For more details and instructions, please refer to [riscv functionality. For more details and instructions, please refer to [riscv
documentation](docs/riscv.md). documentation](docs/riscv.md).