build: SONIC_DEBUGGING_ON=y causes ipmitool-dbgsym other dbgsyms to _not_ get built

SONIC_DEBUGGING_ON=y sets DEB_BUILD_OPTIONS=nostrip and for certain packages, this causes dbgsym packages to not be produced.

Upstream bug: #-5982.

Getting no dbgsym package when debugging is on feels like the inverse of what we expect.

See this:

Set SONIC_DEBUGGING_ON=y in rules/config

$ make configure PLATFORM=broadcom &&
TERM=dumb make target/debs/bookworm/ipmitool_1.8.19-4+deb12u1_amd64.deb
...
make[3]: Leaving directory '/sonic/src/ipmitool/ipmitool-1.8.19'
dh_perl
dh_link
dh_strip_nondeterminism
dh_compress
dh_fixperms
dh_missing
dh: command-omitted: The call to "dh_dwz" was omitted due to "DEB_BUILD_OPTIONS=nostrip"
dh: command-omitted: The call to "dh_strip" was omitted due to "DEB_BUILD_OPTIONS=nostrip"
dh_makeshlibs -a
dh_shlibdeps -a
dh_installdeb
dh_gencontrol
dh_md5sums
dh_builddeb
dpkg-deb: building package 'ipmitool' in '../ipmitool_1.8.19-4+deb12u1_amd64.deb'.
make[2]: Leaving directory '/sonic/src/ipmitool/ipmitool-1.8.19'
dpkg-genbuildinfo --build=binary --admindir=/sonic/dpkg/tmp.WtYzayFxMh -O../ipmitool_1.8.19-4+deb12u1_amd64.buildinfo
dpkg-genchanges --build=binary -O../ipmitool_1.8.19-4+deb12u1_amd64.changes
dpkg-genchanges: info: binary-only upload (no source code included)
dpkg-source --after-build .
dpkg-buildpackage: info: binary-only upload (no source included)
/sonic/src/ipmitool
mv: cannot stat 'ipmitool-dbgsym_1.8.19-4+deb12u1_amd64.deb': No such file or directory
make[1]: *** [Makefile:9: /sonic/target/debs/bookworm/ipmitool_1.8.19-4+deb12u1_amd64.deb] Error 1
make[1]: Leaving directory '/sonic/src/ipmitool'
[  FAIL LOG END  ] [ target/debs/bookworm/ipmitool_1.8.19-4+deb12u1_amd64.deb ]
removed directory '/sonic/dpkg/tmp.WtYzayFxMh'
removed directory '/sonic/dpkg/tmp.Qp50WaAMwW'
removed directory '/sonic/dpkg/tmp.M8hn5MlHGo/work'
removed directory '/sonic/dpkg/tmp.M8hn5MlHGo'
make: *** [slave.mk:747: target/debs/bookworm/ipmitool_1.8.19-4+deb12u1_amd64.deb] Error 1
make[1]: *** [Makefile.work:605: target/debs/bookworm/ipmitool_1.8.19-4+deb12u1_amd64.deb] Error 2
make[1]: Leaving directory '/home/sonic-builder/build/sonic-buildimage'
make: *** [Makefile:49: target/debs/bookworm/ipmitool_1.8.19-4+deb12u1_amd64.deb] Error 2

^- failure

Unset SONIC_DEBUGGING_ON=y in rules/config

$ make configure PLATFORM=broadcom &&
TERM=dumb make target/debs/bookworm/ipmitool_1.8.19-4+deb12u1_amd64.deb
...
make[3]: Leaving directory '/sonic/src/ipmitool/ipmitool-1.8.19'
dh_perl
dh_link
dh_strip_nondeterminism
dh_compress
dh_fixperms
dh_missing
dh_dwz -a
dh_strip -a
dh_makeshlibs -a
dh_shlibdeps -a
dh_installdeb
dh_gencontrol
dh_md5sums
dh_builddeb
dpkg-deb: building package 'ipmitool-dbgsym' in '../ipmitool-dbgsym_1.8.19-4+deb12u1_amd64.deb'.
dpkg-deb: building package 'ipmitool' in '../ipmitool_1.8.19-4+deb12u1_amd64.deb'.
make[2]: Leaving directory '/sonic/src/ipmitool/ipmitool-1.8.19'
dpkg-genbuildinfo --build=binary --admindir=/sonic/dpkg/tmp.dE87sOGye5 -O../ipmitool_1.8.19-4+deb12u1_amd64.buildinfo
dpkg-genchanges --build=binary -O../ipmitool_1.8.19-4+deb12u1_amd64.changes
dpkg-genchanges: info: binary-only upload (no source code included)
dpkg-source --after-build .
dpkg-buildpackage: info: binary-only upload (no source included)
/sonic/src/ipmitool
make[1]: Leaving directory '/sonic/src/ipmitool'

