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 8a2ae17 Publishing web: feb249977349f687d40e57cfe5f0d39e5c5c71f9
docs: 2b5be56bd070d8a9be0299af7f9a517b79715ebc
8a2ae17 is described below
commit 8a2ae1758adaa01bcf415e7375e94b7fe2c7d7fa
Author: Matias <mat...@protobits.dev>
AuthorDate: Thu Oct 22 00:55:36 2020 +0000
Publishing web: feb249977349f687d40e57cfe5f0d39e5c5c71f9 docs:
2b5be56bd070d8a9be0299af7f9a517b79715ebc
---
.../latest/_sources/quickstart/debugging.rst.txt | 33 +++++++++++----------
content/docs/latest/index.html | 2 +-
content/docs/latest/objects.inv | Bin 21168 -> 21177 bytes
content/docs/latest/quickstart/debugging.html | 28 +++++++++--------
content/docs/latest/searchindex.js | 2 +-
content/feed.xml | 4 +--
6 files changed, 37 insertions(+), 32 deletions(-)
diff --git a/content/docs/latest/_sources/quickstart/debugging.rst.txt
b/content/docs/latest/_sources/quickstart/debugging.rst.txt
index 24a3e6d..379240d 100644
--- a/content/docs/latest/_sources/quickstart/debugging.rst.txt
+++ b/content/docs/latest/_sources/quickstart/debugging.rst.txt
@@ -89,28 +89,31 @@ You can put a bunch of these into a simple script to
configure the logging the w
make oldconfig
-JTAG Debugging
---------------
+JTAG/SWD Debugging
+------------------
`JTAG <https://en.wikipedia.org/wiki/JTAG>`_ is a set of standards that
specify a way to attach a hardware device to
your embedded board, and then remotely control the CPU. You can load code,
start, stop, step through the program, and
-examine variables and memory.
-
-This guide assumes your board has a JTAG connector, and you have a JTAG
hardware debugger like a
-`Segger J-Link <https://www.segger.com/products/debug-probes/j-link/>`_ or
`OpenOCD <http://openocd.org/doc-release/html/index.html>`_.
+examine variables and memory. `SWD
<https://en.wikipedia.org/wiki/JTAG#Similar_interface_standards>`_ is an
+Arm-specific interface with a reduced number of signals which can be used
alternatively.
The NuttX operating system uses `threads
<https://en.wikipedia.org/wiki/Thread_(computing)>`_, so you need a
thread-aware debugger to do more than load code, start, and stop it. A
thread-aware debugger will allow you to switch
threads to the one that is running the code you're interested in, for instance
your application, or an operating system
-network thread. So far, OpenOCD is the only supported NuttX thread-aware
debugger.
-
-You will need an OpenOCD-compatible hardware adapter, ideally a fast one (USB
2.0 High Speed). This guide assumes you
-are using the `Olimex ARM USB TINY H
<https://www.olimex.com/Products/ARM/JTAG/ARM-USB-TINY-H/>`_.
-(`Olimex ARM USB TINY H on Amazon
<https://smile.amazon.com/Olimex-ARM-USB-TINY-H-Arm-Jtag/dp/B009UED630/>`_.)
Other
-adapters may work, follow the OpenOCD instructions and the instructions that
came with your adapter.
-
-You'll need to use the `Sony fork of OpenOCD
<https://github.com/sony/openocd-nuttx>`_. Download and install it
-according to the OpenOCD instructions.
+network thread. So far, `OpenOCD <http://openocd.org/>`_ is the only supported
NuttX thread-aware debugger.
+
+.. note::
+ OpenOCD hasn't announced a stable release for a few years but the
development remains active. You'll need to use a
+ version of OpenOCD recent enough so that it includes NuttX support as
`contributed by Sony upstream
+ <http://openocd.zylin.com/#/c/4103/>`_. The version included in official OS
repositories will probably be too old.
+ You should build from source or use one of the unofficial, more recent
builds. See `Getting OpenOCD
+ <http://openocd.org/getting-openocd/>`_ for more details.
+
+You will need a board with a JTAG or SWD connector and an `OpenOCD-compatible
hardware adapter
+<http://openocd.org/supported-jtag-interfaces/>`_, ideally a fast one (USB 2.0
High Speed). For example an `Olimex
+ARM USB TINY H <https://www.olimex.com/Products/ARM/JTAG/ARM-USB-TINY-H/>`_ or
a `Segger J-Link
+<https://www.segger.com/products/debug-probes/j-link/>`_. Many other adapters
work too, follow the OpenOCD
+instructions and the instructions that came with your adapter.
See this article for more info:
`Debugging a Apache NuttX target with GDB and OpenOCD
<https://micro-ros.github.io/docs/tutorials/advanced/nuttx/debugging/>`_.
diff --git a/content/docs/latest/index.html b/content/docs/latest/index.html
index 41cf349..fea878f 100644
--- a/content/docs/latest/index.html
+++ b/content/docs/latest/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 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: 21 October 20 at 00:53</p>
+<p>Last Updated: 22 October 20 at 00:54</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/objects.inv b/content/docs/latest/objects.inv
index e8e808e..d18c467 100644
Binary files a/content/docs/latest/objects.inv and
b/content/docs/latest/objects.inv differ
diff --git a/content/docs/latest/quickstart/debugging.html
b/content/docs/latest/quickstart/debugging.html
index a10a63d..9872cd6 100644
--- a/content/docs/latest/quickstart/debugging.html
+++ b/content/docs/latest/quickstart/debugging.html
@@ -127,7 +127,7 @@
<li class="toctree-l2 current"><a class="current reference internal"
href="#">Debugging</a><ul>
<li class="toctree-l3"><a class="reference internal"
href="#debug-logging">Debug Logging</a></li>
<li class="toctree-l3"><a class="reference internal"
href="#changing-debug-settings-quickly">Changing Debug Settings Quickly</a></li>
-<li class="toctree-l3"><a class="reference internal"
href="#jtag-debugging">JTAG Debugging</a></li>
+<li class="toctree-l3"><a class="reference internal"
href="#jtag-swd-debugging">JTAG/SWD Debugging</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal"
href="organization.html">Directory Structure</a></li>
@@ -281,23 +281,25 @@ for instance turning them on or off before doing a
build:</p>
</pre></div>
</div>
</div>
-<div class="section" id="jtag-debugging">
-<h2>JTAG Debugging<a class="headerlink" href="#jtag-debugging"
title="Permalink to this headline">¶</a></h2>
+<div class="section" id="jtag-swd-debugging">
+<h2>JTAG/SWD Debugging<a class="headerlink" href="#jtag-swd-debugging"
title="Permalink to this headline">¶</a></h2>
<p><a class="reference external"
href="https://en.wikipedia.org/wiki/JTAG";>JTAG</a> is a set of standards that
specify a way to attach a hardware device to
your embedded board, and then remotely control the CPU. You can load code,
start, stop, step through the program, and
-examine variables and memory.</p>
-<p>This guide assumes your board has a JTAG connector, and you have a JTAG
hardware debugger like a
-<a class="reference external"
href="https://www.segger.com/products/debug-probes/j-link/";>Segger J-Link</a>
or <a class="reference external"
href="http://openocd.org/doc-release/html/index.html";>OpenOCD</a>.</p>
+examine variables and memory. <a class="reference external"
href="https://en.wikipedia.org/wiki/JTAG#Similar_interface_standards";>SWD</a>
is an
+Arm-specific interface with a reduced number of signals which can be used
alternatively.</p>
<p>The NuttX operating system uses <a class="reference external"
href="https://en.wikipedia.org/wiki/Thread_(computing)">threads</a>, so you
need a
thread-aware debugger to do more than load code, start, and stop it. A
thread-aware debugger will allow you to switch
threads to the one that is running the code you’re interested in, for instance
your application, or an operating system
-network thread. So far, OpenOCD is the only supported NuttX thread-aware
debugger.</p>
-<p>You will need an OpenOCD-compatible hardware adapter, ideally a fast one
(USB 2.0 High Speed). This guide assumes you
-are using the <a class="reference external"
href="https://www.olimex.com/Products/ARM/JTAG/ARM-USB-TINY-H/";>Olimex ARM USB
TINY H</a>.
-(<a class="reference external"
href="https://smile.amazon.com/Olimex-ARM-USB-TINY-H-Arm-Jtag/dp/B009UED630/";>Olimex
ARM USB TINY H on Amazon</a>.) Other
-adapters may work, follow the OpenOCD instructions and the instructions that
came with your adapter.</p>
-<p>You’ll need to use the <a class="reference external"
href="https://github.com/sony/openocd-nuttx";>Sony fork of OpenOCD</a>. Download
and install it
-according to the OpenOCD instructions.</p>
+network thread. So far, <a class="reference external"
href="http://openocd.org/";>OpenOCD</a> is the only supported NuttX thread-aware
debugger.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>OpenOCD hasn’t announced a stable release for a few years but the
development remains active. You’ll need to use a
+version of OpenOCD recent enough so that it includes NuttX support as <a
class="reference external"
href="http://openocd.zylin.com/#/c/4103/";>contributed by Sony upstream</a>. The
version included in official OS repositories will probably be too old.
+You should build from source or use one of the unofficial, more recent builds.
See <a class="reference external"
href="http://openocd.org/getting-openocd/";>Getting OpenOCD</a> for more
details.</p>
+</div>
+<p>You will need a board with a JTAG or SWD connector and an <a
class="reference external"
href="http://openocd.org/supported-jtag-interfaces/";>OpenOCD-compatible
hardware adapter</a>, ideally a fast one (USB 2.0 High Speed). For example an
<a class="reference external"
href="https://www.olimex.com/Products/ARM/JTAG/ARM-USB-TINY-H/";>Olimex
+ARM USB TINY H</a> or a <a class="reference external"
href="https://www.segger.com/products/debug-probes/j-link/";>Segger J-Link</a>.
Many other adapters work too, follow the OpenOCD
+instructions and the instructions that came with your adapter.</p>
<p>See this article for more info:
<a class="reference external"
href="https://micro-ros.github.io/docs/tutorials/advanced/nuttx/debugging/";>Debugging
a Apache NuttX target with GDB and OpenOCD</a>.</p>
<p>See the section <a class="reference internal"
href="running.html#running"><span class="std std-ref">Running</span></a> for a
brief tutorial on how to use GDB.</p>
diff --git a/content/docs/latest/searchindex.js
b/content/docs/latest/searchindex.js
index 5a9b15f..ad274b5 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","boards/index","components/binfmt","components/drivers/block/index","components/drivers/character/analog","components/drivers/character/can","components/drivers/character/index","components/drivers/character/keypad","components
[...]
\ 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","boards/index","components/binfmt","components/drivers/block/index","components/drivers/character/analog","components/drivers/character/can","components/drivers/character/index","components/drivers/character/keypad","components
[...]
\ No newline at end of file
diff --git a/content/feed.xml b/content/feed.xml
index 4e4786f..1a0b217 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>Wed, 21 Oct 2020 00:55:14 +0000</pubDate>
- <lastBuildDate>Wed, 21 Oct 2020 00:55:14 +0000</lastBuildDate>
+ <pubDate>Thu, 22 Oct 2020 00:55:35 +0000</pubDate>
+ <lastBuildDate>Thu, 22 Oct 2020 00:55:35 +0000</lastBuildDate>
<generator>Jekyll v3.8.5</generator>
<item>
