diff options
| author | Igor Opaniuk <igor.opaniuk@foundries.io> | 2025-02-04 11:01:14 +0100 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2025-02-05 12:49:56 +0000 |
| commit | fe0669477e6280c7ee96b380b752abd9f837ce0f (patch) | |
| tree | 2840b54dcf3d0f0dc1827040e89823c866198886 /meta/recipes-devtools/rust | |
| parent | e8d4c8a153694401e135c167f546e8a158efa723 (diff) | |
| download | poky-fe0669477e6280c7ee96b380b752abd9f837ce0f.tar.gz | |
rust/README-rust.md: fix markdown style issues
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>
Diffstat (limited to 'meta/recipes-devtools/rust')
| -rw-r--r-- | meta/recipes-devtools/rust/README-rust.md | 24 |
1 files changed, 13 insertions, 11 deletions
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 @@ | |||
| 1 | ## Introduction | 1 | # Introduction |
| 2 | 2 | ||
| 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 | ## Building a rust package | 6 | ## Building a rust package |
| 7 | 7 | ||
| 8 | 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 |
| 9 | cargo using cargo.bbclass. If the package already has a Cargo.toml file (most | 9 | cargo using cargo.bbclass. If the package already has a Cargo.toml file (most |
| 10 | rust packages do), then it's especially easy. Otherwise you should probably | 10 | rust packages do), then it's especially easy. Otherwise you should probably |
| 11 | get the code building in cargo first. | 11 | get the code building in cargo first. |
| 12 | 12 | ||
| 13 | Once your package builds in cargo, you can use | 13 | Once your package builds in cargo, you can use |
| 14 | [cargo-bitbake](https://github.com/cardoe/cargo-bitbake) to generate a bitbake | 14 | [cargo-bitbake](https://github.com/cardoe/cargo-bitbake) to generate a bitbake |
| @@ -22,17 +22,19 @@ contained within it | |||
| 22 | 22 | ||
| 23 | ## Pitfalls | 23 | ## Pitfalls |
| 24 | 24 | ||
| 25 | - TARGET_SYS _must_ be different from BUILD_SYS. This is due to the way Rust | 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 | 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. | 27 | we use the Yocto triples instead of the native Rust triples. See |
| 28 | [Add the ability to provide build flags for the build-script-build #3349](https://github.com/rust-lang/cargo/issues/3349) | ||
| 28 | 29 | ||
| 29 | ## Dependencies | 30 | ## Dependencies |
| 30 | 31 | ||
| 31 | On the host: | 32 | On the host: |
| 32 | - Any `-sys` packages your project might need must have RDEPENDs for | 33 | |
| 33 | the native library. | 34 | * Any `-sys` packages your project might need must have RDEPENDs for |
| 35 | the native library. | ||
| 34 | 36 | ||
| 35 | On the target: | 37 | On the target: |
| 36 | - Any `-sys` packages your project might need must have RDEPENDs for | ||
| 37 | the native library. | ||
| 38 | 38 | ||
| 39 | * Any `-sys` packages your project might need must have RDEPENDs for | ||
| 40 | the native library. | ||
