From 8af9d396678cdea143468630f9c32ed3ae0ebffe Mon Sep 17 00:00:00 2001 From: Nathan Hartman <59230071+hartmannathan@users.noreply.github.com> Date: Wed, 5 May 2021 22:18:49 -0400 Subject: [PATCH] Documentation, comments: Minor improvements and typos fixed --- .../reference/user/04_message_queue.rst | 91 +++++++++---------- arch/arm/src/kinetis/kinetis_dma.c | 6 +- arch/arm/src/kinetis/kinetis_dma.h | 6 +- arch/arm/src/kinetis/kinetis_pindump.c | 2 +- arch/arm/src/kl/kl_dma.h | 6 +- arch/arm/src/kl/kl_dumpgpio.c | 2 +- arch/arm/src/lc823450/lc823450_dma.c | 6 +- arch/arm/src/lpc17xx_40xx/lpc17_40_ethernet.c | 4 +- arch/arm/src/lpc17xx_40xx/lpc17_40_gpdma.c | 6 +- arch/arm/src/lpc17xx_40xx/lpc17_40_gpdma.h | 6 +- arch/arm/src/lpc43xx/lpc43_gpdma.c | 6 +- arch/arm/src/lpc43xx/lpc43_gpdma.h | 6 +- arch/arm/src/lpc43xx/lpc43_spifi.c | 2 +- arch/arm/src/lpc43xx/lpc43_spifi.h | 2 +- arch/arm/src/nuc1xx/nuc_dumpgpio.c | 2 +- arch/arm/src/nuc1xx/nuc_gpio.h | 2 +- arch/arm/src/s32k1xx/s32k1xx_pindump.c | 2 +- arch/arm/src/stm32/stm32_dma_v1mux.c | 8 +- arch/arm/src/stm32h7/stm32_dma.c | 6 +- arch/arm/src/stm32h7/stm32_dma.h | 6 +- arch/arm/src/stm32l4/stm32l4_dma.h | 6 +- arch/arm/src/stm32l4/stm32l4xrxx_dma.c | 6 +- arch/arm/src/xmc4/xmc4_dma.h | 6 +- arch/mips/src/pic32mx/pic32mx.h | 6 +- arch/x86/src/qemu/qemu.h | 6 +- boards/arm/sama5/sama5d3-xplained/README.txt | 2 +- boards/arm/sama5/sama5d3x-ek/README.txt | 2 +- boards/renesas/m16c/skp16c26/README.txt | 2 +- include/nuttx/nx/nxfonts.h | 4 +- libs/libc/semaphore/sem_setprotocol.c | 2 +- libs/libc/time/lib_asctime.c | 2 +- libs/libc/time/lib_asctimer.c | 2 +- libs/libc/time/lib_ctime.c | 2 +- libs/libc/time/lib_ctimer.c | 2 +- libs/libnx/nxfonts/nxfonts_cache.c | 2 +- sched/mqueue/mq_initialize.c | 2 +- sched/mqueue/mq_rcvinternal.c | 4 +- sched/mqueue/mq_receive.c | 2 +- sched/mqueue/mq_sndinternal.c | 2 +- sched/mqueue/mq_timedreceive.c | 2 +- 40 files changed, 118 insertions(+), 123 deletions(-) diff --git a/Documentation/reference/user/04_message_queue.rst b/Documentation/reference/user/04_message_queue.rst index 22877039b4..d5d6b8ebe0 100644 --- a/Documentation/reference/user/04_message_queue.rst +++ b/Documentation/reference/user/04_message_queue.rst @@ -19,11 +19,10 @@ handlers may send messages via named message queues. .. c:function:: mqd_t mq_open(const char *mqName, int oflags, ...) - Establishes a connection between a named - message queue and the calling task. After a successful call of - mq_open(), the task can reference the message queue using the address - returned by the call. The message queue remains usable until it is - closed by a successful call to mq_close(). + Establishes a connection between a named message queue and the calling + task. After a successful call of mq_open(), the task can reference the + message queue using the address returned by the call. The message queue + remains usable until it is closed by a successful call to mq_close(). :param mqName: Name of the queue to open :param oflags: Open flags. These may be any combination of: @@ -65,10 +64,10 @@ handlers may send messages via named message queues. .. c:function:: int mq_close(mqd_t mqdes) - Used to indicate that the calling task - is finished with the specified message queued mqdes. The mq_close() - deallocates any system resources allocated by the system for use by this - task for its message queue. + Used to indicate that the calling task is finished with the specified + message queued ``mqdes``. The ``mq_close()`` deallocates any system + resources allocated by the system for use by this task for its message + queue. If the calling task has attached a notification request to the message queue via this ``mqdes`` (see ``mq_notify()``), this attachment will be @@ -104,10 +103,10 @@ handlers may send messages via named message queues. .. c:function:: int mq_send(mqd_t mqdes, const void *msg, size_t msglen, int prio) - Adds the specified message, ``msg``, to - the message queue, ``mqdes``. The ``msglen`` parameter specifies the - length of the message in bytes pointed to by ``msg``. This length must - not exceed the maximum message length from the ``mq_getattr()``. + Adds the specified message, ``msg``, to the message queue, ``mqdes``. + The ``msglen`` parameter specifies the length of the message in bytes + pointed to by ``msg``. This length must not exceed the maximum message + length from the ``mq_getattr()``. If the message queue is not full, ``mq_send()`` will place the ``msg`` in the message queue at the position indicated by the ``prio`` argument. @@ -125,14 +124,14 @@ handlers may send messages via named message queues. However, it behaves differently when called from the interrupt level: - It does not check the size of the queue. It will always post the - message, even if there is already too many messages in queue. This is + message, even if there are already too many messages in queue. This is because the interrupt handler does not have the option of waiting for the message queue to become non-full. - It doesn't allocate new memory (because you cannot allocate memory - from an interrupt handler). Instead, there are are pool of - pre-allocated message structures that may be used just for sending - messages from interrupt handlers. The number of such pre-allocated - messages is a configuration parameter. + from an interrupt handler). Instead, there is a pool of pre-allocated + message structures that may be used just for sending messages from + interrupt handlers. The number of such pre-allocated messages is set + by the ``PREALLOC_MQ_IRQ_MSGS`` configuration parameter. :param mqdes: Message queue descriptor. :param msg: Message to send. @@ -157,10 +156,10 @@ handlers may send messages via named message queues. .. c:function:: int mq_timedsend(mqd_t mqdes, const char *msg, size_t msglen, int prio, \ const struct timespec *abstime); - Adds the specified message, ``msg``, to - the message queue, ``mqdes``. The ``msglen`` parameter specifies the - length of the message in bytes pointed to by ``msg``. This length must - not exceed the maximum message length from the ``mq_getattr()``. + Adds the specified message, ``msg``, to the message queue, ``mqdes``. + The ``msglen`` parameter specifies the length of the message in bytes + pointed to by ``msg``. This length must not exceed the maximum message + length from the ``mq_getattr()``. If the message queue is not full, ``mq_timedsend()`` will place the ``msg`` in the message queue at the position indicated by the ``prio`` @@ -203,12 +202,11 @@ handlers may send messages via named message queues. .. c:function:: ssize_t mq_receive(mqd_t mqdes, void *msg, size_t msglen, int *prio) - Receives the oldest of the highest - priority messages from the message queue specified by ``mqdes``. If the - size of the buffer in bytes, ``msgLen``, is less than the ``mq_msgsize`` - attribute of the message queue, ``mq_receive()`` will return an error. - Otherwise, the selected message is removed from the queue and copied to - ``msg``. + Receives the oldest of the highest priority messages from the message + queue specified by ``mqdes``. If the size of the buffer in bytes, + ``msgLen``, is less than the ``mq_msgsize`` attribute of the message + queue, ``mq_receive()`` will return an error. Otherwise, the selected + message is removed from the queue and copied to ``msg``. If the message queue is empty and ``O_NONBLOCK`` was not set, ``mq_receive()`` will block until a message is added to the message @@ -223,8 +221,8 @@ handlers may send messages via named message queues. :param msg: Buffer to receive the message. :param msglen: Size of the buffer in bytes. :param prio: If not NULL, the location to store message priority. - :return: One success, the length of the selected message in - bytes is returned. On failure, -1 (``ERROR``) is returned and the + :return: On success, the length of the selected message in bytes is + returned. On failure, -1 (``ERROR``) is returned and the ```errno`` <#ErrnoAccess>`__ is set appropriately: - ``EAGAIN`` The queue was empty and the ``O_NONBLOCK`` flag was set @@ -241,12 +239,11 @@ handlers may send messages via named message queues. .. c:function:: ssize_t mq_timedreceive(mqd_t mqdes, void *msg, size_t msglen, \ int *prio, const struct timespec *abstime); - Receives the oldest of the highest - priority messages from the message queue specified by ``mqdes``. If the - size of the buffer in bytes, ``msgLen``, is less than the ``mq_msgsize`` - attribute of the message queue, ``mq_timedreceive()`` will return an - error. Otherwise, the selected message is removed from the queue and - copied to ``msg``. + Receives the oldest of the highest priority messages from the message + queue specified by ``mqdes``. If the size of the buffer in bytes, + ``msgLen``, is less than the ``mq_msgsize`` attribute of the message + queue, ``mq_timedreceive()`` will return an error. Otherwise, the + selected message is removed from the queue and copied to ``msg``. If the message queue is empty and ``O_NONBLOCK`` was not set, ``mq_timedreceive()`` will block until a message is added to the message @@ -270,8 +267,8 @@ handlers may send messages via named message queues. :param prio: If not NULL, the location to store message priority. :param abstime: The absolute time to wait until a timeout is declared. - :return: One success, the length of the selected message in - bytes is returned. On failure, -1 (``ERROR``) is returned and the + :return: On success, the length of the selected message in bytes is + returned. On failure, -1 (``ERROR``) is returned and the ```errno`` <#ErrnoAccess>`__ is set appropriately: - ``EAGAIN``: The queue was empty and the ``O_NONBLOCK`` flag was set @@ -289,11 +286,10 @@ handlers may send messages via named message queues. .. c:function:: int mq_notify(mqd_t mqdes, FAR const struct sigevent *notification) - If the ``notification`` input parameter is not - ``NULL``, this function connects the task with the message queue such - that the specified signal will be sent to the task whenever the message - changes from empty to non-empty. One notification can be attached to a - message queue. + If the ``notification`` input parameter is not ``NULL``, this function + connects the task with the message queue such that the specified signal + will be sent to the task whenever the message queue changes from empty + to non-empty. One notification can be attached to a message queue. If ``notification``; is ``NULL``, the attached notification is detached (if it was held by the calling task) and the queue is available to @@ -337,9 +333,8 @@ handlers may send messages via named message queues. .. c:function:: int mq_setattr(mqd_t mqdes, const struct mq_attr *mqStat, \ struct mq_attr *oldMqStat); - Sets the attributes associated with the - specified message queue "mqdes." Only the "O_NONBLOCK" bit of the - "mq_flags" can be changed. + Sets the attributes associated with the specified message queue "mqdes." + Only the "O_NONBLOCK" bit of the "mq_flags" can be changed. If ``oldMqStat`` is non-null, mq_setattr() will store the previous message queue attributes at that location (just as would have been returned by @@ -357,8 +352,8 @@ handlers may send messages via named message queues. .. c:function:: int mq_getattr(mqd_t mqdes, struct mq_attr *mqStat) - Gets status information and attributes - associated with the specified message queue. + Gets status information and attributes associated with the specified + message queue. :param mqdes: Message queue descriptor :param mqStat: Buffer in which to return attributes. The returned diff --git a/arch/arm/src/kinetis/kinetis_dma.c b/arch/arm/src/kinetis/kinetis_dma.c index 13aec599f7..75b6dab2dc 100644 --- a/arch/arm/src/kinetis/kinetis_dma.c +++ b/arch/arm/src/kinetis/kinetis_dma.c @@ -222,9 +222,9 @@ void weak_function arm_dma_initialize(void) * gives the caller exclusive access to the DMA channel. * * Returned Value: - * One success, this function returns a non-NULL, void* DMA channel - * handle. NULL is returned on any failure. This function can fail only - * if no DMA channel is available. + * On success, this function returns a non-NULL, void* DMA channel handle. + * NULL is returned on any failure. This function can fail only if no DMA + * channel is available. * ****************************************************************************/ diff --git a/arch/arm/src/kinetis/kinetis_dma.h b/arch/arm/src/kinetis/kinetis_dma.h index f352080b5c..96b13e7b9c 100644 --- a/arch/arm/src/kinetis/kinetis_dma.h +++ b/arch/arm/src/kinetis/kinetis_dma.h @@ -150,9 +150,9 @@ void kinetis_dmainitialize(void); * dir - transfer direction * * Returned Value: - * One success, this function returns a non-NULL, void * DMA channel - * handle. NULL is returned on any failure. This function can fail only - * if no DMA channel is available. + * On success, this function returns a non-NULL, void* DMA channel handle. + * NULL is returned on any failure. This function can fail only if no DMA + * channel is available. * ****************************************************************************/ diff --git a/arch/arm/src/kinetis/kinetis_pindump.c b/arch/arm/src/kinetis/kinetis_pindump.c index 4c245dac28..efc3bcaaec 100644 --- a/arch/arm/src/kinetis/kinetis_pindump.c +++ b/arch/arm/src/kinetis/kinetis_pindump.c @@ -78,7 +78,7 @@ static const char g_portchar[KINETIS_NPORTS] = * * Description: * Dump all GPIO registers associated with the provided pin description - * along with a descriptive messasge. + * along with a descriptive message. * ****************************************************************************/ diff --git a/arch/arm/src/kl/kl_dma.h b/arch/arm/src/kl/kl_dma.h index a8c7e7017c..1a6dfc4392 100644 --- a/arch/arm/src/kl/kl_dma.h +++ b/arch/arm/src/kl/kl_dma.h @@ -111,9 +111,9 @@ void kl_dmainitilaize(void); * gives the caller exclusive access to the DMA channel. * * Returned Value: - * One success, this function returns a non-NULL, void* DMA channel - * handle. NULL is returned on any failure. This function can fail only - * if no DMA channel is available. + * On success, this function returns a non-NULL, void* DMA channel handle. + * NULL is returned on any failure. This function can fail only if no DMA + * channel is available. * ****************************************************************************/ diff --git a/arch/arm/src/kl/kl_dumpgpio.c b/arch/arm/src/kl/kl_dumpgpio.c index 826c10f063..da84282811 100644 --- a/arch/arm/src/kl/kl_dumpgpio.c +++ b/arch/arm/src/kl/kl_dumpgpio.c @@ -82,7 +82,7 @@ static const char g_portchar[KL_GPIO_NPORTS] = * * Description: * Dump all GPIO registers associated with the provided pin description - * along with a descriptive messasge. + * along with a descriptive message. * ****************************************************************************/ diff --git a/arch/arm/src/lc823450/lc823450_dma.c b/arch/arm/src/lc823450/lc823450_dma.c index ab417aadcd..195700c2ff 100644 --- a/arch/arm/src/lc823450/lc823450_dma.c +++ b/arch/arm/src/lc823450/lc823450_dma.c @@ -495,9 +495,9 @@ void lc823450_dmareauest_dir(DMA_HANDLE handle, uint8_t dmarequest, int m2p) * gives the caller exclusive access to the DMA channel. * * Returned Value: - * One success, this function returns a non-NULL, void* DMA channel - * handle. NULL is returned on any failure. This function can fail only - * if no DMA channel is available. + * On success, this function returns a non-NULL, void* DMA channel handle. + * NULL is returned on any failure. This function can fail only if no DMA + * channel is available. * ****************************************************************************/ diff --git a/arch/arm/src/lpc17xx_40xx/lpc17_40_ethernet.c b/arch/arm/src/lpc17xx_40xx/lpc17_40_ethernet.c index 27befee53b..b194b550ca 100644 --- a/arch/arm/src/lpc17xx_40xx/lpc17_40_ethernet.c +++ b/arch/arm/src/lpc17xx_40xx/lpc17_40_ethernet.c @@ -655,9 +655,9 @@ static int lpc17_40_transmit(struct lpc17_40_driver_s *priv) *txdesc = TXDESC_CONTROL_INT | TXDESC_CONTROL_LAST | TXDESC_CONTROL_CRC | (priv->lp_dev.d_len - 1); - /* Copy the packet data into the Tx buffer assignd to this descriptor. It + /* Copy the packet data into the Tx buffer assigned to this descriptor. It * should fit because each packet buffer is the MTU size and breaking up - * largerTCP messasges is handled by higher level logic. The hardware + * larger TCP message is handled by higher level logic. The hardware * does, however, support breaking up larger messages into many fragments, * however, that capability is not exploited here. * diff --git a/arch/arm/src/lpc17xx_40xx/lpc17_40_gpdma.c b/arch/arm/src/lpc17xx_40xx/lpc17_40_gpdma.c index 7d506676ee..6029cb9a12 100644 --- a/arch/arm/src/lpc17xx_40xx/lpc17_40_gpdma.c +++ b/arch/arm/src/lpc17xx_40xx/lpc17_40_gpdma.c @@ -367,9 +367,9 @@ void lpc17_40_dmaconfigure(uint8_t dmarequest, bool alternate) * gives the caller exclusive access to the DMA channel. * * Returned Value: - * One success, this function returns a non-NULL, void* DMA channel - * handle. NULL is returned on any failure. This function can fail only - * if no DMA channel is available. + * On success, this function returns a non-NULL, void* DMA channel handle. + * NULL is returned on any failure. This function can fail only if no DMA + * channel is available. * ****************************************************************************/ diff --git a/arch/arm/src/lpc17xx_40xx/lpc17_40_gpdma.h b/arch/arm/src/lpc17xx_40xx/lpc17_40_gpdma.h index 128be9848d..a6db12cb30 100644 --- a/arch/arm/src/lpc17xx_40xx/lpc17_40_gpdma.h +++ b/arch/arm/src/lpc17xx_40xx/lpc17_40_gpdma.h @@ -149,9 +149,9 @@ void lpc17_40_dmaconfigure(uint8_t dmarequest, bool alternate); * gives the caller exclusive access to the DMA channel. * * Returned Value: - * One success, this function returns a non-NULL, void* DMA channel - * handle. NULL is returned on any failure. This function can fail only - * if no DMA channel is available. + * On success, this function returns a non-NULL, void* DMA channel handle. + * NULL is returned on any failure. This function can fail only if no DMA + * channel is available. * ****************************************************************************/ diff --git a/arch/arm/src/lpc43xx/lpc43_gpdma.c b/arch/arm/src/lpc43xx/lpc43_gpdma.c index 2d45d74b02..c2586c206a 100644 --- a/arch/arm/src/lpc43xx/lpc43_gpdma.c +++ b/arch/arm/src/lpc43xx/lpc43_gpdma.c @@ -366,9 +366,9 @@ void lpc43_dmaconfigure(uint8_t dmarequest, uint8_t dmasrc) * gives the caller exclusive access to the DMA channel. * * Returned Value: - * One success, this function returns a non-NULL, void* DMA channel - * handle. NULL is returned on any failure. This function can fail only - * if no DMA channel is available. + * On success, this function returns a non-NULL, void* DMA channel handle. + * NULL is returned on any failure. This function can fail only if no DMA + * channel is available. * ****************************************************************************/ diff --git a/arch/arm/src/lpc43xx/lpc43_gpdma.h b/arch/arm/src/lpc43xx/lpc43_gpdma.h index deaabc38d5..ebd925961f 100644 --- a/arch/arm/src/lpc43xx/lpc43_gpdma.h +++ b/arch/arm/src/lpc43xx/lpc43_gpdma.h @@ -114,9 +114,9 @@ extern "C" * gives the caller exclusive access to the DMA channel. * * Returned Value: - * One success, this function returns a non-NULL, void* DMA channel - * handle. NULL is returned on any failure. This function can fail only - * if no DMA channel is available. + * On success, this function returns a non-NULL, void* DMA channel handle. + * NULL is returned on any failure. This function can fail only if no DMA + * channel is available. * ****************************************************************************/ diff --git a/arch/arm/src/lpc43xx/lpc43_spifi.c b/arch/arm/src/lpc43xx/lpc43_spifi.c index 3eec0eb21b..1e5df20967 100644 --- a/arch/arm/src/lpc43xx/lpc43_spifi.c +++ b/arch/arm/src/lpc43xx/lpc43_spifi.c @@ -1146,7 +1146,7 @@ static inline int lpc43_rominit(FAR struct lpc43_dev_s *priv) * None * * Returned Value: - * One success, a reference to the initialized MTD device instance is + * On success, a reference to the initialized MTD device instance is * returned; NULL is returned on any failure. * ****************************************************************************/ diff --git a/arch/arm/src/lpc43xx/lpc43_spifi.h b/arch/arm/src/lpc43xx/lpc43_spifi.h index 86b9c44f0e..e0ea6a6591 100644 --- a/arch/arm/src/lpc43xx/lpc43_spifi.h +++ b/arch/arm/src/lpc43xx/lpc43_spifi.h @@ -102,7 +102,7 @@ extern "C" * None * * Returned Value: - * One success, a reference to the initialized MTD device instance is + * On success, a reference to the initialized MTD device instance is * returned; NULL is returned on any failure. * ****************************************************************************/ diff --git a/arch/arm/src/nuc1xx/nuc_dumpgpio.c b/arch/arm/src/nuc1xx/nuc_dumpgpio.c index ddbebf05f7..1509c4c013 100644 --- a/arch/arm/src/nuc1xx/nuc_dumpgpio.c +++ b/arch/arm/src/nuc1xx/nuc_dumpgpio.c @@ -78,7 +78,7 @@ static const char g_portchar[NUC_GPIO_NPORTS] = * * Description: * Dump all GPIO registers associated with the provided pin description - * along with a descriptive messasge. + * along with a descriptive message. * ****************************************************************************/ diff --git a/arch/arm/src/nuc1xx/nuc_gpio.h b/arch/arm/src/nuc1xx/nuc_gpio.h index bc0cc19b13..a3c0745b6b 100644 --- a/arch/arm/src/nuc1xx/nuc_gpio.h +++ b/arch/arm/src/nuc1xx/nuc_gpio.h @@ -227,7 +227,7 @@ bool nuc_gpioread(gpio_cfgset_t pinset); * * Description: * Dump all GPIO registers associated with the provided pin description - * along with a descriptive messasge. + * along with a descriptive message. * ****************************************************************************/ diff --git a/arch/arm/src/s32k1xx/s32k1xx_pindump.c b/arch/arm/src/s32k1xx/s32k1xx_pindump.c index aee347af22..c5aaf22fb3 100644 --- a/arch/arm/src/s32k1xx/s32k1xx_pindump.c +++ b/arch/arm/src/s32k1xx/s32k1xx_pindump.c @@ -78,7 +78,7 @@ static const char g_portchar[S32K1XX_NPORTS] = * * Description: * Dump all GPIO registers associated with the provided pin description - * along with a descriptive messasge. + * along with a descriptive message. * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32_dma_v1mux.c b/arch/arm/src/stm32/stm32_dma_v1mux.c index 809831b4d2..b9245d95f9 100644 --- a/arch/arm/src/stm32/stm32_dma_v1mux.c +++ b/arch/arm/src/stm32/stm32_dma_v1mux.c @@ -1066,13 +1066,13 @@ void weak_function arm_dma_initialize(void) * in hardware/stm32g4xxxx_dmamux.h * * Returned Value: - * One success, this function returns a non-NULL, void* DMA channel - * handle. NULL is returned on any failure. This function can fail only - * if no DMA channel is available. + * On success, this function returns a non-NULL, void* DMA channel handle. + * NULL is returned on any failure. This function can fail only if no DMA + * channel is available. * * Assumptions: * - The caller does not hold he DMA channel. - * - The caller can wait for the DMA channel to be freed if it is no + * - The caller can wait for the DMA channel to be freed if it is not * available. * ****************************************************************************/ diff --git a/arch/arm/src/stm32h7/stm32_dma.c b/arch/arm/src/stm32h7/stm32_dma.c index 0c4eab7109..154e8fdb32 100644 --- a/arch/arm/src/stm32h7/stm32_dma.c +++ b/arch/arm/src/stm32h7/stm32_dma.c @@ -2270,9 +2270,9 @@ void weak_function arm_dma_initialize(void) * in chip/stm32h7xxxxxxx_dmamux.h * * Returned Value: - * One success, this function returns a non-NULL, void* DMA channel - * handle. NULL is returned on any failure. This function can fail only - * if no DMA channel is available. + * On success, this function returns a non-NULL, void* DMA channel handle. + * NULL is returned on any failure. This function can fail only if no DMA + * channel is available. * * Assumptions: * - The caller does not hold he DMA channel. diff --git a/arch/arm/src/stm32h7/stm32_dma.h b/arch/arm/src/stm32h7/stm32_dma.h index 9843b9d2db..03ff83dde1 100644 --- a/arch/arm/src/stm32h7/stm32_dma.h +++ b/arch/arm/src/stm32h7/stm32_dma.h @@ -125,9 +125,9 @@ extern "C" * in chip/stm32h7xxxxxxx_dmamux.h * * Returned Value: - * One success, this function returns a non-NULL, void* DMA channel - * handle. NULL is returned on any failure. This function can fail only - * if no DMA channel is available. + * On success, this function returns a non-NULL, void* DMA channel handle. + * NULL is returned on any failure. This function can fail only if no DMA + * channel is available. * * Assumptions: * - The caller does not hold he DMA channel. diff --git a/arch/arm/src/stm32l4/stm32l4_dma.h b/arch/arm/src/stm32l4/stm32l4_dma.h index 7834f50967..58d756623f 100644 --- a/arch/arm/src/stm32l4/stm32l4_dma.h +++ b/arch/arm/src/stm32l4/stm32l4_dma.h @@ -199,9 +199,9 @@ DMA_HANDLE stm32l4_dmachannel(unsigned int chan); * hardware/stm32l4xrxx_dmamux.h * * Returned Value: - * One success, this function returns a non-NULL, void* DMA channel - * handle. NULL is returned on any failure. This function can fail only - * if no DMA channel is available. + * On success, this function returns a non-NULL, void* DMA channel handle. + * NULL is returned on any failure. This function can fail only if no DMA + * channel is available. * * Assumptions: * - The caller does not hold he DMA channel. diff --git a/arch/arm/src/stm32l4/stm32l4xrxx_dma.c b/arch/arm/src/stm32l4/stm32l4xrxx_dma.c index b45a1f7426..228e14aa48 100644 --- a/arch/arm/src/stm32l4/stm32l4xrxx_dma.c +++ b/arch/arm/src/stm32l4/stm32l4xrxx_dma.c @@ -1022,9 +1022,9 @@ void weak_function arm_dma_initialize(void) * in hardware/stm32l4xrxx_dmamux.h * * Returned Value: - * One success, this function returns a non-NULL, void* DMA channel - * handle. NULL is returned on any failure. This function can fail only - * if no DMA channel is available. + * On success, this function returns a non-NULL, void* DMA channel handle. + * NULL is returned on any failure. This function can fail only if no DMA + * channel is available. * * Assumptions: * - The caller does not hold he DMA channel. diff --git a/arch/arm/src/xmc4/xmc4_dma.h b/arch/arm/src/xmc4/xmc4_dma.h index ee8e05eb8c..dd11f4ef78 100644 --- a/arch/arm/src/xmc4/xmc4_dma.h +++ b/arch/arm/src/xmc4/xmc4_dma.h @@ -110,9 +110,9 @@ void xmc4_dmainitilaize(void); * gives the caller exclusive access to the DMA channel. * * Returned Value: - * One success, this function returns a non-NULL, void* DMA channel - * handle. NULL is returned on any failure. This function can fail only - * if no DMA channel is available. + * On success, this function returns a non-NULL, void* DMA channel handle. + * NULL is returned on any failure. This function can fail only if no DMA + * channel is available. * ****************************************************************************/ diff --git a/arch/mips/src/pic32mx/pic32mx.h b/arch/mips/src/pic32mx/pic32mx.h index 9deff0bdf8..ca5e8bcbc0 100644 --- a/arch/mips/src/pic32mx/pic32mx.h +++ b/arch/mips/src/pic32mx/pic32mx.h @@ -477,9 +477,9 @@ void pic32mx_dmainitilaize(void); * caller exclusive access to the DMA channel. * * Returned Value: - * One success, this function returns a non-NULL, void* DMA channel handle. NULL - * is returned on any failure. This function can fail only if no DMA channel is - * available. + * On success, this function returns a non-NULL, void* DMA channel handle. + * NULL is returned on any failure. This function can fail only if no DMA + * channel is available. * ************************************************************************************/ diff --git a/arch/x86/src/qemu/qemu.h b/arch/x86/src/qemu/qemu.h index 21f074a5c1..1e60748287 100644 --- a/arch/x86/src/qemu/qemu.h +++ b/arch/x86/src/qemu/qemu.h @@ -284,9 +284,9 @@ void i486_dmainitilaize(void); * gives the caller exclusive access to the DMA channel. * * Returned Value: - * One success, this function returns a non-NULL, void* DMA channel - * handle. NULL is returned on any failure. This function can fail only - * if no DMA channel is available. + * On success, this function returns a non-NULL, void* DMA channel handle. + * NULL is returned on any failure. This function can fail only if no DMA + * channel is available. * ****************************************************************************/ diff --git a/boards/arm/sama5/sama5d3-xplained/README.txt b/boards/arm/sama5/sama5d3-xplained/README.txt index 8c68bacc3d..964e258370 100644 --- a/boards/arm/sama5/sama5d3-xplained/README.txt +++ b/boards/arm/sama5/sama5d3-xplained/README.txt @@ -2247,7 +2247,7 @@ CAN Usage Only messages that have IDs that match the CONFIG_SAMA5_CANn_ADDRn when both the received and the configured address are masked by CONFIG_SAMA5_CANn_MASKn - will be accepted. For example, if the mask is all ones, then only messasges + will be accepted. For example, if the mask is all ones, then only messages with exact address matches will be accepted; if the mask is all zeroes than any address will be accepted. diff --git a/boards/arm/sama5/sama5d3x-ek/README.txt b/boards/arm/sama5/sama5d3x-ek/README.txt index 45559b1d95..0dc33d3457 100644 --- a/boards/arm/sama5/sama5d3x-ek/README.txt +++ b/boards/arm/sama5/sama5d3x-ek/README.txt @@ -2384,7 +2384,7 @@ CAN Usage Only messages that have IDs that match the CONFIG_SAMA5_CANn_ADDRn when both the received and the configured address are masked by CONFIG_SAMA5_CANn_MASKn - will be accepted. For example, if the mask is all ones, then only messasges + will be accepted. For example, if the mask is all ones, then only messages with exact address matches will be accepted; if the mask is all zeroes than any address will be accepted. diff --git a/boards/renesas/m16c/skp16c26/README.txt b/boards/renesas/m16c/skp16c26/README.txt index b30b3d407b..99cbb7fd14 100644 --- a/boards/renesas/m16c/skp16c26/README.txt +++ b/boards/renesas/m16c/skp16c26/README.txt @@ -27,7 +27,7 @@ boards/renesas/m16c/skp16c26/README.txt c:\Hew3\Tools\KPIT Cummins\GNUM16CM32C-ELF\v0901\m32c-elf\bin\m32c-elf-ld.exe: BFD (GNU Binutils) 2.19-GNUM16CM32C_v0901 assertion fail /home/kpit/fsfsrc/binutils-2.19/bfd/elf32-m32c.c:482 -It is possible that this error messasge my be telling me -- a very roundabout way -- +It is possible that this error message may be telling me -- a very roundabout way -- that I have exceeded the FLASH region, but I think that unlikely (it is difficult to know if the link does not complete gracefully). diff --git a/include/nuttx/nx/nxfonts.h b/include/nuttx/nx/nxfonts.h index 9988e86e46..16bb00e930 100644 --- a/include/nuttx/nx/nxfonts.h +++ b/include/nuttx/nx/nxfonts.h @@ -490,7 +490,7 @@ extern "C" * fontid: Identifies the font set to get * * Returned Value: - * One success, a non-NULL font handle is returned. + * On success, a non-NULL font handle is returned. * ****************************************************************************/ @@ -638,7 +638,7 @@ void nxf_cache_disconnect(FCACHE fhandle); * Zero (OK) is returned if the metrics were * * Returned Value: - * One success, a non-NULL font handle is returned. + * On success, a non-NULL font handle is returned. * ****************************************************************************/ diff --git a/libs/libc/semaphore/sem_setprotocol.c b/libs/libc/semaphore/sem_setprotocol.c index 762232b086..f1418740bd 100644 --- a/libs/libc/semaphore/sem_setprotocol.c +++ b/libs/libc/semaphore/sem_setprotocol.c @@ -47,7 +47,7 @@ * TASK A TASK B * nxsem_init(sem, 0, 0); * nxsem_wait(sem); - * snxem_post(sem); + * nxsem_post(sem); * Awakens as holder * * In this case priority inheritance can interfere with the operation of diff --git a/libs/libc/time/lib_asctime.c b/libs/libc/time/lib_asctime.c index 6bdb9084aa..5504b037e1 100644 --- a/libs/libc/time/lib_asctime.c +++ b/libs/libc/time/lib_asctime.c @@ -42,7 +42,7 @@ * tp - Pointer to the time to be converted. * * Returned Value: - * One success a pointer to the string is returned; on failure, NULL is + * On success, a pointer to the string is returned; on failure, NULL is * returned. * ****************************************************************************/ diff --git a/libs/libc/time/lib_asctimer.c b/libs/libc/time/lib_asctimer.c index fc9712ad1f..6db2480e80 100644 --- a/libs/libc/time/lib_asctimer.c +++ b/libs/libc/time/lib_asctimer.c @@ -63,7 +63,7 @@ static const char * const g_mon_name[12] = * buf - A user provided buffer to receive the 26 character time string. * * Returned Value: - * One success, the pointer to the 'buf' is returned; on failure, NULL is + * On success, the pointer to the 'buf' is returned; on failure, NULL is * returned. * ****************************************************************************/ diff --git a/libs/libc/time/lib_ctime.c b/libs/libc/time/lib_ctime.c index 0dc8d5ead7..7f0c335829 100644 --- a/libs/libc/time/lib_ctime.c +++ b/libs/libc/time/lib_ctime.c @@ -42,7 +42,7 @@ * timep - The current time represented as seconds since the epoch. * * Returned Value: - * One success a pointer to the string is returned; on failure, NULL is + * On success, a pointer to the string is returned; on failure, NULL is * returned. * ****************************************************************************/ diff --git a/libs/libc/time/lib_ctimer.c b/libs/libc/time/lib_ctimer.c index 54f188ab97..55b4eac1b0 100644 --- a/libs/libc/time/lib_ctimer.c +++ b/libs/libc/time/lib_ctimer.c @@ -47,7 +47,7 @@ * buf - A user provided buffer to receive the 26 character time string. * * Returned Value: - * One success, the pointer to the 'buf' is returned; on failure, NULL is + * On success, the pointer to the 'buf' is returned; on failure, NULL is * returned. * ****************************************************************************/ diff --git a/libs/libnx/nxfonts/nxfonts_cache.c b/libs/libnx/nxfonts/nxfonts_cache.c index e7a83439d5..a08ceeecc7 100644 --- a/libs/libnx/nxfonts/nxfonts_cache.c +++ b/libs/libnx/nxfonts/nxfonts_cache.c @@ -878,7 +878,7 @@ void nxf_cache_disconnect(FCACHE fhandle) * Zero (OK) is returned if the metrics were * * Returned Value: - * One success, a non-NULL font handle is returned. + * On success, a non-NULL font handle is returned. * ****************************************************************************/ diff --git a/sched/mqueue/mq_initialize.c b/sched/mqueue/mq_initialize.c index a95d05b45a..2c0febe111 100644 --- a/sched/mqueue/mq_initialize.c +++ b/sched/mqueue/mq_initialize.c @@ -114,7 +114,7 @@ mq_msgblockalloc(FAR sq_queue_t *queue, uint16_t nmsgs, * Name: nxmq_initialize * * Description: - * This function initializes the messasge system. This function must + * This function initializes the message system. This function must * be called early in the initialization sequence before any of the * other message interfaces execute. * diff --git a/sched/mqueue/mq_rcvinternal.c b/sched/mqueue/mq_rcvinternal.c index bfc53b44de..a7b278822b 100644 --- a/sched/mqueue/mq_rcvinternal.c +++ b/sched/mqueue/mq_rcvinternal.c @@ -59,7 +59,7 @@ * msglen - Size of the buffer in bytes * * Returned Value: - * One success, zero (OK) is returned. A negated errno value is returned + * On success, zero (OK) is returned. A negated errno value is returned * on any failure: * * EPERM Message queue opened not opened for reading. @@ -108,7 +108,7 @@ int nxmq_verify_receive(FAR struct mqueue_inode_s *msgq, * received message. * * Returned Value: - * One success, zero (OK) is returned. A negated errno value is returned + * On success, zero (OK) is returned. A negated errno value is returned * on any failure. * * Assumptions: diff --git a/sched/mqueue/mq_receive.c b/sched/mqueue/mq_receive.c index ad86568bff..6eea885358 100644 --- a/sched/mqueue/mq_receive.c +++ b/sched/mqueue/mq_receive.c @@ -203,7 +203,7 @@ ssize_t nxmq_receive(mqd_t mqdes, FAR char *msg, size_t msglen, * prio - If not NULL, the location to store message priority. * * Returned Value: - * One success, the length of the selected message in bytes is returned. + * On success, the length of the selected message in bytes is returned. * On failure, -1 (ERROR) is returned and the errno is set appropriately: * * EAGAIN The queue was empty, and the O_NONBLOCK flag was set diff --git a/sched/mqueue/mq_sndinternal.c b/sched/mqueue/mq_sndinternal.c index 449aec3a39..90864c9f52 100644 --- a/sched/mqueue/mq_sndinternal.c +++ b/sched/mqueue/mq_sndinternal.c @@ -62,7 +62,7 @@ * prio - The priority of the message * * Returned Value: - * One success, 0 (OK) is returned. On failure, a negated errno value is + * On success, 0 (OK) is returned. On failure, a negated errno value is * returned. * * EINVAL Either msg or msgq is NULL or the value of prio is invalid. diff --git a/sched/mqueue/mq_timedreceive.c b/sched/mqueue/mq_timedreceive.c index a0213825ab..3db255b9f5 100644 --- a/sched/mqueue/mq_timedreceive.c +++ b/sched/mqueue/mq_timedreceive.c @@ -336,7 +336,7 @@ ssize_t nxmq_timedreceive(mqd_t mqdes, FAR char *msg, size_t msglen, * abstime - the absolute time to wait until a timeout is declared. * * Returned Value: - * One success, the length of the selected message in bytes is returned. + * On success, the length of the selected message in bytes is returned. * On failure, -1 (ERROR) is returned and the errno is set appropriately: * * EAGAIN The queue was empty, and the O_NONBLOCK flag was set