docs: fix misspelling across the tree

Found a few annoying typos and figured I better run script and
fix anything it can find, here are the results...

Signed-off-by: Anas Nashif <[email protected]>

Author: nashif

CMakeLists.txt

@@ -12,7 +12,7 @@
 # expect to learn how to build the kernel reading this file.
 
 if(NOT DEFINED ZEPHYR_BINARY_DIR)
-  message(FATAL_ERROR "A user error has occured.
+  message(FATAL_ERROR "A user error has occurred.
 cmake was invoked with '${CMAKE_CURRENT_LIST_DIR}' specified as the source directory,
 but it must be invoked with an application source directory,
 such as '${CMAKE_CURRENT_LIST_DIR}/samples/hello_world'.
@@ -39,7 +39,7 @@ project(Zephyr-Kernel VERSION ${PROJECT_VERSION})
 enable_language(C CXX ASM)
 
 # Verify that the toolchain can compile a dummy file, if it is not we
-# won't be able to test for compatiblity with certain C flags.
+# won't be able to test for compatibility with certain C flags.
 check_c_compiler_flag("" toolchain_is_ok)
 assert(toolchain_is_ok "The toolchain is unable to build a dummy C file. See CMakeError.log.")
 

Kconfig.zephyr

@@ -15,7 +15,7 @@ source "modules/Kconfig"
 endmenu
 
 # Include these first so that any properties (e.g. defaults) below can be
-# overriden in *.defconfig files (by defining symbols in multiple locations).
+# overridden in *.defconfig files (by defining symbols in multiple locations).
 # After merging all the symbol definitions, Kconfig picks the first property
 # (e.g. the first default) with a satisfied condition.
 #
@@ -63,7 +63,7 @@ config LINKER_ORPHAN_SECTION_PLACE
 config LINKER_ORPHAN_SECTION_WARN
 	bool "Warn"
 	help
-	  Linker places the orphan sections in ouput and issues
+	  Linker places the orphan sections in output and issues
 	  warning about those sections.
 
 config LINKER_ORPHAN_SECTION_ERROR

arch/Kconfig

@@ -9,7 +9,7 @@
 #
 
 # Include these first so that any properties (e.g. defaults) below can be
-# overriden (by defining symbols in multiple locations)
+# overridden (by defining symbols in multiple locations)
 
 # Note: $ARCH might be a glob pattern
 source "$(ARCH_DIR)/$(ARCH)/Kconfig"

arch/arm/core/cortex_m/prep_c.c

@@ -27,7 +27,7 @@
 /*
  * GCC can detect if memcpy is passed a NULL argument, however one of
  * the cases of relocate_vector_table() it is valid to pass NULL, so we
- * supress the warning for this case.  We need to do this before
+ * suppress the warning for this case.  We need to do this before
  * string.h is included to get the declaration of memcpy.
  */
 #pragma GCC diagnostic push

arch/nios2/core/crt0.S

@@ -134,7 +134,7 @@ SECTION_FUNC(TEXT, __start)
 #endif
 
 	/* TODO if shadow register sets enabled, interate through them to set
-	 * up. Need to clear r0, write gp, set the execption stack pointer
+	 * up. Need to clear r0, write gp, set the exception stack pointer
 	 * GH-1821
 	 */
 

arch/nios2/core/swap.S

@@ -175,7 +175,7 @@ no_unlock:
 SECTION_FUNC(TEXT, z_thread_entry_wrapper)
 	/* This all corresponds to struct init_stack_frame defined in
 	 * thread.c. We need to take this stuff off the stack and put
-	 * it in the apporpriate registers
+	 * it in the appropriate registers
 	 */
 
 	/* Can't return from here, just put NULL in ra */

arch/x86/core/ia32/irq_manage.c

@@ -228,7 +228,7 @@ static void *get_dynamic_stub(int stub_idx)
 	u32_t offset;
 
 	/*
-	 * Because we want the sizes of the stubs to be consisent and minimized,
+	 * Because we want the sizes of the stubs to be consistent and minimized,
 	 * stubs are grouped into blocks, each containing a push and subsequent
 	 * 2-byte jump instruction to the end of the block, which then contains
 	 * a larger jump instruction to common dynamic IRQ handling code

arch/x86/core/ia32/userspace.S

@@ -58,7 +58,7 @@ SECTION_FUNC(TEXT, z_x86_trampoline_to_kernel)
 
 	/* %esp = _kernel->current->stack_info.start
 	 *
-	 * This is the lowest address of the user mode stack, and higest
+	 * This is the lowest address of the user mode stack, and highest
 	 * address of the kernel stack, they are adjacent.
 	 * We want to transplant context here.
 	 */
@@ -166,7 +166,7 @@ SECTION_FUNC(TEXT, z_x86_syscall_entry_stub)
 
 	/* %esp = _kernel->current->stack_info.start
 	 *
-	 * This is the lowest address of the user mode stack, and higest
+	 * This is the lowest address of the user mode stack, and highest
 	 * address of the kernel stack, they are adjacent.
 	 * We want to transplant context here.
 	 */

arch/x86/core/ia32/x86_mmu.c

@@ -133,7 +133,7 @@ int z_arch_buffer_validate(void *addr, size_t size, int write)
 					MMU_PAGE_NUM((char *)addr + size - 1);
 			}
 
-			/* For all the pde's appart from the starting pde,
+			/* For all the pde's apart from the starting pde,
 			 * will have the start pte number as zero.
 			 */
 			if (pde != start_pde_num) {

arch/x86/gen_mmu_x86.py

@@ -245,7 +245,7 @@ def populate_required_structs(self):
 
             # In-case the start address aligns with a page table entry other
             # than zero and the mem_size is greater than (1024*4096) i.e 4MB
-            # in case where it overflows the currenty PDE's range then limit the
+            # in case where it overflows the current PDE's range then limit the
             # PTE to 1024 and so make the mem_size reflect the actual size
             # taken up in the current PDE
             if (size + (pte_valid_addr_start * 4096)) >= \
@@ -277,7 +277,7 @@ def populate_required_structs(self):
 
             # create all the extra PDEs needed to fit the requested size
             # this loop starts from the current pde till the last pde that is
-            # needed the last pde is calcualted as the (start_addr + size) >>
+            # needed the last pde is calculated as the (start_addr + size) >>
             # 22
             if overflow_size != 0:
                 for extra_pdpte in range(pdpte_index,
@@ -488,7 +488,7 @@ def read_mmu_list(mmu_list_data):
                             other_addr, other_end_addr))
                 sys.exit(2)
 
-        # add the retrived info another list
+        # add the retrieved info another list
         regions.append((addr, size, flags))
 
     return (pd_start_addr, regions)

arch/x86/include/kernel_arch_thread.h

@@ -190,7 +190,7 @@ typedef struct s_preempFloatReg {
 } tPreempFloatReg;
 
 /*
- * The thread control stucture definition.  It contains the
+ * The thread control structure definition.  It contains the
  * various fields to manage a _single_ thread. The TCS will be aligned
  * to the appropriate architecture specific boundary via the
  * z_new_thread() call.

arch/x86_64/core/x86_64-hw.h

@@ -183,7 +183,7 @@ struct apic_regs {
 
 #define _apic (*((volatile struct apic_regs *)0xfee00000ll))
 
-/* Crazy encoding for this, but susceptable to a formula.  Returns the
+/* Crazy encoding for this, but susceptible to a formula.  Returns the
  * DIVIDE_CONF register value that divides the input clock by 2^n (n
  * in the range 0-7).
  */

arch/x86_64/core/xuk.h

@@ -58,7 +58,7 @@ static inline void *xuk_get_g_ptr()
  *
  * + Values from 0x100 to 0x1ff are mapped to raw vectors 0x00-0xff
  *   and can be used for handling exceptions, for INT instructions, or
- *   for MSI- or IPI-directed interrupts that specifiy specific
+ *   for MSI- or IPI-directed interrupts that specify specific
  *   vectors.
  *
  * + Values outside this range may be exposed symbolically for other

arch/xtensa/core/xt_zephyr.S

@@ -227,7 +227,7 @@ _zxt_int_exit:
  * every timer interrupt.  Manages the tick timer and calls
  * xPortSysTickHandler() every tick.  See the detailed description of the
  * XT_RTOS_ENTER macro in xtensa_rtos.h.  Callable from C.  Implemented in
- * assmebly code for performance.
+ * assembly code for performance.
  *
  */
 	.globl  _zxt_timer_int

arch/xtensa/include/kernel_arch_thread.h

@@ -73,7 +73,7 @@ typedef struct s_preempCoprocReg {
 } tPreempCoprocReg;
 
 /*
- * The thread control stucture definition.  It contains the
+ * The thread control structure definition.  It contains the
  * various fields to manage a _single_ thread.
  */
 struct _thread_arch {

arch/xtensa/include/xtensa_context.h

@@ -178,7 +178,7 @@ STRUCT_END(XtSolFrame)
  * otherwise a thread retains ownership of the co-processor even when it loses
  * control of the processor. An Xtensa co-processor exception is triggered when
  * any co-processor instruction is executed by a thread that is not the owner,
- * and the context switch of that co-processor is then peformed by the handler.
+ * and the context switch of that co-processor is then performed by the handler.
  * Ownership represents which thread's state is currently in the co-processor.
  *
  * Co-processors may not be used by interrupt or exception handlers. If a

boards/arm/nrf52_pca20020/board.c

@@ -40,7 +40,7 @@ static int pwr_ctrl_init(struct device *dev)
  * from the VDD power rail. Both of these power rails need to be enabled before
  * the sensor driver init can be performed. The VDD rail also has to be powered up
  * before the CCS_VDD rail. These checks are to enforce the power up sequence
- * constraits.
+ * constraints.
  */
 
 #if CONFIG_BOARD_VDD_PWR_CTRL_INIT_PRIORITY <= CONFIG_GPIO_NRF_INIT_PRIORITY

boards/arm/v2m_beetle/pinmux.c

@@ -99,21 +99,21 @@ static void arm_v2m_beetle_pinmux_defaults(void)
 
 	/* Set GPIO Alternate Functions */
 
-	gpio_0 = (1<<0); /* Sheild 0 UART 0 RXD */
-	gpio_0 |= (1<<1); /* Sheild 0 UART 0 TXD */
-	gpio_0 |= (1<<14); /* Sheild 0 I2C SDA SBCON2 */
-	gpio_0 |= (1<<15); /* Sheild 0 I2C SCL SBCON2 */
-	gpio_0 |= (1<<10); /* Sheild 0 SPI_3 nCS */
-	gpio_0 |= (1<<11); /* Sheild 0 SPI_3 MOSI */
-	gpio_0 |= (1<<12); /* Sheild 0 SPI_3 MISO */
-	gpio_0 |= (1<<13); /* Sheild 0 SPI_3 SCK */
+	gpio_0 = (1<<0); /* Shield 0 UART 0 RXD */
+	gpio_0 |= (1<<1); /* Shield 0 UART 0 TXD */
+	gpio_0 |= (1<<14); /* Shield 0 I2C SDA SBCON2 */
+	gpio_0 |= (1<<15); /* Shield 0 I2C SCL SBCON2 */
+	gpio_0 |= (1<<10); /* Shield 0 SPI_3 nCS */
+	gpio_0 |= (1<<11); /* Shield 0 SPI_3 MOSI */
+	gpio_0 |= (1<<12); /* Shield 0 SPI_3 MISO */
+	gpio_0 |= (1<<13); /* Shield 0 SPI_3 SCK */
 
 	CMSDK_AHB_GPIO0_DEV->altfuncset = gpio_0;
 
 	gpio_1 = (1<<0); /* UART 1 RXD */
 	gpio_1 |= (1<<1); /* UART 1 TXD */
-	gpio_1 |= (1<<6); /* Sheild 1 I2C SDA */
-	gpio_1 |= (1<<7); /* Sheild 1 I2C SCL */
+	gpio_1 |= (1<<6); /* Shield 1 I2C SDA */
+	gpio_1 |= (1<<7); /* Shield 1 I2C SCL */
 	gpio_1 |= (1<<2); /* ADC SPI_1 nCS */
 	gpio_1 |= (1<<3); /* ADC SPI_1 MOSI */
 	gpio_1 |= (1<<4); /* ADC SPI_1 MISO */

boards/posix/nrf52_bsim/CMakeLists.txt

@@ -2,13 +2,13 @@
 
 if (NOT DEFINED ENV{BSIM_COMPONENTS_PATH})
 	message(FATAL_ERROR "This board requires the BabbleSim simulator. Please set\
- the  enviroment variable BSIM_COMPONENTS_PATH to point to its components \
+ the  environment variable BSIM_COMPONENTS_PATH to point to its components \
  folder. More information can be found in\
  https://babblesim.github.io/folder_structure_and_env.html")
 endif()
 if (NOT DEFINED ENV{BSIM_OUT_PATH})
 	message(FATAL_ERROR "This board requires the BabbleSim simulator. Please set\
- the enviroment variable BSIM_OUT_PATH to point to the folder where the\
+ the environment variable BSIM_OUT_PATH to point to the folder where the\
  simulator is compiled to. More information can be found in\
  https://babblesim.github.io/folder_structure_and_env.html")
 endif()

boards/xtensa/intel_s1000_crb/support/messenger.py

@@ -160,7 +160,7 @@ def create_memread_cmd(self, tuple):
 
     def create_loadfw_cmd(self, size, sha):
         """
-        Creates a command to load firmware with associated paramters
+        Creates a command to load firmware with associated parameters
         """
         cmd = 'Load Firmware'
         print('CMD >>> %s.' % cmd)

cmake/extensions.cmake

@@ -332,7 +332,7 @@ endmacro()
 # or zephyr_library_named. The constructors create a CMake library
 # with a name accessible through the variable ZEPHYR_CURRENT_LIBRARY.
 #
-# The variable ZEPHYR_CURRENT_LIBRARY should seldomly be needed since
+# The variable ZEPHYR_CURRENT_LIBRARY should seldom be needed since
 # the zephyr libraries have methods that modify the libraries. These
 # methods have the signature: zephyr_library_<target-function>
 #
@@ -830,7 +830,7 @@ endfunction()
 #    _mysection_size = ABSOLUTE(_mysection_end - _mysection_start);
 #
 # When placing into SECTIONS or RAM_SECTIONS, the files must instead define
-# their own output sections to acheive the same thing:
+# their own output sections to achieve the same thing:
 #    SECTION_PROLOGUE(.mysection,,)
 #    {
 #        _mysection_start = .;
@@ -1336,7 +1336,7 @@ endmacro()
 #   assert_not(OBSOLETE_VAR "OBSOLETE_VAR has been removed; use NEW_VAR instead")
 #
 # will cause a FATAL_ERROR and print an error message if the first
-# espression is true
+# expression is true
 macro(assert_not test comment)
   if(${test})
     message(FATAL_ERROR "Assertion failed: ${comment}")

cmake/linker/ld/target_baremetal.cmake

@@ -26,7 +26,7 @@ macro(toolchain_ld_baremetal)
   #
   # CONFIG_LINKER_ORPHAN_SECTION_PLACE is to place the orphan sections
   # without any warnings or errors, which is the default behavior.
-  # So there is no need to explicity set a linker flag.
+  # So there is no need to explicitly set a linker flag.
   if(CONFIG_LINKER_ORPHAN_SECTION_WARN)
     zephyr_ld_options(
       ${LINKERFLAGPREFIX},--orphan-handling=warn

cmake/toolchain/cross-compile/generic.cmake

@@ -9,7 +9,7 @@
 #
 # New users should set the env var 'ZEPHYR_TOOLCHAIN_VARIANT' to
 # 'cross-compile' and the 'CROSS_COMPILE' env var to the toolchain
-# prefix. This interface is consisent with the other non-"Zephyr SDK"
+# prefix. This interface is consistent with the other non-"Zephyr SDK"
 # toolchains.
 #
 # It can be set from either the environment or from a CMake variable

cmake/toolchain/xtools/generic.cmake

@@ -11,7 +11,7 @@ set(LINKER ld)
 
 # Choose one of the toolchains in 'TOOLCHAIN_HOME' at random to use as
 # a 'generic' toolchain until we know for sure which toolchain we
-# should use. Note that we can't use ARCH to distingush between
+# should use. Note that we can't use ARCH to distinguish between
 # toolchains because choosing between iamcu and non-iamcu is dependent
 # on Kconfig, not ARCH.
 file(GLOB toolchain_paths ${TOOLCHAIN_HOME}/*)

doc/guides/bluetooth/bluetooth-arch.rst

@@ -13,7 +13,7 @@ stack.
    Zephyr supports mainly Bluetooth Low Energy (BLE), the low-power
    version of the Bluetooth specification. Zephyr also has limited support
    for portions of the BR/EDR Host. Throughout this architecture document we
-   use BLE interchangably for Bluetooth except when noted.
+   use BLE interchangeably for Bluetooth except when noted.
 
 .. _bluetooth-layers:
 

doc/guides/porting/board_porting.rst

@@ -247,7 +247,7 @@ works like ``if y`` (is always satisfied).
 .. note::
 
     ``range`` properties on ``int`` and ``hex`` symbols work the same way, and
-    can also be added or overriden in :file:`Kconfig.defconfig` files.
+    can also be added or overridden in :file:`Kconfig.defconfig` files.
 
 If you want a symbol to only be user-configurable on some boards, make its base
 definition have no prompt, and then add a prompt to it in the

doc/reference/bluetooth/gatt.rst

@@ -62,7 +62,7 @@ Client procedures can be enabled with the configuration option:
 
 Discover procedures can be initiated with the use of
 :cpp:func:`bt_gatt_discover` API which takes the
-:cpp:class:`bt_gatt_dicover_params` struct which describes the type of
+:cpp:class:`bt_gatt_discover_params` struct which describes the type of
 discovery. The parameters also serves as a filter when setting the ``uuid``
 field only attributes which matches will be discovered, in contrast setting it
 to NULL allows all attributes to be discovered.

doc/reference/networking/coap.rst

@@ -67,7 +67,7 @@ An application reads data from the socket and passes the buffer to the CoAP libr
 to parse the message. If the CoAP message is proper, the library uses the buffer
 along with resources defined above to call the correct callback function
 to handle the CoAP request from the client. It's the callback function's
-responsibilty to either reply or act according to CoAP request.
+responsibility to either reply or act according to CoAP request.
 
 .. code-block:: c
 

doc/releases/release-notes-1.11.rst

@@ -346,7 +346,7 @@ release:
 * :github:`5370` - [Coverity CID: 180699] Error handling issues in /tests/bluetooth/tester/src/gatt.c
 * :github:`5374` - merge_config.sh can behave differently from merge_config.py
 * :github:`5379` - sample: net/socket/http_get: no printf output
-* :github:`5382` - P2P Device Firwmare Update (FOTA) over BLE and Serial
+* :github:`5382` - P2P Device Firmware Update (FOTA) over BLE and Serial
 * :github:`5391` - drivers: stm32 clock control: F0 Series with PREDIV1 Support uses wrong PLLSOURCE define for HSI clock
 * :github:`5401` - delta_ticks_from_prev become negative and waiting tasks never scheduled
 * :github:`5406` - UART1 on STM32F0 Series not working: errors in makro to enable clock
@@ -382,7 +382,7 @@ release:
 * :github:`5576` - None of the :github:'XYZ' links work in the 1.10 release notes
 * :github:`5589` - Issue with using generic gcc cross compile with cmake
 * :github:`5601` - docs for cc3220sf_launchxl are out of date/incorrect
-* :github:`5608` - Bluetooth LE continous scan weird behaviour
+* :github:`5608` - Bluetooth LE continuous scan weird behaviour
 * :github:`5619` - zephyr.git/tests/misc/test_build/testcase.yaml#test_newlib @ esp32:xtensa BUILD failed
 * :github:`5626` - Building samples failed
 * :github:`5640` - MacOS compile error with -std=gnu89

doc/releases/release-notes-1.12.rst

@@ -264,7 +264,7 @@ Documentation
 * Added description for kernel test cases through extensive doxygen comments
 * Discovered some API docs were missing, and fixed
 * Documentation added covering system calls and userspace, kernel, and
-  threading APIs, POSIX compability, VLANs, network traffic
+  threading APIs, POSIX compatibility, VLANs, network traffic
   classification, and the sanitycheck script used by CI.
 * Documented writing guidelines and local doc generation process
 * Improved Sphinx search results output (removed markup)
@@ -649,7 +649,7 @@ These GitHub issues were closed since the previous 1.11.0 tagged release:
 * :github:`7480` - pthread_attr_init( ) does not conform to POSIX specification
 * :github:`7482` - [Coverity CID :185523]  Out-of-bounds read in lsm6dsl driver
 * :github:`7495` - cmake: extensions: ToolchainCapabilityDatabase.cmake parse error in shippable
-* :github:`7500` - DHCP: when CONFIG_NET_APP_MY_IPV4_ADDR is IP stack needs to rebind on DHCP aquire
+* :github:`7500` - DHCP: when CONFIG_NET_APP_MY_IPV4_ADDR is IP stack needs to rebind on DHCP acquire
 * :github:`7508` - [Coverity CID :185523] Memory - illegal accesses in /drivers/sensor/lsm6dsl/lsm6dsl.c
 * :github:`7511` - [Coverity CID :185391] Incorrect expression in /tests/lib/rbtree/src/main.c
 * :github:`7519` - Verify CODEOWNERS (not) including subfolders is intended