summaryrefslogtreecommitdiffstats
path: root/meta/recipes-devtools/rust
diff options
context:
space:
mode:
authorRandy MacLeod <randy.macleod@windriver.com>2021-02-24 20:48:20 -0500
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-08-26 22:09:43 +0100
commit3550bfe387d92ccd4ec16ab407bcf8f7cd849663 (patch)
treea541080401030debd4becc691742f95e13bf37b9 /meta/recipes-devtools/rust
parente9263ee7640e2a418ea67a4555f05a445c10d44f (diff)
downloadpoky-3550bfe387d92ccd4ec16ab407bcf8f7cd849663.tar.gz
rust: update the README to conform to being in oe-core
Provide the full link to the meta-rust issue since the README is no longer part of meta-rust. (From OE-Core rev: 11cb8e67f356d4758c3aae0e5851a44256459e77) Signed-off-by: Randy MacLeod <Randy.MacLeod@windriver.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'meta/recipes-devtools/rust')
-rw-r--r--meta/recipes-devtools/rust/README-rust.md25
1 files changed, 7 insertions, 18 deletions
diff --git a/meta/recipes-devtools/rust/README-rust.md b/meta/recipes-devtools/rust/README-rust.md
index 329d59ab7b..b87637c3b0 100644
--- a/meta/recipes-devtools/rust/README-rust.md
+++ b/meta/recipes-devtools/rust/README-rust.md
@@ -1,7 +1,7 @@
1## Introduction 1## Introduction
2 2
3This OpenEmbedded layer provides the rust compiler, tools for building packages 3This provides the Rust compiler, tools for building packages (cargo), and
4(cargo), and a few example projects. 4a few example projects.
5 5
6## What works: 6## What works:
7 7
@@ -12,8 +12,8 @@ This OpenEmbedded layer provides the rust compiler, tools for building packages
12 12
13## What doesn't: 13## What doesn't:
14 14
15 - Using anything but x86_64 as the build environment 15 - Using anything but x86_64 or arm64 as the build environment
16 - rust (built for target) issue #81 16 - rust (built for target) [issue #81](https://github.com/meta-rust/meta-rust/issues/81)
17 17
18## What's untested: 18## What's untested:
19 19
@@ -24,13 +24,14 @@ This OpenEmbedded layer provides the rust compiler, tools for building packages
24When building a rust package in bitbake, it's usually easiest to build with 24When building a rust package in bitbake, it's usually easiest to build with
25cargo using cargo.bbclass. If the package already has a Cargo.toml file (most 25cargo using cargo.bbclass. If the package already has a Cargo.toml file (most
26rust packages do), then it's especially easy. Otherwise you should probably 26rust packages do), then it's especially easy. Otherwise you should probably
27get the code building in cargo first. 27get the code building in cargo first.
28 28
29Once your package builds in cargo, you can use 29Once your package builds in cargo, you can use
30[cargo-bitbake](https://github.com/cardoe/cargo-bitbake) to generate a bitbake 30[cargo-bitbake](https://github.com/cardoe/cargo-bitbake) to generate a bitbake
31recipe for it. This allows bitbake to fetch all the necessary dependent 31recipe for it. This allows bitbake to fetch all the necessary dependent
32crates, as well as a pegged version of the crates.io index, to ensure maximum 32crates, as well as a pegged version of the crates.io index, to ensure maximum
33reproducibility. 33reproducibility. Once the Rust SDK support is added to oe-core, cargo-bitbake
34may also be added to the SDK.
34 35
35NOTE: You will have to edit the generated recipe based on the comments 36NOTE: You will have to edit the generated recipe based on the comments
36contained within it 37contained within it
@@ -51,18 +52,6 @@ On the target:
51 - Any `-sys` packages your project might need must have RDEPENDs for 52 - Any `-sys` packages your project might need must have RDEPENDs for
52 the native library. 53 the native library.
53 54
54## Maintainer(s) & Patch policy
55
56Open a Pull Request.
57
58The master branch supports the latest master of poky. When poky creates releases, we will create a branch with the same name as the poky release. This release branch should always work with that poky release. Note that these release branches will typically be less tested than the master branch.
59
60All new patches against rust, rust-llvm, and cargo must have referenced
61upstream issues or PRs opened or an explanation why the patch cannot be
62upstreamed. This cooresponds to the OpenEmbedded policy for other meta layers.
63
64More info can be seen on the wiki.
65
66## Copyright 55## Copyright
67 56
68MIT OR Apache-2.0 - Same as rust 57MIT OR Apache-2.0 - Same as rust