You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by xi...@apache.org on 2022/06/23 16:01:45 UTC
[incubator-nuttx] branch master updated: Documentation: Fix various typos.
This is an automated email from the ASF dual-hosted git repository.
xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-nuttx.git
The following commit(s) were added to refs/heads/master by this push:
new 2032eeae6c Documentation: Fix various typos.
2032eeae6c is described below
commit 2032eeae6c2ffe1cb459cd420b6e9c3213423f9d
Author: Nathan Hartman <59...@users.noreply.github.com>
AuthorDate: Thu Jun 23 09:21:31 2022 -0400
Documentation: Fix various typos.
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 <38...@users.noreply.github.com>
---
Documentation/components/drivers/character/serial.rst | 2 +-
Documentation/faq/index.rst | 4 ++--
Documentation/guides/pysimcoder.rst | 8 ++++----
Documentation/platforms/arm/imxrt/boards/teensy-4.x/index.rst | 4 ++--
Documentation/platforms/arm/imxrt/index.rst | 2 +-
.../platforms/arm/stm32wl5/boards/nucleo-wl55jc/index.rst | 4 ++--
Documentation/platforms/arm/stm32wl5/index.rst | 4 ++--
Documentation/platforms/risc-v/bl602/index.rst | 4 ++--
Documentation/platforms/sim/sim/index.rst | 2 +-
Documentation/platforms/xtensa/esp32/index.rst | 2 +-
10 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/Documentation/components/drivers/character/serial.rst b/Documentation/components/drivers/character/serial.rst
index ea259fdb88..11721b6937 100644
--- a/Documentation/components/drivers/character/serial.rst
+++ b/Documentation/components/drivers/character/serial.rst
@@ -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:
diff --git a/Documentation/faq/index.rst b/Documentation/faq/index.rst
index 5430047af5..f5a09e5f78 100644
--- a/Documentation/faq/index.rst
+++ b/Documentation/faq/index.rst
@@ -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
diff --git a/Documentation/guides/pysimcoder.rst b/Documentation/guides/pysimcoder.rst
index 31fc3fe174..25d07991e0 100644
--- a/Documentation/guides/pysimcoder.rst
+++ b/Documentation/guides/pysimcoder.rst
@@ -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:
==================================== =====================================
@@ -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
@@ -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
diff --git a/Documentation/platforms/arm/imxrt/boards/teensy-4.x/index.rst b/Documentation/platforms/arm/imxrt/boards/teensy-4.x/index.rst
index e2ba561a4f..14df038216 100644
--- a/Documentation/platforms/arm/imxrt/boards/teensy-4.x/index.rst
+++ b/Documentation/platforms/arm/imxrt/boards/teensy-4.x/index.rst
@@ -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
diff --git a/Documentation/platforms/arm/imxrt/index.rst b/Documentation/platforms/arm/imxrt/index.rst
index 13b4521262..62f946f603 100644
--- a/Documentation/platforms/arm/imxrt/index.rst
+++ b/Documentation/platforms/arm/imxrt/index.rst
@@ -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
diff --git a/Documentation/platforms/arm/stm32wl5/boards/nucleo-wl55jc/index.rst b/Documentation/platforms/arm/stm32wl5/boards/nucleo-wl55jc/index.rst
index 4ba6118133..bc0f92296c 100644
--- a/Documentation/platforms/arm/stm32wl5/boards/nucleo-wl55jc/index.rst
+++ b/Documentation/platforms/arm/stm32wl5/boards/nucleo-wl55jc/index.rst
@@ -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
diff --git a/Documentation/platforms/arm/stm32wl5/index.rst b/Documentation/platforms/arm/stm32wl5/index.rst
index 798114e211..1025f49e44 100644
--- a/Documentation/platforms/arm/stm32wl5/index.rst
+++ b/Documentation/platforms/arm/stm32wl5/index.rst
@@ -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
@@ -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).
diff --git a/Documentation/platforms/risc-v/bl602/index.rst b/Documentation/platforms/risc-v/bl602/index.rst
index d72c1ad3e5..5a2e8f3247 100644
--- a/Documentation/platforms/risc-v/bl602/index.rst
+++ b/Documentation/platforms/risc-v/bl602/index.rst
@@ -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>`__.
diff --git a/Documentation/platforms/sim/sim/index.rst b/Documentation/platforms/sim/sim/index.rst
index b3b43a021f..29337a1e0d 100644
--- a/Documentation/platforms/sim/sim/index.rst
+++ b/Documentation/platforms/sim/sim/index.rst
@@ -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
diff --git a/Documentation/platforms/xtensa/esp32/index.rst b/Documentation/platforms/xtensa/esp32/index.rst
index 551e5ffe2e..c6e26123fb 100644
--- a/Documentation/platforms/xtensa/esp32/index.rst
+++ b/Documentation/platforms/xtensa/esp32/index.rst
@@ -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