Skip to contentSkip to conversation

docs: Add missing assumption

PATCH Superseded Glenn Washburn 2 participants 3 messages Jul 4, 2023

v2 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 docs: Add missing assumption

Also reword a prior sentence to be more clear.

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

---
Changes from v1:
* Rebased onto latest master

---
 docs/grub-dev.texi | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
docs/grub-dev.texi +4 -3
index 0834ca562ad6..84d19dece9d6 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:
+@samp{grub-pc-dbg} package. The GDB scripts 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)
Signature · 1 line
2.34.1
#1 lore raw
Quoted 16 lines · Glenn Washburn

Also reword a prior sentence to be more clear.

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

---
Changes from v1:
* Rebased onto latest master

---
 docs/grub-dev.texi | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
docs/grub-dev.texi +0 -0
index 0834ca562ad6..84d19dece9d6 100644

docs/grub-dev.texi GDB is started from the @file{grub-core} directory in the GRUB2 build · line 665

Quoted 9 lines
docs/grub-dev.texi +2 -3
@@ -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 scripts is intended to by used

Did you intentionally reintroduce the last 's' that I removed from "GDB scripts"?

- Oskari

Quoted 8 lines
docs/grub-dev.texi +2 -0
+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
#2 lore raw
Quoted 21 lines · On Mon, 3 Jul 2023 22:02:41 -0500 Oskari Pirhonen <[email protected]>…
Quoted 20 lines · Glenn Washburn

Also reword a prior sentence to be more clear.

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

---
Changes from v1:
* Rebased onto latest master

---
 docs/grub-dev.texi | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
docs/grub-dev.texi +0 -1
index 0834ca562ad6..84d19dece9d6 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
Quoted 8 lines

docs/grub-dev.texi GDB is started from the @file{grub-core} directory in the GRUB2 build · line 665

Quoted 5 lines
docs/grub-dev.texi +2 -2
+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 scripts is intended to by used

Did you intentionally reintroduce the last 's' that I removed from "GDB scripts"?

Nope, I'll correct that.

Glenn

Quoted 11 lines

- Oskari

Quoted 8 lines
docs/grub-dev.texi +2 -0
+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