[V4] Improvements for gdbserver configuration

Message ID 20220504173421.41167-1-sundeep.kokkonda@gmail.com
State New
Headers show
Series [V4] Improvements for gdbserver configuration | expand

Commit Message

Sundeep KOKKONDA May 4, 2022, 5:34 p.m. UTC
[Yocto #13722]
The Yocto bug reports a few improvements in the gdbserver configuration which improves the configuration of gdb more easier for novice users.

Signed-off-by: Sundeep KOKKONDA <sundeep.kokkonda@gmail.com>
---
 documentation/dev-manual/common-tasks.rst | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

Comments

Michael Opdenacker May 4, 2022, 5:48 p.m. UTC | #1
Hi Sundeep,

On 5/4/22 19:34, Sundeep KOKKONDA wrote:
> [Yocto #13722]
> The Yocto bug reports a few improvements in the gdbserver configuration which improves the configuration of gdb more easier for novice users.
>
> Signed-off-by: Sundeep KOKKONDA <sundeep.kokkonda@gmail.com>
> ---
>  documentation/dev-manual/common-tasks.rst | 11 +++++------
>  1 file changed, 5 insertions(+), 6 deletions(-)
>
> diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
> index b228c75aa..c9fc585a0 100644
> --- a/documentation/dev-manual/common-tasks.rst
> +++ b/documentation/dev-manual/common-tasks.rst
> @@ -10177,10 +10177,9 @@ debugger.
>  
>  2. *Configure the system to include gdbserver in the target filesystem:*
>  
> -   Make the following addition in either your ``local.conf`` file or in
> -   an image recipe::
> +   Make the following addition in your ``local.conf`` file::
>  
> -      IMAGE_INSTALL:append = " gdbserver"
> +      EXTRA_IMAGE_FEATURES:append = " tools-debug"
>  
>     The change makes
>     sure the ``gdbserver`` package is included.
> @@ -10227,14 +10226,14 @@ debugger.
>  
>        $ mkdir debugfs
>        $ cd debugfs
> -      $ tar xvfj build-dir/tmp-glibc/deploy/images/machine/image.rootfs.tar.bz2
> -      $ tar xvfj build-dir/tmp-glibc/deploy/images/machine/image-dbg.rootfs.tar.bz2
> +      $ tar xvfj build-dir/tmp/deploy/images/machine/image.rootfs.tar.bz2
> +      $ tar xvfj build-dir/tmp/deploy/images/machine/image-dbg.rootfs.tar.bz2
>  
>  5. *Set up GDB:*
>  
>     Install the SDK (if you built one) and then source the correct
>     environment file. Sourcing the environment file puts the SDK in your
> -   ``PATH`` environment variable.
> +   ``PATH`` environment variable and sets ``$GDB`` to the SDK's debugger.
>  
>     If you are using the build system, Gdb is located in
>     `build-dir`\ ``/tmp/sysroots/``\ `host`\ ``/usr/bin/``\ `architecture`\ ``/``\ `architecture`\ ``-gdb``

Everything looks good now.

Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
... and merged into "master-next". This should be in "master" in a few days.

Many thanks for your patience!
Cheers
Michael.

Patch

diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index b228c75aa..c9fc585a0 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -10177,10 +10177,9 @@  debugger.
 
 2. *Configure the system to include gdbserver in the target filesystem:*
 
-   Make the following addition in either your ``local.conf`` file or in
-   an image recipe::
+   Make the following addition in your ``local.conf`` file::
 
-      IMAGE_INSTALL:append = " gdbserver"
+      EXTRA_IMAGE_FEATURES:append = " tools-debug"
 
    The change makes
    sure the ``gdbserver`` package is included.
@@ -10227,14 +10226,14 @@  debugger.
 
       $ mkdir debugfs
       $ cd debugfs
-      $ tar xvfj build-dir/tmp-glibc/deploy/images/machine/image.rootfs.tar.bz2
-      $ tar xvfj build-dir/tmp-glibc/deploy/images/machine/image-dbg.rootfs.tar.bz2
+      $ tar xvfj build-dir/tmp/deploy/images/machine/image.rootfs.tar.bz2
+      $ tar xvfj build-dir/tmp/deploy/images/machine/image-dbg.rootfs.tar.bz2
 
 5. *Set up GDB:*
 
    Install the SDK (if you built one) and then source the correct
    environment file. Sourcing the environment file puts the SDK in your
-   ``PATH`` environment variable.
+   ``PATH`` environment variable and sets ``$GDB`` to the SDK's debugger.
 
    If you are using the build system, Gdb is located in
    `build-dir`\ ``/tmp/sysroots/``\ `host`\ ``/usr/bin/``\ `architecture`\ ``/``\ `architecture`\ ``-gdb``