Documentation: move dev-tools debugging files to process/debugging/
Subsystems (6)
Randy Dunlap
reviewerPATCH v3 1/1 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 Jason Wessel <[email protected]>
Cc Daniel Thompson <[email protected]>
Cc Douglas Anderson <[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]>
Acked-by Daniel Thompson <[email protected]>
Reviewed-by Douglas Anderson <[email protected]>
---
v3: add link to process/debugging/index from dev-tools/index.
@Andrew, please drop v2 of this patch.
Documentation/admin-guide/README.rst | 4 ++--
Documentation/dev-tools/index.rst | 5 +++--
.../{dev-tools => process/debugging}/gdb-kernel-debugging.rst | 0
Documentation/process/debugging/index.rst | 2 ++
Documentation/{dev-tools => process/debugging}/kgdb.rst | 0
MAINTAINERS | 2 +-
include/linux/tty_driver.h | 2 +-
lib/Kconfig.debug | 2 +-
lib/Kconfig.kgdb | 2 +-
9 files changed, 11 insertions(+), 8 deletions(-)Documentation/admin-guide/README.rst +2 -2
@@ -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'.
Documentation/dev-tools/index.rst +3 -2
@@ -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
Documentation/process/debugging/gdb-kernel-debugging.rst renamed from Documentation/dev-tools/gdb-kernel-debugging.rst +0 -0
Documentation/process/debugging/index.rst +2 -0
@@ -11,6 +11,8 @@ general guides :maxdepth: 1 driver_development_debugging_guide + gdb-kernel-debugging + kgdb userspace_debugging_guide .. only:: subproject and html
Documentation/process/debugging/kgdb.rst renamed from Documentation/dev-tools/kgdb.rst +0 -0
MAINTAINERS +1 -1
@@ -12809,7 +12809,7 @@ L: [email protected] 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
include/linux/tty_driver.h +1 -1
@@ -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. *
lib/Kconfig.debug +1 -1
@@ -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
lib/Kconfig.kgdb +1 -1
@@ -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
Quoted 27 lines · Randy Dunlap
Move gdb and kgdb debugging documentation to the dedicated debugging directory (
Documentation/process/debugging/). Adjust theindex.rstfiles to follow the file movement. Adjust files that refer to these moved files to follow the file movement. Update location ofkgdb.rstinMAINTAINERSfile.
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 Jason Wessel <[email protected]>Cc Daniel Thompson <[email protected]>Cc Douglas Anderson <[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]>Acked-by Daniel Thompson <[email protected]>Reviewed-by Douglas Anderson <[email protected]>
Quoted 1 line
---
Applied, thanks.
jon