From 512dc9ff38d8dad84b340712e71a20185fe59819 Mon Sep 17 00:00:00 2001 From: Pisit Sawangvonganan Date: Fri, 26 Jan 2024 00:52:04 +0700 Subject: [PATCH] doc: fix typo in multiple directories (build, hardware, kernel, project) Utilize a code spell-checking tool to scan for and correct spelling errors in all files within the doc/build, hardware, kernel, project directory. Signed-off-by: Pisit Sawangvonganan --- doc/hardware/peripherals/gnss.rst | 2 +- doc/hardware/peripherals/i3c.rst | 2 +- doc/kernel/drivers/device_driver_model.svg | 2 +- doc/kernel/memory_management/heap.rst | 2 +- doc/kernel/services/smp/smp.rst | 2 +- doc/project/dev_env_and_tools.rst | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/hardware/peripherals/gnss.rst b/doc/hardware/peripherals/gnss.rst index fb750358dc..bcc40e540a 100644 --- a/doc/hardware/peripherals/gnss.rst +++ b/doc/hardware/peripherals/gnss.rst @@ -27,7 +27,7 @@ requires little more than implementing power management and configuration for the specific GNSS modem. Adding support for GNSS modems which use other protocols and/or -busses than the usual NMEA0183 over UART is possible, but will +buses than the usual NMEA0183 over UART is possible, but will require a bit more work from the driver developer. Configuration Options diff --git a/doc/hardware/peripherals/i3c.rst b/doc/hardware/peripherals/i3c.rst index 4ffb6dd45e..347d8944ef 100644 --- a/doc/hardware/peripherals/i3c.rst +++ b/doc/hardware/peripherals/i3c.rst @@ -303,7 +303,7 @@ the controller. I\ :sup:`2`\ C Devices under I3C Bus ==================================== -Since I3C is backware compatible with I\ :sup:`2`\ C, the I3C controller +Since I3C is backward compatible with I\ :sup:`2`\ C, the I3C controller API can accommodate I2C API calls without modifications if the controller device driver implements the I2C API. This has the advantage of using existing I2C devices without any modifications to their device drivers. diff --git a/doc/kernel/drivers/device_driver_model.svg b/doc/kernel/drivers/device_driver_model.svg index 9ace8badff..fe779232ee 100644 --- a/doc/kernel/drivers/device_driver_model.svg +++ b/doc/kernel/drivers/device_driver_model.svg @@ -1,3 +1,3 @@ -
struct device {
    const struct config *config;
    const void *api;
    void * const data;
};

struct config {...};
[Not supported by viewer]
Instance 2 of Device Driver 1
Instance 2 of Device Driver 1
Instance 1 of Device Driver 1
Instance 1 of Device Driver 1
struct device {
    const struct config *config;
    const void *api;
    void * const data;
};

struct config {...};
[Not supported by viewer]
Generic
Type API
[Not supported by viewer]
API 1
API 1
API 2
API 2
API 3
API 3
Device Driver 1
[Not supported by viewer]
API Impl 1
API Impl 1
API Impl 2
API Impl 2
API Impl 3
API Impl 3
Subsytem 1
Subsytem 1
Device Driver APIs
Device Driver APIs
Device Driver Instances
Device Driver Instances
Device Driver Implementations
Device Driver Implementations
Device Driver 2
[Not supported by viewer]
API Impl 1
API Impl 1
API Impl 2
API Impl 2
API Impl 3
API Impl 3
Subsytem 2
[Not supported by viewer]
Device Driver 3
[Not supported by viewer]
API Impl 1
API Impl 1
API Impl 2
API Impl 2
API Impl 3
API Impl 3
Generic
Type API
[Not supported by viewer]
API 1
API 1
API 2
API 2
API 3
API 3
Instance 1 of Device Driver 2
Instance 1 of Device Driver 2
struct device {
    const struct config *config;
    const void *api;
    void * const data;
};

