sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
8665acaffa
nuttx/Documentation/quickstart/compiling.rst

76 lines
2.1 KiB
ReStructuredText
Raw Normal View History

add quickstart docs from NuttX Companion - with suggested edits from PR feedback
2020-09-04 23:00:59 +02:00
.. include:: /substitutions.rst
.. _compiling:
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
=========
add quickstart docs from NuttX Companion - with suggested edits from PR feedback
2020-09-04 23:00:59 +02:00
Compiling
=========
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
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.
add quickstart docs from NuttX Companion - with suggested edits from PR feedback
2020-09-04 23:00:59 +02:00
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
Initialize Configuration
========================
add quickstart docs from NuttX Companion - with suggested edits from PR feedback
2020-09-04 23:00:59 +02:00
Changed "based from" to "based on" in compiling.rst
2023-08-22 14:06:52 +02:00
The first step is to initialize NuttX configuration for a given board, based on
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
a pre-existing configuration. To list all supported configurations you can do:
add quickstart docs from NuttX Companion - with suggested edits from PR feedback
2020-09-04 23:00:59 +02:00
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
.. code-block:: console
add quickstart docs from NuttX Companion - with suggested edits from PR feedback
2020-09-04 23:00:59 +02:00
$ cd nuttx
$ ./tools/configure.sh -L | less
Documentation: Remove all tail spaces from *.rst and *.html by the below command: find . -type f -name '*.rst' -exec sed --in-place 's/[[:space:]]\+$//' {} \+ Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 18:48:44 +02:00
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
The output is in the format ``<board name>:<board configuration>``. You will see that
Documentation: Fix a few typos. * Documentation/contributing/documentation.rst * Documentation/guides/tasktraceuser.rst * Documentation/guides/drivers.rst * Documentation/quickstart/running.rst * Documentation/quickstart/compiling.rst * Documentation/components/drivers/character/watchdog.rst * Documentation/components/drivers/character/foc.rst * Documentation/components/nxgraphics/nxtk.rst * Documentation/applications/nsh/login.rst * Documentation/introduction/detailed_support.rst * Documentation/introduction/resources.rst * Documentation/reference/user/01_task_control.rst * Documentation/reference/os/wqueue.rst Fix some misspelled words. Many of these were caught by codespell.
2021-04-28 21:14:44 +02:00
generally all boards support the ``nsh`` configuration which is a good starting point
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
since it enables booting into the interactive command line
Docs: Fix broken links and references in docs Also add to the CI a problem matcher to better report issues Signed-off-by: Brennan Ashton <bashton@brennanashton.com>
2020-10-20 10:40:45 +02:00
:doc:`/applications/nsh/index`.
add quickstart docs from NuttX Companion - with suggested edits from PR feedback
2020-09-04 23:00:59 +02:00
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
To choose a configuration you pass the ``<board name>:<board configuration>`` option
to ``configure.sh`` and indicate your host platform, such as:
add quickstart docs from NuttX Companion - with suggested edits from PR feedback
2020-09-04 23:00:59 +02:00
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
.. code-block:: console
add quickstart docs from NuttX Companion - with suggested edits from PR feedback
2020-09-04 23:00:59 +02:00
$ cd nuttx
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
$ ./tools/configure.sh -l stm32f4discovery:nsh
Documentation: Remove all tail spaces from *.rst and *.html by the below command: find . -type f -name '*.rst' -exec sed --in-place 's/[[:space:]]\+$//' {} \+ Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 18:48:44 +02:00
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
The ``-l`` tells use that we're on Linux (macOS and Windows builds are
possible). Use the ``-h`` argument to see all available options.
Documentation: various improvements to quickstart section
2020-11-21 23:55:16 +01:00
You can then customize this configuration by using the menu based
configuration system with:
add quickstart docs from NuttX Companion - with suggested edits from PR feedback
2020-09-04 23:00:59 +02:00
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
.. code-block:: console
add quickstart docs from NuttX Companion - with suggested edits from PR feedback
2020-09-04 23:00:59 +02:00
[docs] eliminate potential misunderstandings
2022-03-16 18:08:00 +01:00
$ cd nuttx
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
$ make menuconfig
Documentation: Fix a few typos. * Documentation/contributing/documentation.rst * Documentation/guides/tasktraceuser.rst * Documentation/guides/drivers.rst * Documentation/quickstart/running.rst * Documentation/quickstart/compiling.rst * Documentation/components/drivers/character/watchdog.rst * Documentation/components/drivers/character/foc.rst * Documentation/components/nxgraphics/nxtk.rst * Documentation/applications/nsh/login.rst * Documentation/introduction/detailed_support.rst * Documentation/introduction/resources.rst * Documentation/reference/user/01_task_control.rst * Documentation/reference/os/wqueue.rst Fix some misspelled words. Many of these were caught by codespell.
2021-04-28 21:14:44 +02:00
Documentation: various improvements to quickstart section
2020-11-21 23:55:16 +01:00
Modifying the configuration is covered in :doc:`configuring`.
add quickstart docs from NuttX Companion - with suggested edits from PR feedback
2020-09-04 23:00:59 +02:00
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
Build NuttX
===========
add quickstart docs from NuttX Companion - with suggested edits from PR feedback
2020-09-04 23:00:59 +02:00
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
We can now build NuttX. To do so, you can simply run:
add quickstart docs from NuttX Companion - with suggested edits from PR feedback
2020-09-04 23:00:59 +02:00
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
.. code-block:: console
add quickstart docs from NuttX Companion - with suggested edits from PR feedback
2020-09-04 23:00:59 +02:00
[docs] eliminate potential misunderstandings
2022-03-16 18:08:00 +01:00
$ cd nuttx
Documentation: various improvements to quickstart section
2020-11-21 23:55:16 +01:00
$ make
Documentation: Remove all tail spaces from *.rst and *.html by the below command: find . -type f -name '*.rst' -exec sed --in-place 's/[[:space:]]\+$//' {} \+ Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 18:48:44 +02:00
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
The build will complete by generating the binary outputs
Documentation: various improvements to quickstart section
2020-11-21 23:55:16 +01:00
inside ``nuttx`` directory. Typically this includes the ``nuttx``
ELF file (suitable for debugging using ``gdb``) and a ``nuttx.bin``
Documentation: Remove all tail spaces from *.rst and *.html by the below command: find . -type f -name '*.rst' -exec sed --in-place 's/[[:space:]]\+$//' {} \+ Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 18:48:44 +02:00
file that can be flashed to the board.
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
To clean the build, you can do:
add quickstart docs from NuttX Companion - with suggested edits from PR feedback
2020-09-04 23:00:59 +02:00
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
.. code-block:: console
add quickstart docs from NuttX Companion - with suggested edits from PR feedback
2020-09-04 23:00:59 +02:00
documentation: work on quickstart, add tabs sphinx extension
2020-09-11 23:55:50 +02:00
$ make clean
Documentation: Fix a few typos. * Documentation/contributing/documentation.rst * Documentation/guides/tasktraceuser.rst * Documentation/guides/drivers.rst * Documentation/quickstart/running.rst * Documentation/quickstart/compiling.rst * Documentation/components/drivers/character/watchdog.rst * Documentation/components/drivers/character/foc.rst * Documentation/components/nxgraphics/nxtk.rst * Documentation/applications/nsh/login.rst * Documentation/introduction/detailed_support.rst * Documentation/introduction/resources.rst * Documentation/reference/user/01_task_control.rst * Documentation/reference/os/wqueue.rst Fix some misspelled words. Many of these were caught by codespell.
2021-04-28 21:14:44 +02:00
Documentation: merge quickstart with the rest of "getting started"
2020-12-06 03:24:34 +01:00
.. tip::
Documentation: Remove all tail spaces from *.rst and *.html by the below command: find . -type f -name '*.rst' -exec sed --in-place 's/[[:space:]]\+$//' {} \+ Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 18:48:44 +02:00
Documentation: merge quickstart with the rest of "getting started"
2020-12-06 03:24:34 +01:00
To increase build speed (or of any other target such as ``clean``), you can
pass the ``-jN`` flag to ``make``, where ``N`` is the number of parallel jobs
to start (usually, the number of processors on your machine).
add quickstart docs from NuttX Companion - with suggested edits from PR feedback
2020-09-04 23:00:59 +02:00
Reference in New Issue Copy Permalink