Skip to content

Commit 78f8c13

Browse files
committed
Merge pull request #1678 from a-maze-d/issue_1677
Fixed minor errors in the tooling documentation These changes are made under both the "Apache 2.0" and the "GNU Lesser General Public License 2.1 or later" license terms (dual license). SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later
2 parents 02c5274 + 8faa85b commit 78f8c13

File tree

1 file changed

+8
-12
lines changed

1 file changed

+8
-12
lines changed

doc/src/atomvm-tooling.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@ remote: Total 17 (delta 6), reused 16 (delta 6), pack-reused 0
304304
origin/HEAD set to main
305305
```
306306

307-
You can now use the `atomvm.packbeam` target to create a packbeam (ending in `.avm`) file:
307+
You can now use the `mix atomvm.packbeam` task to create a packbeam (ending in `.avm`) file:
308308

309309
```shell
310310
$ mix atomvm.packbeam
@@ -328,7 +328,7 @@ $ ls -l HelloWorld.avm
328328

329329
```{seealso}
330330
See the [`ExAtomVM`](https://github.com/atomvm/ExAtomVM) page for more detailed instructions about how to use the
331-
`atomvm.packbeam` target.
331+
`mix atomvm.packbeam` task.
332332
```
333333

334334
### Running on the `generic_unix` platform
@@ -349,10 +349,10 @@ The [`ExAtomVM`](https://github.com/atomvm/ExAtomVM) plugin supports flash targe
349349

350350
#### ESP32 flash task
351351

352-
To flash AtomVM packbeam file to an ESP32 device, use the `mix.esp32.flash` target. Users will typically specify the device port and baud rate as command-line options to this target.
352+
To flash AtomVM packbeam file to an ESP32 device, use the `mix atomvm.esp32.flash` task. Users will typically specify the device port and baud rate as command-line options to this target.
353353

354354
```{important}
355-
In order to use the `mix.esp32.flash` target, you will need to install the [`esptool`](https://github.com/espressif/esptool) program.
355+
In order to use the `mix atomvm.esp32.flash` task, you will need to install the [`esptool`](https://github.com/espressif/esptool) program.
356356
```
357357

358358
For example:
@@ -362,14 +362,10 @@ $ mix atomvm.esp32.flash --port /dev/ttyUSB0 --baud 921600
362362
```
363363

364364
```{tip}
365-
A baud rate of 921600 works well for most ESP32 devices, some can work reliably at higher rates of 1500000, or even
366-
2000000, but some devices (especially those with a 26Mhz crystal frequency, rather than the more common 40 Mhz
367-
crystal) may need to use a slower baud rate such as 115200.
365+
A baud rate of 921600 works well for most ESP32 devices, some can work reliably at higher rates of 1500000, or even 2000000, but some devices (especially those with a 26Mhz crystal frequency, rather than the more common 40 Mhz crystal) may need to use a slower baud rate such as 115200.
368366
```
369367

370-
> Note. A baud rate of 921600 works well for most ESP32 devices, some can work reliably at higher rates of 1500000, or even 2000000, but some devices (especially those with a 26Mhz crystal frequency, rather than the more common 40 Mhz crystal) may need to use a slower baud rate such as 115200.
371-
372-
See the [`ExAtomVM`](https://github.com/atomvm/ExAtomVM) page for more detailed instructions about how to use the `mix.esp32.flash` target.
368+
See the [`ExAtomVM`](https://github.com/atomvm/ExAtomVM) page for more detailed instructions about how to use the `mix atomvm.esp32.flash` task.
373369

374370
You can now use a serial console program such as [minicom](https://en.wikipedia.org/wiki/Minicom) or [screen](https://en.wikipedia.org/wiki/GNU_Screen) to view console output from a device.
375371

@@ -404,10 +400,10 @@ You can now use a serial console program such as [minicom](https://en.wikipedia.
404400

405401
#### STM32 flash task
406402

407-
To flash AtomVM packbeam file to an STM32 device, use the `atomvm.stm32.flash` mix target.
403+
To flash AtomVM packbeam file to an STM32 device, use the `mix atomvm.stm32.flash` task.
408404

409405
```{important}
410-
In order to use the `mix.stm32.flash` target, you will need to install the `st-flash` tool from the open source
406+
In order to use the `mix atomvm.stm32.flash` task, you will need to install the `st-flash` tool from the open source
411407
(bsd-3 licensed) [stlink](https://github.com/stlink-org/stlink) suite of stm32 utilities.
412408
```
413409

0 commit comments

Comments
 (0)