Skip to content

Commit

Permalink
Typo fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
ivankravets committed Feb 8, 2025
1 parent 93c46bd commit 2a5ebc4
Show file tree
Hide file tree
Showing 19 changed files with 65 additions and 65 deletions.
2 changes: 1 addition & 1 deletion advanced/unit-testing/frameworks/custom/runner.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ let's override a "testing" stage for the :ref:`unit_testing_frameworks_unity`:
# 1. Gather test results from Serial, HTTP, Socket, or other sources
# 2. Report test results (add cases)
# Exmaple: Report succeed result with duration (optional)
# Example: Report succeed result with duration (optional)
self.test_suite.add_case(
TestCase(name="test_connectivity", status=TestStatus.PASSED, duration=1.34)
)
Expand Down
20 changes: 10 additions & 10 deletions boards/atmelsam/adafruit_metro_m0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
.. _board_atmelsam_adafruit_metro_m0:

Adafruit Metro M0 Expresss
==========================
Adafruit Metro M0 Express
=========================

.. contents::

Expand Down Expand Up @@ -46,7 +46,7 @@ Please use ``adafruit_metro_m0`` ID for :ref:`projectconf_env_board` option in :
platform = atmelsam
board = adafruit_metro_m0
You can override default Adafruit Metro M0 Expresss settings per build environment using
You can override default Adafruit Metro M0 Express settings per build environment using
``board_***`` option, where ``***`` is a JSON object path from
board manifest `adafruit_metro_m0.json <https://github.com/platformio/platform-atmelsam/blob/master/boards/adafruit_metro_m0.json>`_. For example,
``board_build.mcu``, ``board_build.f_cpu``, etc.
Expand All @@ -66,7 +66,7 @@ board manifest `adafruit_metro_m0.json <https://github.com/platformio/platform-a
Uploading
---------
Adafruit Metro M0 Expresss supports the following uploading protocols:
Adafruit Metro M0 Express supports the following uploading protocols:

* ``atmel-ice``
* ``blackmagic``
Expand Down Expand Up @@ -98,7 +98,7 @@ Debugging
You can switch between debugging :ref:`debugging_tools` using
:ref:`projectconf_debug_tool` option in :ref:`projectconf`.

Adafruit Metro M0 Expresss does not have on-board debug probe and **IS NOT READY** for debugging. You will need to use/buy one of external probe listed below.
Adafruit Metro M0 Express does not have on-board debug probe and **IS NOT READY** for debugging. You will need to use/buy one of external probe listed below.

.. list-table::
:header-rows: 1
Expand All @@ -107,14 +107,14 @@ Adafruit Metro M0 Expresss does not have on-board debug probe and **IS NOT READY
- On-board
- Default
* - :ref:`debugging_tool_atmel-ice`
-
-
- Yes
* - :ref:`debugging_tool_blackmagic`
-
-
-
-
* - :ref:`debugging_tool_jlink`
-
-
-
-

Frameworks
----------
Expand Down
2 changes: 1 addition & 1 deletion boards/espressif32/lilygo-t-display.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Platform :ref:`platform_espressif32`: ESP32 is a series of low-cost, low-power s
* - **RAM**
- 320KB
* - **Vendor**
- `LilyGo <hhttps://www.lilygo.cc/products/lilygo%C2%AE-ttgo-t-display-1-14-inch-lcd-esp32-control-board?utm_source=platformio.org&utm_medium=docs>`__
- `LilyGo <https://www.lilygo.cc/products/lilygo%C2%AE-ttgo-t-display-1-14-inch-lcd-esp32-control-board?utm_source=platformio.org&utm_medium=docs>`__


Configuration
Expand Down
54 changes: 27 additions & 27 deletions boards/espressif32/minimain_esp32s2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
.. _board_espressif32_minimain_esp32s2:

Deparment of Alchemy MiniMain ESP32-S2
======================================
Department of Alchemy MiniMain ESP32-S2
=======================================

.. contents::

Expand All @@ -32,7 +32,7 @@ Platform :ref:`platform_espressif32`: ESP32 is a series of low-cost, low-power s
* - **RAM**
- 320KB
* - **Vendor**
- `Deparment of Alchemy <https://github.com/DepartmentOfAlchemy/minimain-esp32-s2?utm_source=platformio.org&utm_medium=docs>`__
- `Department of Alchemy <https://github.com/DepartmentOfAlchemy/minimain-esp32-s2?utm_source=platformio.org&utm_medium=docs>`__


