Yocto: install files with -dev recipe

[Mowlwurf]

Hello,

I’m trying to use the -dev version of a self written recipe.

Let’s say there is a recipe foo.bb which does nothing except from installing a systemd-service in the rootfs:

SUMMARY = "example recipe"
PR = "r0"

SRC_URI += "file://foo.service"

inherit systemd

do_install() {
    install -d ${D}${systemd_unitdir}/system/
    install -m 0644 ${WORKDIR}/foo.service ${D}${systemd_unitdir}/system
}

SYSTEMD_PACKAGES = "${PN}"
SYSTEMD_SERVICE:${PN} = "foo.service"

Now there should be a second systemd service bar.service which shall only be installed when the package foo-dev is added to the image. But this service should not be activated automatically.

I tried by adding the following to foo.bb :

SRC_URI:{PN}-dev += "file://bar.service"

do_install:append:${PN}-dev() {
    install -d ${D}${systemd_unitdir}/system/
    install -m 0644 ${WORKDIR}/bar.service ${D}${systemd_unitdir}/system
}

SYSTEMD_PACKAGES += "${PN}-dev"
SYSTEMD_SERVICE:${PN}-dev = "bar.service"
SYSTEMD_AUTO_ENABLE:${PN}-dev = "disable"

But bar.service isn’t installed to my rootfs and I get the following error when building the image:

ERROR: foo-1.0-r0 do_package: Didn't find service unit 'bar.service', specified in SYSTEMD_SERVICE:foo-dev.

Does somebody know how to solve this problem?

Best regards,
Markus

[ToradexAI]

Hi, I’m the Toradex AI Assistant. The Toradex Support team will follow up with you shortly!

Did you like my answer?

---

Hello Markus,

To address the issue with your Yocto recipe where bar.service is not being installed as part of the foo-dev package, please follow these steps:

1. Verify File Location: Ensure bar.service is in the correct directory within your layer, ideally alongside foo.service, or ensure it is correctly referenced in your SRC_URI.

2. Correct SRC_URI Syntax: Modify the syntax for appending to SRC_URI. Instead of SRC_URI:{PN}-dev += "file://bar.service", use:

   SRC_URI_append_${PN}-dev = " file://bar.service"
   

   Note the use of _append and the space before file://bar.service.

3. Ensure File is Packaged: Confirm that bar.service is included in the foo-dev package by checking the do_package task logs.

4. Check SYSTEMD_SERVICE Variable: Verify that SYSTEMD_SERVICE:${PN}-dev is set to bar.service, ensuring the build system looks for it in the foo-dev package.

5. Disable Auto-Enable: You have correctly set SYSTEMD_AUTO_ENABLE:${PN}-dev = "disable", which should prevent bar.service from being enabled by default.

6. Rebuild the Image: After making these changes, clean and rebuild your image to apply all modifications:

   bitbake -c clean foo
   bitbake foo
   bitbake <your-image>
   

By following these steps, bar.service should be included in the foo-dev package and installed in the root filesystem when the package is added to the image. If issues persist, double-check the file paths and ensure all syntax is correct in your recipe.

Best regards,
Toradex AI Assistant

Please, also check if these links can help you solve your problem:

Recipe editing/modification in Yocto build system

Hi buddies~ Would you guys guide me to the quickest/easiest way to modify/customize recipes in Yocto distirubution? I do not want to change original .bb file and sources. Can I simply override everythings in previous .bb file by creating one more recipe with the same name under my own layer? After editing/modifying sources, do I have to generate diff file and put it into under files/ folder and add it to SRC_URI ? Hey… man it’s too bunch of finger sliding over keyboard… Any your nice handlin…

https://community.nxp.com/t5/i-MX-Processors/How-to-automatically-start-services-with-systemd-in-Yocto/m-p/746499.

[rudhi.tx]

Hello @Mowlwurf,

I’m not a Yocto expert (and most of our team is busy attending Embedded World right now!), but looking into some recipes that we have in the layers, I have an idea that this might work:

SUMMARY = "example recipe"
PR = "r0"

SRC_URI += "file://foo.service"
SRC_URI += "file://bar.service"

inherit systemd

do_install() {
    install -d ${D}${systemd_unitdir}/system/
    install -m 0644 ${WORKDIR}/foo.service ${D}${systemd_unitdir}/system/
}

do_install:append:foo-dev() {
    install -m 0644 ${WORKDIR}/bar.service ${D}${systemd_unitdir}/system/
}

SYSTEMD_PACKAGES = "${PN}"
SYSTEMD_SERVICE:${PN} = "foo.service"

PACKAGES += "${PN}-dev"
FILES:${PN}-dev += "${systemd_unitdir}/system/bar.service"

SYSTEMD_PACKAGES += "${PN}-dev"
SYSTEMD_SERVICE:${PN}-dev = "bar.service"
SYSTEMD_AUTO_ENABLE:${PN}-dev = "disable"

