[docs][PATCH V3] Improvements for gdbserver configuration

[docs][PATCH V3] Improvements for gdbserver configuration

[Sundeep KOKKONDA]

[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 | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 9d4aaa5a6..5c4f0028a 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -10181,6 +10181,7 @@ debugger.
    an image recipe::
 
       IMAGE_INSTALL:append = " gdbserver"
+      EXTRA_IMAGE_FEATURES:append = " tools-debug"
 
    The change makes
    sure the ``gdbserver`` package is included.
@@ -10227,14 +10228,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 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``
-- 
2.25.1

Re: [docs][PATCH V3] Improvements for gdbserver configuration

[Michael Opdenacker]

Hi Sundeep,

Many thanks for the patch and the updates!

On 4/19/22 13:45, 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 | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
>
> diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
> index 9d4aaa5a6..5c4f0028a 100644
> --- a/documentation/dev-manual/common-tasks.rst
> +++ b/documentation/dev-manual/common-tasks.rst
> @@ -10181,6 +10181,7 @@ debugger.
>     an image recipe::
>  
>        IMAGE_INSTALL:append = " gdbserver"
> +      EXTRA_IMAGE_FEATURES:append = " tools-debug"


Isn't the EXTRA_IMAGE_FEATURES setting sufficient here? If I understand
correctly, you should remove the "IMAGE_INSTALL" setting and then remove
the "or in an image recipe:" text, because EXTRA_IMAGE_FEATURES is meant
to be used in a configuration file.

Cheers
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [PATCH V3] Improvements for gdbserver configuration

[Sundeep KOKKONDA]

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

Hello Michael,

The current doc says,
IMAGE_INSTALL:append = " gdbserver" to be added in local.conf file or in an image recipe. According to yocto doc, the IMAGE_INSTALL should be used with image recipe and the EXTRA_IMAGE_FEATURES should be used by conf file.

So, the let me know below correction should be OK?

Make the following addition in an image recipe:

IMAGE_INSTALL : append = " gdbserver"

The change makes sure the gdbserver package is included.

And, make following addition in local.conf.
EXTRA_IMAGE_FEATURES:append = " tools-debug"

Thanks,
Sundeep K.

[-- Attachment #2: Type: text/html, Size: 3146 bytes --]