| <!-- |
| 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>Compiling — 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/sphinx_tabs/semantic-ui-2.4.1/segment.min.css" type="text/css" /> |
| <link rel="stylesheet" href="../_static/sphinx_tabs/semantic-ui-2.4.1/menu.min.css" type="text/css" /> |
| <link rel="stylesheet" href="../_static/sphinx_tabs/semantic-ui-2.4.1/tab.min.css" type="text/css" /> |
| <link rel="stylesheet" href="../_static/sphinx_tabs/tabs.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="Running" href="running.html" /> |
| <link rel="prev" title="Installing" href="install.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 current"><a class="current reference internal" href="#">Compiling</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="#initialize-configuration">Initialize Configuration</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#customize-your-configuration-optional">Customize Your Configuration (Optional)</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#build-nuttx">Build NuttX</a></li> |
| </ul> |
| </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>Compiling</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../_sources/quickstart/compiling.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="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> |
| <div class="section" id="initialize-configuration"> |
| <h2>Initialize Configuration<a class="headerlink" href="#initialize-configuration" title="Permalink to this headline">¶</a></h2> |
| <p>The first step is to initialize NuttX configuration for a given board, based from |
| a pre-existing configuration. To list all supported configurations you can do:</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 -L <span class="p">|</span> less |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <p>The output is in the format <code class="docutils literal notranslate"><span class="pre"><board</span> <span class="pre">name>:<board</span> <span class="pre">configuration></span></code>. You will see that |
| generally all boards support the <code class="docutils literal notranslate"><span class="pre">nsh</span></code> configuration which is a good sarting point |
| since it enables booting into the interactive command line |
| <a class="reference internal" href="../components/nsh/index.html"><span class="doc">NuttShell (NSH)</span></a>.</p> |
| <p>To choose a configuration you pass the <code class="docutils literal notranslate"><span class="pre"><board</span> <span class="pre">name>:<board</span> <span class="pre">configuration></span></code> option |
| to <code class="docutils literal notranslate"><span class="pre">configure.sh</span></code> and indicate your host platform, such as:</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 -l stm32f4discovery:nsh |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <p>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). Use the <code class="docutils literal notranslate"><span class="pre">-h</span></code> argument to see all available options.</p> |
| </div> |
| <div class="section" id="customize-your-configuration-optional"> |
| <h2>Customize Your Configuration (Optional)<a class="headerlink" href="#customize-your-configuration-optional" title="Permalink to this headline">¶</a></h2> |
| <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-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> <span class="nb">cd</span> nuttx/ |
| <span class="gp">$</span> make menuconfig |
| </pre></div> |
| </div> |
| <div class="admonition-todo admonition" id="id2"> |
| <p class="admonition-title">Todo</p> |
| <p>Explain some useful options.</p> |
| </div> |
| </div> |
| <div class="section" id="build-nuttx"> |
| <h2>Build NuttX<a class="headerlink" href="#build-nuttx" title="Permalink to this headline">¶</a></h2> |
| <p>We can now build NuttX. To do so, you can simply run:</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> make make |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <p>The build will complete by generating the binary outputs |
| inside <cite>nuttx</cite> directory. Typically this includes the <cite>nuttx</cite> |
| ELF file (suitable for debugging using <cite>gdb</cite>) and a <cite>nuttx.bin</cite> |
| file that can be flashed to the board.</p> |
| <p>To clean the build, you can do:</p> |
| <blockquote> |
| <div><div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> make clean |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <div class="admonition warning"> |
| <p class="admonition-title">Warning</p> |
| <p>At the moment it is recommended that after modifying the |
| configuration you first clean before building again. This |
| is currently worked on.</p> |
| </div> |
| <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> |
| </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> |
