nuttx/Documentation/guides/index.rst

.. todo::
  Create "tutorial" type documentation for specific subjects not to be covered in more general terms.

======
Guides
======

.. toctree::
  nfs.rst
  usbtrace.rst
  simulator.rst
  qemugdb.rst
  rndis.rst
  drivers.rst
  tasktrace.rst
  cpp_cmake.rst
  pysimcoder.rst
  customboards.rst
  customapps.rst
  citests.rst
  zerolatencyinterrupts.rst
  nestedinterrupts.rst
  cortexmhardfaults.rst
  coredump.rst
  minidumpserver.rst
  gdbwithpython.rst
  ofloader.rst
  testingtcpip.rst
  automounter.rst
  stm32nullpointer.rst
  stm32ccm.rst
  stackrecord.rst
convert TODOs to actual TODO banner and improve general presentation of different sections 2020-08-15 23:10:25 +02:00			`.. todo::`
			`Create "tutorial" type documentation for specific subjects not to be covered in more general terms.`

Documentation: various cosmetic changes 2023-10-29 16:40:32 +01:00			`======`
sphinx doc 2020-07-21 00:18:26 +02:00			`Guides`
			`======`

			`.. toctree::`
			`nfs.rst`
			`usbtrace.rst`
add sim and drivers guides, contributing workflow 2020-08-31 02:48:30 +02:00			`simulator.rst`
doc: Add guide how to use QEMU and GDB to debug NuttX This guide is based on steps from this issue: https://github.com/apache/nuttx/issues/8616 2023-02-25 16:55:06 +01:00			`qemugdb.rst`
doc: Add USB RNDIS tutorial to documentation. 2023-01-28 22:43:18 +01:00			`rndis.rst`
add sim and drivers guides, contributing workflow 2020-08-31 02:48:30 +02:00			`drivers.rst`
Add documentation for note filters and task trace guides 2020-10-09 02:07:10 +02:00			`tasktrace.rst`
Adding example to build cmake projects in NuttX Section adjustments Update Documentation/guides/cpp_cmake.rst Co-authored-by: Matias N. <v01d@users.noreply.github.com> Update Documentation/guides/cpp_cmake.rst Co-authored-by: Matias N. <v01d@users.noreply.github.com> Update Documentation/guides/cpp_cmake.rst Co-authored-by: Matias N. <v01d@users.noreply.github.com> Update Documentation/guides/cpp_cmake.rst Co-authored-by: Matias N. <v01d@users.noreply.github.com> Update Documentation/guides/cpp_cmake.rst Co-authored-by: Matias N. <v01d@users.noreply.github.com> Update Documentation/guides/cpp_cmake.rst Co-authored-by: Matias N. <v01d@users.noreply.github.com> Reviewed introduction to the document Add the motivation for writing the document. Update Documentation/guides/cpp_cmake.rst Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com> Update Documentation/guides/cpp_cmake.rst Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com> Update Documentation/guides/cpp_cmake.rst Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com> Update Documentation/guides/cpp_cmake.rst Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com> Update Documentation/guides/cpp_cmake.rst Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com> Adding caption and name for files Correcting caption Update Documentation/guides/cpp_cmake.rst Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com> Update Documentation/guides/cpp_cmake.rst Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com> test: Separating the file from the document Revert "test: Separating the file from the document" This reverts commit beec4788bdb574d9c99f1817b7ffe6e90a18fe46. Removing captions Update Documentation/guides/cpp_cmake.rst Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com> Update Documentation/guides/cpp_cmake.rst Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com> 2021-03-21 16:07:09 +01:00			`cpp_cmake.rst`
Documentation: add guide for pysimCoder integration with NuttX This commit adds documentation for compiling NuttX for pysimCoder and then running pysimCoder designed applications on NuttX. PysimCoder is a Rapid Control Application Development Tool that can transfer block diagrams into C code and can be used in real time control applications. Signed-off-by: Michal Lenc <michallenc@seznam.cz> 2021-08-03 14:04:09 +02:00			`pysimcoder.rst`
Documentation for Custom Boards and Apps 2022-10-12 17:53:04 +02:00			`customboards.rst`
			`customapps.rst`
