Skip to contentSkip to conversation

scripts/oe-debuginfod: correct several issues

PATCH In review Alexander Kanavin 4 participants 13 messages Apr 19, 2021 – Apr 20, 2021 1 message not in the archive

lore
Share & tools
lore
#0 lore raw

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

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

---
 scripts/oe-debuginfod | 13 ++++---------
 1 file changed, 4 insertions(+), 9 deletions(-)
scripts/oe-debuginfod +4 -9
index 967dd5807c..5560769888 100755
@@ -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")
Signature · 1 line
2.30.2
#1 lore raw

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

This is required to enable debuginfod in elfutils.

---
 .../libmicrohttpd/libmicrohttpd_0.9.72.bb     | 31 +++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb
meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb new file +31 -0
new file mode 100644
index 0000000000..66c48da3b7
@@ -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"
Signature · 1 line
2.30.2
#2 lore raw

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

Quoted 2 lines · Alexander Kanavin

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.

Quoted 48 lines
---
  .../libmicrohttpd/libmicrohttpd_0.9.72.bb     | 31 +++++++++++++++++++
  1 file changed, 31 insertions(+)

create mode 100644 meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb

meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb new file +31 -0
new file mode 100644
index 0000000000..66c48da3b7
@@ -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"
#3 lore raw

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

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

Alex

Quoted 63 lines · Khem Raj
Quoted 2 lines · Alexander Kanavin

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.

Quoted 5 lines
---
  .../libmicrohttpd/libmicrohttpd_0.9.72.bb     | 31 +++++++++++++++++++
  1 file changed, 31 insertions(+)

create mode 100644 meta/recipes-support/libmicrohttpd/

libmicrohttpd_0.9.72.bb

Review

Quoted 2 lines
(quoted diff) +0 -0

b/meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb

meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb line 1

Quoted 6 lines

new file mode 100644
index 0000000000..66c48da3b7

meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb new file +1 -0
@@ -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"

meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb

Quoted 10 lines
meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb new file +10 -0
+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"

Quoted 4 lines
meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb new file +4 -0
+
+inherit autotools lib_package pkgconfig gettext
+
+CFLAGS += "-pthread -D_REENTRANT"

meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb

Quoted 10 lines
meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb new file +10 -0
+
+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,"

Quoted 11 lines
meta/recipes-support/libmicrohttpd/libmicrohttpd_0.9.72.bb new file +6 -0
+
+do_compile_append() {
+    sed -i s:-L${STAGING_LIBDIR}::g libmicrohttpd.pc
+}
+
+BBCLASSEXTEND = "native nativesdk"
#4 lore raw

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

In reply to 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.

---
 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(-)
meta/conf/distro/include/default-distrovars.inc +1 -1
index 433d4b6651..9fcc10f83a 100644
@@ -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 ?= ""
 
meta/recipes-devtools/binutils/binutils_2.36.bb +1 -1
index a50d2ee7ee..ee9617de1d 100644
@@ -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
meta/recipes-devtools/elfutils/elfutils_0.183.bb +1 -1
index c0833686de..8b1dece200 100644
@@ -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"
meta/recipes-devtools/gdb/gdb-common.inc +1 -1
index 6e04552034..a2a6364daf 100644
@@ -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"
Signature · 1 line
2.30.2
#5 lore raw

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

Quoted 8 lines · 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.

Quoted 7 lines

---

 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

A message that is not in the archive (sent off-list or not yet received): [email protected]

#7 lore raw

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

Quoted 17 lines · Richard Purdie via lists.openembedded.org
Quoted 8 lines · 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.

Quoted 7 lines

---

 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(-)
Quoted 5 lines

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

#8 lore raw

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

Quoted 5 lines · Richard Purdie
Quoted 3 lines

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

Quoted 1 line
Quoted 9 lines
Quoted 1 line

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

#9 lore raw

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

In reply to 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

---
 documentation/dev-manual/common-tasks.rst | 34 +++++++++++++++--------
 documentation/ref-manual/variables.rst    |  6 ----
 2 files changed, 22 insertions(+), 18 deletions(-)
