[PATCH 1/4] scripts/oe-debuginfod: correct several issues

[PATCH 1/4] scripts/oe-debuginfod: correct several issues

[Alexander Kanavin]

Particularly:
- nesting subprocess.run() inside subprocess.check_output() does not work at all.
How was this tested?
- -R and -U options can be combined; no need to separate the invocations based
on packaging format
- both exception handlers are unnecessary; we can simply print the hint if
invocation did not succeed
- to run debuginfod from its own sysroot, '-c addto_recipe_sysroot' for elfutils-native
must be executed

Signed-off-by: Alexander Kanavin <alex.kanavin@gmail.com>
---
 scripts/oe-debuginfod | 13 ++++---------
 1 file changed, 4 insertions(+), 9 deletions(-)

diff --git a/scripts/oe-debuginfod b/scripts/oe-debuginfod
index 967dd5807c..5560769888 100755
--- a/scripts/oe-debuginfod
+++ b/scripts/oe-debuginfod
@@ -20,12 +20,7 @@ if __name__ == "__main__":
         package_classes_var = "DEPLOY_DIR_" + tinfoil.config_data.getVar("PACKAGE_CLASSES").split()[0].replace("package_", "").upper()
         feed_dir = tinfoil.config_data.getVar(package_classes_var, expand=True)
 
-    try:
-        if package_classes_var == "DEPLOY_DIR_RPM":
-            subprocess.check_output(subprocess.run(['oe-run-native', 'elfutils-native', 'debuginfod', '--verbose', '-R', feed_dir]))
-        else:
-            subprocess.check_output(subprocess.run(['oe-run-native', 'elfutils-native', 'debuginfod', '--verbose', '-U', feed_dir]))
-    except subprocess.CalledProcessError:
-        print("\nTo use the debuginfod server Please ensure that this variable PACKAGECONFIG_pn-elfutils-native = \"debuginfod libdebuginfod\" is set in the local.conf")
-    except KeyboardInterrupt:
-            sys.exit(1)
+    subprocess.call(['bitbake', '-c', 'addto_recipe_sysroot', 'elfutils-native'])
+
+    subprocess.call(['oe-run-native', 'elfutils-native', 'debuginfod', '--verbose', '-R', '-U', feed_dir])
+    print("\nTo use the debuginfod server please ensure that this variable PACKAGECONFIG_pn-elfutils-native = \"debuginfod libdebuginfod\" is set in the local.conf")
-- 
2.30.2

[PATCH 2/4] libmicrohttpd: add a recipe from meta-oe

[Alexander Kanavin]

This is required to enable debuginfod in elfutils.

Signed-off-by: Alexander Kanavin <alex.kanavin@gmail.com>
---
 .../libmicrohttpd/libmicrohttpd_0.9.72.bb     | 31 +++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb

diff --git a/meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb b/meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb
new file mode 100644
index 0000000000..66c48da3b7
--- /dev/null
+++ b/meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb
@@ -0,0 +1,31 @@
+DESCRIPTION = "A small C library that is supposed to make it easy to run an HTTP server as part of another application"
+HOMEPAGE = "http://www.gnu.org/software/libmicrohttpd/"
+LICENSE = "LGPL-2.1+"
+LIC_FILES_CHKSUM = "file://COPYING;md5=57d09285feac8a64efa878e692b14f36"
+SECTION = "net"
+
+DEPENDS = "file"
+
+SRC_URI = "${GNU_MIRROR}/libmicrohttpd/${BPN}-${PV}.tar.gz"
+SRC_URI[md5sum] = "2a286193af88ab2ae3149748d4b46187"
+SRC_URI[sha256sum] = "0ae825f8e0d7f41201fd44a0df1cf454c1cb0bc50fe9d59c26552260264c2ff8"
+
+inherit autotools lib_package pkgconfig gettext
+
+CFLAGS += "-pthread -D_REENTRANT"
+
+EXTRA_OECONF += "--disable-static --with-gnutls=${STAGING_LIBDIR}/../"
+
+PACKAGECONFIG ?= "curl https"
+PACKAGECONFIG_append_class-target = "\
+        ${@bb.utils.filter('DISTRO_FEATURES', 'largefile', d)} \
+"
+PACKAGECONFIG[largefile] = "--enable-largefile,--disable-largefile,,"
+PACKAGECONFIG[curl] = "--enable-curl,--disable-curl,curl,"
+PACKAGECONFIG[https] = "--enable-https,--disable-https,libgcrypt gnutls,"
+
+do_compile_append() {
+    sed -i s:-L${STAGING_LIBDIR}::g libmicrohttpd.pc
+}
+
+BBCLASSEXTEND = "native nativesdk"
-- 
2.30.2

Re: [OE-core] [PATCH 2/4] libmicrohttpd: add a recipe from meta-oe

[Khem Raj]

On 4/19/21 2:00 AM, Alexander Kanavin wrote:
> This is required to enable debuginfod in elfutils.
> 

Don't forget to send a patch to remove  it from meta-openembedded once 
merged in core.

> Signed-off-by: Alexander Kanavin <alex.kanavin@gmail.com>
> ---
>   .../libmicrohttpd/libmicrohttpd_0.9.72.bb     | 31 +++++++++++++++++++
>   1 file changed, 31 insertions(+)
>   create mode 100644 meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb
> 
> diff --git a/meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb b/meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb
> new file mode 100644
> index 0000000000..66c48da3b7
> --- /dev/null
> +++ b/meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb
> @@ -0,0 +1,31 @@
> +DESCRIPTION = "A small C library that is supposed to make it easy to run an HTTP server as part of another application"
> +HOMEPAGE = "http://www.gnu.org/software/libmicrohttpd/"
> +LICENSE = "LGPL-2.1+"
> +LIC_FILES_CHKSUM = "file://COPYING;md5=57d09285feac8a64efa878e692b14f36"
> +SECTION = "net"
> +
> +DEPENDS = "file"
> +
> +SRC_URI = "${GNU_MIRROR}/libmicrohttpd/${BPN}-${PV}.tar.gz"
> +SRC_URI[md5sum] = "2a286193af88ab2ae3149748d4b46187"
> +SRC_URI[sha256sum] = "0ae825f8e0d7f41201fd44a0df1cf454c1cb0bc50fe9d59c26552260264c2ff8"
> +
> +inherit autotools lib_package pkgconfig gettext
> +
> +CFLAGS += "-pthread -D_REENTRANT"
> +
> +EXTRA_OECONF += "--disable-static --with-gnutls=${STAGING_LIBDIR}/../"
> +
> +PACKAGECONFIG ?= "curl https"
> +PACKAGECONFIG_append_class-target = "\
> +        ${@bb.utils.filter('DISTRO_FEATURES', 'largefile', d)} \
> +"
> +PACKAGECONFIG[largefile] = "--enable-largefile,--disable-largefile,,"
> +PACKAGECONFIG[curl] = "--enable-curl,--disable-curl,curl,"
> +PACKAGECONFIG[https] = "--enable-https,--disable-https,libgcrypt gnutls,"
> +
> +do_compile_append() {
> +    sed -i s:-L${STAGING_LIBDIR}::g libmicrohttpd.pc
> +}
> +
> +BBCLASSEXTEND = "native nativesdk"
> 
> 
> 
> 
> 

Re: [OE-core] [PATCH 2/4] libmicrohttpd: add a recipe from meta-oe

[Alexander Kanavin]

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

Thanks, I sent a patch for it to oe-devel.

Alex

On Mon, 19 Apr 2021 at 17:45, Khem Raj <raj.khem@gmail.com> wrote:

>
>
> On 4/19/21 2:00 AM, Alexander Kanavin wrote:
> > This is required to enable debuginfod in elfutils.
> >
>
> Don't forget to send a patch to remove  it from meta-openembedded once
> merged in core.
>
> > Signed-off-by: Alexander Kanavin <alex.kanavin@gmail.com>
> > ---
> >   .../libmicrohttpd/libmicrohttpd_0.9.72.bb     | 31 +++++++++++++++++++
> >   1 file changed, 31 insertions(+)
> >   create mode 100644 meta/recipes-support/libmicrohttpd/
> libmicrohttpd_0.9.72.bb
> >
> > diff --git a/meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb
> b/meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb
> > new file mode 100644
> > index 0000000000..66c48da3b7
> > --- /dev/null
> > +++ b/meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb
> > @@ -0,0 +1,31 @@
> > +DESCRIPTION = "A small C library that is supposed to make it easy to
> run an HTTP server as part of another application"
> > +HOMEPAGE = "http://www.gnu.org/software/libmicrohttpd/"
> > +LICENSE = "LGPL-2.1+"
> > +LIC_FILES_CHKSUM = "file://COPYING;md5=57d09285feac8a64efa878e692b14f36"
> > +SECTION = "net"
> > +
> > +DEPENDS = "file"
> > +
> > +SRC_URI = "${GNU_MIRROR}/libmicrohttpd/${BPN}-${PV}.tar.gz"
> > +SRC_URI[md5sum] = "2a286193af88ab2ae3149748d4b46187"
> > +SRC_URI[sha256sum] =
> "0ae825f8e0d7f41201fd44a0df1cf454c1cb0bc50fe9d59c26552260264c2ff8"
> > +
> > +inherit autotools lib_package pkgconfig gettext
> > +
> > +CFLAGS += "-pthread -D_REENTRANT"
> > +
> > +EXTRA_OECONF += "--disable-static --with-gnutls=${STAGING_LIBDIR}/../"
> > +
> > +PACKAGECONFIG ?= "curl https"
> > +PACKAGECONFIG_append_class-target = "\
> > +        ${@bb.utils.filter('DISTRO_FEATURES', 'largefile', d)} \
> > +"
> > +PACKAGECONFIG[largefile] = "--enable-largefile,--disable-largefile,,"
> > +PACKAGECONFIG[curl] = "--enable-curl,--disable-curl,curl,"
> > +PACKAGECONFIG[https] = "--enable-https,--disable-https,libgcrypt
> gnutls,"
> > +
> > +do_compile_append() {
> > +    sed -i s:-L${STAGING_LIBDIR}::g libmicrohttpd.pc
> > +}
> > +
> > +BBCLASSEXTEND = "native nativesdk"
> >
> >
> >
> > 
> >
>

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

[PATCH 3/4] default-distrovars.inc: add debuginfod to default DISTRO_FEATURES

[Alexander Kanavin]

Obtaining debug information by having it served automatically via http
is far more pleasant than messing about with debugfs and gdbserver or
transferring and installing -dbg packages by hand.

I believe we should follow the desktop distros and have it enabled
out of the box. Please see the following commit for the description
of how it works.

Signed-off-by: Alexander Kanavin <alex.kanavin@gmail.com>
---
 meta/conf/distro/include/default-distrovars.inc  | 2 +-
 meta/recipes-devtools/binutils/binutils_2.36.bb  | 2 +-
 meta/recipes-devtools/elfutils/elfutils_0.183.bb | 2 +-
 meta/recipes-devtools/gdb/gdb-common.inc         | 2 +-
 4 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/meta/conf/distro/include/default-distrovars.inc b/meta/conf/distro/include/default-distrovars.inc
index 433d4b6651..9fcc10f83a 100644
--- a/meta/conf/distro/include/default-distrovars.inc
+++ b/meta/conf/distro/include/default-distrovars.inc
@@ -10,7 +10,7 @@ LOCALE_UTF8_ONLY ?= "0"
 LOCALE_UTF8_IS_DEFAULT ?= "1"
 LOCALE_UTF8_IS_DEFAULT_class-nativesdk = "0"
 
-DISTRO_FEATURES_DEFAULT ?= "acl alsa argp bluetooth ext2 ipv4 ipv6 largefile pcmcia usbgadget usbhost wifi xattr nfs zeroconf pci 3g nfc x11 vfat"
+DISTRO_FEATURES_DEFAULT ?= "acl alsa argp bluetooth debuginfod ext2 ipv4 ipv6 largefile pcmcia usbgadget usbhost wifi xattr nfs zeroconf pci 3g nfc x11 vfat"
 DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT}"
 IMAGE_FEATURES ?= ""
 
diff --git a/meta/recipes-devtools/binutils/binutils_2.36.bb b/meta/recipes-devtools/binutils/binutils_2.36.bb
index a50d2ee7ee..ee9617de1d 100644
--- a/meta/recipes-devtools/binutils/binutils_2.36.bb
+++ b/meta/recipes-devtools/binutils/binutils_2.36.bb
@@ -25,7 +25,7 @@ EXTRA_OECONF_class-native = "--enable-targets=all \
                              --disable-sim \
                              --disable-werror"
 
-PACKAGECONFIG ??= ""
+PACKAGECONFIG ??= "${@bb.utils.filter('DISTRO_FEATURES', 'debuginfod', d)}"
 PACKAGECONFIG[debuginfod] = "--with-debuginfod, --without-debuginfod, elfutils"
 # gcc9.0 end up mis-compiling libbfd.so with O2 which then crashes on target
 # So remove -O2 and use -Os as workaround
diff --git a/meta/recipes-devtools/elfutils/elfutils_0.183.bb b/meta/recipes-devtools/elfutils/elfutils_0.183.bb
index c0833686de..8b1dece200 100644
--- a/meta/recipes-devtools/elfutils/elfutils_0.183.bb
+++ b/meta/recipes-devtools/elfutils/elfutils_0.183.bb
@@ -38,7 +38,7 @@ EXTRA_OECONF = "--program-prefix=eu-"
 DEPENDS_BZIP2 = "bzip2-replacement-native"
 DEPENDS_BZIP2_class-target = "bzip2"
 
-PACKAGECONFIG ??= ""
+PACKAGECONFIG ??= "${@bb.utils.contains('DISTRO_FEATURES', 'debuginfod', 'debuginfod libdebuginfod', '', d)}"
 PACKAGECONFIG[bzip2] = "--with-bzlib,--without-bzlib,${DEPENDS_BZIP2}"
 PACKAGECONFIG[xz] = "--with-lzma,--without-lzma,xz"
 PACKAGECONFIG[libdebuginfod] = "--enable-libdebuginfod,--disable-libdebuginfod,curl"
diff --git a/meta/recipes-devtools/gdb/gdb-common.inc b/meta/recipes-devtools/gdb/gdb-common.inc
index 6e04552034..a2a6364daf 100644
--- a/meta/recipes-devtools/gdb/gdb-common.inc
+++ b/meta/recipes-devtools/gdb/gdb-common.inc
@@ -29,7 +29,7 @@ EXTRA_OECONF = "--disable-gdbtk --disable-x --disable-werror \
                 --disable-gprof \
 "
 
-PACKAGECONFIG ??= "readline"
+PACKAGECONFIG ??= "readline ${@bb.utils.filter('DISTRO_FEATURES', 'debuginfod', d)}"
 # Use --without-system-readline to compile with readline 5.
 PACKAGECONFIG[readline] = "--with-system-readline,--without-system-readline,readline"
 PACKAGECONFIG[python] = "--with-python=${WORKDIR}/python,--without-python,python3,python3 python3-codecs"
-- 
2.30.2

Re: [OE-core] [PATCH 3/4] default-distrovars.inc: add debuginfod to default DISTRO_FEATURES

[Richard Purdie]

On Mon, 2021-04-19 at 11:00 +0200, Alexander Kanavin wrote:
> Obtaining debug information by having it served automatically via http
> is far more pleasant than messing about with debugfs and gdbserver or
> transferring and installing -dbg packages by hand.
> 
> I believe we should follow the desktop distros and have it enabled
> out of the box. Please see the following commit for the description
> of how it works.
> 
> Signed-off-by: Alexander Kanavin <alex.kanavin@gmail.com>
> ---
>  meta/conf/distro/include/default-distrovars.inc  | 2 +-
>  meta/recipes-devtools/binutils/binutils_2.36.bb  | 2 +-
>  meta/recipes-devtools/elfutils/elfutils_0.183.bb | 2 +-
>  meta/recipes-devtools/gdb/gdb-common.inc         | 2 +-
>  4 files changed, 4 insertions(+), 4 deletions(-)

I agree we should do this, it did blow up in testing:

