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

create vm-vcpu-ref crate #182

Merged
merged 3 commits into from
Nov 2, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ vmm = { path = "src/vmm" }
api = { path = "src/api" }

[workspace]
members = ["src/vm-vcpu-ref"]

[profile.dev]
panic = "abort"
Expand Down
2 changes: 1 addition & 1 deletion coverage_config_x86_64.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"coverage_score": 70.4,
"coverage_score": 70.3,
"exclude_path": "msr_index.rs,mpspec.rs,tests/,src/devices/src/virtio/net/bindings.rs",
"crate_features": ""
}
2 changes: 1 addition & 1 deletion rust-vmm-ci
11 changes: 11 additions & 0 deletions src/vm-vcpu-ref/.buildkite/custom-tests.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"tests": [
{
"test_name": "vm-vcpu_coverage",
"command": "cd src/vm-vcpu-ref/ && pytest rust-vmm-ci/integration_tests/test_coverage.py --test-scope crate",
"platform": [
"x86_64"
]
}
]
}
12 changes: 12 additions & 0 deletions src/vm-vcpu-ref/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
[package]
name = "vm-vcpu-ref"
version = "0.1.0"
authors = ["rust-vmm AWS maintainers <[email protected]>"]
edition = "2018"
description = "Wrappers for setting up a VM for booting"
repository = "https://github.com/rust-vmm/vmm-reference"
readme = "README.md"
license = "Apache-2.0 OR BSD-3-Clause"
keywords = ["virt", "kvm", "vm"]

[dependencies]
41 changes: 41 additions & 0 deletions src/vm-vcpu-ref/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Crate Name

## Design

TODO: This section should have a high-level design of the crate.

Some questions that might help in writing this section:
- What is the purpose of this crate?
- What are the main components of the crate? How do they interact which each
other?

## Usage

TODO: This section describes how the crate is used.

Some questions that might help in writing this section:
- What traits do users need to implement?
- Does the crate have any default/optional features? What is each feature
doing?
- Is this crate used by other rust-vmm components? If yes, how?

## Examples

TODO: Usage examples.

```rust
use my_crate;

...
```

## License

**!!!NOTICE**: The BSD-3-Clause license is not included in this template.
The license needs to be manually added because the text of the license file
also includes the copyright. The copyright can be different for different
crates. If the crate contains code from CrosVM, the crate must add the
CrosVM copyright which can be found
[here](https://chromium.googlesource.com/chromiumos/platform/crosvm/+/master/LICENSE).
For crates developed from scratch, the copyright is different and depends on
the contributors.
5 changes: 5 additions & 0 deletions src/vm-vcpu-ref/coverage_config_x86_64.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"coverage_score": 33.3,
"exclude_path": "",
"crate_features": ""
}
1 change: 1 addition & 0 deletions src/vm-vcpu-ref/rust-vmm-ci
3 changes: 3 additions & 0 deletions src/vm-vcpu-ref/src/lib.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
pub fn main() {
println!("It works!");
}