Could you please give it a try?

[Mowlwurf]

Hello @rudhi.tx,

thank you for your response.
I tried your suggestion with the following results:

• when calling bitbake foo-devI get the error

ERROR: Nothing PROVIDES 'foo-dev'. Close matches:
  foo RPROVIDES foo-dev

• when adding foo-devto my image and building this image I get

ERROR: foo-1.0-r0 do_package: Didn't find service unit 'bar.service', specified in SYSTEMD_SERVICE:foo-dev.

It seems that the function do_install:append:${PN}-dev()isn’t called by bitbake.

Best regards,
Markus

[rudhi.tx]

@Mowlwurf,

Probably the correct approach is to use a separate package. I read that -devpackage is primarily used for development-related files such as headers and libraries, not for installing system services.
Could you please try this:

SUMMARY = "example recipe"
PR = "r0"

SRC_URI += "file://foo.service"
SRC_URI += "file://bar.service"

inherit systemd

do_install() {
    install -d ${D}${systemd_unitdir}/system/
    install -m 0644 ${WORKDIR}/foo.service ${D}${systemd_unitdir}/system/
}

# Append installation for the extra package (foo-extra)
do_install:append:foo-extra() {
    install -m 0644 ${WORKDIR}/bar.service ${D}${systemd_unitdir}/system/
}

# Define systemd service for foo (always included)
SYSTEMD_PACKAGES = "${PN}"
SYSTEMD_SERVICE:${PN} = "foo.service"

# Define a separate package (foo-extra) for bar.service
PACKAGES += "${PN}-extra"
FILES:${PN}-extra += "${systemd_unitdir}/system/bar.service"

# Ensure bar.service is not auto-enabled
SYSTEMD_PACKAGES += "${PN}-extra"
SYSTEMD_SERVICE:${PN}-extra = "bar.service"
SYSTEMD_AUTO_ENABLE:${PN}-extra = "disable"

[Mowlwurf]

Hello @rudhi.tx,

I get the same errors like in my answer above. Just this time for ‘foo-extra’:

• bitbake foo-extra:

ERROR: Nothing PROVIDES 'foo-extra'. Close matches:
  foo RPROVIDES foo-extra

• building image with added ‘foo-extra’:

ERROR: foo-1.0-r0 do_package: Didn't find service unit 'bar.service', specified in SYSTEMD_SERVICE:foo-extra.

Best regards,
Markus

[rudhi.tx]

Hello @Mowlwurf,

In this case, you cannot run bitbake foo-extra since foo-extra is not a standalone recipe. It is a subpackage of the main recipe foo. I got a reference minimal image (BSP 7) build working with your requirements for installing conditional systemd services.
I created a new layer called meta-customer for this:

meta-customer
├── conf
│   └── layer.conf
├── COPYING.MIT
├── README
└── recipes-foo
    └── foo
        ├── files
        │   ├── bar.service
        │   └── foo.service
        └── foo_1.0.bb

I modified my recipe for foo as follows:

SUMMARY = "example recipe"
PR = "r0"

DESCRIPTION = "Recipe created by bitbake-layers"
LICENSE = "MIT"
LIC_FILES_CHKSUM = "file://${COREBASE}/meta/files/common-licenses/MIT;md5=0835ade698e0bcf8506ecda2f7b4f302"


SRC_URI += "file://foo.service"
SRC_URI += "file://bar.service"

inherit systemd

do_install() {
    install -d ${D}${systemd_unitdir}/system/
    install -m 0644 ${WORKDIR}/foo.service ${D}${systemd_unitdir}/system/
    install -m 0644 ${WORKDIR}/bar.service ${D}${systemd_unitdir}/system/
}

# Define systemd support
SYSTEMD_PACKAGES = "${PN} ${PN}-extra"
SYSTEMD_SERVICE:${PN} = "foo.service"
SYSTEMD_SERVICE:${PN}-extra = "bar.service"
SYSTEMD_AUTO_ENABLE:${PN}-extra = "disable"

PACKAGES += "${PN}-extra"
FILES:${PN}-extra = "${systemd_unitdir}/system/bar.service"
FILES:${PN} += "${systemd_unitdir}/system/foo.service"

Next, you need to include foo and foo-extra packages in your image by adding the following in your build/conf/local.conf file:

IMAGE_INSTALL:append = " foo"
IMAGE_INSTALL:append = " foo-extra"

After this, you can test by rebuilding your package and image:

bitbake -c clean foo
bitbake foo
bitbake tdx-reference-minimal-image

Let me know how it goes if you get a chance to test this.

[Mowlwurf]

Hello @rudhi.tx,

thank you for your response and your help.

Your suggestion works. Adding the install -m 0644 ${WORKDIR}/bar.service ${D}${systemd_unitdir}/system/ to the general do_install() did the trick.

Do you know why the do_install:append:foo-extra() is ignored by bitbake?

Best regards,
Markus