RE: [OE-core] [PATCH] package.bbclass: Add support for specifying a suffix for debug files

[Peter Kjellerstedt <peter.kjellerstedt@axis.com>]

*ping*

//Peter

> -----Original Message-----
> From: openembedded-core@lists.openembedded.org <openembedded-core@lists.openembedded.org> On Behalf Of Peter Kjellerstedt
> Sent: den 24 december 2021 18:19
> To: Khem Raj <raj.khem@gmail.com>
> Cc: Patches and discussions about the oe-core layer <openembedded-core@lists.openembedded.org>
> Subject: Re: [OE-core] [PATCH] package.bbclass: Add support for specifying a suffix for debug files
> 
> > -----Original Message-----
> > From: Khem Raj <raj.khem@gmail.com>
> > Sent: den 24 december 2021 06:53
> > To: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
> > Cc: Patches and discussions about the oe-core layer <openembedded-core@lists.openembedded.org>
> > Subject: Re: [OE-core] [PATCH] package.bbclass: Add support for specifying a suffix for debug files
> >
> > On Thu, Dec 23, 2021 at 2:36 AM Peter Kjellerstedt <peter.kjellerstedt@axis.com> wrote:
> > >
> > > The suffix is added to the names of all files with debug symbols
> > > produced by split_and_strip_files(). It can be used to make the debug
> > > files produced by one recipe unique to avoid them conflicting with
> > > identically named debug files produced by another recipe. This may be
> > > needed since while the target files may be split in multiple packages,
> > > the debug files for one recipe are all in one package.
> > >
> >
> > can you point to an example recipe clash ?
> 
> Not in OE-Core or OpenEmbedded. The example that required me to have to find
> a solution was that we have our own implementation of an srtp plugin for
> GStreamer that some of our products use, while some of our products use the
> official version from gstreamer1.0-plugins-bad. Our version is a drop-in
> replacement so it provides the libgstrtsp.so plugin just like the original
> package from gstreamer1.0-plugins-bad does. This is no problem for target as
> the GStreamer plugins are packaged one module per package. However, as the
> debug files are all in one package, the libgstrtsp.so file in our dbg package
> conflicts with the libgstrtsp.so in the gstreamer1.0-plugins-bad-dbg package
> and this becomes a problem for any product that uses both our rtsp plugin
> and some other plugin from gstreamer1.0-plugins-bad.
> 
> //Peter
> 
> > > Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
> > > ---
> > >  meta/classes/package.bbclass | 11 +++++++++++
> > >  meta/conf/documentation.conf |  1 +
> > >  2 files changed, 12 insertions(+)
> > >
> > > diff --git a/meta/classes/package.bbclass b/meta/classes/package.bbclass
> > > index 09cd376f4a..3df1edd4a8 100644
> > > --- a/meta/classes/package.bbclass
> > > +++ b/meta/classes/package.bbclass
> > > @@ -62,6 +62,14 @@ PACKAGE_DEPENDS += "rpm-native dwarfsrcfiles-native"
> > >  # tools at rootfs build time.
> > >  PACKAGE_WRITE_DEPS ??= ""
> > >
> > > +# This suffix is added to the names of all files with debug symbols produced by
> > > +# split_and_strip_files(). It can be used to make the debug files produced by
> > > +# one recipe unique to avoid them conflicting with identically named debug files
> > > +# produced by another recipe. This may be needed since while the target files
> > > +# may be split in multiple packages, the debug files for one recipe are all in
> > > +# one package.
> > > +PACKAGE_DEBUG_FILE_SUFFIX ??= ""
> > > +
> > >  def legitimize_package_name(s):
> > >      """
> > >      Make sure package names are legitimate strings
> > > @@ -1117,6 +1125,9 @@ python split_and_strip_files () {
> > >          debugstaticlibdir = ""
> > >          debugsrcdir = "/usr/src/debug"
> > >
> > > +    debugappend += d.getVar('PACKAGE_DEBUG_FILE_SUFFIX')
> > > +    debugstaticappend += d.getVar('PACKAGE_DEBUG_FILE_SUFFIX')
> > > +
> > >      #
> > >      # First lets figure out all of the files we may have to process ... do this only once!
> > >      #
> > > diff --git a/meta/conf/documentation.conf b/meta/conf/documentation.conf
> > > index f63f4b223a..ad49410249 100644
> > > --- a/meta/conf/documentation.conf
> > > +++ b/meta/conf/documentation.conf
> > > @@ -311,6 +311,7 @@ PACKAGE_ARCH[doc] = "The architecture of the resulting package or packages."
> > >  PACKAGE_ARCHS[doc] = "A list of architectures compatible with the given target in order of priority."
> > >  PACKAGE_BEFORE_PN[doc] = "Enables easily adding packages to PACKAGES before ${PN} so that the packages can pick up files that would normally be included in the default package."
> > >  PACKAGE_CLASSES[doc] = "This variable specifies the package manager to use when packaging data. It is set in the conf/local.conf file in the Build Directory."
> > > +PACKAGE_DEBUG_FILE_SUFFIX[doc] = "This suffix is added to the names of all files with debug symbols in the dbg package."
> > >  PACKAGE_EXCLUDE[doc] = "Packages to exclude from the installation. If a listed package is required, an error is generated."
> > >  PACKAGE_EXTRA_ARCHS[doc] = "Specifies the list of architectures compatible with the device CPU. This variable is useful when you build for several different devices that use miscellaneous processors."
> > >  PACKAGE_INSTALL[doc] = "List of the packages to be installed into the image. The variable is generally not user-defined and uses IMAGE_INSTALL as part of the list."