Skip to content

Commit

Permalink
Documentation: Fix various typos.
Browse files Browse the repository at this point in the history
Documentation/components/drivers/character/serial.rst
Documentation/faq/index.rst
Documentation/guides/pysimcoder.rst
Documentation/platforms/arm/imxrt/boards/teensy-4.x/index.rst
Documentation/platforms/arm/imxrt/index.rst
Documentation/platforms/arm/stm32wl5/boards/nucleo-wl55jc/index.rst
Documentation/platforms/arm/stm32wl5/index.rst
Documentation/platforms/risc-v/bl602/index.rst
Documentation/platforms/sim/sim/index.rst
Documentation/platforms/xtensa/esp32/index.rst

Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com>
  • Loading branch information
2 people authored and xiaoxiang781216 committed Jun 23, 2022
1 parent 15864ff commit 2032eea
Show file tree
Hide file tree
Showing 10 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion Documentation/components/drivers/character/serial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Serial Device Drivers

You can choose launch method:
``TTY_LAUNCH_ENTRY`` or ``TTY_LAUNCH_FILE``,
If``TTY_LAUNCH_ENTRY`` you can set program entery by ``TTY_LAUNCH_ENTRYPOINT``.
If``TTY_LAUNCH_ENTRY`` you can set program entry by ``TTY_LAUNCH_ENTRYPOINT``.
If``TTY_LAUNCH_FILE`` you can set file path by ``TTY_LAUNCH_FILEPATH``.

Also, you can customize:
Expand Down
4 changes: 2 additions & 2 deletions Documentation/faq/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,8 @@ Why after putting my application on ENTRYPOINT it stops to work?
----------------------------------------------------------------

When you replace the ENTRYPOINT from "nsh_main" to your application some
initialization flow are changed, for instace the NSH_ARCHINIT is not
executed anymore and so some drivers initialiation that are called from
initialization flow are changed, for instance the NSH_ARCHINIT is not
executed anymore and so some drivers initialization that are called from
it also stops to work.

You can fix it enabling the Board Late Initialization that will replace the
Expand Down
8 changes: 4 additions & 4 deletions Documentation/guides/pysimcoder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ in case this documentation was not updated when new fuctionalities were added to
NuttX Configuration
-------------------

Several configuration options are necessary to be set in order to succesfully compile pysimCoder
Several configuration options are necessary to be set in order to successfully compile pysimCoder
with NuttX. The list is the following:

==================================== =====================================
Expand Down Expand Up @@ -120,7 +120,7 @@ root directory and is run by executing command
$ ./pysim-run.sh
Please note that PYSUPSICTRL variable has to be set/exported in order to succesfully compile NuttX application
Please note that PYSUPSICTRL variable has to be set/exported in order to successfully compile NuttX application
designed with pysimCoder.

Using pysimCoder to design NuttX application
Expand Down Expand Up @@ -156,8 +156,8 @@ also Python skript with parameters for the controllers.

pysimCoder Block settings menu

C code can be generated by selecting Generate C-code icon (highlighted in the green cirle). Executeble files are then
generated and can be flashed into the target. The flashing procedure can be target specific, please refer to plaftorm´s
C code can be generated by selecting Generate C-code icon (highlighted in the green circle). Executable files are then
generated and can be flashed into the target. The flashing procedure can be target specific, please refer to platform´s
documentation. The generated application can be then run from NuttX command line by executing::

nsh> main
4 changes: 2 additions & 2 deletions Documentation/platforms/arm/imxrt/boards/teensy-4.x/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,8 @@ pwm-4.1
-------

This configuration is similar to the nsh configuration with enabled
FlexPWM driver. Submodules 1 (pin 4) and 2 (pin 5) of FlexPWM2 are turn
on aswell as ultiple channel PWM output. Functionality can be tested
FlexPWM driver. Submodules 1 (pin 4) and 2 (pin 5) of FlexPWM2 are turned
on as well as multiple channel PWM output. Functionality can be tested
with example application "pwm". Each channel runs different duty cycle.

