You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by ac...@apache.org on 2021/07/16 22:54:15 UTC
[incubator-nuttx] branch master updated: wqueue: Fix typos
This is an automated email from the ASF dual-hosted git repository.
acassis pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-nuttx.git
The following commit(s) were added to refs/heads/master by this push:
new af1fd49 wqueue: Fix typos
af1fd49 is described below
commit af1fd49fb0f60cce45ad06856247291ba5196403
Author: Nathan Hartman <59...@users.noreply.github.com>
AuthorDate: Mon Jul 5 17:19:30 2021 -0400
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.
---
include/nuttx/wqueue.h | 10 +++++-----
libs/libc/wqueue/work_cancel.c | 10 +++++-----
libs/libc/wqueue/work_queue.c | 16 ++++++++--------
sched/wqueue/kwork_cancel.c | 10 +++++-----
sched/wqueue/kwork_queue.c | 16 ++++++++--------
5 files changed, 31 insertions(+), 31 deletions(-)
diff --git a/include/nuttx/wqueue.h b/include/nuttx/wqueue.h
index ba96380..e78c46c 100644
--- a/include/nuttx/wqueue.h
+++ b/include/nuttx/wqueue.h
@@ -331,14 +331,14 @@ int work_usrstart(void);
* 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 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.
*
* Input Parameters:
* qid - The work queue ID
* work - The work structure to queue
- * worker - The worker callback to be invoked. The callback will invoked
- * on the worker thread of execution.
+ * worker - The worker callback to be invoked. The callback will be
+ * invoked on the worker thread of execution.
* arg - The argument that will be passed to the worker callback when
* it is invoked.
* 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:
* 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.
*
* Input Parameters:
* qid - The work queue ID
- * work - The previously queue work structure to cancel
+ * work - The previously queued work structure to cancel
*
* Returned Value:
* Zero on success, a negated errno on failure
diff --git a/libs/libc/wqueue/work_cancel.c b/libs/libc/wqueue/work_cancel.c
index 9665730..6af60c1 100644
--- a/libs/libc/wqueue/work_cancel.c
+++ b/libs/libc/wqueue/work_cancel.c
@@ -44,12 +44,12 @@
*
* Description:
* 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.
*
* Input Parameters:
* qid - The work queue ID
- * work - The previously queue work structure to cancel
+ * work - The previously queued work structure to cancel
*
* Returned Value:
* 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:
* 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
- * by calling work_queue() again.
+ * user mode work queue. After work has been cancelled, it may be
+ * requeued by calling work_queue() again.
*
* Input Parameters:
* 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:
* Zero (OK) on success, a negated errno on failure. This error may be
diff --git a/libs/libc/wqueue/work_queue.c b/libs/libc/wqueue/work_queue.c
index 5795077..1be23a0 100644
--- a/libs/libc/wqueue/work_queue.c
+++ b/libs/libc/wqueue/work_queue.c
@@ -58,9 +58,9 @@
* Input Parameters:
* qid - The work queue ID (index)
* work - The work structure to queue
- * worker - The worker callback to be invoked. The callback will invoked
- * on the worker thread of execution.
- * arg - The argument that will be passed to the workder callback when
+ * worker - The worker callback to be invoked. The callback will be
+ * invoked on the worker thread of execution.
+ * arg - The argument that will be passed to the worker callback when
* int is invoked.
* delay - Delay (in clock ticks) from the time queue until the worker
* 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)
{
- /* 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.
*/
@@ -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
* work queue logic. The caller should never modify the contents of 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.
*
* Input Parameters:
* qid - The work queue ID (index)
* work - The work structure to queue
- * worker - The worker callback to be invoked. The callback will invoked
- * on the worker thread of execution.
- * arg - The argument that will be passed to the workder callback when
+ * worker - The worker callback to be invoked. The callback will be
+ * invoked on the worker thread of execution.
+ * arg - The argument that will be passed to the worker callback when
* int is invoked.
* delay - Delay (in clock ticks) from the time queue until the worker
* is invoked. Zero means to perform the work immediately.
diff --git a/sched/wqueue/kwork_cancel.c b/sched/wqueue/kwork_cancel.c
index 7e52e09..69886b9 100644
--- a/sched/wqueue/kwork_cancel.c
+++ b/sched/wqueue/kwork_cancel.c
@@ -45,12 +45,12 @@
*
* Description:
* 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.
*
* Input Parameters:
* qid - The work queue ID
- * work - The previously queue work structure to cancel
+ * work - The previously queued work structure to cancel
*
* Returned Value:
* 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:
* 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
- * by calling work_queue() again.
+ * user mode work queue. After work has been cancelled, it may be
+ * requeued by calling work_queue() again.
*
* Input Parameters:
* 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:
* Zero (OK) on success, a negated errno on failure. This error may be
diff --git a/sched/wqueue/kwork_queue.c b/sched/wqueue/kwork_queue.c
index 5581df9..17fedb2 100644
--- a/sched/wqueue/kwork_queue.c
+++ b/sched/wqueue/kwork_queue.c
@@ -59,9 +59,9 @@
* Input Parameters:
* qid - The work queue ID (index)
* work - The work structure to queue
- * worker - The worker callback to be invoked. The callback will invoked
- * on the worker thread of execution.
- * arg - The argument that will be passed to the workder callback when
+ * worker - The worker callback to be invoked. The callback will be
+ * invoked on the worker thread of execution.
+ * arg - The argument that will be passed to the worker callback when
* int is invoked.
* delay - Delay (in clock ticks) from the time queue until the worker
* 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)
{
- /* 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.
*/
@@ -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
* work queue logic. The caller should never modify the contents of 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.
*
* Input Parameters:
* qid - The work queue ID (index)
* work - The work structure to queue
- * worker - The worker callback to be invoked. The callback will invoked
- * on the worker thread of execution.
- * arg - The argument that will be passed to the workder callback when
+ * worker - The worker callback to be invoked. The callback will be
+ * invoked on the worker thread of execution.
+ * arg - The argument that will be passed to the worker callback when
* int is invoked.
* delay - Delay (in clock ticks) from the time queue until the worker
* is invoked. Zero means to perform the work immediately.