https://autobuilder.yoctoproject.org/typhoon/#/builders/57/builds/3289/steps/11/logs/stdio

Hopefully an easy fix?

Cheers,

Richard

Re: [OE-core] [PATCH 3/4] default-distrovars.inc: add debuginfod to default DISTRO_FEATURES

[Richard Purdie]

On Mon, 2021-04-19 at 16:41 +0100, Richard Purdie via lists.openembedded.org wrote:
> On Mon, 2021-04-19 at 11:00 +0200, Alexander Kanavin wrote:
> > Obtaining debug information by having it served automatically via http
> > is far more pleasant than messing about with debugfs and gdbserver or
> > transferring and installing -dbg packages by hand.
> > 
> > I believe we should follow the desktop distros and have it enabled
> > out of the box. Please see the following commit for the description
> > of how it works.
> > 
> > Signed-off-by: Alexander Kanavin <alex.kanavin@gmail.com>
> > ---
> >  meta/conf/distro/include/default-distrovars.inc  | 2 +-
> >  meta/recipes-devtools/binutils/binutils_2.36.bb  | 2 +-
> >  meta/recipes-devtools/elfutils/elfutils_0.183.bb | 2 +-
> >  meta/recipes-devtools/gdb/gdb-common.inc         | 2 +-
> >  4 files changed, 4 insertions(+), 4 deletions(-)
> 
> I agree we should do this, it did blow up in testing:
> 
> https://autobuilder.yoctoproject.org/typhoon/#/builders/57/builds/3289/steps/11/logs/stdio
> 
> Hopefully an easy fix?

Also:

https://autobuilder.yoctoproject.org/typhoon/#/builders/81/builds/1993
https://autobuilder.yoctoproject.org/typhoon/#/builders/82/builds/1705

(elfutils ptest warning)

Cheers,

Richard

Re: [OE-core] [PATCH 3/4] default-distrovars.inc: add debuginfod to default DISTRO_FEATURES

[Alexander Kanavin]

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

On Mon, 19 Apr 2021 at 22:42, Richard Purdie <
richard.purdie@linuxfoundation.org> wrote:

> > I agree we should do this, it did blow up in testing:
> >
> >
> https://autobuilder.yoctoproject.org/typhoon/#/builders/57/builds/3289/steps/11/logs/stdio
> >
> > Hopefully an easy fix?
>
> Also:
>
> https://autobuilder.yoctoproject.org/typhoon/#/builders/81/builds/1993
> https://autobuilder.yoctoproject.org/typhoon/#/builders/82/builds/1705
>
> (elfutils ptest warning)
>

Thanks, I just sent followup patches for both.

Alex

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

[PATCH 4/4] dev-manual/common-tasks.rst: correct the documentation for debuginfod

[Alexander Kanavin]

Particularly,
- correctly describe the use of DEBUGINFOD_URLS; drop it from bitbake variables
- all necessary component tweaks are enabled by default via DISTRO_FEATURES
- provide on-target examples of what to look for when things work properly

Signed-off-by: Alexander Kanavin <alex.kanavin@gmail.com>
---
 documentation/dev-manual/common-tasks.rst | 34 +++++++++++++++--------
 documentation/ref-manual/variables.rst    |  6 ----
 2 files changed, 22 insertions(+), 18 deletions(-)

diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 176025f9e8..9f33b6b2c8 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -10005,34 +10005,44 @@ debug symbols from the server.
 
 To run a debuginfod server, you need to do the following:
 
