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 2020/09/04 23:42:17 UTC
[incubator-nuttx-website] branch asf-site updated: Publishing web:
36f9d16d072aff843aeea6047e41d15a3c4fcaec docs:
b88038a1e1dc60f87c4768870f5de9a80201025a
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 37b517d Publishing web: 36f9d16d072aff843aeea6047e41d15a3c4fcaec docs: b88038a1e1dc60f87c4768870f5de9a80201025a
37b517d is described below
commit 37b517d5c1b0ba2c11e3830519696475e8aed2da
Author: Brennan <ba...@brennanashton.com>
AuthorDate: Fri Sep 4 23:41:51 2020 +0000
Publishing web: 36f9d16d072aff843aeea6047e41d15a3c4fcaec docs: b88038a1e1dc60f87c4768870f5de9a80201025a
---
.../_sources/contributing/coding_style.rst.txt | 3 +
.../latest/_sources/contributing/index.rst.txt | 1 +
.../_sources/contributing/making-changes.rst.txt | 222 ++++++++++
.../docs/latest/_sources/guides/drivers.rst.txt | 204 +++++++++
content/docs/latest/_sources/guides/index.rst.txt | 2 +
.../docs/latest/_sources/guides/simulator.rst.txt | 189 +++++++++
.../_sources/quickstart/build_and_make.rst.txt | 60 +++
.../latest/_sources/quickstart/compiling.rst.txt | 59 +++
.../_sources/quickstart/config_build.rst.txt | 131 ------
.../latest/_sources/quickstart/configuring.rst.txt | 115 +++++
.../latest/_sources/quickstart/debugging.rst.txt | 141 +++++++
.../docs/latest/_sources/quickstart/index.rst.txt | 28 +-
.../latest/_sources/quickstart/install.rst.txt | 195 +++++++++
.../_sources/quickstart/organization.rst.txt | 24 +-
.../latest/_sources/quickstart/quickstart.rst.txt | 126 ++++++
.../latest/_sources/quickstart/running.rst.txt | 105 +++++
content/docs/latest/applications/index.html | 2 +-
content/docs/latest/boards/index.html | 2 +-
content/docs/latest/components/binfmt.html | 2 +-
content/docs/latest/components/drivers/index.html | 2 +-
content/docs/latest/components/filesystem.html | 2 +-
content/docs/latest/components/index.html | 4 +-
content/docs/latest/components/nsh/builtin.html | 2 +-
content/docs/latest/components/nsh/commands.html | 2 +-
content/docs/latest/components/nsh/config.html | 2 +-
.../docs/latest/components/nsh/customizing.html | 2 +-
content/docs/latest/components/nsh/index.html | 2 +-
.../docs/latest/components/nsh/installation.html | 2 +-
content/docs/latest/components/nsh/login.html | 2 +-
content/docs/latest/components/nsh/nsh.html | 2 +-
content/docs/latest/components/nxflat.html | 2 +-
.../latest/components/nxgraphics/appendix.html | 2 +-
.../docs/latest/components/nxgraphics/index.html | 2 +-
content/docs/latest/components/nxgraphics/nx.html | 2 +-
.../latest/components/nxgraphics/nxcursor.html | 2 +-
.../docs/latest/components/nxgraphics/nxfonts.html | 2 +-
.../docs/latest/components/nxgraphics/nxgl.html | 2 +-
.../docs/latest/components/nxgraphics/nxtk.html | 2 +-
.../docs/latest/components/nxgraphics/sample.html | 2 +-
content/docs/latest/components/nxwidgets.html | 2 +-
content/docs/latest/components/paging.html | 2 +-
content/docs/latest/components/power.html | 2 +-
content/docs/latest/components/socketcan.html | 2 +-
content/docs/latest/components/syslog.html | 2 +-
content/docs/latest/contributing/coding_style.html | 7 +-
.../docs/latest/contributing/documentation.html | 3 +-
content/docs/latest/contributing/index.html | 9 +-
.../docs/latest/contributing/making-changes.html | 465 +++++++++++++++++++++
content/docs/latest/contributing/workflow.html | 5 +-
content/docs/latest/genindex.html | 2 +-
content/docs/latest/glossary.html | 2 +-
content/docs/latest/guides/drivers.html | 448 ++++++++++++++++++++
content/docs/latest/guides/index.html | 19 +-
content/docs/latest/guides/nfs.html | 4 +-
content/docs/latest/guides/simulator.html | 435 +++++++++++++++++++
content/docs/latest/guides/usbtrace.html | 6 +-
content/docs/latest/index.html | 17 +-
content/docs/latest/introduction/about.html | 2 +-
.../docs/latest/introduction/detailed_support.html | 2 +-
.../introduction/development_environments.html | 2 +-
content/docs/latest/introduction/index.html | 2 +-
content/docs/latest/introduction/inviolables.html | 4 +-
content/docs/latest/introduction/licensing.html | 2 +-
content/docs/latest/introduction/resources.html | 2 +-
.../latest/introduction/supported_platforms.html | 2 +-
content/docs/latest/introduction/trademarks.html | 2 +-
content/docs/latest/objects.inv | Bin 18079 -> 19270 bytes
.../{config_build.html => build_and_make.html} | 117 ++----
.../quickstart/{index.html => compiling.html} | 85 +++-
content/docs/latest/quickstart/configuring.html | 348 +++++++++++++++
content/docs/latest/quickstart/debugging.html | 363 ++++++++++++++++
content/docs/latest/quickstart/index.html | 42 +-
content/docs/latest/quickstart/install.html | 451 ++++++++++++++++++++
content/docs/latest/quickstart/organization.html | 38 +-
content/docs/latest/quickstart/quickstart.html | 349 ++++++++++++++++
content/docs/latest/quickstart/running.html | 353 ++++++++++++++++
content/docs/latest/reference/index.html | 2 +-
content/docs/latest/reference/os/addrenv.html | 2 +-
content/docs/latest/reference/os/app_vs_os.html | 2 +-
content/docs/latest/reference/os/arch.html | 2 +-
content/docs/latest/reference/os/board.html | 2 +-
content/docs/latest/reference/os/boardctl.html | 2 +-
content/docs/latest/reference/os/conventions.html | 2 +-
content/docs/latest/reference/os/index.html | 2 +-
content/docs/latest/reference/os/iob.html | 2 +-
content/docs/latest/reference/os/led.html | 2 +-
content/docs/latest/reference/os/nuttx.html | 2 +-
content/docs/latest/reference/os/paging.html | 2 +-
content/docs/latest/reference/os/shm.html | 2 +-
content/docs/latest/reference/os/smp.html | 2 +-
content/docs/latest/reference/os/time_clock.html | 2 +-
content/docs/latest/reference/os/wqueue.html | 2 +-
.../latest/reference/user/01_task_control.html | 2 +-
.../latest/reference/user/02_task_scheduling.html | 2 +-
.../latest/reference/user/03_task_control.html | 2 +-
.../latest/reference/user/04_message_queue.html | 2 +-
.../reference/user/05_counting_semaphore.html | 2 +-
.../latest/reference/user/06_clocks_timers.html | 2 +-
content/docs/latest/reference/user/07_signals.html | 2 +-
content/docs/latest/reference/user/08_pthread.html | 2 +-
.../docs/latest/reference/user/09_env_vars.html | 2 +-
.../docs/latest/reference/user/10_filesystem.html | 2 +-
content/docs/latest/reference/user/11_network.html | 2 +-
.../latest/reference/user/12_shared_memory.html | 2 +-
content/docs/latest/reference/user/index.html | 2 +-
content/docs/latest/reference/user/structures.html | 2 +-
content/docs/latest/releases/index.html | 4 +-
content/docs/latest/search.html | 2 +-
content/docs/latest/searchindex.js | 2 +-
content/docs/latest/substitutions.html | 2 +-
content/feed.xml | 4 +-
111 files changed, 4954 insertions(+), 371 deletions(-)
diff --git a/content/docs/latest/_sources/contributing/coding_style.rst.txt b/content/docs/latest/_sources/contributing/coding_style.rst.txt
index 5f0aeda..de58863 100644
--- a/content/docs/latest/_sources/contributing/coding_style.rst.txt
+++ b/content/docs/latest/_sources/contributing/coding_style.rst.txt
@@ -1,3 +1,6 @@
+.. include:: /substitutions.rst
+.. _coding-standard:
+
=================
C Coding Standard
=================
diff --git a/content/docs/latest/_sources/contributing/index.rst.txt b/content/docs/latest/_sources/contributing/index.rst.txt
index a69411b..b2428f0 100644
--- a/content/docs/latest/_sources/contributing/index.rst.txt
+++ b/content/docs/latest/_sources/contributing/index.rst.txt
@@ -8,6 +8,7 @@ and documentation (the one you are reading now):
:maxdepth: 2
workflow.rst
+ making-changes.rst
coding_style.rst
documentation.rst
diff --git a/content/docs/latest/_sources/contributing/making-changes.rst.txt b/content/docs/latest/_sources/contributing/making-changes.rst.txt
new file mode 100644
index 0000000..239433e
--- /dev/null
+++ b/content/docs/latest/_sources/contributing/making-changes.rst.txt
@@ -0,0 +1,222 @@
+.. include:: /substitutions.rst
+.. _making-changes:
+
+Making Changes Using Git
+========================
+
+The Apache NuttX project uses the `Git version control system <https://git-scm.com/book/en/v2/Getting-Started-About-Version-Control>`_
+to track changes, and the source code is hosted on `GitHub <https://www.github.com>`_.
+
+If you want to make changes to NuttX, for your own personal use, or to submit them back to project to improve NuttX,
+that's easy. For the purposes of this guide, you'll need a `GitHub <https://www.github.com>`_ account, since
+the Apache NuttX team uses GitHub. (You could also use git locally, or save your changes to other sites like
+`GitLab <https://about.gitlab.com/>`_ or `BitBucket <https://bitbucket.org>`_, but that's beyond the scope of this
+guide).
+
+Here's how to do it:
+
+#. Set your git user name and email
+
+ .. code-block:: bash
+
+ $ cd nuttx/
+ $ git config --global user.name "Your Name"
+ $ git config --global user.email "yourname@somedomaincom"
+
+#. Sign in to GitHub
+
+ If you don't have a `GitHub <https://www.github.com>`_ account, it's free to
+ sign up.
+
+
+#. Fork the Projects
+
+ Visit both these links and hit the Fork button in the upper right of the page:
+
+ * `NuttX <https://github.com/apache/incubator-nuttx/>`_
+ * `NuttX Apps <https://github.com/apache/incubator-nuttx-apps/>`_
+
+
+#. Clone the Repositories
+
+ On the GitHub web page for your forked ``incubator-nuttx`` project, copy the clone url – get it by hitting the
+ green ``Clone or Download`` button in the upper right. Then do this:
+
+ .. code-block:: bash
+
+ $ git clone <your forked incubator-nuttx project clone url>
+ $ git remote add upstream https://github.com/apache/incubator-nuttx.git
+
+ Do the same for your forked ``incubator-nuttx-apps`` project:
+
+ .. code-block:: bash
+
+ $ cd ../apps
+ $ git clone <your forked incubator-nuttx-apps project clone url>
+ $ git remote add upstream https://github.com/apache/incubator-nuttx-apps.git
+
+#. Create a Local Git Branch
+
+ Now you can create local git branches and push them to GitHub:
+
+ .. code-block:: bash
+
+ $ git checkout -b test/my-new-branch
+ $ git push
+
+
+Git Workflow With an Upstream Repository
+----------------------------------------
+
+The main NuttX git repository is called an "upstream" repository - this is because it's the main source of truth, and
+its changes flow downstream to people who've forked that repository, like us.
+
+Working with an upstream repo is a bit more complex, but it's worth it since you can submit fixes and features
+to the main NuttX repos. One of the things you need to do regularly is keep your local repo in sync
+with the upstream. I work with a local branch, make changes, pull new software from the upstream and merge it in,
+maybe doing that several times. Then when everything works, I get my branch ready to do a Pull Request. Here's how:
+
+#. Fetch upstream changes and merge into my local master:
+
+ .. code-block:: bash
+
+ $ git checkout master
+ $ git fetch upstream
+ $ git merge upstream/master
+ $ git push
+
+#. Merge my local master with my local branch:
+
+ .. code-block:: bash
+
+ $ git checkout my-local-branch
+ $ git merge master
+ $ git push
+
+#. Make changes and push them to my fork
+
+ .. code-block:: bash
+
+ $ vim my-file.c
+ $ git add my-file.c
+ $ git commit my-file.c
+ $ git push
+
+#. Repeat 1-3 as necessary
+
+#. Run the ``tools/checkpatch.sh`` script on your files
+
+ When your code runs, then you're almost ready to submit it. But first you need to check the code to ensure
+ that it conforms to the NuttX :ref:`contributing/coding_style:C Coding Standard`.
+ The ``tools/checkpatch.sh`` script will do that. Here's the usage info:
+
+ .. code-block:: bash
+
+ $ ./tools/checkpatch.sh -h
+ USAGE: ./tools/checkpatch.sh [options] [list|-]
+
+ Options:
+ -h
+ -c spell check with codespell(install with: pip install codespell
+ -r range check only (used with -p and -g)
+ -p <patch list> (default)
+ -g <commit list>
+ -f <file list>
+ - read standard input mainly used by git pre-commit hook as below:
+ git diff --cached | ./tools/checkpatch.sh -
+
+ Run it against your files and correct all the errors in the code you added, so that
+ ``tools/checkpatch.sh`` reports no errors. Then commit the result.
+ For example:
+
+ .. code-block:: bash
+
+ $ ./tools/checkpatch.sh -f my-file.c
+ arch/arm/src/sama5/hardware/my-file.c:876:82: warning: Long line found
+ $ # fix errors
+ $ vim my-file.c
+ $ # run again
+ $ ./tools/checkpatch.sh -f my-file.c
+
+ If you have made a lot of changes, you can also use this bash commandline to see the errors for all the changed C
+ files in your branch (assumes you are currently on the branch that has the changed files):
+
+ .. code-block:: bash
+
+ $ git diff --name-only master | egrep "\.c|\.h" | xargs echo | xargs ./tools/checkpatch.sh -f | less
+
+ Note that there are some bugs in the ``nxstyle`` program that ``checkpatch.sh`` uses, so
+ it may report a few errors that are not actually errors. The committers will help you
+ find these. (Or view the
+ `nxstyle Issues <https://github.com/apache/incubator-nuttx/issues?q=is%3Aissue+is%3Aopen+nxstyle>`_.)
+ |br|
+ |br|
+
+#. Commit the fixed files
+
+ .. code-block:: bash
+
+ $ git add my-file.c
+ $ git commit my-file.c
+ $ git push
+
+
+Submitting Your Changes to NuttX
+--------------------------------
+
+ Pull requests let you tell others about changes you've pushed to a branch in a repository on GitHub. Once a pull
+ request is opened, you can discuss and review the potential changes with collaborators and add follow-up commits
+ before your changes are merged into the base branch.
+
+ (from GitHub's `About pull requests <https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests>`_ page)
+
+Before you do a Pull Request, the NuttX team will usually want all the changes you made in your branch "squashed" into
+a single commit, so that when they review your changes, there's a clean view of the history. If there are changes
+after Pull Request review feedback, they can be separate commits. Here's the easiest way I found to do that initial
+squash before submitting the Pull Request:
+
+#. Check out my branch
+
+ .. code-block:: bash
+
+ $ git checkout my-branch
+
+#. Fetch the upstream code
+
+ .. code-block:: bash
+
+ $ git fetch upstream
+
+#. Rebase onto the upstream code
+
+ .. code-block:: bash
+
+ $ git rebase upstream/master
+
+#. Push to your remote
+
+ This needs to a force push with ``-f``.
+
+ .. code-block:: bash
+
+ $ git push -u my-branch -f
+
+#. Create a GitHub Pull Request
+
+ A Pull Request is how you ask your upstream to review and merge your changes.
+
+ Here's `GitHub's instructions for creating a Pull Request <https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request>`_.
+
+#. Get Pull Request feedback and implement changes
+
+ Get suggestions for improvements from reviewers, make changes, and push them to the branch. Once the reviewers are
+ happy, they may suggest squashing and merging again to make a single commit. In this case you would repeat steps
+ 1 through 6.
+
+Git Resources
+-------------
+
+* `Git Cheat Sheet (by GitHub) <https://github.github.com/training-kit/downloads/github-git-cheat-sheet.pdf>`_
+* `Git Book (online) <https://git-scm.com/book/en/v2>`_
+* `NuttX Code Contribution Workflow (draft) <https://cwiki.apache.org/confluence/display/NUTTX/Code+Contribution+Workflow>`_
+ – All the details are here if you need them!
diff --git a/content/docs/latest/_sources/guides/drivers.rst.txt b/content/docs/latest/_sources/guides/drivers.rst.txt
new file mode 100644
index 0000000..d458ed8
--- /dev/null
+++ b/content/docs/latest/_sources/guides/drivers.rst.txt
@@ -0,0 +1,204 @@
+.. include:: /substitutions.rst
+.. _drivers:
+
+Drivers
+=======
+
+Some NuttX boards don't have full support for all the on-chip peripherals. If you need support for this hardware,
+you will either need to port a driver from another chip, or write one yourself. This section discusses how to do that.
+
+Porting a Driver
+----------------
+
+Often support for on-chip peripherals exists in a closely related chip, or even a different family or from a different
+manufacturer. Many chips are made up of different Intellectual Property (IP) blocks that are licensed from vendors like
+Cadence, Synopsys, and others. The IP blocks may be similar enough to use another chip's driver with little
+modification.
+
+* Find a similar driver in NuttX source code:
+
+ * Look at register names listed in the datasheet for the peripheral.
+ * Search the NuttX codebase for the register names (try several different ones).
+ * Note that you'll have to compare the datasheet to the header and code files to see if there are differences; there
+ will usually be some differences between architectures, and they can be significant.
+
+* Find a similar driver in U-Boot, Zephyr or BSD Unix (OpenBSD, FreeBSD, NetBSD) source code:
+
+ * Only for inspiration, you can't copy code because of license incompatibility and Apache Foundation restrictions.
+ (Apache License 2.0 and BSD code can come in with a software grant agreement from the original authors; this can
+ sometimes be hard to get. Ask on the mailing list if you're unsure.)
+ * But you can debug to see how the driver works.
+ * `U-Boot <https://www.denx.de/wiki/U-Boot>`_ drivers are often easier to understand than BSD Unix drivers because
+ U-Boot is simpler.
+
+* Understanding how the driver works
+
+ Here are a couple of techniques that helped me.
+
+ * printf debugging
+
+ * Sprinkle ``custinfo()`` logging statements through your code to see execution paths and look at variables
+ while the code is running. The reason to use ``custinfo()`` as opposed to the other logging shortcuts
+ (``mcinfo()``, etc.) is that you can turn on and off other other logging and still see your custom debug
+ logging. Sometimes it's useful to quiet the flood of logging that comes from a particular debug logging
+ shortcut.
+ * Note that printing info to the console will affect timing.
+ * Keep a file with just your debug settings in it, like this (``debugsettings``):
+
+ .. code-block:: c
+
+ CONFIG_DEBUG_CUSTOM_INFO=y
+ (etc..)
+
+ * Add the settings to the end of your ``.config`` file after running ``make menuconfig`` (that will reorder
+ the file, making it harder to see and change the debug settings if you need to).
+
+ .. code-block:: bash
+
+ $ cat .config debugsettings > .config1 ; mv .config1 .config
+
+ * If you are using interrupts and threads (many things in NuttX run in different threads as a response to interrupts),
+ you can use printf debugging to see overlapping execution.
+
+ * Interrupts - here's how to inspect the C stack frame to see what execution environment is currently running:
+
+ .. code-block:: c
+
+ uint32_t frame = 0; /* MUST be the very first thing in the function */
+ uint32_t p_frame;
+ frame++; /* make sure that frame doesn't get optimized out */
+ p_frame = (uint32_t)(&frame);
+ custinfo("p_frame: %08x\n", p_frame);
+
+ * Threads - here's how to get the thread identifier to see which thread is currently executing:
+
+ .. code-block:: c
+
+ pthread_t thread_id = pthread_self();
+ custinfo("pthread_id: %08x\n", thread_id);
+
+ * stack frame printf
+ * thread printf
+
+ * `GDB — the Gnu Debugger <https://www.gnu.org/software/gdb/>`_
+
+ GDB is a great tool. In this guide we've already used it to load our program and run it. But it can do a lot
+ more. You can single-step through code, examine variables and memory, set breakpoints, and more. I generally use
+ it from the commandline, but have also used it from an IDE like JetBrains' Clion, where it's easier to see the
+ code context.
+
+ One add-on that I found to be essential is the ability to examine blocks of memory, like buffers that NuttX uses
+ for reading and writing to storage media or network adapters. This `Stack Overflow question on using GDB to
+ examine memory <https://stackoverflow.com/a/54784260/431222>`_ includes a GDB command that is very handy. Add
+ this to your ``.gdbinit`` file, and then use the ``xxd`` command to dump memory in an easy-to-read format:
+
+ .. code-block::
+
+ define xxd
+ if $argc < 2
+ set $size = sizeof(*$arg0)
+ else
+ set $size = $arg1
+ end
+ dump binary memory dump.bin $arg0 ((void *)$arg0)+$size
+ eval "shell xxd -o %d dump.bin; rm dump.bin", ((void *)$arg0)
+ end
+ document xxd
+ Dump memory with xxd command (keep the address as offset)
+
+ xxd addr [size]
+ addr -- expression resolvable as an address
+ size -- size (in byte) of memory to dump
+ sizeof(*addr) is used by default end
+
+ Here's a short GDB session that shows what this looks like in practice. Note that the memory location being
+ examined (``0x200aa9eo`` here) is a buffer being passed to ``mmcsd_readsingle``:
+
+ .. code-block::
+
+ Program received signal SIGTRAP, Trace/breakpoint trap.
+ 0x200166e8 in up_idle () at common/arm_idle.c:78
+ 78 }
+ (gdb) b mmcsd_readsingle
+ Breakpoint 1 at 0x2006ea70: file mmcsd/mmcsd_sdio.c, line 1371.
+ (gdb) c
+ Continuing.
+
+ Breakpoint 1, mmcsd_readsingle (priv=0x200aa8c0, buffer=0x200aa9e0 "WRTEST TXT \030", startblock=2432) at mmcsd/mmcsd_sdio.c:1371
+ 1371 finfo("startblock=%d\n", startblock);
+ (gdb) xxd 0x200aa9e0 200
+ 200aa9e0: 5752 5445 5354 2020 5458 5420 1800 0000 WRTEST TXT ....
+ 200aa9f0: 0000 0000 0000 0000 0000 5500 1100 0000 ..........U.....
+ 200aaa00: 5752 5445 5354 3520 5458 5420 1800 0000 WRTEST5 TXT ....
+ 200aaa10: 0000 0000 0000 0000 0000 5800 1500 0000 ..........X.....
+ 200aaa20: e552 5445 5854 3620 5458 5420 1800 0000 .RTEXT6 TXT ....
+ 200aaa30: 0000 0000 0000 0000 0000 5600 1200 0000 ..........V.....
+ 200aaa40: 5752 5445 5354 3620 5458 5420 1800 0000 WRTEST6 TXT ....
+ 200aaa50: 0000 0000 0000 0000 0000 5600 1200 0000 ..........V.....
+ 200aaa60: 0000 0000 0000 0000 0000 0000 0000 0000 ................
+ 200aaa70: 0000 0000 0000 0000 0000 0000 0000 0000 ................
+ 200aaa80: 0000 0000 0000 0000 0000 0000 0000 0000 ................
+ 200aaa90: 0000 0000 0000 0000 0000 0000 0000 0000 ................
+ 200aaaa0: 0000 0000 0000 0000 ........
+
+
+NuttX Drivers as a Reference
+----------------------------
+
+If you're not porting a NuttX driver from another architecture, it still helps to look at other similar NuttX
+drivers, if there are any. For instance, when implementing an Ethernet driver, look at other NuttX Ethernet drivers;
+for an SD Card driver, look at other NuttX Ethernet drivers. Even if the chip-specific code won't be the same, the
+structure to interface with NuttX can be used.
+
+Using Chip Datasheets
+---------------------
+
+To port or write a driver, you'll have to be familiar with the information in the chip datasheet. Definitely find
+the datasheet for your chip, and read the sections relevant to the peripheral you're working with. Doing so ahead
+of time will save a lot of time later.
+
+Another thing that's often helpful is to refer to sample code provided by the manufacturer, or driver code from
+another operating system (like U-Boot, Zephyr, or FreeBSD) while referring to the datasheet — seeing how working
+code implements the necessary algorithms often helps one understand how the driver needs to work.
+
+* How to use a datasheet
+
+ Key pieces of information in System-on-a-Chip (SoC) datasheets are usually:
+
+ * Chip Architecture Diagram — shows how the subsections of the chip (CPU, system bus, peripherals, I/O, etc.) connect
+ to each other.
+ * Memory Map — showing the location of peripheral registers in memory. This info usually goes into a header file.
+ * DMA Engine — if Direct Memory Access (DMA) is used, this may have info on how to use it.
+ * Peripheral — the datasheet usually has a section on how the peripheral works. Key parts of this include:
+
+ * Registers List — name and offset from the base memory address of the peripheral. This needs to go into a header
+ file.
+ * Register Map — what is the size of each register, and what do the bits mean? You will need to create ``#defines``
+ in a header file that your code will use to operate on the registers. Refer to other driver header files for
+ examples.
+
+Logic Analyzers
+---------------
+
+For drivers that involve input and output (I/O), especially that involve complex protocols like SD Cards, SPI, I2C,
+etc., actually seeing the waveform that goes in and out the chip's pins is extremely helpful. `Logic Analyzers <https://en.wikipedia.org/wiki/Logic_analyzer>`_
+can capture that information and display it graphically, allowing you to see if the driver is doing the right thing
+on the wire.
+
+DMA Debugging
+-------------
+
+* Dump registers before, during, and after transfer. Some NuttX drivers (``sam_sdmmc.c`` or ``imxrt_sdmmc.c`` for
+ example) have built-in code for debugging register states, and can sample registers before, during, and
+ immediately after a DMA transfer, as well as code that can dump the peripheral registers in a nicely-formatted
+ way onto the console device (which can be a serial console, a network console, or memory). Consider using something
+ like this to see what's happening inside the chip if you're trying to debug DMA transfer code.
+* Compare register settings to expected settings determined from the datasheet or from dumping registers from working
+ code in another operating system (U-Boot, Zephyr, FreeBSD, etc.).
+* Use the ``xxd`` GDB tool mentioned above to dump NuttX memory buffers before, during, and after a transfer to see if
+ data is being transferred correctly, if there are over- or under-runs, or to diagnose data being stored in incorrect
+ locations.
+* printf debugging register states can also help here.
+* Remember that logging can change the timing of any algorithms you might be using, so things may start or stop
+ working when logging is added or removed. Definitely test with logging disabled.
+
diff --git a/content/docs/latest/_sources/guides/index.rst.txt b/content/docs/latest/_sources/guides/index.rst.txt
index c592db1..74f7873 100644
--- a/content/docs/latest/_sources/guides/index.rst.txt
+++ b/content/docs/latest/_sources/guides/index.rst.txt
@@ -7,3 +7,5 @@ Guides
.. toctree::
nfs.rst
usbtrace.rst
+ simulator.rst
+ drivers.rst
diff --git a/content/docs/latest/_sources/guides/simulator.rst.txt b/content/docs/latest/_sources/guides/simulator.rst.txt
new file mode 100644
index 0000000..1cbfbe4
--- /dev/null
+++ b/content/docs/latest/_sources/guides/simulator.rst.txt
@@ -0,0 +1,189 @@
+.. include:: /substitutions.rst
+.. _simulator:
+
+Simulator
+=========
+
+Apache NuttX has a simulator that can run as a regular program on Linux, Mac, and Windows computers.
+It's useful for debugging operating system features that aren't associated with particular
+device drivers— for instance the TCP/IP stack itself, a web interface or API for your
+application, or other communication protocols. It's also handy for trying out Apache NuttX without
+having a piece of embedded hardware.
+
+This guide assumes you're on Linux. It works on Windows and Mac too— if you know how,
+submit a PR to improve this guide!
+
+.. todo:: Add Mac and Windows instructions
+
+Compiling
+---------
+
+#. Configure the Simulator
+
+ There are a lot of simulator configurations available that set you up to test various
+ operating system features.
+
+ Here we'll use the ``sim:nsh`` basic NuttX Shell configuration.
+
+ .. code-block:: console
+
+ $ cd nuttx
+ $ ./tools/configure.sh sim:nsh
+
+#. Compile
+
+ .. code-block:: console
+
+ $ make
+
+#. Run the simulator:
+
+ .. code-block:: console
+
+ $ ./nuttx
+ login: admin
+ password: Administrator
+ User Logged-in!
+
+ NuttShell (NSH) NuttX-9.1.0
+ MOTD: username=admin password=Administrator
+ nsh> help
+ help usage: help [-v] [<cmd>]
+
+ [ cp exit losetup mv rmdir true
+ ? cmp false ls mw set uname
+ basename dirname free mb poweroff sh unset
+ break dd help mkdir ps sleep usleep
+ cat echo hexdump mkfatfs pwd test xd
+ cd exec kill mh rm time
+
+ Builtin Apps:
+ hello nsh
+
+ nsh>
+
+#. Stop the simulator:
+
+ .. code-block:: console
+
+ nsh> poweroff
+ $
+ $ # we're back at the Linux prompt.
+
+Accessing the Network
+---------------------
+
+#. Here we'll use the ``sim:tcpblaster`` configuration because it comes with networking
+ that is ready to use.
+
+ .. code-block:: console
+
+ $ make distclean
+ $ ./tools/configure.sh sim:tcpblaster
+ $ make
+
+#. Give the Simulator Privileges
+
+ On recent Linux distributions, you need to give the ``nuttx`` program the capabilities
+ (similar to permissions) to access the network:
+
+ .. code-block:: console
+
+ $ sudo setcap cap_net_admin+ep ./nuttx
+
+#. Run the simulator:
+
+ .. code-block:: console
+
+ $ ./nuttx
+
+#. Bring Up the Network Interfaces
+
+ On Apache NuttX:
+
+ .. code-block:: console
+
+ nsh> ifup eth0
+
+ On Linux, first you need to find your main network interface— this will usually either
+ be an ethernet or wireless network adapter. Do this:
+
+ .. code-block:: console
+
+ $ ifconfig
+ lo: flags=73<UP,LOOPBACK,RUNNING> mtu 65536
+ inet 127.0.0.1 netmask 255.0.0.0
+ inet6 ::1 prefixlen 128 scopeid 0x10<host>
+ loop txqueuelen 1000 (Local Loopback)
+ RX packets 5846 bytes 614351 (614.3 KB)
+ RX errors 0 dropped 0 overruns 0 frame 0
+ TX packets 5846 bytes 614351 (614.3 KB)
+ TX errors 0 dropped 0 overruns 0 carrier 0 collisions 0
+
+ wlp0s20f3: flags=4163<UP,BROADCAST,RUNNING,MULTICAST> mtu 1500
+ inet 192.168.1.209 netmask 255.255.255.0 broadcast 192.168.1.255
+ inet6 fe80::1161:c26b:af05:d784 prefixlen 64 scopeid 0x20<link>
+ ether 24:41:8c:a8:30:d1 txqueuelen 1000 (Ethernet)
+ RX packets 219369 bytes 176416490 (176.4 MB)
+ RX errors 0 dropped 0 overruns 0 frame 0
+ TX packets 108399 bytes 27213617 (27.2 MB)
+ TX errors 0 dropped 0 overruns 0 carrier 0 collisions 0
+
+ ``lo0`` is the Loopback Interface, so ``wlp0s20f3`` is the wireless interface. Note
+ that it has an IP address on the local net. There may be other interfaces listed, you'll
+ need to pick the one that's right for your system.
+
+ Then, on Linux do this to set up the tap network interface and route that will let
+ the Apache Nuttx simulator access the network:
+
+ .. code-block:: console
+
+ $ sudo ./tools/simhostroute.sh wlp0s20f3 on
+ $ ping -c 1 10.0.1.2 # nuttx system
+ PING 10.0.1.2 (10.0.1.2) 56(84) bytes of data.
+ 64 bytes from 10.0.1.2: icmp_seq=1 ttl=64 time=7.52 ms
+
+ --- 10.0.1.2 ping statistics ---
+ 1 packets transmitted, 1 received, 0% packet loss, time 0ms
+ rtt min/avg/max/mdev = 7.529/7.529/7.529/0.000 m
+
+#. Test that Apache NuttX can access the Internet
+
+ First let's ping the network interface of our Linux host to prove we can see the
+ gateway to the Internet:
+
+ .. code-block:: console
+
+ nsh> ping -c 1 10.0.1.1
+ nsh> ping -c 1 10.0.1.1
+ PING 10.0.1.1 56 bytes of data
+ 56 bytes from 10.0.1.1: icmp_seq=0 time=0 ms
+ 1 packets transmitted, 1 received, 0% packet loss, time 1010 ms
+
+ Now let's ping one of Google's DNS servers to prove we can access the rest of the
+ Internet:
+
+ .. code-block:: console
+
+ nsh> ping -c 1 8.8.8.8
+ PING 8.8.8.8 56 bytes of data
+ 56 bytes from 8.8.8.8: icmp_seq=0 time=10 ms
+ 1 packets transmitted, 1 received, 0% packet loss, time 1010 ms
+
+ Success!
+
+Stopping
+--------
+
+If you don't have an nsh prompt, the only effective way to stop the simulator is kill it from another terminal:
+
+ .. code-block:: console
+
+ $ pkill nuttx
+
+
+
+Debugging
+---------
+
+You can debug the simulator like any regular Linux program.
diff --git a/content/docs/latest/_sources/quickstart/build_and_make.rst.txt b/content/docs/latest/_sources/quickstart/build_and_make.rst.txt
new file mode 100644
index 0000000..d1809af
--- /dev/null
+++ b/content/docs/latest/_sources/quickstart/build_and_make.rst.txt
@@ -0,0 +1,60 @@
+.. include:: /substitutions.rst
+.. _build_and_make:
+
+Build and Make Details
+======================
+
+This is included for reference, and it's not necessary to know all these details.
+
+As described in :ref:`compiling`, you use ``make`` at the root ``nuttx/`` directory to build NuttX. This is also
+referenced as ``$(TOPDIR)`` in the ``Makefile``.
+
+Root Directory
+--------------
+
+The ``$(TOPDIR)`` directory holds:
+
+- The top level ```Makefile`` <#topmakefile>`__ that controls the
+ NuttX build.
+
+That directory also holds:
+
+- The makefile fragment ```.config`` <#boardconfigsubdirs>`__
+ that describes the current configuration, and
+- The makefile fragment ```Make.defs`` <#boardconfigsubdirs>`__
+ that provides customized build targets.
+
+Environment Variables
+---------------------
+
+The specific environmental definitions
+are unique for each board but should include, as a minimum,
+updates to the ``PATH`` variable to include the full path to the
+architecture-specific toolchain identified in
+```Make.defs`` <#boardconfigsubdirs>`__.
+
+
+First Time Make
+---------------
+
+Additional configuration actions will be taken the first time that system is built. These additional steps
+include:
+
+- Auto-generating the file ``include/nuttx/config.h`` using the
+ ``$(TOPDIR)/.config`` file.
+- Auto-generating the file ``$(TOPDIR)/.version`` with version
+ 0.0 if one does not exist.
+- Auto-generating the file ``include/nuttx/version.h`` using the
+ ``$(TOPDIR)/.version`` file.
+- Creating a link to
+ ``$(TOPDIR)/arch/``\ *<arch-name>*\ ``/include`` at
+ ``$(TOPDIR)/include/arch``.
+- Creating a link to
+ ``$(TOPDIR)/boards/``\ *<arch-name>*\ ``/``\ *<chip-name>*\ ``/``\ *<board-name>*\ ``/include``
+ at ``$(TOPDIR)/include/arch/board``.
+- Creating a link to
+ ``$(TOPDIR)/boards/``\ *<arch-name>*\ ``/``\ *<chip-name>*\ ``/``\ *<board-name>*\ ``/src``
+ at ``$(TOPDIR)/arch/``\ *<arch-name>*\ ``/src/board``
+- Creating a link to ``${APPDIR}/include`` at
+ ``$(TOPDIR)/include/apps``
+- Creating make dependencies.
diff --git a/content/docs/latest/_sources/quickstart/compiling.rst.txt b/content/docs/latest/_sources/quickstart/compiling.rst.txt
new file mode 100644
index 0000000..b743936
--- /dev/null
+++ b/content/docs/latest/_sources/quickstart/compiling.rst.txt
@@ -0,0 +1,59 @@
+.. include:: /substitutions.rst
+.. _compiling:
+
+Compiling
+=========
+
+Now that we've installed Apache NuttX prerequisites and downloaded the source code, we are ready to compile the source code
+into an executable binary file that can be run on the embedded board.
+
+#. List Possible Apache NuttX Base Configurations
+
+ Find your hardware and a good starting application in the list of base configurations. In the application list,
+ ``nsh`` is the Apache NuttX Shell, an interactive commandline that's a good starting place if you're new.
+
+ .. code-block:: bash
+
+ $ cd nuttx
+ $ ./tools/configure.sh -L | less
+
+#. Initialize Configuration
+
+ Pick one of the board:application base configuration pairs from the list, and feed it to the
+ configuration script. The ``-l`` tells use that we're on Linux. macOS and Windows builds are
+ possible, this guide doesn't cover them yet.
+
+ .. code-block:: bash
+
+ $ cd nuttx
+ $ # this is the basic layout of the command:
+ $ # ./tools/configure.sh -l <board-name>:<config-dir>
+ $ # for example:
+ $ ./tools/configure.sh -l sama5d2-xult:nsh
+
+#. Customize Your Configuration (Optional)
+
+ This step is optional. Right now, this is mainly to get familiar with how it works– you don't need to change
+ any of the options now, but knowing how to do this will come in handy later.
+
+ There are a lot of options. We'll cover a few of them here. Don't worry about the complexity– you don't have to use most of the options.
+
+ .. code-block:: bash
+
+ $ make menuconfig
+
+#. Compile NuttX
+
+ .. code-block:: bash
+
+ $ make clean; make
+
+#. Install the Executable Program on Your Board
+
+ This step is a bit more complicated, depending on your board. It's covered in the section
+ :ref:`Running Apache NuttX <running>`.
+
+----
+
+Next up is :ref:`running`.
+
diff --git a/content/docs/latest/_sources/quickstart/config_build.rst.txt b/content/docs/latest/_sources/quickstart/config_build.rst.txt
deleted file mode 100644
index 6b5331d..0000000
--- a/content/docs/latest/_sources/quickstart/config_build.rst.txt
+++ /dev/null
@@ -1,131 +0,0 @@
-========================
-Configuring and Building
-========================
-
-Configuring NuttX
-=================
-
-**Manual Configuration**. Configuring NuttX requires only copying
-the `board-specific configuration files <#boardconfigsubdirs>`__
-into the top level directory which appears in the make files as
-the make variable, ``$(TOPDIR)``. This could be done manually as
-follows:
-
-- Copy
- ``boards/``\ *<arch-name>*\ ``/``\ *<chip-name>*\ ``/``\ *<board-name>*\ ``/configs/[``\ *<config-dir>*\ ``/]Make.defs``
- to ``$(TOPDIR)/Make.defs`` (see NOTE below),
-- Copy
- ``boards/``\ *<arch-name>*\ ``/``\ *<chip-name>*\ ``/``\ *<board-name>*\ ``/configs/[``\ *<config-dir>*\ ``/]defconfig``
- to ``$(TOPDIR)/.config``
-
-Where *<board-name>* is the name of one of the sub-directories of
-the NuttX ```boards/`` <#DirStructConfigs>`__ directory. This
-sub-directory name corresponds to one of the supported boards
-identified `above <#supportedboards>`__. <config-dir> is the
-optional, specific configuration directory for the board. And
-<app-dir> is the location of the optional application directory.
-
-NOTE: Recall that the ``Make.defs`` file may reside in either the
-``boards/``\ *<arch-name>*\ ``/``\ *<chip-name>*\ ``/``\ *<board-name>*/``configs/[``\ *<config-dir>*
-directory or in the
-``boards/``\ *<arch-name>*\ ``/``\ *<chip-name>*\ ``/``\ *<board-name>*/``scripts``.
-
-**Automated Configuration**. There is a script that automates
-these steps. The following steps will accomplish the same
-configuration:
-
-There is an alternative Windows batch file, ``configure.bat``,
-that can be used instead of ``configure.sh`` in the windows native
-environment like:
-
-And, to make sure that other platforms are supported, there is
-also a C program at ``tools/configure.c`` that can be compiled to
-establish the board configuration on all platforms.
-
- NOTE (2019-08-6): As of this writing, changes to the boards/
- directly have made ``configure.bat`` unusable. For the native
- Windows environment, ``configure.c`` is recommended until that
- batch file can be repaired.
-
-See ``tools/README.txt`` for more information about these scripts.
-Or use the -h option with ``configure.sh>``
-
-If your application directory is not in the standard location
-(``../apps`` or ``../apps-<version>``), then you should also
-specify the location of the application directory on the command
-line like:
-
-**Version Files**. The NuttX build expects to find a version file
-located in the top-level NuttX build directory. That version file
-is called ``.version``. The correct version file is installed in
-each versioned NuttX released. However, if you are working from an
-GIT snapshot, then there will be no version file. If there is no
-version file, the top-level ``Makefile`` will create a dummy
-``.version`` file on the first make. This dummy version file will
-contain all zeroes for version information. If that is not what
-you want, they you should run the ``version.sh`` script to create
-a better ``.version`` file.
-
-You can get help information from the ``version.sh`` script using
-the ``-h`` option. For example:
-
-As an example, the following command will generate a version file
-for version 6.1 using the current GIT revision number:
-
-The ``.version`` file is also used during the build process to
-create a C header file at ``include/nuttx/version.h`` that
-contains the same version information. That version file may be
-used by your C applications for, as an example, reporting version
-information.
-
-**Additional Configuration Steps**. The remainder of configuration
-steps will be performed by
-```$(TOPDIR)/Makefile`` <#topmakefile>`__ the first time the
-system is built as described below.
-
-Building NuttX
-==============
-
-**Building NuttX**. Once NuttX has been configured as described
-`above <#configuringnuttx>`__, it may be built as follows:
-
-The ``$(TOPDIR)`` directory holds:
-
-- The top level ```Makefile`` <#topmakefile>`__ that controls the
- NuttX build.
-
-That directory also holds:
-
-- The makefile fragment ```.config`` <#boardconfigsubdirs>`__
- that describes the current configuration, and
-- The makefile fragment ```Make.defs`` <#boardconfigsubdirs>`__
- that provides customized build targets.
-
-**Environment Variables**. The specific environmental definitions
-are unique for each board but should include, as a minimum,
-updates to the ``PATH`` variable to include the full path to the
-architecture-specific toolchain identified in
-```Make.defs`` <#boardconfigsubdirs>`__.
-
-**First Time Make.** Additional configuration actions will be
-taken the first time that system is built. These additional steps
-include:
-
-- Auto-generating the file ``include/nuttx/config.h`` using the
- ``$(TOPDIR)/.config`` file.
-- Auto-generating the file ``$(TOPDIR)/.version`` with version
- 0.0 if one does not exist.
-- Auto-generating the file ``include/nuttx/version.h`` using the
- ``$(TOPDIR)/.version`` file.
-- Creating a link to
- ``$(TOPDIR)/arch/``\ *<arch-name>*\ ``/include`` at
- ``$(TOPDIR)/include/arch``.
-- Creating a link to
- ``$(TOPDIR)/boards/``\ *<arch-name>*\ ``/``\ *<chip-name>*\ ``/``\ *<board-name>*\ ``/include``
- at ``$(TOPDIR)/include/arch/board``.
-- Creating a link to
- ``$(TOPDIR)/boards/``\ *<arch-name>*\ ``/``\ *<chip-name>*\ ``/``\ *<board-name>*\ ``/src``
- at ``$(TOPDIR)/arch/``\ *<arch-name>*\ ``/src/board``
-- Creating a link to ``${APPDIR}/include`` at
- ``$(TOPDIR)/include/apps``
-- Creating make dependencies.
diff --git a/content/docs/latest/_sources/quickstart/configuring.rst.txt b/content/docs/latest/_sources/quickstart/configuring.rst.txt
new file mode 100644
index 0000000..19fa3a7
--- /dev/null
+++ b/content/docs/latest/_sources/quickstart/configuring.rst.txt
@@ -0,0 +1,115 @@
+.. include:: /substitutions.rst
+.. _configuring:
+
+Configuring
+===========
+
+Apache NuttX is a very configurable operating system. Nearly all features can be configured in or
+out of the system. This makes it possible to compile a build tailored for your hardware and
+application. It also makes configuring the system complex at times.
+
+There is a configuration system that can be used on the commandline or in a GUI. I've found
+the easiest way to configured Apache NuttX is to use the ``menuconfig`` system. This is used
+via a terminal program and allows quick access to all of Apache NuttX's features via a system of
+menus.
+
+The Apache NuttX configuration system uses Linux's
+`kconfig system <https://www.kernel.org/doc/Documentation/kbuild/kconfig-language.txt>`_ adapted for use with Apache
+NuttX. Here's info on Linux's kconfig `menuconfig <https://en.wikipedia.org/wiki/Menuconfig>`_ system.
+
+After you've configured your board (see :ref:`compiling`), you can use the menuconfig system
+to change the configuration. Once you've configured, you can compile to make a build that
+has your configuration options selected.
+
+#. Initialize Board Configuration
+
+ Here we'll use the simulator since that's the simplest to explain. You can do this with
+ any board and base configuration. Note here you should be supplying `configure.sh` the correct flag
+ for your build environment:
+
+ .. code-block:: bash
+
+ -l selects the Linux (l) host environment.
+ -m selects the macOS (m) host environment.
+ -c selects the Windows host and Cygwin (c) environment.
+ -u selects the Windows host and Ubuntu under Windows 10 (u) environment.
+ -g selects the Windows host and MinGW/MSYS environment.
+ -n selects the Windows host and Windows native (n) environment.
+
+ Select the simulator configuration for a Linux host:
+
+ .. code-block:: bash
+
+ $ cd nuttx
+ $ make distclean # make a clean start, clearing out old configurations
+ $ ./tools/configure.sh -l sim:nsh
+ Copy files
+ Select CONFIG_HOST_LINUX=y
+ Refreshing...
+#. Make
+
+ .. code-block:: bash
+
+ $ make clean; make
+ $ ./nuttx
+ login:
+
+ From another terminal window, kill the simulator:
+
+ .. code-block:: bash
+
+ $ pkill nuttx
+
+#. Menu Configuration
+
+ Showing that ``login:`` is annyoing. Let's use the ``menuconfig`` system to turn it off.
+
+ .. code-block:: bash
+
+ $ make menuconfig
+
+ Here's what you should see:
+
+ .. image:: ../images/menuconfig.png
+ :width: 800px
+ :align: center
+ :alt: Screenshot of menuconfig system main screen
+
+ |br|
+
+#. Application Configuration
+
+ The NSH Login setting is under ``Application Configuration > NSH Library``. Use
+ the up and down arrows to navigate to ``Application Configuration``; hit ``<return>`` to
+ select it. Now you're in the ``Application Configuration`` menu. Use the arrows to go
+ down to ``NSH Library`` and select that. Now navigate down to ``Console Login`` and use
+ the spacebar to uncheck that setting (so that it has a blank space instead of a star in it).
+
+ Now let's save. Use the right and left arrow keys to select the ``Exit`` menu item at the
+ bottom of the screen. Hit ``<return>`` to select it, hit ``<return>`` again, and again, finally
+ hitting ``<return>`` in the ``Save Configuration`` dialog box.
+ |br|
+ |br|
+
+#. Make the New Configuration
+
+ .. code-block:: bash
+
+ $ make clean; make
+
+#. Run
+
+ .. code-block:: bash
+
+ $ ./nuttx
+ NuttShell (NSH) NuttX-8.2
+ MOTD: username=admin password=Administrator
+
+ Success!
+
+ If you find that message of the day (MOTD) annoying and want to turn that off, it's
+ configured in ``Application Configuration > NSH Library >> Message of the Day (MOTD)``.
+
+----
+
+Next up is :ref:`debugging`.
diff --git a/content/docs/latest/_sources/quickstart/debugging.rst.txt b/content/docs/latest/_sources/quickstart/debugging.rst.txt
new file mode 100644
index 0000000..94aa29e
--- /dev/null
+++ b/content/docs/latest/_sources/quickstart/debugging.rst.txt
@@ -0,0 +1,141 @@
+.. include:: /substitutions.rst
+.. _debugging:
+
+Debugging
+=========
+
+Finding and fixing bugs is an important part of the hardware and software development process. Sometimes you also need
+to use debugging techniques to understand how the system works. Two tools that are helpful are debug logging and
+debugging using the Gnu Debugger (gdb).
+
+Debug Logging
+-------------
+
+NuttX has a powerful logging facility with ``info``, ``warn``, and ``error`` levels. You can enable debugging for your
+build for the ``net`` feature (TCP/IP stack) by putting the following lines in your ``.config`` file:
+
+ ::
+
+ CONFIG_DEBUG_ALERT=y
+ CONFIG_DEBUG_FEATURES=y
+ CONFIG_DEBUG_ERROR=y
+ CONFIG_DEBUG_WARN=y
+ CONFIG_DEBUG_INFO=y
+ CONFIG_DEBUG_ASSERTIONS=y
+ CONFIG_DEBUG_NET=y
+ CONFIG_DEBUG_NET_ERROR=y
+ CONFIG_DEBUG_NET_WARN=y
+ CONFIG_DEBUG_NET_INFO=y
+ CONFIG_DEBUG_SYMBOLS=y
+ CONFIG_DEBUG_NOOPT=y
+ CONFIG_SYSLOG_TIMESTAMP=y
+
+Note that turning all these to ``y`` will produce an incredible amount of logging output. Set the level you want and
+the area you're interested in to ``y``, and the rest to ``n``, and then recompile. You can see the full list of
+debug feature areas in the file `debug.h <https://github.com/apache/incubator-nuttx/blob/master/include/debug.h>`__.
+
+Timestamps can be enabled by setting ``CONFIG_SYSLOG_TIMESTAMP=y``.
+
+You may need to do a little bit of experimenting to find the combination of logging settings that work for the problem
+you're trying to solve. See the file `debug.h <https://github.com/starcat-io/incubator-nuttx/blob/master/include/debug.h>`_
+for available debug settings that are available. This can also be configured via the ``menuconfig`` system.
+
+There are also subsystems that enable USB trace debugging, and you can log to memory too, if you need the logging to be
+faster than what the console can output.
+
+Changing Debug Settings Quickly
+-------------------------------
+
+You can use the ``kconfig-tweak`` script that comes with the ``kconfig-frontends`` tools to quickly change debug settings,
+for instance turning them on or off before doing a build:
+
+.. code-block:: bash
+
+ $ kconfig-tweak --disable CONFIG_DEBUG_NET
+ $ kconfig-tweak --enable CONFIG_DEBUG_NET
+
+You can put a bunch of these into a simple script to configure the logging the way you want:
+
+.. code-block:: bash
+
+ #!/bin/bash
+
+ $ kconfig-tweak --disable CONFIG_DEBUG_ALERT
+ $ kconfig-tweak --disable CONFIG_DEBUG_FEATURES
+ $ kconfig-tweak --disable CONFIG_DEBUG_ERROR
+ $ kconfig-tweak --disable CONFIG_DEBUG_WARN
+ $ kconfig-tweak --disable CONFIG_DEBUG_INFO
+ $ kconfig-tweak --disable CONFIG_DEBUG_ASSERTIONS
+ $ kconfig-tweak --disable CONFIG_DEBUG_NET
+ $ kconfig-tweak --disable CONFIG_DEBUG_NET_ERROR
+ $ kconfig-tweak --disable CONFIG_DEBUG_NET_WARN
+ $ kconfig-tweak --disable CONFIG_DEBUG_NET_INFO
+ $ kconfig-tweak --disable CONFIG_DEBUG_SYMBOLS
+ $ kconfig-tweak --disable CONFIG_DEBUG_NOOPT
+ $ kconfig-tweak --disable CONFIG_SYSLOG_TIMESTAMP
+
+Custom Debug Logging
+--------------------
+
+Sometimes you need to see debug logs specific to your feature, and you don't want the rest of the built-in logs
+because they're either not relevant or have too much information. Debugging using logs is surprisingly powerful.
+
+
+You can add your own custom debug logging by adding the following lines to
+`debug.h <https://github.com/apache/incubator-nuttx/blob/master/include/debug.h>`__:
+
+.. code-block:: c
+
+ /* after the CONFIG_DEBUG_WATCHDOG_INFO block near line 721 */
+ #ifdef CONFIG_DEBUG_CUSTOM_INFO
+ # define custinfo _info
+ #else
+ # define custinfo _none
+ #endif
+
+You need to add the following line to your ``.config`` file:
+
+.. code-block:: c
+
+ CONFIG_DEBUG_CUSTOM_INFO=y
+
+You would use it like this:
+
+.. code-block:: c
+
+ /* Custom debug logging */
+ custinfo("This is a custom log message.");
+ custinfo("Custom log data: %d", my-integer-variable);
+
+
+JTAG 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>`_.
+
+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.
+
+See this article for more info:
+`Debugging a Apache NuttX target with GDB and OpenOCD <https://micro-ros.github.io/docs/tutorials/advanced/debugging_gdb_openocd/>`_.
+
+See the section :ref:`Running <running>` for a brief tutorial on how to use GDB.
+
+----
+
+Next up is :ref:`organization`.
diff --git a/content/docs/latest/_sources/quickstart/index.rst.txt b/content/docs/latest/_sources/quickstart/index.rst.txt
index 70423f9..aab8cf2 100644
--- a/content/docs/latest/_sources/quickstart/index.rst.txt
+++ b/content/docs/latest/_sources/quickstart/index.rst.txt
@@ -1,16 +1,28 @@
.. todo::
- This should be a brief introduction to how NuttX works and how to get it running. A widely used board could be targeted to create a brief demonstration on how to clone, configure, build, flash and run NuttX.
- For now, the content that is here presented is what remains of the old Porting Guide which is not already in another section of this documentation.
-==========
-Quickstart
-==========
+===============
+Getting Started
+===============
-The present Quickstart guide is a work in progress and only contains some basic information. In the meantime you can look at NuttX main `README <https://github.com/apache/incubator-nuttx/blob/master/README.md>`_ file which contains some information that will help you get started.
+This section describes how to get started with NuttX. :ref:`quickstart/quickstart:Quickstart` is for
+experienced embedded developers, and quickly outlines the basic of getting NuttX configured and
+compiled. Use this if you are experienced with FreeRTOS, Zephyr, or a similar RTOS.
+
+The remaining sections are detailed instructions aimed at beginners for getting the necessary
+compilers and other tools installed, then compiling NuttX and running on your hardware. There are sections
+on configuring NuttX with more features than just the minimum, and a section on debugging. For reference
+there is also a description of the code organization and some details about what happens when running ``make``
+to build NuttX.
.. toctree::
:maxdepth: 1
+ quickstart.rst
+ install.rst
+ compiling.rst
+ running.rst
+ configuring.rst
+ debugging.rst
organization.rst
- config_build.rst
-
+ build_and_make.rst
+
diff --git a/content/docs/latest/_sources/quickstart/install.rst.txt b/content/docs/latest/_sources/quickstart/install.rst.txt
new file mode 100644
index 0000000..a844a9e
--- /dev/null
+++ b/content/docs/latest/_sources/quickstart/install.rst.txt
@@ -0,0 +1,195 @@
+.. include:: /substitutions.rst
+.. _install:
+
+Installing
+==========
+
+To start developing on Apache NuttX, we need to get the source code, configure it, compile it, and get it uploaded onto an
+embedded computing board. These instructions are for `Ubuntu <https://ubuntu.com/>`_ Linux and macOS Catalina. If you're using a different
+version, you may need to change some of the commands.
+
+Prerequisites
+-------------
+
+Install prerequisites for building using Linux
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+#. Install system packages
+
+ .. code-block:: bash
+
+ $ sudo apt install \
+ bison flex gettext texinfo libncurses5-dev libncursesw5-dev \
+ gperf automake libtool pkg-config build-essential gperf \
+ libgmp-dev libmpc-dev libmpfr-dev libisl-dev binutils-dev libelf-dev \
+ libexpat-dev gcc-multilib g++-multilib picocom u-boot-tools util-linux
+
+
+#. Give yourself access to the serial console device
+
+ This is done by adding your Linux user to the ``dialout`` group:
+
+ .. code-block:: bash
+
+ $ sudo usermod -a -G dialout $USER
+ $ # now get a login shell that knows we're in the dialout group:
+ $ su - $USER
+
+Install prerequisites for building and using Apache NuttX (macOS)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ .. code-block:: bash
+
+ $ brew tap discoteq/discoteq
+ $ brew install flock
+ $ brew install x86_64-elf-gcc # Used by simulator
+ $ brew install u-boot-tools # Some platform integrate with u-boot
+
+Install prerequisites for building and using Apache NuttX (Windows -- WSL)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you are are building Apache NuttX on windows and using WSL follow
+that installation guide for Linux. This has been verified against the
+Ubunutu 18.04 version.
+
+There may be complications interacting with
+programming tools over USB. Recently support for USBIP was added to WSL 2
+which has been used with the STM32 platform, but it is not trivial to configure:
+https://github.com/rpasek/usbip-wsl2-instructions
+
+Install prerequisites for building and using Apache NuttX (Windows -- Cygwin)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Download and install `Cygwin <https://www.cygwin.com/>`_ using the minimal
+installation in addition to these packages::
+
+ make bison libmpc-devel
+ gcc-core byacc automake-1.15
+ gcc-g++ gperf libncurses-devel
+ flex gdb libmpfr-devel
+ git unzip zlib-devel
+
+Install Required Tools (All Platforms)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+There are a collection of required tools that need to be built to build most Apache NuttX configurations:
+
+ .. code-block:: bash
+
+ $ mkdir buildtools
+ $ export NUTTXTOOLS=`pwd`/buildtools
+ $ export NUTTXTOOLS_PATH=$NUTTXTOOLS/bin:$NUTTXTOOLS/usr/bin
+ $ git clone https://bitbucket.org/nuttx/tools.git tools
+
+*NOTE:* You will need to add ``NUTTXTOOLS_PATH`` to your environment ``PATH``
+
+#. Install kconfig-frontends tool
+
+This is necessary to run the ``./nuttx/tools/configure.sh`` script as well as using the ncurses-based menuconfig system.
+
+ .. code-block:: bash
+
+ $ cd tools/
+ $ cd kconfig-frontends
+ $ # on MacOS do the following:
+ $ patch < ../kconfig-macos.diff -p 1
+ $ ./configure --prefix=$NUTTXTOOLS --enable-mconf --disable-shared --enable-static --disable-gconf --disable-qconf --disable-nconf
+ $ # on Linux do the following:
+ $ ./configure --prefix=$NUTTXTOOLS --enable-mconf --disable-gconf --disable-qconf
+ $ touch aclocal.m4 Makefile.in
+ $ make
+ $ make install
+
+#. Install gperf tool
+
+ This required to build ``kconfig-frontends``.
+
+ .. code-block:: bash
+
+ $ cd tools/
+ $ wget http://ftp.gnu.org/pub/gnu/gperf/gperf-3.1.tar.gz
+ $ tar zxf gperf-3.1.tar.gz
+ $ cd gperf-3.1
+ $ ./configure --prefix=$NUTTXTOOLS
+ $ make
+ $ make install
+
+#. Install gen-romfs (optional)
+
+
+ This is required if you want to build ROM-based file systems.
+
+ .. code-block:: bash
+
+ $ cd tools/
+ $ tar zxf genromfs-0.5.2.tar.gz
+ $ cd genromfs-0.5.2
+ $ make install PREFIX=$NUTTXTOOLS
+
+Get Source Code (Stable)
+------------------------
+Apache NuttX releases are published on the project `Downloads <https://nuttx.apache.org/download/>`_ page and distributed
+by the Apache mirrors. Be sure to download both the nuttx and apps tarballs.
+
+
+Get Source Code (Development)
+------------------------------
+Apache NuttX is `actively developed on GitHub <https://github.com/apache/incubator-nuttx/>`_. If you want
+to use it, modify it or help develop it, you'll need the source code.
+
+You can either clone the public repositories:
+
+ .. code-block:: bash
+
+ $ mkdir nuttx
+ $ cd nuttx
+ $ git clone https://github.com/apache/incubator-nuttx.git nuttx
+ $ git clone https://github.com/apache/incubator-nuttx-apps apps
+
+Or, download the `tarball <https://github.com/apache/incubator-nuttx/tarball/master>`_:
+
+ .. code-block:: bash
+
+ $ curl -OL https://github.com/apache/incubator-nuttx/tarball/master
+ $ curl -OL https://github.com/apache/incubator-nuttx-apps/tarball/master
+ # optionally, zipball is also available (for Windows users).
+
+Later if we want to make modifications (for instance, to improve NuttX and save them in our own branch,
+or submit them back to the project), we can do that easily using git to track our changes and submit them
+upstream to the NuttX project.
+
+Install a Cross-Compiler Toolchain
+----------------------------------
+
+With Apache NuttX, you compile the operating system and your application on your desktop or laptop computer, then install the
+binary file on your embedded computer. This guide assumes your computer is an
+`ARM <https://en.wikipedia.org/wiki/ARM_architecture>`_ CPU. If it isn't, you'll need a different tool chain.
+
+ There are hints on how to get the latest tool chains for most supported architectures in the Apache NuttX CI helper
+ `script <https://github.com/apache/incubator-nuttx-testing/blob/master/cibuild.sh>`_ and Docker `container <https://github.com/apache/incubator-nuttx-testing/blob/master/docker/linux/Dockerfile>`_
+
+Download the right flavor of the
+`ARM Embedded Gnu Toolchain <https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm>`_
+for your embedded processor's CPU.
+
+Unpack it into ``/opt/gcc`` and add the bin directory to your path. For instance:
+
+ .. code-block:: bash
+
+ $ usermod -a -G users $USER
+ $ # get a login shell that knows we're in this group:
+ $ su - $USER
+ $ sudo mkdir /opt/gcc
+ $ sudo chgrp -R users /opt/gcc
+ $ sudo chmod -R u+rw /opt/gcc
+ $ cd /opt/gcc
+ $ HOST_PLATFORM=x86_64-linux # use "mac" for macOS.
+ $ # For windows there is a zip instead (gcc-arm-none-eabi-9-2019-q4-major-win32.zip)
+ $ curl -L -o gcc-arm-none-eabi-9-2019-q4-major-${HOST_PLATFORM}.tar.bz2 https://developer.arm.com/-/media/Files/downloads/gnu-rm/9-2019q4/gcc-arm-none-eabi-9-2019-q4-major-${HOST_PLATFORM}.tar.bz2
+ $ tar xf gcc-arm-none-eabi-9-2019-q4-major-${HOST_PLATFORM}.tar.bz2
+ $ # add the toolchain bin/ dir to your path...
+ $ # you can edit your shell's rc files if you don't use bash
+ $ echo "export PATH=/opt/gcc/gcc-arm-none-eabi-9-2019-q4-major/bin:$PATH" >> ~/.bashrc
+
+----
+
+Next up is :ref:`compiling`.
diff --git a/content/docs/latest/_sources/quickstart/organization.rst.txt b/content/docs/latest/_sources/quickstart/organization.rst.txt
index 03af58c..82a5a15 100644
--- a/content/docs/latest/_sources/quickstart/organization.rst.txt
+++ b/content/docs/latest/_sources/quickstart/organization.rst.txt
@@ -1,8 +1,14 @@
+.. include:: /substitutions.rst
+.. _organization:
+
===================
Directory Structure
===================
-**Directory Structure**. The general directory layout for NuttX is
+This is included for reference, and it's not necessary to know
+all the details at first.
+
+The general directory layout for NuttX is
very similar to the directory structure of the Linux kernel -- at
least at the most superficial layers. At the top level is the main
makefile and a series of sub-directories identified below and
@@ -62,10 +68,12 @@ specified by several settings in the NuttX configuration file.
board and is selected via the
``CONFIG_ARCH_BOARD="stm32f4discovery"`` configuration setting.
-Documentation
-=============
+``nuttx/Documentation``
+=======================
-General documentation for the NuttX OS resides in this directory.
+This directory holds the NuttX documentation. It's made with
+the `Sphinx documentation system <https://www.sphinx-doc.org>`_. See the
+README.md file for information on how to build it.
``nuttx/arch``
==============
@@ -221,8 +229,8 @@ Current architecture/chip directories are summarized below:
At present, this includes the Zilog z80, ez80Acclaim! and
z8Encore! Microcontrollers.
-nuttx/binfmt
-============
+``nuttx/binfmt``
+================
The ``binfmt/`` subdirectory contains logic for loading binaries
in the file system into memory in a form that can be used to
@@ -499,3 +507,7 @@ The top-level ``Makefile`` in the ``$(TOPDIR)`` directory contains
all of the top-level control logic to build NuttX. Use of this
``Makefile`` to build NuttX is described
`below <#buildingnuttx>`__.
+
+----
+
+Next up is :ref:`build_and_make`.
diff --git a/content/docs/latest/_sources/quickstart/quickstart.rst.txt b/content/docs/latest/_sources/quickstart/quickstart.rst.txt
new file mode 100644
index 0000000..be38a07
--- /dev/null
+++ b/content/docs/latest/_sources/quickstart/quickstart.rst.txt
@@ -0,0 +1,126 @@
+.. include:: /substitutions.rst
+.. _quickstart:
+
+Quickstart
+==========
+
+Here's the quick version of getting started with NuttX. This is a bare-bones outline for experienced developers– if it's
+going too quickly, dive into the following sections. This Quickstart guide assumes you're on a Linux
+computer, you're using an ARM microcontroller on your embedded board, and you're familiar with using the command line.
+
+#. Install a Cross-Compiler Toolchain
+
+ With NuttX, you compile the operating system and your application on your desktop or laptop computer, then install the
+ binary file on your embedded computer. This guide assumes your computer is an
+ `ARM <https://en.wikipedia.org/wiki/ARM_architecture>`_ CPU. If it isn't, you'll need a different tool chain.
+
+ You can download a toolchain from
+ `ARM Embedded Gnu Toolchain <https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm>`_
+ for your embedded processor's CPU. You can also use a toolchain shipped with your OS for the `none-eabi` target, such as `gcc-arm-none-eabi` in Linux.
+
+
+In the following example, we download ``gcc-arm-none-eabi`` version 9.0 and unpack it into ``/opt/gcc`:
+
+ .. code-block:: console
+
+ $ sudo mkdir /opt/gcc
+ $ sudo chgrp -R users /opt/gcc
+ $ cd /opt/gcc
+ $ wget https://developer.arm.com/-/media/Files/downloads/gnu-rm/9-2019q4/gcc-arm-none-eabi-9-2019-q4-major-x86_64-linux.tar.bz2
+ $ tar xf gcc-arm-none-eabi-9-2019-q4-major-x86_64-linux.tar.bz2
+
+Then, add the toolchain ``bin/`` directory to your path:
+
+.. code-block:: console
+
+ $ echo "export PATH=/opt/gcc/gcc-arm-none-eabi-9-2019-q4-major/bin:$PATH" >> ~/.bashrc
+
+If you are using any other shell, the procedure is similar by editing the corresponding rc file.
+
+#. Download Apache NuttX
+The next step is to download NuttX main repository along the application repository. The latter is technically optional in a very minimal configurations but should be included in normal configuration since it includes the NuttX shell.
+ .. code-block:: console
+
+ $ mkdir nuttx
+ $ cd nuttx
+ $ git clone https://github.com/apache/incubator-nuttx.git nuttx
+ $ git clone https://github.com/apache/incubator-nuttx-apps apps
+ $ git clone https://bitbucket.org/nuttx/tools.git tools
+
+#. Install the ``kconfig-frontends`` package
+
+ NuttX is configured using ``kconfig`` system via an interactive menu system (``menuconfig``). It also includes the ``kconfig-tweak`` utility that can be used to quickly change debug settings without going into the menu system.
+
+
+ On Ubuntu 20.04 LTS and later, you can do:
+
+ .. code-block:: console
+
+ $ apt install kconfig-frontends
+
+ On MacOS, and Ubuntu 18.04 LTS and earlier, you need to install manually:
+
+ .. code-block:: console
+
+ $ cd tools/kconfig-frontends
+ $ # on MacOS do the following:
+ $ patch < ../kconfig-macos.diff -p 1
+ $ ./configure --enable-mconf --disable-shared --enable-static --disable-gconf --disable-qconf --disable-nconf
+ $ # on Linux do the following:
+ $ ./configure --enable-mconf --disable-nconf --disable-gconf --disable-qconf
+ $ make
+ $ make install
+
+#. List Possible Apache NuttX Base Configurations
+
+ Find your hardware and a good starting application in the list of base configurations. In the application list,
+ ``nsh`` is the Apache NuttX Shell, an interactive commandline that's a good starting place if you're new.
+
+ .. code-block:: bash
+
+ $ cd nuttx
+ $ ./tools/configure.sh -L | less
+
+#. Initialize Configuration
+
+ Pick one of the board:application base configuration pairs from the list, and feed it to
+ the configuration script. The ``-l`` tells us that we're on Linux. macOS and Windows builds
+ are possible, this guide doesn't cover them yet.
+
+ .. code-block:: bash
+
+ $ cd nuttx
+ $ ./tools/configure.sh -l <board-name>:<config-dir>
+ # for instance:
+ $ ./tools/configure.sh -l sama5d27-xult:nsh
+
+#. Customize Your Configuration (Optional)
+
+ This step is optional. Right now, this is mainly to get familiar with how it works– you don't need to change
+ any of the options now, but knowing how to do this will come in handy later.
+
+ There are a lot of options. We'll cover a few of them here. Don't worry about the complexity– you don't have to use most of the options.
+
+ .. code-block:: bash
+
+ $ make menuconfig
+
+Use your arrows to navigate the menu and ``ENTER`` key to enable/disable options. To exit and save your configuration, go back to the main menu, choose ``<Exit>`` and select "yes" when asked if you want to save.
+
+#. Compile Apache NuttX
+
+ .. code-block:: bash
+
+ $ make
+
+#. Install the Executable Program on Your Board
+
+ This step is a bit more complicated, depending on your board. It's covered in the section
+ :ref:`Running Apache NuttX <running>`.
+
+----
+
+.. rubric:: More Details
+
+If you want more details, start at :ref:`install`.
+
diff --git a/content/docs/latest/_sources/quickstart/running.rst.txt b/content/docs/latest/_sources/quickstart/running.rst.txt
new file mode 100644
index 0000000..9bbbf1e
--- /dev/null
+++ b/content/docs/latest/_sources/quickstart/running.rst.txt
@@ -0,0 +1,105 @@
+.. include:: /substitutions.rst
+.. _running:
+
+Running
+=======
+
+Embedded boards have different ways to get your program onto them and get them running. 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/>`_. `JTAG <https://en.wikipedia.org/wiki/JTAG>`_
+is a set of standards that let you 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.
+
+#. Attach the Debugger Cables
+
+#. Start the Debugger
+
+ Refer to your JTAG debugger's documentation for information on how to start a GDB Server process that gdb can
+ communicate with to load code and start, stop, and step the embedded board's CPU. Your command line may be
+ different from this one.
+
+ .. code-block:: bash
+
+ $ JLinkGDBServer -device ATSAMA5D27 -if JTAG -speed 1000 -JTAGConf -1,-1
+
+#. Launch the Gnu Debugger
+
+ In another terminal window, launch the GDB for your platform. In the case of this guide, this came with the
+ ARM Embedded Gnu Toolchain we downloaded in the Install step.
+
+ .. code-block:: bash
+
+ $ arm-none-eabi-gdb
+
+#. Connect to the board's serial console
+
+ Usually you connect a USB-to-serial adapter to the board's serial console so you can see debug logging or
+ execute Apache NuttX Shell (nsh) commands. You can access the serial console from Linux with the ``picocom`` terminal
+ program. From another terminal, do this:
+
+ .. code-block:: bash
+
+ $ picocom -b 115200 /dev/ttyUSB0
+
+#. Set gdb to talk with the J-Link
+
+ ::
+
+ (gdb) target extended-remote :2331
+
+#. Reset the board
+
+ ::
+
+ (gdb) mon reset
+
+#. You may need to switch to the serial console to hit a key to stop the board from booting from its boot monitor
+ (U-Boot, in the case of the SAMA5 boards from Microchip).
+
+#. Halt the board
+
+ ::
+
+ (gdb) mon halt
+
+#. Load nuttx
+
+ ::
+
+ (gdb) file nuttx
+ (gdb) load nuttx
+ `/home/adamf/src/nuttx-sama5d36-xplained/nuttx/nuttx' has changed; re-reading symbols.
+ Loading section .text, size 0x9eae4 lma 0x20008000
+ Loading section .ARM.exidx, size 0x8 lma 0x200a6ae4
+ Loading section .data, size 0x125c lma 0x200a6aec
+ Start address 0x20008040, load size 654664
+ Transfer rate: 75 KB/sec, 15587 bytes/write.
+ (gdb)
+
+#. Set a breakpoint
+
+ ::
+
+ (gdb) breakpoint nsh_main
+
+#. Start nuttx
+
+ ::
+
+ (gdb) continue
+ Continuing.
+
+ Breakpoint 1, nsh_main (argc=1, argv=0x200ddfac) at nsh_main.c:208
+ 208 sched_getparam(0, ¶m);
+ (gdb) continue
+ Continuing.
+
+Debugging Shortcuts
+-------------------
+
+Note that you can abbreviate ``gdb`` commands, ``info b`` is a shortcut for
+``information breakpoints``; ``c`` works the same as ``continue``, etc.
+
+----
+
+Next up is :ref:`configuring`.
diff --git a/content/docs/latest/applications/index.html b/content/docs/latest/applications/index.html
index f407cdf..2831622 100644
--- a/content/docs/latest/applications/index.html
+++ b/content/docs/latest/applications/index.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/boards/index.html b/content/docs/latest/boards/index.html
index 8ea9b67..e63d384 100644
--- a/content/docs/latest/boards/index.html
+++ b/content/docs/latest/boards/index.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Supported Boards</a></li>
diff --git a/content/docs/latest/components/binfmt.html b/content/docs/latest/components/binfmt.html
index 8ab0151..e6e4a7d 100644
--- a/content/docs/latest/components/binfmt.html
+++ b/content/docs/latest/components/binfmt.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">OS Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="nsh/index.html">NuttShell (NSH)</a></li>
<li class="toctree-l2"><a class="reference internal" href="power.html">Power Management</a></li>
diff --git a/content/docs/latest/components/drivers/index.html b/content/docs/latest/components/drivers/index.html
index a96102d..e66620d 100644
--- a/content/docs/latest/components/drivers/index.html
+++ b/content/docs/latest/components/drivers/index.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">OS Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../nsh/index.html">NuttShell (NSH)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../power.html">Power Management</a></li>
diff --git a/content/docs/latest/components/filesystem.html b/content/docs/latest/components/filesystem.html
index ee85cfa..5ce75f4 100644
--- a/content/docs/latest/components/filesystem.html
+++ b/content/docs/latest/components/filesystem.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">OS Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="nsh/index.html">NuttShell (NSH)</a></li>
<li class="toctree-l2"><a class="reference internal" href="power.html">Power Management</a></li>
diff --git a/content/docs/latest/components/index.html b/content/docs/latest/components/index.html
index 1db965d..bdbcb46 100644
--- a/content/docs/latest/components/index.html
+++ b/content/docs/latest/components/index.html
@@ -59,7 +59,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="NuttShell (NSH)" href="nsh/index.html" />
- <link rel="prev" title="Configuring and Building" href="../quickstart/config_build.html" />
+ <link rel="prev" title="Build and Make Details" href="../quickstart/build_and_make.html" />
</head>
<body class="wy-body-for-nav">
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">OS Components</a><ul>
<li class="toctree-l2"><a class="reference internal" href="nsh/index.html">NuttShell (NSH)</a></li>
<li class="toctree-l2"><a class="reference internal" href="power.html">Power Management</a></li>
diff --git a/content/docs/latest/components/nsh/builtin.html b/content/docs/latest/components/nsh/builtin.html
index 69eaf13..a78b731 100644
--- a/content/docs/latest/components/nsh/builtin.html
+++ b/content/docs/latest/components/nsh/builtin.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">OS Components</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="index.html">NuttShell (NSH)</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="nsh.html">Overview</a></li>
diff --git a/content/docs/latest/components/nsh/commands.html b/content/docs/latest/components/nsh/commands.html
index 332ddf8..581dde7 100644
--- a/content/docs/latest/components/nsh/commands.html
+++ b/content/docs/latest/components/nsh/commands.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">OS Components</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="index.html">NuttShell (NSH)</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="nsh.html">Overview</a></li>
diff --git a/content/docs/latest/components/nsh/config.html b/content/docs/latest/components/nsh/config.html
index d23cd7c..5483c1b 100644
--- a/content/docs/latest/components/nsh/config.html
+++ b/content/docs/latest/components/nsh/config.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">OS Components</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="index.html">NuttShell (NSH)</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="nsh.html">Overview</a></li>
diff --git a/content/docs/latest/components/nsh/customizing.html b/content/docs/latest/components/nsh/customizing.html
index 4a17523..07ff54b 100644
--- a/content/docs/latest/components/nsh/customizing.html
+++ b/content/docs/latest/components/nsh/customizing.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">OS Components</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="index.html">NuttShell (NSH)</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="nsh.html">Overview</a></li>
diff --git a/content/docs/latest/components/nsh/index.html b/content/docs/latest/components/nsh/index.html
index 2437628..ac1ec99 100644
--- a/content/docs/latest/components/nsh/index.html
+++ b/content/docs/latest/components/nsh/index.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">OS Components</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">NuttShell (NSH)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="nsh.html">Overview</a></li>
diff --git a/content/docs/latest/components/nsh/installation.html b/content/docs/latest/components/nsh/installation.html
index 52272f4..cbee3d8 100644
--- a/content/docs/latest/components/nsh/installation.html
+++ b/content/docs/latest/components/nsh/installation.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">OS Components</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="index.html">NuttShell (NSH)</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="nsh.html">Overview</a></li>
diff --git a/content/docs/latest/components/nsh/login.html b/content/docs/latest/components/nsh/login.html
index 54cd1fd..d9c0c0e 100644
--- a/content/docs/latest/components/nsh/login.html
+++ b/content/docs/latest/components/nsh/login.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">OS Components</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="index.html">NuttShell (NSH)</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="nsh.html">Overview</a></li>
diff --git a/content/docs/latest/components/nsh/nsh.html b/content/docs/latest/components/nsh/nsh.html
index 71ffa62..2fcdb77 100644
--- a/content/docs/latest/components/nsh/nsh.html
+++ b/content/docs/latest/components/nsh/nsh.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">OS Components</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="index.html">NuttShell (NSH)</a><ul class="current">
<li class="toctree-l3 current"><a class="current reference internal" href="#">Overview</a><ul>
diff --git a/content/docs/latest/components/nxflat.html b/content/docs/latest/components/nxflat.html
index 29f4574..43aca4f 100644
--- a/content/docs/latest/components/nxflat.html
+++ b/content/docs/latest/components/nxflat.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">OS Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="nsh/index.html">NuttShell (NSH)</a></li>
<li class="toctree-l2"><a class="reference internal" href="power.html">Power Management</a></li>
diff --git a/content/docs/latest/components/nxgraphics/appendix.html b/content/docs/latest/components/nxgraphics/appendix.html
index f76841f..341fed8 100644
--- a/content/docs/latest/components/nxgraphics/appendix.html
+++ b/content/docs/latest/components/nxgraphics/appendix.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">OS Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../nsh/index.html">NuttShell (NSH)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../power.html">Power Management</a></li>
diff --git a/content/docs/latest/components/nxgraphics/index.html b/content/docs/latest/components/nxgraphics/index.html
index 2b529aa..1875758 100644
--- a/content/docs/latest/components/nxgraphics/index.html
+++ b/content/docs/latest/components/nxgraphics/index.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">OS Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../nsh/index.html">NuttShell (NSH)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../power.html">Power Management</a></li>
diff --git a/content/docs/latest/components/nxgraphics/nx.html b/content/docs/latest/components/nxgraphics/nx.html
index b5731a5..f43ec6d 100644
--- a/content/docs/latest/components/nxgraphics/nx.html
+++ b/content/docs/latest/components/nxgraphics/nx.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">OS Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../nsh/index.html">NuttShell (NSH)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../power.html">Power Management</a></li>
diff --git a/content/docs/latest/components/nxgraphics/nxcursor.html b/content/docs/latest/components/nxgraphics/nxcursor.html
index 3101f15..57cc5db 100644
--- a/content/docs/latest/components/nxgraphics/nxcursor.html
+++ b/content/docs/latest/components/nxgraphics/nxcursor.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">OS Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../nsh/index.html">NuttShell (NSH)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../power.html">Power Management</a></li>
diff --git a/content/docs/latest/components/nxgraphics/nxfonts.html b/content/docs/latest/components/nxgraphics/nxfonts.html
index fec46f1..e4c9575 100644
--- a/content/docs/latest/components/nxgraphics/nxfonts.html
+++ b/content/docs/latest/components/nxgraphics/nxfonts.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">OS Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../nsh/index.html">NuttShell (NSH)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../power.html">Power Management</a></li>
diff --git a/content/docs/latest/components/nxgraphics/nxgl.html b/content/docs/latest/components/nxgraphics/nxgl.html
index 668ab30..07298aa 100644
--- a/content/docs/latest/components/nxgraphics/nxgl.html
+++ b/content/docs/latest/components/nxgraphics/nxgl.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">OS Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../nsh/index.html">NuttShell (NSH)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../power.html">Power Management</a></li>
diff --git a/content/docs/latest/components/nxgraphics/nxtk.html b/content/docs/latest/components/nxgraphics/nxtk.html
index c8c9a05..90b5c69 100644
--- a/content/docs/latest/components/nxgraphics/nxtk.html
+++ b/content/docs/latest/components/nxgraphics/nxtk.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">OS Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../nsh/index.html">NuttShell (NSH)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../power.html">Power Management</a></li>
diff --git a/content/docs/latest/components/nxgraphics/sample.html b/content/docs/latest/components/nxgraphics/sample.html
index a3815d6..a105fdf 100644
--- a/content/docs/latest/components/nxgraphics/sample.html
+++ b/content/docs/latest/components/nxgraphics/sample.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">OS Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../nsh/index.html">NuttShell (NSH)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../power.html">Power Management</a></li>
diff --git a/content/docs/latest/components/nxwidgets.html b/content/docs/latest/components/nxwidgets.html
index 5608732..f6912b4 100644
--- a/content/docs/latest/components/nxwidgets.html
+++ b/content/docs/latest/components/nxwidgets.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">OS Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="nsh/index.html">NuttShell (NSH)</a></li>
<li class="toctree-l2"><a class="reference internal" href="power.html">Power Management</a></li>
diff --git a/content/docs/latest/components/paging.html b/content/docs/latest/components/paging.html
index 23a65d7..52a95b9 100644
--- a/content/docs/latest/components/paging.html
+++ b/content/docs/latest/components/paging.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">OS Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="nsh/index.html">NuttShell (NSH)</a></li>
<li class="toctree-l2"><a class="reference internal" href="power.html">Power Management</a></li>
diff --git a/content/docs/latest/components/power.html b/content/docs/latest/components/power.html
index 47574c5..ea20efe 100644
--- a/content/docs/latest/components/power.html
+++ b/content/docs/latest/components/power.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">OS Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="nsh/index.html">NuttShell (NSH)</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Power Management</a><ul>
diff --git a/content/docs/latest/components/socketcan.html b/content/docs/latest/components/socketcan.html
index c031729..20c2a35 100644
--- a/content/docs/latest/components/socketcan.html
+++ b/content/docs/latest/components/socketcan.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">OS Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="nsh/index.html">NuttShell (NSH)</a></li>
<li class="toctree-l2"><a class="reference internal" href="power.html">Power Management</a></li>
diff --git a/content/docs/latest/components/syslog.html b/content/docs/latest/components/syslog.html
index 5d14ba5..d9d1640 100644
--- a/content/docs/latest/components/syslog.html
+++ b/content/docs/latest/components/syslog.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">OS Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="nsh/index.html">NuttShell (NSH)</a></li>
<li class="toctree-l2"><a class="reference internal" href="power.html">Power Management</a></li>
diff --git a/content/docs/latest/contributing/coding_style.html b/content/docs/latest/contributing/coding_style.html
index eb692e4..c6134d1 100644
--- a/content/docs/latest/contributing/coding_style.html
+++ b/content/docs/latest/contributing/coding_style.html
@@ -59,7 +59,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Documentation" href="documentation.html" />
- <link rel="prev" title="Development Workflow" href="workflow.html" />
+ <link rel="prev" title="Making Changes Using Git" href="making-changes.html" />
</head>
<body class="wy-body-for-nav">
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
@@ -125,6 +125,7 @@
<li class="toctree-l1"><a class="reference internal" href="../releases/index.html">Releases</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Contributing</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="workflow.html">Development Workflow</a></li>
+<li class="toctree-l2"><a class="reference internal" href="making-changes.html">Making Changes Using Git</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">C Coding Standard</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#general-conventions">General Conventions</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#file-organization">File Organization</a></li>
@@ -247,7 +248,7 @@
<div itemprop="articleBody">
<div class="section" id="c-coding-standard">
-<h1>C Coding Standard<a class="headerlink" href="#c-coding-standard" title="Permalink to this headline">¶</a></h1>
+<span id="coding-standard"></span><h1>C Coding Standard<a class="headerlink" href="#c-coding-standard" title="Permalink to this headline">¶</a></h1>
<p>NuttX follows a specific coding style which needs to be followed at all times
a contribution to be accepted. Please read this document before working on
new code so that you can follow the style from the start. To check your code
diff --git a/content/docs/latest/contributing/documentation.html b/content/docs/latest/contributing/documentation.html
index f458847..ce065eb 100644
--- a/content/docs/latest/contributing/documentation.html
+++ b/content/docs/latest/contributing/documentation.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
@@ -125,6 +125,7 @@
<li class="toctree-l1"><a class="reference internal" href="../releases/index.html">Releases</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Contributing</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="workflow.html">Development Workflow</a></li>
+<li class="toctree-l2"><a class="reference internal" href="making-changes.html">Making Changes Using Git</a></li>
<li class="toctree-l2"><a class="reference internal" href="coding_style.html">C Coding Standard</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Documentation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#building">Building</a></li>
diff --git a/content/docs/latest/contributing/index.html b/content/docs/latest/contributing/index.html
index 17c98df..c7da975 100644
--- a/content/docs/latest/contributing/index.html
+++ b/content/docs/latest/contributing/index.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
@@ -125,6 +125,7 @@
<li class="toctree-l1"><a class="reference internal" href="../releases/index.html">Releases</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="workflow.html">Development Workflow</a></li>
+<li class="toctree-l2"><a class="reference internal" href="making-changes.html">Making Changes Using Git</a></li>
<li class="toctree-l2"><a class="reference internal" href="coding_style.html">C Coding Standard</a></li>
<li class="toctree-l2"><a class="reference internal" href="documentation.html">Documentation</a></li>
</ul>
@@ -202,6 +203,12 @@ and documentation (the one you are reading now):</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="workflow.html">Development Workflow</a></li>
+<li class="toctree-l1"><a class="reference internal" href="making-changes.html">Making Changes Using Git</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="making-changes.html#git-workflow-with-an-upstream-repository">Git Workflow With an Upstream Repository</a></li>
+<li class="toctree-l2"><a class="reference internal" href="making-changes.html#submitting-your-changes-to-nuttx">Submitting Your Changes to NuttX</a></li>
+<li class="toctree-l2"><a class="reference internal" href="making-changes.html#git-resources">Git Resources</a></li>
+</ul>
+</li>
<li class="toctree-l1"><a class="reference internal" href="coding_style.html">C Coding Standard</a><ul>
<li class="toctree-l2"><a class="reference internal" href="coding_style.html#general-conventions">General Conventions</a></li>
<li class="toctree-l2"><a class="reference internal" href="coding_style.html#data-and-type-definitions">Data and Type Definitions</a></li>
diff --git a/content/docs/latest/contributing/making-changes.html b/content/docs/latest/contributing/making-changes.html
new file mode 100644
index 0000000..3dcbe23
--- /dev/null
+++ b/content/docs/latest/contributing/making-changes.html
@@ -0,0 +1,465 @@
+<!--
+ Documentation/_templates/layout.html
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership. The
+ ASF licenses this file to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance with the
+ License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+-->
+
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Making Changes Using Git — NuttX latest documentation</title>
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+
+ <link rel="shortcut icon" href="../_static/favicon.ico"/>
+
+
+
+
+
+ <!--[if lt IE 9]>
+ <script src="../_static/js/html5shiv.min.js"></script>
+ <![endif]-->
+
+
+ <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+ <script src="../_static/jquery.js"></script>
+ <script src="../_static/underscore.js"></script>
+ <script src="../_static/doctools.js"></script>
+ <script src="../_static/language_data.js"></script>
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <link rel="next" title="C Coding Standard" href="coding_style.html" />
+ <link rel="prev" title="Development Workflow" href="workflow.html" />
+</head>
+
+<body class="wy-body-for-nav">
+
+
+ <div class="wy-grid-for-nav">
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-scroll">
+ <div class="wy-side-nav-search" >
+
+
+ <a href="../index.html" class="icon icon-home"> NuttX
+
+
+
+
+ <img src="../_static/NuttX.png" class="logo" alt="Logo"/>
+
+ </a>
+
+ <!-- this version selector is quite ugly, should be probably replaced by something
+ more modern -->
+
+ <div class="version-selector">
+ <select>
+
+ <option value="latest" selected="selected">latest</option>
+
+ </select>
+ </div>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+ </div>
+
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+ <p class="caption"><span class="caption-text">Table of Contents</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">API Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../guides/index.html">Guides</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../releases/index.html">Releases</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Contributing</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="workflow.html">Development Workflow</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Making Changes Using Git</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#git-workflow-with-an-upstream-repository">Git Workflow With an Upstream Repository</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#submitting-your-changes-to-nuttx">Submitting Your Changes to NuttX</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#git-resources">Git Resources</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="coding_style.html">C Coding Standard</a></li>
+<li class="toctree-l2"><a class="reference internal" href="documentation.html">Documentation</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </div>
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" aria-label="top navigation">
+
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">NuttX</a>
+
+ </nav>
+
+
+ <div class="wy-nav-content">
+
+ <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+ <ul class="wy-breadcrumbs">
+
+ <li><a href="../index.html" class="icon icon-home"></a> »</li>
+
+ <li><a href="index.html">Contributing</a> »</li>
+
+ <li>Making Changes Using Git</li>
+
+
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../_sources/contributing/making-changes.rst.txt" rel="nofollow"> View page source</a>
+
+
+ </li>
+
+ </ul>
+
+
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="making-changes-using-git">
+<span id="making-changes"></span><h1>Making Changes Using Git<a class="headerlink" href="#making-changes-using-git" title="Permalink to this headline">¶</a></h1>
+<p>The Apache NuttX project uses the <a class="reference external" href="https://git-scm.com/book/en/v2/Getting-Started-About-Version-Control">Git version control system</a>
+to track changes, and the source code is hosted on <a class="reference external" href="https://www.github.com">GitHub</a>.</p>
+<p>If you want to make changes to NuttX, for your own personal use, or to submit them back to project to improve NuttX,
+that’s easy. For the purposes of this guide, you’ll need a <a class="reference external" href="https://www.github.com">GitHub</a> account, since
+the Apache NuttX team uses GitHub. (You could also use git locally, or save your changes to other sites like
+<a class="reference external" href="https://about.gitlab.com/">GitLab</a> or <a class="reference external" href="https://bitbucket.org">BitBucket</a>, but that’s beyond the scope of this
+guide).</p>
+<p>Here’s how to do it:</p>
+<ol class="arabic">
+<li><p>Set your git user name and email</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ <span class="nb">cd</span> nuttx/
+$ git config --global user.name <span class="s2">"Your Name"</span>
+$ git config --global user.email <span class="s2">"yourname@somedomaincom"</span>
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Sign in to GitHub</p>
+<p>If you don’t have a <a class="reference external" href="https://www.github.com">GitHub</a> account, it’s free to
+sign up.</p>
+</li>
+<li><p>Fork the Projects</p>
+<p>Visit both these links and hit the Fork button in the upper right of the page:</p>
+<ul class="simple">
+<li><p><a class="reference external" href="https://github.com/apache/incubator-nuttx/">NuttX</a></p></li>
+<li><p><a class="reference external" href="https://github.com/apache/incubator-nuttx-apps/">NuttX Apps</a></p></li>
+</ul>
+</li>
+<li><p>Clone the Repositories</p>
+<p>On the GitHub web page for your forked <code class="docutils literal notranslate"><span class="pre">incubator-nuttx</span></code> project, copy the clone url – get it by hitting the
+green <code class="docutils literal notranslate"><span class="pre">Clone</span> <span class="pre">or</span> <span class="pre">Download</span></code> button in the upper right. Then do this:</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ git clone <your forked incubator-nuttx project clone url>
+$ git remote add upstream https://github.com/apache/incubator-nuttx.git
+</pre></div>
+</div>
+</div></blockquote>
+<p>Do the same for your forked <code class="docutils literal notranslate"><span class="pre">incubator-nuttx-apps</span></code> project:</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ <span class="nb">cd</span> ../apps
+$ git clone <your forked incubator-nuttx-apps project clone url>
+$ git remote add upstream https://github.com/apache/incubator-nuttx-apps.git
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Create a Local Git Branch</p>
+<p>Now you can create local git branches and push them to GitHub:</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ git checkout -b test/my-new-branch
+$ git push
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+</ol>
+<div class="section" id="git-workflow-with-an-upstream-repository">
+<h2>Git Workflow With an Upstream Repository<a class="headerlink" href="#git-workflow-with-an-upstream-repository" title="Permalink to this headline">¶</a></h2>
+<p>The main NuttX git repository is called an “upstream” repository - this is because it’s the main source of truth, and
+its changes flow downstream to people who’ve forked that repository, like us.</p>
+<p>Working with an upstream repo is a bit more complex, but it’s worth it since you can submit fixes and features
+to the main NuttX repos. One of the things you need to do regularly is keep your local repo in sync
+with the upstream. I work with a local branch, make changes, pull new software from the upstream and merge it in,
+maybe doing that several times. Then when everything works, I get my branch ready to do a Pull Request. Here’s how:</p>
+<ol class="arabic">
+<li><p>Fetch upstream changes and merge into my local master:</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ git checkout master
+$ git fetch upstream
+$ git merge upstream/master
+$ git push
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Merge my local master with my local branch:</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ git checkout my-local-branch
+$ git merge master
+$ git push
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Make changes and push them to my fork</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ vim my-file.c
+$ git add my-file.c
+$ git commit my-file.c
+$ git push
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Repeat 1-3 as necessary</p></li>
+<li><p>Run the <code class="docutils literal notranslate"><span class="pre">tools/checkpatch.sh</span></code> script on your files</p>
+<p>When your code runs, then you’re almost ready to submit it. But first you need to check the code to ensure
+that it conforms to the NuttX <a class="reference internal" href="coding_style.html#c-coding-standard"><span class="std std-ref">C Coding Standard</span></a>.
+The <code class="docutils literal notranslate"><span class="pre">tools/checkpatch.sh</span></code> script will do that. Here’s the usage info:</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ ./tools/checkpatch.sh -h
+USAGE: ./tools/checkpatch.sh <span class="o">[</span>options<span class="o">]</span> <span class="o">[</span>list<span class="p">|</span>-<span class="o">]</span>
+
+Options:
+-h
+-c spell check with codespell<span class="o">(</span>install with: pip install codespell
+-r range check only <span class="o">(</span>used with -p and -g<span class="o">)</span>
+-p <patch list> <span class="o">(</span>default<span class="o">)</span>
+-g <commit list>
+-f <file list>
+- <span class="nb">read</span> standard input mainly used by git pre-commit hook as below:
+ git diff --cached <span class="p">|</span> ./tools/checkpatch.sh -
+</pre></div>
+</div>
+</div></blockquote>
+<p>Run it against your files and correct all the errors in the code you added, so that
+<code class="docutils literal notranslate"><span class="pre">tools/checkpatch.sh</span></code> reports no errors. Then commit the result.
+For example:</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ ./tools/checkpatch.sh -f my-file.c
+arch/arm/src/sama5/hardware/my-file.c:876:82: warning: Long line found
+$ <span class="c1"># fix errors</span>
+$ vim my-file.c
+$ <span class="c1"># run again</span>
+$ ./tools/checkpatch.sh -f my-file.c
+</pre></div>
+</div>
+</div></blockquote>
+<p>If you have made a lot of changes, you can also use this bash commandline to see the errors for all the changed C
+files in your branch (assumes you are currently on the branch that has the changed files):</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ git diff --name-only master <span class="p">|</span> egrep <span class="s2">"\.c|\.h"</span> <span class="p">|</span> xargs <span class="nb">echo</span> <span class="p">|</span> xargs ./tools/checkpatch.sh -f <span class="p">|</span> less
+</pre></div>
+</div>
+</div></blockquote>
+<p>Note that there are some bugs in the <code class="docutils literal notranslate"><span class="pre">nxstyle</span></code> program that <code class="docutils literal notranslate"><span class="pre">checkpatch.sh</span></code> uses, so
+it may report a few errors that are not actually errors. The committers will help you
+find these. (Or view the
+<a class="reference external" href="https://github.com/apache/incubator-nuttx/issues?q=is%3Aissue+is%3Aopen+nxstyle">nxstyle Issues</a>.)
+<br/>
+<br/></p>
+</li>
+<li><p>Commit the fixed files</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ git add my-file.c
+$ git commit my-file.c
+$ git push
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+</ol>
+</div>
+<div class="section" id="submitting-your-changes-to-nuttx">
+<h2>Submitting Your Changes to NuttX<a class="headerlink" href="#submitting-your-changes-to-nuttx" title="Permalink to this headline">¶</a></h2>
+<blockquote>
+<div><p>Pull requests let you tell others about changes you’ve pushed to a branch in a repository on GitHub. Once a pull
+request is opened, you can discuss and review the potential changes with collaborators and add follow-up commits
+before your changes are merged into the base branch.</p>
+<p>(from GitHub’s <a class="reference external" href="https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests">About pull requests</a> page)</p>
+</div></blockquote>
+<p>Before you do a Pull Request, the NuttX team will usually want all the changes you made in your branch “squashed” into
+a single commit, so that when they review your changes, there’s a clean view of the history. If there are changes
+after Pull Request review feedback, they can be separate commits. Here’s the easiest way I found to do that initial
+squash before submitting the Pull Request:</p>
+<ol class="arabic">
+<li><p>Check out my branch</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ git checkout my-branch
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Fetch the upstream code</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ git fetch upstream
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Rebase onto the upstream code</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ git rebase upstream/master
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Push to your remote</p>
+<p>This needs to a force push with <code class="docutils literal notranslate"><span class="pre">-f</span></code>.</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ git push -u my-branch -f
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Create a GitHub Pull Request</p>
+<p>A Pull Request is how you ask your upstream to review and merge your changes.</p>
+<p>Here’s <a class="reference external" href="https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request">GitHub’s instructions for creating a Pull Request</a>.</p>
+</li>
+<li><p>Get Pull Request feedback and implement changes</p>
+<p>Get suggestions for improvements from reviewers, make changes, and push them to the branch. Once the reviewers are
+happy, they may suggest squashing and merging again to make a single commit. In this case you would repeat steps
+1 through 6.</p>
+</li>
+</ol>
+</div>
+<div class="section" id="git-resources">
+<h2>Git Resources<a class="headerlink" href="#git-resources" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li><p><a class="reference external" href="https://github.github.com/training-kit/downloads/github-git-cheat-sheet.pdf">Git Cheat Sheet (by GitHub)</a></p></li>
+<li><p><a class="reference external" href="https://git-scm.com/book/en/v2">Git Book (online)</a></p></li>
+<li><p><a class="reference external" href="https://cwiki.apache.org/confluence/display/NUTTX/Code+Contribution+Workflow">NuttX Code Contribution Workflow (draft)</a>
+– All the details are here if you need them!</p></li>
+</ul>
+</div>
+</div>
+
+
+ </div>
+
+ </div>
+ <footer>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+
+ © Copyright 2020, The Apache Software Foundation
+
+ </p>
+ </div>
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.Navigation.enable(true);
+ });
+ </script>
+
+
+
+
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/content/docs/latest/contributing/workflow.html b/content/docs/latest/contributing/workflow.html
index eb34127..4d5e276 100644
--- a/content/docs/latest/contributing/workflow.html
+++ b/content/docs/latest/contributing/workflow.html
@@ -58,7 +58,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
- <link rel="next" title="C Coding Standard" href="coding_style.html" />
+ <link rel="next" title="Making Changes Using Git" href="making-changes.html" />
<link rel="prev" title="Contributing" href="index.html" />
</head>
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
@@ -125,6 +125,7 @@
<li class="toctree-l1"><a class="reference internal" href="../releases/index.html">Releases</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Contributing</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Development Workflow</a></li>
+<li class="toctree-l2"><a class="reference internal" href="making-changes.html">Making Changes Using Git</a></li>
<li class="toctree-l2"><a class="reference internal" href="coding_style.html">C Coding Standard</a></li>
<li class="toctree-l2"><a class="reference internal" href="documentation.html">Documentation</a></li>
</ul>
diff --git a/content/docs/latest/genindex.html b/content/docs/latest/genindex.html
index 5547e78..e206211 100644
--- a/content/docs/latest/genindex.html
+++ b/content/docs/latest/genindex.html
@@ -114,7 +114,7 @@
<li class="toctree-l1"><a class="reference internal" href="index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/glossary.html b/content/docs/latest/glossary.html
index da93156..9fbd4c1 100644
--- a/content/docs/latest/glossary.html
+++ b/content/docs/latest/glossary.html
@@ -115,7 +115,7 @@
<li class="toctree-l1"><a class="reference internal" href="index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/guides/drivers.html b/content/docs/latest/guides/drivers.html
new file mode 100644
index 0000000..d2d94c2
--- /dev/null
+++ b/content/docs/latest/guides/drivers.html
@@ -0,0 +1,448 @@
+<!--
+ Documentation/_templates/layout.html
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership. The
+ ASF licenses this file to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance with the
+ License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+-->
+
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Drivers — NuttX latest documentation</title>
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+
+ <link rel="shortcut icon" href="../_static/favicon.ico"/>
+
+
+
+
+
+ <!--[if lt IE 9]>
+ <script src="../_static/js/html5shiv.min.js"></script>
+ <![endif]-->
+
+
+ <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+ <script src="../_static/jquery.js"></script>
+ <script src="../_static/underscore.js"></script>
+ <script src="../_static/doctools.js"></script>
+ <script src="../_static/language_data.js"></script>
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <link rel="next" title="Releases" href="../releases/index.html" />
+ <link rel="prev" title="Simulator" href="simulator.html" />
+</head>
+
+<body class="wy-body-for-nav">
+
+
+ <div class="wy-grid-for-nav">
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-scroll">
+ <div class="wy-side-nav-search" >
+
+
+ <a href="../index.html" class="icon icon-home"> NuttX
+
+
+
+
+ <img src="../_static/NuttX.png" class="logo" alt="Logo"/>
+
+ </a>
+
+ <!-- this version selector is quite ugly, should be probably replaced by something
+ more modern -->
+
+ <div class="version-selector">
+ <select>
+
+ <option value="latest" selected="selected">latest</option>
+
+ </select>
+ </div>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+ </div>
+
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+ <p class="caption"><span class="caption-text">Table of Contents</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">API Reference</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Guides</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="nfs.html">NFS Client How-To</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usbtrace.html">USB Device Trace</a></li>
+<li class="toctree-l2"><a class="reference internal" href="simulator.html">Simulator</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Drivers</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#porting-a-driver">Porting a Driver</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#nuttx-drivers-as-a-reference">NuttX Drivers as a Reference</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#using-chip-datasheets">Using Chip Datasheets</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#logic-analyzers">Logic Analyzers</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#dma-debugging">DMA Debugging</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../releases/index.html">Releases</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </div>
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" aria-label="top navigation">
+
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">NuttX</a>
+
+ </nav>
+
+
+ <div class="wy-nav-content">
+
+ <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+ <ul class="wy-breadcrumbs">
+
+ <li><a href="../index.html" class="icon icon-home"></a> »</li>
+
+ <li><a href="index.html">Guides</a> »</li>
+
+ <li>Drivers</li>
+
+
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../_sources/guides/drivers.rst.txt" rel="nofollow"> View page source</a>
+
+
+ </li>
+
+ </ul>
+
+
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="drivers">
+<span id="id1"></span><h1>Drivers<a class="headerlink" href="#drivers" title="Permalink to this headline">¶</a></h1>
+<p>Some NuttX boards don’t have full support for all the on-chip peripherals. If you need support for this hardware,
+you will either need to port a driver from another chip, or write one yourself. This section discusses how to do that.</p>
+<div class="section" id="porting-a-driver">
+<h2>Porting a Driver<a class="headerlink" href="#porting-a-driver" title="Permalink to this headline">¶</a></h2>
+<p>Often support for on-chip peripherals exists in a closely related chip, or even a different family or from a different
+manufacturer. Many chips are made up of different Intellectual Property (IP) blocks that are licensed from vendors like
+Cadence, Synopsys, and others. The IP blocks may be similar enough to use another chip’s driver with little
+modification.</p>
+<ul>
+<li><p>Find a similar driver in NuttX source code:</p>
+<ul class="simple">
+<li><p>Look at register names listed in the datasheet for the peripheral.</p></li>
+<li><p>Search the NuttX codebase for the register names (try several different ones).</p></li>
+<li><p>Note that you’ll have to compare the datasheet to the header and code files to see if there are differences; there
+will usually be some differences between architectures, and they can be significant.</p></li>
+</ul>
+</li>
+<li><p>Find a similar driver in U-Boot, Zephyr or BSD Unix (OpenBSD, FreeBSD, NetBSD) source code:</p>
+<ul class="simple">
+<li><p>Only for inspiration, you can’t copy code because of license incompatibility and Apache Foundation restrictions.
+(Apache License 2.0 and BSD code can come in with a software grant agreement from the original authors; this can
+sometimes be hard to get. Ask on the mailing list if you’re unsure.)</p></li>
+<li><p>But you can debug to see how the driver works.</p></li>
+<li><p><a class="reference external" href="https://www.denx.de/wiki/U-Boot">U-Boot</a> drivers are often easier to understand than BSD Unix drivers because
+U-Boot is simpler.</p></li>
+</ul>
+</li>
+<li><p>Understanding how the driver works</p>
+<p>Here are a couple of techniques that helped me.</p>
+<blockquote>
+<div><ul>
+<li><p>printf debugging</p>
+<ul>
+<li><p>Sprinkle <code class="docutils literal notranslate"><span class="pre">custinfo()</span></code> logging statements through your code to see execution paths and look at variables
+while the code is running. The reason to use <code class="docutils literal notranslate"><span class="pre">custinfo()</span></code> as opposed to the other logging shortcuts
+(<code class="docutils literal notranslate"><span class="pre">mcinfo()</span></code>, etc.) is that you can turn on and off other other logging and still see your custom debug
+logging. Sometimes it’s useful to quiet the flood of logging that comes from a particular debug logging
+shortcut.</p></li>
+<li><p>Note that printing info to the console will affect timing.</p></li>
+<li><p>Keep a file with just your debug settings in it, like this (<code class="docutils literal notranslate"><span class="pre">debugsettings</span></code>):</p>
+<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="n">CONFIG_DEBUG_CUSTOM_INFO</span><span class="o">=</span><span class="n">y</span>
+<span class="p">(</span><span class="n">etc</span><span class="p">..)</span>
+</pre></div>
+</div>
+</li>
+<li><p>Add the settings to the end of your <code class="docutils literal notranslate"><span class="pre">.config</span></code> file after running <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">menuconfig</span></code> (that will reorder
+the file, making it harder to see and change the debug settings if you need to).</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ cat .config debugsettings > .config1 <span class="p">;</span> mv .config1 .config
+</pre></div>
+</div>
+</li>
+<li><p>If you are using interrupts and threads (many things in NuttX run in different threads as a response to interrupts),
+you can use printf debugging to see overlapping execution.</p>
+<ul>
+<li><p>Interrupts - here’s how to inspect the C stack frame to see what execution environment is currently running:</p>
+<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="kt">uint32_t</span> <span class="n">frame</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="cm">/* MUST be the very first thing in the function */</span>
+<span class="kt">uint32_t</span> <span class="n">p_frame</span><span class="p">;</span>
+<span class="n">frame</span><span class="o">++</span><span class="p">;</span> <span class="cm">/* make sure that frame doesn't get optimized out */</span>
+<span class="n">p_frame</span> <span class="o">=</span> <span class="p">(</span><span class="kt">uint32_t</span><span class="p">)(</span><span class="o">&</span><span class="n">frame</span><span class="p">);</span>
+<span class="n">custinfo</span><span class="p">(</span><span class="s">"p_frame: %08x</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="n">p_frame</span><span class="p">);</span>
+</pre></div>
+</div>
+</li>
+<li><p>Threads - here’s how to get the thread identifier to see which thread is currently executing:</p>
+<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="n">pthread_t</span> <span class="n">thread_id</span> <span class="o">=</span> <span class="n">pthread_self</span><span class="p">();</span>
+<span class="n">custinfo</span><span class="p">(</span><span class="s">"pthread_id: %08x</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="n">thread_id</span><span class="p">);</span>
+</pre></div>
+</div>
+</li>
+</ul>
+</li>
+<li><p>stack frame printf</p></li>
+<li><p>thread printf</p></li>
+</ul>
+</li>
+<li><p><a class="reference external" href="https://www.gnu.org/software/gdb/">GDB — the Gnu Debugger</a></p>
+<p>GDB is a great tool. In this guide we’ve already used it to load our program and run it. But it can do a lot
+more. You can single-step through code, examine variables and memory, set breakpoints, and more. I generally use
+it from the commandline, but have also used it from an IDE like JetBrains’ Clion, where it’s easier to see the
+code context.</p>
+<p>One add-on that I found to be essential is the ability to examine blocks of memory, like buffers that NuttX uses
+for reading and writing to storage media or network adapters. This <a class="reference external" href="https://stackoverflow.com/a/54784260/431222">Stack Overflow question on using GDB to
+examine memory</a> includes a GDB command that is very handy. Add
+this to your <code class="docutils literal notranslate"><span class="pre">.gdbinit</span></code> file, and then use the <code class="docutils literal notranslate"><span class="pre">xxd</span></code> command to dump memory in an easy-to-read format:</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>define xxd
+ if $argc < 2
+ set $size = sizeof(*$arg0)
+ else
+ set $size = $arg1
+ end
+ dump binary memory dump.bin $arg0 ((void *)$arg0)+$size
+ eval "shell xxd -o %d dump.bin; rm dump.bin", ((void *)$arg0)
+end
+document xxd
+ Dump memory with xxd command (keep the address as offset)
+
+ xxd addr [size]
+ addr -- expression resolvable as an address
+ size -- size (in byte) of memory to dump
+ sizeof(*addr) is used by default end
+</pre></div>
+</div>
+<p>Here’s a short GDB session that shows what this looks like in practice. Note that the memory location being
+examined (<code class="docutils literal notranslate"><span class="pre">0x200aa9eo</span></code> here) is a buffer being passed to <code class="docutils literal notranslate"><span class="pre">mmcsd_readsingle</span></code>:</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>Program received signal SIGTRAP, Trace/breakpoint trap.
+0x200166e8 in up_idle () at common/arm_idle.c:78
+78 }
+(gdb) b mmcsd_readsingle
+Breakpoint 1 at 0x2006ea70: file mmcsd/mmcsd_sdio.c, line 1371.
+(gdb) c
+Continuing.
+
+Breakpoint 1, mmcsd_readsingle (priv=0x200aa8c0, buffer=0x200aa9e0 "WRTEST TXT \030", startblock=2432) at mmcsd/mmcsd_sdio.c:1371
+1371 finfo("startblock=%d\n", startblock);
+(gdb) xxd 0x200aa9e0 200
+200aa9e0: 5752 5445 5354 2020 5458 5420 1800 0000 WRTEST TXT ....
+200aa9f0: 0000 0000 0000 0000 0000 5500 1100 0000 ..........U.....
+200aaa00: 5752 5445 5354 3520 5458 5420 1800 0000 WRTEST5 TXT ....
+200aaa10: 0000 0000 0000 0000 0000 5800 1500 0000 ..........X.....
+200aaa20: e552 5445 5854 3620 5458 5420 1800 0000 .RTEXT6 TXT ....
+200aaa30: 0000 0000 0000 0000 0000 5600 1200 0000 ..........V.....
+200aaa40: 5752 5445 5354 3620 5458 5420 1800 0000 WRTEST6 TXT ....
+200aaa50: 0000 0000 0000 0000 0000 5600 1200 0000 ..........V.....
+200aaa60: 0000 0000 0000 0000 0000 0000 0000 0000 ................
+200aaa70: 0000 0000 0000 0000 0000 0000 0000 0000 ................
+200aaa80: 0000 0000 0000 0000 0000 0000 0000 0000 ................
+200aaa90: 0000 0000 0000 0000 0000 0000 0000 0000 ................
+200aaaa0: 0000 0000 0000 0000 ........
+</pre></div>
+</div>
+</li>
+</ul>
+</div></blockquote>
+</li>
+</ul>
+</div>
+<div class="section" id="nuttx-drivers-as-a-reference">
+<h2>NuttX Drivers as a Reference<a class="headerlink" href="#nuttx-drivers-as-a-reference" title="Permalink to this headline">¶</a></h2>
+<p>If you’re not porting a NuttX driver from another architecture, it still helps to look at other similar NuttX
+drivers, if there are any. For instance, when implementing an Ethernet driver, look at other NuttX Ethernet drivers;
+for an SD Card driver, look at other NuttX Ethernet drivers. Even if the chip-specific code won’t be the same, the
+structure to interface with NuttX can be used.</p>
+</div>
+<div class="section" id="using-chip-datasheets">
+<h2>Using Chip Datasheets<a class="headerlink" href="#using-chip-datasheets" title="Permalink to this headline">¶</a></h2>
+<p>To port or write a driver, you’ll have to be familiar with the information in the chip datasheet. Definitely find
+the datasheet for your chip, and read the sections relevant to the peripheral you’re working with. Doing so ahead
+of time will save a lot of time later.</p>
+<p>Another thing that’s often helpful is to refer to sample code provided by the manufacturer, or driver code from
+another operating system (like U-Boot, Zephyr, or FreeBSD) while referring to the datasheet — seeing how working
+code implements the necessary algorithms often helps one understand how the driver needs to work.</p>
+<ul>
+<li><p>How to use a datasheet</p>
+<p>Key pieces of information in System-on-a-Chip (SoC) datasheets are usually:</p>
+<ul class="simple">
+<li><p>Chip Architecture Diagram — shows how the subsections of the chip (CPU, system bus, peripherals, I/O, etc.) connect
+to each other.</p></li>
+<li><p>Memory Map — showing the location of peripheral registers in memory. This info usually goes into a header file.</p></li>
+<li><p>DMA Engine — if Direct Memory Access (DMA) is used, this may have info on how to use it.</p></li>
+<li><p>Peripheral — the datasheet usually has a section on how the peripheral works. Key parts of this include:</p>
+<ul>
+<li><p>Registers List — name and offset from the base memory address of the peripheral. This needs to go into a header
+file.</p></li>
+<li><p>Register Map — what is the size of each register, and what do the bits mean? You will need to create <code class="docutils literal notranslate"><span class="pre">#defines</span></code>
+in a header file that your code will use to operate on the registers. Refer to other driver header files for
+examples.</p></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="section" id="logic-analyzers">
+<h2>Logic Analyzers<a class="headerlink" href="#logic-analyzers" title="Permalink to this headline">¶</a></h2>
+<p>For drivers that involve input and output (I/O), especially that involve complex protocols like SD Cards, SPI, I2C,
+etc., actually seeing the waveform that goes in and out the chip’s pins is extremely helpful. <a class="reference external" href="https://en.wikipedia.org/wiki/Logic_analyzer">Logic Analyzers</a>
+can capture that information and display it graphically, allowing you to see if the driver is doing the right thing
+on the wire.</p>
+</div>
+<div class="section" id="dma-debugging">
+<h2>DMA Debugging<a class="headerlink" href="#dma-debugging" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li><p>Dump registers before, during, and after transfer. Some NuttX drivers (<code class="docutils literal notranslate"><span class="pre">sam_sdmmc.c</span></code> or <code class="docutils literal notranslate"><span class="pre">imxrt_sdmmc.c</span></code> for
+example) have built-in code for debugging register states, and can sample registers before, during, and
+immediately after a DMA transfer, as well as code that can dump the peripheral registers in a nicely-formatted
+way onto the console device (which can be a serial console, a network console, or memory). Consider using something
+like this to see what’s happening inside the chip if you’re trying to debug DMA transfer code.</p></li>
+<li><p>Compare register settings to expected settings determined from the datasheet or from dumping registers from working
+code in another operating system (U-Boot, Zephyr, FreeBSD, etc.).</p></li>
+<li><p>Use the <code class="docutils literal notranslate"><span class="pre">xxd</span></code> GDB tool mentioned above to dump NuttX memory buffers before, during, and after a transfer to see if
+data is being transferred correctly, if there are over- or under-runs, or to diagnose data being stored in incorrect
+locations.</p></li>
+<li><p>printf debugging register states can also help here.</p></li>
+<li><p>Remember that logging can change the timing of any algorithms you might be using, so things may start or stop
+working when logging is added or removed. Definitely test with logging disabled.</p></li>
+</ul>
+</div>
+</div>
+
+
+ </div>
+
+ </div>
+ <footer>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+
+ © Copyright 2020, The Apache Software Foundation
+
+ </p>
+ </div>
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.Navigation.enable(true);
+ });
+ </script>
+
+
+
+
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/content/docs/latest/guides/index.html b/content/docs/latest/guides/index.html
index c94cfa8..336cd7e 100644
--- a/content/docs/latest/guides/index.html
+++ b/content/docs/latest/guides/index.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
@@ -124,6 +124,8 @@
<li class="toctree-l1 current"><a class="current reference internal" href="#">Guides</a><ul>
<li class="toctree-l2"><a class="reference internal" href="nfs.html">NFS Client How-To</a></li>
<li class="toctree-l2"><a class="reference internal" href="usbtrace.html">USB Device Trace</a></li>
+<li class="toctree-l2"><a class="reference internal" href="simulator.html">Simulator</a></li>
+<li class="toctree-l2"><a class="reference internal" href="drivers.html">Drivers</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../releases/index.html">Releases</a></li>
@@ -210,6 +212,21 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="usbtrace.html">USB Device Trace</a></li>
+<li class="toctree-l1"><a class="reference internal" href="simulator.html">Simulator</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="simulator.html#compiling">Compiling</a></li>
+<li class="toctree-l2"><a class="reference internal" href="simulator.html#accessing-the-network">Accessing the Network</a></li>
+<li class="toctree-l2"><a class="reference internal" href="simulator.html#stopping">Stopping</a></li>
+<li class="toctree-l2"><a class="reference internal" href="simulator.html#debugging">Debugging</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="drivers.html">Drivers</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="drivers.html#porting-a-driver">Porting a Driver</a></li>
+<li class="toctree-l2"><a class="reference internal" href="drivers.html#nuttx-drivers-as-a-reference">NuttX Drivers as a Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="drivers.html#using-chip-datasheets">Using Chip Datasheets</a></li>
+<li class="toctree-l2"><a class="reference internal" href="drivers.html#logic-analyzers">Logic Analyzers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="drivers.html#dma-debugging">DMA Debugging</a></li>
+</ul>
+</li>
</ul>
</div>
</div>
diff --git a/content/docs/latest/guides/nfs.html b/content/docs/latest/guides/nfs.html
index b3be15f..60f83a4 100644
--- a/content/docs/latest/guides/nfs.html
+++ b/content/docs/latest/guides/nfs.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
@@ -130,6 +130,8 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="usbtrace.html">USB Device Trace</a></li>
+<li class="toctree-l2"><a class="reference internal" href="simulator.html">Simulator</a></li>
+<li class="toctree-l2"><a class="reference internal" href="drivers.html">Drivers</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../releases/index.html">Releases</a></li>
diff --git a/content/docs/latest/guides/simulator.html b/content/docs/latest/guides/simulator.html
new file mode 100644
index 0000000..94fa420
--- /dev/null
+++ b/content/docs/latest/guides/simulator.html
@@ -0,0 +1,435 @@
+<!--
+ Documentation/_templates/layout.html
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership. The
+ ASF licenses this file to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance with the
+ License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+-->
+
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Simulator — NuttX latest documentation</title>
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+
+ <link rel="shortcut icon" href="../_static/favicon.ico"/>
+
+
+
+
+
+ <!--[if lt IE 9]>
+ <script src="../_static/js/html5shiv.min.js"></script>
+ <![endif]-->
+
+
+ <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+ <script src="../_static/jquery.js"></script>
+ <script src="../_static/underscore.js"></script>
+ <script src="../_static/doctools.js"></script>
+ <script src="../_static/language_data.js"></script>
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <link rel="next" title="Drivers" href="drivers.html" />
+ <link rel="prev" title="USB Device Trace" href="usbtrace.html" />
+</head>
+
+<body class="wy-body-for-nav">
+
+
+ <div class="wy-grid-for-nav">
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-scroll">
+ <div class="wy-side-nav-search" >
+
+
+ <a href="../index.html" class="icon icon-home"> NuttX
+
+
+
+
+ <img src="../_static/NuttX.png" class="logo" alt="Logo"/>
+
+ </a>
+
+ <!-- this version selector is quite ugly, should be probably replaced by something
+ more modern -->
+
+ <div class="version-selector">
+ <select>
+
+ <option value="latest" selected="selected">latest</option>
+
+ </select>
+ </div>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+ </div>
+
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+ <p class="caption"><span class="caption-text">Table of Contents</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">API Reference</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Guides</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="nfs.html">NFS Client How-To</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usbtrace.html">USB Device Trace</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Simulator</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#compiling">Compiling</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#accessing-the-network">Accessing the Network</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#stopping">Stopping</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#debugging">Debugging</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="drivers.html">Drivers</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../releases/index.html">Releases</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </div>
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" aria-label="top navigation">
+
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">NuttX</a>
+
+ </nav>
+
+
+ <div class="wy-nav-content">
+
+ <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+ <ul class="wy-breadcrumbs">
+
+ <li><a href="../index.html" class="icon icon-home"></a> »</li>
+
+ <li><a href="index.html">Guides</a> »</li>
+
+ <li>Simulator</li>
+
+
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../_sources/guides/simulator.rst.txt" rel="nofollow"> View page source</a>
+
+
+ </li>
+
+ </ul>
+
+
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="simulator">
+<span id="id1"></span><h1>Simulator<a class="headerlink" href="#simulator" title="Permalink to this headline">¶</a></h1>
+<p>Apache NuttX has a simulator that can run as a regular program on Linux, Mac, and Windows computers.
+It’s useful for debugging operating system features that aren’t associated with particular
+device drivers— for instance the TCP/IP stack itself, a web interface or API for your
+application, or other communication protocols. It’s also handy for trying out Apache NuttX without
+having a piece of embedded hardware.</p>
+<p>This guide assumes you’re on Linux. It works on Windows and Mac too— if you know how,
+submit a PR to improve this guide!</p>
+<div class="admonition-todo admonition" id="id2">
+<p class="admonition-title">Todo</p>
+<p>Add Mac and Windows instructions</p>
+</div>
+<div class="section" id="compiling">
+<h2>Compiling<a class="headerlink" href="#compiling" title="Permalink to this headline">¶</a></h2>
+<ol class="arabic">
+<li><p>Configure the Simulator</p>
+<p>There are a lot of simulator configurations available that set you up to test various
+operating system features.</p>
+<p>Here we’ll use the <code class="docutils literal notranslate"><span class="pre">sim:nsh</span></code> basic NuttX Shell configuration.</p>
+<blockquote>
+<div><div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> <span class="nb">cd</span> nuttx
+<span class="gp">$</span> ./tools/configure.sh sim:nsh
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Compile</p>
+<blockquote>
+<div><div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> make
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Run the simulator:</p>
+<blockquote>
+<div><div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> ./nuttx
+<span class="go">login: admin</span>
+<span class="go">password: Administrator</span>
+<span class="go">User Logged-in!</span>
+
+<span class="go">NuttShell (NSH) NuttX-9.1.0</span>
+<span class="go">MOTD: username=admin password=Administrator</span>
+<span class="go">nsh> help</span>
+<span class="go">help usage: help [-v] [<cmd>]</span>
+
+<span class="go"> [ cp exit losetup mv rmdir true</span>
+<span class="go"> ? cmp false ls mw set uname</span>
+<span class="go"> basename dirname free mb poweroff sh unset</span>
+<span class="go"> break dd help mkdir ps sleep usleep</span>
+<span class="go"> cat echo hexdump mkfatfs pwd test xd</span>
+<span class="go"> cd exec kill mh rm time</span>
+
+<span class="go">Builtin Apps:</span>
+<span class="go"> hello nsh</span>
+
+<span class="go">nsh></span>
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Stop the simulator:</p>
+<blockquote>
+<div><div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">nsh> poweroff</span>
+<span class="gp">$</span>
+<span class="gp">$</span> <span class="c1"># we're back at the Linux prompt.</span>
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+</ol>
+</div>
+<div class="section" id="accessing-the-network">
+<h2>Accessing the Network<a class="headerlink" href="#accessing-the-network" title="Permalink to this headline">¶</a></h2>
+<ol class="arabic">
+<li><p>Here we’ll use the <code class="docutils literal notranslate"><span class="pre">sim:tcpblaster</span></code> configuration because it comes with networking
+that is ready to use.</p>
+<blockquote>
+<div><div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> make distclean
+<span class="gp">$</span> ./tools/configure.sh sim:tcpblaster
+<span class="gp">$</span> make
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Give the Simulator Privileges</p>
+<p>On recent Linux distributions, you need to give the <code class="docutils literal notranslate"><span class="pre">nuttx</span></code> program the capabilities
+(similar to permissions) to access the network:</p>
+<blockquote>
+<div><div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> sudo setcap cap_net_admin+ep ./nuttx
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Run the simulator:</p>
+<blockquote>
+<div><div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> ./nuttx
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Bring Up the Network Interfaces</p>
+<p>On Apache NuttX:</p>
+<blockquote>
+<div><div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">nsh> ifup eth0</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p>On Linux, first you need to find your main network interface— this will usually either
+be an ethernet or wireless network adapter. Do this:</p>
+<blockquote>
+<div><div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> ifconfig
+<span class="go">lo: flags=73<UP,LOOPBACK,RUNNING> mtu 65536</span>
+<span class="go"> inet 127.0.0.1 netmask 255.0.0.0</span>
+<span class="go"> inet6 ::1 prefixlen 128 scopeid 0x10<host></span>
+<span class="go"> loop txqueuelen 1000 (Local Loopback)</span>
+<span class="go"> RX packets 5846 bytes 614351 (614.3 KB)</span>
+<span class="go"> RX errors 0 dropped 0 overruns 0 frame 0</span>
+<span class="go"> TX packets 5846 bytes 614351 (614.3 KB)</span>
+<span class="go"> TX errors 0 dropped 0 overruns 0 carrier 0 collisions 0</span>
+
+<span class="go">wlp0s20f3: flags=4163<UP,BROADCAST,RUNNING,MULTICAST> mtu 1500</span>
+<span class="go"> inet 192.168.1.209 netmask 255.255.255.0 broadcast 192.168.1.255</span>
+<span class="go"> inet6 fe80::1161:c26b:af05:d784 prefixlen 64 scopeid 0x20<link></span>
+<span class="go"> ether 24:41:8c:a8:30:d1 txqueuelen 1000 (Ethernet)</span>
+<span class="go"> RX packets 219369 bytes 176416490 (176.4 MB)</span>
+<span class="go"> RX errors 0 dropped 0 overruns 0 frame 0</span>
+<span class="go"> TX packets 108399 bytes 27213617 (27.2 MB)</span>
+<span class="go"> TX errors 0 dropped 0 overruns 0 carrier 0 collisions 0</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p><code class="docutils literal notranslate"><span class="pre">lo0</span></code> is the Loopback Interface, so <code class="docutils literal notranslate"><span class="pre">wlp0s20f3</span></code> is the wireless interface. Note
+that it has an IP address on the local net. There may be other interfaces listed, you’ll
+need to pick the one that’s right for your system.</p>
+<p>Then, on Linux do this to set up the tap network interface and route that will let
+the Apache Nuttx simulator access the network:</p>
+<blockquote>
+<div><div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> sudo ./tools/simhostroute.sh wlp0s20f3 on
+<span class="gp">$</span> ping -c <span class="m">1</span> <span class="m">10</span>.0.1.2 <span class="c1"># nuttx system</span>
+<span class="go">PING 10.0.1.2 (10.0.1.2) 56(84) bytes of data.</span>
+<span class="go">64 bytes from 10.0.1.2: icmp_seq=1 ttl=64 time=7.52 ms</span>
+
+<span class="go">--- 10.0.1.2 ping statistics ---</span>
+<span class="go">1 packets transmitted, 1 received, 0% packet loss, time 0ms</span>
+<span class="go">rtt min/avg/max/mdev = 7.529/7.529/7.529/0.000 m</span>
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Test that Apache NuttX can access the Internet</p>
+<p>First let’s ping the network interface of our Linux host to prove we can see the
+gateway to the Internet:</p>
+<blockquote>
+<div><div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">nsh> ping -c 1 10.0.1.1</span>
+<span class="go">nsh> ping -c 1 10.0.1.1</span>
+<span class="go">PING 10.0.1.1 56 bytes of data</span>
+<span class="go">56 bytes from 10.0.1.1: icmp_seq=0 time=0 ms</span>
+<span class="go">1 packets transmitted, 1 received, 0% packet loss, time 1010 ms</span>
+</pre></div>
+</div>
+<p>Now let’s ping one of Google’s DNS servers to prove we can access the rest of the
+Internet:</p>
+<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">nsh> ping -c 1 8.8.8.8</span>
+<span class="go">PING 8.8.8.8 56 bytes of data</span>
+<span class="go">56 bytes from 8.8.8.8: icmp_seq=0 time=10 ms</span>
+<span class="go">1 packets transmitted, 1 received, 0% packet loss, time 1010 ms</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p>Success!</p>
+</li>
+</ol>
+</div>
+<div class="section" id="stopping">
+<h2>Stopping<a class="headerlink" href="#stopping" title="Permalink to this headline">¶</a></h2>
+<p>If you don’t have an nsh prompt, the only effective way to stop the simulator is kill it from another terminal:</p>
+<blockquote>
+<div><div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> pkill nuttx
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+<div class="section" id="debugging">
+<h2>Debugging<a class="headerlink" href="#debugging" title="Permalink to this headline">¶</a></h2>
+<p>You can debug the simulator like any regular Linux program.</p>
+</div>
+</div>
+
+
+ </div>
+
+ </div>
+ <footer>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+
+ © Copyright 2020, The Apache Software Foundation
+
+ </p>
+ </div>
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.Navigation.enable(true);
+ });
+ </script>
+
+
+
+
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/content/docs/latest/guides/usbtrace.html b/content/docs/latest/guides/usbtrace.html
index 5ea3b04..ed87bd3 100644
--- a/content/docs/latest/guides/usbtrace.html
+++ b/content/docs/latest/guides/usbtrace.html
@@ -58,7 +58,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
- <link rel="next" title="Releases" href="../releases/index.html" />
+ <link rel="next" title="Simulator" href="simulator.html" />
<link rel="prev" title="NFS Client How-To" href="nfs.html" />
</head>
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
@@ -124,6 +124,8 @@
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Guides</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="nfs.html">NFS Client How-To</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">USB Device Trace</a></li>
+<li class="toctree-l2"><a class="reference internal" href="simulator.html">Simulator</a></li>
+<li class="toctree-l2"><a class="reference internal" href="drivers.html">Drivers</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../releases/index.html">Releases</a></li>
diff --git a/content/docs/latest/index.html b/content/docs/latest/index.html
index 2adfa4c..88fb266 100644
--- a/content/docs/latest/index.html
+++ b/content/docs/latest/index.html
@@ -115,7 +115,7 @@
<li class="toctree-l1 current"><a class="current reference internal" href="#">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="boards/index.html">Supported Boards</a></li>
@@ -203,7 +203,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: 02 September 20 at 20:23</p>
+<p>Last Updated: 04 September 20 at 23:39</p>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Table of Contents</span></p>
<ul class="current">
@@ -229,9 +229,15 @@ by following these <a class="reference internal" href="contributing/documentatio
<li class="toctree-l2"><a class="reference internal" href="introduction/inviolables.html#the-enemies">The Enemies</a></li>
</ul>
</li>
-<li class="toctree-l1"><a class="reference internal" href="quickstart/index.html">Quickstart</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="quickstart/index.html">Getting Started</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="quickstart/quickstart.html">Quickstart</a></li>
+<li class="toctree-l2"><a class="reference internal" href="quickstart/install.html">Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="quickstart/compiling.html">Compiling</a></li>
+<li class="toctree-l2"><a class="reference internal" href="quickstart/running.html">Running</a></li>
+<li class="toctree-l2"><a class="reference internal" href="quickstart/configuring.html">Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="quickstart/debugging.html">Debugging</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart/organization.html">Directory Structure</a></li>
-<li class="toctree-l2"><a class="reference internal" href="quickstart/config_build.html">Configuring and Building</a></li>
+<li class="toctree-l2"><a class="reference internal" href="quickstart/build_and_make.html">Build and Make Details</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="components/index.html">OS Components</a><ul>
@@ -258,11 +264,14 @@ by following these <a class="reference internal" href="contributing/documentatio
<li class="toctree-l1"><a class="reference internal" href="guides/index.html">Guides</a><ul>
<li class="toctree-l2"><a class="reference internal" href="guides/nfs.html">NFS Client How-To</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/usbtrace.html">USB Device Trace</a></li>
+<li class="toctree-l2"><a class="reference internal" href="guides/simulator.html">Simulator</a></li>
+<li class="toctree-l2"><a class="reference internal" href="guides/drivers.html">Drivers</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="releases/index.html">Releases</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing/index.html">Contributing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="contributing/workflow.html">Development Workflow</a></li>
+<li class="toctree-l2"><a class="reference internal" href="contributing/making-changes.html">Making Changes Using Git</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing/coding_style.html">C Coding Standard</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing/documentation.html">Documentation</a></li>
</ul>
diff --git a/content/docs/latest/introduction/about.html b/content/docs/latest/introduction/about.html
index d6b7853..d2b2c4b 100644
--- a/content/docs/latest/introduction/about.html
+++ b/content/docs/latest/introduction/about.html
@@ -130,7 +130,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/introduction/detailed_support.html b/content/docs/latest/introduction/detailed_support.html
index 3ad2b8b..a41de7e 100644
--- a/content/docs/latest/introduction/detailed_support.html
+++ b/content/docs/latest/introduction/detailed_support.html
@@ -312,7 +312,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/introduction/development_environments.html b/content/docs/latest/introduction/development_environments.html
index d46f217..7d78463 100644
--- a/content/docs/latest/introduction/development_environments.html
+++ b/content/docs/latest/introduction/development_environments.html
@@ -135,7 +135,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/introduction/index.html b/content/docs/latest/introduction/index.html
index d13faa7..a27936f 100644
--- a/content/docs/latest/introduction/index.html
+++ b/content/docs/latest/introduction/index.html
@@ -125,7 +125,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/introduction/inviolables.html b/content/docs/latest/introduction/inviolables.html
index 8200175..0a75140 100644
--- a/content/docs/latest/introduction/inviolables.html
+++ b/content/docs/latest/introduction/inviolables.html
@@ -58,7 +58,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
- <link rel="next" title="Quickstart" href="../quickstart/index.html" />
+ <link rel="next" title="Getting Started" href="../quickstart/index.html" />
<link rel="prev" title="Resources" href="resources.html" />
</head>
@@ -132,7 +132,7 @@
</li>
</ul>
</li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/introduction/licensing.html b/content/docs/latest/introduction/licensing.html
index a905f03..046fdd0 100644
--- a/content/docs/latest/introduction/licensing.html
+++ b/content/docs/latest/introduction/licensing.html
@@ -128,7 +128,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/introduction/resources.html b/content/docs/latest/introduction/resources.html
index 18a2f00..c7ecee6 100644
--- a/content/docs/latest/introduction/resources.html
+++ b/content/docs/latest/introduction/resources.html
@@ -125,7 +125,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/introduction/supported_platforms.html b/content/docs/latest/introduction/supported_platforms.html
index c1e6672..3b9b365 100644
--- a/content/docs/latest/introduction/supported_platforms.html
+++ b/content/docs/latest/introduction/supported_platforms.html
@@ -125,7 +125,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/introduction/trademarks.html b/content/docs/latest/introduction/trademarks.html
index 00649c0..0904023 100644
--- a/content/docs/latest/introduction/trademarks.html
+++ b/content/docs/latest/introduction/trademarks.html
@@ -125,7 +125,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/objects.inv b/content/docs/latest/objects.inv
index d721159..240aa01 100644
Binary files a/content/docs/latest/objects.inv and b/content/docs/latest/objects.inv differ
diff --git a/content/docs/latest/quickstart/config_build.html b/content/docs/latest/quickstart/build_and_make.html
similarity index 54%
rename from content/docs/latest/quickstart/config_build.html
rename to content/docs/latest/quickstart/build_and_make.html
index 4b02ad1..e70dd90 100644
--- a/content/docs/latest/quickstart/config_build.html
+++ b/content/docs/latest/quickstart/build_and_make.html
@@ -26,7 +26,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Configuring and Building — NuttX latest documentation</title>
+ <title>Build and Make Details — NuttX latest documentation</title>
@@ -116,11 +116,18 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="index.html">Quickstart</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Getting Started</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html">Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="compiling.html">Compiling</a></li>
+<li class="toctree-l2"><a class="reference internal" href="running.html">Running</a></li>
+<li class="toctree-l2"><a class="reference internal" href="configuring.html">Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="debugging.html">Debugging</a></li>
<li class="toctree-l2"><a class="reference internal" href="organization.html">Directory Structure</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Configuring and Building</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="#configuring-nuttx">Configuring NuttX</a></li>
-<li class="toctree-l3"><a class="reference internal" href="#building-nuttx">Building NuttX</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Build and Make Details</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#root-directory">Root Directory</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#environment-variables">Environment Variables</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#first-time-make">First Time Make</a></li>
</ul>
</li>
</ul>
@@ -179,15 +186,15 @@
<li><a href="../index.html" class="icon icon-home"></a> »</li>
- <li><a href="index.html">Quickstart</a> »</li>
+ <li><a href="index.html">Getting Started</a> »</li>
- <li>Configuring and Building</li>
+ <li>Build and Make Details</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/quickstart/config_build.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/quickstart/build_and_make.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -200,82 +207,13 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
- <div class="section" id="configuring-and-building">
-<h1>Configuring and Building<a class="headerlink" href="#configuring-and-building" title="Permalink to this headline">¶</a></h1>
-<div class="section" id="configuring-nuttx">
-<h2>Configuring NuttX<a class="headerlink" href="#configuring-nuttx" title="Permalink to this headline">¶</a></h2>
-<p><strong>Manual Configuration</strong>. Configuring NuttX requires only copying
-the <a class="reference external" href="#boardconfigsubdirs">board-specific configuration files</a>
-into the top level directory which appears in the make files as
-the make variable, <code class="docutils literal notranslate"><span class="pre">$(TOPDIR)</span></code>. This could be done manually as
-follows:</p>
-<ul class="simple">
-<li><p>Copy
-<code class="docutils literal notranslate"><span class="pre">boards/</span></code><em><arch-name></em><code class="docutils literal notranslate"><span class="pre">/</span></code><em><chip-name></em><code class="docutils literal notranslate"><span class="pre">/</span></code><em><board-name></em><code class="docutils literal notranslate"><span class="pre">/configs/[</span></code><em><config-dir></em><code class="docutils literal notranslate"><span class="pre">/]Make [...]
-to <code class="docutils literal notranslate"><span class="pre">$(TOPDIR)/Make.defs</span></code> (see NOTE below),</p></li>
-<li><p>Copy
-<code class="docutils literal notranslate"><span class="pre">boards/</span></code><em><arch-name></em><code class="docutils literal notranslate"><span class="pre">/</span></code><em><chip-name></em><code class="docutils literal notranslate"><span class="pre">/</span></code><em><board-name></em><code class="docutils literal notranslate"><span class="pre">/configs/[</span></code><em><config-dir></em><code class="docutils literal notranslate"><span class="pre">/]defc [...]
-to <code class="docutils literal notranslate"><span class="pre">$(TOPDIR)/.config</span></code></p></li>
-</ul>
-<p>Where <em><board-name></em> is the name of one of the sub-directories of
-the NuttX <code class="docutils literal notranslate"><span class="pre">`boards/</span></code> <#DirStructConfigs>`__ directory. This
-sub-directory name corresponds to one of the supported boards
-identified <a class="reference external" href="#supportedboards">above</a>. <config-dir> is the
-optional, specific configuration directory for the board. And
-<app-dir> is the location of the optional application directory.</p>
-<p>NOTE: Recall that the <code class="docutils literal notranslate"><span class="pre">Make.defs</span></code> file may reside in either the
-<code class="docutils literal notranslate"><span class="pre">boards/</span></code><em><arch-name></em><code class="docutils literal notranslate"><span class="pre">/</span></code><em><chip-name></em><code class="docutils literal notranslate"><span class="pre">/</span></code><em><board-name></em>/<code class="docutils literal notranslate"><span class="pre">configs/[</span></code><em><config-dir></em>
-directory or in the
-<code class="docutils literal notranslate"><span class="pre">boards/</span></code><em><arch-name></em><code class="docutils literal notranslate"><span class="pre">/</span></code><em><chip-name></em><code class="docutils literal notranslate"><span class="pre">/</span></code><em><board-name></em>/<code class="docutils literal notranslate"><span class="pre">scripts</span></code>.</p>
-<p><strong>Automated Configuration</strong>. There is a script that automates
-these steps. The following steps will accomplish the same
-configuration:</p>
-<p>There is an alternative Windows batch file, <code class="docutils literal notranslate"><span class="pre">configure.bat</span></code>,
-that can be used instead of <code class="docutils literal notranslate"><span class="pre">configure.sh</span></code> in the windows native
-environment like:</p>
-<p>And, to make sure that other platforms are supported, there is
-also a C program at <code class="docutils literal notranslate"><span class="pre">tools/configure.c</span></code> that can be compiled to
-establish the board configuration on all platforms.</p>
-<blockquote>
-<div><p>NOTE (2019-08-6): As of this writing, changes to the boards/
-directly have made <code class="docutils literal notranslate"><span class="pre">configure.bat</span></code> unusable. For the native
-Windows environment, <code class="docutils literal notranslate"><span class="pre">configure.c</span></code> is recommended until that
-batch file can be repaired.</p>
-</div></blockquote>
-<p>See <code class="docutils literal notranslate"><span class="pre">tools/README.txt</span></code> for more information about these scripts.
-Or use the -h option with <code class="docutils literal notranslate"><span class="pre">configure.sh></span></code></p>
-<p>If your application directory is not in the standard location
-(<code class="docutils literal notranslate"><span class="pre">../apps</span></code> or <code class="docutils literal notranslate"><span class="pre">../apps-<version></span></code>), then you should also
-specify the location of the application directory on the command
-line like:</p>
-<p><strong>Version Files</strong>. The NuttX build expects to find a version file
-located in the top-level NuttX build directory. That version file
-is called <code class="docutils literal notranslate"><span class="pre">.version</span></code>. The correct version file is installed in
-each versioned NuttX released. However, if you are working from an
-GIT snapshot, then there will be no version file. If there is no
-version file, the top-level <code class="docutils literal notranslate"><span class="pre">Makefile</span></code> will create a dummy
-<code class="docutils literal notranslate"><span class="pre">.version</span></code> file on the first make. This dummy version file will
-contain all zeroes for version information. If that is not what
-you want, they you should run the <code class="docutils literal notranslate"><span class="pre">version.sh</span></code> script to create
-a better <code class="docutils literal notranslate"><span class="pre">.version</span></code> file.</p>
-<p>You can get help information from the <code class="docutils literal notranslate"><span class="pre">version.sh</span></code> script using
-the <code class="docutils literal notranslate"><span class="pre">-h</span></code> option. For example:</p>
-<p>As an example, the following command will generate a version file
-for version 6.1 using the current GIT revision number:</p>
-<p>The <code class="docutils literal notranslate"><span class="pre">.version</span></code> file is also used during the build process to
-create a C header file at <code class="docutils literal notranslate"><span class="pre">include/nuttx/version.h</span></code> that
-contains the same version information. That version file may be
-used by your C applications for, as an example, reporting version
-information.</p>
-<p><strong>Additional Configuration Steps</strong>. The remainder of configuration
-steps will be performed by
-<code class="docutils literal notranslate"><span class="pre">`$(TOPDIR)/Makefile</span></code> <#topmakefile>`__ the first time the
-system is built as described below.</p>
-</div>
-<div class="section" id="building-nuttx">
-<h2>Building NuttX<a class="headerlink" href="#building-nuttx" title="Permalink to this headline">¶</a></h2>
-<p><strong>Building NuttX</strong>. Once NuttX has been configured as described
-<a class="reference external" href="#configuringnuttx">above</a>, it may be built as follows:</p>
+ <div class="section" id="build-and-make-details">
+<span id="build-and-make"></span><h1>Build and Make Details<a class="headerlink" href="#build-and-make-details" title="Permalink to this headline">¶</a></h1>
+<p>This is included for reference, and it’s not necessary to know all these details.</p>
+<p>As described in <a class="reference internal" href="compiling.html#compiling"><span class="std std-ref">Compiling</span></a>, you use <code class="docutils literal notranslate"><span class="pre">make</span></code> at the root <code class="docutils literal notranslate"><span class="pre">nuttx/</span></code> directory to build NuttX. This is also
+referenced as <code class="docutils literal notranslate"><span class="pre">$(TOPDIR)</span></code> in the <code class="docutils literal notranslate"><span class="pre">Makefile</span></code>.</p>
+<div class="section" id="root-directory">
+<h2>Root Directory<a class="headerlink" href="#root-directory" title="Permalink to this headline">¶</a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">$(TOPDIR)</span></code> directory holds:</p>
<ul class="simple">
<li><p>The top level <code class="docutils literal notranslate"><span class="pre">`Makefile</span></code> <#topmakefile>`__ that controls the
@@ -288,13 +226,18 @@ that describes the current configuration, and</p></li>
<li><p>The makefile fragment <code class="docutils literal notranslate"><span class="pre">`Make.defs</span></code> <#boardconfigsubdirs>`__
that provides customized build targets.</p></li>
</ul>
-<p><strong>Environment Variables</strong>. The specific environmental definitions
+</div>
+<div class="section" id="environment-variables">
+<h2>Environment Variables<a class="headerlink" href="#environment-variables" title="Permalink to this headline">¶</a></h2>
+<p>The specific environmental definitions
are unique for each board but should include, as a minimum,
updates to the <code class="docutils literal notranslate"><span class="pre">PATH</span></code> variable to include the full path to the
architecture-specific toolchain identified in
<code class="docutils literal notranslate"><span class="pre">`Make.defs</span></code> <#boardconfigsubdirs>`__.</p>
-<p><strong>First Time Make.</strong> Additional configuration actions will be
-taken the first time that system is built. These additional steps
+</div>
+<div class="section" id="first-time-make">
+<h2>First Time Make<a class="headerlink" href="#first-time-make" title="Permalink to this headline">¶</a></h2>
+<p>Additional configuration actions will be taken the first time that system is built. These additional steps
include:</p>
<ul class="simple">
<li><p>Auto-generating the file <code class="docutils literal notranslate"><span class="pre">include/nuttx/config.h</span></code> using the
diff --git a/content/docs/latest/quickstart/index.html b/content/docs/latest/quickstart/compiling.html
similarity index 59%
copy from content/docs/latest/quickstart/index.html
copy to content/docs/latest/quickstart/compiling.html
index 4b4c123..ee8a562 100644
--- a/content/docs/latest/quickstart/index.html
+++ b/content/docs/latest/quickstart/compiling.html
@@ -26,7 +26,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Quickstart — NuttX latest documentation</title>
+ <title>Compiling — NuttX latest documentation</title>
@@ -58,8 +58,8 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
- <link rel="next" title="Directory Structure" href="organization.html" />
- <link rel="prev" title="The Inviolable Principles of NuttX" href="../introduction/inviolables.html" />
+ <link rel="next" title="Running" href="running.html" />
+ <link rel="prev" title="Installing" href="install.html" />
</head>
<body class="wy-body-for-nav">
@@ -116,9 +116,15 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Quickstart</a><ul>
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Getting Started</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html">Installing</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Compiling</a></li>
+<li class="toctree-l2"><a class="reference internal" href="running.html">Running</a></li>
+<li class="toctree-l2"><a class="reference internal" href="configuring.html">Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="debugging.html">Debugging</a></li>
<li class="toctree-l2"><a class="reference internal" href="organization.html">Directory Structure</a></li>
-<li class="toctree-l2"><a class="reference internal" href="config_build.html">Configuring and Building</a></li>
+<li class="toctree-l2"><a class="reference internal" href="build_and_make.html">Build and Make Details</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
@@ -175,13 +181,15 @@
<li><a href="../index.html" class="icon icon-home"></a> »</li>
- <li>Quickstart</li>
+ <li><a href="index.html">Getting Started</a> »</li>
+
+ <li>Compiling</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/quickstart/index.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/quickstart/compiling.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -194,20 +202,59 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
- <div class="admonition-todo admonition" id="id1">
-<p class="admonition-title">Todo</p>
-<p>This should be a brief introduction to how NuttX works and how to get it running. A widely used board could be targeted to create a brief demonstration on how to clone, configure, build, flash and run NuttX.
-For now, the content that is here presented is what remains of the old Porting Guide which is not already in another section of this documentation.</p>
+ <div class="section" id="compiling">
+<span id="id1"></span><h1>Compiling<a class="headerlink" href="#compiling" title="Permalink to this headline">¶</a></h1>
+<p>Now that we’ve installed Apache NuttX prerequisites and downloaded the source code, we are ready to compile the source code
+into an executable binary file that can be run on the embedded board.</p>
+<ol class="arabic">
+<li><p>List Possible Apache NuttX Base Configurations</p>
+<p>Find your hardware and a good starting application in the list of base configurations. In the application list,
+<code class="docutils literal notranslate"><span class="pre">nsh</span></code> is the Apache NuttX Shell, an interactive commandline that’s a good starting place if you’re new.</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ <span class="nb">cd</span> nuttx
+$ ./tools/configure.sh -L <span class="p">|</span> less
+</pre></div>
</div>
-<div class="section" id="quickstart">
-<h1>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this headline">¶</a></h1>
-<p>The present Quickstart guide is a work in progress and only contains some basic information. In the meantime you can look at NuttX main <a class="reference external" href="https://github.com/apache/incubator-nuttx/blob/master/README.md">README</a> file which contains some information that will help you get started.</p>
-<div class="toctree-wrapper compound">
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="organization.html">Directory Structure</a></li>
-<li class="toctree-l1"><a class="reference internal" href="config_build.html">Configuring and Building</a></li>
-</ul>
+</div></blockquote>
+</li>
+<li><p>Initialize Configuration</p>
+<p>Pick one of the board:application base configuration pairs from the list, and feed it to the
+configuration script. The <code class="docutils literal notranslate"><span class="pre">-l</span></code> tells use that we’re on Linux. macOS and Windows builds are
+possible, this guide doesn’t cover them yet.</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ <span class="nb">cd</span> nuttx
+$ <span class="c1"># this is the basic layout of the command:</span>
+$ <span class="c1"># ./tools/configure.sh -l <board-name>:<config-dir></span>
+$ <span class="c1"># for example:</span>
+$ ./tools/configure.sh -l sama5d2-xult:nsh
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Customize Your Configuration (Optional)</p>
+<p>This step is optional. Right now, this is mainly to get familiar with how it works– you don’t need to change
+any of the options now, but knowing how to do this will come in handy later.</p>
+<p>There are a lot of options. We’ll cover a few of them here. Don’t worry about the complexity– you don’t have to use most of the options.</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make menuconfig
+</pre></div>
</div>
+</div></blockquote>
+</li>
+<li><p>Compile NuttX</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make clean<span class="p">;</span> make
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Install the Executable Program on Your Board</p>
+<p>This step is a bit more complicated, depending on your board. It’s covered in the section
+<a class="reference internal" href="running.html#running"><span class="std std-ref">Running Apache NuttX</span></a>.</p>
+</li>
+</ol>
+<hr class="docutils" />
+<p>Next up is <a class="reference internal" href="running.html#running"><span class="std std-ref">Running</span></a>.</p>
</div>
diff --git a/content/docs/latest/quickstart/configuring.html b/content/docs/latest/quickstart/configuring.html
new file mode 100644
index 0000000..62c447c
--- /dev/null
+++ b/content/docs/latest/quickstart/configuring.html
@@ -0,0 +1,348 @@
+<!--
+ Documentation/_templates/layout.html
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership. The
+ ASF licenses this file to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance with the
+ License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+-->
+
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Configuring — NuttX latest documentation</title>
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+
+ <link rel="shortcut icon" href="../_static/favicon.ico"/>
+
+
+
+
+
+ <!--[if lt IE 9]>
+ <script src="../_static/js/html5shiv.min.js"></script>
+ <![endif]-->
+
+
+ <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+ <script src="../_static/jquery.js"></script>
+ <script src="../_static/underscore.js"></script>
+ <script src="../_static/doctools.js"></script>
+ <script src="../_static/language_data.js"></script>
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <link rel="next" title="Debugging" href="debugging.html" />
+ <link rel="prev" title="Running" href="running.html" />
+</head>
+
+<body class="wy-body-for-nav">
+
+
+ <div class="wy-grid-for-nav">
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-scroll">
+ <div class="wy-side-nav-search" >
+
+
+ <a href="../index.html" class="icon icon-home"> NuttX
+
+
+
+
+ <img src="../_static/NuttX.png" class="logo" alt="Logo"/>
+
+ </a>
+
+ <!-- this version selector is quite ugly, should be probably replaced by something
+ more modern -->
+
+ <div class="version-selector">
+ <select>
+
+ <option value="latest" selected="selected">latest</option>
+
+ </select>
+ </div>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+ </div>
+
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+ <p class="caption"><span class="caption-text">Table of Contents</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Getting Started</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html">Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="compiling.html">Compiling</a></li>
+<li class="toctree-l2"><a class="reference internal" href="running.html">Running</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="debugging.html">Debugging</a></li>
+<li class="toctree-l2"><a class="reference internal" href="organization.html">Directory Structure</a></li>
+<li class="toctree-l2"><a class="reference internal" href="build_and_make.html">Build and Make Details</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">API Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../guides/index.html">Guides</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../releases/index.html">Releases</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </div>
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" aria-label="top navigation">
+
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">NuttX</a>
+
+ </nav>
+
+
+ <div class="wy-nav-content">
+
+ <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+ <ul class="wy-breadcrumbs">
+
+ <li><a href="../index.html" class="icon icon-home"></a> »</li>
+
+ <li><a href="index.html">Getting Started</a> »</li>
+
+ <li>Configuring</li>
+
+
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../_sources/quickstart/configuring.rst.txt" rel="nofollow"> View page source</a>
+
+
+ </li>
+
+ </ul>
+
+
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="configuring">
+<span id="id1"></span><h1>Configuring<a class="headerlink" href="#configuring" title="Permalink to this headline">¶</a></h1>
+<p>Apache NuttX is a very configurable operating system. Nearly all features can be configured in or
+out of the system. This makes it possible to compile a build tailored for your hardware and
+application. It also makes configuring the system complex at times.</p>
+<p>There is a configuration system that can be used on the commandline or in a GUI. I’ve found
+the easiest way to configured Apache NuttX is to use the <code class="docutils literal notranslate"><span class="pre">menuconfig</span></code> system. This is used
+via a terminal program and allows quick access to all of Apache NuttX’s features via a system of
+menus.</p>
+<p>The Apache NuttX configuration system uses Linux’s
+<a class="reference external" href="https://www.kernel.org/doc/Documentation/kbuild/kconfig-language.txt">kconfig system</a> adapted for use with Apache
+NuttX. Here’s info on Linux’s kconfig <a class="reference external" href="https://en.wikipedia.org/wiki/Menuconfig">menuconfig</a> system.</p>
+<p>After you’ve configured your board (see <a class="reference internal" href="compiling.html#compiling"><span class="std std-ref">Compiling</span></a>), you can use the menuconfig system
+to change the configuration. Once you’ve configured, you can compile to make a build that
+has your configuration options selected.</p>
+<ol class="arabic">
+<li><p>Initialize Board Configuration</p>
+<p>Here we’ll use the simulator since that’s the simplest to explain. You can do this with
+any board and base configuration. Note here you should be supplying <cite>configure.sh</cite> the correct flag
+for your build environment:</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>-l selects the Linux <span class="o">(</span>l<span class="o">)</span> host environment.
+-m selects the macOS <span class="o">(</span>m<span class="o">)</span> host environment.
+-c selects the Windows host and Cygwin <span class="o">(</span>c<span class="o">)</span> environment.
+-u selects the Windows host and Ubuntu under Windows <span class="m">10</span> <span class="o">(</span>u<span class="o">)</span> environment.
+-g selects the Windows host and MinGW/MSYS environment.
+-n selects the Windows host and Windows native <span class="o">(</span>n<span class="o">)</span> environment.
+</pre></div>
+</div>
+</div></blockquote>
+<p>Select the simulator configuration for a Linux host:</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ <span class="nb">cd</span> nuttx
+$ make distclean <span class="c1"># make a clean start, clearing out old configurations</span>
+$ ./tools/configure.sh -l sim:nsh
+ Copy files
+ Select <span class="nv">CONFIG_HOST_LINUX</span><span class="o">=</span>y
+ Refreshing...
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Make</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make clean<span class="p">;</span> make
+$ ./nuttx
+login:
+</pre></div>
+</div>
+</div></blockquote>
+<p>From another terminal window, kill the simulator:</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ pkill nuttx
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Menu Configuration</p>
+<p>Showing that <code class="docutils literal notranslate"><span class="pre">login:</span></code> is annyoing. Let’s use the <code class="docutils literal notranslate"><span class="pre">menuconfig</span></code> system to turn it off.</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make menuconfig
+</pre></div>
+</div>
+</div></blockquote>
+<p>Here’s what you should see:</p>
+<a class="reference internal image-reference" href="quickstart/../images/menuconfig.png"><img alt="Screenshot of menuconfig system main screen" class="align-center" src="quickstart/../images/menuconfig.png" style="width: 800px;" /></a>
+<p><br/></p>
+</li>
+<li><p>Application Configuration</p>
+<p>The NSH Login setting is under <code class="docutils literal notranslate"><span class="pre">Application</span> <span class="pre">Configuration</span> <span class="pre">></span> <span class="pre">NSH</span> <span class="pre">Library</span></code>. Use
+the up and down arrows to navigate to <code class="docutils literal notranslate"><span class="pre">Application</span> <span class="pre">Configuration</span></code>; hit <code class="docutils literal notranslate"><span class="pre"><return></span></code> to
+select it. Now you’re in the <code class="docutils literal notranslate"><span class="pre">Application</span> <span class="pre">Configuration</span></code> menu. Use the arrows to go
+down to <code class="docutils literal notranslate"><span class="pre">NSH</span> <span class="pre">Library</span></code> and select that. Now navigate down to <code class="docutils literal notranslate"><span class="pre">Console</span> <span class="pre">Login</span></code> and use
+the spacebar to uncheck that setting (so that it has a blank space instead of a star in it).</p>
+<p>Now let’s save. Use the right and left arrow keys to select the <code class="docutils literal notranslate"><span class="pre">Exit</span></code> menu item at the
+bottom of the screen. Hit <code class="docutils literal notranslate"><span class="pre"><return></span></code> to select it, hit <code class="docutils literal notranslate"><span class="pre"><return></span></code> again, and again, finally
+hitting <code class="docutils literal notranslate"><span class="pre"><return></span></code> in the <code class="docutils literal notranslate"><span class="pre">Save</span> <span class="pre">Configuration</span></code> dialog box.
+<br/>
+<br/></p>
+</li>
+<li><p>Make the New Configuration</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make clean<span class="p">;</span> make
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Run</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ ./nuttx
+NuttShell <span class="o">(</span>NSH<span class="o">)</span> NuttX-8.2
+MOTD: <span class="nv">username</span><span class="o">=</span>admin <span class="nv">password</span><span class="o">=</span>Administrator
+</pre></div>
+</div>
+</div></blockquote>
+<p>Success!</p>
+<p>If you find that message of the day (MOTD) annoying and want to turn that off, it’s
+configured in <code class="docutils literal notranslate"><span class="pre">Application</span> <span class="pre">Configuration</span> <span class="pre">></span> <span class="pre">NSH</span> <span class="pre">Library</span> <span class="pre">>></span> <span class="pre">Message</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">Day</span> <span class="pre">(MOTD)</span></code>.</p>
+</li>
+</ol>
+<hr class="docutils" />
+<p>Next up is <a class="reference internal" href="debugging.html#debugging"><span class="std std-ref">Debugging</span></a>.</p>
+</div>
+
+
+ </div>
+
+ </div>
+ <footer>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+
+ © Copyright 2020, The Apache Software Foundation
+
+ </p>
+ </div>
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.Navigation.enable(true);
+ });
+ </script>
+
+
+
+
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/content/docs/latest/quickstart/debugging.html b/content/docs/latest/quickstart/debugging.html
new file mode 100644
index 0000000..2c3cb7c
--- /dev/null
+++ b/content/docs/latest/quickstart/debugging.html
@@ -0,0 +1,363 @@
+<!--
+ Documentation/_templates/layout.html
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership. The
+ ASF licenses this file to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance with the
+ License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+-->
+
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Debugging — NuttX latest documentation</title>
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+
+ <link rel="shortcut icon" href="../_static/favicon.ico"/>
+
+
+
+
+
+ <!--[if lt IE 9]>
+ <script src="../_static/js/html5shiv.min.js"></script>
+ <![endif]-->
+
+
+ <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+ <script src="../_static/jquery.js"></script>
+ <script src="../_static/underscore.js"></script>
+ <script src="../_static/doctools.js"></script>
+ <script src="../_static/language_data.js"></script>
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <link rel="next" title="Directory Structure" href="organization.html" />
+ <link rel="prev" title="Configuring" href="configuring.html" />
+</head>
+
+<body class="wy-body-for-nav">
+
+
+ <div class="wy-grid-for-nav">
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-scroll">
+ <div class="wy-side-nav-search" >
+
+
+ <a href="../index.html" class="icon icon-home"> NuttX
+
+
+
+
+ <img src="../_static/NuttX.png" class="logo" alt="Logo"/>
+
+ </a>
+
+ <!-- this version selector is quite ugly, should be probably replaced by something
+ more modern -->
+
+ <div class="version-selector">
+ <select>
+
+ <option value="latest" selected="selected">latest</option>
+
+ </select>
+ </div>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+ </div>
+
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+ <p class="caption"><span class="caption-text">Table of Contents</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Getting Started</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html">Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="compiling.html">Compiling</a></li>
+<li class="toctree-l2"><a class="reference internal" href="running.html">Running</a></li>
+<li class="toctree-l2"><a class="reference internal" href="configuring.html">Configuring</a></li>
+<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="#custom-debug-logging">Custom Debug Logging</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#jtag-debugging">JTAG Debugging</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="organization.html">Directory Structure</a></li>
+<li class="toctree-l2"><a class="reference internal" href="build_and_make.html">Build and Make Details</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">API Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../guides/index.html">Guides</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../releases/index.html">Releases</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </div>
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" aria-label="top navigation">
+
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">NuttX</a>
+
+ </nav>
+
+
+ <div class="wy-nav-content">
+
+ <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+ <ul class="wy-breadcrumbs">
+
+ <li><a href="../index.html" class="icon icon-home"></a> »</li>
+
+ <li><a href="index.html">Getting Started</a> »</li>
+
+ <li>Debugging</li>
+
+
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../_sources/quickstart/debugging.rst.txt" rel="nofollow"> View page source</a>
+
+
+ </li>
+
+ </ul>
+
+
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="debugging">
+<span id="id1"></span><h1>Debugging<a class="headerlink" href="#debugging" title="Permalink to this headline">¶</a></h1>
+<p>Finding and fixing bugs is an important part of the hardware and software development process. Sometimes you also need
+to use debugging techniques to understand how the system works. Two tools that are helpful are debug logging and
+debugging using the Gnu Debugger (gdb).</p>
+<div class="section" id="debug-logging">
+<h2>Debug Logging<a class="headerlink" href="#debug-logging" title="Permalink to this headline">¶</a></h2>
+<p>NuttX has a powerful logging facility with <code class="docutils literal notranslate"><span class="pre">info</span></code>, <code class="docutils literal notranslate"><span class="pre">warn</span></code>, and <code class="docutils literal notranslate"><span class="pre">error</span></code> levels. You can enable debugging for your
+build for the <code class="docutils literal notranslate"><span class="pre">net</span></code> feature (TCP/IP stack) by putting the following lines in your <code class="docutils literal notranslate"><span class="pre">.config</span></code> file:</p>
+<blockquote>
+<div><div class="highlight-none notranslate"><div class="highlight"><pre><span></span>CONFIG_DEBUG_ALERT=y
+CONFIG_DEBUG_FEATURES=y
+CONFIG_DEBUG_ERROR=y
+CONFIG_DEBUG_WARN=y
+CONFIG_DEBUG_INFO=y
+CONFIG_DEBUG_ASSERTIONS=y
+CONFIG_DEBUG_NET=y
+CONFIG_DEBUG_NET_ERROR=y
+CONFIG_DEBUG_NET_WARN=y
+CONFIG_DEBUG_NET_INFO=y
+CONFIG_DEBUG_SYMBOLS=y
+CONFIG_DEBUG_NOOPT=y
+CONFIG_SYSLOG_TIMESTAMP=y
+</pre></div>
+</div>
+</div></blockquote>
+<p>Note that turning all these to <code class="docutils literal notranslate"><span class="pre">y</span></code> will produce an incredible amount of logging output. Set the level you want and
+the area you’re interested in to <code class="docutils literal notranslate"><span class="pre">y</span></code>, and the rest to <code class="docutils literal notranslate"><span class="pre">n</span></code>, and then recompile. You can see the full list of
+debug feature areas in the file <a class="reference external" href="https://github.com/apache/incubator-nuttx/blob/master/include/debug.h">debug.h</a>.</p>
+<p>Timestamps can be enabled by setting <code class="docutils literal notranslate"><span class="pre">CONFIG_SYSLOG_TIMESTAMP=y</span></code>.</p>
+<p>You may need to do a little bit of experimenting to find the combination of logging settings that work for the problem
+you’re trying to solve. See the file <a class="reference external" href="https://github.com/starcat-io/incubator-nuttx/blob/master/include/debug.h">debug.h</a>
+for available debug settings that are available. This can also be configured via the <code class="docutils literal notranslate"><span class="pre">menuconfig</span></code> system.</p>
+<p>There are also subsystems that enable USB trace debugging, and you can log to memory too, if you need the logging to be
+faster than what the console can output.</p>
+</div>
+<div class="section" id="changing-debug-settings-quickly">
+<h2>Changing Debug Settings Quickly<a class="headerlink" href="#changing-debug-settings-quickly" title="Permalink to this headline">¶</a></h2>
+<p>You can use the <code class="docutils literal notranslate"><span class="pre">kconfig-tweak</span></code> script that comes with the <code class="docutils literal notranslate"><span class="pre">kconfig-frontends</span></code> tools to quickly change debug settings,
+for instance turning them on or off before doing a build:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ kconfig-tweak --disable CONFIG_DEBUG_NET
+$ kconfig-tweak --enable CONFIG_DEBUG_NET
+</pre></div>
+</div>
+<p>You can put a bunch of these into a simple script to configure the logging the way you want:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/bin/bash</span>
+
+$ kconfig-tweak --disable CONFIG_DEBUG_ALERT
+$ kconfig-tweak --disable CONFIG_DEBUG_FEATURES
+$ kconfig-tweak --disable CONFIG_DEBUG_ERROR
+$ kconfig-tweak --disable CONFIG_DEBUG_WARN
+$ kconfig-tweak --disable CONFIG_DEBUG_INFO
+$ kconfig-tweak --disable CONFIG_DEBUG_ASSERTIONS
+$ kconfig-tweak --disable CONFIG_DEBUG_NET
+$ kconfig-tweak --disable CONFIG_DEBUG_NET_ERROR
+$ kconfig-tweak --disable CONFIG_DEBUG_NET_WARN
+$ kconfig-tweak --disable CONFIG_DEBUG_NET_INFO
+$ kconfig-tweak --disable CONFIG_DEBUG_SYMBOLS
+$ kconfig-tweak --disable CONFIG_DEBUG_NOOPT
+$ kconfig-tweak --disable CONFIG_SYSLOG_TIMESTAMP
+</pre></div>
+</div>
+</div>
+<div class="section" id="custom-debug-logging">
+<h2>Custom Debug Logging<a class="headerlink" href="#custom-debug-logging" title="Permalink to this headline">¶</a></h2>
+<p>Sometimes you need to see debug logs specific to your feature, and you don’t want the rest of the built-in logs
+because they’re either not relevant or have too much information. Debugging using logs is surprisingly powerful.</p>
+<p>You can add your own custom debug logging by adding the following lines to
+<a class="reference external" href="https://github.com/apache/incubator-nuttx/blob/master/include/debug.h">debug.h</a>:</p>
+<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cm">/* after the CONFIG_DEBUG_WATCHDOG_INFO block near line 721 */</span>
+<span class="cp">#ifdef CONFIG_DEBUG_CUSTOM_INFO</span>
+<span class="cp"># define custinfo _info</span>
+<span class="cp">#else</span>
+<span class="cp"># define custinfo _none</span>
+<span class="cp">#endif</span>
+</pre></div>
+</div>
+<p>You need to add the following line to your <code class="docutils literal notranslate"><span class="pre">.config</span></code> file:</p>
+<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="n">CONFIG_DEBUG_CUSTOM_INFO</span><span class="o">=</span><span class="n">y</span>
+</pre></div>
+</div>
+<p>You would use it like this:</p>
+<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cm">/* Custom debug logging */</span>
+<span class="n">custinfo</span><span class="p">(</span><span class="s">"This is a custom log message."</span><span class="p">);</span>
+<span class="n">custinfo</span><span class="p">(</span><span class="s">"Custom log data: %d"</span><span class="p">,</span> <span class="n">my</span><span class="o">-</span><span class="n">integer</span><span class="o">-</span><span class="n">variable</span><span class="p">);</span>
+</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>
+<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>
+<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>
+<p>See this article for more info:
+<a class="reference external" href="https://micro-ros.github.io/docs/tutorials/advanced/debugging_gdb_openocd/">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>
+<hr class="docutils" />
+<p>Next up is <a class="reference internal" href="organization.html#organization"><span class="std std-ref">Directory Structure</span></a>.</p>
+</div>
+</div>
+
+
+ </div>
+
+ </div>
+ <footer>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+
+ © Copyright 2020, The Apache Software Foundation
+
+ </p>
+ </div>
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.Navigation.enable(true);
+ });
+ </script>
+
+
+
+
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/content/docs/latest/quickstart/index.html b/content/docs/latest/quickstart/index.html
index 4b4c123..126da4f 100644
--- a/content/docs/latest/quickstart/index.html
+++ b/content/docs/latest/quickstart/index.html
@@ -26,7 +26,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Quickstart — NuttX latest documentation</title>
+ <title>Getting Started — NuttX latest documentation</title>
@@ -58,7 +58,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
- <link rel="next" title="Directory Structure" href="organization.html" />
+ <link rel="next" title="Quickstart" href="quickstart.html" />
<link rel="prev" title="The Inviolable Principles of NuttX" href="../introduction/inviolables.html" />
</head>
@@ -116,9 +116,15 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Quickstart</a><ul>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Getting Started</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html">Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="compiling.html">Compiling</a></li>
+<li class="toctree-l2"><a class="reference internal" href="running.html">Running</a></li>
+<li class="toctree-l2"><a class="reference internal" href="configuring.html">Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="debugging.html">Debugging</a></li>
<li class="toctree-l2"><a class="reference internal" href="organization.html">Directory Structure</a></li>
-<li class="toctree-l2"><a class="reference internal" href="config_build.html">Configuring and Building</a></li>
+<li class="toctree-l2"><a class="reference internal" href="build_and_make.html">Build and Make Details</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
@@ -175,7 +181,7 @@
<li><a href="../index.html" class="icon icon-home"></a> »</li>
- <li>Quickstart</li>
+ <li>Getting Started</li>
<li class="wy-breadcrumbs-aside">
@@ -194,18 +200,26 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
- <div class="admonition-todo admonition" id="id1">
-<p class="admonition-title">Todo</p>
-<p>This should be a brief introduction to how NuttX works and how to get it running. A widely used board could be targeted to create a brief demonstration on how to clone, configure, build, flash and run NuttX.
-For now, the content that is here presented is what remains of the old Porting Guide which is not already in another section of this documentation.</p>
-</div>
-<div class="section" id="quickstart">
-<h1>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this headline">¶</a></h1>
-<p>The present Quickstart guide is a work in progress and only contains some basic information. In the meantime you can look at NuttX main <a class="reference external" href="https://github.com/apache/incubator-nuttx/blob/master/README.md">README</a> file which contains some information that will help you get started.</p>
+ <div class="section" id="getting-started">
+<h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h1>
+<p>This section describes how to get started with NuttX. <a class="reference internal" href="quickstart.html#quickstart"><span class="std std-ref">Quickstart</span></a> is for
+experienced embedded developers, and quickly outlines the basic of getting NuttX configured and
+compiled. Use this if you are experienced with FreeRTOS, Zephyr, or a similar RTOS.</p>
+<p>The remaining sections are detailed instructions aimed at beginners for getting the necessary
+compilers and other tools installed, then compiling NuttX and running on your hardware. There are sections
+on configuring NuttX with more features than just the minimum, and a section on debugging. For reference
+there is also a description of the code organization and some details about what happens when running <code class="docutils literal notranslate"><span class="pre">make</span></code>
+to build NuttX.</p>
<div class="toctree-wrapper compound">
<ul>
+<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="install.html">Installing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling</a></li>
+<li class="toctree-l1"><a class="reference internal" href="running.html">Running</a></li>
+<li class="toctree-l1"><a class="reference internal" href="configuring.html">Configuring</a></li>
+<li class="toctree-l1"><a class="reference internal" href="debugging.html">Debugging</a></li>
<li class="toctree-l1"><a class="reference internal" href="organization.html">Directory Structure</a></li>
-<li class="toctree-l1"><a class="reference internal" href="config_build.html">Configuring and Building</a></li>
+<li class="toctree-l1"><a class="reference internal" href="build_and_make.html">Build and Make Details</a></li>
</ul>
</div>
</div>
diff --git a/content/docs/latest/quickstart/install.html b/content/docs/latest/quickstart/install.html
new file mode 100644
index 0000000..0ce9d80
--- /dev/null
+++ b/content/docs/latest/quickstart/install.html
@@ -0,0 +1,451 @@
+<!--
+ Documentation/_templates/layout.html
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership. The
+ ASF licenses this file to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance with the
+ License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+-->
+
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Installing — NuttX latest documentation</title>
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+
+ <link rel="shortcut icon" href="../_static/favicon.ico"/>
+
+
+
+
+
+ <!--[if lt IE 9]>
+ <script src="../_static/js/html5shiv.min.js"></script>
+ <![endif]-->
+
+
+ <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+ <script src="../_static/jquery.js"></script>
+ <script src="../_static/underscore.js"></script>
+ <script src="../_static/doctools.js"></script>
+ <script src="../_static/language_data.js"></script>
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <link rel="next" title="Compiling" href="compiling.html" />
+ <link rel="prev" title="Quickstart" href="quickstart.html" />
+</head>
+
+<body class="wy-body-for-nav">
+
+
+ <div class="wy-grid-for-nav">
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-scroll">
+ <div class="wy-side-nav-search" >
+
+
+ <a href="../index.html" class="icon icon-home"> NuttX
+
+
+
+
+ <img src="../_static/NuttX.png" class="logo" alt="Logo"/>
+
+ </a>
+
+ <!-- this version selector is quite ugly, should be probably replaced by something
+ more modern -->
+
+ <div class="version-selector">
+ <select>
+
+ <option value="latest" selected="selected">latest</option>
+
+ </select>
+ </div>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+ </div>
+
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+ <p class="caption"><span class="caption-text">Table of Contents</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Getting Started</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Installing</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#prerequisites">Prerequisites</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#install-prerequisites-for-building-using-linux">Install prerequisites for building using Linux</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#install-prerequisites-for-building-and-using-apache-nuttx-macos">Install prerequisites for building and using Apache NuttX (macOS)</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#install-prerequisites-for-building-and-using-apache-nuttx-windows-wsl">Install prerequisites for building and using Apache NuttX (Windows – WSL)</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#install-prerequisites-for-building-and-using-apache-nuttx-windows-cygwin">Install prerequisites for building and using Apache NuttX (Windows – Cygwin)</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#install-required-tools-all-platforms">Install Required Tools (All Platforms)</a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="#get-source-code-stable">Get Source Code (Stable)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#get-source-code-development">Get Source Code (Development)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#install-a-cross-compiler-toolchain">Install a Cross-Compiler Toolchain</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="compiling.html">Compiling</a></li>
+<li class="toctree-l2"><a class="reference internal" href="running.html">Running</a></li>
+<li class="toctree-l2"><a class="reference internal" href="configuring.html">Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="debugging.html">Debugging</a></li>
+<li class="toctree-l2"><a class="reference internal" href="organization.html">Directory Structure</a></li>
+<li class="toctree-l2"><a class="reference internal" href="build_and_make.html">Build and Make Details</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">API Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../guides/index.html">Guides</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../releases/index.html">Releases</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </div>
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" aria-label="top navigation">
+
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">NuttX</a>
+
+ </nav>
+
+
+ <div class="wy-nav-content">
+
+ <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+ <ul class="wy-breadcrumbs">
+
+ <li><a href="../index.html" class="icon icon-home"></a> »</li>
+
+ <li><a href="index.html">Getting Started</a> »</li>
+
+ <li>Installing</li>
+
+
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../_sources/quickstart/install.rst.txt" rel="nofollow"> View page source</a>
+
+
+ </li>
+
+ </ul>
+
+
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="installing">
+<span id="install"></span><h1>Installing<a class="headerlink" href="#installing" title="Permalink to this headline">¶</a></h1>
+<p>To start developing on Apache NuttX, we need to get the source code, configure it, compile it, and get it uploaded onto an
+embedded computing board. These instructions are for <a class="reference external" href="https://ubuntu.com/">Ubuntu</a> Linux and macOS Catalina. If you’re using a different
+version, you may need to change some of the commands.</p>
+<div class="section" id="prerequisites">
+<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="install-prerequisites-for-building-using-linux">
+<h3>Install prerequisites for building using Linux<a class="headerlink" href="#install-prerequisites-for-building-using-linux" title="Permalink to this headline">¶</a></h3>
+<ol class="arabic simple">
+<li><p>Install system packages</p></li>
+</ol>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ sudo apt install <span class="se">\</span>
+ bison flex gettext texinfo libncurses5-dev libncursesw5-dev <span class="se">\</span>
+ gperf automake libtool pkg-config build-essential gperf <span class="se">\</span>
+ libgmp-dev libmpc-dev libmpfr-dev libisl-dev binutils-dev libelf-dev <span class="se">\</span>
+ libexpat-dev gcc-multilib g++-multilib picocom u-boot-tools util-linux
+</pre></div>
+</div>
+</div></blockquote>
+<ol class="arabic">
+<li><p>Give yourself access to the serial console device</p>
+<p>This is done by adding your Linux user to the <code class="docutils literal notranslate"><span class="pre">dialout</span></code> group:</p>
+</li>
+</ol>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ sudo usermod -a -G dialout <span class="nv">$USER</span>
+$ <span class="c1"># now get a login shell that knows we're in the dialout group:</span>
+$ su - <span class="nv">$USER</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+<div class="section" id="install-prerequisites-for-building-and-using-apache-nuttx-macos">
+<h3>Install prerequisites for building and using Apache NuttX (macOS)<a class="headerlink" href="#install-prerequisites-for-building-and-using-apache-nuttx-macos" title="Permalink to this headline">¶</a></h3>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ brew tap discoteq/discoteq
+$ brew install flock
+$ brew install x86_64-elf-gcc <span class="c1"># Used by simulator</span>
+$ brew install u-boot-tools <span class="c1"># Some platform integrate with u-boot</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+<div class="section" id="install-prerequisites-for-building-and-using-apache-nuttx-windows-wsl">
+<h3>Install prerequisites for building and using Apache NuttX (Windows – WSL)<a class="headerlink" href="#install-prerequisites-for-building-and-using-apache-nuttx-windows-wsl" title="Permalink to this headline">¶</a></h3>
+<p>If you are are building Apache NuttX on windows and using WSL follow
+that installation guide for Linux. This has been verified against the
+Ubunutu 18.04 version.</p>
+<p>There may be complications interacting with
+programming tools over USB. Recently support for USBIP was added to WSL 2
+which has been used with the STM32 platform, but it is not trivial to configure:
+<a class="reference external" href="https://github.com/rpasek/usbip-wsl2-instructions">https://github.com/rpasek/usbip-wsl2-instructions</a></p>
+</div>
+<div class="section" id="install-prerequisites-for-building-and-using-apache-nuttx-windows-cygwin">
+<h3>Install prerequisites for building and using Apache NuttX (Windows – Cygwin)<a class="headerlink" href="#install-prerequisites-for-building-and-using-apache-nuttx-windows-cygwin" title="Permalink to this headline">¶</a></h3>
+<p>Download and install <a class="reference external" href="https://www.cygwin.com/">Cygwin</a> using the minimal
+installation in addition to these packages:</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>make bison libmpc-devel
+gcc-core byacc automake-1.15
+gcc-g++ gperf libncurses-devel
+flex gdb libmpfr-devel
+git unzip zlib-devel
+</pre></div>
+</div>
+</div>
+<div class="section" id="install-required-tools-all-platforms">
+<h3>Install Required Tools (All Platforms)<a class="headerlink" href="#install-required-tools-all-platforms" title="Permalink to this headline">¶</a></h3>
+<p>There are a collection of required tools that need to be built to build most Apache NuttX configurations:</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ mkdir buildtools
+$ <span class="nb">export</span> <span class="nv">NUTTXTOOLS</span><span class="o">=</span><span class="sb">`</span><span class="nb">pwd</span><span class="sb">`</span>/buildtools
+$ <span class="nb">export</span> <span class="nv">NUTTXTOOLS_PATH</span><span class="o">=</span><span class="nv">$NUTTXTOOLS</span>/bin:<span class="nv">$NUTTXTOOLS</span>/usr/bin
+$ git clone https://bitbucket.org/nuttx/tools.git tools
+</pre></div>
+</div>
+</div></blockquote>
+<p><em>NOTE:</em> You will need to add <code class="docutils literal notranslate"><span class="pre">NUTTXTOOLS_PATH</span></code> to your environment <code class="docutils literal notranslate"><span class="pre">PATH</span></code></p>
+<ol class="arabic simple">
+<li><p>Install kconfig-frontends tool</p></li>
+</ol>
+<p>This is necessary to run the <code class="docutils literal notranslate"><span class="pre">./nuttx/tools/configure.sh</span></code> script as well as using the ncurses-based menuconfig system.</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ <span class="nb">cd</span> tools/
+$ <span class="nb">cd</span> kconfig-frontends
+$ <span class="c1"># on MacOS do the following:</span>
+$ patch < ../kconfig-macos.diff -p <span class="m">1</span>
+$ ./configure --prefix<span class="o">=</span><span class="nv">$NUTTXTOOLS</span> --enable-mconf --disable-shared --enable-static --disable-gconf --disable-qconf --disable-nconf
+$ <span class="c1"># on Linux do the following:</span>
+$ ./configure --prefix<span class="o">=</span><span class="nv">$NUTTXTOOLS</span> --enable-mconf --disable-gconf --disable-qconf
+$ touch aclocal.m4 Makefile.in
+$ make
+$ make install
+</pre></div>
+</div>
+</div></blockquote>
+<ol class="arabic">
+<li><p>Install gperf tool</p>
+<p>This required to build <code class="docutils literal notranslate"><span class="pre">kconfig-frontends</span></code>.</p>
+</li>
+</ol>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ <span class="nb">cd</span> tools/
+$ wget http://ftp.gnu.org/pub/gnu/gperf/gperf-3.1.tar.gz
+$ tar zxf gperf-3.1.tar.gz
+$ <span class="nb">cd</span> gperf-3.1
+$ ./configure --prefix<span class="o">=</span><span class="nv">$NUTTXTOOLS</span>
+$ make
+$ make install
+</pre></div>
+</div>
+</div></blockquote>
+<ol class="arabic">
+<li><p>Install gen-romfs (optional)</p>
+<p>This is required if you want to build ROM-based file systems.</p>
+</li>
+</ol>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ <span class="nb">cd</span> tools/
+$ tar zxf genromfs-0.5.2.tar.gz
+$ <span class="nb">cd</span> genromfs-0.5.2
+$ make install <span class="nv">PREFIX</span><span class="o">=</span><span class="nv">$NUTTXTOOLS</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+</div>
+<div class="section" id="get-source-code-stable">
+<h2>Get Source Code (Stable)<a class="headerlink" href="#get-source-code-stable" title="Permalink to this headline">¶</a></h2>
+<p>Apache NuttX releases are published on the project <a class="reference external" href="https://nuttx.apache.org/download/">Downloads</a> page and distributed
+by the Apache mirrors. Be sure to download both the nuttx and apps tarballs.</p>
+</div>
+<div class="section" id="get-source-code-development">
+<h2>Get Source Code (Development)<a class="headerlink" href="#get-source-code-development" title="Permalink to this headline">¶</a></h2>
+<p>Apache NuttX is <a class="reference external" href="https://github.com/apache/incubator-nuttx/">actively developed on GitHub</a>. If you want
+to use it, modify it or help develop it, you’ll need the source code.</p>
+<p>You can either clone the public repositories:</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ mkdir nuttx
+$ <span class="nb">cd</span> nuttx
+$ git clone https://github.com/apache/incubator-nuttx.git nuttx
+$ git clone https://github.com/apache/incubator-nuttx-apps apps
+</pre></div>
+</div>
+</div></blockquote>
+<p>Or, download the <a class="reference external" href="https://github.com/apache/incubator-nuttx/tarball/master">tarball</a>:</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ curl -OL https://github.com/apache/incubator-nuttx/tarball/master
+$ curl -OL https://github.com/apache/incubator-nuttx-apps/tarball/master
+<span class="c1"># optionally, zipball is also available (for Windows users).</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p>Later if we want to make modifications (for instance, to improve NuttX and save them in our own branch,
+or submit them back to the project), we can do that easily using git to track our changes and submit them
+upstream to the NuttX project.</p>
+</div>
+<div class="section" id="install-a-cross-compiler-toolchain">
+<h2>Install a Cross-Compiler Toolchain<a class="headerlink" href="#install-a-cross-compiler-toolchain" title="Permalink to this headline">¶</a></h2>
+<p>With Apache NuttX, you compile the operating system and your application on your desktop or laptop computer, then install the
+binary file on your embedded computer. This guide assumes your computer is an
+<a class="reference external" href="https://en.wikipedia.org/wiki/ARM_architecture">ARM</a> CPU. If it isn’t, you’ll need a different tool chain.</p>
+<blockquote>
+<div><p>There are hints on how to get the latest tool chains for most supported architectures in the Apache NuttX CI helper
+<a class="reference external" href="https://github.com/apache/incubator-nuttx-testing/blob/master/cibuild.sh">script</a> and Docker <a class="reference external" href="https://github.com/apache/incubator-nuttx-testing/blob/master/docker/linux/Dockerfile">container</a></p>
+</div></blockquote>
+<p>Download the right flavor of the
+<a class="reference external" href="https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm">ARM Embedded Gnu Toolchain</a>
+for your embedded processor’s CPU.</p>
+<p>Unpack it into <code class="docutils literal notranslate"><span class="pre">/opt/gcc</span></code> and add the bin directory to your path. For instance:</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ usermod -a -G users <span class="nv">$USER</span>
+$ <span class="c1"># get a login shell that knows we're in this group:</span>
+$ su - <span class="nv">$USER</span>
+$ sudo mkdir /opt/gcc
+$ sudo chgrp -R users /opt/gcc
+$ sudo chmod -R u+rw /opt/gcc
+$ <span class="nb">cd</span> /opt/gcc
+$ <span class="nv">HOST_PLATFORM</span><span class="o">=</span>x86_64-linux <span class="c1"># use "mac" for macOS.</span>
+$ <span class="c1"># For windows there is a zip instead (gcc-arm-none-eabi-9-2019-q4-major-win32.zip)</span>
+$ curl -L -o gcc-arm-none-eabi-9-2019-q4-major-<span class="si">${</span><span class="nv">HOST_PLATFORM</span><span class="si">}</span>.tar.bz2 https://developer.arm.com/-/media/Files/downloads/gnu-rm/9-2019q4/gcc-arm-none-eabi-9-2019-q4-major-<span class="si">${</span><span class="nv">HOST_PLATFORM</span><span class="si">}</span>.tar.bz2
+$ tar xf gcc-arm-none-eabi-9-2019-q4-major-<span class="si">${</span><span class="nv">HOST_PLATFORM</span><span class="si">}</span>.tar.bz2
+$ <span class="c1"># add the toolchain bin/ dir to your path...</span>
+$ <span class="c1"># you can edit your shell's rc files if you don't use bash</span>
+$ <span class="nb">echo</span> <span class="s2">"export PATH=/opt/gcc/gcc-arm-none-eabi-9-2019-q4-major/bin:</span><span class="nv">$PATH</span><span class="s2">"</span> >> ~/.bashrc
+</pre></div>
+</div>
+</div></blockquote>
+<hr class="docutils" />
+<p>Next up is <a class="reference internal" href="compiling.html#compiling"><span class="std std-ref">Compiling</span></a>.</p>
+</div>
+</div>
+
+
+ </div>
+
+ </div>
+ <footer>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+
+ © Copyright 2020, The Apache Software Foundation
+
+ </p>
+ </div>
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.Navigation.enable(true);
+ });
+ </script>
+
+
+
+
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/content/docs/latest/quickstart/organization.html b/content/docs/latest/quickstart/organization.html
index 46a3df4..a25269a 100644
--- a/content/docs/latest/quickstart/organization.html
+++ b/content/docs/latest/quickstart/organization.html
@@ -58,8 +58,8 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
- <link rel="next" title="Configuring and Building" href="config_build.html" />
- <link rel="prev" title="Quickstart" href="index.html" />
+ <link rel="next" title="Build and Make Details" href="build_and_make.html" />
+ <link rel="prev" title="Debugging" href="debugging.html" />
</head>
<body class="wy-body-for-nav">
@@ -116,16 +116,22 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="index.html">Quickstart</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Getting Started</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html">Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="compiling.html">Compiling</a></li>
+<li class="toctree-l2"><a class="reference internal" href="running.html">Running</a></li>
+<li class="toctree-l2"><a class="reference internal" href="configuring.html">Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="debugging.html">Debugging</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Directory Structure</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="#documentation">Documentation</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#nuttx-documentation"><code class="docutils literal notranslate"><span class="pre">nuttx/Documentation</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#nuttx-arch"><code class="docutils literal notranslate"><span class="pre">nuttx/arch</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#subdirectory-structure">Subdirectory Structure</a></li>
<li class="toctree-l4"><a class="reference internal" href="#summary-of-files">Summary of Files</a></li>
<li class="toctree-l4"><a class="reference internal" href="#supported-architectures">Supported Architectures</a></li>
</ul>
</li>
-<li class="toctree-l3"><a class="reference internal" href="#nuttx-binfmt">nuttx/binfmt</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#nuttx-binfmt"><code class="docutils literal notranslate"><span class="pre">nuttx/binfmt</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#nuttx-audio"><code class="docutils literal notranslate"><span class="pre">nuttx/audio</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#nuttx-boards"><code class="docutils literal notranslate"><span class="pre">nuttx/boards</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#id1">Subdirectory Structure</a></li>
@@ -151,7 +157,7 @@
<li class="toctree-l3"><a class="reference internal" href="#nuttx-makefile"><code class="docutils literal notranslate"><span class="pre">nuttx/Makefile</span></code></a></li>
</ul>
</li>
-<li class="toctree-l2"><a class="reference internal" href="config_build.html">Configuring and Building</a></li>
+<li class="toctree-l2"><a class="reference internal" href="build_and_make.html">Build and Make Details</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
@@ -208,7 +214,7 @@
<li><a href="../index.html" class="icon icon-home"></a> »</li>
- <li><a href="index.html">Quickstart</a> »</li>
+ <li><a href="index.html">Getting Started</a> »</li>
<li>Directory Structure</li>
@@ -230,8 +236,10 @@
<div itemprop="articleBody">
<div class="section" id="directory-structure">
-<h1>Directory Structure<a class="headerlink" href="#directory-structure" title="Permalink to this headline">¶</a></h1>
-<p><strong>Directory Structure</strong>. The general directory layout for NuttX is
+<span id="organization"></span><h1>Directory Structure<a class="headerlink" href="#directory-structure" title="Permalink to this headline">¶</a></h1>
+<p>This is included for reference, and it’s not necessary to know
+all the details at first.</p>
+<p>The general directory layout for NuttX is
very similar to the directory structure of the Linux kernel – at
least at the most superficial layers. At the top level is the main
makefile and a series of sub-directories identified below and
@@ -286,9 +294,11 @@ board and is selected via the
<code class="docutils literal notranslate"><span class="pre">CONFIG_ARCH_BOARD="stm32f4discovery"</span></code> configuration setting.</p>
</li>
</ul>
-<div class="section" id="documentation">
-<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2>
-<p>General documentation for the NuttX OS resides in this directory.</p>
+<div class="section" id="nuttx-documentation">
+<h2><code class="docutils literal notranslate"><span class="pre">nuttx/Documentation</span></code><a class="headerlink" href="#nuttx-documentation" title="Permalink to this headline">¶</a></h2>
+<p>This directory holds the NuttX documentation. It’s made with
+the <a class="reference external" href="https://www.sphinx-doc.org">Sphinx documentation system</a>. See the
+README.md file for information on how to build it.</p>
</div>
<div class="section" id="nuttx-arch">
<h2><code class="docutils literal notranslate"><span class="pre">nuttx/arch</span></code><a class="headerlink" href="#nuttx-arch" title="Permalink to this headline">¶</a></h2>
@@ -440,7 +450,7 @@ z8Encore! Microcontrollers.</p></li>
</div>
</div>
<div class="section" id="nuttx-binfmt">
-<h2>nuttx/binfmt<a class="headerlink" href="#nuttx-binfmt" title="Permalink to this headline">¶</a></h2>
+<h2><code class="docutils literal notranslate"><span class="pre">nuttx/binfmt</span></code><a class="headerlink" href="#nuttx-binfmt" title="Permalink to this headline">¶</a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">binfmt/</span></code> subdirectory contains logic for loading binaries
in the file system into memory in a form that can be used to
execute them.</p>
@@ -683,6 +693,8 @@ support.</p>
all of the top-level control logic to build NuttX. Use of this
<code class="docutils literal notranslate"><span class="pre">Makefile</span></code> to build NuttX is described
<a class="reference external" href="#buildingnuttx">below</a>.</p>
+<hr class="docutils" />
+<p>Next up is <a class="reference internal" href="build_and_make.html#build-and-make"><span class="std std-ref">Build and Make Details</span></a>.</p>
</div>
</div>
diff --git a/content/docs/latest/quickstart/quickstart.html b/content/docs/latest/quickstart/quickstart.html
new file mode 100644
index 0000000..a77d342
--- /dev/null
+++ b/content/docs/latest/quickstart/quickstart.html
@@ -0,0 +1,349 @@
+<!--
+ Documentation/_templates/layout.html
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership. The
+ ASF licenses this file to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance with the
+ License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+-->
+
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Quickstart — NuttX latest documentation</title>
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+
+ <link rel="shortcut icon" href="../_static/favicon.ico"/>
+
+
+
+
+
+ <!--[if lt IE 9]>
+ <script src="../_static/js/html5shiv.min.js"></script>
+ <![endif]-->
+
+
+ <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+ <script src="../_static/jquery.js"></script>
+ <script src="../_static/underscore.js"></script>
+ <script src="../_static/doctools.js"></script>
+ <script src="../_static/language_data.js"></script>
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <link rel="next" title="Installing" href="install.html" />
+ <link rel="prev" title="Getting Started" href="index.html" />
+</head>
+
+<body class="wy-body-for-nav">
+
+
+ <div class="wy-grid-for-nav">
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-scroll">
+ <div class="wy-side-nav-search" >
+
+
+ <a href="../index.html" class="icon icon-home"> NuttX
+
+
+
+
+ <img src="../_static/NuttX.png" class="logo" alt="Logo"/>
+
+ </a>
+
+ <!-- this version selector is quite ugly, should be probably replaced by something
+ more modern -->
+
+ <div class="version-selector">
+ <select>
+
+ <option value="latest" selected="selected">latest</option>
+
+ </select>
+ </div>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+ </div>
+
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+ <p class="caption"><span class="caption-text">Table of Contents</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Getting Started</a><ul class="current">
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Quickstart</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html">Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="compiling.html">Compiling</a></li>
+<li class="toctree-l2"><a class="reference internal" href="running.html">Running</a></li>
+<li class="toctree-l2"><a class="reference internal" href="configuring.html">Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="debugging.html">Debugging</a></li>
+<li class="toctree-l2"><a class="reference internal" href="organization.html">Directory Structure</a></li>
+<li class="toctree-l2"><a class="reference internal" href="build_and_make.html">Build and Make Details</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">API Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../guides/index.html">Guides</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../releases/index.html">Releases</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </div>
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" aria-label="top navigation">
+
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">NuttX</a>
+
+ </nav>
+
+
+ <div class="wy-nav-content">
+
+ <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+ <ul class="wy-breadcrumbs">
+
+ <li><a href="../index.html" class="icon icon-home"></a> »</li>
+
+ <li><a href="index.html">Getting Started</a> »</li>
+
+ <li>Quickstart</li>
+
+
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../_sources/quickstart/quickstart.rst.txt" rel="nofollow"> View page source</a>
+
+
+ </li>
+
+ </ul>
+
+
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="quickstart">
+<span id="id1"></span><h1>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this headline">¶</a></h1>
+<p>Here’s the quick version of getting started with NuttX. This is a bare-bones outline for experienced developers– if it’s
+going too quickly, dive into the following sections. This Quickstart guide assumes you’re on a Linux
+computer, you’re using an ARM microcontroller on your embedded board, and you’re familiar with using the command line.</p>
+<ol class="arabic">
+<li><p>Install a Cross-Compiler Toolchain</p>
+<p>With NuttX, you compile the operating system and your application on your desktop or laptop computer, then install the
+binary file on your embedded computer. This guide assumes your computer is an
+<a class="reference external" href="https://en.wikipedia.org/wiki/ARM_architecture">ARM</a> CPU. If it isn’t, you’ll need a different tool chain.</p>
+<p>You can download a toolchain from
+<a class="reference external" href="https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm">ARM Embedded Gnu Toolchain</a>
+for your embedded processor’s CPU. You can also use a toolchain shipped with your OS for the <cite>none-eabi</cite> target, such as <cite>gcc-arm-none-eabi</cite> in Linux.</p>
+</li>
+</ol>
+<p>In the following example, we download <code class="docutils literal notranslate"><span class="pre">gcc-arm-none-eabi</span></code> version 9.0 and unpack it into <a href="#id2"><span class="problematic" id="id3">``</span></a>/opt/gcc`:</p>
+<blockquote>
+<div><div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> sudo mkdir /opt/gcc
+<span class="gp">$</span> sudo chgrp -R users /opt/gcc
+<span class="gp">$</span> <span class="nb">cd</span> /opt/gcc
+<span class="gp">$</span> wget https://developer.arm.com/-/media/Files/downloads/gnu-rm/9-2019q4/gcc-arm-none-eabi-9-2019-q4-major-x86_64-linux.tar.bz2
+<span class="gp">$</span> tar xf gcc-arm-none-eabi-9-2019-q4-major-x86_64-linux.tar.bz2
+</pre></div>
+</div>
+</div></blockquote>
+<p>Then, add the toolchain <code class="docutils literal notranslate"><span class="pre">bin/</span></code> directory to your path:</p>
+<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> <span class="nb">echo</span> <span class="s2">"export PATH=/opt/gcc/gcc-arm-none-eabi-9-2019-q4-major/bin:</span><span class="nv">$PATH</span><span class="s2">"</span> >> ~/.bashrc
+</pre></div>
+</div>
+<p>If you are using any other shell, the procedure is similar by editing the corresponding rc file.</p>
+<p>#. Download Apache NuttX
+The next step is to download NuttX main repository along the application repository. The latter is technically optional in a very minimal configurations but should be included in normal configuration since it includes the NuttX shell.</p>
+<blockquote>
+<div><div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> mkdir nuttx
+<span class="gp">$</span> <span class="nb">cd</span> nuttx
+<span class="gp">$</span> git clone https://github.com/apache/incubator-nuttx.git nuttx
+<span class="gp">$</span> git clone https://github.com/apache/incubator-nuttx-apps apps
+<span class="gp">$</span> git clone https://bitbucket.org/nuttx/tools.git tools
+</pre></div>
+</div>
+</div></blockquote>
+<ol class="arabic">
+<li><p>Install the <code class="docutils literal notranslate"><span class="pre">kconfig-frontends</span></code> package</p>
+<p>NuttX is configured using <code class="docutils literal notranslate"><span class="pre">kconfig</span></code> system via an interactive menu system (<code class="docutils literal notranslate"><span class="pre">menuconfig</span></code>). It also includes the <code class="docutils literal notranslate"><span class="pre">kconfig-tweak</span></code> utility that can be used to quickly change debug settings without going into the menu system.</p>
+<p>On Ubuntu 20.04 LTS and later, you can do:</p>
+<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> apt install kconfig-frontends
+</pre></div>
+</div>
+<p>On MacOS, and Ubuntu 18.04 LTS and earlier, you need to install manually:</p>
+<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> <span class="nb">cd</span> tools/kconfig-frontends
+<span class="gp">$</span> <span class="c1"># on MacOS do the following:</span>
+<span class="gp">$</span> patch < ../kconfig-macos.diff -p <span class="m">1</span>
+<span class="gp">$</span> ./configure --enable-mconf --disable-shared --enable-static --disable-gconf --disable-qconf --disable-nconf
+<span class="gp">$</span> <span class="c1"># on Linux do the following:</span>
+<span class="gp">$</span> ./configure --enable-mconf --disable-nconf --disable-gconf --disable-qconf
+<span class="gp">$</span> make
+<span class="gp">$</span> make install
+</pre></div>
+</div>
+</li>
+<li><p>List Possible Apache NuttX Base Configurations</p>
+<p>Find your hardware and a good starting application in the list of base configurations. In the application list,
+<code class="docutils literal notranslate"><span class="pre">nsh</span></code> is the Apache NuttX Shell, an interactive commandline that’s a good starting place if you’re new.</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ <span class="nb">cd</span> nuttx
+$ ./tools/configure.sh -L <span class="p">|</span> less
+</pre></div>
+</div>
+</li>
+<li><p>Initialize Configuration</p>
+<p>Pick one of the board:application base configuration pairs from the list, and feed it to
+the configuration script. The <code class="docutils literal notranslate"><span class="pre">-l</span></code> tells us that we’re on Linux. macOS and Windows builds
+are possible, this guide doesn’t cover them yet.</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ <span class="nb">cd</span> nuttx
+$ ./tools/configure.sh -l <board-name>:<config-dir>
+<span class="c1"># for instance:</span>
+$ ./tools/configure.sh -l sama5d27-xult:nsh
+</pre></div>
+</div>
+</li>
+<li><p>Customize Your Configuration (Optional)</p>
+<p>This step is optional. Right now, this is mainly to get familiar with how it works– you don’t need to change
+any of the options now, but knowing how to do this will come in handy later.</p>
+<p>There are a lot of options. We’ll cover a few of them here. Don’t worry about the complexity– you don’t have to use most of the options.</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make menuconfig
+</pre></div>
+</div>
+</li>
+</ol>
+<p>Use your arrows to navigate the menu and <code class="docutils literal notranslate"><span class="pre">ENTER</span></code> key to enable/disable options. To exit and save your configuration, go back to the main menu, choose <code class="docutils literal notranslate"><span class="pre"><Exit></span></code> and select “yes” when asked if you want to save.</p>
+<ol class="arabic">
+<li><p>Compile Apache NuttX</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make
+</pre></div>
+</div>
+</li>
+<li><p>Install the Executable Program on Your Board</p>
+<p>This step is a bit more complicated, depending on your board. It’s covered in the section
+<a class="reference internal" href="running.html#running"><span class="std std-ref">Running Apache NuttX</span></a>.</p>
+</li>
+</ol>
+<hr class="docutils" />
+<p class="rubric">More Details</p>
+<p>If you want more details, start at <a class="reference internal" href="install.html#install"><span class="std std-ref">Installing</span></a>.</p>
+</div>
+
+
+ </div>
+
+ </div>
+ <footer>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+
+ © Copyright 2020, The Apache Software Foundation
+
+ </p>
+ </div>
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.Navigation.enable(true);
+ });
+ </script>
+
+
+
+
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/content/docs/latest/quickstart/running.html b/content/docs/latest/quickstart/running.html
new file mode 100644
index 0000000..02e33f9
--- /dev/null
+++ b/content/docs/latest/quickstart/running.html
@@ -0,0 +1,353 @@
+<!--
+ Documentation/_templates/layout.html
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership. The
+ ASF licenses this file to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance with the
+ License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+-->
+
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+ <meta charset="utf-8">
+
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Running — NuttX latest documentation</title>
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+
+ <link rel="shortcut icon" href="../_static/favicon.ico"/>
+
+
+
+
+
+ <!--[if lt IE 9]>
+ <script src="../_static/js/html5shiv.min.js"></script>
+ <![endif]-->
+
+
+ <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+ <script src="../_static/jquery.js"></script>
+ <script src="../_static/underscore.js"></script>
+ <script src="../_static/doctools.js"></script>
+ <script src="../_static/language_data.js"></script>
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+ <link rel="next" title="Configuring" href="configuring.html" />
+ <link rel="prev" title="Compiling" href="compiling.html" />
+</head>
+
+<body class="wy-body-for-nav">
+
+
+ <div class="wy-grid-for-nav">
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-scroll">
+ <div class="wy-side-nav-search" >
+
+
+ <a href="../index.html" class="icon icon-home"> NuttX
+
+
+
+
+ <img src="../_static/NuttX.png" class="logo" alt="Logo"/>
+
+ </a>
+
+ <!-- this version selector is quite ugly, should be probably replaced by something
+ more modern -->
+
+ <div class="version-selector">
+ <select>
+
+ <option value="latest" selected="selected">latest</option>
+
+ </select>
+ </div>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+ </div>
+
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+ <p class="caption"><span class="caption-text">Table of Contents</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Getting Started</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html">Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="compiling.html">Compiling</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Running</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#debugging-shortcuts">Debugging Shortcuts</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="configuring.html">Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="debugging.html">Debugging</a></li>
+<li class="toctree-l2"><a class="reference internal" href="organization.html">Directory Structure</a></li>
+<li class="toctree-l2"><a class="reference internal" href="build_and_make.html">Build and Make Details</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">API Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../guides/index.html">Guides</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../releases/index.html">Releases</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </div>
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" aria-label="top navigation">
+
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">NuttX</a>
+
+ </nav>
+
+
+ <div class="wy-nav-content">
+
+ <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+ <ul class="wy-breadcrumbs">
+
+ <li><a href="../index.html" class="icon icon-home"></a> »</li>
+
+ <li><a href="index.html">Getting Started</a> »</li>
+
+ <li>Running</li>
+
+
+ <li class="wy-breadcrumbs-aside">
+
+
+ <a href="../_sources/quickstart/running.rst.txt" rel="nofollow"> View page source</a>
+
+
+ </li>
+
+ </ul>
+
+
+ <hr/>
+</div>
+ <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+ <div itemprop="articleBody">
+
+ <div class="section" id="running">
+<span id="id1"></span><h1>Running<a class="headerlink" href="#running" title="Permalink to this headline">¶</a></h1>
+<p>Embedded boards have different ways to get your program onto them and get them running. 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>. <a class="reference external" href="https://en.wikipedia.org/wiki/JTAG">JTAG</a>
+is a set of standards that let you 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>
+<ol class="arabic">
+<li><p>Attach the Debugger Cables</p></li>
+<li><p>Start the Debugger</p>
+<p>Refer to your JTAG debugger’s documentation for information on how to start a GDB Server process that gdb can
+communicate with to load code and start, stop, and step the embedded board’s CPU. Your command line may be
+different from this one.</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ JLinkGDBServer -device ATSAMA5D27 -if JTAG -speed <span class="m">1000</span> -JTAGConf -1,-1
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Launch the Gnu Debugger</p>
+<p>In another terminal window, launch the GDB for your platform. In the case of this guide, this came with the
+ARM Embedded Gnu Toolchain we downloaded in the Install step.</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ arm-none-eabi-gdb
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Connect to the board’s serial console</p>
+<p>Usually you connect a USB-to-serial adapter to the board’s serial console so you can see debug logging or
+execute Apache NuttX Shell (nsh) commands. You can access the serial console from Linux with the <code class="docutils literal notranslate"><span class="pre">picocom</span></code> terminal
+program. From another terminal, do this:</p>
+<blockquote>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ picocom -b <span class="m">115200</span> /dev/ttyUSB0
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Set gdb to talk with the J-Link</p>
+<blockquote>
+<div><div class="highlight-none notranslate"><div class="highlight"><pre><span></span>(gdb) target extended-remote :2331
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Reset the board</p>
+<blockquote>
+<div><div class="highlight-none notranslate"><div class="highlight"><pre><span></span>(gdb) mon reset
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>You may need to switch to the serial console to hit a key to stop the board from booting from its boot monitor
+(U-Boot, in the case of the SAMA5 boards from Microchip).</p></li>
+<li><p>Halt the board</p>
+<blockquote>
+<div><div class="highlight-none notranslate"><div class="highlight"><pre><span></span>(gdb) mon halt
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Load nuttx</p>
+<blockquote>
+<div><div class="highlight-none notranslate"><div class="highlight"><pre><span></span>(gdb) file nuttx
+(gdb) load nuttx
+`/home/adamf/src/nuttx-sama5d36-xplained/nuttx/nuttx' has changed; re-reading symbols.
+Loading section .text, size 0x9eae4 lma 0x20008000
+Loading section .ARM.exidx, size 0x8 lma 0x200a6ae4
+Loading section .data, size 0x125c lma 0x200a6aec
+Start address 0x20008040, load size 654664
+Transfer rate: 75 KB/sec, 15587 bytes/write.
+(gdb)
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Set a breakpoint</p>
+<blockquote>
+<div><div class="highlight-none notranslate"><div class="highlight"><pre><span></span>(gdb) breakpoint nsh_main
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+<li><p>Start nuttx</p>
+<blockquote>
+<div><div class="highlight-none notranslate"><div class="highlight"><pre><span></span>(gdb) continue
+Continuing.
+
+Breakpoint 1, nsh_main (argc=1, argv=0x200ddfac) at nsh_main.c:208
+208 sched_getparam(0, &param);
+(gdb) continue
+Continuing.
+</pre></div>
+</div>
+</div></blockquote>
+</li>
+</ol>
+<div class="section" id="debugging-shortcuts">
+<h2>Debugging Shortcuts<a class="headerlink" href="#debugging-shortcuts" title="Permalink to this headline">¶</a></h2>
+<p>Note that you can abbreviate <code class="docutils literal notranslate"><span class="pre">gdb</span></code> commands, <code class="docutils literal notranslate"><span class="pre">info</span> <span class="pre">b</span></code> is a shortcut for
+<code class="docutils literal notranslate"><span class="pre">information</span> <span class="pre">breakpoints</span></code>; <code class="docutils literal notranslate"><span class="pre">c</span></code> works the same as <code class="docutils literal notranslate"><span class="pre">continue</span></code>, etc.</p>
+<hr class="docutils" />
+<p>Next up is <a class="reference internal" href="configuring.html#configuring"><span class="std std-ref">Configuring</span></a>.</p>
+</div>
+</div>
+
+
+ </div>
+
+ </div>
+ <footer>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+
+ © Copyright 2020, The Apache Software Foundation
+
+ </p>
+ </div>
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.Navigation.enable(true);
+ });
+ </script>
+
+
+
+
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/content/docs/latest/reference/index.html b/content/docs/latest/reference/index.html
index e4a0b5f..0f17c3f 100644
--- a/content/docs/latest/reference/index.html
+++ b/content/docs/latest/reference/index.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/os/addrenv.html b/content/docs/latest/reference/os/addrenv.html
index 81c5b11..b323e50 100644
--- a/content/docs/latest/reference/os/addrenv.html
+++ b/content/docs/latest/reference/os/addrenv.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/os/app_vs_os.html b/content/docs/latest/reference/os/app_vs_os.html
index 3e4a4d5..bc59163 100644
--- a/content/docs/latest/reference/os/app_vs_os.html
+++ b/content/docs/latest/reference/os/app_vs_os.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/os/arch.html b/content/docs/latest/reference/os/arch.html
index 18d144c..e4ea683 100644
--- a/content/docs/latest/reference/os/arch.html
+++ b/content/docs/latest/reference/os/arch.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/os/board.html b/content/docs/latest/reference/os/board.html
index ca526f4..1bb79e7 100644
--- a/content/docs/latest/reference/os/board.html
+++ b/content/docs/latest/reference/os/board.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/os/boardctl.html b/content/docs/latest/reference/os/boardctl.html
index 7829e3e..ff708e5 100644
--- a/content/docs/latest/reference/os/boardctl.html
+++ b/content/docs/latest/reference/os/boardctl.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/os/conventions.html b/content/docs/latest/reference/os/conventions.html
index 38da72e..db378cf 100644
--- a/content/docs/latest/reference/os/conventions.html
+++ b/content/docs/latest/reference/os/conventions.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/os/index.html b/content/docs/latest/reference/os/index.html
index 316eefe..bcc19ff 100644
--- a/content/docs/latest/reference/os/index.html
+++ b/content/docs/latest/reference/os/index.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/os/iob.html b/content/docs/latest/reference/os/iob.html
index 5ee7d93..e06c300 100644
--- a/content/docs/latest/reference/os/iob.html
+++ b/content/docs/latest/reference/os/iob.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/os/led.html b/content/docs/latest/reference/os/led.html
index ec3bcb9..9aec9c1 100644
--- a/content/docs/latest/reference/os/led.html
+++ b/content/docs/latest/reference/os/led.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/os/nuttx.html b/content/docs/latest/reference/os/nuttx.html
index 5be87b2..72ab2ec 100644
--- a/content/docs/latest/reference/os/nuttx.html
+++ b/content/docs/latest/reference/os/nuttx.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/os/paging.html b/content/docs/latest/reference/os/paging.html
index be83dd3..4f0943e 100644
--- a/content/docs/latest/reference/os/paging.html
+++ b/content/docs/latest/reference/os/paging.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/os/shm.html b/content/docs/latest/reference/os/shm.html
index 3adfd6a..86999b0 100644
--- a/content/docs/latest/reference/os/shm.html
+++ b/content/docs/latest/reference/os/shm.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/os/smp.html b/content/docs/latest/reference/os/smp.html
index 1627f4b..5b41dc0 100644
--- a/content/docs/latest/reference/os/smp.html
+++ b/content/docs/latest/reference/os/smp.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/os/time_clock.html b/content/docs/latest/reference/os/time_clock.html
index 9f36ab0..3b23c13 100644
--- a/content/docs/latest/reference/os/time_clock.html
+++ b/content/docs/latest/reference/os/time_clock.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/os/wqueue.html b/content/docs/latest/reference/os/wqueue.html
index ce47363..9b6e360 100644
--- a/content/docs/latest/reference/os/wqueue.html
+++ b/content/docs/latest/reference/os/wqueue.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/user/01_task_control.html b/content/docs/latest/reference/user/01_task_control.html
index 784ab78..6bf2e39 100644
--- a/content/docs/latest/reference/user/01_task_control.html
+++ b/content/docs/latest/reference/user/01_task_control.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/user/02_task_scheduling.html b/content/docs/latest/reference/user/02_task_scheduling.html
index ca2efb1..266b718 100644
--- a/content/docs/latest/reference/user/02_task_scheduling.html
+++ b/content/docs/latest/reference/user/02_task_scheduling.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/user/03_task_control.html b/content/docs/latest/reference/user/03_task_control.html
index 7c18fb3..b891f0a 100644
--- a/content/docs/latest/reference/user/03_task_control.html
+++ b/content/docs/latest/reference/user/03_task_control.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/user/04_message_queue.html b/content/docs/latest/reference/user/04_message_queue.html
index 1a75b6a..4505ed6 100644
--- a/content/docs/latest/reference/user/04_message_queue.html
+++ b/content/docs/latest/reference/user/04_message_queue.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/user/05_counting_semaphore.html b/content/docs/latest/reference/user/05_counting_semaphore.html
index 7160ed8..93bc7d1 100644
--- a/content/docs/latest/reference/user/05_counting_semaphore.html
+++ b/content/docs/latest/reference/user/05_counting_semaphore.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/user/06_clocks_timers.html b/content/docs/latest/reference/user/06_clocks_timers.html
index 45b0fcc..978aaa9 100644
--- a/content/docs/latest/reference/user/06_clocks_timers.html
+++ b/content/docs/latest/reference/user/06_clocks_timers.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/user/07_signals.html b/content/docs/latest/reference/user/07_signals.html
index 689d0ad..a9c5c2a 100644
--- a/content/docs/latest/reference/user/07_signals.html
+++ b/content/docs/latest/reference/user/07_signals.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/user/08_pthread.html b/content/docs/latest/reference/user/08_pthread.html
index 52dab17..9520186 100644
--- a/content/docs/latest/reference/user/08_pthread.html
+++ b/content/docs/latest/reference/user/08_pthread.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/user/09_env_vars.html b/content/docs/latest/reference/user/09_env_vars.html
index 036e068..d99bb61 100644
--- a/content/docs/latest/reference/user/09_env_vars.html
+++ b/content/docs/latest/reference/user/09_env_vars.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/user/10_filesystem.html b/content/docs/latest/reference/user/10_filesystem.html
index 9951d4b..9d5c4de 100644
--- a/content/docs/latest/reference/user/10_filesystem.html
+++ b/content/docs/latest/reference/user/10_filesystem.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/user/11_network.html b/content/docs/latest/reference/user/11_network.html
index 38df2ed..9bedb86 100644
--- a/content/docs/latest/reference/user/11_network.html
+++ b/content/docs/latest/reference/user/11_network.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/user/12_shared_memory.html b/content/docs/latest/reference/user/12_shared_memory.html
index 11651c7..c3fbc35 100644
--- a/content/docs/latest/reference/user/12_shared_memory.html
+++ b/content/docs/latest/reference/user/12_shared_memory.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/user/index.html b/content/docs/latest/reference/user/index.html
index f017e63..116be0a 100644
--- a/content/docs/latest/reference/user/index.html
+++ b/content/docs/latest/reference/user/index.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/reference/user/structures.html b/content/docs/latest/reference/user/structures.html
index 59d9034..98ef924 100644
--- a/content/docs/latest/reference/user/structures.html
+++ b/content/docs/latest/reference/user/structures.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/releases/index.html b/content/docs/latest/releases/index.html
index 8c3a63d..ac50573 100644
--- a/content/docs/latest/releases/index.html
+++ b/content/docs/latest/releases/index.html
@@ -59,7 +59,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Contributing" href="../contributing/index.html" />
- <link rel="prev" title="USB Device Trace" href="../guides/usbtrace.html" />
+ <link rel="prev" title="Drivers" href="../guides/drivers.html" />
</head>
<body class="wy-body-for-nav">
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/search.html b/content/docs/latest/search.html
index 561d2be..86d334f 100644
--- a/content/docs/latest/search.html
+++ b/content/docs/latest/search.html
@@ -116,7 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="boards/index.html">Supported Boards</a></li>
diff --git a/content/docs/latest/searchindex.js b/content/docs/latest/searchindex.js
index e51f21b..9bcf016 100644
--- a/content/docs/latest/searchindex.js
+++ b/content/docs/latest/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["applications/index","boards/index","components/binfmt","components/drivers/index","components/filesystem","components/index","components/nsh/builtin","components/nsh/commands","components/nsh/config","components/nsh/customizing","components/nsh/index","components/nsh/installation","components/nsh/login","components/nsh/nsh","components/nxflat","components/nxgraphics/appendix","components/nxgraphics/index","components/nxgraphics/nx","components/nxgraphics/nxcur [...]
\ No newline at end of file
+Search.setIndex({docnames:["applications/index","boards/index","components/binfmt","components/drivers/index","components/filesystem","components/index","components/nsh/builtin","components/nsh/commands","components/nsh/config","components/nsh/customizing","components/nsh/index","components/nsh/installation","components/nsh/login","components/nsh/nsh","components/nxflat","components/nxgraphics/appendix","components/nxgraphics/index","components/nxgraphics/nx","components/nxgraphics/nxcur [...]
\ No newline at end of file
diff --git a/content/docs/latest/substitutions.html b/content/docs/latest/substitutions.html
index 38bf9ad..b73fe82 100644
--- a/content/docs/latest/substitutions.html
+++ b/content/docs/latest/substitutions.html
@@ -114,7 +114,7 @@
<li class="toctree-l1"><a class="reference internal" href="index.html">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/inviolables.html">The Inviolable Principles of NuttX</a></li>
-<li class="toctree-l1"><a class="reference internal" href="quickstart/index.html">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="quickstart/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="components/index.html">OS Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="applications/index.html">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="boards/index.html">Supported Boards</a></li>
diff --git a/content/feed.xml b/content/feed.xml
index 1ee7290..8afc297 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, 02 Sep 2020 20:25:00 +0000</pubDate>
- <lastBuildDate>Wed, 02 Sep 2020 20:25:00 +0000</lastBuildDate>
+ <pubDate>Fri, 04 Sep 2020 23:41:50 +0000</pubDate>
+ <lastBuildDate>Fri, 04 Sep 2020 23:41:50 +0000</lastBuildDate>
<generator>Jekyll v3.8.5</generator>
<item>