Commit d5af79c0 authored by Randy Dunlap's avatar Randy Dunlap Committed by Jonathan Corbet
Browse files

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: default avatarRandy 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: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Acked-by: default avatarDaniel Thompson <danielt@kernel.org>
Reviewed-by: default avatarDouglas Anderson <dianders@chromium.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241210000041.305477-1-rdunlap@infradead.org
parent 270beb5b

Documentation/admin-guide/README.rst

+2 −2
Original line number Diff line number Diff line
@@ -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
Original line number Diff line number Diff line
@@ -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/index.rst

+2 −0
Original line number Diff line number Diff line
@@ -11,6 +11,8 @@ general guides 
   :maxdepth: 1



   driver_development_debugging_guide

   gdb-kernel-debugging

   kgdb

   userspace_debugging_guide



.. only::  subproject and html