Skip to content

Commit d5af79c

Browse files
rddunlapJonathan Corbet
authored andcommitted
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 <[email protected]> Cc: Sebastian Fricke <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Cc: Jason Wessel <[email protected]> Cc: Daniel Thompson <[email protected]> Cc: Douglas Anderson <[email protected]> Cc: [email protected] Cc: [email protected] Cc: Doug Anderson <[email protected]> Cc: Alex Shi <[email protected]> Cc: Hu Haowen <[email protected]> Cc: Andrew Morton <[email protected]> Cc: Greg Kroah-Hartman <[email protected]> Cc: [email protected] Acked-by: Greg Kroah-Hartman <[email protected]> Acked-by: Daniel Thompson <[email protected]> Reviewed-by: Douglas Anderson <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
1 parent 270beb5 commit d5af79c

File tree

9 files changed

+11
-8
lines changed

9 files changed

+11
-8
lines changed

Documentation/admin-guide/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -356,5 +356,5 @@ instructions at 'Documentation/admin-guide/reporting-issues.rst'.
356356

357357
Hints on understanding kernel bug reports are in
358358
'Documentation/admin-guide/bug-hunting.rst'. More on debugging the kernel
359-
with gdb is in 'Documentation/dev-tools/gdb-kernel-debugging.rst' and
360-
'Documentation/dev-tools/kgdb.rst'.
359+
with gdb is in 'Documentation/process/debugging/gdb-kernel-debugging.rst' and
360+
'Documentation/process/debugging/kgdb.rst'.

Documentation/dev-tools/index.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ whole; patches welcome!
1010
A brief overview of testing-specific tools can be found in
1111
Documentation/dev-tools/testing-overview.rst
1212

13+
Tools that are specific to debugging can be found in
14+
Documentation/process/debugging/index.rst
15+
1316
.. toctree::
1417
:caption: Table of contents
1518
:maxdepth: 2
@@ -27,8 +30,6 @@ Documentation/dev-tools/testing-overview.rst
2730
kmemleak
2831
kcsan
2932
kfence
30-
gdb-kernel-debugging
31-
kgdb
3233
kselftest
3334
kunit/index
3435
ktap
File renamed without changes.

Documentation/process/debugging/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ general guides
1111
:maxdepth: 1
1212

1313
driver_development_debugging_guide
14+
gdb-kernel-debugging
15+
kgdb
1416
userspace_debugging_guide
1517

1618
.. only:: subproject and html

MAINTAINERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12811,7 +12811,7 @@ L: [email protected]
1281112811
S: Maintained
1281212812
W: http://kgdb.wiki.kernel.org/
1281312813
T: git git://git.kernel.org/pub/scm/linux/kernel/git/jwessel/kgdb.git
12814-
F: Documentation/dev-tools/kgdb.rst
12814+
F: Documentation/process/debugging/kgdb.rst
1281512815
F: drivers/misc/kgdbts.c
1281612816
F: drivers/tty/serial/kgdboc.c
1281712817
F: include/linux/kdb.h

include/linux/tty_driver.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ struct serial_struct;
320320
*
321321
* @poll_init: ``int ()(struct tty_driver *driver, int line, char *options)``
322322
*
323-
* kgdboc support (Documentation/dev-tools/kgdb.rst). This routine is
323+
* kgdboc support (Documentation/process/debugging/kgdb.rst). This routine is
324324
* called to initialize the HW for later use by calling @poll_get_char or
325325
* @poll_put_char.
326326
*

lib/Kconfig.debug

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -433,7 +433,7 @@ config GDB_SCRIPTS
433433
build directory. If you load vmlinux into gdb, the helper
434434
scripts will be automatically imported by gdb as well, and
435435
additional functions are available to analyze a Linux kernel
436-
instance. See Documentation/dev-tools/gdb-kernel-debugging.rst
436+
instance. See Documentation/process/debugging/gdb-kernel-debugging.rst
437437
for further details.
438438

439439
endif # DEBUG_INFO

lib/Kconfig.kgdb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ menuconfig KGDB
1919
CONFIG_FRAME_POINTER to aid in producing more reliable stack
2020
backtraces in the external debugger. Documentation of
2121
kernel debugger is available at http://kgdb.sourceforge.net
22-
as well as in Documentation/dev-tools/kgdb.rst. If
22+
as well as in Documentation/process/debugging/kgdb.rst. If
2323
unsure, say N.
2424

2525
if KGDB

0 commit comments

Comments
 (0)