| <!-- |
| 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="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>Configuration Settings — NuttX latest documentation</title> |
| <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> |
| <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../_static/copybutton.css" type="text/css" /> |
| <link rel="stylesheet" href="../../_static/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 src="../../_static/jquery.js"></script> |
| <script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script> |
| <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> |
| <script src="../../_static/doctools.js"></script> |
| <script src="../../_static/sphinx_highlight.js"></script> |
| <script src="../../_static/clipboard.min.js"></script> |
| <script src="../../_static/copybutton.js"></script> |
| <script 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="WAPI (Wireless API)" href="../wapi/index.html" /> |
| <link rel="prev" title="NuttX Diagnostic Tool (Nxdiag)" 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 |
| |
| |
| |
| </a> |
| |
| <!-- this version selector is quite ugly, should be probably replaced by something |
| more modern --> |
| |
| <div class="version-selector"> |
| <select onchange="javascript:location.href = this.value;"> |
| |
| <option value="../../../latest" selected="selected">latest</option> |
| |
| <option value="../../../10.0.0" >10.0.0</option> |
| |
| <option value="../../../10.0.1" >10.0.1</option> |
| |
| <option value="../../../10.1.0" >10.1.0</option> |
| |
| <option value="../../../10.2.0" >10.2.0</option> |
| |
| <option value="../../../10.3.0" >10.3.0</option> |
| |
| <option value="../../../11.0.0" >11.0.0</option> |
| |
| <option value="../../../12.0.0" >12.0.0</option> |
| |
| <option value="../../../12.1.0" >12.1.0</option> |
| |
| <option value="../../../12.2.0" >12.2.0</option> |
| |
| <option value="../../../12.2.1" >12.2.1</option> |
| |
| <option value="../../../12.3.0" >12.3.0</option> |
| |
| <option value="../../../12.4.0" >12.4.0</option> |
| |
| <option value="../../../12.5.0" >12.5.0</option> |
| |
| <option value="../../../12.5.1" >12.5.1</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" aria-label="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="Navigation menu"> |
| <p class="caption" role="heading"><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="../../quickstart/index.html">Getting Started</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="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../platforms/index.html">Supported Platforms</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="reference internal" href="../index.html">Applications</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="index.html">NuttX Diagnostic Tool (Nxdiag)</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="index.html#usage">Usage</a><ul class="current"> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">Configuration Settings</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#option-dependencies-on-configuration-settings">Option Dependencies on Configuration Settings</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#nxdiag-specific-configuration-settings">Nxdiag-Specific Configuration Settings</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../wapi/index.html">WAPI (Wireless API)</a></li> |
| </ul> |
| </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="../../faq/index.html">FAQ</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="../../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="Mobile navigation menu" > |
| <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="Page navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="../../index.html" class="icon icon-home" aria-label="Home"></a></li> |
| <li class="breadcrumb-item"><a href="../index.html">Applications</a></li> |
| <li class="breadcrumb-item"><a href="index.html">NuttX Diagnostic Tool (Nxdiag)</a></li> |
| <li class="breadcrumb-item active">Configuration Settings</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="../../_sources/applications/nxdiag/config.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"> |
| |
| <section id="configuration-settings"> |
| <h1>Configuration Settings<a class="headerlink" href="#configuration-settings" title="Permalink to this heading"></a></h1> |
| <p>The availability of the above commands depends upon features that may or |
| may not be enabled in the NuttX configuration file. The following |
| <a class="reference internal" href="#nxdiagcmddependencies"><span class="std std-ref">cmdtable</span></a> indicates the dependency of each command on |
| NuttX configuration settings. General configuration settings are |
| discussed in the NuttX Porting Guide. |
| Configuration settings specific to Nxdiag as discussed at the |
| <a class="reference internal" href="#nxdiagconfiguration"><span class="std std-ref">cmdbottom</span></a> of this document.</p> |
| <p>Note that the <code class="docutils literal notranslate"><span class="pre">--vendor-specific</span></code> or <code class="docutils literal notranslate"><span class="pre">-v</span></code> option will generate vendor-specific |
| information and checks. The output of this option will depend on the selected |
| vendors in the NuttX configuration file. For example, if the <code class="docutils literal notranslate"><span class="pre">CONFIG_SYSTEM_NXDIAG_ESPRESSIF</span></code> |
| configuration setting is enabled, then this option will provide custom |
| information and checks for Espressif devices. Multiple vendors may be selected |
| at the same time.</p> |
| <section id="option-dependencies-on-configuration-settings"> |
| <span id="nxdiagcmddependencies"></span><h2>Option Dependencies on Configuration Settings<a class="headerlink" href="#option-dependencies-on-configuration-settings" title="Permalink to this heading"></a></h2> |
| <table class="docutils align-default"> |
| <thead> |
| <tr class="row-odd"><th class="head"><p>Option</p></th> |
| <th class="head"><p>Depends on Configuration</p></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--help,</span> <span class="pre">-h</span></code></p></td> |
| <td></td> |
| </tr> |
| <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--nuttx,</span> <span class="pre">-n</span></code></p></td> |
| <td></td> |
| </tr> |
| <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--flags,</span> <span class="pre">-f</span></code></p></td> |
| <td><p><code class="docutils literal notranslate"><span class="pre">CONFIG_SYSTEM_NXDIAG_COMP_FLAGS</span></code></p></td> |
| </tr> |
| <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--config,</span> <span class="pre">-c</span></code></p></td> |
| <td><p><code class="docutils literal notranslate"><span class="pre">CONFIG_SYSTEM_NXDIAG_CONF</span></code></p></td> |
| </tr> |
| <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--host-os,</span> <span class="pre">-o</span></code></p></td> |
| <td></td> |
| </tr> |
| <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--host-path,</span> <span class="pre">-p</span></code></p></td> |
| <td><p><code class="docutils literal notranslate"><span class="pre">CONFIG_SYSTEM_NXDIAG_HOST_PATH</span></code></p></td> |
| </tr> |
| <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--host-packages,</span> <span class="pre">-k</span></code></p></td> |
| <td><p><code class="docutils literal notranslate"><span class="pre">CONFIG_SYSTEM_NXDIAG_HOST_PACKAGES</span></code></p></td> |
| </tr> |
| <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--host-modules,</span> <span class="pre">-m</span></code></p></td> |
| <td><p><code class="docutils literal notranslate"><span class="pre">CONFIG_SYSTEM_NXDIAG_HOST_MODULES</span></code></p></td> |
| </tr> |
| <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--vendor-specific,</span> <span class="pre">-v</span></code></p></td> |
| <td></td> |
| </tr> |
| <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--all</span></code></p></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| </section> |
| <section id="nxdiag-specific-configuration-settings"> |
| <span id="nxdiagconfiguration"></span><h2>Nxdiag-Specific Configuration Settings<a class="headerlink" href="#nxdiag-specific-configuration-settings" title="Permalink to this heading"></a></h2> |
| <p>The behavior of Nxdiag can be modified with the following settings in the |
| <code class="docutils literal notranslate"><span class="pre">boards/<arch>/<chip>/<board>/defconfig</span></code> file:</p> |
| <table class="docutils align-default"> |
| <thead> |
| <tr class="row-odd"><th class="head"><p>Configuration</p></th> |
| <th class="head"><p>Description</p></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">CONFIG_SYSTEM_NXDIAG_COMP_FLAGS</span></code></p></td> |
| <td><p>Enable the nxdiag application to list the NuttX compilation |
| flags. This is useful for debugging the host and target |
| systems. Enables the <code class="docutils literal notranslate"><span class="pre">-f</span></code> and <code class="docutils literal notranslate"><span class="pre">--nuttx-flags</span></code> options.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">CONFIG_SYSTEM_NXDIAG_CONF</span></code></p></td> |
| <td><p>Enable the nxdiag application to list the configuration options |
| used to compile NuttX. This is useful for debugging the host and |
| target systems. Enables the <code class="docutils literal notranslate"><span class="pre">-c</span></code> and <code class="docutils literal notranslate"><span class="pre">--nuttx-config</span></code> options.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">CONFIG_SYSTEM_NXDIAG_HOST_PATH</span></code></p></td> |
| <td><p>Enable the nxdiag application to list the host system PATH |
| variable. This is useful for debugging the host system. |
| Enables the <code class="docutils literal notranslate"><span class="pre">-p</span></code> and <code class="docutils literal notranslate"><span class="pre">--host-path</span></code> options.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">CONFIG_SYSTEM_NXDIAG_HOST_PACKAGES</span></code></p></td> |
| <td><p>Enable the nxdiag application to list the installed packages |
| on the host system. This is useful for debugging the host |
| system. Enables the <code class="docutils literal notranslate"><span class="pre">-k</span></code> and <code class="docutils literal notranslate"><span class="pre">--host-packages</span></code> options.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">CONFIG_SYSTEM_NXDIAG_HOST_MODULES</span></code></p></td> |
| <td><p>Enable the nxdiag application to list the installed Python |
| modules on the host system. This is useful for debugging the |
| host system. Enables the <code class="docutils literal notranslate"><span class="pre">-m</span></code> and <code class="docutils literal notranslate"><span class="pre">--host-modules</span></code> options.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">CONFIG_SYSTEM_NXDIAG_ESPRESSIF</span></code></p></td> |
| <td><p>Enable Espressif-specific information and checks.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </section> |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="index.html" class="btn btn-neutral float-left" title="NuttX Diagnostic Tool (Nxdiag)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="../wapi/index.html" class="btn btn-neutral float-right" title="WAPI (Wireless API)" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright 2020, The Apache Software Foundation.</p> |
| </div> |
| |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
