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 2022/10/14 00:21:24 UTC
[incubator-nuttx-website] branch asf-site updated: Publishing web: d696c67810809c3f81a4dd87b09d9e940db854b4 docs: e9db7bbb8c1c4a4f4cbce2522afa22651889057f
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 eb9f401 Publishing web: d696c67810809c3f81a4dd87b09d9e940db854b4 docs: e9db7bbb8c1c4a4f4cbce2522afa22651889057f
eb9f401 is described below
commit eb9f40180851969c9394a9f98682af20d6f434f8
Author: dependabot[bot] <49...@users.noreply.github.com>
AuthorDate: Fri Oct 14 00:19:39 2022 +0000
Publishing web: d696c67810809c3f81a4dd87b09d9e940db854b4 docs: e9db7bbb8c1c4a4f4cbce2522afa22651889057f
---
content/docs/10.0.0/index.html | 2 +-
content/docs/10.0.1/index.html | 2 +-
content/docs/10.1.0/index.html | 2 +-
content/docs/10.2.0/index.html | 2 +-
content/docs/10.3.0/index.html | 2 +-
content/docs/11.0.0/index.html | 2 +-
.../docs/latest/_sources/guides/customapps.rst.txt | 84 +++++++++++-----------
.../latest/_sources/guides/customboards.rst.txt | 6 +-
content/docs/latest/guides/customapps.html | 6 +-
content/docs/latest/guides/customboards.html | 2 +-
content/docs/latest/index.html | 2 +-
content/docs/latest/searchindex.js | 2 +-
content/feed.xml | 4 +-
13 files changed, 58 insertions(+), 60 deletions(-)
diff --git a/content/docs/10.0.0/index.html b/content/docs/10.0.0/index.html
index 1b63f7b..2bba9ee 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: 13 October 22 at 08:17</p>
+<p>Last Updated: 14 October 22 at 00:16</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 5fcc870..caacbe8 100644
--- a/content/docs/10.0.1/index.html
+++ b/content/docs/10.0.1/index.html
@@ -219,7 +219,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: 13 October 22 at 08:17</p>
+<p>Last Updated: 14 October 22 at 00:17</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 120be6d..2c36eec 100644
--- a/content/docs/10.1.0/index.html
+++ b/content/docs/10.1.0/index.html
@@ -219,7 +219,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: 13 October 22 at 08:18</p>
+<p>Last Updated: 14 October 22 at 00:17</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.2.0/index.html b/content/docs/10.2.0/index.html
index 87a87f8..0eed55b 100644
--- a/content/docs/10.2.0/index.html
+++ b/content/docs/10.2.0/index.html
@@ -220,7 +220,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: 13 October 22 at 08:18</p>
+<p>Last Updated: 14 October 22 at 00:17</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.3.0/index.html b/content/docs/10.3.0/index.html
index 87a87f8..0eed55b 100644
--- a/content/docs/10.3.0/index.html
+++ b/content/docs/10.3.0/index.html
@@ -220,7 +220,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: 13 October 22 at 08:18</p>
+<p>Last Updated: 14 October 22 at 00:17</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/11.0.0/index.html b/content/docs/11.0.0/index.html
index 52f7f9a..f888a06 100644
--- a/content/docs/11.0.0/index.html
+++ b/content/docs/11.0.0/index.html
@@ -220,7 +220,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: 13 October 22 at 08:19</p>
+<p>Last Updated: 14 October 22 at 00:18</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/guides/customapps.rst.txt b/content/docs/latest/_sources/guides/customapps.rst.txt
index 5ae2ca6..4510fc1 100644
--- a/content/docs/latest/_sources/guides/customapps.rst.txt
+++ b/content/docs/latest/_sources/guides/customapps.rst.txt
@@ -2,7 +2,7 @@
Custom Apps How-to
==================
-Nuttx comes with a large number of Apps but, most likely, you will want to add your own.
+NuttX comes with a large number of Apps but, most likely, you will want to add your own.
There are various different options for this depending on your requirements.
@@ -23,7 +23,7 @@ the directory ``CustomApps`` as an example.
-----------------------------------------
The CustomApps directory need only to contain the minimum three files:
-
+
* ``Makefile``
* ``Kconfig``
* ``CustomHello.c``
@@ -34,74 +34,74 @@ The CustomApps directory need only to contain the minimum three files:
The custom application directory must include a Makefile to make all of the targets
expected by the NuttX build and must generate an archive called libapps.a in the
-top-level of the custom directory structure.
+top-level of the custom directory structure.
The Makefile has just those minimum required targets:
.. code-block:: console
APPDIR = ${shell pwd}
-
+
-include $(TOPDIR)/Make.defs
-
+
# files
-
+
CSRCS = CustomHello.c
COBJS = CustomHello.o
-
+
ROOTDEPPATH = --dep-path .
-
+
# Build targets
-
+
all: libapps.a
.PHONY: dirlinks context preconfig depend clean clean_context distclean
.PRECIOUS: libapps$(LIBEXT)
-
+
# Compile C Files
-
+
$(COBJS): %$(OBJEXT): %.c
$(call COMPILE, $<, $@)
-
+
# Add object files to the apps archive
-
+
libapps.a: $(COBJS)
$(call ARCHIVE, libapps.a, $(COBJS))
-
+
# Create directory links
-
+
dirlinks:
-
+
# Setup any special pre-build context
-
+
context:
-
+
# Setup any special pre-configuration context
-
+
preconfig:
-
+
# Make the dependency file, Make.deps
-
+
depend: Makefile $(CSRCS)
$(Q) $(MKDEP) $(ROOTDEPPATH) "$(CC)" -- $(CFLAGS) -- $(SRCS) > Make.dep
-
+
# Clean the results of the last build
-
+
clean:
$(call CLEAN)
-
+
# Remove the build context and directory links
-
+
clean_context:
-
+
# Restore the directory to its original state
-
+
distclean: clean clean_context
$(call DELFILE, Make.dep)
-
+
# Include dependencies
-
+
-include Make.dep
-
+
1.2 Kconfig
-----------
@@ -147,7 +147,7 @@ For this "Hello, Custom World!" application ``custom_hello()`` is the applicatio
.. code-block:: console
#include <stdio.h>
-
+
int custom_hello(int argc, char *argv[])
{
printf("Hello, Custom World!!\n");
@@ -171,14 +171,14 @@ This can be done by
* hand-editing the .config file before running make menuconfig, which is rarely a good idea
* Using ``kconfig-tweak --set-str CONFIG_APPS_DIR ../CustomApps``
* select the CustomApps directory as a command line option at the time the board is configured:
-
- .. code-block:: console
+
+ .. code-block:: console
./tools/configure.sh -a ../CustomApps <board>:<config>
or
- .. code-block:: console
+ .. code-block:: console
.tools/configure.sh -l ../CustomBoards/MyCustomBoardName/MyCustomConfig
@@ -193,12 +193,12 @@ Then build as you normally would. When you execute the custom_hello app you shou
---------------------------------------------------------------
The collection of apps provided in nuttx-apps can be useful, and this method simply
-extends the directory structure to include your own directory structure.
+extends the directory structure to include your own directory structure.
The existing /apps makefile automatically checks for the existence of sub-directories
that contain a ``Makefile`` and ``Make.defs`` file. This example assumes there is likely
to be more than one custom app, and includes a ``Kconfig`` for the app itself. Inclusion
-of a ``Kconfig`` allows custom App options to be included in the Nuttx configuration
+of a ``Kconfig`` allows custom App options to be included in the NuttX configuration
system, but is optional.
2.1 Custom Apps Directory
@@ -254,7 +254,7 @@ Create a Makefile in the ``CustomApps/CustomHello`` directory with the following
MAINSRC = CustomHello.c
- include $(APPDIR)/Application.mk
+ include $(APPDIR)/Application.mk
2.6 CustomHello Kconfig
@@ -275,7 +275,7 @@ the purposes of this example, the Kconfig will only cover our single application
default n
---help---
Enable the Custom Hello App
-
+
if CUSTOM_APPS_CUSTOM_HELLO
config CUSTOM_APPS_CUSTOM_HELLO_PROGNAME
@@ -284,7 +284,7 @@ the purposes of this example, the Kconfig will only cover our single application
---help---
This is the name of the program that will be used when the NSH ELF
program is installed.
-
+
config CUSTOM_APPS_CUSTOM_HELLO_PRIORITY
int "Custom Hello task priority"
default 100
@@ -292,7 +292,7 @@ the purposes of this example, the Kconfig will only cover our single application
config CUSTOM_APPS_CUSTOM_HELLO_STACKSIZE
int "Custom Hello stack size"
default DEFAULT_TASK_STACKSIZE
-
+
endif
2.7 Build and Run
@@ -319,7 +319,7 @@ outside of the default trees.
Create a directory for the custom apps in a location of your choosing. Then create A
symbolic link in the main nuttx/apps directory.
-This example assumes this has been placed below the top Nuttx folder, alongside the
+This example assumes this has been placed below the top NuttX folder, alongside the
default ``apps`` directory, i.e. ``nuttx/CustomApps``
.. code-block:: console
@@ -343,4 +343,4 @@ default ``apps`` directory, i.e. ``nuttx/CustomApps``
------------------
Follow all the steps as in sections 2.2 to 2.7 above, creating the exact same files but
-placing then in the new ``CustomApps`` directory location created as described here.
+placing then in the new ``CustomApps`` directory location created as described here.
diff --git a/content/docs/latest/_sources/guides/customboards.rst.txt b/content/docs/latest/_sources/guides/customboards.rst.txt
index fcd4301..d9eab5e 100644
--- a/content/docs/latest/_sources/guides/customboards.rst.txt
+++ b/content/docs/latest/_sources/guides/customboards.rst.txt
@@ -14,7 +14,7 @@ as "in-tree" boards) are configured using a standard syntax:
Refreshing...
Sometimes it is not appropriate, or not wanted, to add a new or custom board to
-the Nuttx boards tree itself. If so, the board can be defined out-of-tree in a
+the NuttX boards tree itself. If so, the board can be defined out-of-tree in a
custom directory and still be built easily.
------------------
@@ -25,7 +25,7 @@ The same set of files as provided for in-tree boards is required (i.e. configs,
Kconfig, scripts, etc.) but these can be placed in a directory of your choice.
In this example, the files are assumed to exist in:
- ``../nuttx/CustomBoards/MyCustomBoardName``
+ ``../nuttx/CustomBoards/MyCustomBoardName``
.. code-block:: console
@@ -67,5 +67,3 @@ They should be set to suit your board name and directory location.
.. Note::
If you subsequently run a ``make distclean`` operation, then these settings will be lost.
They should be added back before building, and/or before running ``make menuconfig``.
-
-
diff --git a/content/docs/latest/guides/customapps.html b/content/docs/latest/guides/customapps.html
index 6a5781f..31cd07d 100644
--- a/content/docs/latest/guides/customapps.html
+++ b/content/docs/latest/guides/customapps.html
@@ -170,7 +170,7 @@
<section id="custom-apps-how-to">
<h1>Custom Apps How-to<a class="headerlink" href="#custom-apps-how-to" title="Permalink to this headline"></a></h1>
-<p>Nuttx comes with a large number of Apps but, most likely, you will want to add your own.</p>
+<p>NuttX comes with a large number of Apps but, most likely, you will want to add your own.</p>
<p>There are various different options for this depending on your requirements.</p>
<blockquote>
<div><ol class="arabic simple">
@@ -354,7 +354,7 @@ extends the directory structure to include your own directory structure.</p>
<p>The existing /apps makefile automatically checks for the existence of sub-directories
that contain a <code class="docutils literal notranslate"><span class="pre">Makefile</span></code> and <code class="docutils literal notranslate"><span class="pre">Make.defs</span></code> file. This example assumes there is likely
to be more than one custom app, and includes a <code class="docutils literal notranslate"><span class="pre">Kconfig</span></code> for the app itself. Inclusion
-of a <code class="docutils literal notranslate"><span class="pre">Kconfig</span></code> allows custom App options to be included in the Nuttx configuration
+of a <code class="docutils literal notranslate"><span class="pre">Kconfig</span></code> allows custom App options to be included in the NuttX configuration
system, but is optional.</p>
<section id="custom-apps-directory">
<h3>2.1 Custom Apps Directory<a class="headerlink" href="#custom-apps-directory" title="Permalink to this headline"></a></h3>
@@ -463,7 +463,7 @@ outside of the default trees.</p>
<h3>3.1 Create Custom Apps directory and a Symbolic Link<a class="headerlink" href="#create-custom-apps-directory-and-a-symbolic-link" title="Permalink to this headline"></a></h3>
<p>Create a directory for the custom apps in a location of your choosing. Then create A
symbolic link in the main nuttx/apps directory.</p>
-<p>This example assumes this has been placed below the top Nuttx folder, alongside the
+<p>This example assumes this has been placed below the top NuttX folder, alongside the
default <code class="docutils literal notranslate"><span class="pre">apps</span></code> directory, i.e. <code class="docutils literal notranslate"><span class="pre">nuttx/CustomApps</span></code></p>
<blockquote>
<div><div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nb">pwd</span>
diff --git a/content/docs/latest/guides/customboards.html b/content/docs/latest/guides/customboards.html
index b98b063..ca5e611 100644
--- a/content/docs/latest/guides/customboards.html
+++ b/content/docs/latest/guides/customboards.html
@@ -164,7 +164,7 @@ as “in-tree” boards) are configured using a standard syntax:</p>
</div>
</div></blockquote>
<p>Sometimes it is not appropriate, or not wanted, to add a new or custom board to
-the Nuttx boards tree itself. If so, the board can be defined out-of-tree in a
+the NuttX boards tree itself. If so, the board can be defined out-of-tree in a
custom directory and still be built easily.</p>
<section id="add-a-custom-board">
<h2>Add a Custom Board<a class="headerlink" href="#add-a-custom-board" title="Permalink to this headline"></a></h2>
diff --git a/content/docs/latest/index.html b/content/docs/latest/index.html
index 97d7ca6..88551dd 100644
--- a/content/docs/latest/index.html
+++ b/content/docs/latest/index.html
@@ -145,7 +145,7 @@ by following these <a class="reference internal" href="contributing/documentatio
<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: 13 October 22 at 08:19</p>
+<p>Last Updated: 14 October 22 at 00:18</p>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Table of Contents</span></p>
<ul class="current">
diff --git a/content/docs/latest/searchindex.js b/content/docs/latest/searchindex.js
index 7113075..f0d45f5 100644
--- a/content/docs/latest/searchindex.js
+++ b/content/docs/latest/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["applications/index","applications/nsh/builtin","applications/nsh/commands","applications/nsh/config","applications/nsh/customizing","applications/nsh/index","applications/nsh/installation","applications/nsh/login","applications/nsh/nsh","components/binfmt","components/drivers/block/index","components/drivers/character/analog","components/drivers/character/can","components/drivers/character/foc","components/drivers/character/index","components/drivers/character [...]
\ No newline at end of file
+Search.setIndex({docnames:["applications/index","applications/nsh/builtin","applications/nsh/commands","applications/nsh/config","applications/nsh/customizing","applications/nsh/index","applications/nsh/installation","applications/nsh/login","applications/nsh/nsh","components/binfmt","components/drivers/block/index","components/drivers/character/analog","components/drivers/character/can","components/drivers/character/foc","components/drivers/character/index","components/drivers/character [...]
\ No newline at end of file
diff --git a/content/feed.xml b/content/feed.xml
index db9c48a..3947a54 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>Thu, 13 Oct 2022 08:20:34 +0000</pubDate>
- <lastBuildDate>Thu, 13 Oct 2022 08:20:34 +0000</lastBuildDate>
+ <pubDate>Fri, 14 Oct 2022 00:19:36 +0000</pubDate>
+ <lastBuildDate>Fri, 14 Oct 2022 00:19:36 +0000</lastBuildDate>
<generator>Jekyll v3.8.5</generator>
<item>