From a5e643b0cd509af3986834486a761dbbbd715522 Mon Sep 17 00:00:00 2001 From: Nathan Hartman Date: Mon, 16 Mar 2020 15:42:34 -0400 Subject: [PATCH] Fix typos in comments and documentation. --- ChangeLog | 18 ++++++------ Documentation/NuttShell.html | 4 +-- Documentation/NuttXDemandPaging.html | 4 +-- Documentation/NuttxPortingGuide.html | 11 ++++---- INVIOLABLES.txt | 2 +- ReleaseNotes | 2 +- TODO | 2 +- arch/arm/src/arm/up_blocktask.c | 28 +++++++++---------- arch/arm/src/arm/up_head.S | 2 +- arch/arm/src/armv6-m/up_blocktask.c | 25 ++++++++--------- arch/arm/src/armv7-a/arm_addrenv.c | 2 +- arch/arm/src/armv7-a/arm_blocktask.c | 28 +++++++++---------- arch/arm/src/armv7-a/arm_head.S | 2 +- arch/arm/src/armv7-a/arm_pghead.S | 2 +- arch/arm/src/armv7-m/up_blocktask.c | 28 +++++++++---------- arch/arm/src/armv7-r/arm_blocktask.c | 28 +++++++++---------- arch/arm/src/armv7-r/arm_head.S | 2 +- arch/arm/src/cxd56xx/cxd56_irq.c | 2 +- arch/arm/src/cxd56xx/cxd56_udmac.h | 2 +- arch/arm/src/dm320/dm320_usbdev.c | 4 +-- arch/arm/src/efm32/efm32_irq.c | 2 +- arch/arm/src/imxrt/imxrt_edma.c | 2 +- arch/arm/src/imxrt/imxrt_ehci.c | 4 +-- arch/arm/src/imxrt/imxrt_irq.c | 2 +- arch/arm/src/kinetis/kinetis_irq.c | 2 +- arch/arm/src/lc823450/lc823450_irq.c | 2 +- arch/arm/src/lpc17xx_40xx/lpc17_40_irq.c | 2 +- arch/arm/src/lpc31xx/lpc31_ehci.c | 4 +-- arch/arm/src/lpc43xx/lpc43_ehci.c | 4 +-- arch/arm/src/lpc43xx/lpc43_irq.c | 2 +- arch/arm/src/lpc54xx/lpc54_irq.c | 2 +- arch/arm/src/max326xx/common/max326_irq.c | 2 +- arch/arm/src/nrf52/nrf52_irq.c | 2 +- arch/arm/src/s32k1xx/s32k14x/s32k14x_irq.c | 2 +- arch/arm/src/s32k1xx/s32k1xx_edma.c | 2 +- arch/arm/src/sam34/sam4cm_oneshot.c | 2 +- arch/arm/src/sam34/sam_irq.c | 2 +- arch/arm/src/sama5/sam_ehci.c | 4 +-- arch/arm/src/sama5/sam_oneshot.c | 2 +- arch/arm/src/samd2l2/sam_dmac.h | 4 +-- arch/arm/src/samd2l2/sam_i2c_master.c | 2 +- arch/arm/src/samd5e5/sam_dmac.h | 4 +-- arch/arm/src/samd5e5/sam_i2c_master.c | 2 +- arch/arm/src/samd5e5/sam_irq.c | 2 +- arch/arm/src/samv7/sam_irq.c | 2 +- arch/arm/src/samv7/sam_oneshot.c | 2 +- arch/arm/src/samv7/sam_serial.c | 2 +- arch/arm/src/stm32/stm32_irq.c | 2 +- arch/arm/src/stm32/stm32_oneshot.c | 2 +- arch/arm/src/stm32/stm32_sdadc.c | 2 +- arch/arm/src/stm32f7/stm32_irq.c | 2 +- arch/arm/src/stm32h7/stm32_irq.c | 2 +- arch/arm/src/stm32l4/stm32l4_irq.c | 2 +- arch/arm/src/stm32l4/stm32l4_oneshot.c | 2 +- arch/arm/src/tiva/common/tiva_irq.c | 2 +- arch/arm/src/tiva/lm/lm3s_ethernet.c | 2 +- arch/arm/src/xmc4/xmc4_irq.c | 2 +- arch/avr/src/avr/up_blocktask.c | 28 +++++++++---------- arch/avr/src/avr32/up_blocktask.c | 28 +++++++++---------- arch/hc/src/common/up_blocktask.c | 28 +++++++++---------- arch/mips/src/mips32/up_blocktask.c | 28 +++++++++---------- arch/mips/src/pic32mz/pic32mz-oneshot.c | 2 +- arch/misoc/src/lm32/lm32_blocktask.c | 28 +++++++++---------- arch/misoc/src/minerva/minerva_blocktask.c | 25 ++++++++--------- arch/or1k/src/common/up_blocktask.c | 28 +++++++++---------- arch/renesas/src/common/up_blocktask.c | 28 +++++++++---------- arch/risc-v/src/rv32im/up_blocktask.c | 28 +++++++++---------- arch/risc-v/src/rv64gc/up_blocktask.c | 28 +++++++++---------- arch/sim/src/sim/up_blocktask.c | 28 +++++++++---------- arch/x86/src/common/up_blocktask.c | 27 +++++++++--------- arch/x86_64/src/common/up_blocktask.c | 27 +++++++++--------- arch/xtensa/src/common/xtensa_blocktask.c | 28 +++++++++---------- arch/z16/src/common/up_blocktask.c | 28 +++++++++---------- arch/z80/src/common/up_blocktask.c | 28 +++++++++---------- boards/arm/s32k1xx/s32k146evb/README.txt | 2 +- boards/arm/samd2l2/samd20-xplained/README.txt | 2 +- boards/arm/samd5e5/metro-m4/include/board.h | 2 +- .../same54-xplained-pro/include/board.h | 2 +- boards/arm/samv7/same70-xplained/README.txt | 2 +- boards/hc/m9s12/demo9s12ne64/README.txt | 6 ++-- boards/hc/m9s12/ne64badge/README.txt | 6 ++-- drivers/mtd/sst39vf.c | 2 +- drivers/sensors/README.txt | 2 +- drivers/sensors/lsm303agr.c | 2 +- drivers/sensors/lsm6dsl.c | 2 +- drivers/syslog/README.txt | 2 +- fs/spiffs/src/spiffs_volume.c | 2 +- include/nuttx/arch.h | 22 +++++++-------- include/nuttx/fs/fs.h | 2 +- include/nuttx/mm/iob.h | 2 +- include/nuttx/mqueue.h | 2 +- include/nuttx/net/net.h | 2 +- include/nuttx/sched.h | 2 +- include/nuttx/semaphore.h | 2 +- include/nuttx/signal.h | 2 +- include/nuttx/timers/pwm.h | 2 +- include/signal.h | 2 +- libs/libc/semaphore/sem_init.c | 2 +- libs/libc/wqueue/work_queue.c | 4 +-- mm/iob/iob_navail.c | 2 +- net/Kconfig | 2 +- net/ipforward/ipv6_forward.c | 2 +- sched/pthread/pthread_findjoininfo.c | 2 +- sched/semaphore/sem_holder.c | 24 ++++++++-------- sched/semaphore/sem_post.c | 2 +- sched/semaphore/sem_trywait.c | 8 +++--- sched/signal/sig_default.c | 9 +++--- sched/wqueue/kwork_inherit.c | 4 +-- sched/wqueue/kwork_queue.c | 4 +-- 109 files changed, 413 insertions(+), 455 deletions(-) diff --git a/ChangeLog b/ChangeLog index 0792780df4c..f1a5644f0cf 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1987,7 +1987,7 @@ There is no real substance in the initial check-in; only the directory structure and skeleton files (Code complete on 8/15/11). * arch/arm/include/armv7-m, arch/arm/src/armv7-m, etc.: Rename all cortexm3 - directories and files to armv7-m; Change name of of all CORTEXM3 constants + directories and files to armv7-m; Change name of all CORTEXM3 constants to ARMV7M. This is a major namespace change needed to cleanly support the ARM Cortex-M4 which is also in the ARMv7 M Series (specifically, ARMv7E-M). * sched/sig_initialize.c, sig_received.c, and mq_waitirq.c. Fixed several @@ -2566,7 +2566,7 @@ * configs/pic32-starterkit/nsh2: Add a PIC32 Ethernet Starter Kit NSH configuration that has no serial console; all interaction is done via Telnet. - * net/netdev_sem.c: Correct a deadlock condition by making a seamphore + * net/netdev_sem.c: Correct a deadlock condition by making a semaphore recursive. To my knowledge this deadlock only occurs when running the NSH command ifconfig over Telnet. In that case the function netdev_foreach takes the network device semaphore, but so does the telnet logic causing @@ -2822,7 +2822,7 @@ to done in that case. * arch/arc/src/stm32_otgfsdev.c: Fixed some status settings in queuing of write messages. Added a "hack" to work around missing TxFIFO empty interrupts. The - hack is basically to poll for space in the TxFIFO instead of of setting up + hack is basically to poll for space in the TxFIFO instead of setting up the interrupt. * arch/arm/src/stm32/stm32f2* and chip/stm32f2*: Update all STM32 F2 file so that they are equivalent to F4 files. This is kind of a maintenance nightmare. @@ -7602,7 +7602,7 @@ * include/unistd.h: Some POSIX_* and _POSIX_* macros are defined without value, whereas (as far as I can tell) the newer versions of the standard require them to have the value corresponding to - the standard version implemented, like 200809L. Are the any plans + the standard version implemented, like 200809L. Are there any plans to clean this up? For now I've put together a quick patch that defines those macros to 1, consistent with the rest of unistd.h. From Kosma Moczek (2014-6-30) @@ -9217,7 +9217,7 @@ but the received characters never arrive in the reader thread. The problem was fixed by re-initializing the semaphores on the last uart_close() on the device. From Harald Welte (2014-12-13). - * sched/semaphore/sem_recover.c, Make.defs, seamphore.c, + * sched/semaphore/sem_recover.c, Make.defs, semaphore.c, sched/wdog/wd_recover.c, Make.defs, wdog.h, sched/task/task_recover.c: Add logic to clean up after task_delete() or pthread_cancel() if the task happens to be waiting on a semaphore when it is cancelled @@ -13393,7 +13393,7 @@ often half-works and does weird things...). From Angus Gratton (2016-12-14). * Xtensa ESP32: Add missing ENTRY() and RET() macros in C callable - assembly language. At one time I though the that the ESP32 support the + assembly language. At one time I thought that the ESP32 supported the CALL0 ABI. I was mistaken so there may be a few more like this (2016-12-14). * Xtensa ESP32: Fix a couple of bugs associated with handling of CPU @@ -22262,7 +22262,7 @@ * arch/arm/src/stm32: Add support for DMA v1 CSELR support. From Mateusz Szafoni (2018-12-19). * Brings in initial WIP support for the STML0. This initial commit is - unverified and, hence it it marked "EXPERIMENTAL." From Mateusz + unverified and, hence it is marked "EXPERIMENTAL." From Mateusz Szafoni (2018-12-19). * configs/: Hook new STM32L0 boards into the configuration system. nucleo boards use as default ST LINK MCO as clock input from MCU and @@ -22284,7 +22284,7 @@ * mm/mm_heap/mm_sem.c: This is a candidate replacement for the reverted change 91aa26774b291fa553f701ce5222e56a6156c323. This change adds a check to mm_trysemaphore() (the root implementation of both - kmm_trysemaphore() and umm_trysemaphore()). It checks if the that task + kmm_trysemaphore() and umm_trysemaphore()). It checks if the task that is apparently executing is marked as RUNNING. If not, how could the non-running task be trying to get the MM semaphore? I think only in the exact scenario that Eunbong Song has described. So I think the @@ -25986,7 +25986,7 @@ conditional logic. Precedence of operators problem. - arch/arm/src/s32k1xx/s32k1xx_clockconfig.c: Fix another problem related to whether a divider is pre-decremented or not. The answer - must be the divder values are never pre-decremented. They are + must be the divider values are never pre-decremented. They are decremented just before being written to hardware. - arch/arm/src/s32k1xx/s32k1xx_periphclocks.c and related files: Fix yet another case of confusion between pre-decremented and diff --git a/Documentation/NuttShell.html b/Documentation/NuttShell.html index 2f98ac7d12e..3903611dc5f 100644 --- a/Documentation/NuttShell.html +++ b/Documentation/NuttShell.html @@ -2477,7 +2477,7 @@ mkdir <path>

