diff --git a/meta/recipes-devtools/rust/README-rust.md b/meta/recipes-devtools/rust/README-rust.md index 209836ab65..a7e19c506e 100644 --- a/meta/recipes-devtools/rust/README-rust.md +++ b/meta/recipes-devtools/rust/README-rust.md @@ -1,14 +1,14 @@ -## Introduction +# Introduction -This provides the Rust compiler, tools for building packages (cargo), and +This provides the Rust compiler, tools for building packages (cargo), and a few example projects. ## Building a rust package When building a rust package in bitbake, it's usually easiest to build with cargo using cargo.bbclass. If the package already has a Cargo.toml file (most -rust packages do), then it's especially easy. Otherwise you should probably -get the code building in cargo first. +rust packages do), then it's especially easy. Otherwise you should probably +get the code building in cargo first. Once your package builds in cargo, you can use [cargo-bitbake](https://github.com/cardoe/cargo-bitbake) to generate a bitbake @@ -22,17 +22,19 @@ contained within it ## Pitfalls - - 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. +`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 +[Add the ability to provide build flags for the build-script-build #3349](https://github.com/rust-lang/cargo/issues/3349) ## Dependencies On the host: - - Any `-sys` packages your project might need must have RDEPENDs for - the native library. + +* Any `-sys` packages your project might need must have RDEPENDs for + the native library. On the target: - - Any `-sys` packages your project might need must have RDEPENDs for - the native library. +* Any `-sys` packages your project might need must have RDEPENDs for + the native library.