Typos typos typos, and treefmt fixes (eclipse-openbsw#101)

Change-Id: I86501274ec4ee61dc718a6d9caa894a4ff0745ec

Co-authored-by: Thomas Frank <[email protected]>

Author: marcmo

CHANGELOG.md

@@ -43,7 +43,7 @@ All notable changes to this project will be documented in this file.
 * Clean up includes in application/systems
 * Switch camel_case to PascalCalse filenames
 * Downgrade cmake to version 3.22
-* Make unit test separate executeable
+* Make unit test separate executable
 * Move platform support code into executables
 * Switch from platform::atomic to std::atomic
 

README.md

@@ -73,7 +73,7 @@ describes Eclipse OpenBSW in detail and provides simple setup guides to build an
 
 ## Contributing
 
-It is expected that this respository will be used as a starting point for many custom developments.
+It is expected that this repository will be used as a starting point for many custom developments.
 You may wish to contribute back some of your work to this repository.
 For more details see [CONTRIBUTING](CONTRIBUTING.md).
 

doc/codingGuidelines/conventions/comments.rst

@@ -88,7 +88,7 @@ The following comment styles are allowed:
         bool isValid(uint32_t id);
 
   - It is common to omit the *\\brief* tag. The first sentence until the first "." or empty line
-    is treated as brief decription.
+    is treated as brief description.
   - If you use tags, use the backslash style, not the at-sign style (*\\return* vs. *@return*).
   - It is also okay to skip the doxygen comment completely for methods whose functionality,
     parameters and return value are obvious due to the declaration.
@@ -113,7 +113,7 @@ This includes extracting inlined functions and choosing good names.
     class BadTimeout
     {
     public:
-        static const uint8_t MAX_TIMEOUT = 128U; // unit is miliseconds
+        static const uint8_t MAX_TIMEOUT = 128U; // unit is milliseconds
 
         // ...
     };

doc/codingGuidelines/conventions/statements.rst

@@ -123,7 +123,7 @@ Additionally, C and C++ code can interpret NULL differently which leads to incom
 **Use nullptr!**
 
 Modern code should use ``nullptr`` instead of ``0`` or ``NULL`` to maximize readability and
-prevent suprising overload resolution outcomes between pointer and integral types.
+prevent surprising overload resolution outcomes between pointer and integral types.
 
 .. code-block:: cpp
 
@@ -229,7 +229,7 @@ Critical Sections
 
 | Avoid critical sections if possible by design. Sometimes this is not feasible, e.g. when accessing
   shared HW resources.
-| In these cases use a lock meachnism with the RAII pattern:
+| In these cases use a lock mechanism with the RAII pattern:
 
 .. code-block:: cpp
 
@@ -258,4 +258,4 @@ It is often hard to understand the values of delays. Explain the chosen values i
 Retries
 -------
 
-Document retries in the code or make it obvious by designing a clear API.
+Document retries in the code or make it obvious by designing a clear API.

doc/learning/hwio/index.rst

@@ -60,6 +60,6 @@ If you dive deeper, you will find that code under ``executables/referenceApp/pla
 sets up the configuration of the software for this board.
 In the ``main()`` function called at startup, the very first function called is ``StaticBsp::init()`` and this
 initializes the board as configured by the code under ``executables/referenceApp/platforms/s32k148evb/bspConfiguration/``.
-This makes use of resuable APIs defined for BSPs for many different boards and SOCs.
+This makes use of reusable APIs defined for BSPs for many different boards and SOCs.
 Explore this code to further understand how the board's hardware components are configured and then used.
 

doc/learning/layout/index.rst

@@ -27,7 +27,7 @@ You can view this as a map to regularly refer back to as you navigate and become
     |   └── s32k1xx
     └── tools
 
-``admin``: holds platform-specific build adapation files.
+``admin``: holds platform-specific build adaptation files.
 In particular the ``cmake`` subdirectory contains platform-specific settings for the build environment.
 
 ``doc``: holds some of the RST (reStructuredText) documentation files from which this documentation is built.

executables/referenceApp/platforms/s32k148evb/bspConfiguration/doc/user/bspAdc.rst

@@ -77,7 +77,7 @@ Example
     }
 
 This code snippet placed in the demo system could read the ADC value and store the scaled data in the
-variable `value` wth the context menu.
+variable `value` in the context menu.
 
 As per the demo, ADC channel is configured to read a value from internal potentiometer
 (``ADC0 - Channel_28``) available in the evaluation board. The value is then scaled to

executables/referenceApp/platforms/s32k148evb/main/doc/index.rst

@@ -12,9 +12,9 @@ The ``main`` module contains below sub-modules associated to S32k148:
 - startup : Startup code.
 - linker script file : Contains information about memory allocation
 - static BSP : system which controls BSP even before the lifecycle starts ("static")
-- Systems: system associcated to Board Support Package (BSP)
+- Systems: system associated to Board Support Package (BSP)
 
 See the user documentation for detailed information:
 
 .. toctree::
-    user/index
+    user/index

executables/referenceApp/platforms/s32k148evb/main/doc/user/systems/BspSystem.rst

@@ -6,7 +6,7 @@ BSP System
 The `BspSystem` class encapsulates the implementation of BSP management within the system
 architecture, residing within the `systems` namespace.
 
-BspSytem is low level module, that can be initialized after main.
+BspSystem is low level module, that can be initialized after main.
 
 This class offers functionalities for initializing, running, and shutting down the BSP system, as
 well as executing cyclic tasks and integrating with testing functionalities.

libs/bsp/bspCharInputOutput/include/charInputOutput/charIo.h

@@ -11,8 +11,8 @@ extern "C"
 using tCharIOApi = struct
 {
     void (*init)(void);
-    void (*setAsynchron)(void);
-    void (*setSynchron)(void);
+    void (*setAsynchronous)(void);
+    void (*setSynchronous)(void);
     int (*putc)(int c);
     int (*getc)(void);
     void (*Idle)(void);
@@ -37,12 +37,12 @@ int setCharIOApi2Default(void);
 /**
  * Make CharIO output asynchronous
  */
-void charIoSetAsynchron(void);
+void charIoSetAsynchronous(void);
 
 /**
  * Make CharIO output synchronous
  */
-void charIoSetSynchron(void);
+void charIoSetSynchronous(void);
 
 /**
  * CharIO idle task for asynchronous output