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.

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

Conversation

ejoerns
Copy link
Member

@ejoerns ejoerns commented Jun 18, 2024

With d51bab8 (rauc: split package into 'rauc' for binary and 'rauc-conf' for configuration), users need to append rauc-conf instead of rauc when providing their device-specific configuration.

This was not reflected by the docs yet.

Also add an explicit migration note early in the README.rst.

With d51bab8 (rauc: split package into 'rauc' for binary and
'rauc-conf' for configuration), users need to append rauc-conf instead
of rauc when providing their device-specific configuration.

This was not reflected by the docs yet.

Also add an explicit migration note early in the README.rst.

Signed-off-by: Enrico Jörns <ejo@pengutronix.de>
@jluebbe jluebbe merged commit 71e98ed into rauc:master Jun 18, 2024
2 checks passed
@ejoerns ejoerns deleted the rauc-conf-docs branch June 18, 2024 07:17
Copy link
Contributor

@OnkelUlla OnkelUlla left a comment

Choose a reason for hiding this comment

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

Looks good otherwise.

@@ -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.

OnkelUlla added a commit that referenced this pull request Jun 18, 2024
@ejoerns
Copy link
Member Author

ejoerns commented Jul 3, 2024

backported to scarthgap

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants