Open
Conversation
Member
ejoerns
commented
Apr 8, 2026
ejoerns
commented
- Fix typos, wording, etc.
- Drop redundant or useless information
- Clarify or rephrase some aspects
- Add information on release cycles
This should be shown as 'code', not as 'italic'. Signed-off-by: Enrico Jörns <ejo@pengutronix.de>
Signed-off-by: Enrico Jörns <ejo@pengutronix.de>
This plural form originates from when the section described rauc-hawkbit, too. Fixes: 1a9a22d ("rauc-hawkbit: remove recipe and references") Signed-off-by: Enrico Jörns <ejo@pengutronix.de>
This is basic Yocto/OE knowledge that is not worth being replicated in each individual layer. While at it, drop the section numbers, since we don't intend to write a whole book here. Signed-off-by: Enrico Jörns <ejo@pengutronix.de>
Better outline the purpose of RAUC and this layer. Add note on host and target side integration. Signed-off-by: Enrico Jörns <ejo@pengutronix.de>
ejoerns
force-pushed
the
revise-meta-rauc
branch
from
df4d76c to
535dd73
Compare
Member
Author
hnez
reviewed
Apr 13, 2026
Comment on lines
+33
to
+35
| Only when using casync (with fuse support), ``meta-filesystems`` from | ||
| `meta-openembedded <https://github.com/openembedded/meta-openembedded.git>`_ is | ||
| required additionally. |
Member
There was a problem hiding this comment.
The "This layer depends on … only when …" may be a bit hard to parse. How about:
Suggested change
| Only when using casync (with fuse support), ``meta-filesystems`` from | |
| `meta-openembedded <https://github.com/openembedded/meta-openembedded.git>`_ is | |
| required additionally. | |
| To use the optional casync feature with FUSE, you will also need: | |
| * ``meta-filesystems`` from `meta-openembedded <https://github.com/openembedded/meta-openembedded.git>`_. |
hnez
reviewed
Apr 13, 2026
Comment on lines
+50
to
+51
| Building and Using RAUC Host Tool | ||
| ================================= |
Member
There was a problem hiding this comment.
Suggested change
| Building and Using RAUC Host Tool | |
| ================================= | |
| Building and Using the RAUC Host Tool | |
| ================================= |
Member
Author
There was a problem hiding this comment.
Thought about this additional change, too. Will add it.
Member
There was a problem hiding this comment.
I also think that is section is less important than "Adding the RAUC Update Service to Your Device" and "Configure Custom Kernel".
How about changing the order of the sections to:
- "Layer Dependencies"
- "Migration Notes"
- "Configure Custom Kernel"
- "Adding the RAUC Update Service to Your Device" (this also configures the bundle build. Maybe the title should be changed to something that reflects that. I.E.: "Adding RAUC and building Bundles")
- "Building and Using the RAUC Host Tool"
- "Building The RAUC hawkBit Client"
- "Build RAUC Development Version"
- "Release Cycle"
- "Contributing"
Member
Author
There was a problem hiding this comment.
I'd split up the target configuration and bundle building.
I'd keep the kernel chapter where it is for now.
Member
|
Hi, I like the changes. The README quickly gets to the point and I like that. I have added a few comments on what I would maybe change. I have also noted that there are no references to rauc/meta-rauc-community yet. Maybe we should add one? Examples are sometimes worth more than a lot of documentation. |
* Shorten the description * drop 'bitbake', which of course is required, but not a layer. * clarify the casync requirements and scope Signed-off-by: Enrico Jörns <ejo@pengutronix.de>
* 'changes' is too broad, we don't intend to backport all new features * allow 'backport' in backport notes, too (e.g. when not doing a pure cherry pick * replace 'poky releases' by 'Yocto releases' Signed-off-by: Enrico Jörns <ejo@pengutronix.de>
This mainly replicates the information from the "Contributing" chapter. Move the Maintainers note there. Signed-off-by: Enrico Jörns <ejo@pengutronix.de>
It's not sufficient to just set FILESEXTRAPATHS, you'd also need the system.conf file itself. Also the keyring is installed this way for most use cases. Reword 'RAUC update file' to 'RAUC system configuration' which is more appropriate. Signed-off-by: Enrico Jörns <ejo@pengutronix.de>
Recent bundles should not be build without, if possible. Signed-off-by: Enrico Jörns <ejo@pengutronix.de>
* add missing 'the' to heading * remove useless 'if you intend' * point out 'manually' usage of the RAUC tool * shorten and align wording Signed-off-by: Enrico Jörns <ejo@pengutronix.de>
Using RAUC manually as a host tool is less important than integrating it for the target. Signed-off-by: Enrico Jörns <ejo@pengutronix.de>
ejoerns
force-pushed
the
revise-meta-rauc
branch
from
535dd73 to
51eae75
Compare
Member
Author
A good idea, but I'd prefer to do this in a separate PR. |
This was mixed in the same chapter and could easily be overlooked, since the heading just noted "Adding the RAUC Update Service to Your Device". Signed-off-by: Enrico Jörns <ejo@pengutronix.de>
Signed-off-by: Enrico Jörns <ejo@pengutronix.de>
ejoerns
force-pushed
the
revise-meta-rauc
branch
from
51eae75 to
e6577cf
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.