^- success

Example with nostrip:

/sonic/src/ipmitool/ipmitool-1.8.19$ DEB_BUILD_OPTIONS=nostrip dpkg-buildpackage -rfakeroot -d -b -us -uc -j32 --admindir /tmp/foobar
...
dh: command-omitted: The call to "dh_dwz" was omitted due to "DEB_BUILD_OPTIONS=nostrip"
dh: command-omitted: The call to "dh_strip" was omitted due to "DEB_BUILD_OPTIONS=nostrip"
   dh_makeshlibs -a
   dh_shlibdeps -a
   dh_installdeb
   dh_gencontrol
   dh_md5sums
   dh_builddeb
dpkg-deb: building package 'ipmitool' in '../ipmitool_1.8.19-4+deb12u1_amd64.deb'.
 dpkg-genbuildinfo --build=binary --admindir=/tmp/foobar -O../ipmitool_1.8.19-4+deb12u1_amd64.buildinfo
 dpkg-genchanges --build=binary -O../ipmitool_1.8.19-4+deb12u1_amd64.changes
dpkg-genchanges: info: binary-only upload (no source code included)
 dpkg-source --after-build .
dpkg-buildpackage: info: binary-only upload (no source included)

^- no ipmitool-dbgsym_1.8.19-4+deb12u1_amd64.deb created

/sonic/src/ipmitool/ipmitool-1.8.19$ dpkg-buildpackage -rfakeroot -d -b -us -uc -j32 --admindir /tmp/foobar
...
   dh_dwz -a
   dh_strip -a
   dh_makeshlibs -a
   dh_shlibdeps -a
   dh_installdeb
   dh_gencontrol
   dh_md5sums
   dh_builddeb
dpkg-deb: building package 'ipmitool' in '../ipmitool_1.8.19-4+deb12u1_amd64.deb'.
dpkg-deb: building package 'ipmitool-dbgsym' in '../ipmitool-dbgsym_1.8.19-4+deb12u1_amd64.deb'.
 dpkg-genbuildinfo --build=binary --admindir=/tmp/foobar -O../ipmitool_1.8.19-4+deb12u1_amd64.buildinfo
 dpkg-genchanges --build=binary -O../ipmitool_1.8.19-4+deb12u1_amd64.changes
dpkg-genchanges: info: binary-only upload (no source code included)
 dpkg-source --after-build .
dpkg-buildpackage: info: binary-only upload (no source included)

^- now both files are created

I did find this on the internet: https://lists.debian.org/debian-devel/2015/05/msg00472.html

  * DH inhibits ddeb creation when either "dh_strip -k", "dh_strip
    --dbg-package" is used or when either "noddebs" or "nostrip" are
    given as/in DEB_BUILD_OPTIONS.

But not so much info here: https://manpages.debian.org/testing/debhelper/debhelper-compat-upgrade-checklist.7.en.html

I'm not entirely sure why/what. It could be the debhelper/compat mode that is related, or there is something else that I haven't seen yet. But the results speak for themselves: nostrip is not an expected feature, because the it breaks the build which expects the ipmitool-dbgsym to be built.

Perhaps we want DEB_BUILD_OPTIONS_GENERIC := debug instead?

ossobv / sonic-buildimage

build: SONIC_DEBUGGING_ON=y causes ipmitool-dbgsym other dbgsyms to _not_ get built #19