docs: add description about local CI tests This page adds description how to run CI tests locally. Signed-off-by: Michal Lenc <michallenc@seznam.cz> 2023-10-17 08:48:15 +02:00			`citests.rst`
Documentation: Improve "High Performance, Zero Latency Interrupts" * Documentation/guides/zerolatencyinterrupts.rst: Add paragraph that defines jitter. Fix a few minor typos. Fix incorrect reStructuredText formatting for bulletpoints (they were being rendered like 2nd level bulletpoints). * Documentation/guides/index.rst: Add zerolatencyinterrupts.rst to the TOC, which I forgot to do in PR # 9302. 2023-05-18 23:57:02 +02:00			`zerolatencyinterrupts.rst`
Documentation: Import Nested Interrupts page from CWIKI * Documentation/guides/nestedinterrupts.rst: New. Imported from [1] and converted from CWIKI to reStructuredText. * Documentation/guides/index.rst: Link to the new page. * Documentation/guides/zerolatencyinterrupts.rst: Replace link to the CWIKI Nested Interrupts page with link to the above. [1] https://cwiki.apache.org/confluence/display/NUTTX/Nested+Interrupts 2023-05-19 16:22:04 +02:00			`nestedinterrupts.rst`
Documentation: Import "Analyzing Cortex-M Hardfaults" from CWIKI * Documentation/guides/cortexmhardfaults.rst: New. Migrated from [1] with conversion to reStructuredText, minor typo fixes, and a link to a Narkive archive of the original quoted question. * Documentation/guides/index.rst: Add above to TOC. [1] https://cwiki.apache.org/confluence/display/NUTTX/Analyzing+Cortex-M+Hardfaults 2023-05-24 20:28:31 +02:00			`cortexmhardfaults.rst`
Documentation/coredump: add coredump chapter Signed-off-by: chao an <anchao@xiaomi.com> 2023-05-25 06:20:25 +02:00			`coredump.rst`
Added minidumpserver into index 2023-08-22 14:15:59 +02:00			`minidumpserver.rst`
Documentation:Add documentation related to gdb python script debugging Signed-off-by: anjiahao <anjiahao@xiaomi.com> 2023-06-20 14:36:19 +02:00			`gdbwithpython.rst`
ofloader:add Documentation for ofloader Signed-off-by: anjiahao <anjiahao@xiaomi.com> 2023-08-03 05:18:56 +02:00			`ofloader.rst`
Documentation: migrate "Testing TCP/IP Network Stacks" from wiki link: https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139629530 2023-11-05 10:30:50 +01:00			`testingtcpip.rst`
Documentation: migrate "Auto-Mounter" from wiki link: https://cwiki.apache.org/confluence/display/NUTTX/Auto-Mounter 2023-11-06 15:47:06 +01:00			`automounter.rst`
Documentation: migrate "STM32 Null Pointer Detection" from wiki link: https://cwiki.apache.org/confluence/display/NUTTX/STM32+Null+Pointer+Detection Co-authored-by: hartmannathan <59230071+hartmannathan@users.noreply.github.com> 2023-11-07 18:44:39 +01:00			`stm32nullpointer.rst`
Documentation: migrate "STM32 CCM Allocator" from wiki link: https://cwiki.apache.org/confluence/display/NUTTX/STM32+CCM+Allocator Co-authored-by: hartmannathan <59230071+hartmannathan@users.noreply.github.com> 2023-11-07 18:51:57 +01:00			`stm32ccm.rst`
Documentation:add Documentation for stack statistics Signed-off-by: anjiahao <anjiahao@xiaomi.com> 2023-10-25 16:30:26 +02:00			`stackrecord.rst`