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
This commit is contained in:
Randy Dunlap 2024-12-09 16:00:41 -08:00 committed by Jonathan Corbet
parent 270beb5b2a
commit d5af79c05e
9 changed files with 11 additions and 8 deletions

View file

@ -356,5 +356,5 @@ instructions at 'Documentation/admin-guide/reporting-issues.rst'.
Hints on understanding kernel bug reports are in Hints on understanding kernel bug reports are in
'Documentation/admin-guide/bug-hunting.rst'. More on debugging the kernel 'Documentation/admin-guide/bug-hunting.rst'. More on debugging the kernel
with gdb is in 'Documentation/dev-tools/gdb-kernel-debugging.rst' and with gdb is in 'Documentation/process/debugging/gdb-kernel-debugging.rst' and
'Documentation/dev-tools/kgdb.rst'. 'Documentation/process/debugging/kgdb.rst'.

View file

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

View file

@ -11,6 +11,8 @@ general guides
:maxdepth: 1 :maxdepth: 1
driver_development_debugging_guide driver_development_debugging_guide
gdb-kernel-debugging
kgdb
userspace_debugging_guide userspace_debugging_guide
.. only:: subproject and html .. only:: subproject and html

View file

@ -12811,7 +12811,7 @@ L: kgdb-bugreport@lists.sourceforge.net
S: Maintained S: Maintained
W: http://kgdb.wiki.kernel.org/ W: http://kgdb.wiki.kernel.org/
T: git git://git.kernel.org/pub/scm/linux/kernel/git/jwessel/kgdb.git 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/misc/kgdbts.c
F: drivers/tty/serial/kgdboc.c F: drivers/tty/serial/kgdboc.c
F: include/linux/kdb.h F: include/linux/kdb.h

View file

@ -320,7 +320,7 @@ struct serial_struct;
* *
* @poll_init: ``int ()(struct tty_driver *driver, int line, char *options)`` * @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 * called to initialize the HW for later use by calling @poll_get_char or
* @poll_put_char. * @poll_put_char.
* *

View file

@ -433,7 +433,7 @@ config GDB_SCRIPTS
build directory. If you load vmlinux into gdb, the helper build directory. If you load vmlinux into gdb, the helper
scripts will be automatically imported by gdb as well, and scripts will be automatically imported by gdb as well, and
additional functions are available to analyze a Linux kernel 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. for further details.
endif # DEBUG_INFO endif # DEBUG_INFO

View file

@ -19,7 +19,7 @@ menuconfig KGDB
CONFIG_FRAME_POINTER to aid in producing more reliable stack CONFIG_FRAME_POINTER to aid in producing more reliable stack
backtraces in the external debugger. Documentation of backtraces in the external debugger. Documentation of
kernel debugger is available at http://kgdb.sourceforge.net 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. unsure, say N.
if KGDB if KGDB