rust-vmm / vfio

14 stars 20 forks source link

Move all crates to workspace root #39

Open epilys opened 11 months ago

epilys commented 11 months ago

Summary of the PR

Having all the workspace crates under the crates/ directory is unnecessary. Rust documentation itself recommends all crates to be in the root directory:

https://doc.rust-lang.org/book/ch14-03-cargo-workspaces.html#creating-the-second-package-in-the-workspace

I paste the text content here, in case the online page ever changes or becomes unavailable:

## Creating the Second Package in the Workspace

Next, let’s create another member package in the workspace and call it add_one. Change the top-level Cargo.toml to specify the add_one path in the members list:

Filename: Cargo.toml

[workspace]

members = [
    "adder",
    "add_one",
]

Then generate a new library crate named add_one:

$ cargo new add_one --lib
     Created library `add_one` package

Your add directory should now have these directories and files:

├── Cargo.lock
├── Cargo.toml
├── add_one
│   ├── Cargo.toml
│   └── src
│       └── lib.rs
├── adder
│   ├── Cargo.toml
│   └── src
│       └── main.rs
└── target

Please summarize here why the changes in this PR are needed.

Requirements

Before submitting your PR, please make sure you addressed the following requirements:

sboeuf commented 11 months ago

That sounds good to me. Getting rid of the crates indirection directory is a nice simplification.

epilys commented 11 months ago

@liuw @sameo @jiangliu ping :)

epilys commented 10 months ago

This is approved, needs someone to press the merge button.

epilys commented 9 months ago

Rebased against main