diff --git a/Documentation/guides/coredump.rst b/Documentation/debugging/coredump.rst similarity index 100% rename from Documentation/guides/coredump.rst rename to Documentation/debugging/coredump.rst diff --git a/Documentation/guides/coresight.rst b/Documentation/debugging/coresight.rst similarity index 100% rename from Documentation/guides/coresight.rst rename to Documentation/debugging/coresight.rst diff --git a/Documentation/guides/cortexmhardfaults.rst b/Documentation/debugging/cortexmhardfaults.rst similarity index 100% rename from Documentation/guides/cortexmhardfaults.rst rename to Documentation/debugging/cortexmhardfaults.rst diff --git a/Documentation/guides/debugging_elf_loadable_modules.rst b/Documentation/debugging/debugging_elf_loadable_modules.rst similarity index 100% rename from Documentation/guides/debugging_elf_loadable_modules.rst rename to Documentation/debugging/debugging_elf_loadable_modules.rst diff --git a/Documentation/guides/debuggingflash_nuttxonarm.rst b/Documentation/debugging/debuggingflash_nuttxonarm.rst similarity index 100% rename from Documentation/guides/debuggingflash_nuttxonarm.rst rename to Documentation/debugging/debuggingflash_nuttxonarm.rst diff --git a/Documentation/guides/disabling_stackdumpdebug.rst b/Documentation/debugging/disabling_stackdumpdebug.rst similarity index 100% rename from Documentation/guides/disabling_stackdumpdebug.rst rename to Documentation/debugging/disabling_stackdumpdebug.rst diff --git a/Documentation/guides/gdb/irqinfo.rst b/Documentation/debugging/gdb/irqinfo.rst similarity index 100% rename from Documentation/guides/gdb/irqinfo.rst rename to Documentation/debugging/gdb/irqinfo.rst diff --git a/Documentation/guides/gdbserver.rst b/Documentation/debugging/gdbserver.rst similarity index 100% rename from Documentation/guides/gdbserver.rst rename to Documentation/debugging/gdbserver.rst diff --git a/Documentation/guides/gdbwithpython.rst b/Documentation/debugging/gdbwithpython.rst similarity index 100% rename from Documentation/guides/gdbwithpython.rst rename to Documentation/debugging/gdbwithpython.rst diff --git a/Documentation/guides/image/coredump-gdb.png b/Documentation/debugging/image/coredump-gdb.png similarity index 100% rename from Documentation/guides/image/coredump-gdb.png rename to Documentation/debugging/image/coredump-gdb.png diff --git a/Documentation/guides/image/coredump-hexdump.png b/Documentation/debugging/image/coredump-hexdump.png similarity index 100% rename from Documentation/guides/image/coredump-hexdump.png rename to Documentation/debugging/image/coredump-hexdump.png diff --git a/Documentation/guides/image/coredump-overview.png b/Documentation/debugging/image/coredump-overview.png similarity index 100% rename from Documentation/guides/image/coredump-overview.png rename to Documentation/debugging/image/coredump-overview.png diff --git a/Documentation/guides/image/syscall-flat-after.png b/Documentation/debugging/image/syscall-flat-after.png similarity index 100% rename from Documentation/guides/image/syscall-flat-after.png rename to Documentation/debugging/image/syscall-flat-after.png diff --git a/Documentation/guides/image/syscall-flat-before.png b/Documentation/debugging/image/syscall-flat-before.png similarity index 100% rename from Documentation/guides/image/syscall-flat-before.png rename to Documentation/debugging/image/syscall-flat-before.png diff --git a/Documentation/guides/image/syscall-protected-after.png b/Documentation/debugging/image/syscall-protected-after.png similarity index 100% rename from Documentation/guides/image/syscall-protected-after.png rename to Documentation/debugging/image/syscall-protected-after.png diff --git a/Documentation/guides/image/syscall-protected-before.png b/Documentation/debugging/image/syscall-protected-before.png similarity index 100% rename from Documentation/guides/image/syscall-protected-before.png rename to Documentation/debugging/image/syscall-protected-before.png diff --git a/Documentation/guides/image/task-trace-internal.png b/Documentation/debugging/image/task-trace-internal.png similarity index 100% rename from Documentation/guides/image/task-trace-internal.png rename to Documentation/debugging/image/task-trace-internal.png diff --git a/Documentation/guides/image/task-trace-overview.png b/Documentation/debugging/image/task-trace-overview.png similarity index 100% rename from Documentation/guides/image/task-trace-overview.png rename to Documentation/debugging/image/task-trace-overview.png diff --git a/Documentation/guides/image/trace-compass-screenshot.png b/Documentation/debugging/image/trace-compass-screenshot.png similarity index 100% rename from Documentation/guides/image/trace-compass-screenshot.png rename to Documentation/debugging/image/trace-compass-screenshot.png diff --git a/Documentation/debugging/index.rst b/Documentation/debugging/index.rst new file mode 100644 index 00000000000..fb18b2b9de4 --- /dev/null +++ b/Documentation/debugging/index.rst @@ -0,0 +1,21 @@ +========= +Debugging +========= + +This page contains a collection of guides on how to debug problems with NuttX. + +.. toctree:: + gdbwithpython.rst + qemugdb.rst + gdbserver.rst + debugging_elf_loadable_modules.rst + tasktrace.rst + kasan.rst + coredump.rst + coresight.rst + stackcheck.rst + stackrecord.rst + disabling_stackdumpdebug.rst + debuggingflash_nuttxonarm.rst + cortexmhardfaults.rst + mte.rst diff --git a/Documentation/guides/kasan.rst b/Documentation/debugging/kasan.rst similarity index 100% rename from Documentation/guides/kasan.rst rename to Documentation/debugging/kasan.rst diff --git a/Documentation/guides/mte.rst b/Documentation/debugging/mte.rst similarity index 100% rename from Documentation/guides/mte.rst rename to Documentation/debugging/mte.rst diff --git a/Documentation/guides/qemugdb.rst b/Documentation/debugging/qemugdb.rst similarity index 100% rename from Documentation/guides/qemugdb.rst rename to Documentation/debugging/qemugdb.rst diff --git a/Documentation/guides/stackcheck.rst b/Documentation/debugging/stackcheck.rst similarity index 100% rename from Documentation/guides/stackcheck.rst rename to Documentation/debugging/stackcheck.rst diff --git a/Documentation/guides/stackrecord.rst b/Documentation/debugging/stackrecord.rst similarity index 100% rename from Documentation/guides/stackrecord.rst rename to Documentation/debugging/stackrecord.rst diff --git a/Documentation/guides/tasktrace.rst b/Documentation/debugging/tasktrace.rst similarity index 100% rename from Documentation/guides/tasktrace.rst rename to Documentation/debugging/tasktrace.rst diff --git a/Documentation/guides/tasktraceinternal.rst b/Documentation/debugging/tasktraceinternal.rst similarity index 100% rename from Documentation/guides/tasktraceinternal.rst rename to Documentation/debugging/tasktraceinternal.rst diff --git a/Documentation/guides/tasktraceuser.rst b/Documentation/debugging/tasktraceuser.rst similarity index 100% rename from Documentation/guides/tasktraceuser.rst rename to Documentation/debugging/tasktraceuser.rst diff --git a/Documentation/guides/index.rst b/Documentation/guides/index.rst index 4093e2c1fbf..262bccf0808 100644 --- a/Documentation/guides/index.rst +++ b/Documentation/guides/index.rst @@ -9,45 +9,32 @@ Guides 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 - kasan.rst fortify.rst nestedinterrupts.rst - cortexmhardfaults.rst - coredump.rst - coresight.rst - gdbserver.rst - gdbwithpython.rst ofloader.rst testingtcpip.rst automounter.rst stm32nullpointer.rst stm32ccm.rst - stackcheck.rst - stackrecord.rst etcromfs.rst thread_local_storage.rst devicetree.rst - debuggingflash_nuttxonarm.rst changing_systemclockconfig.rst usingkernelthreads.rst armv7m_runtimestackcheck.rst - disabling_stackdumpdebug.rst include_files_board_h.rst specialstuff_in_nuttxheaderfiles.rst kernel_threads_with_custom_stacks.rst versioning_and_task_names.rst logging_rambuffer.rst - mte.rst ipv6.rst integrate_newlib.rst protected_build.rst @@ -65,7 +52,6 @@ Guides building_nuttx_with_app_out_of_src_tree.rst building_uclibcpp.rst custom_app_directories.rst - debugging_elf_loadable_modules.rst multiple_nsh_sessions.rst nsh_network_link_management.rst ram_rom_disks.rst diff --git a/Documentation/index.rst b/Documentation/index.rst index c8b6fd9c215..6ebf6e01eb4 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -36,6 +36,7 @@ Last Updated: |today| implementation/index.rst reference/index.rst faq/index.rst + debugging/index.rst guides/index.rst glossary.rst logos/index.rst