struct config {...};
[Not supported by viewer]
struct device {
    const struct config *config;
    const void *api;
    void * const data;
};

struct config {...};
[Not supported by viewer]
Instance 1 of Device Driver 3
Instance 1 of Device Driver 3
Application
Application +
struct device {
    const struct config *config;
    const void *api;
    void * const data;
};

struct config {...};
[Not supported by viewer]
Instance 2 of Device Driver 1
Instance 2 of Device Driver 1
Instance 1 of Device Driver 1
Instance 1 of Device Driver 1
struct device {
    const struct config *config;
    const void *api;
    void * const data;
};

struct config {...};
[Not supported by viewer]
Generic
Type API
[Not supported by viewer]
API 1
API 1
API 2
API 2
API 3
API 3
Device Driver 1
[Not supported by viewer]
API Impl 1
API Impl 1
API Impl 2
API Impl 2
API Impl 3
API Impl 3
Subsystem 1
Subsystem 1
Device Driver APIs
Device Driver APIs
Device Driver Instances
Device Driver Instances
Device Driver Implementations
Device Driver Implementations
Device Driver 2
[Not supported by viewer]
API Impl 1
API Impl 1
API Impl 2
API Impl 2
API Impl 3
API Impl 3
Subsystem 2
[Not supported by viewer]
Device Driver 3
[Not supported by viewer]
API Impl 1
API Impl 1
API Impl 2
API Impl 2
API Impl 3
API Impl 3
Generic
Type API
[Not supported by viewer]
API 1
API 1
API 2
API 2
API 3
API 3
Instance 1 of Device Driver 2
Instance 1 of Device Driver 2
struct device {
    const struct config *config;
    const void *api;
    void * const data;
};

struct config {...};
[Not supported by viewer]
struct device {
    const struct config *config;
    const void *api;
    void * const data;
};

struct config {...};
[Not supported by viewer]
Instance 1 of Device Driver 3
Instance 1 of Device Driver 3
Application
Application diff --git a/doc/kernel/memory_management/heap.rst b/doc/kernel/memory_management/heap.rst index 7dd332464d..a52c5ff77c 100644 --- a/doc/kernel/memory_management/heap.rst +++ b/doc/kernel/memory_management/heap.rst @@ -175,7 +175,7 @@ will be ignored and the minimum value will be used instead. To force a smaller than minimum value to be used, the application may enable the :kconfig:option:`CONFIG_HEAP_MEM_POOL_IGNORE_MIN` option. This can be useful when optimizing the heap size and the minimum requirement can be more accurately -determined for a speficic application. +determined for a specific application. Allocating Memory ================= diff --git a/doc/kernel/services/smp/smp.rst b/doc/kernel/services/smp/smp.rst index 0f1e29c9f1..0a94ed022b 100644 --- a/doc/kernel/services/smp/smp.rst +++ b/doc/kernel/services/smp/smp.rst @@ -302,7 +302,7 @@ registers only when :c:func:`arch_switch` is called to minimize context switching latency. Such architectures must use NULL as the argument to :c:func:`z_get_next_switch_handle` to determine if there is a new thread to schedule, and follow through with their own :c:func:`arch_switch` or -derrivative if so, or directly leave interrupt mode otherwise. +derivative if so, or directly leave interrupt mode otherwise. In the former case it is up to that switch code to store the handle resulting from the thread that is being switched out in that thread's "switch_handle" field after its context has fully been saved. diff --git a/doc/project/dev_env_and_tools.rst b/doc/project/dev_env_and_tools.rst index 3d7e5fd4bb..1678a455f1 100644 --- a/doc/project/dev_env_and_tools.rst +++ b/doc/project/dev_env_and_tools.rst @@ -323,7 +323,7 @@ Fix for an issue blocking development. * *Maintainer* -Maintainer review reqiured. +Maintainer review required. * *Security Review*