--  Ensure that this variable is set in your ``local.conf`` file:
+-  Ensure that "debuginfod" is present in :term:`DISTRO_FEATURES
+   (it already is in oe-core defaults and poky reference distribution).
+   If not, set:
    ::
 
-      PACKAGECONFIG_pn-elfutils-native = "debuginfod libdebuginfod"
+      DISTRO_FEATURES_append = " debuginfod"
 
-   This :term:`PACKAGECONFIG` option enables debuginfod and libdebuginfod for
-   "elfutils-native".
+   This distro feature enables the server and client library in elfutils,
+   and enables debuginfod support in clients (at the moment, gdb and binutils).
 
--  Run the following commands to set up the "debuginfod" server:
+-  Run the following commands to launch the "debuginfod" server on the host:
    ::
 
       $ oe-debuginfod
 
+-  To use debuginfod on the target, you need to know the ip:port where
+   debuginfod is listening on the host (port defaults to 8002), and export
+   that into the shell environment, for example in qemu:
+   ::
 
-To use debuginfod on the target, you need the following:
+      root@qemux86-64:~# export DEBUGINFOD_URLS="http://192.168.7.1:8002/"
 
--  Ensure that this variable is set in your ``local.conf`` file:
+-  Then debug info fetching should simply work when running the target gdb,
+   readelf or objdump, for example:
    ::
 
-      DEBUGINFOD_URLS = "http://localhost:8002/"
-
-   This :term:`DEBUGINFOD_URLS` option does the client configuration.
+      root@qemux86-64:~# gdb /bin/cat
+      ...
+      Reading symbols from /bin/cat...
+      Downloading separate debug info for /bin/cat...
+      Reading symbols from /home/root/.cache/debuginfod_client/923dc4780cfbc545850c616bffa884b6b5eaf322/debuginfo...
 
+-  It's also possible to use "debuginfod-find" to just query the server:
    ::
 
-        PACKAGECONFIG_pn-gdb = "debuginfod"
+      root@qemux86-64:~# debuginfod-find debuginfo /bin/ls
+      /home/root/.cache/debuginfod_client/356edc585f7f82d46f94fcb87a86a3fe2d2e60bd/debuginfo
 
-   This :term:`PACKAGECONFIG` option enables "debuginfod" for "gdb".
 
 Using the gdbserver method
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 74ac12bf98..8a35b0960e 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -1563,12 +1563,6 @@ system and gives an overview of their function and contents.
 
          DEBIANNAME_${PN} = "dbus-1"
 
-   :term:`DEBUGINFOD_URLS`
-      Points to the URL of the "debuginfod" server. Such that for every
-      debugging information lookup, the debuginfod client will query the
-      server and return the requested information. You set this variable
-      in your ``local.conf`` file.
-
    :term:`DEBUG_BUILD`
       Specifies to build packages with debugging information. This
       influences the value of the ``SELECTED_OPTIMIZATION`` variable.
-- 
2.30.2

[OE-core] [PATCH 4/4] dev-manual/common-tasks.rst: correct the documentation for debuginfod

[Richard Purdie]

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

Forwarded from OE-Core to ensure docs people see it.

Cheers,

Richard

[-- Attachment #2: Forwarded message — [OE-core] [PATCH 4/4] dev-manual/common-tasks.rst: correct the documentation for debuginfod --]
[-- Type: message/rfc822, Size: 12302 bytes --]

[-- Attachment #2.1.1: Type: text/plain, Size: 3870 bytes --]

Particularly,
- correctly describe the use of DEBUGINFOD_URLS; drop it from bitbake variables
- all necessary component tweaks are enabled by default via DISTRO_FEATURES
- provide on-target examples of what to look for when things work properly

Signed-off-by: Alexander Kanavin <alex.kanavin@gmail.com>
---
 documentation/dev-manual/common-tasks.rst | 34 +++++++++++++++--------
 documentation/ref-manual/variables.rst    |  6 ----
 2 files changed, 22 insertions(+), 18 deletions(-)

diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 176025f9e8..9f33b6b2c8 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -10005,34 +10005,44 @@ debug symbols from the server.
 
 To run a debuginfod server, you need to do the following:
 
--  Ensure that this variable is set in your ``local.conf`` file:
+-  Ensure that "debuginfod" is present in :term:`DISTRO_FEATURES
+   (it already is in oe-core defaults and poky reference distribution).
+   If not, set:
    ::
 
-      PACKAGECONFIG_pn-elfutils-native = "debuginfod libdebuginfod"
+      DISTRO_FEATURES_append = " debuginfod"
 
-   This :term:`PACKAGECONFIG` option enables debuginfod and libdebuginfod for
-   "elfutils-native".
+   This distro feature enables the server and client library in elfutils,
+   and enables debuginfod support in clients (at the moment, gdb and binutils).
 
--  Run the following commands to set up the "debuginfod" server:
+-  Run the following commands to launch the "debuginfod" server on the host:
    ::
 
       $ oe-debuginfod
 
+-  To use debuginfod on the target, you need to know the ip:port where
+   debuginfod is listening on the host (port defaults to 8002), and export
+   that into the shell environment, for example in qemu:
+   ::
 
-To use debuginfod on the target, you need the following:
+      root@qemux86-64:~# export DEBUGINFOD_URLS="http://192.168.7.1:8002/"
 
--  Ensure that this variable is set in your ``local.conf`` file:
+-  Then debug info fetching should simply work when running the target gdb,
+   readelf or objdump, for example:
    ::
 
-      DEBUGINFOD_URLS = "http://localhost:8002/"
-
-   This :term:`DEBUGINFOD_URLS` option does the client configuration.
+      root@qemux86-64:~# gdb /bin/cat
+      ...
+      Reading symbols from /bin/cat...
+      Downloading separate debug info for /bin/cat...
+      Reading symbols from /home/root/.cache/debuginfod_client/923dc4780cfbc545850c616bffa884b6b5eaf322/debuginfo...
 
+-  It's also possible to use "debuginfod-find" to just query the server:
    ::
 
-        PACKAGECONFIG_pn-gdb = "debuginfod"
+      root@qemux86-64:~# debuginfod-find debuginfo /bin/ls
+      /home/root/.cache/debuginfod_client/356edc585f7f82d46f94fcb87a86a3fe2d2e60bd/debuginfo
 
-   This :term:`PACKAGECONFIG` option enables "debuginfod" for "gdb".
 
 Using the gdbserver method
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 74ac12bf98..8a35b0960e 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -1563,12 +1563,6 @@ system and gives an overview of their function and contents.
 
          DEBIANNAME_${PN} = "dbus-1"
 
-   :term:`DEBUGINFOD_URLS`
-      Points to the URL of the "debuginfod" server. Such that for every
-      debugging information lookup, the debuginfod client will query the
-      server and return the requested information. You set this variable
-      in your ``local.conf`` file.
-
    :term:`DEBUG_BUILD`
       Specifies to build packages with debugging information. This
       influences the value of the ``SELECTED_OPTIMIZATION`` variable.
-- 
2.30.2

\r

