Skip to content

Commit

Permalink
doc: spelling fixes in samples/ and boards/
Browse files Browse the repository at this point in the history
regular spelling check on .rst files

Signed-off-by: David B. Kinder <[email protected]>
  • Loading branch information
dbkinder authored and Anas Nashif committed Jun 12, 2017
1 parent 57df515 commit 342bdda
Show file tree
Hide file tree
Showing 24 changed files with 32 additions and 31 deletions.
4 changes: 2 additions & 2 deletions boards/arc/em_starterkit/doc/board.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Documentation for this board can be found at `embARC website`_.
See also this URL for details about the board:
`Designware ARC EM Starter Kit website`_ .

The lastest version of EM Starter Kit is 2.3, developer can upgrade from
The latest version of EM Starter Kit is 2.3, developer can upgrade from
2.0/2.1/2.2 to 2.3 using latest firmware.
The default configuration for EM Starter Kit boards can be found in
:file:`boards/arc/em_starterkit/em_starterkit_defconfig`.
Expand Down Expand Up @@ -102,7 +102,7 @@ switches, 9 LEDs, SDCard on SPI, and a 16MB SPI-Flash memory.
The SPI-Flash also holds 3 (or 4) separate FPGA CPU bit files, selectable via
dip switch.

The SPI-Flash is also programmed with a bootloader. The booloader can copy a
The SPI-Flash is also programmed with a bootloader. The bootloader can copy a
program image from SPI-Flash into executable memory. Zephyr initialization will
copy the initialized data section to the data memory if CONFIG_XIP is used.

Expand Down
2 changes: 1 addition & 1 deletion boards/arm/96b_carbon_nrf51/doc/96b_carbon_nrf51.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Supported Features
+-----------+------------+-------------------------------------+
| SPIS | on-chip | SPI slave |
+-----------+------------+-------------------------------------+
| RADIO | on-chip | bluetooth |
| RADIO | on-chip | Bluetooth |
+-----------+------------+-------------------------------------+

The default configuration can be found in the defconfig file:
Expand Down
2 changes: 1 addition & 1 deletion boards/arm/96b_nitrogen/doc/96b_nitrogen.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ features:
+-----------+------------+--------------------------------------+
| FLASH | on-chip | flash |
+-----------+------------+--------------------------------------+
| RADIO | on-chip | bluetooth |
| RADIO | on-chip | Bluetooth |
+-----------+------------+--------------------------------------+
| RTT | on-chip | console |
+-----------+------------+--------------------------------------+
Expand Down
2 changes: 1 addition & 1 deletion boards/arm/cc3200_launchxl/doc/cc3200_launchxl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ driver support.
| GPIO | on-chip | gpio |
+-----------+------------+-----------------------+

The accelerometer, temperature sensors, WiFi, or other perhipherals
The accelerometer, temperature sensors, WiFi, or other peripherals
accessible through the BoosterPack, are not currently supported by
this Zephyr port.

Expand Down
2 changes: 1 addition & 1 deletion boards/arm/cc3220sf_launchxl/doc/cc3220sf_launchxl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ Debugging
=========

It is possible to enable loading and debugging of an application via
OpenOCD and gdb, by linking and locating the program completely in SRAM.
openocd and gdb, by linking and locating the program completely in SRAM.

Prerequisites:
--------------
Expand Down
2 changes: 1 addition & 1 deletion boards/arm/nrf51_pca10028/doc/nrf51_pca10028.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ hardware features:
+-----------+------------+----------------------+
| FLASH | on-chip | flash |
+-----------+------------+----------------------+
| RADIO | on-chip | bluetooth |
| RADIO | on-chip | Bluetooth |
+-----------+------------+----------------------+
| RTT | on-chip | console |
+-----------+------------+----------------------+
Expand Down
2 changes: 1 addition & 1 deletion boards/arm/nrf52840_pca10056/doc/nrf52840_pca10056.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ hardware features:
+-----------+------------+----------------------+
| FLASH | on-chip | flash |
+-----------+------------+----------------------+
| RADIO | on-chip | bluetooth |
| RADIO | on-chip | Bluetooth |
+-----------+------------+----------------------+
| RTT | on-chip | console |
+-----------+------------+----------------------+
Expand Down
2 changes: 1 addition & 1 deletion boards/arm/nrf52_blenano2/doc/nrf52_blenano2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The BLE Nano v2 board configuration supports the following hardware features:
+-----------+------------+--------------------------------------+
| FLASH | on-chip | flash |
+-----------+------------+--------------------------------------+
| RADIO | on-chip | bluetooth |
| RADIO | on-chip | Bluetooth |
+-----------+------------+--------------------------------------+
| I2C | on-chip | i2c |
+-----------+------------+--------------------------------------+
Expand Down
2 changes: 1 addition & 1 deletion boards/arm/nrf52_pca10040/doc/nrf52_pca10040.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ hardware features:
+-----------+------------+----------------------+
| FLASH | on-chip | flash |
+-----------+------------+----------------------+
| RADIO | on-chip | bluetooth |
| RADIO | on-chip | Bluetooth |
+-----------+------------+----------------------+
| RTT | on-chip | console |
+-----------+------------+----------------------+
Expand Down
2 changes: 1 addition & 1 deletion boards/arm/nucleo_f412zg/doc/nucleo412zg.rst
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Programming and Debugging
*************************

