Skip to content

Commit 37e7ec5

Browse files
sirhcelYatekii
authored andcommitted
Update docs on cargo-embed profile parameter
This parameter is a positional argument since a while and its name got updated with probe-rs/probe-rs#3361.
1 parent a6fe392 commit 37e7ec5

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

src/content/docs/tools/cargo-embed.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ And there is much more to come in the future!
2121
You can use it like any cargo command would be used
2222

2323
```bash
24-
cargo embed <args>
24+
cargo embed [OPTIONS] [CONFIG_PROFILE]
2525
```
2626

2727
This will do following in sequence:
@@ -73,10 +73,10 @@ precedence.
7373

7474
The data in the `Embed.toml` is structured in two levels: The outer layer is a
7575
configuration profile name, inside each profile there are then a series of
76-
sections with different options. The default profile is called "default" ;) When
77-
invoking cargo-embed, a different profile name can be passed as an argument with
78-
`--config <profile>`, which will load the settings under that profile instead of
79-
`default`.
76+
sections with different options. The default profile is called "default" ;)
77+
When invoking cargo-embed, a different profile name can be passed as positional
78+
argument `CONFIG_PROFILE`, which will load the settings under that profile
79+
instead of `default` (see [Usage](#usage)).
8080

8181
For example, in your `Embed.toml`:
8282

@@ -92,8 +92,8 @@ chip = "STM32F401CCUx"
9292
enabled = true
9393
```
9494

95-
Now you can run `cargo embed --config with_rtt` to have RTT enabled, while
96-
`cargo embed` will use the default config "default" without RTT.
95+
Now you can run `cargo embed with_rtt` to have RTT enabled, while `cargo embed`
96+
will use the default config "default" without RTT.
9797

9898
## RTT
9999

0 commit comments

Comments
 (0)