[-- Attachment #2.1.2: Type: text/plain, Size: 441 bytes --]


-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#150667): https://lists.openembedded.org/g/openembedded-core/message/150667
Mute This Topic: https://lists.openembedded.org/mt/82204271/1686473
Group Owner: openembedded-core+owner@lists.openembedded.org
Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub [richard.purdie@linuxfoundation.org]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [docs] [OE-core] [PATCH 4/4] dev-manual/common-tasks.rst: correct the documentation for debuginfod

[Quentin Schulz]

Hi all,

On Mon, Apr 19, 2021 at 11:11:21AM +0100, Richard Purdie wrote:
> Forwarded from OE-Core to ensure docs people see it.
> 
> Cheers,
> 
> Richard

> Date: Mon, 19 Apr 2021 11:00:44 +0200
> From: Alexander Kanavin <alex.kanavin@gmail.com>
> To: openembedded-core@lists.openembedded.org
> Cc: Alexander Kanavin <alex.kanavin@gmail.com>
> Subject: [OE-core] [PATCH 4/4] dev-manual/common-tasks.rst: correct the
>  documentation for debuginfod
> 
> Particularly,
> - correctly describe the use of DEBUGINFOD_URLS; drop it from bitbake variables
> - all necessary component tweaks are enabled by default via DISTRO_FEATURES
> - provide on-target examples of what to look for when things work properly
> 
> Signed-off-by: Alexander Kanavin <alex.kanavin@gmail.com>
> ---
>  documentation/dev-manual/common-tasks.rst | 34 +++++++++++++++--------
>  documentation/ref-manual/variables.rst    |  6 ----
>  2 files changed, 22 insertions(+), 18 deletions(-)
> 
> diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
> index 176025f9e8..9f33b6b2c8 100644
> --- a/documentation/dev-manual/common-tasks.rst
> +++ b/documentation/dev-manual/common-tasks.rst
> @@ -10005,34 +10005,44 @@ debug symbols from the server.
>  
>  To run a debuginfod server, you need to do the following:
>  
> --  Ensure that this variable is set in your ``local.conf`` file:
> +-  Ensure that "debuginfod" is present in :term:`DISTRO_FEATURES

Missing trailing `.

> +   (it already is in oe-core defaults and poky reference distribution).

s/oe-core/``OpenEmbedded-core/ ?
s/poky/``poky``/ ?

> +   If not, set:
>     ::
>  
> -      PACKAGECONFIG_pn-elfutils-native = "debuginfod libdebuginfod"
> +      DISTRO_FEATURES_append = " debuginfod"
>  
> -   This :term:`PACKAGECONFIG` option enables debuginfod and libdebuginfod for
> -   "elfutils-native".
> +   This distro feature enables the server and client library in elfutils,

s/elfutils/``elfutils``/ ?

> +   and enables debuginfod support in clients (at the moment, gdb and binutils).
>  

s/debuginfod/``debuginfod``/ ?
s/gdb/``gdb``/ ?
s/binutils/``binutils``/ ?

> --  Run the following commands to set up the "debuginfod" server:
> +-  Run the following commands to launch the "debuginfod" server on the host:

s/"debuginfod"/``debuginfod``/ ?

>     ::
>  
>        $ oe-debuginfod
>  
> +-  To use debuginfod on the target, you need to know the ip:port where
> +   debuginfod is listening on the host (port defaults to 8002), and export

s/debuginfod/``debuginfod``/ for both debuginfod?

> +   that into the shell environment, for example in qemu:

s/qemu/``qemu``/ ?

> +   ::
>  

It should be:

that into the shell environment, for example in qemu::

instead.

> -To use debuginfod on the target, you need the following:
> +      root@qemux86-64:~# export DEBUGINFOD_URLS="http://192.168.7.1:8002/"
>  
> --  Ensure that this variable is set in your ``local.conf`` file:
> +-  Then debug info fetching should simply work when running the target gdb,

s/gdb/``gdb``/ ?

> +   readelf or objdump, for example:

s/readelf/``readelf``/ ?
s/objdump/``objdump``/ ?

>     ::
>  

It should be:

readelf or objdump, for example::

instead.

> -      DEBUGINFOD_URLS = "http://localhost:8002/"
> -
> -   This :term:`DEBUGINFOD_URLS` option does the client configuration.
> +      root@qemux86-64:~# gdb /bin/cat
> +      ...
> +      Reading symbols from /bin/cat...
> +      Downloading separate debug info for /bin/cat...
> +      Reading symbols from /home/root/.cache/debuginfod_client/923dc4780cfbc545850c616bffa884b6b5eaf322/debuginfo...
>  
> +-  It's also possible to use "debuginfod-find" to just query the server:

s/"debuginfod-find"/``debuginfod-find``/ ?

>     ::
>  

It should be:

It's also possible to use "debuginfod-find" to just query the server::

instead.

Cheers,
Quentin

Re: [docs] [OE-core] [PATCH 4/4] dev-manual/common-tasks.rst: correct the documentation for debuginfod

[Alexander Kanavin]

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

Thank you, I will fix these up and resend. Is docs@ the right destination
for patches to documentation/ ?

Alex

On Mon, 19 Apr 2021 at 12:33, Quentin Schulz <
quentin.schulz@streamunlimited.com> wrote:

> Hi all,
>
> On Mon, Apr 19, 2021 at 11:11:21AM +0100, Richard Purdie wrote:
> > Forwarded from OE-Core to ensure docs people see it.
> >
> > Cheers,
> >
> > Richard
>
> > Date: Mon, 19 Apr 2021 11:00:44 +0200
> > From: Alexander Kanavin <alex.kanavin@gmail.com>
> > To: openembedded-core@lists.openembedded.org
> > Cc: Alexander Kanavin <alex.kanavin@gmail.com>
> > Subject: [OE-core] [PATCH 4/4] dev-manual/common-tasks.rst: correct the
> >  documentation for debuginfod
> >
> > Particularly,
> > - correctly describe the use of DEBUGINFOD_URLS; drop it from bitbake
> variables
> > - all necessary component tweaks are enabled by default via
> DISTRO_FEATURES
> > - provide on-target examples of what to look for when things work
> properly
> >
> > Signed-off-by: Alexander Kanavin <alex.kanavin@gmail.com>
> > ---
> >  documentation/dev-manual/common-tasks.rst | 34 +++++++++++++++--------
> >  documentation/ref-manual/variables.rst    |  6 ----
> >  2 files changed, 22 insertions(+), 18 deletions(-)
> >
> > diff --git a/documentation/dev-manual/common-tasks.rst
> b/documentation/dev-manual/common-tasks.rst
> > index 176025f9e8..9f33b6b2c8 100644
> > --- a/documentation/dev-manual/common-tasks.rst
> > +++ b/documentation/dev-manual/common-tasks.rst
> > @@ -10005,34 +10005,44 @@ debug symbols from the server.
> >
> >  To run a debuginfod server, you need to do the following:
> >
> > --  Ensure that this variable is set in your ``local.conf`` file:
> > +-  Ensure that "debuginfod" is present in :term:`DISTRO_FEATURES
>
> Missing trailing `.
>
> > +   (it already is in oe-core defaults and poky reference distribution).
>
> s/oe-core/``OpenEmbedded-core/ ?
> s/poky/``poky``/ ?
>
> > +   If not, set:
> >     ::
> >
> > -      PACKAGECONFIG_pn-elfutils-native = "debuginfod libdebuginfod"
> > +      DISTRO_FEATURES_append = " debuginfod"
> >
> > -   This :term:`PACKAGECONFIG` option enables debuginfod and
> libdebuginfod for
> > -   "elfutils-native".
> > +   This distro feature enables the server and client library in
> elfutils,
>
> s/elfutils/``elfutils``/ ?
>
> > +   and enables debuginfod support in clients (at the moment, gdb and
> binutils).
> >
>
> s/debuginfod/``debuginfod``/ ?
> s/gdb/``gdb``/ ?
> s/binutils/``binutils``/ ?
>
> > --  Run the following commands to set up the "debuginfod" server:
> > +-  Run the following commands to launch the "debuginfod" server on the
> host:
>
> s/"debuginfod"/``debuginfod``/ ?
>
> >     ::
> >
> >        $ oe-debuginfod
> >
> > +-  To use debuginfod on the target, you need to know the ip:port where
> > +   debuginfod is listening on the host (port defaults to 8002), and
> export
>
> s/debuginfod/``debuginfod``/ for both debuginfod?
>
> > +   that into the shell environment, for example in qemu:
>
> s/qemu/``qemu``/ ?
>
> > +   ::
> >
>
> It should be:
>
> that into the shell environment, for example in qemu::
>
> instead.
>
> > -To use debuginfod on the target, you need the following:
> > +      root@qemux86-64:~# export DEBUGINFOD_URLS="
> http://192.168.7.1:8002/"
> >
> > --  Ensure that this variable is set in your ``local.conf`` file:
> > +-  Then debug info fetching should simply work when running the target
> gdb,
>
> s/gdb/``gdb``/ ?
>
> > +   readelf or objdump, for example:
>
> s/readelf/``readelf``/ ?
> s/objdump/``objdump``/ ?
>
> >     ::
> >
>
> It should be:
>
> readelf or objdump, for example::
>
> instead.
>
> > -      DEBUGINFOD_URLS = "http://localhost:8002/"
> > -
> > -   This :term:`DEBUGINFOD_URLS` option does the client configuration.
> > +      root@qemux86-64:~# gdb /bin/cat
> > +      ...
> > +      Reading symbols from /bin/cat...
> > +      Downloading separate debug info for /bin/cat...
> > +      Reading symbols from
> /home/root/.cache/debuginfod_client/923dc4780cfbc545850c616bffa884b6b5eaf322/debuginfo...
> >
> > +-  It's also possible to use "debuginfod-find" to just query the server:
>
> s/"debuginfod-find"/``debuginfod-find``/ ?
>
> >     ::
> >
>
> It should be:
>
> It's also possible to use "debuginfod-find" to just query the server::
>
> instead.
>
> Cheers,
> Quentin
>

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

Re: [docs] [OE-core] [PATCH 4/4] dev-manual/common-tasks.rst: correct the documentation for debuginfod

[Quentin Schulz]

Hi Alex,

On Mon, Apr 19, 2021 at 02:39:00PM +0200, Alexander Kanavin wrote:
> Thank you, I will fix these up and resend. Is docs@ the right destination
> for patches to documentation/ ?
> 

Yes, as far as my understanding goes, documentation/ in poky is handled
the same way as e.g. meta layer (which comes from openembedded-core).
So, the actual git repo/branch to base your patch against is:
https://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs branch master
or master-next if there are conflicts not straightforward to fix.

There, you can read
https://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/README to
know how to contribute and
https://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/README
to know a bit more about what's what and the rules (until we get a
CONTRIBUTING or GUIDELINES or whatever file to explain the implicit
rules).

