cederom opened a new pull request, #18970: URL: https://github.com/apache/nuttx/pull/18970
## Summary * 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. ## Impact Documentation parts from cwiki (https://cwiki.apache.org/confluence/display/NUTTX/Wiki) is preserved into our new in-tree sphinx based documentation. ## Testing ``` % uname -a FreeBSD hexagon 14.4-RELEASE-p5 FreeBSD 14.4-RELEASE-p5 GENERIC amd64 % cd nuttx.git/Documentation % pipenv shell % sphinx-autobuild --delay=15 . /tmp/nuttx/doc/html [sphinx-autobuild] > python -m sphinx build . /tmp/nuttx/doc/html Running Sphinx v7.3.7 loading pickled environment... done myst v3.0.1: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions=set(), disable_syntax=[], all_links_external=False, links_external_new_tab=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={}, footnote_transition=True, words_per_minute=200, substitutions={}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True) Tags updated building [mo]: targets for 0 po files that are out of date writing output... building [html]: targets for 146 source files that are out of date updating environment: 0 added, 146 changed, 0 removed reading sources... [100%] _tags/wifi looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done copying downloadable files... [ 25%] components/drivers/special/usbmonitor_wireshark_l copying downloadable files... [100%] platforms/xtensa/esp32s2/boards/esp32s2-saola-1/tone.wav copying static files... done copying extra files... done done writing output... [100%] index generating indices... genindex done writing additional pages... search done dumping search index in English (code: en)... done dumping object inventory... done WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\. c:.*:: net_driver_s'.* WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\. c:.*::.*sigaction.* WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\. c:.*::.*open.* WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\. c:.*::.*close.* WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\. c:.*::.*read.* WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\. c:.*::.*write.* WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\. c:.*::.*ioctl.* WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\. c:.*::.*mmap.* WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\. c:.*::.*poll.* WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\. c:.*::.*dup.* WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\. c:.*::.*rewinddir.* WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\. c:.*::.*bind.* WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\. c:.*::.*unlink.* build succeeded. The HTML pages are in ../../../../../../../../../../tmp/nuttx/doc/html. [sphinx-autobuild] Serving on http://127.0.0.1:8000 ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
