Skip to content

rimage: update submodule to 542924d70c17, back in sync with west.yml (fixes -dirty)#6398

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

Merged
ranj063 merged 2 commits into from
Oct 13, 2022
Merged

rimage: update submodule to 542924d70c17, back in sync with west.yml (fixes -dirty) #6398

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ace2414
rimage: update submodule to 542924d70c17, back in sync with west.yml
marc-hb Oct 11, 2022
68ada05
west.yml: add warning to keep git submodules in sync
marc-hb Oct 11, 2022
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
2 changes: 1 addition & 1 deletion rimage
Open in desktop
Submodule rimage updated 5 files
+85 −1 config/mtl.toml
+15 −1 config/tgl-cavs.toml
+229 −0 config/tgl-h-cavs.toml
+1 −0 src/include/rimage/manifest.h
+2 −1 src/include/rimage/sof/user/manifest.h
22 changes: 22 additions & 0 deletions west.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,24 @@ manifest:
- name: zephyrproject
url-base: https://github.com/zephyrproject-rtos

# When upgrading projects here please run git log --oneline in the
# project and if not too long then include the output in your commit
# message. See examples of good commit messages at
# https://github.com/thesofproject/sof/commits/4e1d3ba61abd3/rimage
# (git log 4e1d3ba61abd3 -- rimage/)

# WARNING: for backwards compatibility with non-Zephyr platforms,
# rimage and toml99 are STILL git submodules! Every time you change
# their `revision` revision here you MUST keep their git submodules in
# sync. This is as simple as `git add rimage` before committing (+
# `git commit --amend` if you forgot and already committed this
# west manifest file).

# When a submodule is out of sync then both `git status` and `git
# describe` notice and a "-dirty" suffix appears in the SOF version.
# It is generally very bad practice to git push without looking
# at "git status"; even without submodules.

@kv2019ikv2019iOct 12, 2022

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Given we will need frequent updates to rimage (like #6385 today), the above seems just way too complicated. Can we use a different directory for either the submodule (renaming it) or the west module? This probably needs to be done in steps to remove the hardcodes for rimage path, before the switch, but I don't see we can survive with this duplicated rimage copies setup in the long term.

Not blocking the PR because of this, as long as we use the same directory name, this is needed yes or yes.

@marc-hbmarc-hbOct 12, 2022•
edited
Loading

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

Yes, the best would be to move rimage one level-up in west.yml and leave the rimage submodule in place. west would then stop fooling git submodules. This would help de-hardcoding the sof name of the sof clone too.

BTW west is suspiciously quiet about nesting git repos. It does not explicitly forbid it but it never shows any nested git repo in any example anywhere in the documentation.

HOWEVER, moving rimage in west.yml would require large, disruptive and backwards-incompatible changes in the build system and in CI, which is why it was not done yet. I mean much more complicated and much more time-consuming changes than keeping the submodule in sync. Good request to add the backlog though.

@marc-hbmarc-hbOct 13, 2022

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

Given we will need frequent updates to rimage (like #6385 today),

BTW rimage updates were not really frequent in the past. They are more frequent now because MTL is brand new but I would expect this to ease off soon. As long as the firmware boots who cares about rimage?

projects:
- name: rimage
repo-path: rimage
Expand DownExpand Up@@ -41,6 +59,10 @@ manifest:
- tinycrypt

self:
# sof can unfortunately NOT be cloned as "sof2" nor "sof-topic1"
# because for now rimage is cloned as "sof/rimage", tomlc99 as
# "sof/rimage/tomlc99" and probably other build issues that we have
# not discovered yet.
path: sof
# Changes to submanifests/*.yml files _are_ effective; these have no
# specified 'revision:'
Expand Down