Documentation: move debug pages to a separate top level page

Move debug related pages from Guides to a separate top level page. This way all pages related to debugging will be in one place which is more user friendly. Related Github issue: https://github.com/apache/nuttx/issues/15667 Signed-off-by: raiden00pl <raiden00@railab.me>
2025-03-22 08:15:08 +01:00 · 2025-03-22 08:15:08 +01:00 · 9394962cf6
commit 9394962cf6
parent a4777f153b
30 changed files with 22 additions and 14 deletions
--- a/Documentation/debugging/coredump.rst
+++ b/Documentation/debugging/coredump.rst
--- a/Documentation/debugging/coresight.rst
+++ b/Documentation/debugging/coresight.rst
--- a/Documentation/debugging/cortexmhardfaults.rst
+++ b/Documentation/debugging/cortexmhardfaults.rst
--- a/Documentation/debugging/debugging_elf_loadable_modules.rst
+++ b/Documentation/debugging/debugging_elf_loadable_modules.rst
--- a/Documentation/debugging/debuggingflash_nuttxonarm.rst
+++ b/Documentation/debugging/debuggingflash_nuttxonarm.rst
--- a/Documentation/debugging/disabling_stackdumpdebug.rst
+++ b/Documentation/debugging/disabling_stackdumpdebug.rst
--- a/Documentation/debugging/gdb/irqinfo.rst
+++ b/Documentation/debugging/gdb/irqinfo.rst
--- a/Documentation/debugging/gdbserver.rst
+++ b/Documentation/debugging/gdbserver.rst
--- a/Documentation/debugging/gdbwithpython.rst
+++ b/Documentation/debugging/gdbwithpython.rst
--- a/Documentation/debugging/image/coredump-gdb.png
+++ b/Documentation/debugging/image/coredump-gdb.png
--- a/Documentation/debugging/image/coredump-hexdump.png
+++ b/Documentation/debugging/image/coredump-hexdump.png
--- a/Documentation/debugging/image/coredump-overview.png
+++ b/Documentation/debugging/image/coredump-overview.png
--- a/Documentation/debugging/image/syscall-flat-after.png
+++ b/Documentation/debugging/image/syscall-flat-after.png
--- a/Documentation/debugging/image/syscall-flat-before.png
+++ b/Documentation/debugging/image/syscall-flat-before.png
--- a/Documentation/debugging/image/syscall-protected-after.png
+++ b/Documentation/debugging/image/syscall-protected-after.png
--- a/Documentation/debugging/image/syscall-protected-before.png
+++ b/Documentation/debugging/image/syscall-protected-before.png
--- a/Documentation/debugging/image/task-trace-internal.png
+++ b/Documentation/debugging/image/task-trace-internal.png
--- a/Documentation/debugging/image/task-trace-overview.png
+++ b/Documentation/debugging/image/task-trace-overview.png
--- a/Documentation/debugging/image/trace-compass-screenshot.png
+++ b/Documentation/debugging/image/trace-compass-screenshot.png
--- a/Documentation/debugging/index.rst
+++ 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
--- a/Documentation/debugging/kasan.rst
+++ b/Documentation/debugging/kasan.rst
--- a/Documentation/debugging/mte.rst
+++ b/Documentation/debugging/mte.rst
--- a/Documentation/debugging/qemugdb.rst
+++ b/Documentation/debugging/qemugdb.rst
--- a/Documentation/debugging/stackcheck.rst
+++ b/Documentation/debugging/stackcheck.rst
--- a/Documentation/debugging/stackrecord.rst
+++ b/Documentation/debugging/stackrecord.rst
--- a/Documentation/debugging/tasktrace.rst
+++ b/Documentation/debugging/tasktrace.rst
--- a/Documentation/debugging/tasktraceinternal.rst
+++ b/Documentation/debugging/tasktraceinternal.rst
--- a/Documentation/debugging/tasktraceuser.rst
+++ b/Documentation/debugging/tasktraceuser.rst
--- 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
--- 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