Nucleo F412ZG board includes an ST-LINK/V2-1 embedded debug tool interface.
However this interface is currently not supported by openocd. You will need
However this interface is currently not supported by OpenOCD. You will need
to use ST tools or an external JTAG probe.


Expand Down
2 changes: 1 addition & 1 deletion boards/arm/nucleo_f413zh/doc/nucleof413zh.rst
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Programming and Debugging
*************************

Nucleo F413ZH board includes an ST-LINK/V2-1 embedded debug tool interface.
However this interface is currently not supported by openocd. You will need
However this interface is currently not supported by OpenOCD. You will need
to use ST tools or an external JTAG probe.


Expand Down
2 changes: 1 addition & 1 deletion boards/arm/stm32f469i_disco/doc/stm32f469i_disco.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ The default configuration can be found in the defconfig file:
Pin Mapping
===========

STM32F469I-DISCO Discovry kit has 9 GPIO controllers. These controllers are responsible for pin muxing,
STM32F469I-DISCO Discovery kit has 9 GPIO controllers. These controllers are responsible for pin muxing,
input/output, pull-up, etc.

For mode details please refer to `32F469IDISCOVERY board User Manual`_.
Expand Down
2 changes: 1 addition & 1 deletion boards/arm/stm32f4_disco/doc/stm32f4_disco.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ The default configuration can be found in the defconfig file:
Pin Mapping
===========

STM32F4DISCOVERY Discovry kit has 8 GPIO controllers. These controllers are responsible for pin muxing,
STM32F4DISCOVERY Discovery kit has 8 GPIO controllers. These controllers are responsible for pin muxing,
input/output, pull-up, etc.

For mode details please refer to `STM32F4DISCOVERY board User Manual`_.
Expand Down
4 changes: 2 additions & 2 deletions boards/nios2/altera_max10/doc/board.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Reference CPU
A reference CPU design of a Nios II/f core is included in the Zephyr tree
in the :file:`arch/nios2/soc/nios2f-zephyr/cpu` directory.

Flash ths CPU using the ``nios2-configure-sof`` SDK tool with the FPGA
Flash this CPU using the ``nios2-configure-sof`` SDK tool with the FPGA
configuration file
:file:`arch/nios2/soc/nios2f-zephyr/cpu/ghrd_10m50da.sof`:

Expand Down Expand Up @@ -284,7 +284,7 @@ nios2-configure-sof. You can leave this process running.
$ nios2-gdb-server --tcpport 1234 --tcppersist --init-cache --reset-target
Build your zephyr kernel, and load it into a GDB built for Nios II (included in
Build your Zephyr kernel, and load it into a GDB built for Nios II (included in
the Zephyr SDK):

.. code-block:: console
Expand Down
2 changes: 1 addition & 1 deletion boards/x86/qemu_x86/doc/board.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ X86 Emulation (QEMU)
Overview
********

The Zephyr Kernel uses the qemu_x86 board configuration to emulate pentium-class
The Zephyr Kernel uses the qemu_x86 board configuration to emulate Pentium-class
systems running on QEMU.
This board configuration provides support for an x86 Minute IA CPU and the
following devices:
Expand Down
2 changes: 1 addition & 1 deletion boards/xtensa/xt-sim/doc/xt-sim.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ emulating Xtensa hardware.
Hardware
********

The folllowing Xtensa cores are officially supported:
The following Xtensa cores are officially supported:

- hifi3_bd5
- XRC_FUSION_AON_ALL_LM
Expand Down
2 changes: 1 addition & 1 deletion samples/basic/rgb_led/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Arduino 101
===========

You will need to connect the LED pins to PWM0, PWM1 and PWM2
on arduino 101 via the shield. Depending on what kind of RGB
on Arduino 101 via the shield. Depending on what kind of RGB
LED you are using, please connect the common cathode to the
ground or the common anode to Vcc. You need current limiting
resistor for each of the single color LEDs.
Expand Down
6 changes: 3 additions & 3 deletions samples/bluetooth/bluetooth.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ To build any of the Bluetooth samples, follow the instructions below:
Host Bluetooth controller is connected to the second QEMU serial line through a
Unix socket (QEMU option -serial unix:/tmp/bt-server-bredr). This option is
already added to Qemu through QEMU_EXTRA_FLAGS in Makefile.
already added to QEMU through QEMU_EXTRA_FLAGS in Makefile.

On the host side BlueZ allows to "connect" Bluetooth controller through a
so-called user channel. Use the btproxy tool for that:
Expand All @@ -24,13 +24,13 @@ down.
$ sudo tools/btproxy -u
Listening on /tmp/bt-server-bredr
Running the application in Qemu will connect the second serial line to
Running the application in QEMU will connect the second serial line to
``bt-server-bredr`` Unix socket. When Bluetooth (CONFIG_BLUETOOTH) and Bluetooth
HCI UART driver (CONFIG_BLUETOOTH_H4) are enabled, the Bluetooth driver
registers with the system.

From now on Bluetooth may be used by the application. To run applications in
the Qemu emulation environment, type:
the QEMU emulation environment, type:

.. code-block:: console
Expand Down
2 changes: 1 addition & 1 deletion samples/environmental_sensing/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Environmental Sensing Sample
Overview
********

This sample implementes a simple environmental sensing service using the Arduino
This sample implements a simple environmental sensing service using the Arduino
101 board.

The sensor subsystem application collects temperature, humidity and pressure
Expand Down
2 changes: 1 addition & 1 deletion samples/kernel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Kernel Samples
##############

The following are kernel samples that can be run on any of the supported
plaforms:
platforms:

.. toctree::
:maxdepth: 1
Expand Down
5 changes: 3 additions & 2 deletions samples/net/mbedtls_dtlsclient/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,9 @@ Assign the server IP address and start the DTLS server.
. Setting up the SSL/TLS structure... ok
. Waiting for a remote connection ...
To stop the server use Ctrl-C and repeat steps described in f) every time
QEMU gets terminated, due the Netwrok interface (tap) being restarted.
To stop the server, use Ctrl-C and repeat the steps described in
:ref:`networking_with_qemu` every time
QEMU gets terminated, due the Network interface (tap) being restarted.

From the application directory type

Expand Down
2 changes: 1 addition & 1 deletion samples/net/mbedtls_dtlsserver/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ From the app directory type the screen should display
. Setting up ecjpake password ... ok
. Performing the TLS handshake...
If trying to use IPv6 edit the file prj_qemu_x86.conf and chage the line from
If trying to use IPv6 edit the file prj_qemu_x86.conf and change the line from
CONFIG_NET_IPV6=n to CONFIG_NET_IPV6=y

And run the client on mbedTLS as
Expand Down
4 changes: 2 additions & 2 deletions samples/net/zoap_server/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The sample exports the following resources:
/location-query
/large-update
These resources allow a good part of the ETSI testcases to be run
These resources allow a good part of the ETSI test cases to be run
against zoap-server.

Building And Running
Expand All @@ -46,7 +46,7 @@ It can be built and executed on QEMU as follows:
Use this command on the host to run the`libcoap`_ implementation of
the ETSI testcases:
the ETSI test cases:

.. code-block:: console
Expand Down
4 changes: 2 additions & 2 deletions samples/sensor/th02/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ controlled using the I2C interface.

More details about the sensor and the display can be found here:

- `Grove Tempture And Humidity`_
- `Grove Temperature And Humidity`_
- `Grove LCD Module`_

Wiring
Expand All @@ -27,7 +27,7 @@ Wiring
The easiest way to get this wired is to use the Grove shield and connect both
devices to I2C. No additional wiring is required. Depending on the board you are
using you might need to connect two 10K ohm resistors to SDL and and SDA (I2C).
The LCD display requires 5 volts, so the volatage switch on the shield needs to
The LCD display requires 5 volts, so the voltage switch on the shield needs to
be on 5v.


Expand Down

0 comments on commit 342bdda

Please sign in to comment.