This configuration can be easily changed to work with Teensy 4.0 by
Expand Down
2 changes: 1 addition & 1 deletion Documentation/platforms/arm/imxrt/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ CONFIG_SCHED_TICKLESS_ALARM option. CONFIG_USEC_PER_TICK option determines the r
of time reported by :c:func:`clock_systime_ticks()` and the resolution of times that can be set
for certain delays including watchdog timers and delayed work. It is important that value set in
CONFIG_USEC_PER_TICK represents the frequency of GPT timer that runs the tickless mode. Clock
source of the timer is 16.6 MHz, which is then devided by the prescaler value from 1 to 4096.
source of the timer is 16.6 MHz, which is then divided by the prescaler value from 1 to 4096.
Possible values for CONFIG_USEC_PER_TICK are 10 or 100 for example.

Peripheral Support
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ stlink that provides virtual serial port.

NSH is configured to use LPUART and virtual serial port. After flashing
you can open /dev/ttyACM0 (may change depending on your system) and nsh
prompt will be waiting for you there. Serial device does not disapear
when flashing and reseting board - it can be left opened and flashing
prompt will be waiting for you there. Serial device does not disappear
when flashing and resetting board - it can be left opened and flashing
will work without problems.

Configurations
Expand Down
4 changes: 2 additions & 2 deletions Documentation/platforms/arm/stm32wl5/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ RCC Yes All registers defined, not all peripherals enabled
SYSCFG Yes All registers defined, GPIO EXTI works, remapping not tested
USART Yes
LPUART Yes full speed with HSE works, low power mode with LSE not implemented
FLASH Yes Progmem imlementation - mtd filesystems like smartfs or nxffs work
FLASH Yes Progmem implementation - mtd filesystems like smartfs or nxffs work
DMA No
SRAM2 No
SPI No
Expand Down Expand Up @@ -138,7 +138,7 @@ FLASH
-----

Place where program code lives. Part of flash can also be used to create
small filesystems like nxffs or smartfs to hold persistant data between
small filesystems like nxffs or smartfs to hold persistent data between
reboots without the need of attaching external flash or mmc card. Since
flash has limited number of erases (writes) it's best to hold there only
data that is no frequently updated (so, configuration is ok, logs are not).
Expand Down
4 changes: 2 additions & 2 deletions Documentation/platforms/risc-v/bl602/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,8 @@ Config download
For details, please refer to `BLFlashEnv — BL602 IoT
SDK <https://bouffalolab.github.io/bl_iot_sdk/Developer_Environment/BLFlashEnv/BLFlashEnv.html#iot>`__

Debuging with OpenOCD
=====================
Debugging with OpenOCD
======================

Download OpenOCD `RISC‑V
OpenOCD <https://static.dev.sifive.com/dev-tools/freedom-tools/v2020.12/riscv-openocd-0.10.0-2020.12.1-x86_64-linux-ubuntu14.tar.gz>`__.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/platforms/sim/sim/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ All you need is your machine ``gcc`` working.
Compiling
=========

All you need to do is select your desired board profile configuratioon
All you need to do is select your desired board profile configuration
(see: nuttx/sim/sim/sim/configs for the listing) ::

$ make distclean
Expand Down
2 changes: 1 addition & 1 deletion Documentation/platforms/xtensa/esp32/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ First configure to use the BLE board profile::
$ ./tools/configure.sh esp32-devkitc:ble
$ make flash ESPTOOL_PORT=/dev/ttyUSB0

Enter in the NSH shell using your prefered serial console tool and run the scan command::
Enter in the NSH shell using your preferred serial console tool and run the scan command::

NuttShell (NSH) NuttX-10.2.0
nsh> ifconfig
Expand Down

0 comments on commit 2032eea

Please sign in to comment.