From f5ea8fec37a31de61a10d37c1ba381aa945f649c Mon Sep 17 00:00:00 2001 From: "David B. Kinder" Date: Mon, 27 Feb 2017 13:15:43 -0800 Subject: [PATCH] doc: fix more spelling errors throughout docs Change-Id: Ie76b51a3d0729159fa30c1fc9160b279d9f70b6c Signed-off-by: David B. Kinder --- doc/README.rst | 4 ++-- doc/application/application.rst | 2 +- doc/crypto/tinycrypt.rst | 2 +- doc/drivers/drivers.rst | 6 +++--- doc/getting_started/getting_started.rst | 2 +- doc/getting_started/installation_mac.rst | 2 +- doc/getting_started/installation_win.rst | 2 +- doc/glossary.rst | 2 +- doc/porting/application.rst | 2 +- doc/porting/arch.rst | 2 +- doc/release-notes.rst | 12 ++++++------ doc/subsystems/bluetooth/bluetooth.rst | 4 ++-- doc/subsystems/bluetooth/gap-pics.rst | 6 +++--- doc/subsystems/bluetooth/gatt-pics.rst | 4 ++-- doc/subsystems/c_library.rst | 2 +- doc/subsystems/logging/kernel_event_logger.rst | 2 +- doc/subsystems/logging/system_log.rst | 2 +- doc/subsystems/networking/buffers.rst | 2 +- doc/subsystems/networking/ip-stack-migrate.rst | 8 ++++---- doc/subsystems/networking/networking-api-usage.rst | 2 +- doc/subsystems/networking/overview.rst | 2 +- doc/subsystems/networking/qemu_setup.rst | 2 +- doc/subsystems/shell.rst | 4 ++-- 23 files changed, 39 insertions(+), 39 deletions(-) diff --git a/doc/README.rst b/doc/README.rst index 3dcbc4a0828..e3ccee52e8c 100644 --- a/doc/README.rst +++ b/doc/README.rst @@ -18,10 +18,10 @@ Documentation Notes Zephyr Project content is written using the reStructuredText markup language (.rst file extension) with Sphinx extensions, and processed using sphinx to -create a formatted standalone website. Developers can view this content either +create a formatted stand-alone website. Developers can view this content either in its raw form as .rst markup files, or you can generate the HTML content and view it with a web browser directly on your workstations drive. This same .rst -content is also fed into the Zephyr Project'ns public website documentation area +content is also fed into the Zephyr Project's public website documentation area (with a different theme applied). You can read details about reStructuredText and about Sphinx extensions from diff --git a/doc/application/application.rst b/doc/application/application.rst index 31e879aba79..1385279bff0 100644 --- a/doc/application/application.rst +++ b/doc/application/application.rst @@ -398,7 +398,7 @@ entries manually, using the configuration menu is a preferred method. .. note:: - When a non-default entry is selected for options that are nonnumerical, + When a non-default entry is selected for options that are non-numerical, an asterisk :kbd:`*` appears between the square brackets in the display. There is nothing added added the display when you select the option's default. diff --git a/doc/crypto/tinycrypt.rst b/doc/crypto/tinycrypt.rst index 6bcea3a344e..988e4717e87 100644 --- a/doc/crypto/tinycrypt.rst +++ b/doc/crypto/tinycrypt.rst @@ -217,7 +217,7 @@ Specific Remarks * TinyCrypt ECC implementation is based on nano-ecc (see https://github.com/iSECPartners/nano-ecc) which in turn is based on - mciro-ecc (see https://github.com/kmackay/micro-ecc). In the original + micro-ecc (see https://github.com/kmackay/micro-ecc). In the original nano and micro-ecc documentation, there is an important remark about the way integers are represented: diff --git a/doc/drivers/drivers.rst b/doc/drivers/drivers.rst index 197f829c41d..177e5348c70 100644 --- a/doc/drivers/drivers.rst +++ b/doc/drivers/drivers.rst @@ -49,7 +49,7 @@ Zephyr provides a set of device drivers for multiple boards. Each driver should support an interrupt-based implementation, rather than polling, unless the specific hardware does not provide any interrupt. -High-level calls accessed through devices's specific API, such as i2c.h +High-level calls accessed through device-specific APIs, such as i2c.h or spi.h, are usually intended as synchronous. Thus, these calls should be blocking. @@ -147,7 +147,7 @@ the normal course of operation (such as a storage device full). Bad parameters, programming errors, consistency checks, pathological/unrecoverable failures, etc., should be handled by assertions. -When it is appropriate to return error condtitions for the caller to check, 0 +When it is appropriate to return error conditions for the caller to check, 0 should be returned on success and a POSIX errno.h code returned on failure. See https://wiki.zephyrproject.org/view/Coding_conventions#Return_Codes for details about this. @@ -280,7 +280,7 @@ executed. Any driver will specify one of five initialization levels: `PRE_KERNEL_2` Used for devices that rely on the initialization of devices initialized as part of the PRIMARY level. These devices cannot use any kernel - services during configuration, since the kerne services are not yet + services during configuration, since the kernel services are not yet available. Init functions at this level run on the interrupt stack. `POST_KERNEL` diff --git a/doc/getting_started/getting_started.rst b/doc/getting_started/getting_started.rst index 38f617ffeab..89ee75a1ff2 100644 --- a/doc/getting_started/getting_started.rst +++ b/doc/getting_started/getting_started.rst @@ -78,7 +78,7 @@ To build an example application follow these steps: $ cd zephyr-project -#. Source the project environment file to set the project environtment +#. Source the project environment file to set the project environment variables: .. code-block:: console diff --git a/doc/getting_started/installation_mac.rst b/doc/getting_started/installation_mac.rst index ab44e67985a..fab63977e13 100644 --- a/doc/getting_started/installation_mac.rst +++ b/doc/getting_started/installation_mac.rst @@ -94,7 +94,7 @@ Setting Up the Toolchain Creating a Case-sensitive File System ===================================== -Building the compiler requires a case-senstive file system. Therefore, use +Building the compiler requires a case-sensitive file system. Therefore, use :program:`diskutil` to create an 8 GB blank sparse image making sure you select case-sensitive file system (OS X Extended (Case-sensitive, Journaled) and mount it. diff --git a/doc/getting_started/installation_win.rst b/doc/getting_started/installation_win.rst index 31b5f7085f3..3f2244b36f5 100644 --- a/doc/getting_started/installation_win.rst +++ b/doc/getting_started/installation_win.rst @@ -36,7 +36,7 @@ for native Windows applications. The Zephyr build system will execute on top of this tool set. To install :program:`MinGW`, visit the site `MinGW Home`_ and install the -following packages with their installler `mingw-get-setup.exe`: +following packages with their installer `mingw-get-setup.exe`: * mingw-developer-toolkit * mingw32-base diff --git a/doc/glossary.rst b/doc/glossary.rst index 28a49e70acb..900d91685b2 100644 --- a/doc/glossary.rst +++ b/doc/glossary.rst @@ -66,4 +66,4 @@ Glossary of Terms XIP (eXecute In Place) a method of executing programs directly from long term storage rather than copying it into RAM, saving writable memory for - dynamic data and not the staic program code. + dynamic data and not the static program code. diff --git a/doc/porting/application.rst b/doc/porting/application.rst index 5eb53f18379..f66a7617315 100644 --- a/doc/porting/application.rst +++ b/doc/porting/application.rst @@ -8,7 +8,7 @@ Legacy Applications Porting Guide This document is still work in progress. -This guide will help you move your applications from the nanokerne/microkernel +This guide will help you move your applications from the nanokernel/microkernel model to the unified kernel. The unified kernel was introduced with :ref:`zephyr_1.6` which was released late 2016. diff --git a/doc/porting/arch.rst b/doc/porting/arch.rst index e0a122711f2..0f6f31fd4c5 100644 --- a/doc/porting/arch.rst +++ b/doc/porting/arch.rst @@ -83,7 +83,7 @@ When a device wants to signal the processor that there is some work to be done on its behalf, it raises an interrupt. When a thread does an operation that is not handled by the serial flow of the software itself, it raises an exception. Both, interrupts and exceptions, pass control to a handler. The handler is -knowns as an :abbr:`ISR (Interrupt Service Routine)` in the case of +known as an :abbr:`ISR (Interrupt Service Routine)` in the case of interrupts. The handler perform the work required the exception or the interrupt. For interrupts, that work is device-specific. For exceptions, it depends on the exception, but most often the core kernel itself is responsible diff --git a/doc/release-notes.rst b/doc/release-notes.rst index 151816df5fc..773b1b6bc67 100644 --- a/doc/release-notes.rst +++ b/doc/release-notes.rst @@ -64,7 +64,7 @@ Boards * Renamed board Quark SE devboard to Quark SE C1000 devboard. * Renamed board Quark SE SSS devboard to Quark SE C1000 SS devboard. -* Quark SE C1000: Disabled IPM and enabled UART0 on the Sensor SubSytem. +* Quark SE C1000: Disabled IPM and enabled UART0 on the Sensor Subsystem. * Removed basic_cortex_m3 and basic_minuteia boards. * Arduino 101: Removed backup/restore scripts. To restore original bootloader use flashpack utility instead. @@ -235,7 +235,7 @@ JIRA Related Items * :jira:`ZEP-926` - API changes to memory pools * :jira:`ZEP-927` - API changes to memory maps * :jira:`ZEP-928` - API changes to event handling -* :jira:`ZEP-930` - Cutover to unified kernel +* :jira:`ZEP-930` - Cut over to unified kernel * :jira:`ZEP-933` - Unified kernel ARC port * :jira:`ZEP-934` - NIOS_II port * :jira:`ZEP-935` - Kernel logger support (validation) @@ -303,12 +303,12 @@ JIRA Related Items * :jira:`ZEP-940` - Fail to get ATT response * :jira:`ZEP-950` - USB: Device is not listed by USB20CV test suite * :jira:`ZEP-961` - samples: other cases cannot execute after run aon_counter case -* :jira:`ZEP-967` - Sanity doesnt build 'samples/usb/dfu' with assertions (-R) -* :jira:`ZEP-970` - Sanity doesnt build 'tests/kernel/test_build' with assertions (-R) +* :jira:`ZEP-967` - Sanity doesn't build 'samples/usb/dfu' with assertions (-R) +* :jira:`ZEP-970` - Sanity doesn't build 'tests/kernel/test_build' with assertions (-R) * :jira:`ZEP-982` - Minimal libc has EWOULDBLOCK != EAGAIN * :jira:`ZEP-1014` - [TCF] tests/bluetooth/init build fail * :jira:`ZEP-1025` - Unified kernel build sometimes breaks on a missing .d dependency file. -* :jira:`ZEP-1027` - Doccumentation for GCC ARM is not accurate +* :jira:`ZEP-1027` - Documentation for GCC ARM is not accurate * :jira:`ZEP-1031` - qmsi: dma: driver test fails with LLVM * :jira:`ZEP-1048` - grove_lcd sample: sample does not work if you disable serial * :jira:`ZEP-1051` - mpool allocation failed after defrag twice... @@ -323,7 +323,7 @@ JIRA Related Items * :jira:`ZEP-1101` - SYS_KERNEL_VER_PATCHLEVEL() and friends artificially limit version numbers to 4 bits * :jira:`ZEP-1124` - tests/kernel/test_sprintf/microkernel/testcase.ini#test failure on frdm_k64f * :jira:`ZEP-1130` - region 'RAM' overflowed occurs while building test_hmac_prng -* :jira:`ZEP-1138` - Recived packets not being passed to upper layer from IP stack when using ENC28J60 driver +* :jira:`ZEP-1138` - Received packets not being passed to upper layer from IP stack when using ENC28J60 driver * :jira:`ZEP-1139` - Fix build error when power management is built with unified kernel * :jira:`ZEP-1141` - Tinycrypt SHA256 test fails with system crash using unified kernel type * :jira:`ZEP-1144` - Tinycrypt AES128 fixed-key with variable-text test fails using unified kernel type diff --git a/doc/subsystems/bluetooth/bluetooth.rst b/doc/subsystems/bluetooth/bluetooth.rst index 9ef19e57792..a7cf28385b5 100644 --- a/doc/subsystems/bluetooth/bluetooth.rst +++ b/doc/subsystems/bluetooth/bluetooth.rst @@ -3,14 +3,14 @@ Bluetooth ######### -Zephyr comes integrated with a feature-rich and higly configurable +Zephyr comes integrated with a feature-rich and highly configurable Bluetooth stack: * Bluetooth 4.2 compliant * Bluetooth Controller support (LE Link Layer) - * Currently supports Nordic Semconductor nRF51 and nRF52 + * Currently supports Nordic Semiconductor nRF51 and nRF52 * Generic Access Profile (GAP) with all possible roles diff --git a/doc/subsystems/bluetooth/gap-pics.rst b/doc/subsystems/bluetooth/gap-pics.rst index bb2f7ed05bb..6e48cb4eb83 100644 --- a/doc/subsystems/bluetooth/gap-pics.rst +++ b/doc/subsystems/bluetooth/gap-pics.rst @@ -462,9 +462,9 @@ TSPC_GAP_27_3 False (*) Peripheral Privacy Flag (C.1) TSPC_GAP_27_4 False (*) Reconnection Address (C.2) TSPC_GAP_27_5 False (*) Peripheral Preferred Connection Parameters (C.3) -TSPC_GAP_27_6 True Writeable Device Name (C.3) -TSPC_GAP_27_7 True Writeable Appearance (C.3) -TSPC_GAP_27_8 False (*) Writeable Peripheral Privacy Flag (C.4) +TSPC_GAP_27_6 True Writable Device Name (C.3) +TSPC_GAP_27_7 True Writable Appearance (C.3) +TSPC_GAP_27_8 False (*) Writable Peripheral Privacy Flag (C.4) ============== ============== ======================================= diff --git a/doc/subsystems/bluetooth/gatt-pics.rst b/doc/subsystems/bluetooth/gatt-pics.rst index 292fdb317d6..ffadaa9ed60 100644 --- a/doc/subsystems/bluetooth/gatt-pics.rst +++ b/doc/subsystems/bluetooth/gatt-pics.rst @@ -217,8 +217,8 @@ TSPC_GATT_4B_38 True Server: Characteristic Format: struct (M) =============== =========== ============================================ -Generic Attribute Profile Service - SDP Inteoperability -******************************************************* +Generic Attribute Profile Service - SDP Interoperability +******************************************************** ============== =========== ============================================ Parameter Name Selected Description diff --git a/doc/subsystems/c_library.rst b/doc/subsystems/c_library.rst index 9b83e76e50f..390ed11def3 100644 --- a/doc/subsystems/c_library.rst +++ b/doc/subsystems/c_library.rst @@ -11,7 +11,7 @@ Applications that require a more extensive C library can either submit contributions that enhance the existing library or substitute with a replacement library. -The Zephyr SDK and other supported toolchains comes with a baremetal C library +The Zephyr SDK and other supported toolchains comes with a bare-metal C library based on ``newlib`` that can be used with Zephyr by selecting the :option:`CONFIG_NEWLIB_LIBC` in the application configuration file. Part of the support for ``newlib`` is a set of hooks available under diff --git a/doc/subsystems/logging/kernel_event_logger.rst b/doc/subsystems/logging/kernel_event_logger.rst index dd73a5eb17a..d2262f7ad33 100644 --- a/doc/subsystems/logging/kernel_event_logger.rst +++ b/doc/subsystems/logging/kernel_event_logger.rst @@ -24,7 +24,7 @@ The kernel event logger is capable of recording the following pre-defined event types: * Interrupts. -* Ccontext switching of threads. +* Context switching of threads. * Kernel sleep events (i.e. entering and exiting a low power state). The kernel event logger only records the pre-defined event types it has been diff --git a/doc/subsystems/logging/system_log.rst b/doc/subsystems/logging/system_log.rst index 7cee98db68b..4c4415cd4c2 100644 --- a/doc/subsystems/logging/system_log.rst +++ b/doc/subsystems/logging/system_log.rst @@ -9,7 +9,7 @@ defined in a generic way. This API can be deactivated through the Kconfig options, see :ref:`global_kconfig`. -This aproach prevents impacting image size and execution time when the system +This approach prevents impacting image size and execution time when the system log is not needed. Each of the four ``SYS_LOG_X`` macros correspond to a different logging level, diff --git a/doc/subsystems/networking/buffers.rst b/doc/subsystems/networking/buffers.rst index e88dd0b8fb8..0874a4b091d 100644 --- a/doc/subsystems/networking/buffers.rst +++ b/doc/subsystems/networking/buffers.rst @@ -28,7 +28,7 @@ buffers, rather this is done implicitly as :c:func:`net_buf_alloc` gets called. If there is a need to reserve space in the buffer for protocol headers -to be prependend later, it's possible to reserve this headroom with: +to be prepended later, it's possible to reserve this headroom with: .. code-block:: c diff --git a/doc/subsystems/networking/ip-stack-migrate.rst b/doc/subsystems/networking/ip-stack-migrate.rst index ae363e5f268..d8c7ec6e20c 100644 --- a/doc/subsystems/networking/ip-stack-migrate.rst +++ b/doc/subsystems/networking/ip-stack-migrate.rst @@ -26,15 +26,15 @@ migrate applications using the older v1.6 IP stack to the new v1.7 IP stack: at the same time. This means that applications can utilize concurrently e.g., IEEE 802.15.4 and Bluetooth IP networking. The different network technologies are abstracted to network interfaces and there can be multiple network - interaces in the system depending on configuration. + interfaces in the system depending on configuration. * **Network Kconfig options are changed.** Most of the networking configuration options are renamed. Please check the :ref:`networking` documentation for the new names. -* **All uIP based API's are gone.** Those API's were not public in v1.6 but - applications could call them anyway. These uIP API's were mainly used to set - IP address etc. management style operations. The new management API's can be +* **All uIP based APIs are gone.** Those APIs were not public in v1.6 but + applications could call them anyway. These uIP APIs were mainly used to set + IP address etc. management style operations. The new management APIs can be found in net_if.h and net_mgmt.h in Zephyr v1.7. * **Network buffer management is changed.** In earlier Zephyr versions, there diff --git a/doc/subsystems/networking/networking-api-usage.rst b/doc/subsystems/networking/networking-api-usage.rst index 1c520bb0f88..a980fa0983f 100644 --- a/doc/subsystems/networking/networking-api-usage.rst +++ b/doc/subsystems/networking/networking-api-usage.rst @@ -13,7 +13,7 @@ API is that the net_context API uses the fragmented network buffers (net_buf) defined in :file:`net/buf.h` and BSD socket API uses linear memory buffers. This example creates a simple server that listens to incoming UDP connections -and sends the received data back. You can downlow the example application +and sends the received data back. You can download the example application source file here `connectivity-example-app.c `_ This example application begins with some initialization. (Use this as an diff --git a/doc/subsystems/networking/overview.rst b/doc/subsystems/networking/overview.rst index ff001b2b53f..34382849b46 100644 --- a/doc/subsystems/networking/overview.rst +++ b/doc/subsystems/networking/overview.rst @@ -10,7 +10,7 @@ The networking stack supports the following features: * IPv6 - * IPv6 header compresson, which is part of the 6LoWPAN support + * IPv6 header compression, which is part of the 6LoWPAN support * UDP * IPv4 diff --git a/doc/subsystems/networking/qemu_setup.rst b/doc/subsystems/networking/qemu_setup.rst index 8a5c4a292c1..b43827ec4e3 100644 --- a/doc/subsystems/networking/qemu_setup.rst +++ b/doc/subsystems/networking/qemu_setup.rst @@ -113,7 +113,7 @@ echo_server sample, CONFIG_NET_TCP=y): You will need to Ctrl+C manually. -You can also use the telnet comand to achieve the above. +You can also use the telnet command to achieve the above. Setting up NAT/masquerading to access Internet ********************************************** diff --git a/doc/subsystems/shell.rst b/doc/subsystems/shell.rst index d6970df56d5..04b6c13e512 100644 --- a/doc/subsystems/shell.rst +++ b/doc/subsystems/shell.rst @@ -9,7 +9,7 @@ Overview The Shell enables multiple subsystem to use and expose their shell interface simultaneously. -Each subbsystem can support shell functionality dynamically by its Kconfig file, +Each subsystem can support shell functionality dynamically by its Kconfig file, which enables or disables the shell usage for the subsystem. Using shell commands @@ -92,7 +92,7 @@ In order to support shell in your subsystem, the application must do the followi callback functions in the shell database using :c:macro:`SHELL_REGISTER`. Optionally, you can use one of the following API functions to override default -behvior and settings: +behavior and settings: * :c:func:`shell_register_default_module`