[PATCH v3] docs: Add missing assumption

[PATCH v3] docs: Add missing assumption

[Glenn Washburn]

Also reword a prior sentence to be more clear.

Fixes: 5a3d2b4742df (docs: Add debugging chapter to development documentation)
Signed-off-by: Glenn Washburn <development@efficientek.com>
---
v3: Fix rebase merge error (scripts -> script)
v2: rebase
---
 docs/grub-dev.texi | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/docs/grub-dev.texi b/docs/grub-dev.texi
index 0834ca562ad6..f7c944dc9e20 100644
--- a/docs/grub-dev.texi
+++ b/docs/grub-dev.texi
@@ -660,10 +660,11 @@ GDB is started from the @file{grub-core} directory in the GRUB2 build
 directory. GRUB2 developers have made this more simple by including a GDB
 script which does much of the setup. This file is at @file{grub-core/gdb_grub}
 in the build directory and is also installed via @command{make install}.
-If not building GRUB, the distribution may have a package which installs
+When using a pre-built GRUB, the distribution may have a package which installs
 this GDB script along with debug symbol binaries, such as Debian's
-@samp{grub-pc-dbg} package. The GDB script is intended to be used
-like so, assuming:
+@samp{grub-pc-dbg} package. The GDB script is intended to by used
+like so, assuming that @samp{/path/to/script} is the path to the directory
+containing the gdb_grub script and debug symbol files:
 
 @example
 cd $(dirname /path/to/script/gdb_grub)
-- 
2.34.1

Re: [PATCH v3] docs: Add missing assumption

[Oskari Pirhonen]

[-- Attachment #1: Type: text/plain, Size: 1884 bytes --]

On Mon, Jul 10, 2023 at 12:14:48 -0500, Glenn Washburn wrote:
> Also reword a prior sentence to be more clear.
> 
> Fixes: 5a3d2b4742df (docs: Add debugging chapter to development documentation)
> Signed-off-by: Glenn Washburn <development@efficientek.com>
> ---
> v3: Fix rebase merge error (scripts -> script)
> v2: rebase
> ---
>  docs/grub-dev.texi | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
> 
> diff --git a/docs/grub-dev.texi b/docs/grub-dev.texi
> index 0834ca562ad6..f7c944dc9e20 100644
> --- a/docs/grub-dev.texi
> +++ b/docs/grub-dev.texi
> @@ -660,10 +660,11 @@ GDB is started from the @file{grub-core} directory in the GRUB2 build
>  directory. GRUB2 developers have made this more simple by including a GDB
>  script which does much of the setup. This file is at @file{grub-core/gdb_grub}
>  in the build directory and is also installed via @command{make install}.
> -If not building GRUB, the distribution may have a package which installs
> +When using a pre-built GRUB, the distribution may have a package which installs
>  this GDB script along with debug symbol binaries, such as Debian's
> -@samp{grub-pc-dbg} package. The GDB script is intended to be used
> -like so, assuming:
> +@samp{grub-pc-dbg} package. The GDB script is intended to by used

Aw man, it seems to have picked up the original "by" which was changed
to "be". Looking back at v2 it was there as well, but I only commented
on the "script/scripts" portion. My bad on that.

Thanks for putting up with all these tiny changes. I've made sure to
read over it multiple times. The next one should be the final one.

- Oskari

> +like so, assuming that @samp{/path/to/script} is the path to the directory
> +containing the gdb_grub script and debug symbol files:
>  
>  @example
>  cd $(dirname /path/to/script/gdb_grub)
> -- 
> 2.34.1
> 

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH v3] docs: Add missing assumption

[Glenn Washburn]

On Mon, 10 Jul 2023 22:34:58 -0500
Oskari Pirhonen <xxc3ncoredxx@gmail.com> wrote:

> On Mon, Jul 10, 2023 at 12:14:48 -0500, Glenn Washburn wrote:
> > Also reword a prior sentence to be more clear.
> > 
> > Fixes: 5a3d2b4742df (docs: Add debugging chapter to development documentation)
> > Signed-off-by: Glenn Washburn <development@efficientek.com>
> > ---
> > v3: Fix rebase merge error (scripts -> script)
> > v2: rebase
> > ---
> >  docs/grub-dev.texi | 7 ++++---
> >  1 file changed, 4 insertions(+), 3 deletions(-)
> > 
> > diff --git a/docs/grub-dev.texi b/docs/grub-dev.texi
> > index 0834ca562ad6..f7c944dc9e20 100644
> > --- a/docs/grub-dev.texi
> > +++ b/docs/grub-dev.texi
> > @@ -660,10 +660,11 @@ GDB is started from the @file{grub-core} directory in the GRUB2 build
> >  directory. GRUB2 developers have made this more simple by including a GDB
> >  script which does much of the setup. This file is at @file{grub-core/gdb_grub}
> >  in the build directory and is also installed via @command{make install}.
> > -If not building GRUB, the distribution may have a package which installs
> > +When using a pre-built GRUB, the distribution may have a package which installs
> >  this GDB script along with debug symbol binaries, such as Debian's
> > -@samp{grub-pc-dbg} package. The GDB script is intended to be used
> > -like so, assuming:
> > +@samp{grub-pc-dbg} package. The GDB script is intended to by used
> 
> Aw man, it seems to have picked up the original "by" which was changed
> to "be". Looking back at v2 it was there as well, but I only commented
> on the "script/scripts" portion. My bad on that.
> 
> Thanks for putting up with all these tiny changes. I've made sure to
> read over it multiple times. The next one should be the final one.

Thanks for the sharp eye. I should have caught that also, but wasn't
looking.

Glenn

> 
> - Oskari
> 
> > +like so, assuming that @samp{/path/to/script} is the path to the directory
> > +containing the gdb_grub script and debug symbol files:
> >  
> >  @example
> >  cd $(dirname /path/to/script/gdb_grub)
> > -- 
> > 2.34.1
> >