You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by gi...@apache.org on 2021/07/07 00:10:51 UTC
[incubator-nuttx-website] branch asf-site updated: Publishing web:
934a4647f20f1ab1148ce00d3b05b97fb19ad702 docs:
e506b2a52cb8a617e1d3cdc0465bb90c4db61b67
This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-nuttx-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new afcd8c4 Publishing web: 934a4647f20f1ab1148ce00d3b05b97fb19ad702 docs: e506b2a52cb8a617e1d3cdc0465bb90c4db61b67
afcd8c4 is described below
commit afcd8c470538a26c2f963e3dcd5c3ae73d2c7d92
Author: Nathan <59...@users.noreply.github.com>
AuthorDate: Wed Jul 7 00:08:31 2021 +0000
Publishing web: 934a4647f20f1ab1148ce00d3b05b97fb19ad702 docs: e506b2a52cb8a617e1d3cdc0465bb90c4db61b67
---
content/docs/10.0.0/index.html | 2 +-
content/docs/10.0.1/index.html | 2 +-
content/docs/10.1.0/index.html | 2 +-
.../latest/_sources/reference/os/wqueue.rst.txt | 45 +++++++++++-----------
content/docs/latest/index.html | 2 +-
content/docs/latest/reference/os/wqueue.html | 45 +++++++++++-----------
content/feed.xml | 4 +-
7 files changed, 50 insertions(+), 52 deletions(-)
diff --git a/content/docs/10.0.0/index.html b/content/docs/10.0.0/index.html
index 0e8bfa6..3de6dfb 100644
--- a/content/docs/10.0.0/index.html
+++ b/content/docs/10.0.0/index.html
@@ -207,7 +207,7 @@ by following these <a class="reference internal" href="contributing/documentatio
<div class="section" id="nuttx-documentation">
<h1>NuttX Documentation<a class="headerlink" href="#nuttx-documentation" title="Permalink to this headline">¶</a></h1>
<p>NuttX is a real-time operating system (RTOS) with an emphasis on standards compliance and small footprint. Scalable from 8-bit to 32-bit microcontroller environments, the primary governing standards in NuttX are Posix and ANSI standards. Additional standard APIs from Unix and other common RTOS’s (such as VxWorks) are adopted for functionality not available under these standards, or for functionality that is not appropriate for deeply-embedded environments (such as fork()).</p>
-<p>Last Updated: 06 July 21 at 00:05</p>
+<p>Last Updated: 07 July 21 at 00:05</p>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Table of Contents</span></p>
<ul class="current">
diff --git a/content/docs/10.0.1/index.html b/content/docs/10.0.1/index.html
index 21851a5..51d487d 100644
--- a/content/docs/10.0.1/index.html
+++ b/content/docs/10.0.1/index.html
@@ -213,7 +213,7 @@ by following these <a class="reference internal" href="contributing/documentatio
<div class="section" id="nuttx-documentation">
<h1>NuttX Documentation<a class="headerlink" href="#nuttx-documentation" title="Permalink to this headline">¶</a></h1>
<p>NuttX is a real-time operating system (RTOS) with an emphasis on standards compliance and small footprint. Scalable from 8-bit to 32-bit microcontroller environments, the primary governing standards in NuttX are Posix and ANSI standards. Additional standard APIs from Unix and other common RTOS’s (such as VxWorks) are adopted for functionality not available under these standards, or for functionality that is not appropriate for deeply-embedded environments (such as fork()).</p>
-<p>Last Updated: 06 July 21 at 00:05</p>
+<p>Last Updated: 07 July 21 at 00:05</p>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Table of Contents</span></p>
<ul class="current">
diff --git a/content/docs/10.1.0/index.html b/content/docs/10.1.0/index.html
index bf395ce..394e569 100644
--- a/content/docs/10.1.0/index.html
+++ b/content/docs/10.1.0/index.html
@@ -213,7 +213,7 @@ by following these <a class="reference internal" href="contributing/documentatio
<div class="section" id="nuttx-documentation">
<h1>NuttX Documentation<a class="headerlink" href="#nuttx-documentation" title="Permalink to this headline">¶</a></h1>
<p>NuttX is a real-time operating system (RTOS) with an emphasis on standards compliance and small footprint. Scalable from 8-bit to 64-bit microcontroller environments, the primary governing standards in NuttX are POSIX and ANSI standards. Additional standard APIs from Unix and other common RTOS’s (such as VxWorks) are adopted for functionality not available under these standards, or for functionality that is not appropriate for deeply-embedded environments (such as fork()).</p>
-<p>Last Updated: 06 July 21 at 00:05</p>
+<p>Last Updated: 07 July 21 at 00:06</p>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Table of Contents</span></p>
<ul class="current">
diff --git a/content/docs/latest/_sources/reference/os/wqueue.rst.txt b/content/docs/latest/_sources/reference/os/wqueue.rst.txt
index 749f3b7..c3fc954 100644
--- a/content/docs/latest/_sources/reference/os/wqueue.rst.txt
+++ b/content/docs/latest/_sources/reference/os/wqueue.rst.txt
@@ -10,10 +10,10 @@ for delayed processing, or for serializing activities.
Classes of Work Queues
======================
-There are three different classes of
-work queues, each with different properties and intended usage.
-These class of work queues along with the common work queue
-interface are described in the following paragraphs.
+There are three different classes of work queues, each with
+different properties and intended usage. These classes of work
+queues along with the common work queue interface are described in
+the following paragraphs.
High Priority Kernel Work queue
-------------------------------
@@ -89,9 +89,9 @@ work queue runs at a lower priority than the high priority work
queue, of course, and so is inappropriate to serve as a driver
*bottom half*. It is, otherwise, very similar to the high priority
work queue and most of the discussion above for the high priority
-work queue applies equally here. The lower priority work queue
-does have one important, however, that make it better suited for
-some tasks:
+work queue applies equally here. The lower priority work queue does
+have one important property, however, that makes it better suited
+for some tasks:
**Priority Inheritance**. The lower priority worker thread(s)
support *priority inheritance* (if <config>
@@ -100,8 +100,8 @@ lower priority worker thread can then be adjusted to match the
highest priority client.
**NOTE:** This priority inheritance feature is not automatic.
- The lower priority worker thread will always a fixed priority
- unless additional logic implements that calls
+ The lower priority worker thread will always have a fixed
+ priority unless additional logic calls
``lpwork_boostpriority()`` to raise the priority of the lower
priority worker thread (typically called before scheduling the
work) and then calls the matching ``lpwork_restorepriority()``
@@ -144,19 +144,18 @@ User-Mode Work Queue
**Work Queue Accessibility**. The high- and low-priority worker
threads are kernel-mode threads. In the normal, *flat* NuttX
-build, these work queues are are useful to application code and
+build, these work queues are useful to application code and
may be shared. However, in the NuttX protected and kernel build
modes, kernel mode code is isolated and cannot be accessed from
user-mode code.
**User-Mode Work Queue**. if either ``CONFIG_BUILD_PROTECTED`` or
``CONFIG_BUILD_KERNEL`` are selected, then the option to enable a
-special user-mode work queue is enable. The interface to the
-user-mode work queue is identical to the interface to the
-kernel-mode work queues and the user-mode work queue is
-functionally equivalent to the high priority work queue. It
-differs in that its implementation does not depend on internal,
-kernel-space facilities.
+special user-mode work queue is enabled. The interface to the user-
+mode work queue is identical to that of the kernel-mode work queues
+and the user-mode work queue is functionally equivalent to the high
+priority work queue. It differs in that its implementation does not
+depend on internal, kernel-space facilities.
**Configuration Options**.
@@ -182,10 +181,10 @@ interface function identifies the work queue:
**Kernel-Mode Work Queue IDs:**
- ``HPWORK``. This ID of the high priority work queue that should
- only be used for hi-priority, time-critical, driver bottom-half
+ only be used for high-priority, time-critical, driver bottom-half
functions.
- ``LPWORK``. This is the ID of the low priority work queue that
- can be used for any purpose. if ``CONFIG_SCHED_LPWORK`` is not
+ can be used for any purpose. If ``CONFIG_SCHED_LPWORK`` is not
defined, then there is only one kernel work queue and
``LPWORK`` is equal to ``HPWORK``.
@@ -193,7 +192,7 @@ interface function identifies the work queue:
- ``USRWORK``. This is the ID of the user-mode work queue that
can be used for any purpose by applications. In a flat build,
- ``LPWORK`` is equal to ``LPWORK`` so that user applications
+ ``USRWORK`` is equal to ``LPWORK`` so that user applications
will use the lower priority work queue (if there is one).
Work Queue Interface Types
@@ -222,14 +221,14 @@ Work Queue Interfaces
zero by 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
+ ``work_queue()`` is called before the previous work has been
performed and removed from the queue, then any pending work will
be canceled and lost.
:param qid: The work queue ID.
:param work: The work structure to queue
:param worker: The worker callback to be invoked. The callback
- will invoked on the worker thread of execution.
+ will be invoked on the worker thread of execution.
:param arg: The argument that will be passed to the worker
callback function when it is invoked.
@@ -244,10 +243,10 @@ Work Queue Interfaces
Cancel previously queued work. This removes work
from the work queue. After work has been cancelled, it may be
- re-queue by calling ``work_queue()`` again.
+ re-queued by calling ``work_queue()`` again.
:param qid: The work queue ID.
- :param work: The previously queue work structure to cancel.
+ :param work: The previously queued work structure to cancel.
:return: Zero is returned on success; a negated ``errno`` is returned on
failure.
diff --git a/content/docs/latest/index.html b/content/docs/latest/index.html
index 629a963..7173c77 100644
--- a/content/docs/latest/index.html
+++ b/content/docs/latest/index.html
@@ -214,7 +214,7 @@ by following these <a class="reference internal" href="contributing/documentatio
<div class="section" id="nuttx-documentation">
<h1>NuttX Documentation<a class="headerlink" href="#nuttx-documentation" title="Permalink to this headline">¶</a></h1>
<p>NuttX is a real-time operating system (RTOS) with an emphasis on standards compliance and small footprint. Scalable from 8-bit to 64-bit microcontroller environments, the primary governing standards in NuttX are POSIX and ANSI standards. Additional standard APIs from Unix and other common RTOS’s (such as VxWorks) are adopted for functionality not available under these standards, or for functionality that is not appropriate for deeply-embedded environments (such as fork()).</p>
-<p>Last Updated: 06 July 21 at 00:05</p>
+<p>Last Updated: 07 July 21 at 00:06</p>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Table of Contents</span></p>
<ul class="current">
diff --git a/content/docs/latest/reference/os/wqueue.html b/content/docs/latest/reference/os/wqueue.html
index 9802f76..e1d629b 100644
--- a/content/docs/latest/reference/os/wqueue.html
+++ b/content/docs/latest/reference/os/wqueue.html
@@ -246,10 +246,10 @@ are useful for off-loading work to a different threading context,
for delayed processing, or for serializing activities.</p>
<div class="section" id="classes-of-work-queues">
<h2>Classes of Work Queues<a class="headerlink" href="#classes-of-work-queues" title="Permalink to this headline">¶</a></h2>
-<p>There are three different classes of
-work queues, each with different properties and intended usage.
-These class of work queues along with the common work queue
-interface are described in the following paragraphs.</p>
+<p>There are three different classes of work queues, each with
+different properties and intended usage. These classes of work
+queues along with the common work queue interface are described in
+the following paragraphs.</p>
<div class="section" id="high-priority-kernel-work-queue">
<h3>High Priority Kernel Work queue<a class="headerlink" href="#high-priority-kernel-work-queue" title="Permalink to this headline">¶</a></h3>
<p>The dedicated high-priority
@@ -317,9 +317,9 @@ work queue runs at a lower priority than the high priority work
queue, of course, and so is inappropriate to serve as a driver
<em>bottom half</em>. It is, otherwise, very similar to the high priority
work queue and most of the discussion above for the high priority
-work queue applies equally here. The lower priority work queue
-does have one important, however, that make it better suited for
-some tasks:</p>
+work queue applies equally here. The lower priority work queue does
+have one important property, however, that makes it better suited
+for some tasks:</p>
<p><strong>Priority Inheritance</strong>. The lower priority worker thread(s)
support <em>priority inheritance</em> (if <config>
CONFIG_PRIORITY_INHERITANCE is also selected): The priority of the
@@ -327,8 +327,8 @@ lower priority worker thread can then be adjusted to match the
highest priority client.</p>
<blockquote>
<div><p><strong>NOTE:</strong> This priority inheritance feature is not automatic.
-The lower priority worker thread will always a fixed priority
-unless additional logic implements that calls
+The lower priority worker thread will always have a fixed
+priority unless additional logic calls
<code class="docutils literal notranslate"><span class="pre">lpwork_boostpriority()</span></code> to raise the priority of the lower
priority worker thread (typically called before scheduling the
work) and then calls the matching <code class="docutils literal notranslate"><span class="pre">lpwork_restorepriority()</span></code>
@@ -370,18 +370,17 @@ the lower priority worker thread. Default: 2048.</p></li>
<h3>User-Mode Work Queue<a class="headerlink" href="#user-mode-work-queue" title="Permalink to this headline">¶</a></h3>
<p><strong>Work Queue Accessibility</strong>. The high- and low-priority worker
threads are kernel-mode threads. In the normal, <em>flat</em> NuttX
-build, these work queues are are useful to application code and
+build, these work queues are useful to application code and
may be shared. However, in the NuttX protected and kernel build
modes, kernel mode code is isolated and cannot be accessed from
user-mode code.</p>
<p><strong>User-Mode Work Queue</strong>. if either <code class="docutils literal notranslate"><span class="pre">CONFIG_BUILD_PROTECTED</span></code> or
<code class="docutils literal notranslate"><span class="pre">CONFIG_BUILD_KERNEL</span></code> are selected, then the option to enable a
-special user-mode work queue is enable. The interface to the
-user-mode work queue is identical to the interface to the
-kernel-mode work queues and the user-mode work queue is
-functionally equivalent to the high priority work queue. It
-differs in that its implementation does not depend on internal,
-kernel-space facilities.</p>
+special user-mode work queue is enabled. The interface to the user-
+mode work queue is identical to that of the kernel-mode work queues
+and the user-mode work queue is functionally equivalent to the high
+priority work queue. It differs in that its implementation does not
+depend on internal, kernel-space facilities.</p>
<p><strong>Configuration Options</strong>.</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">CONFIG_LIB_USRWORK</span></code>. If CONFIG_LIB_USRWORK is also defined
@@ -404,10 +403,10 @@ interface function identifies the work queue:</p>
<p><strong>Kernel-Mode Work Queue IDs:</strong></p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">HPWORK</span></code>. This ID of the high priority work queue that should
-only be used for hi-priority, time-critical, driver bottom-half
+only be used for high-priority, time-critical, driver bottom-half
functions.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">LPWORK</span></code>. This is the ID of the low priority work queue that
-can be used for any purpose. if <code class="docutils literal notranslate"><span class="pre">CONFIG_SCHED_LPWORK</span></code> is not
+can be used for any purpose. If <code class="docutils literal notranslate"><span class="pre">CONFIG_SCHED_LPWORK</span></code> is not
defined, then there is only one kernel work queue and
<code class="docutils literal notranslate"><span class="pre">LPWORK</span></code> is equal to <code class="docutils literal notranslate"><span class="pre">HPWORK</span></code>.</p></li>
</ul>
@@ -415,7 +414,7 @@ defined, then there is only one kernel work queue and
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">USRWORK</span></code>. This is the ID of the user-mode work queue that
can be used for any purpose by applications. In a flat build,
-<code class="docutils literal notranslate"><span class="pre">LPWORK</span></code> is equal to <code class="docutils literal notranslate"><span class="pre">LPWORK</span></code> so that user applications
+<code class="docutils literal notranslate"><span class="pre">USRWORK</span></code> is equal to <code class="docutils literal notranslate"><span class="pre">LPWORK</span></code> so that user applications
will use the lower priority work queue (if there is one).</p></li>
</ul>
</div>
@@ -444,7 +443,7 @@ queued work will be performed on the worker thread of execution
zero by 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
-<code class="docutils literal notranslate"><span class="pre">work_queue()</span></code> is called before the previous work as been
+<code class="docutils literal notranslate"><span class="pre">work_queue()</span></code> is called before the previous work has been
performed and removed from the queue, then any pending work will
be canceled and lost.</p>
<dl class="field-list simple">
@@ -453,7 +452,7 @@ be canceled and lost.</p>
<li><p><strong>qid</strong> – The work queue ID.</p></li>
<li><p><strong>work</strong> – The work structure to queue</p></li>
<li><p><strong>worker</strong> – The worker callback to be invoked. The callback
-will invoked on the worker thread of execution.</p></li>
+will be invoked on the worker thread of execution.</p></li>
<li><p><strong>arg</strong> – The argument that will be passed to the worker
callback function when it is invoked.</p></li>
<li><p><strong>delay</strong> – Delay (in system clock ticks) from the time queue
@@ -472,12 +471,12 @@ immediately.</p></li>
<span class="pre">int</span> <code class="sig-name descname"><span class="pre">work_cancel</span></code><span class="sig-paren">(</span><span class="pre">int</span> <em><span class="pre">qid</span></em>, <span class="pre">FAR</span> <em class="property"><span class="pre">struct</span></em> <span class="pre">work_s</span> <span class="pre">*</span><em><span class="pre">work</span></em><span class="sig-paren">)</span><a class="headerlink" href="#c.work_cancel" title="Permalink to this defi [...]
<dd><p>Cancel previously queued work. This removes work
from the work queue. After work has been cancelled, it may be
-re-queue by calling <code class="docutils literal notranslate"><span class="pre">work_queue()</span></code> again.</p>
+re-queued by calling <code class="docutils literal notranslate"><span class="pre">work_queue()</span></code> again.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>qid</strong> – The work queue ID.</p></li>
-<li><p><strong>work</strong> – The previously queue work structure to cancel.</p></li>
+<li><p><strong>work</strong> – The previously queued work structure to cancel.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
diff --git a/content/feed.xml b/content/feed.xml
index 9ecaa87..d8bbe81 100644
--- a/content/feed.xml
+++ b/content/feed.xml
@@ -5,8 +5,8 @@
<description></description>
<link>/</link>
<atom:link href="/feed.xml" rel="self" type="application/rss+xml"/>
- <pubDate>Tue, 06 Jul 2021 00:07:25 +0000</pubDate>
- <lastBuildDate>Tue, 06 Jul 2021 00:07:25 +0000</lastBuildDate>
+ <pubDate>Wed, 07 Jul 2021 00:08:29 +0000</pubDate>
+ <lastBuildDate>Wed, 07 Jul 2021 00:08:29 +0000</lastBuildDate>
<generator>Jekyll v3.8.5</generator>
<item>