Commit 6fde4385 authored by Nir Lichtman's avatar Nir Lichtman Committed by Jonathan Corbet
Browse files

Documentation: English fixes in kgdb/kdb article 



Minor grammar and typos fixed in the kgdb/kdb article

Signed-off-by: default avatarNir Lichtman <nir@lichtman.org>
Reviewed-by: default avatarDouglas Anderson <dianders@chromium.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241018223536.GA799515@lichtman.org
parent ca26a0a2

Documentation/dev-tools/kgdb.rst

+8 −10
Original line number Diff line number Diff line
@@ -75,11 +75,11 @@ supports it for the architecture you are using, you can use hardware 
breakpoints if you desire to run with the ``CONFIG_STRICT_KERNEL_RWX``

option turned on, else you need to turn off this option.



Next you should choose one of more I/O drivers to interconnect debugging

Next you should choose one or more I/O drivers to interconnect the debugging

host and debugged target. Early boot debugging requires a KGDB I/O

driver that supports early debugging and the driver must be built into

the kernel directly. Kgdb I/O driver configuration takes place via

kernel or module parameters which you can learn more about in the in the

kernel or module parameters which you can learn more about in the

section that describes the parameter kgdboc.



Here is an example set of ``.config`` symbols to enable or disable for kgdb::
@@ -201,8 +201,8 @@ Using loadable module or built-in 
Configure kgdboc at runtime with sysfs

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



At run time you can enable or disable kgdboc by echoing a parameters

into the sysfs. Here are two examples:

At run time you can enable or disable kgdboc by writing parameters

into sysfs. Here are two examples:



1. Enable kgdboc on ttyS0::
@@ -374,10 +374,10 @@ default behavior is always set to 0. 
Kernel parameter: ``nokaslr``

-----------------------------



If the architecture that you are using enable KASLR by default,

If the architecture that you are using enables KASLR by default,

you should consider turning it off.  KASLR randomizes the

virtual address where the kernel image is mapped and confuse

gdb which resolve kernel symbol address from symbol table

virtual address where the kernel image is mapped and confuses

gdb which resolves addresses of kernel symbols from the symbol table

of vmlinux.



Using kdb
@@ -631,8 +631,6 @@ automatically changes into kgdb mode. 


	kgdb



   Now disconnect your terminal program and connect gdb in its place



2. At the kdb prompt, disconnect the terminal program and connect gdb in

   its place.
@@ -749,7 +747,7 @@ The kernel debugger is organized into a number of components: 
   helper functions in some of the other kernel components to make it

   possible for kdb to examine and report information about the kernel

   without taking locks that could cause a kernel deadlock. The kdb core

   contains implements the following functionality.

   implements the following functionality.



   -  A simple shell