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

Qemu build #53

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Qemu build #53

wants to merge 5 commits into from

Conversation

mchack-work
Copy link
Member

Description

Change the build instructions for qemu. Inform about pre-compiled tkey-libs. Remove tag from running OCI image, unless necessary.

Some Hugo maintainence: Modern hugo complained about a theme file.

Type of change

Please tick any that are relevant to this PR and remove any that aren't.

  • Documentation (a change to documentation)

Submission checklist

  • I have performed a self-review of my changes
  • My changes are well written and CI is passing
  • I have squashed my work to relevant commits and rebased on main for linear history

We can be specific about what qemu target to build, so we avoid
building unnecessary support by building just the qemu-system-riscv32
target.
Users should probably use :latest most of the time unless doing
something for reproducible builds that requires a specific version.
Let's specify that and remove tags from the rest of the mentions of
the image.
hugo complains about the nonexistent file:

  _internal/google_analytics_async.html

so we remove the reference to it.

Besides, we don't want any Google Analytics anywhere, anyway.
Since we're now closer to qemu upstreams no warnings should appear.
@@ -64,7 +64,7 @@ make -C contrib run
```
or use this podman command
```
podman run --rm --mount type=bind,source="$(pwd)",target=/src -w /src -it ghcr.io/tillitis/tkey-builder:4 /usr/bin/bash
Copy link
Member

Choose a reason for hiding this comment

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

While I agree about removing the tkey-builder number under devtools, I wonder if it is correct to do so under the unlocked pages.

These instructions are for building a specific tag, as of now TK1-24.03, to be able to build it as we intended and infact released, the :4 needs to stay. Otherwise we may, implicitly, change the release build of an earlier tag when we release newer version of tkey-builder - a build that we may not have tested.

@mchack-work
Copy link
Member Author

I see your point. Would it be acceptable to clarify here, too, that you should use the image tag mentioned in the particular release if you want a reproducible bitstream?

We want to mention the version of tools used to build every release in the actual release, of course, and not have to do it in the Dev Handbook.

@dehanj
Copy link
Member

dehanj commented Oct 8, 2024

I see your point. Would it be acceptable to clarify here, too, that you should use the image tag mentioned in the particular release if you want a reproducible bitstream?

We want to mention the version of tools used to build every release in the actual release, of course, and not have to do it in the Dev Handbook.

I agree, and in the long run I think we should have some type of installer/build script that automates the majority of this. That one can look into if one wants to make it manually.

Yes, if it is clearly mentioned either in here, or with links to the information I think it suffices.

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.

3 participants