documentation/dev-manual/common-tasks.rst +22 -12
index 176025f9e8..9f33b6b2c8 100644
@@ -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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
documentation/ref-manual/variables.rst +0 -6
index 74ac12bf98..8a35b0960e 100644
@@ -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.
Signature · 1 line
2.30.2
#10 lore raw

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

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

Cheers,

Richard

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

---
 documentation/dev-manual/common-tasks.rst | 34 +++++++++++++++--------
 documentation/ref-manual/variables.rst    |  6 ----
 2 files changed, 22 insertions(+), 18 deletions(-)
documentation/dev-manual/common-tasks.rst +22 -12
index 176025f9e8..9f33b6b2c8 100644
@@ -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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
documentation/ref-manual/variables.rst +0 -6
index 74ac12bf98..8a35b0960e 100644
@@ -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.
Signature · 1 line
2.30.2

-=-=-=-=-=-=-=-=-=-=-=-
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: [email protected]
Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub [[email protected]]
-=-=-=-=-=-=-=-=-=-=-=-

#11 lore raw

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

Hi all,

Quoted 29 lines · Richard Purdie

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

Cheers,

Richard

Date: Mon, 19 Apr 2021 11:00:44 +0200
From: Alexander Kanavin <[email protected]>
To: [email protected]
Cc: Alexander Kanavin <[email protected]>
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

---
 documentation/dev-manual/common-tasks.rst | 34 +++++++++++++++--------
 documentation/ref-manual/variables.rst    |  6 ----
 2 files changed, 22 insertions(+), 18 deletions(-)
documentation/dev-manual/common-tasks.rst +0 -0
index 176025f9e8..9f33b6b2c8 100644

documentation/dev-manual/common-tasks.rst debug symbols from the server. · line 10008

Quoted 5 lines
documentation/dev-manual/common-tasks.rst +1 -1
@@ -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 `.

documentation/dev-manual/common-tasks.rst debug symbols from the server. · line 10009

Quoted 1 line
documentation/dev-manual/common-tasks.rst +1 -0
+   (it already is in oe-core defaults and poky reference distribution).

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

documentation/dev-manual/common-tasks.rst debug symbols from the server. · line 10015

Quoted 9 lines
documentation/dev-manual/common-tasks.rst +3 -3
+   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``/ ?

documentation/dev-manual/common-tasks.rst debug symbols from the server. · line 10017

Quoted 2 lines
documentation/dev-manual/common-tasks.rst +1 -0
+   and enables debuginfod support in clients (at the moment, gdb and binutils).
 

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

documentation/dev-manual/common-tasks.rst debug symbols from the server. · line 10018

Quoted 2 lines
documentation/dev-manual/common-tasks.rst +1 -1
--  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``/ ?

documentation/dev-manual/common-tasks.rst debug symbols from the server. · line 10024

Quoted 6 lines
documentation/dev-manual/common-tasks.rst +2 -0
    ::
 
       $ 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?

documentation/dev-manual/common-tasks.rst debug symbols from the server. · line 10025

Quoted 1 line
documentation/dev-manual/common-tasks.rst +1 -0
+   that into the shell environment, for example in qemu:

s/qemu/``qemu``/ ?

documentation/dev-manual/common-tasks.rst debug symbols from the server. · line 10027

Quoted 2 lines
documentation/dev-manual/common-tasks.rst +1 -0
+   ::
 

It should be:

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

instead.

documentation/dev-manual/common-tasks.rst debug symbols from the server. · line 10030

Quoted 5 lines
documentation/dev-manual/common-tasks.rst +2 -2
-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``/ ?

documentation/dev-manual/common-tasks.rst debug symbols from the server. · line 10031

Quoted 1 line
documentation/dev-manual/common-tasks.rst +1 -0
+   readelf or objdump, for example:

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

documentation/dev-manual/common-tasks.rst debug symbols from the server. · line 10033

Quoted 2 lines
documentation/dev-manual/common-tasks.rst +0 -0
    ::
 

It should be:

readelf or objdump, for example::

instead.

documentation/dev-manual/common-tasks.rst debug symbols from the server. · line 10040

Quoted 10 lines
documentation/dev-manual/common-tasks.rst +6 -3
-      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``/ ?

documentation/dev-manual/common-tasks.rst debug symbols from the server. · line 10042

Quoted 2 lines
documentation/dev-manual/common-tasks.rst +0 -0
    ::
 

It should be:

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

instead.

Cheers,
Quentin

#12 lore raw

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

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

Alex

Quoted 150 lines · Quentin Schulz

Hi all,

Quoted 13 lines · Richard Purdie

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

Cheers,

Richard

Date: Mon, 19 Apr 2021 11:00:44 +0200
From: Alexander Kanavin <[email protected]>
To: [email protected]
Cc: Alexander Kanavin <[email protected]>
Subject: [OE-core] [PATCH 4/4] dev-manual/common-tasks.rst: correct the
documentation for debuginfod

Quoted 2 lines

Particularly,
- correctly describe the use of DEBUGINFOD_URLS; drop it from bitbake

variables

Quoted 1 line

- all necessary component tweaks are enabled by default via

DISTRO_FEATURES

Quoted 1 line

- provide on-target examples of what to look for when things work

properly

Review

Quoted 8 lines
---
 documentation/dev-manual/common-tasks.rst | 34 +++++++++++++++--------
 documentation/ref-manual/variables.rst    |  6 ----
 2 files changed, 22 insertions(+), 18 deletions(-)
(quoted diff) +0 -0

b/documentation/dev-manual/common-tasks.rst

documentation/dev-manual/common-tasks.rst debug symbols from the server. · line 10008

Quoted 9 lines

index 176025f9e8..9f33b6b2c8 100644

documentation/dev-manual/common-tasks.rst +1 -1
@@ -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 `.

