From 12b872f687b3524349c55ea107acb08e4a2d4e1a Mon Sep 17 00:00:00 2001 From: Jan Niehusmann Date: Sun, 25 Aug 2024 08:16:12 +0000 Subject: [PATCH] Bulk update of docs mentioning .cargo/config The file was renamed to config.toml a while ago. --- README.md | 4 ++-- boards/boardsource-blok/README.md | 2 +- .../examples/sparkfun_micromod_battery_voltage.rs | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8b90343d..15f4c4a7 100644 --- a/README.md +++ b/README.md @@ -396,7 +396,7 @@ More details can be found in the [Project Template](https://github.com/rp-rs/rp2 $ cargo install elf2uf2-rs --locked ``` -*Step 2* - Make sure your .cargo/config contains the following (it should by +*Step 2* - Make sure your .cargo/config.toml contains the following (it should by default if you are working in this repository): ```toml @@ -433,7 +433,7 @@ $ cargo install --locked probe-rs-tools Alternatively, follow the installation instructions on https://probe.rs/. -*Step 2* - Make sure your .cargo/config contains the following: +*Step 2* - Make sure your .cargo/config.toml contains the following: ```toml [target.thumbv6m-none-eabi] diff --git a/boards/boardsource-blok/README.md b/boards/boardsource-blok/README.md index b1e5138d..a039f579 100644 --- a/boards/boardsource-blok/README.md +++ b/boards/boardsource-blok/README.md @@ -62,7 +62,7 @@ To start a basic project from scratch, create a project using `cargo new project project directory, run `cargo add blok`, `cargo add cortex-m-rt`, and `cargo add panic-halt`. The first command will add this HAL (Hardware Abstraction Layer), the second is required for the `#[entry]` macro, and _panic-halt_ creates a simple panic function, which just halts. -You'll also need to copy the cargo config file from the [repo](https://github.com/rp-rs/rp-hal-boards/blob/main/.cargo/config). It specifies the target and optimizing flags to the linker. You'll also need to copy [_memory.x_](https://github.com/rp-rs/rp-hal-boards/blob/main/memory.x) to your project root. This file tells the linker the flash and RAM layout, so it won't clobber the bootloader or write to an out of bounds memory address. +You'll also need to copy the cargo config file from the [repo](https://github.com/rp-rs/rp-hal-boards/blob/main/.cargo/config.toml). It specifies the target and optimizing flags to the linker. You'll also need to copy [_memory.x_](https://github.com/rp-rs/rp-hal-boards/blob/main/memory.x) to your project root. This file tells the linker the flash and RAM layout, so it won't clobber the bootloader or write to an out of bounds memory address. The simplest working example, which does nothing except loop forever, is: diff --git a/boards/sparkfun-micromod-rp2040/examples/sparkfun_micromod_battery_voltage.rs b/boards/sparkfun-micromod-rp2040/examples/sparkfun_micromod_battery_voltage.rs index 85ffc010..f4f6c720 100644 --- a/boards/sparkfun-micromod-rp2040/examples/sparkfun_micromod_battery_voltage.rs +++ b/boards/sparkfun-micromod-rp2040/examples/sparkfun_micromod_battery_voltage.rs @@ -3,7 +3,7 @@ //! Continuously reads the battery voltage and prints it over defmt-rtt. //! //! Note that for this example to work, you need to change the runner -//! to `probe-rs run` (in `.cargo/config` at the root of the repository) +//! to `probe-rs run` (in `.cargo/config.toml` at the root of the repository) //! and connect to the RP2040 via SWD, preferredly via the Raspberry //! Pi Debug Probe. //!