doc: getting_started: Add instructions for multi-platform Zephyr SDK #43008
Conversation
stephanosio
requested review from
nashif,
gmarull,
carlescufi,
tejlmand,
galak and
mbolivar-nordic
There was a problem hiding this comment.
Looks good overall. I don't understand the naming, though. I thought we discussed at the TSC that this was going to be renamed from "Zephyr SDK", because there was too much potential for confusion in the embedded space with "vendor SDK", which includes all the firmware libraries etc for developing on an SoC. Did I misunderstand something?
stephanosio
force-pushed
the
mp_sdk_doc_update
branch
2 times, most recently
from
7ec3584 to
9f2a9ad
Compare
|
Ready for review. DNM until Zephyr SDK 0.14.0 is released. |
stephanosio
force-pushed
the
mp_sdk_doc_update
branch
from
9f2a9ad to
31011b5
Compare
|
Zephyr SDK 0.14.0 has been released. Ready for final review and merging. |
|
@carlescufi @gmarull @mbolivar-nordic Could you review this so that we can merge it and announce the SDK 0.14.0 release? |
There was a problem hiding this comment.
Great job, some changes requested. Also, can you please update the Set up a toolchain section? This paragraph is now wrong:
On Linux systems, you can install the Zephyr SDK to get toolchains for all supported architectures. Otherwise, you can install other toolchains in the usual way for your operating system: with installer programs or system package managers, by downloading and extracting a zip archive, etc.
This commit adds the instruction for installing the `wget` application
for macOS and Windows hosts, such that it is available on all three
host platforms when the Getting Started Guide is followed.
The rationale behind this is as follows:
* The Zephyr documentations, including the Getting Started Guide,
makes extensive use of the wget command.
* wget is a purpose-made tool for get/download requests and is more
user-friendly than curl for the purpose of downloading files.
Signed-off-by: Stephanos Ioannidis <[email protected]>
stephanosio
force-pushed
the
mp_sdk_doc_update
branch
from
c083d57 to
03a9fab
Compare
This commit adds the Linux, macOS and Windows instructions for installing the new multi-platform Zephyr SDK. Signed-off-by: Stephanos Ioannidis <[email protected]>
Since Zephyr SDK is now supported on all major operating systems, there is no need to restrict it to "on Linux." This commit also removes an endorsement of the GNU Arm Embedded toolchain because there is no need to recommend and/or use it anymore for the aforementioned reason. Signed-off-by: Stephanos Ioannidis <[email protected]>
stephanosio
force-pushed
the
mp_sdk_doc_update
branch
from
03a9fab to
7aafa77
Compare
| wget https://github.com/zephyrproject-rtos/sdk-ng/releases/download/v0.14.0/zephyr-sdk-0.14.0_macos-x86_64.tar.gz | ||
| wget -O - https://github.com/zephyrproject-rtos/sdk-ng/releases/download/v0.14.0/sha256.sum | shasum --check --ignore-missing | ||
|
|
||
| If your host architecture is 64-bit ARM (Apple Silicon, also known as M1), replace |
There was a problem hiding this comment.
I'd personally remove M1 references, I'm pretty sure we'll have M2 or M1plus or whatever at some point.
There was a problem hiding this comment.
As far as I know, Apple is currently working on the "M2" chip; but, as of now, all the production Macs are M1 and they refer to those as "M1" in the marketing materials too.
I think we can update/generalise this later when they actually have multiple M series SoCs.
There was a problem hiding this comment.
I think just mentioning Apple Sillicon means we don't have to keep updating the document when, e.g., M2 is released.
There was a problem hiding this comment.
I agree with @gmarull, let's stick to "Apple Silicon". Please send a follow-up PR @stephanosio.
There was a problem hiding this comment.
Looking at https://www.apple.com/mac-mini/, they almost exclusively refer to their Arm-based Mac Minis as "M1" and there is not a single mention of the "Apple Silicon" on that page (from what I can see, they stopped using the "Apple Silicon" term, at least in the marketing materials); in that sense, I think it is helpful to keep that "aka. M1" for now.
When they release a new M series SoC, I will make sure to send a follow-up PR either generalising that phrase or just completely removing it.
Zephyr SDK 0.14.0.