2020-09-05 05:00:59 +08:00
.. include :: /substitutions.rst
.. _configuring:
Configuring
===========
2020-12-06 10:24:34 +08:00
Apache NuttX is a very configurable: 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.
2020-09-05 05:00:59 +08:00
The Apache NuttX configuration system uses Linux's
2020-11-22 06:55:16 +08:00
`kconfig system <https://www.kernel.org/doc/Documentation/kbuild/kconfig-language.txt> `_ which
includes various frontends that allow you to modify configuration easily. Usually, the `` menuconfig ``
frontend is used, which is a console based menu system (more info `here <https://en.wikipedia.org/wiki/Menuconfig> `_ ).
2020-09-05 05:00:59 +08:00
2020-11-22 06:55:16 +08:00
As previously explained in :doc: `compiling` , the first step is to load a premade configuration for
2020-12-06 10:24:34 +08:00
your board. Then, you can modify this configuration to your liking. In this example, we will show
how you modify the default configuration of the `` sim `` build, a build of NuttX which runs on your own
computer.
2020-09-05 05:00:59 +08:00
2020-11-22 06:55:16 +08:00
#. Initialize Board Configuration
2020-09-05 05:00:59 +08:00
2020-11-22 06:55:16 +08:00
.. code-block :: console
2020-09-05 05:00:59 +08:00
$ cd nuttx
$ ./tools/configure.sh -l sim:nsh
Copy files
Select CONFIG_HOST_LINUX=y
Refreshing...
2020-11-22 06:55:16 +08:00
#. Build & run
2020-09-05 05:00:59 +08:00
2020-11-22 06:55:16 +08:00
.. code-block :: console
2020-09-05 05:00:59 +08:00
$ make clean; make
$ ./nuttx
login:
From another terminal window, kill the simulator:
2020-11-22 06:55:16 +08:00
.. code-block :: console
2020-09-05 05:00:59 +08:00
$ pkill nuttx
2020-11-22 06:55:16 +08:00
#. Modify configuration
2020-09-05 05:00:59 +08:00
2020-11-22 06:55:16 +08:00
In this case we will remove the login feature (which will boot straight to the prompt). To
do so, we use the `` menuconfig `` frontend.
2020-09-05 05:00:59 +08:00
2020-11-22 06:55:16 +08:00
.. code-block :: console
2020-09-05 05:00:59 +08:00
$ make menuconfig
Here's what you should see:
2020-09-06 02:57:54 +08:00
.. image :: ../_static/images/menuconfig.png
2020-09-05 05:00:59 +08:00
:width: 800px
:align: center
:alt: Screenshot of menuconfig system main screen
|br|
2020-11-22 06:55:16 +08:00
The NSH Login setting is under :menuselection: `Application Configuration --> NSH Library` . You
can use :kbd: `🢁` and :kbd: `🢃` keys to navigate and :kbd: `↵` to enter a submenu.
To disable the corresponding setting go to :menuselection: `Console Login` and press :kbd: `spacebar` to
it (so that it has a blank space instead of a star in it).
2020-09-05 05:00:59 +08:00
2020-11-22 06:55:16 +08:00
Now you need to exit `` menuconfig `` and save the modified configuration. Use the :kbd: `🡸` and
:kbd: `🡺` arrow keys to navigate the lower menu. If you select :menuselection: `Exit` you will be
prompted to save the config.
2020-09-05 05:00:59 +08:00
2020-11-22 06:55:16 +08:00
#. Build with the new Configuration
2020-09-05 05:00:59 +08:00
2020-11-22 06:55:16 +08:00
.. code-block :: console
2020-09-05 05:00:59 +08:00
2020-11-22 06:55:16 +08:00
$ make
2020-09-05 05:00:59 +08:00
#. Run
2020-11-22 06:55:16 +08:00
.. code-block :: console
2020-09-05 05:00:59 +08:00
$ ./nuttx
NuttShell (NSH) NuttX-8.2
MOTD: username=admin password=Administrator
Success!
2020-11-22 06:55:16 +08:00
.. tip ::
2020-09-05 05:00:59 +08:00
If you find that message of the day (MOTD) annoying and want to turn that off, it's
2020-11-22 06:55:16 +08:00
configured in :menuselection: `Application Configuration --> NSH Library --> Message of the Day (MOTD)` .
Fast configuration changes
--------------------------
If you know exactly which configuration symbol you want to change, you can use the `` kconfig-tweak `` tool (comes with the `` kconfig-frontends `` package) to quickly change a setting without going into the configuration frontend. This is useful to change settings such as debug options:
.. code-block :: console
$ kconfig-tweak --disable CONFIG_DEBUG_NET
$ make olddefconfig # needed to have the kconfig system check the config
$ kconfig-tweak --enable CONFIG_DEBUG_NET
$ make olddefconfig
This is also useful to script configuration changes that you perform often:
2020-12-06 10:24:34 +08:00
.. code-block :: bash
2020-11-22 06:55:16 +08:00
#!/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
make oldconfig