documentation/dev-manual/common-tasks.rst debug symbols from the server. · line 10009

Quoted 1 line
documentation/dev-manual/common-tasks.rst +1 -0
+   (it already is in oe-core defaults and poky reference distribution).

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

documentation/dev-manual/common-tasks.rst debug symbols from the server.

Quoted 7 lines
documentation/dev-manual/common-tasks.rst +2 -2
+   If not, set:
    ::
 
-      PACKAGECONFIG_pn-elfutils-native = "debuginfod libdebuginfod"
+      DISTRO_FEATURES_append = " debuginfod"
 
-   This :term:`PACKAGECONFIG` option enables debuginfod and

libdebuginfod for

documentation/dev-manual/common-tasks.rst debug symbols from the server. · line 10015

Quoted 2 lines
documentation/dev-manual/common-tasks.rst +1 -1
-   "elfutils-native".
+   This distro feature enables the server and client library in

elfutils,

s/elfutils/``elfutils``/ ?

documentation/dev-manual/common-tasks.rst debug symbols from the server. · line 10016

Quoted 1 line
documentation/dev-manual/common-tasks.rst +1 -0
+   and enables debuginfod support in clients (at the moment, gdb and

binutils).

Quoted 1 line

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

Quoted 2 lines

-- 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``/ ?

Quoted 6 lines
    ::

       $ 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?

Quoted 1 line

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

s/qemu/``qemu``/ ?

Quoted 2 lines

+ ::

It should be:

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

instead.

documentation/dev-manual/common-tasks.rst

Quoted 2 lines
documentation/dev-manual/common-tasks.rst +1 -1
-To use debuginfod on the target, you need the following:
+      root@qemux86-64:~# export DEBUGINFOD_URLS="

http://192.168.7.1:8002/"

Quoted 3 lines

-- 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``/ ?

Quoted 1 line

+ readelf or objdump, for example:

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

Quoted 2 lines
    ::

It should be:

readelf or objdump, for example::

instead.

documentation/dev-manual/common-tasks.rst debug symbols from the server.

Quoted 8 lines
documentation/dev-manual/common-tasks.rst +5 -3
-      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...

Quoted 2 lines

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

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

Quoted 2 lines
    ::

