Skip to content

Update docs on cargo-embed profile parameter #185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update docs on cargo-embed profile parameter #185

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions src/content/docs/tools/cargo-embed.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ And there is much more to come in the future!
You can use it like any cargo command would be used

```bash
cargo embed <args>
cargo embed [OPTIONS] [CONFIG_PROFILE]
```

This will do following in sequence:
Expand Down Expand Up @@ -73,10 +73,10 @@ precedence.

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

For example, in your `Embed.toml`:

Expand All @@ -92,8 +92,8 @@ chip = "STM32F401CCUx"
enabled = true
```

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

## RTT

Expand Down