diff options
| author | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-08-05 14:16:48 +0100 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-08-08 15:44:20 +0100 |
| commit | a514d1cb530f28d911725f6d3d17904aeed60549 (patch) | |
| tree | 2c25330b844258b92139af0d2b96148a90239d73 | |
| parent | 1e8f4ee56ad1c75ec9d52c4f8458de137b70d9c1 (diff) | |
| download | poky-a514d1cb530f28d911725f6d3d17904aeed60549.tar.gz | |
rust: Update README
Update the README to match the current status and remove unclear/obsolete
information and fix formatting.
(From OE-Core rev: fa5d16692dda655a54653df7b4bf98410090ec5c)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
| -rw-r--r-- | meta/recipes-devtools/rust/README-rust.md | 26 |
1 files changed, 3 insertions, 23 deletions
diff --git a/meta/recipes-devtools/rust/README-rust.md b/meta/recipes-devtools/rust/README-rust.md index b87637c3b0..209836ab65 100644 --- a/meta/recipes-devtools/rust/README-rust.md +++ b/meta/recipes-devtools/rust/README-rust.md | |||
| @@ -3,22 +3,6 @@ | |||
| 3 | This provides the Rust compiler, tools for building packages (cargo), and | 3 | This provides the Rust compiler, tools for building packages (cargo), and |
| 4 | a few example projects. | 4 | a few example projects. |
| 5 | 5 | ||
| 6 | ## What works: | ||
| 7 | |||
| 8 | - Building `rust-native` and `cargo-native` | ||
| 9 | - Building Rust based projects with Cargo for the TARGET | ||
| 10 | - e.g. `rustfmt` which is used by the CI system | ||
| 11 | - `-buildsdk` and `-crosssdk` packages | ||
| 12 | |||
| 13 | ## What doesn't: | ||
| 14 | |||
| 15 | - Using anything but x86_64 or arm64 as the build environment | ||
| 16 | - rust (built for target) [issue #81](https://github.com/meta-rust/meta-rust/issues/81) | ||
| 17 | |||
| 18 | ## What's untested: | ||
| 19 | |||
| 20 | - cargo (built for target) | ||
| 21 | |||
| 22 | ## Building a rust package | 6 | ## Building a rust package |
| 23 | 7 | ||
| 24 | When building a rust package in bitbake, it's usually easiest to build with | 8 | When building a rust package in bitbake, it's usually easiest to build with |
| @@ -36,11 +20,11 @@ may also be added to the SDK. | |||
| 36 | NOTE: You will have to edit the generated recipe based on the comments | 20 | NOTE: You will have to edit the generated recipe based on the comments |
| 37 | contained within it | 21 | contained within it |
| 38 | 22 | ||
| 39 | ## TODO | ||
| 40 | |||
| 41 | ## Pitfalls | 23 | ## Pitfalls |
| 42 | 24 | ||
| 43 | - TARGET_SYS _must_ be different from BUILD_SYS. This is due to the way Rust configuration options are tracked for different targets. This is the reason we use the Yocto triples instead of the native Rust triples. See rust-lang/cargo#3349. | 25 | - TARGET_SYS _must_ be different from BUILD_SYS. This is due to the way Rust |
| 26 | configuration options are tracked for different targets. This is the reason | ||
| 27 | we use the Yocto triples instead of the native Rust triples. See rust-lang/cargo#3349. | ||
| 44 | 28 | ||
| 45 | ## Dependencies | 29 | ## Dependencies |
| 46 | 30 | ||
| @@ -52,7 +36,3 @@ On the target: | |||
| 52 | - Any `-sys` packages your project might need must have RDEPENDs for | 36 | - Any `-sys` packages your project might need must have RDEPENDs for |
| 53 | the native library. | 37 | the native library. |
| 54 | 38 | ||
| 55 | ## Copyright | ||
| 56 | |||
| 57 | MIT OR Apache-2.0 - Same as rust | ||
| 58 | |||