Skip to content
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.

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

Proofreading fixes #109

Merged
merged 19 commits into from
Aug 1, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
style: Remove unused ignore md tags
  • Loading branch information
SergioGasquez committed Jul 27, 2023
commit 449300aaf28d6bbf6722d40c807a8bdb46d1ee3d
2 changes: 1 addition & 1 deletion rust-doc-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ To simplify link maintenance, follow the rules below:

Example:

```
```md
[`espup`][espup-github] is a tool that simplifies installing and maintaining the components required to develop Rust applications.

[espup-github]: https://github.com/esp-rs/espup
Expand Down
6 changes: 3 additions & 3 deletions src/misc/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ If using GNU ABI, install [MinGW/MSYS2 toolchain].

You must clean your project and rebuild for changes in the `sdkconfig.defaults` to take effect:

```shell,ignore
```shell
cargo clean
cargo build
```
Expand All @@ -127,7 +127,7 @@ Instead, we are building the documentation and hosting it ourselves on GitHub Pa

If the second-stage bootloader reports this error, you likely need to increase the stack size for the main task. This can be accomplished by adding the following to the `sdkconfig.defaults` file:

```ignore
```text
CONFIG_ESP_MAIN_TASK_STACK_SIZE=7000
```

Expand All @@ -137,7 +137,7 @@ In this example, we are allocating 7kB for the main task's stack.

Add to your `sdkconfig.defaults` file:

```ignore
```text
CONFIG_INT_WDT=n
CONFIG_ESP_TASK_WDT=n
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ Before going further, let's see what these files are for.
7 println!("Hello, world!");
8 }
```

The first line is an import that defines the esp-idf entry-point when the root crate is a binary crate that defines a main function.

Then, we have a usual main function with a few lines on it:
Expand All @@ -96,6 +97,7 @@ Since our [`runner` configuration][runner-config] also passes the `--monitor` ar
> `cargo install espflash`

You should see something similar to this:

```text
[2023-04-18T08:05:09Z INFO ] Connecting...
[2023-04-18T08:05:10Z INFO ] Using flash stub
Expand All @@ -117,6 +119,7 @@ Commands:
I (344) cpu_start: Starting scheduler.
Hello, world!
```

As you can see, there are messages from the first and second stage bootloader and then, our "Hello, world!" is printed.

You can reboot with `CTRL+R` or exit with `CTRL+C`.
Expand Down