It should be:

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

instead.

Cheers,
Quentin

#13 lore raw

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

Hi Alex,

Quoted 3 lines · Alexander Kanavin

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

Quoted 159 lines

Alex

Quoted 150 lines · Quentin Schulz

Hi all,

Quoted 13 lines · Richard Purdie

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

Cheers,

Richard

Date: Mon, 19 Apr 2021 11:00:44 +0200
From: Alexander Kanavin <[email protected]>
To: [email protected]
Cc: Alexander Kanavin <[email protected]>
Subject: [OE-core] [PATCH 4/4] dev-manual/common-tasks.rst: correct the
documentation for debuginfod

Quoted 2 lines

Particularly,
- correctly describe the use of DEBUGINFOD_URLS; drop it from bitbake

variables

Quoted 1 line

- all necessary component tweaks are enabled by default via

DISTRO_FEATURES

Quoted 1 line

- provide on-target examples of what to look for when things work

properly

Review

Quoted 8 lines
---
 documentation/dev-manual/common-tasks.rst | 34 +++++++++++++++--------
 documentation/ref-manual/variables.rst    |  6 ----
 2 files changed, 22 insertions(+), 18 deletions(-)
(quoted diff) +0 -0

b/documentation/dev-manual/common-tasks.rst

documentation/dev-manual/common-tasks.rst debug symbols from the server. · line 10008

Quoted 9 lines

index 176025f9e8..9f33b6b2c8 100644

documentation/dev-manual/common-tasks.rst +1 -1
@@ -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 `.

documentation/dev-manual/common-tasks.rst debug symbols from the server. · line 10009

Quoted 1 line
documentation/dev-manual/common-tasks.rst +1 -0
+   (it already is in oe-core defaults and poky reference distribution).

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

documentation/dev-manual/common-tasks.rst debug symbols from the server.

Quoted 7 lines
documentation/dev-manual/common-tasks.rst +2 -2
+   If not, set:
    ::
 
-      PACKAGECONFIG_pn-elfutils-native = "debuginfod libdebuginfod"
+      DISTRO_FEATURES_append = " debuginfod"
 
-   This :term:`PACKAGECONFIG` option enables debuginfod and

libdebuginfod for

documentation/dev-manual/common-tasks.rst debug symbols from the server. · line 10015

Quoted 2 lines
documentation/dev-manual/common-tasks.rst +1 -1
-   "elfutils-native".
+   This distro feature enables the server and client library in

elfutils,

s/elfutils/``elfutils``/ ?

documentation/dev-manual/common-tasks.rst debug symbols from the server. · line 10016

Quoted 1 line
documentation/dev-manual/common-tasks.rst +1 -0
+   and enables debuginfod support in clients (at the moment, gdb and

binutils).

Quoted 1 line

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

Quoted 2 lines

-- 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``/ ?

Quoted 6 lines
    ::

       $ 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?

Quoted 1 line

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

s/qemu/``qemu``/ ?

Quoted 2 lines

+ ::

It should be:

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

instead.

documentation/dev-manual/common-tasks.rst

Quoted 2 lines
documentation/dev-manual/common-tasks.rst +1 -1
-To use debuginfod on the target, you need the following:
+      root@qemux86-64:~# export DEBUGINFOD_URLS="

http://192.168.7.1:8002/"

Quoted 3 lines

-- 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``/ ?

Quoted 1 line

+ readelf or objdump, for example:

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

Quoted 2 lines
    ::

It should be:

readelf or objdump, for example::

instead.

documentation/dev-manual/common-tasks.rst debug symbols from the server.

Quoted 8 lines
documentation/dev-manual/common-tasks.rst +5 -3
-      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...

Quoted 2 lines

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

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

Quoted 2 lines
    ::

It should be:

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

instead.

Cheers,
Quentin

Signature · 4 lines
StreamUnlimited Engineering GmbH
High Tech Campus Vienna, Gutheil-Schoder-Gasse 10, 1100 Vienna, Austria
Fax: +43 1 667 20 02 4401
[email protected], www.streamunlimited.com