Synopsis. Create the directory at <path>. - All components of of <path> except the final directory name must exist on a mounted file + All components of <path> except the final directory name must exist on a mounted file system; the final directory must not.

@@ -4366,7 +4366,7 @@ set FOOBAR ABC_${FOO}_${BAR}

  • CONFIG_NSH_USBCONSOLE. - If defined, then the an arbitrary USB device may be used to as the NSH console. + If defined, then an arbitrary USB device may be used to as the NSH console. In this case, CONFIG_NSH_USBCONDEV must be defined to indicate which USB device to use as the console. The advantage of using a device other that /dev/console is that normal debug output can then use /dev/console while NSH uses CONFIG_NSH_USBCONDEV.

    diff --git a/Documentation/NuttXDemandPaging.html b/Documentation/NuttXDemandPaging.html index caac5251a03..aeb210517e3 100644 --- a/Documentation/NuttXDemandPaging.html +++ b/Documentation/NuttXDemandPaging.html @@ -161,7 +161,7 @@

    g_pftcb
    A variable that holds a reference to the TCB of the thread that is currently be re-filled.
    g_pgworker
    -
    The process ID of of the thread that will perform the page fills.
    +
    The process ID of the thread that will perform the page fills.
    pg_callback()
    The callback function that is invoked from a driver when the fill is complete.
    pg_miss()
    @@ -190,7 +190,7 @@
  • g_pgworker. - The process ID of of the thread that will perform the page fills + The process ID of the thread that will perform the page fills
  • diff --git a/Documentation/NuttxPortingGuide.html b/Documentation/NuttxPortingGuide.html index ed6c3d0c0a7..7282af8f4f9 100644 --- a/Documentation/NuttxPortingGuide.html +++ b/Documentation/NuttxPortingGuide.html @@ -2069,11 +2069,10 @@ The specific environmental definitions are unique for each board but should incl

    Input Parameters: