Documentation: move dev-tools debugging files to process/debugging/

Move gdb and kgdb debugging documentation to the dedicated
debugging directory (Documentation/process/debugging/).
Adjust the index.rst files to follow the file movement.
Adjust files that refer to these moved files to follow the file movement.
Update location of kgdb.rst in MAINTAINERS file.
Add a link from dev-tools/index to process/debugging/index.

Note: translations are not updated.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Sebastian Fricke <sebastian.fricke@collabora.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: workflows@vger.kernel.org
Cc: Jason Wessel <jason.wessel@windriver.com>
Cc: Daniel Thompson <danielt@kernel.org>
Cc: Douglas Anderson <dianders@chromium.org>
Cc: linux-debuggers@vger.kernel.org
Cc: kgdb-bugreport@lists.sourceforge.net
Cc: Doug Anderson <dianders@chromium.org>
Cc: Alex Shi <alexs@kernel.org>
Cc: Hu Haowen <2023002089@link.tyut.edu.cn>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: linux-serial@vger.kernel.org
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Acked-by: Daniel Thompson <danielt@kernel.org>
Reviewed-by: Douglas Anderson <dianders@chromium.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241210000041.305477-1-rdunlap@infradead.org

diff --git a/Documentation/admin-guide/README.rst b/Documentation/admin-guide/README.rst
index f2bebff6a733f694c2ce5028b9863caa75c988bc..eb94526689091311a32b13b5f69d1ff3727854b4 100644 (file)
--- a/Documentation/admin-guide/README.rst
+++ b/Documentation/admin-guide/README.rst
@@ -356,5 +356,5 @@ instructions at 'Documentation/admin-guide/reporting-issues.rst'.
 
 Hints on understanding kernel bug reports are in
 'Documentation/admin-guide/bug-hunting.rst'. More on debugging the kernel
-with gdb is in 'Documentation/dev-tools/gdb-kernel-debugging.rst' and
-'Documentation/dev-tools/kgdb.rst'.
+with gdb is in 'Documentation/process/debugging/gdb-kernel-debugging.rst' and
+'Documentation/process/debugging/kgdb.rst'.

diff --git a/Documentation/dev-tools/index.rst b/Documentation/dev-tools/index.rst
index 3c0ac08b2709119f283ed8ca57c1c42c9f640c36..65c54b27a60b8ded8eb834f783316e58a0aae3e8 100644 (file)
--- a/Documentation/dev-tools/index.rst
+++ b/Documentation/dev-tools/index.rst
@@ -10,6 +10,9 @@ whole; patches welcome!
 A brief overview of testing-specific tools can be found in
 Documentation/dev-tools/testing-overview.rst
 
+Tools that are specific to debugging can be found in
+Documentation/process/debugging/index.rst
+
 .. toctree::
    :caption: Table of contents
    :maxdepth: 2
@@ -27,8 +30,6 @@ Documentation/dev-tools/testing-overview.rst
    kmemleak
    kcsan
    kfence
-   gdb-kernel-debugging
-   kgdb
    kselftest
    kunit/index
    ktap

diff --git a/Documentation/dev-tools/gdb-kernel-debugging.rst b/Documentation/process/debugging/gdb-kernel-debugging.rst
similarity index 100%
rename from Documentation/dev-tools/gdb-kernel-debugging.rst
rename to Documentation/process/debugging/gdb-kernel-debugging.rst

diff --git a/Documentation/process/debugging/index.rst b/Documentation/process/debugging/index.rst
index f6e4a00dfee32b73d55b3519e8f133cf77bd082e..387d33d16f5ed24eec7dd92ffc027f4e6d22db87 100644 (file)
--- a/Documentation/process/debugging/index.rst
+++ b/Documentation/process/debugging/index.rst
@@ -11,6 +11,8 @@ general guides
    :maxdepth: 1
 
    driver_development_debugging_guide
+   gdb-kernel-debugging
+   kgdb
    userspace_debugging_guide
 
 .. only::  subproject and html

diff --git a/Documentation/dev-tools/kgdb.rst b/Documentation/process/debugging/kgdb.rst
similarity index 100%
rename from Documentation/dev-tools/kgdb.rst
rename to Documentation/process/debugging/kgdb.rst

diff --git a/MAINTAINERS b/MAINTAINERS
index 17daa9ee9384509c1ef3f2a3825a4594eab88741..4006434e015571f89bf502c8fe305a35c4c0137a 100644 (file)
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -12811,7 +12811,7 @@ L:      kgdb-bugreport@lists.sourceforge.net
 S:     Maintained
 W:     http://kgdb.wiki.kernel.org/
 T:     git git://git.kernel.org/pub/scm/linux/kernel/git/jwessel/kgdb.git
-F:     Documentation/dev-tools/kgdb.rst
+F:     Documentation/process/debugging/kgdb.rst
 F:     drivers/misc/kgdbts.c
 F:     drivers/tty/serial/kgdboc.c
 F:     include/linux/kdb.h

diff --git a/include/linux/tty_driver.h b/include/linux/tty_driver.h
index dd4b31ce6d5d4249b3aa9cf2f08f6716c6d57b5c..d4cdc089f6c379613ae7f29ed7b9c7ba9aecade4 100644 (file)
--- a/include/linux/tty_driver.h
+++ b/include/linux/tty_driver.h
@@ -320,7 +320,7 @@ struct serial_struct;
  *
  * @poll_init: ``int ()(struct tty_driver *driver, int line, char *options)``
  *
- *     kgdboc support (Documentation/dev-tools/kgdb.rst). This routine is
+ *     kgdboc support (Documentation/process/debugging/kgdb.rst). This routine is
  *     called to initialize the HW for later use by calling @poll_get_char or
  *     @poll_put_char.
  *

diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug
index f3d72370587936fa373129cc9b246f15dac907be..d2cf74cbbe70d4594ade35e636a98b1698857833 100644 (file)
--- a/lib/Kconfig.debug
+++ b/lib/Kconfig.debug
@@ -433,7 +433,7 @@ config GDB_SCRIPTS
          build directory. If you load vmlinux into gdb, the helper
          scripts will be automatically imported by gdb as well, and
          additional functions are available to analyze a Linux kernel
-         instance. See Documentation/dev-tools/gdb-kernel-debugging.rst
+         instance. See Documentation/process/debugging/gdb-kernel-debugging.rst
          for further details.
 
 endif # DEBUG_INFO

diff --git a/lib/Kconfig.kgdb b/lib/Kconfig.kgdb
index 537e1b3f57340cbabb9a7b2aa5708ead50535289..8336b1a489a396e63982bc4ab75bee923a6fcf90 100644 (file)
--- a/lib/Kconfig.kgdb
+++ b/lib/Kconfig.kgdb
@@ -19,7 +19,7 @@ menuconfig KGDB
          CONFIG_FRAME_POINTER to aid in producing more reliable stack
          backtraces in the external debugger.  Documentation of
          kernel debugger is available at http://kgdb.sourceforge.net
-         as well as in Documentation/dev-tools/kgdb.rst.  If
+         as well as in Documentation/process/debugging/kgdb.rst.  If
          unsure, say N.
 
 if KGDB