Configuration
Expand All @@ -46,7 +46,7 @@ Please use ``minimain_esp32s2`` ID for :ref:`projectconf_env_board` option in :r
platform = espressif32
board = minimain_esp32s2
You can override default Deparment of Alchemy MiniMain ESP32-S2 settings per build environment using
You can override default Department of Alchemy MiniMain ESP32-S2 settings per build environment using
``board_***`` option, where ``***`` is a JSON object path from
board manifest `minimain_esp32s2.json <https://github.com/platformio/platform-espressif32/blob/master/boards/minimain_esp32s2.json>`_. For example,
``board_build.mcu``, ``board_build.f_cpu``, etc.
Expand All @@ -66,7 +66,7 @@ board manifest `minimain_esp32s2.json <https://github.com/platformio/platform-es
Uploading
---------
Deparment of Alchemy MiniMain ESP32-S2 supports the following uploading protocols:
Department of Alchemy MiniMain ESP32-S2 supports the following uploading protocols:

* ``cmsis-dap``
* ``esp-bridge``
Expand Down Expand Up @@ -107,7 +107,7 @@ Debugging
You can switch between debugging :ref:`debugging_tools` using
:ref:`projectconf_debug_tool` option in :ref:`projectconf`.

Deparment of Alchemy MiniMain ESP32-S2 does not have on-board debug probe and **IS NOT READY** for debugging. You will need to use/buy one of external probe listed below.
Department of Alchemy MiniMain ESP32-S2 does not have on-board debug probe and **IS NOT READY** for debugging. You will need to use/buy one of external probe listed below.

.. list-table::
:header-rows: 1
Expand All @@ -116,38 +116,38 @@ Deparment of Alchemy MiniMain ESP32-S2 does not have on-board debug probe and **
- On-board
- Default
* - :ref:`debugging_tool_cmsis-dap`
-
-
- Yes
* - ``esp-bridge``
-
-
-
-
* - :ref:`debugging_tool_esp-prog`
-
-
-
-
* - :ref:`debugging_tool_iot-bus-jtag`
-
-
-
-
* - :ref:`debugging_tool_jlink`
-
-
-
-
* - :ref:`debugging_tool_minimodule`
-
-
-
-
* - :ref:`debugging_tool_olimex-arm-usb-ocd`
-
-
-
-
* - :ref:`debugging_tool_olimex-arm-usb-ocd-h`
-
-
-
-
* - :ref:`debugging_tool_olimex-arm-usb-tiny-h`
-
-
-
-
* - :ref:`debugging_tool_olimex-jtag-tiny`
-
-
-
-
* - :ref:`debugging_tool_tumpa`
-
-
-
-

Frameworks
----------
Expand Down
2 changes: 1 addition & 1 deletion core/migration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ guarantees the full project reproducibility on any supported host machine for de

The new :ref:`cmd_pkg` operates in accordance with the active (working) project.
The :ref:`cmd_pkg_install` command will install all required project dependencies.
The :ref:`cmd_pkg_list` commmand allows listing not only dependent libraries
The :ref:`cmd_pkg_list` command allows listing not only dependent libraries
but also development platforms and their packages.

The notable addition is the :ref:`cmd_pkg_outdated` command. It allows you to
Expand Down
4 changes: 2 additions & 2 deletions core/userguide/cmd_test.rst
Original file line number Diff line number Diff line change
Expand Up @@ -185,9 +185,9 @@ Control verbosity level.
* - ``-v``
- Show a raw output from a testing framework
* - ``-vv``
- Base verbosity for buidling and uploading stages
- Base verbosity for building and uploading stages
* - ``-vvv``
- Extra verbosity for buidling and uploading stages
- Extra verbosity for building and uploading stages

Examples
--------
Expand Down
2 changes: 1 addition & 1 deletion core/userguide/lib/cmd_list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ Examples
LiquidCrystal
=============
#ID: 136
LiquidCrystal Library is faster and extensable, compatible with the original LiquidCrystal library
LiquidCrystal Library is faster and extensible, compatible with the original LiquidCrystal library
Version: 1.3.4
Keywords: lcd, hd44780
Expand Down
2 changes: 1 addition & 1 deletion core/userguide/platforms/cmd_frameworks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Print all supported frameworks, SDKs, etc.
cmsis ~ CMSIS
=============
The ARM Cortex Microcontroller Software Interface Standard (CMSIS) is a vendor-independent hardware abstraction layer for the Cortex-M processor series and specifies debugger interfaces. The CMSIS enables consistent and simple software interfaces to the processor for interface peripherals, real-time operating systems, and middleware. It simplifies software re-use, reducing the learning curve for new microcontroller developers and cutting the time-to-market for devices.
The ARM Cortex Microcontroller Software Interface Standard (CMSIS) is a vendor-independent hardware abstraction layer for the Cortex-M processor series and specifies debugger interfaces. The CMSIS enables consistent and simple software interfaces to the processor for interface peripherals, real-time operating systems, and middleware. It simplifies software reuse, reducing the learning curve for new microcontroller developers and cutting the time-to-market for devices.
Home: https://platformio.org/frameworks/cmsis
Expand Down
4 changes: 2 additions & 2 deletions frameworks/arduino.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6684,8 +6684,8 @@ Denky
- 4MB
- 320KB

Deparment of Alchemy
~~~~~~~~~~~~~~~~~~~~
Department of Alchemy
~~~~~~~~~~~~~~~~~~~~~

.. list-table::
:header-rows: 1
Expand Down
4 changes: 2 additions & 2 deletions frameworks/espidf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1835,8 +1835,8 @@ Denky
- 4MB
- 320KB

Deparment of Alchemy
~~~~~~~~~~~~~~~~~~~~
Department of Alchemy
~~~~~~~~~~~~~~~~~~~~~

.. list-table::
:header-rows: 1
Expand Down
2 changes: 1 addition & 1 deletion librarymanager/dependencies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Please take a look at the example below. The ``dep_1`` and ``dep_2`` dependencie
are common to the ``release`` and ``debug`` working environments, whereas
the ``dep_3`` is a specific only for the ``debug`` working environment.
The ``[env:debug]`` section overrides common ``lib_deps`` option, and the
``${env.lib_deps}`` (:ref:`projectconf_interpolation` technic) is used to merge
``${env.lib_deps}`` (:ref:`projectconf_interpolation` technique) is used to merge
the common and custom dependencies.

.. code-block:: ini
Expand Down
4 changes: 2 additions & 2 deletions manifests/library-json/fields/build/extrascript.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,11 +109,11 @@ Project structure
# remove specified flags
projenv.ProcessUnFlags("-fno-rtti")
# Pass flags to the Global environemnt (project `src` files, frameworks)
# Pass flags to the Global environment (project `src` files, frameworks)
global_env = DefaultEnvironment()
global_env.Append(CPPDEFINES=[("TEST_GLOBAL", 1)])
# Attach post action to the global environemnt
# Attach post action to the global environment
def post_program_action(source, target, env):
print("Program has been built!")
Expand Down
2 changes: 1 addition & 1 deletion manifests/library-json/fields/scripts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,5 +44,5 @@ Execute custom scripts during the special :ref:`cmd_pkg` life cycle events:
.. code-block:: javascript
"scripts": {
"preuninstall": ["maintainance.sh", "--action", "uninstall"]
"preuninstall": ["maintenance.sh", "--action", "uninstall"]
}
4 changes: 2 additions & 2 deletions platforms/espressif32.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1736,8 +1736,8 @@ Denky
- 4MB
- 320KB

Deparment of Alchemy
~~~~~~~~~~~~~~~~~~~~
Department of Alchemy
~~~~~~~~~~~~~~~~~~~~~

.. list-table::
:header-rows: 1
Expand Down
2 changes: 1 addition & 1 deletion platforms/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ development platform, PlatformIO defines:
- The **PlatformIO Build System** build scripts for the supported frameworks
and SDKs
- Pre-configured presets for embedded circuit boards
- Pre-compiled toolchains and related tools for the architechture(s)
- Pre-compiled toolchains and related tools for the architecture(s)

Each project must specify the platform name using the
:ref:`projectconf_env_platform` option in :ref:`projectconf`. A
Expand Down
6 changes: 3 additions & 3 deletions platforms/openhw.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ You do not need to use/buy external debug probe.
- Flash
- RAM
* - :ref:`board_openhw_nexys_a7`
-
-
- 320MHz
- 16MB
- 1.16MB
Expand Down Expand Up @@ -135,7 +135,7 @@ Packages
- Fork of Open On-Chip Debugger that has RISC-V support for PULP platform

* - `tool-ovpsim-corev <https://registry.platformio.org/tools/platformio/tool-ovpsim-corev>`__
- Imperas RISC-V OVPsim CORE-V simulator provides a reference of the OpenHW Group CORE-V processor cores. The riscvOVPsim familiy of simulators implement the full and complete functionality of the RISC-V Foundation's public User and Privilege specifications.
- Imperas RISC-V OVPsim CORE-V simulator provides a reference of the OpenHW Group CORE-V processor cores. The riscvOVPsim family of simulators implement the full and complete functionality of the RISC-V Foundation's public User and Privilege specifications.

* - `tool-renode <https://registry.platformio.org/tools/platformio/tool-renode>`__
- Renode is a development framework which accelerates IoT and embedded systems development by letting you simulate physical hardware systems
Expand Down Expand Up @@ -193,7 +193,7 @@ Digilent
- RAM
* - :ref:`board_openhw_nexys_a7`
- On-board
-
-
- 320MHz
- 16MB
- 1.16MB
2 changes: 1 addition & 1 deletion platforms/ststm8.rst
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ Packages
- STM8 toolchain with GDB debugger

* - `tool-stm8flash <https://registry.platformio.org/tools/platformio/tool-stm8flash>`__
- stm8flash is an application for programing stm8 devices with SWIM/stlinkv(1,2).
- stm8flash is an application for programming stm8 devices with SWIM/stlinkv(1,2).

* - `tool-stm8gal <https://registry.platformio.org/tools/platformio/tool-stm8gal>`__
- stm8gal is an application for programming or reading out STM8 memory using the built-in ROM bootloader (BSL) via UART or SPI interface
Expand Down
10 changes: 5 additions & 5 deletions plus/debugging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ Platforms
- Shakti is an open-source initiative by the RISE group at IIT-Madras, which is not only building open source, production grade processors, but also associated components like interconnect fabrics, verification tools, storage controllers, peripheral IPs and SOC tools.

