wqueue: Fix typos

include/nuttx/wqueue.h:
libs/libc/wqueue/work_cancel.c:
libs/libc/wqueue/work_queue.c:
sched/wqueue/kwork_cancel.c:
sched/wqueue/kwork_queue.c:

    * Fix spelling, grammar, and typos.
    * Improve wording in a few areas.
    * These changes affect comments only. No functional changes.
This commit is contained in:
Nathan Hartman
2021-07-05 17:19:30 -04:00
committed by Alan Carvalho de Assis
parent c47faa7120
commit af1fd49fb0
5 changed files with 31 additions and 31 deletions
+5 -5
View File
@@ -331,14 +331,14 @@ int work_usrstart(void);
* the caller. Otherwise, the work structure is completely managed by the * the caller. Otherwise, the work structure is completely managed by the
* work queue logic. The caller should never modify the contents of the * work queue logic. The caller should never modify the contents of the
* work queue structure directly. If work_queue() is called before the * work queue structure directly. If work_queue() is called before the
* previous work as been performed and removed from the queue, then any * previous work has been performed and removed from the queue, then any
* pending work will be canceled and lost. * pending work will be canceled and lost.
* *
* Input Parameters: * Input Parameters:
* qid - The work queue ID * qid - The work queue ID
* work - The work structure to queue * work - The work structure to queue
* worker - The worker callback to be invoked. The callback will invoked * worker - The worker callback to be invoked. The callback will be
* on the worker thread of execution. * invoked on the worker thread of execution.
* arg - The argument that will be passed to the worker callback when * arg - The argument that will be passed to the worker callback when
* it is invoked. * it is invoked.
* delay - Delay (in clock ticks) from the time queue until the worker * delay - Delay (in clock ticks) from the time queue until the worker
@@ -357,12 +357,12 @@ int work_queue(int qid, FAR struct work_s *work, worker_t worker,
* *
* Description: * Description:
* Cancel previously queued work. This removes work from the work queue. * Cancel previously queued work. This removes work from the work queue.
* After work has been cancelled, it may be re-queue by calling * After work has been cancelled, it may be requeued by calling
* work_queue() again. * work_queue() again.
* *
* Input Parameters: * Input Parameters:
* qid - The work queue ID * qid - The work queue ID
* work - The previously queue work structure to cancel * work - The previously queued work structure to cancel
* *
* Returned Value: * Returned Value:
* Zero on success, a negated errno on failure * Zero on success, a negated errno on failure
+5 -5
View File
@@ -44,12 +44,12 @@
* *
* Description: * Description:
* Cancel previously queued work. This removes work from the work queue. * Cancel previously queued work. This removes work from the work queue.
* After work has been cancelled, it may be re-queue by calling * After work has been cancelled, it may be requeued by calling
* work_queue() again. * work_queue() again.
* *
* Input Parameters: * Input Parameters:
* qid - The work queue ID * qid - The work queue ID
* work - The previously queue work structure to cancel * work - The previously queued work structure to cancel
* *
* Returned Value: * Returned Value:
* Zero (OK) on success, a negated errno on failure. This error may be * Zero (OK) on success, a negated errno on failure. This error may be
@@ -107,12 +107,12 @@ static int work_qcancel(FAR struct usr_wqueue_s *wqueue,
* *
* Description: * Description:
* Cancel previously queued user-mode work. This removes work from the * Cancel previously queued user-mode work. This removes work from the
* user mode work queue. After work has been cancelled, it may be re-queue * user mode work queue. After work has been cancelled, it may be
* by calling work_queue() again. * requeued by calling work_queue() again.
* *
* Input Parameters: * Input Parameters:
* qid - The work queue ID (must be USRWORK) * qid - The work queue ID (must be USRWORK)
* work - The previously queue work structure to cancel * work - The previously queued work structure to cancel
* *
* Returned Value: * Returned Value:
* Zero (OK) on success, a negated errno on failure. This error may be * Zero (OK) on success, a negated errno on failure. This error may be
+8 -8
View File
@@ -58,9 +58,9 @@
* Input Parameters: * Input Parameters:
* qid - The work queue ID (index) * qid - The work queue ID (index)
* work - The work structure to queue * work - The work structure to queue
* worker - The worker callback to be invoked. The callback will invoked * worker - The worker callback to be invoked. The callback will be
* on the worker thread of execution. * invoked on the worker thread of execution.
* arg - The argument that will be passed to the workder callback when * arg - The argument that will be passed to the worker callback when
* int is invoked. * int is invoked.
* delay - Delay (in clock ticks) from the time queue until the worker * delay - Delay (in clock ticks) from the time queue until the worker
* is invoked. Zero means to perform the work immediately. * is invoked. Zero means to perform the work immediately.
@@ -84,7 +84,7 @@ static int work_qqueue(FAR struct usr_wqueue_s *wqueue,
if (work->worker != NULL) if (work->worker != NULL)
{ {
/* Remove the entry from the work queue. It will re requeued at the /* Remove the entry from the work queue. It will be requeued at the
* end of the work queue. * end of the work queue.
*/ */
@@ -123,15 +123,15 @@ static int work_qqueue(FAR struct usr_wqueue_s *wqueue,
* the caller. Otherwise, the work structure is completely managed by the * the caller. Otherwise, the work structure is completely managed by the
* work queue logic. The caller should never modify the contents of the * work queue logic. The caller should never modify the contents of the
* work queue structure directly. If work_queue() is called before the * work queue structure directly. If work_queue() is called before the
* previous work as been performed and removed from the queue, then any * previous work has been performed and removed from the queue, then any
* pending work will be canceled and lost. * pending work will be canceled and lost.
* *
* Input Parameters: * Input Parameters:
* qid - The work queue ID (index) * qid - The work queue ID (index)
* work - The work structure to queue * work - The work structure to queue
* worker - The worker callback to be invoked. The callback will invoked * worker - The worker callback to be invoked. The callback will be
* on the worker thread of execution. * invoked on the worker thread of execution.
* arg - The argument that will be passed to the workder callback when * arg - The argument that will be passed to the worker callback when
* int is invoked. * int is invoked.
* delay - Delay (in clock ticks) from the time queue until the worker * delay - Delay (in clock ticks) from the time queue until the worker
* is invoked. Zero means to perform the work immediately. * is invoked. Zero means to perform the work immediately.
+5 -5
View File
@@ -45,12 +45,12 @@
* *
* Description: * Description:
* Cancel previously queued work. This removes work from the work queue. * Cancel previously queued work. This removes work from the work queue.
* After work has been cancelled, it may be re-queue by calling * After work has been cancelled, it may be requeued by calling
* work_queue() again. * work_queue() again.
* *
* Input Parameters: * Input Parameters:
* qid - The work queue ID * qid - The work queue ID
* work - The previously queue work structure to cancel * work - The previously queued work structure to cancel
* *
* Returned Value: * Returned Value:
* Zero (OK) on success, a negated errno on failure. This error may be * Zero (OK) on success, a negated errno on failure. This error may be
@@ -106,12 +106,12 @@ static int work_qcancel(FAR struct kwork_wqueue_s *wqueue,
* *
* Description: * Description:
* Cancel previously queued user-mode work. This removes work from the * Cancel previously queued user-mode work. This removes work from the
* user mode work queue. After work has been cancelled, it may be re-queue * user mode work queue. After work has been cancelled, it may be
* by calling work_queue() again. * requeued by calling work_queue() again.
* *
* Input Parameters: * Input Parameters:
* qid - The work queue ID (must be HPWORK or LPWORK) * qid - The work queue ID (must be HPWORK or LPWORK)
* work - The previously queue work structure to cancel * work - The previously queued work structure to cancel
* *
* Returned Value: * Returned Value:
* Zero (OK) on success, a negated errno on failure. This error may be * Zero (OK) on success, a negated errno on failure. This error may be
+8 -8
View File
@@ -59,9 +59,9 @@
* Input Parameters: * Input Parameters:
* qid - The work queue ID (index) * qid - The work queue ID (index)
* work - The work structure to queue * work - The work structure to queue
* worker - The worker callback to be invoked. The callback will invoked * worker - The worker callback to be invoked. The callback will be
* on the worker thread of execution. * invoked on the worker thread of execution.
* arg - The argument that will be passed to the workder callback when * arg - The argument that will be passed to the worker callback when
* int is invoked. * int is invoked.
* delay - Delay (in clock ticks) from the time queue until the worker * delay - Delay (in clock ticks) from the time queue until the worker
* is invoked. Zero means to perform the work immediately. * is invoked. Zero means to perform the work immediately.
@@ -89,7 +89,7 @@ static void work_qqueue(FAR struct kwork_wqueue_s *wqueue,
if (work->worker != NULL) if (work->worker != NULL)
{ {
/* Remove the entry from the work queue. It will re requeued at the /* Remove the entry from the work queue. It will be requeued at the
* end of the work queue. * end of the work queue.
*/ */
@@ -127,15 +127,15 @@ static void work_qqueue(FAR struct kwork_wqueue_s *wqueue,
* the caller. Otherwise, the work structure is completely managed by the * the caller. Otherwise, the work structure is completely managed by the
* work queue logic. The caller should never modify the contents of the * work queue logic. The caller should never modify the contents of the
* work queue structure directly. If work_queue() is called before the * work queue structure directly. If work_queue() is called before the
* previous work as been performed and removed from the queue, then any * previous work has been performed and removed from the queue, then any
* pending work will be canceled and lost. * pending work will be canceled and lost.
* *
* Input Parameters: * Input Parameters:
* qid - The work queue ID (index) * qid - The work queue ID (index)
* work - The work structure to queue * work - The work structure to queue
* worker - The worker callback to be invoked. The callback will invoked * worker - The worker callback to be invoked. The callback will be
* on the worker thread of execution. * invoked on the worker thread of execution.
* arg - The argument that will be passed to the workder callback when * arg - The argument that will be passed to the worker callback when
* int is invoked. * int is invoked.
* delay - Delay (in clock ticks) from the time queue until the worker * delay - Delay (in clock ticks) from the time queue until the worker
* is invoked. Zero means to perform the work immediately. * is invoked. Zero means to perform the work immediately.