nuttx/Documentation/implementation/index.rst

======================
Implementation Details
======================

.. toctree::
   :maxdepth: 1

   chip_h.rst
   hardfaults.rst
   make_build_system.rst
   naming_arch_mcu_board_interfaces.rst
   naming_os_internals.rst
   nuttx_initialization_sequence.rst
   simulation.rst
Documentation: migrate "Linux Processes vs NuttX Tasks" from wiki link: https://cwiki.apache.org/confluence/display/NUTTX/Linux+Processes+vs+NuttX+Tasks 2023-11-04 20:41:19 +01:00			`======================`
			`Implementation Details`
			`======================`

			`.. toctree::`
Documentation: brand new layout for NuttX documentation. The documentation grew one page at a time, so the tree follows the history of who wrote what and not the shape of NuttX. Scheduling is spread over three places, a driver page can sit above the subsystem that owns it, and the front page lists everything at the same level. That is a lot to face when all you want to know is where the scheduler lives. This change files every page under the code it describes. It is a move, not a rewrite: outside the ten pages named below, every page keeps the text that is already in master, and no page's text is deleted. What it does: * Groups the table of contents into nine chapters. * Moves the OS subsystems under os/: scheduling, memory, drivers, filesystem, networking, IPC, interrupts, libs, time. * Renames the platform pages to the names the source tree uses, and derives their tags from the tree instead of by hand. * Splits guides/ by subject. * Adds Documentation/redirects.py, with a rule for every page that left its old path, so old URLs keep working. The redirect page also carries a link's #anchor across to the new page. Ten pages have text that is new or rewritten. Nine of them are the landing page of a chapter, which has to exist for the new structure: index the front page os/index OS Design os/scheduling/index Scheduling os/interrupts/index Interrupts os/ipc/index IPC os/time/index Time and timers about/index About developing/index Developing NuttX ReleaseNotes/index Release notes The tenth is os/libs/libbuiltin, the only page here with technical content: libs/libbuiltin/ had no page at all. Five SVG diagrams come with these pages, hand-written XML with no editor metadata. Nothing outside Documentation/ is touched. How it was checked: * Sphinx builds with -W: no warnings, and no document left outside a toctree. * A script, offered in the PR, proves the narrow claim this rests on. For every page outside the ten named above it erases what a move touches -- link target, path, tag line, toctree block, table border -- from the whole old text and the whole new text, and requires the two to be byte for byte identical. It also requires every sentence of a deleted page to turn up somewhere, and every page that left its old path to have a redirect, from a URL that existed, to where its content went. It exits non-zero and names the page if any of that is not true, and it tests added pages too, so forgetting to declare one cannot make it pass. * An independent audit checked 133 factual claims on these ten pages against the tree, one shell command per claim: 130 confirmed, 1 refuted and fixed here, 2 not checkable. * tools/checkpatch.sh is clean over the range. The diff is large because moving a page changes every link that points to it. Most of it is pure renames, and board pages that gained one tag line. Assisted-by: Claude:claude-opus-5 2026-09-30 17:55:03 +02:00			`:maxdepth: 1`

doc: Migrating the rest of documentation from cwiki. * This completes task list in https://github.com/apache/nuttx/issues/11127. * This preserves selected content from cwiki and moves it to new docs. * Most pages are simple copy-paste with a simple RST formatting updates, with minor updates. * Content update / reorganization will follow later on when needed. * Files added (or updated title from cwiki -> current docs): * Documentation/implementation: * index. * cancellation_points. * Asynchronous vs. Synchronous Context Switches -> context_switches.rst. * ARMv7-M Hardfaults, SVCALL, and Debuggers -> hardfatuls.rst. * chip.h FAQ -> chip_h.rst. * Debug Output (SYSLOG) Issues -> syslog.rst. * Detaching File Descriptors -> file_descriptors.rst. * device_nodes.rst. * Dynamic Clocking -> power_management.rst. * ENOTTY ioctl() Return Value -> ioctl.rst. * memory_configurations.rst. * kernel_modules_vs_shared_libraries.rst. * NAKing USB OUT/IN Tokens -> usb.rst. * naming_arch_mcu_board_interfaces.rst. * naming_os_internals.rst. * nuttx_tasking.rst. * oneshot_timers_and_cpu_load.rst. * nuttx_initialization_sequence.rst. * short_time_delays.rst. * Signal Handler Tour -> signal_handlers.rst. * smp.rst. * syslog.rst. * Task Exit Sequence -> nuttx_tasking.rst. * tasks_vs_threads.rst. * tls.rst. * tickless_os.rst. * Why Can't Kernel Threads Have pthreads -> kernel_threads_vs_pthreads.rst. * Documentation/components/filesystem: * smartfs.rst. Signed-off-by: Tomasz 'CeDeROM' CEDRO <tomek@cedro.info> 2026-05-16 13:54:41 +02:00			`chip_h.rst`
			`hardfaults.rst`
			`make_build_system.rst`
			`naming_arch_mcu_board_interfaces.rst`
			`naming_os_internals.rst`
			`nuttx_initialization_sequence.rst`
doc: Add NuttX Simulation page from Confluence 2024-09-08 19:19:00 -03:00			`simulation.rst`