[PATCH v1 2/3] doc: develop: Fix typos and wording in gdb.rst

[Alexander Dahl]

Hello Lothar,

Am Tue, Nov 19, 2024 at 10:28:36PM +0000 schrieb Lothar Rubusch:
> Fix some typos and duplicate words in gdb.rst.
> 
> Signed-off-by: Lothar Rubusch <l.rubusch at gmail.com>
> ---
>  doc/develop/gdb.rst | 14 +++++++-------
>  1 file changed, 7 insertions(+), 7 deletions(-)
> 
> diff --git a/doc/develop/gdb.rst b/doc/develop/gdb.rst
> index 4e359c7f22..dc38435227 100644
> --- a/doc/develop/gdb.rst
> +++ b/doc/develop/gdb.rst
> @@ -8,12 +8,12 @@ Using a JTAG adapter it is possible to debug a running U-Boot with GDB.
>  A common way is to connect a debug adapter to the JTAG connector of your
>  board, run a GDB server, connect GDB to the GDB server, and use GDB as usual.
>  
> -Similarly QEMU can provide a GDB server.
> +Similarly, QEMU can provide a GDB server.
>  
>  Preparing build
>  ---------------
>  
> -Building U-Boot with with reduced optimization (-Og) and without link time
> +Building U-Boot with reduced optimization (-Og) and without link time

ack

>  optimization is recommended for easier debugging::
>  
>      CONFIG_CC_OPTIMIZE_FOR_DEBUG=y
> @@ -24,8 +24,8 @@ Otherwise build, install, and run U-Boot as usual.
>  Using OpenOCD as GDB server
>  ---------------------------
>  
> -`OpenOCD <https://openocd.org/>`_ is an open source tool supporting hardware
> -debug probes, and providing a GDB server. It is readily available in major Linux
> +`OpenOCD <https://openocd.org/>`_ is an open-source tool supporting hardware
> +debug probes and provide a GDB server. It is readily available in major Linux

NACK.  It would read "OpenOCD is a tool supporting x and provide y"
now.  This is most probably wrong?

>  distributions or you can build it from source.
>  
>  Here is example of starting OpenOCD on Debian using a J-Link adapter and a
> @@ -124,7 +124,7 @@ with the command *bdinfo*:
>      Early malloc usage: cd8 / 2000
>  
>  Look out for the line starting with *relocaddr* which has the address
> -you need, ``0x27f7a000`` in this case.
> +You need, ``0x27f7a000`` in this case.

NACK.  These are not two sentences but one, containing "the address you
need".  Splitting that makes no sense.

Greets
Alex

>  On most architectures (not sandbox, x86, Xtensa) the global data pointer is
>  stored in a fixed register:
> @@ -144,7 +144,7 @@ riscv        gp
>  sh           r13
>  ============ ========
>  
> -On these architecture the relocation address cat be determined by
> +On this architecture the relocation address can be determined by
>  dereferencing the global data pointer stored in register, *r9* in the example:
>  
>  .. code-block:: console
> @@ -153,7 +153,7 @@ dereferencing the global data pointer stored in register, *r9* in the example:
>       $1 = 0x27f7a000
>  
>  In the GDB shell discard the previously loaded symbol file and add it once
> -again with the relocation address like this:
> +again, with the relocation address like this:
>  
>  .. code-block:: console
>  
> -- 
> 2.39.2
>