Skip to content

getting_started/build-guide: update Build SOF with zephyr - #425

Merged
lgirdwood merged 1 commit into
thesofproject:masterfrom
aborisovich:update-build-guide-build-with-zephyr
Aug 10, 2022
Merged

getting_started/build-guide: update Build SOF with zephyr#425
lgirdwood merged 1 commit into
thesofproject:masterfrom
aborisovich:update-build-guide-build-with-zephyr

Conversation

@aborisovich

@aborisovichaborisovich commented Aug 9, 2022•
edited
Loading

Copy link
Copy Markdown
Contributor

Introduction of west tool to SOF project in PR thesofproject/sof#6005 required to update
build guide on how to use python convenience script and west tool.

Signed-off-by: Andrey Borisovich andrey.borisovich@intel.com

kv2019i
kv2019i approved these changes Aug 9, 2022
View reviewed changes

@kv2019ikv2019i left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you @aborisovich ! One minor typo slipped in, otherwise looks good.

Comment threadgetting_started/build-guide/build-with-zephyr.rst Outdated
@kv2019i
kv2019i requested a review from marc-hbAugust 9, 2022 17:00
@aborisovich
aborisovichforce-pushed the update-build-guide-build-with-zephyr branch from 083ef36 to 200018bCompareAugust 9, 2022 20:17
aiChaoSONG
aiChaoSONG reviewed Aug 10, 2022
View reviewed changes
Comment threadgetting_started/build-guide/build-with-zephyr.rst
.. code-block:: bash

$ tree build-sof-staging/
west sign --build-dir ./build-tgl -t rimage --tool-path ./build-rimage/rimage --tool-data ./sof/rimage/config -- -k ./sof/keys/otc_private_key_3k.pem

@aiChaoSONGaiChaoSONGAug 10, 2022

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

do we want to mention the -f option? or the version in manifest will be 0.0.0, which is not correct.

@aborisovichaborisovichAug 10, 2022•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

-f option is for -f, --force ignore any errors and try to proceed according to west sign --help .
How is that related to versioning?
Yes we need to integrate firmware versioning with west tool (we currently lack this feature).

@aborisovich
aborisovichforce-pushed the update-build-guide-build-with-zephyr branch 2 times, most recently from 6ab66fe to 024ce11CompareAugust 10, 2022 13:02
@aborisovich

aborisovich commented Aug 10, 2022•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Push update:

  • Added Troubleshooting section describing issue when west tool version is not sufficient to process sof/west.yml manifest.
    As @mmaka1 noticed west tool 0.12.0 raises not very user-friendly Python exception.

lgirdwood
lgirdwood approved these changes Aug 10, 2022
View reviewed changes

@lgirdwoodlgirdwood left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@deb-intel are you ok to fixup any grammar after merge ?

@aborisovich

aborisovich commented Aug 10, 2022

Copy link
Copy Markdown
ContributorAuthor

Hold on one more fix!

Andrey Borisovich
getting_started/build-guide: update Build SOF with zephyr
dc965ad
Introduction of west tool to SOF project required to update
build guide on how to use python convenience script and west tool.
Signed-off-by: Andrey Borisovich <andrey.borisovich@intel.com>
@aborisovich
aborisovichforce-pushed the update-build-guide-build-with-zephyr branch from 024ce11 to dc965adCompareAugust 10, 2022 13:18
@aborisovich

aborisovich commented Aug 10, 2022

Copy link
Copy Markdown
ContributorAuthor

Now it's ok. Ready to merge.

@lgirdwood
lgirdwood merged commit 81345c6 into thesofproject:masterAug 10, 2022
@lgirdwood

lgirdwood commented Aug 10, 2022

Copy link
Copy Markdown
Member

We can fix up any grammar later - lets get the devs using this.

@deb-intel

deb-intel commented Aug 19, 2022

Copy link
Copy Markdown
Collaborator

@aborisovich I'm making language and style updates to this doc. On line 20, you state that the easiest way to build Z is to use its recommended toolchain. The link you provide does not exist and the section on using toolchains is not easily apparent (Install a Toolchain <https://docs.zephyrproject.org/latest/getting_started/index.html#install-a-toolchain>_). Do you mean to state that the easiest installation method is to use the Zephyr SDK which contains toolchains https://docs.zephyrproject.org/latest/develop/getting_started/#install-zephyr-sdk? Please advise, thanks!

@aborisovich

aborisovich commented Aug 22, 2022•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

@aborisovich I'm making language and style updates to this doc. On line 20, you state that the easiest way to build Z is to use its recommended toolchain. The link you provide does not exist and the section on using toolchains is not easily apparent (Install a Toolchain <https://docs.zephyrproject.org/latest/getting_started/index.html#install-a-toolchain>_). Do you mean to state that the easiest installation method is to use the Zephyr SDK which contains toolchains https://docs.zephyrproject.org/latest/develop/getting_started/#install-zephyr-sdk? Please advise, thanks!

Yes, I meant Zephyr SDK.
In fact this part is a left over from the old version of the guide. I should had verified that part....

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lgirdwoodlgirdwoodlgirdwood approved these changes
@kv2019ikv2019ikv2019i approved these changes
@anton-intelanton-intelAwaiting requested review from anton-intel
@deb-inteldeb-intelAwaiting requested review from deb-inteldeb-intel is a code owner
@intelkevinputnamintelkevinputnamAwaiting requested review from intelkevinputnamintelkevinputnam is a code owner
@greg-intelgreg-intelAwaiting requested review from greg-intel
@marc-hbmarc-hbAwaiting requested review from marc-hb
+1 more reviewer
@aiChaoSONGaiChaoSONGaiChaoSONG left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@aborisovich@lgirdwood@deb-intel@kv2019i@aiChaoSONG