Skip to content

Commit

Permalink
README.md: show how to git cherry-pick across sof.git and rimage.git
Browse files Browse the repository at this point in the history
Also warn that the main branch is now frozen.

Signed-off-by: Marc Herbert <[email protected]>
  • Loading branch information
marc-hb committed Oct 27, 2023
1 parent 8d9eece commit 5bbc1f5
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,32 @@ the DSP on certain Intel System-on-Chip (SoC). This is used by
the [Sound Open Firmware (SOF)](https://github.com/thesofproject/sof)
to generate binary image files.

As of October 2023, the main branch and active development of
https://github.com/thesofproject/sof/rimage has been transferred to a
subdirectory of the main sof repo and frozen in the standalone rimage
git repo. See https://github.com/thesofproject/sof/issues/8178 for more.

Other, stable/maintenance branches of the standalone rimage git repo are
still being used!

Because the entire rimage git history has been transferred, it is very
easy to `cherry-pick -x` commits across sof.git and rimage.git. Here's
an example how:

```shell
cd sof/
git -C rimage/ remote add sof-parent "$(pwd)"
cd rimage/
git checkout stable-v2.7
git fetch sof-parent
git cherry-pick -x abcdef
```

... where `abcdef` is commit from sof.git that you want to cherry-pick
to a stable branch of rimage.git. Obviously, `abcdef` changes outside
the `sof/tools/rimage/` directory will not apply.


## Building

Most SOF users never build `rimage` directly but as an ExternalProject
Expand Down

0 comments on commit 5bbc1f5

Please sign in to comment.