Let us know if there's anything that needs clarification or if you need
help!

Cheers,
Quentin

> Alex
> 
> On Mon, 19 Apr 2021 at 12:33, Quentin Schulz <
> quentin.schulz@streamunlimited.com> wrote:
> 
> > Hi all,
> >
> > On Mon, Apr 19, 2021 at 11:11:21AM +0100, Richard Purdie wrote:
> > > Forwarded from OE-Core to ensure docs people see it.
> > >
> > > Cheers,
> > >
> > > Richard
> >
> > > Date: Mon, 19 Apr 2021 11:00:44 +0200
> > > From: Alexander Kanavin <alex.kanavin@gmail.com>
> > > To: openembedded-core@lists.openembedded.org
> > > Cc: Alexander Kanavin <alex.kanavin@gmail.com>
> > > Subject: [OE-core] [PATCH 4/4] dev-manual/common-tasks.rst: correct the
> > >  documentation for debuginfod
> > >
> > > Particularly,
> > > - correctly describe the use of DEBUGINFOD_URLS; drop it from bitbake
> > variables
> > > - all necessary component tweaks are enabled by default via
> > DISTRO_FEATURES
> > > - provide on-target examples of what to look for when things work
> > properly
> > >
> > > Signed-off-by: Alexander Kanavin <alex.kanavin@gmail.com>
> > > ---
> > >  documentation/dev-manual/common-tasks.rst | 34 +++++++++++++++--------
> > >  documentation/ref-manual/variables.rst    |  6 ----
> > >  2 files changed, 22 insertions(+), 18 deletions(-)
> > >
> > > diff --git a/documentation/dev-manual/common-tasks.rst
> > b/documentation/dev-manual/common-tasks.rst
> > > index 176025f9e8..9f33b6b2c8 100644
> > > --- a/documentation/dev-manual/common-tasks.rst
> > > +++ b/documentation/dev-manual/common-tasks.rst
> > > @@ -10005,34 +10005,44 @@ debug symbols from the server.
> > >
> > >  To run a debuginfod server, you need to do the following:
> > >
> > > --  Ensure that this variable is set in your ``local.conf`` file:
> > > +-  Ensure that "debuginfod" is present in :term:`DISTRO_FEATURES
> >
> > Missing trailing `.
> >
> > > +   (it already is in oe-core defaults and poky reference distribution).
> >
> > s/oe-core/``OpenEmbedded-core/ ?
> > s/poky/``poky``/ ?
> >
> > > +   If not, set:
> > >     ::
> > >
> > > -      PACKAGECONFIG_pn-elfutils-native = "debuginfod libdebuginfod"
> > > +      DISTRO_FEATURES_append = " debuginfod"
> > >
> > > -   This :term:`PACKAGECONFIG` option enables debuginfod and
> > libdebuginfod for
> > > -   "elfutils-native".
> > > +   This distro feature enables the server and client library in
> > elfutils,
> >
> > s/elfutils/``elfutils``/ ?
> >
> > > +   and enables debuginfod support in clients (at the moment, gdb and
> > binutils).
> > >
> >
> > s/debuginfod/``debuginfod``/ ?
> > s/gdb/``gdb``/ ?
> > s/binutils/``binutils``/ ?
> >
> > > --  Run the following commands to set up the "debuginfod" server:
> > > +-  Run the following commands to launch the "debuginfod" server on the
> > host:
> >
> > s/"debuginfod"/``debuginfod``/ ?
> >
> > >     ::
> > >
> > >        $ oe-debuginfod
> > >
> > > +-  To use debuginfod on the target, you need to know the ip:port where
> > > +   debuginfod is listening on the host (port defaults to 8002), and
> > export
> >
> > s/debuginfod/``debuginfod``/ for both debuginfod?
> >
> > > +   that into the shell environment, for example in qemu:
> >
> > s/qemu/``qemu``/ ?
> >
> > > +   ::
> > >
> >
> > It should be:
> >
> > that into the shell environment, for example in qemu::
> >
> > instead.
> >
> > > -To use debuginfod on the target, you need the following:
> > > +      root@qemux86-64:~# export DEBUGINFOD_URLS="
> > http://192.168.7.1:8002/"
> > >
> > > --  Ensure that this variable is set in your ``local.conf`` file:
> > > +-  Then debug info fetching should simply work when running the target
> > gdb,
> >
> > s/gdb/``gdb``/ ?
> >
> > > +   readelf or objdump, for example:
> >
> > s/readelf/``readelf``/ ?
> > s/objdump/``objdump``/ ?
> >
> > >     ::
> > >
> >
> > It should be:
> >
> > readelf or objdump, for example::
> >
> > instead.
> >
> > > -      DEBUGINFOD_URLS = "http://localhost:8002/"
> > > -
> > > -   This :term:`DEBUGINFOD_URLS` option does the client configuration.
> > > +      root@qemux86-64:~# gdb /bin/cat
> > > +      ...
> > > +      Reading symbols from /bin/cat...
> > > +      Downloading separate debug info for /bin/cat...
> > > +      Reading symbols from
> > /home/root/.cache/debuginfod_client/923dc4780cfbc545850c616bffa884b6b5eaf322/debuginfo...
> > >
> > > +-  It's also possible to use "debuginfod-find" to just query the server:
> >
> > s/"debuginfod-find"/``debuginfod-find``/ ?
> >
> > >     ::
> > >
> >
> > It should be:
> >
> > It's also possible to use "debuginfod-find" to just query the server::
> >
> > instead.
> >
> > Cheers,
> > Quentin
> >

> 
> 
> 


-- 
StreamUnlimited Engineering GmbH
High Tech Campus Vienna, Gutheil-Schoder-Gasse 10, 1100 Vienna, Austria
Fax: +43 1 667 20 02 4401
quentin.schulz@streamunlimited.com, www.streamunlimited.com