Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: rauc-conf needs to be appended now instead of rauc #327

Merged
merged 1 commit into from
Jun 18, 2024
Merged

README: rauc-conf needs to be appended now instead of rauc #327

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,18 @@ Please submit patches via GitHub pull request on https://github.com/rauc/meta-ra

Maintainer: Enrico Joerns <ejo@pengutronix.de>

Migration Notes
===============

Since **scarthgap**, the platform configuration (system.conf, keyring, etc.) was
moved to a separate ``rauc-conf.bb`` recipe to allow building the rauc package
with ``TUNE_PKGARCH`` and have a clearer separation between the binary and the
configuration.

Thus when updating to scarthgap or newer, make sure to move all
configuration-specific adaptions from your ``rauc_%.bbappend`` to a
``rauc-conf.bbappend`` file.


I. Adding the rauc Layer to Your Build
======================================
Expand Down Expand Up @@ -85,7 +97,7 @@ you have to follow at least the following steps:

DISTRO_FEATURES += "rauc"

2. Add a ``rauc_%.bbappend`` in your device-specific (BSP) layer
2. Add a ``rauc-conf.bbappend`` in your device-specific (BSP) layer
that installs your RAUC system configuration file under
``/etc/rauc/system.conf``. For information on how to write the RAUC
update file, please refer to the RAUC user documentation [1]_::
Expand Down
4 changes: 2 additions & 2 deletions scripts/README
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ To use them in your BSP in order to sign and verify bundles, you have to:

Copy the keyring file `dev/ca.cert.pem` into your projects meta layer under
`recipes-core/rauc/files` and add a simple rauc .bbappend file
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Formally in line 19 this should be "and add a simple rauc-conf .bbappend file", perhaps it would be better to just drop the first part and use "and add a simple .bbappend file" instead.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 I would be fine with both variants. Since the PR was merged a minute before your comment, feel free to open a new one with this additional fix.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done and already merged.

`recipes-core/rauc/rauc_%.bbappend` that adds the keyring file to the rauc
package search path:
`recipes-core/rauc/rauc-conf.bbappend` that adds the keyring file to the rauc
config package search path:

FILESEXTRAPATHS:prepend := "${THISDIR}/files:"

Expand Down
Loading