Skip to contentSkip to conversation

docs: Add missing assumption

PATCH In review Glenn Washburn 3 participants 3 messages Jul 11, 2023 – Jul 13, 2023

lore
Share & tools
lore
#0 lore raw

PATCH v4 1/1 docs: Add missing assumption

Also reword a prior sentence to be more clear.

Fixes 5a3d2b4742df (docs: Add debugging chapter to development documentation)

---
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(-)
docs/grub-dev.texi +3 -2
index 0834ca562ad6..a695b02f06df 100644
@@ -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)
Signature · 1 line
2.34.1
Reviewed-by on v4 1/1
#1 lore raw
Quoted 4 lines · Glenn Washburn

Also reword a prior sentence to be more clear.

Fixes 5a3d2b4742df (docs: Add debugging chapter to development documentation)

LGTM, thanks.

- Oskari

Quoted 39 lines

---
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(-)
docs/grub-dev.texi +3 -2
index 0834ca562ad6..a695b02f06df 100644
@@ -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)
Signature · 1 line
2.34.1