nuttx/Documentation/components/index.rst

=============
OS Components
=============

NuttX is very feature-rich RTOS and is thus composed of various different
subsystems. The following sections explain how each of these main RTOS components
work and can be used. For detailed documentation on the specific API used in this
case, you can head to the :doc:`reference <../reference/index>`.

.. toctree::
   :maxdepth: 2
   :caption: Contents:
   
   binfmt.rst
   concurrency/index.rst
   iterable_sections.rst
   drivers/index.rst
   nxflat.rst
   nxgraphics/index.rst
   paging.rst
   audio/index.rst
   filesystem/index.rst
   libs/index.rst
   net/index.rst
   mm/index.rst
   syscall.rst
   tools/index.rst
   arch/index.rst
   boards.rst
   cmake.rst
   openamp.rst
   video.rst
   crypto.rst
   wireless.rst
Documentation: add dummy pages for missing filesystems and drivers 2023-10-27 12:57:14 +02:00			`=============`
sphinx doc 2020-07-20 19:18:26 -03:00			`OS Components`
			`=============`

Documentation: cosmetics changes - various style fixes - limit the line length to about 80 characters to improve readability in terminal-based IDEs 2023-10-26 13:10:13 +02:00			`NuttX is very feature-rich RTOS and is thus composed of various different`
			`subsystems. The following sections explain how each of these main RTOS components`
			`work and can be used. For detailed documentation on the specific API used in this`
			case, you can head to the :doc:`reference <../reference/index>`.
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-19 00:48:44 +08:00
sphinx doc 2020-07-20 19:18:26 -03:00			`.. toctree::`
			`:maxdepth: 2`
			`:caption: Contents:`

			`binfmt.rst`
Documentation: Add documentation for seqcount. This commit added ducumentation for seqcount. Signed-off-by: ouyangxiangzhen <ouyangxiangzhen@xiaomi.com> 2025-12-22 09:44:34 +08:00			`concurrency/index.rst`
include/nuttx: Add link-time iterable sections infrastructure Add generic support for link-time registration of struct instances, modeled after the Zephyr STRUCT_SECTION_* mechanism: - include/nuttx/iterable_sections.h: STRUCT_SECTION_ITERABLE/DECLARE/ FOREACH/GET/COUNT macros placing instances in name-sorted linker sections delimited by _<type>_list_start/_end symbols (attributes through the nuttx/compiler.h macros; FOREACH takes a caller-declared iterator, like list_for_every_entry). - include/nuttx/linker/iterable_sections.ld: ITERABLE_SECTION() macro emitting the KEEP + SORT_BY_NAME collection statements (linker scripts in ARCHSCRIPT are CPP-preprocessed). - include/nuttx/linker/common-rom.ld / common-ram.ld: central aggregators meant to be included by board linker scripts (inside .text and .data respectively); subsystems register their sections here guarded by their Kconfig options, so the fragments expand to nothing on configurations that do not use them. - CONFIG_ITERABLE_SECTIONS_LINKER_INSERT + include/nuttx/linker/ common-insert.ld (added before the board script by tools/Config.mk and by the top-level CMakeLists.txt): optional zero-touch mode that supplements the board script through GNU ld INSERT AFTER, collecting the subsystems' ITERABLE_SECTION blocks in one output section; the common-rom.ld/common-ram.ld fragments expand to nothing in that mode. See the option help for the constraints. - Documentation/components/iterable_sections.rst. First user: the Zephyr zbus message bus port (apps/system/zbus in nuttx-apps); its board integration comes in a companion PR. Signed-off-by: Jorge Guzman <jorge.gzm@gmail.com> 2026-08-21 14:24:11 -03:00			`iterable_sections.rst`
sphinx doc 2020-07-20 19:18:26 -03:00			`drivers/index.rst`
			`nxflat.rst`
			`nxgraphics/index.rst`
			`paging.rst`
Documentation: migrate /audio 2023-10-25 15:20:40 +02:00			`audio/index.rst`
Documentation: migrate /fs 2023-10-25 15:21:20 +02:00			`filesystem/index.rst`
Documentation: migrate /libs 2023-10-25 15:21:50 +02:00			`libs/index.rst`
Documentation: migrate /net 2023-10-25 15:22:15 +02:00			`net/index.rst`
Documentation: migrate /mm 2023-10-25 15:22:48 +02:00			`mm/index.rst`
Documentation: migrate /syscall 2023-10-25 15:23:21 +02:00			`syscall.rst`
Documentation: migrate /tools 2023-10-25 15:26:30 +02:00			`tools/index.rst`
Documentation: migrate /arch 2023-10-25 15:26:43 +02:00			`arch/index.rst`
Documentation: migrate the rest boards - migrated /README are removed from /boards - there are a lot of READMEs that should be further converted to rst. At the moment they are moved to Documentation/platforms and included in rst files 2023-10-25 20:28:04 +02:00			`boards.rst`
Documentation: add dummy pages for missing top directories crypto, openamp, video and wireless 2023-10-27 11:39:30 +02:00			`cmake.rst`
			`openamp.rst`
			`video.rst`
			`crypto.rst`
			`wireless.rst`