MIRRORS/poky
1
0
Fork 0
mirror of git://git.yoctoproject.org/poky.git synced 2025-07-19 12:59:02 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

rust/README-rust.md: fix markdown style issues

Browse Source 
Fix markdown style issues using markdownlint tool [1]:

$ cat ./meta/recipes-devtools/rust/README-rust.md | mdl
(stdin):1: MD002 First header should be a top level header
(stdin):25: MD006 Consider starting bulleted lists at the beginning of the line
(stdin):3: MD009 Trailing spaces
(stdin):11: MD009 Trailing spaces
(stdin):26: MD009 Trailing spaces
(stdin):39: MD012 Multiple consecutive blank lines
(stdin):32: MD032 Lists should be surrounded by blank lines
(stdin):36: MD032 Lists should be surrounded by blank lines

[1] https://github.com/markdownlint/markdownlint
(From OE-Core rev: 62bade83dd6e021f11e9599a2699a1b202324f0f)

Signed-off-by: Igor Opaniuk <igor.opaniuk@foundries.io>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Igor Opaniuk 2025-02-04 11:01:14 +01:00 committed by Richard Purdie
parent e8d4c8a153
commit fe0669477e
1 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
meta/recipes-devtools/rust/README-rust.md
View File

@ -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.