[PATCH] Documentation: English fixes in kgdb/kdb article

[PATCH] Documentation: English fixes in kgdb/kdb article

[Nir Lichtman]

Minor grammar and typos fixed in the kgdb/kdb article

Signed-off-by: Nir Lichtman <nir@lichtman.org>
---
 Documentation/dev-tools/kgdb.rst | 16 +++++++---------
 1 file changed, 7 insertions(+), 9 deletions(-)

diff --git a/Documentation/dev-tools/kgdb.rst b/Documentation/dev-tools/kgdb.rst
index f83ba2601e55..9e0e3f3235ef 100644
--- a/Documentation/dev-tools/kgdb.rst
+++ b/Documentation/dev-tools/kgdb.rst
@@ -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 of the 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,7 +201,7 @@ 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
+At run time you can enable or disable kgdboc by echoing the parameters
 into the 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
 
-- 
2.39.2

Re: [PATCH] Documentation: English fixes in kgdb/kdb article

[Matthew Wilcox]

On Fri, Oct 18, 2024 at 04:31:36PM +0000, Nir Lichtman wrote:
> -Next you should choose one of more I/O drivers to interconnect debugging
> +Next you should choose one of the I/O drivers to interconnect the debugging

Wrong fix ;-)  "one or more".

> @@ -201,7 +201,7 @@ 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
> +At run time you can enable or disable kgdboc by echoing the parameters
>  into the sysfs. Here are two examples:

Maybe "by writing parameters into sysfs"?

> @@ -631,8 +631,6 @@ automatically changes into kgdb mode.
>  
>  	kgdb
>  
> -   Now disconnect your terminal program and connect gdb in its place
> -

Is there a reason you deleted this?  It seems important.

Re: [PATCH] Documentation: English fixes in kgdb/kdb article

[Nir Lichtman]

On Fri, Oct 18, 2024 at 06:27:01PM +0100, Matthew Wilcox wrote:
> On Fri, Oct 18, 2024 at 04:31:36PM +0000, Nir Lichtman wrote:
> > -Next you should choose one of more I/O drivers to interconnect debugging
> > +Next you should choose one of the I/O drivers to interconnect the debugging
> 
> Wrong fix ;-)  "one or more".

Will fix in v2 :)

> 
> > @@ -201,7 +201,7 @@ 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
> > +At run time you can enable or disable kgdboc by echoing the parameters
> >  into the sysfs. Here are two examples:
> 
> Maybe "by writing parameters into sysfs"?

Yah, sounds better will fix as well in v2.

> 
> > @@ -631,8 +631,6 @@ automatically changes into kgdb mode.
> >  
> >  	kgdb
> >  
> > -   Now disconnect your terminal program and connect gdb in its place
> > -
> 
> Is there a reason you deleted this?  It seems important.
> 

Yes, this sentence is duplicated twice (with slightly different wording), here and a line below.

[PATCH v2] Documentation: English fixes in kgdb/kdb article

[Nir Lichtman]

Minor grammar and typos fixed in the kgdb/kdb article

Signed-off-by: Nir Lichtman <nir@lichtman.org>
---
 Documentation/dev-tools/kgdb.rst | 16 +++++++---------
 1 file changed, 7 insertions(+), 9 deletions(-)

diff --git a/Documentation/dev-tools/kgdb.rst b/Documentation/dev-tools/kgdb.rst
index f83ba2601e55..9e0e3f3235ef 100644
--- a/Documentation/dev-tools/kgdb.rst
+++ b/Documentation/dev-tools/kgdb.rst
@@ -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,7 +201,7 @@ 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
+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
 
-- 
2.39.2

Re: [PATCH] Documentation: English fixes in kgdb/kdb article

[Matthew Wilcox]

On Fri, Oct 18, 2024 at 05:49:53PM +0000, Nir Lichtman wrote:
> > > -   Now disconnect your terminal program and connect gdb in its place
> > > -
> > 
> > Is there a reason you deleted this?  It seems important.
> > 
> 
> Yes, this sentence is duplicated twice (with slightly different wording), here and a line below.

Right you are.  I should have looked more closely.

Re: [PATCH v2] Documentation: English fixes in kgdb/kdb article

[Doug Anderson]

Hi,

On Fri, Oct 18, 2024 at 10:55 AM Nir Lichtman <nir@lichtman.org> wrote:
>
> @@ -201,7 +201,7 @@ 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
> +At run time you can enable or disable kgdboc by writing parameters
>  into sysfs. Here are two examples:

In response to v1, Matthew wanted you to change "the sysfs" into
"sysfs". In the above it's no longer "the sysfs" but it's not part of
your patch (no "-" of the old line with the "the" and "+" of the new
line without the "the". Huh? This causes the patch to fail to apply.

Other than that, this all looks fine to me.

Reviewed-by: Douglas Anderson <dianders@chromium.org>

Re: [PATCH v2] Documentation: English fixes in kgdb/kdb article

[Nir Lichtman]

On Fri, Oct 18, 2024 at 12:46:14PM -0700, Doug Anderson wrote:
> Hi,
> 
> On Fri, Oct 18, 2024 at 10:55 AM Nir Lichtman <nir@lichtman.org> wrote:
> >
> > @@ -201,7 +201,7 @@ 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
> > +At run time you can enable or disable kgdboc by writing parameters
> >  into sysfs. Here are two examples:
> 
> In response to v1, Matthew wanted you to change "the sysfs" into
> "sysfs". In the above it's no longer "the sysfs" but it's not part of
> your patch (no "-" of the old line with the "the" and "+" of the new
> line without the "the". Huh? This causes the patch to fail to apply.
> 
> Other than that, this all looks fine to me.
> 
> Reviewed-by: Douglas Anderson <dianders@chromium.org>

Thanks, sorry about that mistake, will send a v3 with a fix shortly.

[PATCH v3] Documentation: English fixes in kgdb/kdb article

[Nir Lichtman]

Minor grammar and typos fixed in the kgdb/kdb article

Signed-off-by: Nir Lichtman <nir@lichtman.org>
---
 Documentation/dev-tools/kgdb.rst | 16 +++++++---------
 1 file changed, 7 insertions(+), 9 deletions(-)

diff --git a/Documentation/dev-tools/kgdb.rst b/Documentation/dev-tools/kgdb.rst
index f83ba2601e55..9e0e3f3235ef 100644
--- a/Documentation/dev-tools/kgdb.rst
+++ b/Documentation/dev-tools/kgdb.rst
@@ -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,7 +201,7 @@ 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
 
-- 
2.39.2

Re: [PATCH v3] Documentation: English fixes in kgdb/kdb article

[Doug Anderson]

Hi,

On Fri, Oct 18, 2024 at 3:35 PM Nir Lichtman <nir@lichtman.org> wrote:
>
> Minor grammar and typos fixed in the kgdb/kdb article
>
> Signed-off-by: Nir Lichtman <nir@lichtman.org>
> ---
>  Documentation/dev-tools/kgdb.rst | 16 +++++++---------
>  1 file changed, 7 insertions(+), 9 deletions(-)

You could have kept my tag, but in any case giving it again:

Reviewed-by: Douglas Anderson <dianders@chromium.org>

Re: [PATCH v3] Documentation: English fixes in kgdb/kdb article

[Jonathan Corbet]

A couple of comments..

Nir Lichtman <nir@lichtman.org> writes:

> Minor grammar and typos fixed in the kgdb/kdb article
>
> Signed-off-by: Nir Lichtman <nir@lichtman.org>
> ---

When you post followup versions to a patch, please put an explanation in
this space saying what has changed; that makes life easier for
reviewers. 

>  Documentation/dev-tools/kgdb.rst | 16 +++++++---------
>  1 file changed, 7 insertions(+), 9 deletions(-)

Beyond that, it is good to wait a little while before posting new
versions to let other reviews come through.  Three iterations in one day
are a bit much.

That said, the patch looks OK now; I'll apply it shortly.

Thanks,

jon

Re: [PATCH v3] Documentation: English fixes in kgdb/kdb article

[Nir Lichtman]

On Fri, Oct 18, 2024 at 05:10:38PM -0600, Jonathan Corbet wrote:
> A couple of comments..
> 
> Nir Lichtman <nir@lichtman.org> writes:
> 
> > Minor grammar and typos fixed in the kgdb/kdb article
> >
> > Signed-off-by: Nir Lichtman <nir@lichtman.org>
> > ---
> 
> When you post followup versions to a patch, please put an explanation in
> this space saying what has changed; that makes life easier for
> reviewers. 
> 
> >  Documentation/dev-tools/kgdb.rst | 16 +++++++---------
> >  1 file changed, 7 insertions(+), 9 deletions(-)
> 
> Beyond that, it is good to wait a little while before posting new
> versions to let other reviews come through.  Three iterations in one day
> are a bit much.
> 
> That said, the patch looks OK now; I'll apply it shortly.
> 
> Thanks,
> 
> jon

Noted, thanks