Skip to content

Commit

Permalink
style: Format notes and warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
SergioGasquez committed Jul 27, 2023
1 parent 9602b94 commit f84a584
Show file tree
Hide file tree
Showing 9 changed files with 14 additions and 15 deletions.
6 changes: 3 additions & 3 deletions src/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Please note that you can host the development environment in a [container][use-c

Make sure you have [Rust][rust-lang-org] installed. If not, see the instructions on the [rustup][rustup.rs-website] website.

> **Warning**: When using Unix based systems, installing Rust via a system package manager (e.g. `brew`, `apt`, `dnf`, etc.) can result in various issues and incompatibilities, so it's best to use [rustup][rustup.rs-website] instead.
> 🚨 **Warning**: When using Unix based systems, installing Rust via a system package manager (e.g. `brew`, `apt`, `dnf`, etc.) can result in various issues and incompatibilities, so it's best to use [rustup][rustup.rs-website] instead.
When using Windows, make sure you have installed one of the ABIs listed below. For more details, see the [Windows][rustup-book-windows] chapter in The rustup book.
- **MSVC**: Recommended ABI, included in the list of `rustup` default requirements. Use it for interoperability with the software produced by Visual Studio.
Expand Down Expand Up @@ -103,7 +103,7 @@ Install all the necessary tools to develop Rust applications for all supported E
espup install
```

> **Note**: `std` applications require installing additional software covered in [`std` Development Requirements][rust-esp-book-std-requirements]
> ⚠️ **Note**: `std` applications require installing additional software covered in [`std` Development Requirements][rust-esp-book-std-requirements]

### 3. Set up the environment variables
`espup` will create an export file that contains some environment variables required to build projects.
Expand Down Expand Up @@ -138,7 +138,7 @@ To enable support for Espressif targets, `espup` installs the following tools:
The forked compiler can coexist with the standard Rust compiler, allowing both to be installed on your system. The forked compiler is invoked when using any of the available [overriding methods][rustup-overrides].
> **Note**: We are making efforts to upstream our forks
> ⚠️ **Note**: We are making efforts to upstream our forks
> 1. Changes in `LLVM` fork. Already in progress, see the status in this [tracking issue][llvm-github-fork-upstream issue].
> 2. Rust compiler forks. If `LLVM` changes are accepted, we will proceed with the Rust compiler changes.
Expand Down
4 changes: 2 additions & 2 deletions src/overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ In the [esp-rs organization] we use the following wording:

## Support for Espressif Products

> **Notes**:
> ⚠️ **Notes**:
>
> - ✅ - The feature is implemented or supported
> - ⏳ - The feature is under development
Expand All @@ -48,7 +48,7 @@ In the [esp-rs organization] we use the following wording:
| ESP32-H2 |||
| ESP8266 |||

> **Note**: The ESP8266 series is outside the scope of this book. Rust support for the
> ⚠️ **Note**: The ESP8266 series is outside the scope of this book. Rust support for the
> ESP8266 series is limited and is not being officially supported by Espressif.
The products supported in certain circumstances will be called _supported Espressif products_ throughout the book.
2 changes: 1 addition & 1 deletion src/overview/using-the-core-library.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The table below covers the current support for `no_std` at this moment for diffe
| ESP32-S3 |||||
| ESP32-H2 |||||

> **Note**:
> ⚠️ **Note**:
>
> - ✅ in Wi-Fi/BLE/ESP-NOW means that the target supports, at least, one of the listed technologies. For details, see [Current support][esp-wifi-current-support] table of the esp-wifi repository.
> - [ESP8266 HAL][esp-rs/esp8266-hal] is in maintenance mode and no further development will be done for this chip.
Expand Down
2 changes: 1 addition & 1 deletion src/tooling/debugging/probe-rs.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Starting from `probe-rs` v0.12, it is possible to flash and debug the ESP32-C3 w
| :------: | :------: | :-------: |
| ESP32-C3 || ⚠️ |

**Note**: _Items marked with ⚠️ are currently work in progress, usable but expect bugs._
> ⚠️ **Note**: _Items marked with ⚠️ are currently work in progress, usable but expect bugs._
## Permissions - Linux

Expand Down
5 changes: 3 additions & 2 deletions src/tooling/debugging/vscode.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ There is also a possibility to debug with graphical output directly in Visual St
| 3V3 | VJTAG |
| GND | GND |

**Note**: On Windows `USB Serial Converter A 0403 6010 00` driver should be WinUSB.
> ⚠️ **Note**: On Windows `USB Serial Converter A 0403 6010 00` driver should be WinUSB.
2. Set up VSCode
1. Install [Cortex-Debug][cortex-debug] extension for VScode.
Expand Down Expand Up @@ -87,7 +87,8 @@ espflash board-info
| 3V3 | VJTAG |
| GND | GND |

**Note**: On Windows `USB Serial Converter A 0403 6010 00` driver should be WinUSB.
> ⚠️**Note**: On Windows `USB Serial Converter A 0403 6010 00` driver should be WinUSB.
2. Set up VSCode
1. Install [Cortex-Debug][cortex-debug] extension for VScode.
2. Create the `.vscode/launch.json` file in the project tree you want to debug.
Expand Down
4 changes: 1 addition & 3 deletions src/tooling/espflash.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@ The [esp-rs/espflash][espflash] repository contains two crates, `cargo-espflash`
[esptool]: https://github.com/espressif/esptool
[espflash]: https://github.com/esp-rs/espflash

> #### A note on `espflash` and `cargo-espflash`.
>
> The `espflash` and `cargo-espflash` commands shown below, assume that version `2.0` or greater is used.
> ⚠️ **Note**: The `espflash` and `cargo-espflash` commands shown below, assume that version `2.0` or greater is used.
## cargo-espflash

Expand Down
2 changes: 1 addition & 1 deletion src/writing-your-own-application/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ You can write an application in the following ways:

- (**Strongly recommended**) Generate from a template: Gives you a configured project, saves time and prevents possible errors.
- Start from scratch using Cargo: Requires more expertise since you need to configure several parts of the project.
> Note: Starting a project with Cargo does not provide any advantage, only mentioned here since it's the usual way of generating a project in Rust.
> ⚠️ **Note**: Starting a project with Cargo does not provide any advantage, only mentioned here since it's the usual way of generating a project in Rust.

This chapter won't cover the instructions on how to create a project from scratch with `cargo`, it will only focus on generating a project from a template project.
Expand Down
2 changes: 1 addition & 1 deletion src/writing-your-own-application/nostd.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The training contains:
* A button example ([Source][button])
* A button with interrupt example ([Source][button-interrupt])

> Note that there are several examples covering the use of specific peripherals under the examples' folder of every SoC [`esp-hal`][esp-hal]. E.g. [`esp32c3-hal/examples`][esp32c3-hal-examples]
> ⚠️ **Note**: There are several examples covering the use of specific peripherals under the examples' folder of every SoC [`esp-hal`][esp-hal]. E.g. [`esp32c3-hal/examples`][esp32c3-hal-examples]
[no-std-book]: https://esp-rs.github.io/no_std-training/
[no-std-repository]: https://github.com/esp-rs/no_std-training
Expand Down
2 changes: 1 addition & 1 deletion src/writing-your-own-application/std.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The training is split into two parts:
* GPIO/Button Interrupts ([Source][button-interrupt])
* Driving an RGB LED

> Note that there are several examples covering the use of specific peripherals under the examples' folder of [`esp-idf-hal`][esp-idf-hal]. I.e. [`esp-idf-hal/examples`][esp-idf-hal-examples].
> ⚠️ **Note**: There are several examples covering the use of specific peripherals under the examples' folder of [`esp-idf-hal`][esp-idf-hal]. I.e. [`esp-idf-hal/examples`][esp-idf-hal-examples].
[ferrous-systems]: https://ferrous-systems.com/
[std-book]: https://esp-rs.github.io/std-training/
Expand Down

0 comments on commit f84a584

Please sign in to comment.