Skip to content
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.

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

Resolve documentation pointing to wrong SDK #103

Merged
merged 1 commit into from
May 28, 2024

Conversation

marnovandermaas
Copy link
Contributor

In the documentation we should just recommend that people use cmake to pull in the correct version of the SDK.

@marnovandermaas
Copy link
Contributor Author

Partially fixes: #101

HU90m
HU90m previously requested changes May 27, 2024
doc/guide/building-examples.md Outdated Show resolved Hide resolved
doc/guide/building-examples.md Outdated Show resolved Hide resolved
Copy link
Member

@HU90m HU90m left a comment

Choose a reason for hiding this comment

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

Also, there are a few sentences which are split over multiple lines.

@nwf
Copy link

nwf commented May 27, 2024

I'm not sure I approve of increasingly relying on cmake to pull in the RTOS in a section for "advanced users". Advanced users can probably be told how to ensure that they fetch the suitable version (which, hopefully soon, is just mainline?) and might want to make changes to the RTOS itself, which would be difficult if it's hidden behind cmake. Thoughts?

@davidchisnall
Copy link

Why are you wrapping a build system that can target Sonata and comes with a dev container that just works in a load of CMake goo?

For reference, the first CHERIoT build system used CMake, but CMake was not sufficiently flexible to allow defining new kinds of targets and so we abandoned it.

@GregAC
Copy link
Contributor

GregAC commented May 27, 2024

I would note the software in this repository is intended for system bring-up/test purposes. People wanting to actually develop software for Sonata will use https://github.com/lowRISC/sonata-software or indeed just the upstream CHERIoT RTOS repository: https://github.com/microsoft/cheriot-rtos/.

The main branch of this repository and of the https://github.com/lowRISC/sonata-software are our live development repositories and as such in a state of flux right now. So in particular documentation is still being worked on along with deciding exactly what lives where etc.

We do not intend for cmake to be the primary build system for Sonata software, rather we will use the existing build flows provided by the CHERIoT RTOS upstream. It may remain in use in this repository for the limited use case of building small programs used for verification purposes and only of relevance to hardware engineers working on the RTL but this is not yet decided.

In the documentation we should just recommend that people use cmake to
pull in the correct version of the SDK.
@marnovandermaas marnovandermaas dismissed HU90m’s stale review May 28, 2024 08:55

resolved comments

@marnovandermaas marnovandermaas merged commit 3bc3b06 into lowRISC:main May 28, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants