[PATCH v4] docs: Add missing assumption

[PATCH v4] 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>
---
Range-diff against v3:
1:  437c408b31cb ! 1:  c228e0412720 docs: Add missing assumption
    @@ docs/grub-dev.texi: GDB is started from the @file{grub-core} directory in the GR
     -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
    + @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:
      

 docs/grub-dev.texi | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/docs/grub-dev.texi b/docs/grub-dev.texi
index 0834ca562ad6..a695b02f06df 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:
+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 v4] docs: Add missing assumption

[Oskari Pirhonen]

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

On Tue, Jul 11, 2023 at 12:07:29 -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>

LGTM, thanks.

Reviewed-by: Oskari Pirhonen <xxc3ncoredxx@gmail.com>

- Oskari

> ---
> Range-diff against v3:
> 1:  437c408b31cb ! 1:  c228e0412720 docs: Add missing assumption
>     @@ docs/grub-dev.texi: GDB is started from the @file{grub-core} directory in the GR
>      -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
>     + @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:
>       
> 
>  docs/grub-dev.texi | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/docs/grub-dev.texi b/docs/grub-dev.texi
> index 0834ca562ad6..a695b02f06df 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:
> +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 v4] docs: Add missing assumption

[Daniel Kiper]

On Tue, Jul 11, 2023 at 07:08:48PM -0500, Oskari Pirhonen wrote:
> On Tue, Jul 11, 2023 at 12:07:29 -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>
>
> LGTM, thanks.
>
> Reviewed-by: Oskari Pirhonen <xxc3ncoredxx@gmail.com>

Reviewed-by: Daniel Kiper <daniel.kiper@oracle.com>

Daniel