* - :ref:`platform_sifive`
- SiFive brings the power of open source and software automation to the semiconductor industry, making it possible to develop new hardware faster and more affordably than ever before.
- SiFive brings the power of open source and software automation to the semiconductor industry, making it possible to develop new hardware faster and more affordably than ever before.

* - :ref:`platform_siliconlabsefm32`
- Silicon Labs EFM32 Gecko 32-bit microcontroller (MCU) family includes devices that offer flash memory configurations up to 256 kB, 32 kB of RAM and CPU speeds up to 48 MHz. Based on the powerful ARM Cortex-M core, the Gecko family features innovative low energy techniques, short wake-up time from energy saving modes and a wide selection of peripherals, making it ideal for battery operated applications and other systems requiring high performance and low-energy consumption.
Expand Down Expand Up @@ -2451,8 +2451,8 @@ Delta
- 512KB
- 64KB

Deparment of Alchemy
~~~~~~~~~~~~~~~~~~~~
Department of Alchemy
~~~~~~~~~~~~~~~~~~~~~

.. list-table::
:header-rows: 1
Expand Down Expand Up @@ -2516,14 +2516,14 @@ Digilent
* - :ref:`board_openhw_nexys_a7`
- :ref:`platform_openhw`
- On-board
-
-
- 320MHz
- 16MB
- 1.16MB
* - :ref:`board_chipsalliance_swervolf_nexys`
- :ref:`platform_chipsalliance`
- On-board
-
-
- 320MHz
- 16MB
- 1.16MB
Expand Down
2 changes: 1 addition & 1 deletion projectconf/sections/env/options/platform/platform.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Example of using a `Espressif 32 development platform <https://registry.platform
[env:latest_version]
; not recommended as it does not ensure that
; - builds are repeatable
; - all developers who checkout the project wil build against the same platform version
; - all developers who checkout the project will build against the same platform version
platform = platformio/espressif32
[env:development_verion_by_git]
Expand Down

0 comments on commit 2a5ebc4

Please sign in to comment.